Debit Memos

GET /accounting/debit-memos

Group: Accounting › Debit Memos · Operation ID: debitMemos

Returns a list of debit memos. To filter by document number, counterparty name, purchase order, customer message or any amount, use POST accounting/debit-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
creditMemoId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
debitMemoDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
dueDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
taxDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
approvalStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
debitMemoStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
debitMemoType — 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
paymentTerm — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
isMigrated — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
debitGlAccountId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
billToAddressId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
soldToAddressId — 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, creditMemoId, customerId, entityId, debitMemoDate, dueDate, taxDate, approvalStatus, debitMemoStatus, debitMemoType, currency, paymentTerm, isMigrated, lastModifiedDate
Selectable: id, debitMemoNumber, creditMemoId, creditMemoNumber, debitMemoDate, dueDate, taxDate, approvalStatus, debitMemoStatus, debitMemoType, currency, customerId, customerName, customerNumber, entityId, entityName, paymentTerm, purchaseOrder, customerMessage, externalDebitMemoId, isMigrated, debitGlAccountId, billToAddressId, soldToAddressId, subtotal, totalAmount, totalTax, totalAmountDebited, lineDiscounts, unappliedCreditAmount, lastModifiedDate

Response

200 Success

Under data, an array of debitMemosRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the debit memo.
`debitMemoNumber`	string or null	no	The debit memo number, for example 'DM-1'. Absent while none has been assigned.
`creditMemoId`	string or null	no	The source credit memo this debit memo settles. Absent on a standalone debit memo. See id on GET accounting/credit-memos/:id.
`creditMemoNumber`	string or null	no	The number of the source credit memo. Present whenever creditMemoId is.
`debitMemoDate`	string (date)	no	The date the debit memo was issued. Format YYYY-MM-DD.
`dueDate`	string (date) or null	no	The date the debit memo falls due. Format YYYY-MM-DD. Computed from debitMemoDate plus the payment term's days.
`taxDate`	string (date) or null	no	The date the debit memo's tax was determined on. Format YYYY-MM-DD. Defaults to debitMemoDate.
`approvalStatus`	string or null	no	The approval status of the debit memo. Possible values: 'draft', 'pendingApproval', 'revise', 'approved', 'rejected'. Only an approved debit memo has financial effect.
`debitMemoStatus`	string or null	no	The payment and credit coverage status. Possible values: 'unpaid', 'isOverdue', 'partiallyPaid', 'paidInFull', 'creditedInFull', 'disputed'. Absent before approval.
`debitMemoType`	string	no	The reason key for the charge, for example 'orderEntryError'. The accepted keys are configured per tenant.
`currency`	string	no	The currency of the debit memo. Format ISO 4217, for example 'USD'. It governs every amount on the record.
`customerId`	string or null	no	The customer the debit memo is issued to. See id on GET accounting/customers/:id.
`customerName`	string or null	no	The display name of the customer.
`customerNumber`	string or null	no	The customer number.
`entityId`	string or null	no	The legal entity that issued the debit memo. See id on GET base/entities.
`entityName`	string or null	no	The name of the issuing legal entity.
`paymentTerm`	string	no	The payment-term key applied to the debit memo. See code on GET accounting/payment-terms.
`purchaseOrder`	string or null	no	The customer's own purchase-order reference.
`customerMessage`	string or null	no	A free-text message shown to the customer on the document.
`externalDebitMemoId`	string or null	no	The identifier of this debit memo in an external source system.
`isMigrated`	boolean or null	no	Whether the debit memo was loaded from a previous system. When true, it is excluded from dunning and its journal entries are auto-reversed.
`debitGlAccountId`	string or null	no	The header debit GL account the journal entry posts to, an Asset-type account. See id on GET accounting/accounts/:id.
`billToAddressId`	string or null	no	The bill-to address on the document. There is no endpoint for it.
`soldToAddressId`	string or null	no	The sold-to address on the document. There is no endpoint for it.
`subtotal`	string (decimal) or null	no	The sum of the lines' pre-discount totals, in the debit memo currency.
`totalAmount`	string (decimal) or null	no	The total including tax, in the debit memo currency.
`totalTax`	string (decimal) or null	no	The total tax across all lines, in the debit memo currency.
`totalAmountDebited`	string (decimal) or null	no	The gross amount debited, in the debit memo currency.
`lineDiscounts`	string (decimal) or null	no	The sum of the prorated discount amounts across all lines, in the debit memo currency.
`unappliedCreditAmount`	string (decimal) or null	no	The credit still unapplied on the source credit memo, in the debit memo currency. Absent on a standalone debit memo.
`lastModifiedDate`	string (date-time) or null	no	The date and time the debit memo record 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