Invoice Payments

The Invoice Payment Object

From the Invoice Payments endpoint, you can retrieve a list of all invoice payments for a specified business.

FieldTypeDescription
id string Identifier for the invoice payment, unique to the business in the accounting service provider.
customerRefReference TypesReference to the customer the invoice has been issued to.
accountRef Reference TypesReference to the account to which the invoice payment is linked to.

Pushing data requires a valid bank account reference. Query Accounts and use the id parameter of an account with isBankAccount=true as a value. For Xero, use nomincalCode parameter.
totalAmount
sortable, filterable
decimal Amount of the invoice payment, inclusive of tax.
currencyRef Reference TypesCurrency of the invoice.

Pushing data will fail if the business has not enabled or does not support multiple currency. Leaving this blank would default to the business' default currency. Not applicable when multi-currency is not supported.
currencyRate decimalRate between the currency of the invoice and the base currency of the business.
date
sortable, filterable
string
See Date
Date the invoice payment was recorded in the accounting service provider.
memo stringUser-friendly reference for the invoice payment.
lines arrayAn array of invoice payment lines.
subsidiaryRefsReference TypesAn array of subsidiaries the invoice refers to.
sourceModifiedDate
sortable, filterable
string
See Date
Date the record was last changed in the accounting service provider.

Lines

FieldTypeDescirption
amount decimal Total amount of the line, inclusive of discounts and tax.
link objectAn invoice payment linked transaction.
allocatedOnDate string
See Date
Date the payment line was allocated on.

Link

FieldTypeDescription
type string Types of invoice payment line links. Valid values:
invoice
payment
paymentOnAccount
creditNote
refund
other
id stringUnique identifier of the transaction represented by the link.