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 for the business in the accounting service.
vendorRef Reference TypesReference to the vendor against which the payment is created.
accountRef Reference TypesReference 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 stringISO-4217 currency code of the bill 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 bill payment was recorded in the accounting service.
paymentMethod
sortable, filterable
stringPayment method used.
memo stringAny additional information or business notes about the bill payment.
lines arrayAn 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

FieldTypeDescirption
amount decimal Line item payment amount.
linksarrayBill 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 bill payment lines. Valid values:
bill
other
creditNote
billPayment
paymentOnAccount
refund
id
sortable, filterable
stringUnique identifier of the transaction represented by the link.

How to - User Guide

Step-by-step guide on utilizing this endpoint.