Bills

Bills represent an itemized record of goods purchased from or services provided by another company.

The Bill Object

Property

Type

Description

id

string

Unique business identifier for the bill

vendor_id

string

Unique ID for the vendor associated with this bill

currency

string

The ISO-4217 currency code

purchase_orders

object[]

Array of associated purchase orders corresponding to this bill payment.

line_items

object[]

Array of Bill Line items containing metadata associated with the bill (see example API response below)

status

string

Current status of the bill, one of:

open - Bill is no longer a draft. It has been processed and/or sent to the supplier. In this state, it will impact the ledger. It also has no payments made against it (amountDue == totalAmount).
partially_paid - The balance paid against the bill is positive, but less than the total bill amount (0 < amountDue < totalAmount).
paid - Bill is paid in full. This includes if the bill has been credited or overpaid. (amountDue == 0).
void - A Bill can become Void by being deleted, refunded, written off, or cancelled. A voided bill may still be partially paid and so all outstanding amounts on voided bills are removed from the accounts payable account.
draft - Bill is yet to be authorized and sent by the supplier, and will not be used in any reports. It may contain incomplete line items.
unknown - Unable to recognize the status of the bill. This can be due to missing values in the accounting service provider or unavailable in the data we received.

total_amount

number

Total amount of the Bill

tax_amount

number

Total tax amount for the Bill

amount_due

number

Outstanding amount to be paid for the Bill

updated_at

string

The last ISO 8601

{
      "id": "1",
      "vendor_id": "123",
      "purchase_orders": [
        {
          "id": "1"
        }
      ],
      "posted_at": "2021-03-09T10:18:29.985Z",
      "due_date": "2021-03-09T10:18:29.985Z",
      "currency": "USD",
      "line_items": [
        {
          "description": "Services rendered.",
          "unit_amount": 100.5,
          "quantity": 3,
          "discount_amount": 0,
          "sub_total": 301.5,
          "tax_amount": 20.5,
          "total_amount": 322,
          "discount_percentage": 10.5,
          "tax_rate_id": "1",
          "item_id": "1",
          "account_id": "123"
        }
      ],
      "status": "open",
      "sub_total": 301.5,
      "tax_amount": 20.5,
      "total_amount": 322,
      "amount_due": 322,
      "payments": [
        {
          "amount": 50.5,
          "id": "50",
          "date": "2021-03-09T10:18:29.985Z"
        }
      ]
    }