Bill Payment Requests

The Bill Payment Request object

A bill payment request represents an allocation of money within any vendors accounts payable account such as a payment to be made against a bill, like a credit card, cheque, or cash payment.

Field	Type	Description
id	string	Identifier for the bill payment request, unique for the business in the accounting service.
batchId	string	Identifier of the batch.
vendorRef	Reference Types	Reference to the vendor against which the payment is created.
bankAccountRef	Reference Types	Reference to the bank account the payment request is linked to.
paymentNumber sortable, filterable	string See Date	Date the bill payment was recorded in the accounting service.
paymentCode sortable, filterable	string	Code of the payment.
paymentDate sortable, filterable	string See Date	Date of the payment.
postedDate sortable, filterable	string See Date	Date of the bill as recorded in the accounting service provider.
currency	string	ISO-4217 currency code of the bill payment.
totalAmount sortable, filterable	decimal	Amount of the bill payment, inclusive of tax.
totalPaid sortable, filterable	decimal	Total amount paid.
amountDue sortable, filterable	decimal	Total amount due
state	string	State of the payment, paid or declined.
paymentMethodRef	Reference Types	Reference to the payment method against which the payment is created.
memo	string	Any additional information or business notes about the bill payment.
sourceModifiedDate sortable, filterable	string See Date	The date on which this record was last modified in the accounting service.

Links

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