Bill Payments

A bill payment represents an allocation of money within a business' accounts payable account such as a payment made against a bill, like a credit card, cheque, or cash payment.

The Bill Payment Object

PropertyTypeDescription
idstringUnique identifier for the bill payment
vendor_idstringUnique ID for the vendor associated with the bill payment
account_idstringAccount ID that logs the payment details associated with a bill payment.
total_amountnumberTotal amount of payment for the bill.
currencystringThe ISO-4217 currency code
currency_ratenumberRate between the currency of the invoice and the base currency.
datestringThe payment date ISO 8601
memostringDescription of the the bill payment.
line_itemsobject[]Array of line items with details for the payment. See below.

Bill Payment Line Items

A bill payment line item corresponds to payments allocated for one or multiple bills. Each payment line item is an allocation of funds for a single bill. A partial payment can be applied to a bill and an overall bill payment can be applied to multiple bills at once. The sum of the amount for all line items must equal total_amount.

PropertyTypeDescription
bill_idstringID of the associated bill for the line item
amountnumberTotal amount of of the allocated payment for this line item
typestringA Bill Payment can be applied to different objects (ex. Credit Notes, Journal Entries). Default value = "Bill"
allocated_atstringDate when the line item payment is made
{
      "id": "1",
      "vendor_id": "123",
      "account_id": "123",
      "total_amount": 200.5,
      "currency": "USD",
      "currency_rate": 1.13,
      "date": "2021-03-09T10:57:54.294Z",
      "memo": "Bill payment memo.",
      "line_items": [
        {
          "bill_id": "50",
          "amount": 200.5,
          "type": "Bill",
          "allocated_at": "2021-03-09T10:57:54.294Z"
        }
      ]
    }