Create Credit Memo

POST /accounting/credit-memos

Group: Accounting › Credit Memos · Operation ID: createCreditMemo

Creates a credit memo. Every credit memo created here is a manual credit memo. The other types come from internal workflows.

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.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.

Request body

Required, application/json: createCreditMemoInput.

Field Type Required Description
customerId string yes The customer the credit memo is issued to. See id on GET accounting/customers/:id.
entityId string yes The legal entity issuing the credit memo. See id on GET base/entities.
currency string yes The currency of the credit memo. Every amount on the credit memo is in this currency. Format ISO 4217, for example 'USD'.
creditMemoDate string (date) yes The date the credit memo is issued. Use format YYYY-MM-DD.
manualCreditMemoType string no The reason for the credit memo, as a tenant-configured key, for example 'writeOff' or 'customerSatisfaction'. Although the field is optional in the schema, a credit memo cannot be created without it.
description string no A free-form description of the credit memo.
externalCreditMemoId string no The identifier of this credit memo in an external source system.
lines array of object yes The lines of the credit memo. At least one is required, even when the request also has applications. Each line has a description and a total price. Tax is added internally.
lines[].description string yes The line description, as shown to the customer.
lines[].totalPrice string (decimal) yes The line total before tax, in the credit memo currency.
applications array of object no Initial applications, each applying the credit memo to an invoice when it is created.
applications[].invoiceId string yes The invoice this application targets. See id on GET accounting/invoices/:id.
applications[].appliedAmount string (decimal) yes The amount to apply, in the credit memo currency. Must be positive.
applications[].appliedDate string (date) yes The date the application is recorded. Use format YYYY-MM-DD.

Example:

{
  "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "currency": "<currency>",
  "creditMemoDate": "2026-01-15",
  "manualCreditMemoType": "<manualCreditMemoType>",
  "description": "<description>",
  "externalCreditMemoId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "lines": [
    {
      "description": "<description>",
      "totalPrice": "19.99"
    }
  ],
  "applications": [
    {
      "invoiceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "appliedAmount": "19.99",
      "appliedDate": "2026-01-15"
    }
  ]
}

Response

200 Success

Under data (createCreditMemoOutput):

Field Type Required Description
id string yes The unique identifier for the created credit memo. Read the full record with GET accounting/credit-memos/:id.

Response headers

Errors

Code Status
CUSTOMER_NOT_FOUND 400
ENTITY_NOT_FOUND 400
INVOICE_NOT_FOUND 400
NO_LINES 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses