Invoice Credit Notes

An Invoice Credit Note is a financial transaction representing a reduction that can be applied against one or multiple invoices issued to Customers. From the Invoice Credit Notes endpoint, you can retrieve a list of all invoice credit notes for a specified business.

The Invoice Credit Note Object

PropertyTypeDescription
idstringThe unique Rutter ID for the invoice credit note.
platform_idstringThe internal platform ID for the invoice credit note.
customer_idstringThe linked Rutter ID of the customer attached to this invoice credit note.
issue_datestringThe issue date in ISO 8601.
allocated_atstring | nullThe date in ISO 8601 of when the invoice credit note was fully allocated. Null if the invoice credit note is not fully allocated.
currency_codestringThe ISO-4217 currency code of the invoice credit note
memostringA short description of the invoice credit note.
statusstringThe status of the invoice credit note. Can be "OPEN", "APPLIED", "PARTIALLY_APPLIED", or "CLOSED"
total_amountnumberTotal amount of the invoice credit note.
remainingnumberThe unallocated amount of the invoice credit note.
linked_invoicesobject[]An array of linked invoice IDs and their respective invoice credit note allocations.
{
   "id":"7a380c81-d5b4-437e-8393-12915bbd549a",
   "platform_id":"1",
   "customer_id":"e7a24a1c-f4e7-4de1-b351-fc20bc23de28",
   "document_number":"13",
   "issue_date":"2021-03-09T10:18:29.985Z",
   "allocated_at":"2021-03-09T10:18:29.985Z",
   "currency_code":"USD",
   "memo":"Refund for broken items",
   "status":"APPLIED",
   "total_amount":100,
   "remaining_amount":0,
   "linked_invoices":[
      {
         "invoice_id":"6e3ba0e7-a21b-44e8-9e58-11471e2b9115",
         "allocated_amount":100
      }
   ]
}