Skip to main content
POST
Create credit note

Authorizations

x-dolfin-api-key
string
header
required

An API key issued to your client. It carries the client's scope; org-scoped calls also require the x-dolfin-organisation-id header. Keys are created and revoked by a client administrator.

Headers

x-dolfin-organisation-id
string<uuid>

Target organisation. Required when authenticating with an API key; omit for Bearer callers (resolved from the token).

Path Parameters

invoiceId
string<uuid>
required

Body

application/json
amount

Amount to credit, in the invoice's currency. Must be greater than zero and must not exceed the invoice's outstanding balance.

reason
null | string

Optional human-readable reason for the credit (e.g. "returned goods", "customer dispute", "goodwill").

invoiceLineItemId
null | string<uuid>

Optional id of a specific line item on the invoice this credit relates to. When supplied, that line's frozen tax rate is inherited (unless taxRateId overrides it) and recorded as provenance.

taxRateId
null | string<uuid>

Optional tax rate to apply to the credit (an id from GET /tax-rates — an org rate or a country default). Overrides the line item's rate when both are given. When omitted and no line item is supplied, the credit is treated as zero-rated.

Response

Created

currency
string
required

ISO 4217 currency code (e.g. GBP, USD, EUR) — always equal to the invoice currency

id
string<uuid>
organisationId
string<uuid>
invoiceId
string<uuid>
documentNumber
null | string
amount
netAmount

Net (ex-tax) portion of the credit. NetAmount + TaxAmount == Amount.

taxAmount

VAT/tax portion of the credit.

taxRateId
null | string<uuid>

Soft reference to the tax rate applied (an org rate or country default). Null on a zero-rated credit.

taxRateSnapshot
null | object

Frozen copy of the tax rate applied — the source of truth (code, name, rate, source). Null on a zero-rated credit.

invoiceLineItemId
null | string<uuid>

Optional id of the specific invoice line item this credit relates to.

reason
null | string
status
enum<string>
Available options:
Draft,
Issuing,
Issued
issuedAt
null | string<date-time>
createdAt
string<date-time>
createdBy
null | string<uuid>
updatedAt
string<date-time>
updatedBy
null | string<uuid>