Bills

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

The Bill Object

Property	Type	Description
id	string	A Rutter designated ID for the bill. It always will be in UUID format.
platform_id	string	Unique Platform ID for the bill.
document_number	string	Reference document number for the bill.
vendor_id	string	Unique ID for the vendor associated with this bill.
purchase_orders	object[]	Array of associated purchase orders corresponding to this bill payment when available.
issue_date	string	Date when the bill was issued.
due_date	string	Date when the bill is due for payment.
currency_code	string	The ISO-4217 currency code.
line_items	Bill Line Item[]	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_discount	number	Total value of discounts applied to the bill.
sub_total	number	Total amount of the bill excluding any taxes.
tax_amount	number	Total tax amount for the bill.
total_amount	number	Total amount of the bill.
amount_due	number	Outstanding amount to be paid for the bill.
memo	string	Overall description for the bill.
payments	object[]	Array of linked Bill Payments for the bill.

Bill Line Item

Field	Type	Description
id	string	A Rutter designated ID for this bill line item. It always will be in UUID format.
description	string	Contains the description of the product/service for this bill line item, usually the name.
unit_amount	number	Price per quantity for this bill line item.
quantity	number	The quantity of the product/service for this bill line item.
discount_amount	number	The amount discounted for this bill line item.
sub_total	number	Total amount for this bill line item, excluding any taxes.
tax_amount	number	The amount taxed for this bill line item.
amount	number	The total amount for this bill line item.
discount_percentage	number	The percentage discounted for this bill line item.
tax_rate_id	string	The id of the tax rate.
item_id	string	Platform ID of the product/service for this bill line item.
account_id	string	Platform ID of the account that this bill line item impacts.

{
      "id": "1",
      "platform_id": "2",
      "document_number": "IN-00-1000000",
      "vendor_id": "123",
      "purchase_orders": [
        {
          "id": "1"
        }
      ],
      "issue_date": "2021-03-09T10:18:29.985Z",
      "due_date": "2021-03-09T10:18:29.985Z",
      "currency": "USD",
      "line_items": [
        {
          "id": "1",
          "description": "Services rendered.",
          "unit_amount": 100.5,
          "quantity": 3,
          "discount_amount": 0,
          "sub_total": 301.5,
          "tax_amount": 20.5,
          "amount": 322,
          "discount_percentage": 10.5,
          "tax_rate_id": "1",
          "item_id": "1",
          "account_id": "123"
        }
      ],
      "status": "open",
      "total_discount": 0,
      "sub_total": 301.5,
      "tax_amount": 20.5,
      "total_amount": 322,
      "amount_due": 322,
      "memo": "Example bill memo.",
      "payments": [
        {
          "id": "500",
          "amount": 322,
          "date": "2021-03-09T10:18:29.985Z"
        }
      ]
    }