Finance

Credit note

Credit note: what is refunded to the customer.

Schemas: CreditNoteDto

{
  "id": "id_8f2a1c",
  "creditNoteNumber": "string",
  "status": "draft",
  "issueDate": "2026-09-01T08:00:00Z",
  "currency": "EUR",
  "contactId": "string",
  "invoiceId": "string",
  "subTotal": "1234.50",
  "taxesPrice": "1234.50",
  "netPrice": "1234.50",
  "grossPrice": "1234.50",
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z"
}

Generated from the schema

A credit note: what is returned to the customer, tied to the invoice it corrects. Its document lifecycle runs from draft to validated to voided, but status is a free string: tolerate any value. Only the totals are published; the signed tax document, the tax breakdown, the lines and the reason are not. It shares the scope of invoices.

Attributes

idstring

Credit note identifier.

creditNoteNumberstring | null

Credit note number; null while it is a draft.

statusstring

Document lifecycle status: draft, validated or voided (the same values the status filter takes).

Available options: draft, validated, voided

issueDatestring<date-time> | null

Issue date in ISO 8601 UTC; null if not recorded.

currencystring

Currency, as an ISO 4217 code.

contactIdstring | null

Contact the credit note is issued to; null if not recorded.

invoiceIdstring | null

Invoice this credit note rectifies; null if it is not attached to any.

subTotalstring

Subtotal before discounts and taxes, as a decimal string.

Limits: pattern ^-?\d+\.\d{2}$

taxesPricestring

Tax total, as a decimal string.

Limits: pattern ^-?\d+\.\d{2}$

netPricestring

Taxable base, as a decimal string.

Limits: pattern ^-?\d+\.\d{2}$

grossPricestring

Total including taxes, as a decimal string.

Limits: pattern ^-?\d+\.\d{2}$

createdAtstring<date-time>

Creation date in ISO 8601 UTC.

updatedAtstring<date-time>

Last modification date in ISO 8601 UTC.

Values

status: draft, validated, voided

Returned by

GET /api/v1/credit-notes — List credit notes
GET /api/v1/credit-notes/{creditNoteId} — Get a credit note

Modified by

POST /api/v1/credit-notes/{creditNoteId}/validate — Validate a credit note
POST /api/v1/credit-notes/{creditNoteId}/void — Void a credit note

Was this page helpful?

Example

Attributes

Values

Returned by

Modified by