Invoices

An invoice is an itemized record of goods sold or services provided to a customer.

The Invoice Object

PropertyTypeDescription
idstringA Rutter designated ID for this invoice. It always will be in UUID format.
platform_idstringUnique Platform ID for this invoice.
document_numberstringReference document number for the invoice.
customer_idstringCorresponding customer Platform ID that receives the invoice.
issue_datestringDate of the invoice as recorded in the accounting platform in ISO 8601 format.
due_datestringThe due date in ISO 8601.
currency_codestringThe ISO-4217 currency code
line_itemsInvoice Line Item[]Array of Invoice Line items containing metadata associated with the invoice (see example API response below).
statusstringCurrent state of an invoice, one of:

open - Invoice is no longer a draft. It has been processed and/or sent to the customer. 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 invoice is positive, but less than the total invoice amount (0 < amountDue < totalAmount).
paid - Invoice is paid in full. This includes if the invoice has been credited or overpaid. (amountDue == 0).
void - An invoice can become void by being deleted, refunded, written off, or cancelled. A voided invoice may still be partially paid and so all outstanding amounts on voided invoices are removed from the accounts receivable account.
draft - Invoice is yet to be authorized and sent to the customer, and will not be used in any reports. It may contain incomplete line items.
unknown - Unable to recognize the status of the invoice. This can be due to missing values in the accounting service provider or unavailable in the data we received.
total_discountnumberTotal value of discounts applied to the invoice.
sub_totalnumberTotal amount of the invoice excluding any taxes.
tax_amountnumberTotal tax amount on the invoice.
total_amountnumberTotal amount of the invoice.
amount_duenumberOutstanding amount to be paid for the invoice.
memostringOverall description for the invoice.
paymentsobject[]Array of payments associated with the invoice.

Invoice Line Item

FieldTypeDescription
idstringA Rutter designated ID for this invoice line item. It always will be in UUID format.
descriptionstringContains the description of the product/service for this invoice line item, usually the name.
unit_amountnumberPrice per quantity for this invoice line item.
quantitynumberThe quantity of the product/service for this invoice line item.
discount_amountnumberThe amount discounted for this invoice line item.
sub_totalnumberTotal amount for this invoice line item, excluding any taxes.
tax_amountnumberThe amount taxed for this invoice line item.
amountnumberThe total amount for this invoice line item.
discount_percentagenumberThe percentage discounted for this invoice line item.
tax_rate_idstringThe id of the tax rate.
item_idstringPlatform ID of the product/service for this invoice line item.
account_idstringPlatform ID of the account that this invoice line item impacts.
{
      "id": "11111aa1-1a11-111a-aa1a-11aaa1a1aa11",
      "platform_id": "2",
      "document_number": "IN-00-1000000",
      "customer_id": "123",
      "issue_date": "2021-03-09T15:59:47.118Z",
      "due_date": "2021-03-29T15:59:47.118Z",
      "currency_code": "USD",
      "line_items": [
        {
          "id": "1",
          "description": "RutterWood",
          "unit_amount": 12,
          "quantity": "1",
          "discount_amount": null,
          "sub_total": 12,
          "tax_amount": 0.60,
          "amount": "12.60,
          "discount_percentage": null,
          "tax_rate_id": "NON",
          "item_id": "1",
          "account_id": "8fcd64df-42ab-4389-96f8-7b486bc67ed2"
        },
      ],
      "status": "open",
      "total_discount": 0,
      "sub_total": 275,
      "tax_amount": 25.5,
      "total_amount": 300.5,
      "amount_due": 300.5,
      "memo": "Example invoice memo.",
      "payments": [
        {
          "id": "50",
          "amount": 50.5,
                    "date": "2021-03-19T15:59:47.118Z",
        }
      ]
    }