Retrieve a debit memo

Operation ID: getDebitMemo

Group: Accounting › Debit Memos

GET /accounting/debit-memos/{id}

Read-only: Reads and returns; changes nothing.

Retrieves a debit memo. Use the debit memo's id, not its debitMemoNumber.

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`.
`id`	path	string	yes	The unique identifier of the debit memo you want to retrieve.

Response

200 Success

Under data (getDebitMemoOutput):

Field	Type	Required	Description
`id`	string	yes	The unique identifier for the debit memo.
`debitMemoNumber`	string	no	The debit memo number, for example 'DM-1'. Absent while none has been assigned.
`creditMemoId`	string	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	no	The number of the source credit memo. Present whenever creditMemoId is.
`debitMemoDate`	date	yes	The date the debit memo was issued. Format YYYY-MM-DD.
`dueDate`	date	no	The date the debit memo falls due. Format YYYY-MM-DD. Computed from debitMemoDate plus the payment term's days.
`taxDate`	date	no	The date the debit memo's tax was determined on. Format YYYY-MM-DD. Defaults to debitMemoDate.
`approvalStatus`	string	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	no	The payment and credit coverage status. Possible values: 'unpaid', 'isOverdue', 'partiallyPaid', 'paidInFull', 'creditedInFull', 'disputed'. Absent before approval.
`debitMemoType`	string	yes	The reason key for the charge, for example 'orderEntryError'. The accepted keys are configured per tenant.
`currency`	string	yes	The currency of the debit memo. Format ISO 4217, for example 'USD'. It governs every amount on the record.
`customerId`	string	yes	The customer the debit memo is issued to. See id on GET accounting/customers/:id.
`customerName`	string	no	The display name of the customer.
`customerNumber`	string	no	The customer number.
`entityId`	string	yes	The legal entity that issued the debit memo. See id on GET base/entities.
`entityName`	string	no	The name of the issuing legal entity.
`paymentTerm`	string	yes	The payment-term key applied to the debit memo. See code on GET accounting/payment-terms.
`purchaseOrder`	string	no	The customer's own purchase-order reference.
`customerMessage`	string	no	A free-text message shown to the customer on the document.
`externalDebitMemoId`	string	no	The identifier of this debit memo in an external source system.
`isMigrated`	boolean	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	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	yes	The bill-to address on the document. There is no endpoint for it.
`soldToAddressId`	string	yes	The sold-to address on the document. There is no endpoint for it.
`subtotal`	decimal	no	The sum of the lines' pre-discount totals, in the debit memo currency.
`totalAmount`	decimal	no	The total including tax, in the debit memo currency.
`totalTax`	decimal	no	The total tax across all lines, in the debit memo currency.
`totalAmountDebited`	decimal	no	The gross amount debited, in the debit memo currency.
`lineDiscounts`	decimal	no	The sum of the prorated discount amounts across all lines, in the debit memo currency.
`unappliedCreditAmount`	decimal	no	The credit still unapplied on the source credit memo, in the debit memo currency. Absent on a standalone debit memo.
`lastModifiedDate`	date-time	yes	The date and time the debit memo record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
`lines`	array<object>	no	The lines of the debit memo, each debiting one line of the source credit memo. An empty array when the debit memo has no lines. All line amounts are in the debit memo currency.
`lines[].id`	string	yes	The unique identifier for the debit memo line.
`lines[].lineNumber`	string	no	The sequential line number within the debit memo.
`lines[].description`	string	no	A free-text line description, shown to the customer.
`lines[].productId`	string	no	The debited product. Absent on a free-text line. See id on GET accounting/products/:id.
`lines[].creditMemoLineId`	string	no	The source credit memo line this line debits. See lines[].id on GET accounting/credit-memos/:id.
`lines[].quantity`	decimal	no	The quantity debited. A count, not an amount, so it has no currency.
`lines[].unitOfMeasure`	string	no	The unit-of-measure key, for example 'each'.
`lines[].unitPrice`	decimal	no	The price per unit, in the debit memo currency.
`lines[].adjustedUnitPrice`	decimal	no	The price per unit after adjustment, in the debit memo currency.
`lines[].listPrice`	decimal	no	The list price per unit as it stood on the source credit memo line, in the debit memo currency.
`lines[].listPriceTotal`	decimal	no	The pre-discount line total, in the debit memo currency.
`lines[].discountAmount`	decimal	no	The discount from the source credit memo line, in the debit memo currency.
`lines[].discountPercentage`	decimal	no	The discount as a percentage of the list price. A percentage, not an amount, so it has no currency.
`lines[].totalPrice`	decimal	no	The line total excluding tax, in the debit memo currency.
`lines[].amountDebited`	decimal	no	The amount debited for the line, in the debit memo currency.
`lines[].totalAmountDue`	decimal	no	The amount of the source credit memo line still available to debit, in the debit memo currency.
`lines[].taxAmount`	decimal	no	The tax on the line, in the debit memo currency.
`lines[].taxCode`	string	no	The tax code applied to the line.
`lines[].taxDate`	date	no	The date the line's tax was determined on. Format YYYY-MM-DD.
`lines[].taxMode`	string	no	How the line's prices are quoted for tax. Possible values: 'TaxInclusive', 'TaxExclusive'.
`lines[].taxExemptCode`	string	no	The customer-level tax-exempt code applied to the line.
`lines[].creditGlAccountId`	string	no	The line's credit general ledger account, the credit side of the journal entry. See id on GET accounting/accounts/:id.
`lines[].serviceStartDate`	date	no	The first day of the service period the line covers. Format YYYY-MM-DD.
`lines[].serviceEndDate`	date	no	The last day of the service period the line covers, inclusive. Format YYYY-MM-DD.

{
  "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",
    "lines": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "lineNumber": "<lineNumber>",
        "description": "<description>",
        "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "creditMemoLineId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "quantity": "19.99",
        "unitOfMeasure": "<unitOfMeasure>",
        "unitPrice": "19.99",
        "adjustedUnitPrice": "19.99",
        "listPrice": "19.99",
        "listPriceTotal": "19.99",
        "discountAmount": "19.99",
        "discountPercentage": "19.99",
        "totalPrice": "19.99",
        "amountDebited": "19.99",
        "totalAmountDue": "19.99",
        "taxAmount": "19.99",
        "taxCode": "<taxCode>",
        "taxDate": "2026-01-15",
        "taxMode": "<taxMode>",
        "taxExemptCode": "<taxExemptCode>",
        "creditGlAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "serviceStartDate": "2026-01-15",
        "serviceEndDate": "2026-01-15"
      }
    ]
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Errors

Code	Status
`NOT_FOUND`	400

Statuses

400 — Invalid request or business failure. Codes: NOT_FOUND
401 — The request carries no valid access token.
403 — Not authorized
404 — Not found
429 — Too many requests from this client address. The response has no body and no Retry-After header.
500 — Internal server error