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
id
stringThe Rutter generated unique ID of the invoice.
platform_id
stringThe platform specific ID of the invoice.
account_id
stringThe Rutter ID of the Account linked to the invoice. Represents the account being debited.
customer_id
stringnullableThe Rutter ID of the Customers linked to the invoice.
due_date
stringnullableThe ISO 8601 timestamp for when the invoice is/was due.
issue_date
stringThe ISO 8601 timestamp for when the invoice was issued.
status
enumThe status of the invoice.
currency_code
stringnullableThe ISO 4217 currency code of the invoice.
document_number
stringnullableThe buyer facing document number of the invoice.
memo
stringnullableoptionalThe memo of the invoice.
amount_due
stringnullableThe current amount due on the invoice. Represents the remainder after invoice payments or invoice credit memos are applied against the total amount.
sub_total
stringnullableThe subtotal of the invoice, without the tax amount.
tax_amount
stringnullableThe total tax amount applied to the invoice.
total_amount
stringnullableThe total amount due on the invoice.
total_discount
stringnullableThe total amount of discounts applied to the invoice.
linked_payments
arrayAn array of Rutter IDs of Invoice Payments and Invoice Credit Memos applied against the invoice.
linked_payments
attributesline_items
arrayAn array of line items associated with the invoice.
line_items
attributescreated_at
stringnullableupdated_at
stringnullableplatform_data
objectoptionalThe raw platform data corresponding to the Rutter object.
platform_data
attributes{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"account_id": "00000000-0000-0000-0000-000000000000",
"customer_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 /accounting/invoicesRequest Parameters
access_token
stringqueryThe access token of the connection.
cursor
stringoptionalqueryThe cursor to use for pagination. This value is passed in from next_cursor
field in a previous request.
expand
enumoptionalqueryUsed to request inclusion of optional objects.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
limit
integeroptionalqueryThe limit on the number of entities returned.
updated_at_max
integeroptionalqueryThe Unix Timestamp in milliseconds maximum updated_at datetime to fetch entities from.
updated_at_min
integeroptionalqueryThe Unix Timestamp in milliseconds minimum updated_at datetime to fetch entities from.
Response Body
connection
objectconnection
attributesinvoices
arrayinvoices
attributesnext_cursor
stringnullableoptional{
"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",
"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 /accounting/invoices/:idRequest Parameters
id
stringpathThe Rutter generated unique ID of the object.
access_token
stringqueryThe access token of the connection.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
Response Body
connection
objectconnection
attributesinvoice
objectinvoice
attributes{
"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",
"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 /accounting/invoicesRequest Parameters
access_token
stringqueryThe access token of the connection.
Request Body
invoice
objectinvoice
attributesResponse Body
Any of:
invoice
objectinvoice
attributesasync_response
objectoptionalasync_response
attributeserrors
arrayoptionalerrors
attributes{
"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",
"line_items": [
{
"total_amount": 2,
"description": "A Rutter Shirt",
"item": {
"id": "00000000-0000-0000-0000-000000000000",
"quantity": 1,
"unit_amount": 2
}
}
]
}
}
{
"invoice": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"account_id": "00000000-0000-0000-0000-000000000000",
"customer_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"
}
}
}