Skip to main content
GET
Get supplier 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

creditNoteId
string<uuid>
required

Response

OK

currency
string
required

ISO 4217 currency code (e.g. GBP, USD, EUR).

id
string<uuid>
organisationId
string<uuid>
supplierId
string<uuid>
documentNumber
null | string
amount

Gross (tax-inclusive) credit amount, always positive.

netAmount

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

taxAmount

VAT/tax portion of the credit.

appliedAmount

How much of Amount has been netted against bills.

available

Remaining credit available to apply (Amount - AppliedAmount).

taxRateId
null | string<uuid>

Soft reference to the tax rate applied. Null on a zero-rated credit.

taxRateSnapshot
null | object

Frozen copy of the tax rate applied — the source of truth. Null on a zero-rated credit.

originalBillId
null | string<uuid>

Optional id of the bill this credit relates to (header-level provenance).

reason
null | string
source
enum<string>

How the credit note was ingested: Manual or Ocr.

Available options:
Manual,
Ocr
status
enum<string>
Available options:
Draft,
Issued,
PartiallyApplied,
Applied
issuedAt
null | string<date-time>
createdAt
string<date-time>
createdBy
null | string<uuid>
updatedAt
string<date-time>
updatedBy
null | string<uuid>