Bill Payments

The Bill Payment Object

A bill payment represents an allocation of money within any vendors accounts payable account such as a payment made against a bill, like a credit card, cheque, or cash payment. From the Bill Payments endpoint, you can retrieve a list of all bill payments for a specified business.

FieldTypeDescription
id string Identifier for the bill payment, unique to the business in the accounting service provider.
vendorRef Reference TypesVendor that issued the bill.
accountRef Reference TypesReference to the account to which the bill 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 bill payment, inclusive of tax.
currencyRef Reference TypesCurrency of the bill.

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.
currencyRate decimalRate between the currency of the bill and the base currency of the business. Not applicable when multi-currency is not supported.
date
sortable, filterable
string
See Date
Date the bill payment was recorded in the accounting service provider.
memo stringUser-friendly reference for the bill payment.
lines arrayAn array of bill payment lines
subsidiaryRefsReference TypesAn array of subsidiaries the bill 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 deprecated, objectPlease use the links field, link will be deprecated in the future.
linksarrayAn array of bill payment links
allocatedOnDate string
See Date
Date the payment line was allocated on.

Link

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