Invoice Payments

The Invoice Payments object

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

FieldTypeDescription
id
sortable, filterable
string Identifier for the invoice payment, unique for the business in the accounting service.
customerRefReference TypesReference to the customer against which the payment is created.
accountRef Reference TypesReference to the account or bank account 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.
currency stringISO-4217 currency code of the invoice payment.
currencyRate decimalRate to convert the total amount of the transaction into the base currency for the business at the time of the transaction.
date
sortable, filterable
string
See Date
Date the invoice payment was recorded in the accounting service.
paymentMethod
sortable, filterable
stringPayment method used.
memo stringAny additional information or business notes about the invoice payment.
lines arrayAn array of invoice payment lines.
sourceModifiedDate
sortable, filterable
string
See Date
Date the record was last changed in the accounting service provider.

Lines

FieldTypeDescirption
amount
sortable, filterable
decimal Any additional information or business notes about the invoice payment.
links objectInvoice payment linked transactions.
allocatedOnDate
sortable, filterable
string
See Date
Date the payment line was allocated on.

Links

FieldTypeDescription
type
sortable, filterable
string Types of links to invoice payment lines. Valid values:
invoice
payment
paymentOnAccount
creditNote
refund
id
sortable, filterable
stringUnique identifier of the transaction represented by the link.