Invoice Credit Memos
Properties
id
stringThe Rutter generated unique ID of the invoice credit memo.
platform_id
stringThe platform specific ID of the invoice credit memo.
account_id
stringnullableThe Rutter ID of the Account linked to the invoice. Represents the account being debited. This is typically the primary Accounts Receivable account.
customer_id
stringnullableThe Rutter ID of the Customer linked to the invoice credit memo.
allocated_at
stringnullableThe ISO 8601 timestamp for when the invoice credit memo was allocated.
issue_date
stringnullableThe ISO 8601 timestamp for when the invoice credit memo was issued.
currency_code
stringnullableThe ISO 4217 currency code of the invoice credit memo.
document_number
stringnullableThe buyer facing document number of the invoice credit memo.
memo
stringnullableThe memo of the invoice credit memo.
status
enumnullableThe status of the invoice credit memo.
remaining_amount
stringnullableThe remaining unapplied amount of the invoice credit memo.
total_amount
stringnullableThe total amount of the invoice credit memo.
linked_invoices
arrayAn array of Rutter IDs of Invoices linked to the invoice credit memo.
linked_invoices
attributesline_items
arrayAn array of line items containing details about the invoice credit memo.
line_items
attributescreated_at
stringfilterablenullableThe ISO 8601 timestamp that the invoice credit memo was created.
updated_at
stringfilterablenullableThe ISO 8601 timestamp that the invoice credit memo was last updated.
last_synced_at
stringfilterableThe ISO 8601 timestamp when the invoice credit memo was last synced by Rutter.
platform_url
stringnullableA URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.
platform_data
objectOptionalThe raw platform data corresponding to the Rutter object.
List Invoice Credit Memos
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryOptionalUsed to paginate to the next batch of objects. Should be a copy of the next_cursor
value from the previous response.
limit
integerqueryOptionalUsed to limit the number of returned objects. Defaults to 50.
filter
stringqueryOptionalUsed to specify criteria to filter out the objects returned. Supports all filterable
fields. Check Filtering Objects for more information. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.
sort
stringqueryOptionalUsed to sort the returned objects, e.g. last_synced_at ASC
. Supports all filterable
fields except on QuickBooks Desktop, Sage Intacct, and Dynamics 365. For those platforms only updated_at
and last_synced_at
fields are supported. If a value is provided but ASC
or DESC
is not, defaults to ASC
. If omitted, defaults to updated_at DESC
.
expand
enumqueryOptionalInclude platform specific data (includes additional fields not provided by the Rutter object).
last_synced_at_min
integerqueryOptionalDeprecated - use filter
instead. Used to filter objects with a last_synced_at
value greater than or equal to the supplied value. Should be a Unix time in milliseconds.
updated_at_max
integerqueryOptionalDeprecated - use filter
instead. Used to filter objects with a updated_at
value less than or equal to the supplied value. Should be a Unix time in milliseconds.
updated_at_min
integerqueryOptionalDeprecated - use filter
instead. Used to filter objects with a updated_at
value greater than or equal to the supplied value. Should be a Unix time in milliseconds.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
invoice_credit_memos
arrayinvoice_credit_memos
attributesnext_cursor
stringnullableOptionalconnection
objectconnection
attributes- QuickBooks
- NetSuite
- Xero
- QuickBooks Desktop
1{
2 "invoice_credit_memos": [
3 {
4 "id": "00000000-0000-0000-0000-000000000000",
5 "platform_id": "12345678",
6 "account_id": "00000000-0000-0000-0000-000000000000",
7 "customer_id": "00000000-0000-0000-0000-000000000000",
8 "allocated_at": "2023-01-02T02:34:56.000Z",
9 "issue_date": "2023-01-02T02:34:56.000Z",
10 "currency_code": "USD",
11 "document_number": "CUSTCRED-1",
12 "memo": "Discount for future Rutter shirts.",
13 "status": "APPLIED",
14 "remaining_amount": "0",
15 "total_amount": "3",
16 "linked_invoices": [
17 {
18 "id": "00000000-0000-0000-0000-000000000000",
19 "allocated_amount": "3"
20 }
21 ],
22 "line_items": [
23 {
24 "id": "00000000-0000-0000-0000-000000000000",
25 "platform_id": "12345678",
26 "account_id": "00000000-0000-0000-0000-000000000000",
27 "class_id": "00000000-0000-0000-0000-000000000000",
28 "item_id": "00000000-0000-0000-0000-000000000000",
29 "tax_rate_id": "00000000-0000-0000-0000-000000000000",
30 "description": "A Rutter shirt.",
31 "quantity": 1,
32 "amount": "14.34",
33 "discount_amount": "0",
34 "discount_percentage": "0",
35 "sub_total": "12.34",
36 "tax_amount": "2",
37 "unit_amount": "12.34"
38 }
39 ],
40 "created_at": "2023-01-02T02:34:56.000Z",
41 "updated_at": "2023-01-02T02:34:56.000Z",
42 "last_synced_at": "2023-01-02T02:34:56.000Z",
43 "platform_url": "https://platform.com/resource?id=123",
44 "platform_data": {
45 "id": 123,
46 "data": "Varies by platform"
47 }
48 }
49 ],
50 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
51 "connection": {
52 "id": "00000000-0000-0000-0000-000000000000",
53 "orgId": "00000000-0000-0000-0000-000000000000",
54 "platform": "NETSUITE"
55 }
56}
Fetch an Invoice Credit Memo
Request Parameters
id
stringpathRequiredThe unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
id_type
enumqueryOptionalUsed to indicate the type of id
that is supplied. Defaults to rutter
. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
invoice_credit_memo
objectinvoice_credit_memo
attributesconnection
objectconnection
attributes- QuickBooks
- NetSuite
- Xero
- QuickBooks Desktop
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_url": "https://platform.com/resource?id=123",
43 "platform_data": {
44 "id": 123,
45 "data": "Varies by platform"
46 }
47 },
48 "connection": {
49 "id": "00000000-0000-0000-0000-000000000000",
50 "orgId": "00000000-0000-0000-0000-000000000000",
51 "platform": "NETSUITE"
52 }
53}
Create an Invoice Credit Memo
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
invoice_credit_memo
objectinvoice_credit_memo
attributesResponse Body
Any of:
invoice_credit_memo
objectinvoice_credit_memo
attributesasync_response
objectOptionalasync_response
attributeserrors
arrayOptionalerrors
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_url": "https://platform.com/resource?id=123",
43 "platform_data": {
44 "id": 123,
45 "data": "Varies by platform"
46 }
47 }
48}
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
Any of:
deleted_invoice_credit_memo
objectdeleted_invoice_credit_memo
attributesasync_response
objectOptionalasync_response
attributeserrors
arrayOptionalerrors
attributes- NetSuite
1{
2 "deleted_invoice_credit_memo": {
3 "code": "deleted",
4 "success": true
5 }
6}
Create an Invoice Credit Memo Application
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
invoice_credit_application
objectinvoice_credit_application
attributesResponse Body
Any of:
invoice_credit_application
objectinvoice_credit_application
attributesasync_response
objectOptionalasync_response
attributeserrors
arrayOptionalerrors
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}
Update an Invoice Credit Memo Application
Endpoint Not Available for Version 2024-04-30
Have questions?
Contact support for personalized guidance.