Invoice Credit Memos

The InvoiceCreditMemo Object

A Rutter Invoice Credit Memo represents an invoice credit memo issued to a customer that can be applied against an invoice. Every invoice credit memo is linked to an Customer and zero or more Invoices.

Properties

idstringRequired

The Rutter generated unique ID of the invoice credit memo.

platform_idstringRequired

The platform specific ID of the invoice credit memo.

account_idstringnullableRequired

The Rutter ID of the Account linked to the invoice. Represents the account being debited. This is typically the primary Accounts Receivable account.

customer_idstringnullableRequired

The Rutter ID of the Customer linked to the invoice credit memo.

allocated_atstringnullableRequired

The ISO 8601 timestamp for when the invoice credit memo was allocated.

issue_datestringnullableRequired

The ISO 8601 timestamp for when the invoice credit memo was issued.

currency_codestringnullableRequired

The ISO 4217 currency code of the invoice credit memo.

document_numberstringnullableRequired

The buyer facing document number of the invoice credit memo.

memostringnullableRequired

The memo of the invoice credit memo.

statusenumnullableRequired

The status of the invoice credit memo.

One ofOPENAPPLIEDPARTIALLY_APPLIEDDRAFT, or UNKNOWN.
remaining_amountstringnullableRequired

The remaining unapplied amount of the invoice credit memo.

total_amountstringnullableRequired

The total amount on the invoice credit memo.

linked_invoicesarrayRequired

An array of Rutter IDs of Invoices linked to the invoice credit memo.

Show linked_invoices attributes
line_itemsarrayRequired

An array of line items containing details about the invoice credit memo.

Show line_items attributes
created_atstringnullableRequired

The ISO 8601 timestamp that the invoice credit memo was created.

updated_atstringnullableRequired

The ISO 8601 timestamp that the invoice credit memo was last updated.

last_synced_atstringRequired

The ISO 8601 timestamp when the invoice credit memo was last synced by Rutter.

platform_dataobject

The raw platform data corresponding to the Rutter object.

Endpoints
GET
/accounting/invoice_credit_memos
GET
/accounting/invoice_credit_memos/:id
POST
/accounting/invoice_credit_memos
DELETE
/accounting/invoice_credit_memos/:id
POST
/accounting/invoice_credit_applications

List Invoice Credit Memos

GEThttps://production.rutterapi.com/versioned/accounting/invoice_credit_memos

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

    cursorstringquery

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

    expandenumquery

    Used to request inclusion of optional objects.

    Can beplatform_data.
    force_fetchenumquery

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

    One oftrue or false.
    last_synced_at_minintegerquery

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

    limitintegerquery

    The limit on the number of entities returned.

    sortstringquery

    The field and direction to sort by (ASC or DESC), e.g. last_synced_at ASC. Currently supports the fields: updated_at, last_synced_at. If a field is provided but ASC or DESC is not, defaults to ASC. If this field is omitted, defaults, to updated_at DESC.

    updated_at_maxintegerquery

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

    updated_at_minintegerquery

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

Response Body

    invoice_credit_memosarrayRequired
    Show invoice_credit_memos attributes
    next_cursorstringnullable
Support by integration
  • Exact
    Exact
  • Free Agent
    Free Agent
  • Freshbooks
    Freshbooks
  • KashFlow
    KashFlow

Fetch an Invoice Credit Memo

GEThttps://production.rutterapi.com/versioned/accounting/invoice_credit_memos/:id

Request Parameters

    idstringpathRequired

    The Rutter generated unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

    force_fetchenumquery

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

    One oftrue or false.

Response Body

    invoice_credit_memoobjectRequired
    Show invoice_credit_memo attributes
Support by integration
  • Exact
    Exact
  • Free Agent
    Free Agent
  • Freshbooks
    Freshbooks
  • KashFlow
    KashFlow

Create an Invoice Credit Memo

POSThttps://production.rutterapi.com/versioned/accounting/invoice_credit_memos

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    invoice_credit_memoobjectRequired
    Show invoice_credit_memo attributes

Response Body

    Any of:

    invoice_credit_memoobjectRequired
    Show invoice_credit_memo attributes
    async_responseobject
    Show async_response attributes
    errorsarray
    Show errors attributes
Support by integration
  • Exact
    Exact
  • Free Agent
    Free Agent
  • Freshbooks
    Freshbooks
  • KashFlow
    KashFlow
Example Request Body
JSON
1
{
2
"invoice_credit_memo": {
3
"account_id": "00000000-0000-0000-0000-000000000000",
4
"customer_id": "00000000-0000-0000-0000-000000000000",
5
"issue_date": "2023-01-02T02:34:56.000Z",
6
"currency_code": "USD",
7
"line_items": [
8
{
9
"account_id": "00000000-0000-0000-0000-000000000000",
10
"description": "Discount for future Rutter shirts.",
11
"total_amount": "3",
12
"item": {
13
"id": "00000000-0000-0000-0000-000000000000",
14
"quantity": 1,
15
"unit_amount": "3"
16
}
17
}
18
]
19
}
20
}
Example Response Body
JSON
1
{
2
"invoice_credit_memo": {
3
"id": "00000000-0000-0000-0000-000000000000",
4
"platform_id": "12345678",
5
"account_id": "00000000-0000-0000-0000-000000000000",
6
"customer_id": "00000000-0000-0000-0000-000000000000",
7
"allocated_at": "2023-01-02T02:34:56.000Z",
8
"issue_date": "2023-01-02T02:34:56.000Z",
9
"currency_code": "USD",
10
"document_number": "CUSTCRED-1",
11
"memo": "Discount for future Rutter shirts.",
12
"status": "APPLIED",
13
"remaining_amount": "0",
14
"total_amount": "3",
15
"linked_invoices": [
16
{
17
"id": "00000000-0000-0000-0000-000000000000",
18
"allocated_amount": "3"
19
}
20
],
21
"line_items": [
22
{
23
"id": "00000000-0000-0000-0000-000000000000",
24
"platform_id": "12345678",
25
"account_id": "00000000-0000-0000-0000-000000000000",
26
"class_id": "00000000-0000-0000-0000-000000000000",
27
"item_id": "00000000-0000-0000-0000-000000000000",
28
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
29
"description": "A Rutter shirt.",
30
"quantity": 1,
31
"amount": "14.34",
32
"discount_amount": "0",
33
"discount_percentage": "0",
34
"sub_total": "12.34",
35
"tax_amount": "2",
36
"unit_amount": "12.34"
37
}
38
],
39
"created_at": "2023-01-02T02:34:56.000Z",
40
"updated_at": "2023-01-02T02:34:56.000Z",
41
"last_synced_at": "2023-01-02T02:34:56.000Z",
42
"platform_data": {
43
"id": 123,
44
"data": "Varies by platform"
45
}
46
}
47
}

Delete an Invoice Credit Memo

DELETEhttps://production.rutterapi.com/versioned/accounting/invoice_credit_memos/:id

Request Parameters

    idstringpathRequired

    The Rutter generated unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

Response Body

    codeenumRequired

    Returns the status of the requested object: deleted indicates object was deleted by this operation, whereas not_found indicates object was not found (allowing us to make DELETE operations idempotent).

    One ofdeleted or not_found.
    successbooleanRequired

    Indicates whether deletion was successful

Support by integration
  • Netsuite
    Netsuite
Example Response Body
JSON
1
{
2
"code": "deleted",
3
"success": true
4
}

Create an Invoice Credit Memo Application

POSThttps://production.rutterapi.com/versioned/accounting/invoice_credit_applications

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    invoice_credit_applicationobjectRequired
    Show invoice_credit_application attributes

Response Body

    Any of:

    invoice_credit_applicationobjectRequired
    Show invoice_credit_application attributes
    async_responseobject
    Show async_response attributes
    errorsarray
    Show errors attributes
Support by integration
  • Netsuite
    Netsuite
  • Quickbooks
    Quickbooks
  • QuickBooks Desktop
    QuickBooks Desktop
  • Sage Intacct
    Sage Intacct
Example Request Body
JSON
1
{
2
"invoice_credit_application": {
3
"account_id": "00000000-0000-0000-0000-000000000000",
4
"customer_id": "00000000-0000-0000-0000-000000000000",
5
"invoice_credit_memo_id": "00000000-0000-0000-0000-000000000000",
6
"transaction_date": "2023-01-02T02:34:56.000Z",
7
"currency_code": "USD",
8
"memo": "Applying vendor credit for the invoice.",
9
"linked_invoices": [
10
{
11
"id": "00000000-0000-0000-0000-000000000000",
12
"allocated_amount": 12.34
13
}
14
]
15
}
16
}
Example Response Body
JSON
1
{
2
"invoice_credit_application": {
3
"success": true
4
}
5
}

Have questions?

Contact support for personalized guidance.

Contact support