Issue credit note
Issue a Draft credit note. This applies it to the invoice’s outstanding balance and makes the credit note immutable. If the credit zeroes the balance, the invoice moves to Credited.
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).
Response
OK
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