List debit memos
Operation ID: debitMemos
Group: Accounting › Debit Memos
Open in the interactive reference
GET /accounting/debit-memos
Read-only: Reads and returns; changes nothing.
Lists debit memos. To filter by debit memo number, customer name or number, purchase order, customer message, or external identifier, use POST accounting/debit-memos/search.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Api-Version |
header | string · 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, likecreditMemoId— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likedebitMemoDate— filter by eq, ne, gt, gte, lt, lte, in, notIn, betweendueDate— filter by eq, ne, gt, gte, lt, lte, in, notIn, betweentaxDate— filter by eq, ne, gt, gte, lt, lte, in, notIn, betweenapprovalStatus— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likedebitMemoStatus— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likedebitMemoType— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likecurrency— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likecustomerId— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likeentityId— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likepaymentTerm— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likeisMigrated— filter by eq, ne, gt, gte, lt, lte, in, notIn, betweendebitGlAccountId— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likebillToAddressId— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likesoldToAddressId— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likelastModifiedDate— filter by eq, ne, gt, gte, lt, lte, in, notIn, between- 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
page[size]— Page sizepage[cursor]— Opaque continuation cursor
Response
200 Success
Under data, an array of debitMemosRow:
| Field | Type | Required | Filter | Sort | Description |
|---|---|---|---|---|---|
id |
string | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | The unique identifier for the debit memo. |
debitMemoNumber |
string | null | no | no | no | The debit memo number, for example 'DM-1'. Absent while none has been assigned. |
creditMemoId |
string | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | The source credit memo this debit memo settles. Absent on a standalone debit memo. See id on GET accounting/credit-memos/:id. |
creditMemoNumber |
string | null | no | no | no | The number of the source credit memo. Present whenever creditMemoId is. |
debitMemoDate |
date | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) |
yes | The date the debit memo was issued. Format YYYY-MM-DD. |
dueDate |
date | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) |
yes | The date the debit memo falls due. Format YYYY-MM-DD. Computed from debitMemoDate plus the payment term's days. |
taxDate |
date | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) |
yes | The date the debit memo's tax was determined on. Format YYYY-MM-DD. Defaults to debitMemoDate. |
approvalStatus |
string | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | The approval status of the debit memo. Possible values: 'draft', 'pendingApproval', 'revise', 'approved', 'rejected'. Only an approved debit memo has financial effect. |
debitMemoStatus |
string | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | The payment and credit coverage status. Possible values: 'unpaid', 'isOverdue', 'partiallyPaid', 'paidInFull', 'creditedInFull', 'disputed'. Absent before approval. |
debitMemoType |
string | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | The reason key for the charge, for example 'orderEntryError'. The accepted keys are configured per tenant. |
currency |
string | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | The currency of the debit memo. Format ISO 4217, for example 'USD'. It governs every amount on the record. |
customerId |
string | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | The customer the debit memo is issued to. See id on GET accounting/customers/:id. |
customerName |
string | null | no | no | no | The display name of the customer. |
customerNumber |
string | null | no | no | no | The customer number. |
entityId |
string | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | The legal entity that issued the debit memo. See id on GET base/entities. |
entityName |
string | null | no | no | no | The name of the issuing legal entity. |
paymentTerm |
string | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | The payment-term key applied to the debit memo. See code on GET accounting/payment-terms. |
purchaseOrder |
string | null | no | no | no | The customer's own purchase-order reference. |
customerMessage |
string | null | no | no | no | A free-text message shown to the customer on the document. |
externalDebitMemoId |
string | null | no | no | no | The identifier of this debit memo in an external source system. |
isMigrated |
boolean | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) |
yes | 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 | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
no | The general ledger account the journal entry debits for the debit memo's full amount. See id on GET accounting/accounts/:id. |
billToAddressId |
string | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
no | The bill-to address on the document. There is no endpoint for it. |
soldToAddressId |
string | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
no | The sold-to address on the document. There is no endpoint for it. |
subtotal |
decimal | null | no | no | no | The sum of the lines' pre-discount totals, in the debit memo currency. |
totalAmount |
decimal | null | no | no | no | The total including tax, in the debit memo currency. |
totalTax |
decimal | null | no | no | no | The total tax across all lines, in the debit memo currency. |
totalAmountDebited |
decimal | null | no | no | no | The gross amount debited, in the debit memo currency. |
lineDiscounts |
decimal | null | no | no | no | The sum of the prorated discount amounts across all lines, in the debit memo currency. |
unappliedCreditAmount |
decimal | null | no | no | no | The credit still unapplied on the source credit memo, in the debit memo currency. Absent on a standalone debit memo. |
lastModifiedDate |
date-time | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) |
yes | The date and time the debit memo record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |
{
"data": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"debitMemoNumber": "<debitMemoNumber>",
"creditMemoId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"creditMemoNumber": "<creditMemoNumber>",
"debitMemoDate": "2026-01-15",
"dueDate": "2026-01-15",
"taxDate": "2026-01-15",
"approvalStatus": "<approvalStatus>",
"debitMemoStatus": "<debitMemoStatus>",
"debitMemoType": "<debitMemoType>",
"currency": "<currency>",
"customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"customerName": "<customerName>",
"customerNumber": "<customerNumber>",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityName": "<entityName>",
"paymentTerm": "<paymentTerm>",
"purchaseOrder": "<purchaseOrder>",
"customerMessage": "<customerMessage>",
"externalDebitMemoId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isMigrated": true,
"debitGlAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"billToAddressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"soldToAddressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"subtotal": "19.99",
"totalAmount": "19.99",
"totalTax": "19.99",
"totalAmountDebited": "19.99",
"lineDiscounts": "19.99",
"unappliedCreditAmount": "19.99",
"lastModifiedDate": "2026-01-15T09:30:00.000Z"
}
],
"pagination": {
"hasMore": true,
"nextCursor": "<nextCursor>"
}
}
Statuses
400— Invalid request or business failure401— The request carries no valid access token.403— Not authorized404— Not found429— Too many requests from this client address. The response has no body and noRetry-Afterheader.500— Internal server error