Bill Payments

Overview

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. See Bill Payments endpoint for more details.

Data Model

Field	Type	Description
id	string	Identifier for the bill payment, unique to the business in the accounting service provider.
vendorRef	Reference Types	Vendor that issued the bill.
accountRef	Reference Types	Reference 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 Types	Currency 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	decimal	Rate 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	string	User-friendly reference for the bill payment.
lines	array	An array of bill payment lines.
sourceModifiedDate sortable, filterable	string See Date	Date the record was last changed in the accounting service provider.

Lines

Field	Type	Descirption
amount	decimal	Total amount of the line, inclusive of discounts and tax.
link	object	A bill payment linked transactions.
allocatedOnDate	string See Date	Date the payment line was allocated on.

Link

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

Example Data

{
  "data":
  [
    {
      "id": "1",
      "vendorRef":
      {
        "id": "1",
        "name": "Home Reno Inc"
      },
      "accountRef":
      {
        "id": "145",
        "name": "Professional Services"
      },
      "totalAmount": 200.5,
      "currencyRef":
      {
        "id": "CAD",
        "name": "Canadian Dollar"
      },
      "currencyRate": 1.13,
      "date": "2021-03-09T10:57:54.294Z",
      "memo": "Bill payment memo.",
      "lines":
      [
        {
          "amount": 200.5,
          "links":
          {
            "type": "bill",
            "id": "50",
            "amount": 0
          },          
          "allocatedOnDate": "2021-03-09T10:57:54.294Z"
        }
      ],
      "sourceModifiedDate": "2021-03-09T10:18:29.985Z"
    }
  ]
}