Create supplier credit note
Create a supplier (AP) credit note in Draft against a supplier. Amount is the gross (tax-inclusive) credit, positive. Issue it separately to make the credit available; apply it to a bill to net it down.
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
ISO 4217 currency code (e.g. GBP, USD, EUR).
Gross (tax-inclusive) credit amount. Must be greater than zero.
Optional tax rate to apply (an org rate or country default). Omit for a zero-rated credit; the net/tax split is computed from it.
Optional id of the bill this credit relates to — header-level provenance only.
Optional human-readable reason for the credit.
Response
Created
ISO 4217 currency code (e.g. GBP, USD, EUR).
Gross (tax-inclusive) credit amount, always positive.
Net (ex-tax) portion of the credit. NetAmount + TaxAmount == Amount.
VAT/tax portion of the credit.
How much of Amount has been netted against bills.
Remaining credit available to apply (Amount - AppliedAmount).
Soft reference to the tax rate applied. Null on a zero-rated credit.
Frozen copy of the tax rate applied — the source of truth. Null on a zero-rated credit.
Optional id of the bill this credit relates to (header-level provenance).
How the credit note was ingested: Manual or Ocr.
Manual, Ocr Draft, Issued, PartiallyApplied, Applied