Accounting

Invoices
Get API Keys

The Invoice object

A Rutter Invoice represents an invoice issued by the business entity that a customer must pay. Every invoice is linked to an accounts receivable Account, a Customer, Invoice Payments, and Invoice Credit Memos.

The invoice line item contains information regarding the items sold and accounts affected in the invoice. Every invoice line item is linked to a credit Account, Tax Rate, and Item.

Properties

idstring

The Rutter generated unique ID of the invoice.

platform_idstring

The platform specific ID of the invoice.

document_numberstringnullable

The buyer facing document number of the invoice.

customer_idstringnullable

The Rutter ID of the Customers linked to the invoice.

issue_datestring

The ISO 8601 timestamp for when the invoice was issued.

due_datestringnullable

The ISO 8601 timestamp for when the invoice is/was due.

currency_codestringnullable

The ISO 4217 currency code of the invoice.

account_idstring

The Rutter ID of the Account linked to the invoice. Represents the account being debited.

line_itemsarray

An array of line items associated with the invoice.

Show line_items attributes
statusenum

The status of the invoice.

One ofopen, partially_paid, paid, void, draft, unknown, or submitted.
total_discountstringnullable

The total amount of discounts applied to the invoice.

sub_totalstringnullable

The subtotal of the invoice, without the tax amount.

tax_amountstringnullable

The total tax amount applied to the invoice.

total_amountstringnullable

The total amount due on the invoice.

amount_duestringnullable

The current amount due on the invoice. Represents the remainder after invoice payments or invoice credit memos are applied against the total amount.

linked_paymentsarray

An array of Rutter IDs of Invoice Payments and Invoice Credit Memos applied against the invoice.

Show linked_payments attributes
memostringnullableoptional

The memo of the invoice.

created_atstringnullable
updated_atstringnullable
platform_dataoptional

The raw platform data corresponding to the Rutter object.

Example Invoice Object
{
  "id": "00000000-0000-0000-0000-000000000000",
  "account_id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "document_number": "CUSTINVC-1",
  "customer_id": "00000000-0000-0000-0000-000000000000",
  "issue_date": "2023-01-02T02:34:56.000Z",
  "due_date": "2023-01-02T02:34:56.000Z",
  "currency_code": "USD",
  "line_items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "description": "A Rutter shirt.",
      "unit_amount": "12.34",
      "quantity": 1,
      "discount_amount": "0",
      "sub_total": "12.34",
      "tax_amount": "2",
      "amount": "14.34",
      "discount_percentage": "0",
      "tax_rate_id": "00000000-0000-0000-0000-000000000000",
      "item_id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "status": "partially_paid",
  "total_discount": "0",
  "sub_total": "12.34",
  "tax_amount": "2",
  "total_amount": "14.34",
  "amount_due": "9.34",
  "memo": "For a Rutter shirt.",
  "linked_payments": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "INVOICE_PAYMENT",
      "amount": "3",
      "date": "2023-01-02T02:34:56.000Z"
    },
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "INVOICE_CREDIT_MEMO",
      "amount": "2",
      "date": "2023-01-02T02:34:56.000Z"
    }
  ],
  "created_at": "2023-01-02T02:34:56.000Z",
  "updated_at": "2023-01-02T02:34:56.000Z"
}

List Invoices

GET /accounting/invoices
Supported for: NetSuiteQuickBooksXero

Request Parameters

    access_tokenstringquery

    The access token of the connection.

    cursorstringoptionalquery

    The cursor to use for pagination. This value is passed in from next_cursor field in a previous request.

    expandenumoptionalquery

    Used to request inclusion of optional objects.

    Can beplatform_data.
    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.
    limitintegeroptionalquery

    The limit on the number of entities returned.

    updated_at_maxintegeroptionalquery

    The Unix Timestamp in milliseconds maximum updated_at datetime to fetch entities from.

    updated_at_minintegeroptionalquery

    The Unix Timestamp in milliseconds minimum updated_at datetime to fetch entities from.

Response Body

    invoicesarray
    Show invoices attributes
    next_cursorstringnullableoptional
Example Response Body
{
  "invoices": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "account_id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "document_number": "CUSTINVC-1",
      "customer_id": "00000000-0000-0000-0000-000000000000",
      "issue_date": "2023-01-02T02:34:56.000Z",
      "due_date": "2023-01-02T02:34:56.000Z",
      "currency_code": "USD",
      "line_items": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "platform_id": "12345678",
          "description": "A Rutter shirt.",
          "unit_amount": "12.34",
          "quantity": 1,
          "discount_amount": "0",
          "sub_total": "12.34",
          "tax_amount": "2",
          "amount": "14.34",
          "discount_percentage": "0",
          "tax_rate_id": "00000000-0000-0000-0000-000000000000",
          "item_id": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "status": "partially_paid",
      "total_discount": "0",
      "sub_total": "12.34",
      "tax_amount": "2",
      "total_amount": "14.34",
      "amount_due": "9.34",
      "memo": "For a Rutter shirt.",
      "linked_payments": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "INVOICE_PAYMENT",
          "amount": "3",
          "date": "2023-01-02T02:34:56.000Z"
        },
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "INVOICE_CREDIT_MEMO",
          "amount": "2",
          "date": "2023-01-02T02:34:56.000Z"
        }
      ],
      "created_at": "2023-01-02T02:34:56.000Z",
      "updated_at": "2023-01-02T02:34:56.000Z"
    }
  ],
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}

Fetch an Invoice

GET /accounting/invoices/:id
Supported for: NetSuiteQuickBooksXero

Request Parameters

    idstringpath

    The Rutter generated unique ID of the object.

    access_tokenstringquery

    The access token of the connection.

    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.

Response Body

    invoiceInvoice
    Show invoice attributes
Example Response Body
{
  "invoice": {
    "id": "00000000-0000-0000-0000-000000000000",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "document_number": "CUSTINVC-1",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "issue_date": "2023-01-02T02:34:56.000Z",
    "due_date": "2023-01-02T02:34:56.000Z",
    "currency_code": "USD",
    "line_items": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "platform_id": "12345678",
        "description": "A Rutter shirt.",
        "unit_amount": "12.34",
        "quantity": 1,
        "discount_amount": "0",
        "sub_total": "12.34",
        "tax_amount": "2",
        "amount": "14.34",
        "discount_percentage": "0",
        "tax_rate_id": "00000000-0000-0000-0000-000000000000",
        "item_id": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "status": "partially_paid",
    "total_discount": "0",
    "sub_total": "12.34",
    "tax_amount": "2",
    "total_amount": "14.34",
    "amount_due": "9.34",
    "memo": "For a Rutter shirt.",
    "linked_payments": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "type": "INVOICE_PAYMENT",
        "amount": "3",
        "date": "2023-01-02T02:34:56.000Z"
      },
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "type": "INVOICE_CREDIT_MEMO",
        "amount": "2",
        "date": "2023-01-02T02:34:56.000Z"
      }
    ],
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z"
  }
}

Create an Invoice

POST /accounting/invoices
Supported for: QuickBooks

Request Parameters

    access_tokenstringquery

    The access token of the connection.

Request Body

    invoiceobject
    Show invoice attributes

Response Body

    Any of:

    Invoice Response

    invoiceInvoice
    Show invoice attributes

    Async Response Payload

    async_responseobjectoptional
    Show async_response attributes
    errorsarrayoptional
    Show errors attributes
Example Request Body
{
  "invoice": {
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "currency_code": "USD",
    "line_items": [
      {
        "item": {
          "id": "00000000-0000-0000-0000-000000000000",
          "unit_amount": 2,
          "quantity": 1
        },
        "total_amount": 2,
        "description": "A Rutter Shirt"
      }
    ],
    "due_date": "2023-01-02T02:34:56.000Z",
    "issue_date": "2023-01-02T02:34:56.000Z"
  }
}
Example Response Body
{
  "invoice": {
    "id": "00000000-0000-0000-0000-000000000000",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "document_number": "CUSTINVC-1",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "issue_date": "2023-01-02T02:34:56.000Z",
    "due_date": "2023-01-02T02:34:56.000Z",
    "currency_code": "USD",
    "line_items": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "platform_id": "12345678",
        "description": "A Rutter shirt.",
        "unit_amount": "12.34",
        "quantity": 1,
        "discount_amount": "0",
        "sub_total": "12.34",
        "tax_amount": "2",
        "amount": "14.34",
        "discount_percentage": "0",
        "tax_rate_id": "00000000-0000-0000-0000-000000000000",
        "item_id": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "status": "partially_paid",
    "total_discount": "0",
    "sub_total": "12.34",
    "tax_amount": "2",
    "total_amount": "14.34",
    "amount_due": "9.34",
    "memo": "For a Rutter shirt.",
    "linked_payments": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "type": "INVOICE_PAYMENT",
        "amount": "3",
        "date": "2023-01-02T02:34:56.000Z"
      },
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "type": "INVOICE_CREDIT_MEMO",
        "amount": "2",
        "date": "2023-01-02T02:34:56.000Z"
      }
    ],
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z"
  }
}
Next
Invoice Credit Memos