v1

latestOpenAPI 3.0.32026-07-26362271803.3 KB

Accounts Receivable

Get Default Payment Amount

Get the default payment amount for an invoice based on when payment is posted.

    If the invoice has discount terms and the posted date is within the discount period,
    the discounted amount is returned. Otherwise, the full amount is returned.

post/coa/api/v1/invoice/{invoice_id}/default-payment

Path parameters

invoice_idinteger required

ID of the invoice

Request body

posted_atstring date required

Date when payment would be posted

transaction_amountnumber double nullable

Optional transaction amount

Response

default_payment_amountnumber double required

payment_term_discount_notestring nullable