Invoices

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

The Invoice Object

Property

Type

Description

id

string

A Rutter designated ID for this invoice. It always will be in UUID format.

platform_id

string

Unique Platform ID for this invoice.

account_id

string

Platform ID associated with the platform account.

document_number

string

Reference document number for the invoice.

customer_id

string

Corresponding customer Platform ID that receives the invoice.

line_items

Invoice Line Item[]

Array of line items contained in the invoice. See example API reference below.

posted_date

string

Date of the invoice as recorded in the accounting platform in ISO 8601 format.

due_date

string

The due date in ISO 8601.

currency_code

string

The ISO-4217 currency code

status

string

Current 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).
partiallyPaid - 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_discount

number

Total value of discounts applied to the invoice.

sub_total

number

Total amount of the invoice excluding any taxes.

tax_amount

number

Total tax amount on the invoice.

total

number

Total amount of the invoice.

amount_due

number

Total pending amount due for the invoice.

discount_percentage

number

Percentage rate of discounts applied to the invoice.

memo

string

Overall description for the invoice

payments

object[]

Array of payments associated with the invoice.

Invoice Line Item

Field

Type

Description

id

string

A Rutter designated ID for this invoice line item. It always will be in UUID format.

platform_id

string

Platform ID associated with this invoice line item.

item_id

string

Platform ID of the product/service for this invoice line item.

item_name

string

Name of the product/service for this invoice line item.

quantity

number

The quantity of the product/service for this invoice line item.

unit_amount

number

Price per quantity for this invoice line item.

amount

number

The amount for this invoice line item.

{
      "id": "11111aa1-1a11-111a-aa1a-11aaa1a1aa11",
      "platform_id": "2",
      "account_id": "1000000",
      "document_number": "IN-00-1000000",
      "customer_id": "123",
      "posted_date": "2021-03-09T15:59:47.118Z",
      "due_date": "2021-03-09T15:59:47.118Z",
      "currency_code": "USD",
      "line_items": [
        {
          "id": "b22b2222-2b2b-2bb2-bbb2-bb222bb2b22",
          "platform_id": "123",
          "name": "Rutter Pants",
          "quantity": 3,
          "unit_amount": 75,
          "amount": 225,
        },
        {
          "id": "b11b1111-1b1b-1bb1-bbb1-bb111bb1b11",
          "platform_id": "124",
          "name": "Rutter Shoes",
          "quantity": 10,
          "unit_amount": 25,
          "amount": 250,
        },
      ],
      "status": "open",
      "total_discount": 0,
      "sub_total": 275,
      "tax_amount": 25.5,
      "total_amount": 300.5,
      "amount_due": 300.5,
      "discount_percentage": 0,
      "memo": "Example invoice memo.",
      "payments": [
        {
          "amount": 50.5,
          "id": "50"
        }
      ]
    }