Invoice Credit Memos
Properties
id
stringRequiredThe Rutter generated unique ID of the invoice credit memo.
platform_id
stringRequiredThe platform specific ID of the invoice credit memo.
account_id
stringnullableRequiredThe Rutter ID of the Account linked to the invoice. Represents the account being debited. This is typically the primary Accounts Receivable account.
customer_id
stringnullableRequiredThe Rutter ID of the Customer linked to the invoice credit memo.
allocated_at
stringnullableRequiredThe ISO 8601 timestamp for when the invoice credit memo was allocated.
issue_date
stringnullableRequiredThe ISO 8601 timestamp for when the invoice credit memo was issued.
currency_code
stringnullableRequiredThe ISO 4217 currency code of the invoice credit memo.
document_number
stringnullableRequiredThe buyer facing document number of the invoice credit memo.
memo
stringnullableRequiredThe memo of the invoice credit memo.
status
enumnullableRequiredThe status of the invoice credit memo.
remaining_amount
stringnullableRequiredThe remaining unapplied amount of the invoice credit memo.
total_amount
stringnullableRequiredThe total amount on the invoice credit memo.
linked_invoices
arrayRequiredAn array of Rutter IDs of Invoices linked to the invoice credit memo.
linked_invoices
attributesline_items
arrayRequiredAn array of line items containing details about the invoice credit memo.
line_items
attributescreated_at
stringnullableRequiredThe ISO 8601 timestamp that the invoice credit memo was created.
updated_at
stringnullableRequiredThe ISO 8601 timestamp that the invoice credit memo was last updated.
last_synced_at
stringRequiredThe ISO 8601 timestamp when the invoice credit memo was last synced by Rutter.
platform_data
objectThe raw platform data corresponding to the Rutter object.
List Invoice Credit Memos
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryThe cursor to use for pagination. This value is passed in from next_cursor
field in a previous request.
expand
enumqueryUsed to request inclusion of optional objects.
force_fetch
enumqueryForce a response even if the underlying connection hasn't finished the initial sync.
last_synced_at_min
integerqueryUnix Timestamp in milliseconds representing the minimum last_synced_at datetime to fetch entities from.
limit
integerqueryThe limit on the number of entities returned.
sort
stringqueryThe 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_max
integerqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integerqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
invoice_credit_memos
arrayRequiredinvoice_credit_memos
attributesnext_cursor
stringnullable- QuickBooks
- Netsuite
- Xero
- QuickBooks Desktop
Fetch an Invoice Credit Memo
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
force_fetch
enumqueryForce a response even if the underlying connection hasn't finished the initial sync.
Response Body
invoice_credit_memo
objectRequiredinvoice_credit_memo
attributes- QuickBooks
- Netsuite
- Xero
- QuickBooks Desktop
Create an Invoice Credit Memo
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
invoice_credit_memo
objectRequiredinvoice_credit_memo
attributesResponse Body
Any of:
invoice_credit_memo
objectRequiredinvoice_credit_memo
attributesasync_response
objectasync_response
attributeserrors
arrayerrors
attributes- QuickBooks
- Netsuite
- Xero
- QuickBooks Desktop
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}
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
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
Response Body
code
enumRequiredReturns 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).
success
booleanRequiredIndicates whether deletion was successful
- Netsuite
1{
2 "code": "deleted",
3 "success": true
4}
Create an Invoice Credit Memo Application
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
invoice_credit_application
objectRequiredinvoice_credit_application
attributesResponse Body
Any of:
invoice_credit_application
objectRequiredinvoice_credit_application
attributesasync_response
objectasync_response
attributeserrors
arrayerrors
attributes- QuickBooks
- Netsuite
- Xero
- QuickBooks Desktop
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}
1{
2 "invoice_credit_application": {
3 "success": true
4 }
5}
Have questions?
Contact support for personalized guidance.