Credit Memos

GET /accounting/credit-memos

Group: Accounting › Credit Memos · Operation ID: creditMemos

Returns a list of credit memos. To match by credit memo number, customer name or number, entity name, description or external identifier, use POST accounting/credit-memos/search.

Open in the interactive reference

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
creditMemoDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
creditMemoStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
creditMemoType — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
manualCreditMemoType — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
currency — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
customerId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
entityId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
invoiceId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, creditMemoDate, creditMemoStatus, creditMemoType, manualCreditMemoType, currency, customerId, entityId, invoiceId, subtotal, totalTax, totalDutiesAndCustoms, totalAmountCredited, appliedAmount, unappliedAmount, lastModifiedDate
Selectable: id, creditMemoNumber, creditMemoDate, creditMemoStatus, creditMemoType, manualCreditMemoType, currency, description, externalCreditMemoId, customerId, customerName, customerNumber, entityId, entityName, invoiceId, invoiceNumber, subtotal, totalTax, totalDutiesAndCustoms, totalAmountCredited, appliedAmount, unappliedAmount, lastModifiedDate

Response

200 Success

Under data, an array of creditMemosRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the credit memo.
`creditMemoNumber`	string or null	no	The credit memo number, for example 'CM-1'. Absent while none has been assigned.
`creditMemoDate`	string (date)	no	The date the credit memo was issued. Format YYYY-MM-DD.
`creditMemoStatus`	string or null	no	The application status of the credit memo. Possible values: 'unapplied', 'partiallyApplied', 'appliedInFull'.
`creditMemoType`	string or null	no	How the credit memo was created. Possible values: 'manual', 'creditRebill', 'earlyRenewal', 'lateFees', 'cancellation', 'inventoryReturn'. Only 'manual' credit memos are created through this API. The rest come from internal workflows.
`manualCreditMemoType`	string or null	no	The reason for a manual credit memo, as a tenant-configured key, for example 'writeOff' or 'customerSatisfaction'. Absent when creditMemoType is not 'manual'.
`currency`	string	no	The currency of the credit memo. Every amount on the record, its lines and its application rows is in this currency. Format ISO 4217, for example 'USD'.
`description`	string or null	no	A free-form description of the credit memo.
`externalCreditMemoId`	string or null	no	The identifier of this credit memo in an external source system. For identifiers owned by your other systems, use externalIdentifiers below.
`customerId`	string or null	no	The customer the credit memo is issued to. See id on GET accounting/customers/:id.
`customerName`	string or null	no	The name of the customer the credit memo is issued to.
`customerNumber`	string or null	no	The customer number of the customer the credit memo is issued to.
`entityId`	string or null	no	The legal entity that issued the credit memo. See id on GET base/entities.
`entityName`	string or null	no	The name of the legal entity that issued the credit memo.
`invoiceId`	string or null	no	The invoice the credit memo was created from. Absent when it was not created from an invoice. See id on GET accounting/invoices/:id.
`invoiceNumber`	string or null	no	The number of the invoice the credit memo was created from. Present whenever invoiceId is.
`subtotal`	string (decimal) or null	no	The subtotal before tax and duties, in the credit memo currency. Absent when no subtotal has been computed.
`totalTax`	string (decimal) or null	no	The total tax across all lines, in the credit memo currency.
`totalDutiesAndCustoms`	string (decimal) or null	no	The total duties and customs across all lines, in the credit memo currency.
`totalAmountCredited`	string (decimal) or null	no	The total credited, including tax and duties, in the credit memo currency.
`appliedAmount`	string (decimal) or null	no	The amount applied to invoices and debit memos so far, in the credit memo currency. This is the net of the application rows below.
`unappliedAmount`	string (decimal) or null	no	The amount still available to apply, in the credit memo currency.
`lastModifiedDate`	string (date-time) or null	no	The date and time the credit memo last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error