The Invoice Credit Memo 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
idstringThe Rutter generated unique ID of the invoice credit memo.
platform_idstringThe platform specific ID of the invoice credit memo.
customer_idstringnullableThe Rutter ID of the Customer linked to the invoice credit memo.
document_numberstringnullableThe buyer facing document number of the invoice credit memo.
issue_datestringnullableThe ISO 8601 timestamp for when the invoice credit memo was issued.
allocated_atstringnullableThe ISO 8601 timestamp for when the invoice credit memo was allocated.
currency_codestringnullableThe ISO 4217 currency code of the invoice credit memo.
memostringnullableThe memo of the invoice credit memo.
statusenumnullableThe status of the invoice credit memo.
total_amountstringnullableThe total amount on the invoice credit memo.
remaining_amountstringnullableThe remaining unapplied amount of the invoice credit memo.
linked_invoicesarrayAn array of Rutter IDs of Invoices linked to the invoice credit memo.
linked_invoices attributes{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"customer_id": "00000000-0000-0000-0000-000000000000",
"document_number": "CUSTCRED-1",
"issue_date": "2023-01-02T02:34:56.000Z",
"allocated_at": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"memo": "Discount for future Rutter shirts.",
"status": "APPLIED",
"total_amount": "3",
"remaining_amount": "0",
"linked_invoices": [
{
"id": "00000000-0000-0000-0000-000000000000",
"allocated_amount": "3"
}
]
}
List Invoice Credit Memos
GET /accounting/invoice_credit_memosRequest Parameters
access_tokenstringqueryThe access token of the connection.
cursorstringoptionalqueryThe cursor to use for pagination. This value is passed in from next_cursor field in a previous request.
expandenumoptionalqueryUsed to request inclusion of optional objects.
force_fetchenumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
limitintegeroptionalqueryThe limit on the number of entities returned.
updated_at_maxintegeroptionalqueryThe Unix Timestamp in milliseconds maximum updated_at datetime to fetch entities from.
updated_at_minintegeroptionalqueryThe Unix Timestamp in milliseconds minimum updated_at datetime to fetch entities from.
Response Body
invoice_credit_memosarrayinvoice_credit_memos attributesnext_cursorstringnullable{
"invoice_credit_memos": [
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"customer_id": "00000000-0000-0000-0000-000000000000",
"document_number": "CUSTCRED-1",
"issue_date": "2023-01-02T02:34:56.000Z",
"allocated_at": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"memo": "Discount for future Rutter shirts.",
"status": "APPLIED",
"total_amount": "3",
"remaining_amount": "0",
"linked_invoices": [
{
"id": "00000000-0000-0000-0000-000000000000",
"allocated_amount": "3"
}
]
}
],
"next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}
Fetch an Invoice Credit Memo
GET /accounting/invoice_credit_memos/:idRequest Parameters
idstringpathThe Rutter generated unique ID of the object.
access_tokenstringqueryThe access token of the connection.
force_fetchenumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
Response Body
invoice_credit_memonullableinvoice_credit_memo attributes{
"invoice_credit_memo": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"customer_id": "00000000-0000-0000-0000-000000000000",
"document_number": "CUSTCRED-1",
"issue_date": "2023-01-02T02:34:56.000Z",
"allocated_at": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"memo": "Discount for future Rutter shirts.",
"status": "APPLIED",
"total_amount": "3",
"remaining_amount": "0",
"linked_invoices": [
{
"id": "00000000-0000-0000-0000-000000000000",
"allocated_amount": "3"
}
]
}
}