Update payment

Endpoint for updating an existing payment.

Path Params
string
required
Body Params

A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

double
required

The total amount of the payment, in the payment currency. It must reconcile against whichever list is set. The five document-linked lists (invoice_payments, bill_payments, credit_note_payments, debit_note_payments, payslip_payments) are summed by amount_to_pcy; the two advance blocks (credit_notes, debit_notes) carry no amount_to_pcy and are summed by amount instead. For money-out payments (bill_payments, credit_note_payments, payslip_payments, debit_notes) amount equals that sum plus payment_fees; for money-in payments (invoice_payments, debit_note_payments, credit_notes) it equals that sum minus payment_fees. Must be greater than zero.

bill_payments
array of objects

A list of objects to represent bill payments. Required if paying bills.

bill_payments
string

The unique identifier of the contact associated with this payment.

string | null

The unique identifier of the cost center associated with this payment.

credit_note_payments
array of objects

A list of objects to represent credit note payments. Required if applying credit notes.

credit_note_payments
credit_notes
array of objects

A list with a single object to record a customer advance (money received before any invoice exists). A matching credit note is auto-generated.

credit_notes
string
enum
required
  • AED - AED ⃱
  • SAR - SAR ⃁
  • USD - USD $
  • EUR - EUR €
  • CAD - CAD $
  • AFN - AFN ؋
  • ALL - ALL Lek
  • AMD - AMD դր.
  • ARS - ARS $
  • AUD - AUD $
  • ...

Full information for CurrencyEnum

date
required

The date when the payment was made or received.

debit_note_payments
array of objects

A list of objects to represent debit note payments. Required if paying debit notes.

debit_note_payments
debit_notes
array of objects

A list with a single object to record a supplier advance (money paid before any bill exists). A matching debit note is auto-generated.

debit_notes
string

The unique identifier of the employee associated with this payment. Required for payslip payments.

double | null

The exchange rate to the organization base currency at the time of the payment.

string
length ≤ 255

External identifier for the payment.

invoice_payments
array of objects

A list of objects to represent invoice payments. Required if paying invoices.

invoice_payments
string
required

The account used for this payment. Must be a valid payment account.

double

Bank charges, or the residual left over when the lines do not add up to amount — typically the rounding and exchange-rate difference on a payment settling documents held in another currency. May be negative, and what that means depends on the direction: on a money-out payment a negative value means the lines convert to more than the cash actually paid, while on a money-in payment it means more was received than the lines convert to. Must not be zero; omit the field instead.

string | null

The account to categorize payment_fees. Required if payment_fees is set, and cannot be a bank account. Use the Exchange Gain or Loss account when the residual is an exchange-rate difference.

payslip_payments
array of objects

A list of objects to represent payslip payments. Required if paying payslips.

payslip_payments
string | null

The unique identifier of the project associated with this payment.

string
Headers
string

Client-provided UUID to uniquely identify a request

string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json