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.

Files can be attached to Rutter Invoices in the form of Rutter Attachments.

Properties

idstring

The Rutter generated unique ID of the invoice.

platform_idstring

The platform specific ID of the invoice.

account_idstring

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

customer_idstringnullable

The Rutter ID of the Customers linked to the invoice.

subsidiary_idstringnullable

The Rutter ID of the Subsidiary linked to the invoice. This feature is currently only supported on NetSuite.

due_datestringnullable

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

issue_datestring

The ISO 8601 timestamp for when the invoice was issued.

statusenum

The status of the invoice.

One ofopenpartially_paidpaidvoiddraftunknown, or submitted.
currency_codestringnullable

The ISO 4217 currency code of the invoice.

document_numberstringnullable

The buyer facing document number of the invoice.

memostringnullableoptional

The memo of 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.

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.

total_discountstringnullable

The total amount of discounts applied to the invoice.

linked_paymentsarray

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

Show linked_payments attributes
line_itemsarray

An array of line items associated with the invoice.

Show line_items attributes
created_atstringnullable

The ISO 8601 timestamp that the invoice was created.

updated_atstringnullable

The ISO 8601 timestamp that the invoice was last updated.

platform_dataobjectoptional

The raw platform data corresponding to the Rutter object.

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

List Invoices

GET /versioned/accounting/invoices
Supported for: NetSuiteQuickBooksQuickBooks DesktopSage IntacctXeroZoho Books

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

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

    updated_at_minintegeroptionalquery

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

Response Body

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

Fetch an Invoice

GET /versioned/accounting/invoices/:id
Supported for: NetSuiteQuickBooksQuickBooks DesktopSage IntacctXeroZoho Books

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

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

Create an Invoice

POST /versioned/accounting/invoices
Supported for: NetSuiteQuickBooksQuickBooks DesktopSage IntacctXero

Request Parameters

    access_tokenstringquery

    The access token of the connection.

Request Body

    invoiceobject
    Show invoice attributes

Response Body

    Any of:

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

Update an Invoice

PATCH /versioned/accounting/invoices/:id
Supported for: NetSuiteQuickBooksQuickBooks DesktopXero

If a field value is provided, that field will take the updated value. If the field is not provided, the existing value will persist.

Request Parameters

    idstringpath

    The Rutter generated unique ID of the object.

    access_tokenstringquery

    The access token of the connection.

Request Body

    invoiceobject
    Show invoice attributes

Response Body

    Any of:

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