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.

Field	Type	Description
id	string	Identifier for the bill payment, unique for the business in the accounting service.
vendorRef	Reference Types	Reference to the vendor against which the payment is created.
accountRef	Reference Types	Reference to the account 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.
currency	string	ISO-4217 currency code of the bill payment.
currencyRate	decimal	Rate 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 bill payment was recorded in the accounting service.
paymentMethod sortable, filterable	string	Payment method used.
memo	string	Any additional information or business notes about the bill payment.
lines	array	An array of bill payment line items. ref:the-bills-object#bill-status
sourceModifiedDate sortable, filterable	string See Date	The date on which this record was last modified in the accounting service.

Lines

Field	Type	Descirption
amount	decimal	Line item payment amount.
links	array	Bill payment linked transactions.
allocatedOnDate sortable, filterable	string See Date	Date the payment line was allocated on.

Links

Field	Type	Description
type sortable, filterable	string	Types of links to bill payment lines. Valid values: `bill` `other` `creditNote` `billPayment` `paymentOnAccount` `refund`
id sortable, filterable	string	Unique identifier of the transaction represented by the link.

How to - User Guide

Step-by-step guide on utilizing this endpoint.