Create credit note
Create a credit note in Draft against a Sent or PartiallyPaid invoice. The amount must not exceed the invoice’s outstanding balance. Issue it separately to apply it to the balance.
Authentication. An API key (x-dolfin-api-key) together with the x-dolfin-organisation-id header identifying the organisation, or a JWT Bearer token that carries the organisation in its claims.
Authorizations
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
Target organisation. Required when authenticating with an API key; omit for Bearer callers (resolved from the token).
Path Parameters
Body
Amount to credit, in the invoice's currency. Must be greater than zero and must not exceed the invoice's outstanding balance.
Optional human-readable reason for the credit (e.g. "returned goods", "customer dispute", "goodwill").
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.
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
ISO 4217 currency code (e.g. GBP, USD, EUR) — always equal to the invoice currency
Net (ex-tax) portion of the credit. NetAmount + TaxAmount == Amount.
VAT/tax portion of the credit.
Soft reference to the tax rate applied (an org rate or country default). Null on a zero-rated credit.
Frozen copy of the tax rate applied — the source of truth (code, name, rate, source). Null on a zero-rated credit.
Optional id of the specific invoice line item this credit relates to.
Draft, Issuing, Issued