Skip to main content
POST
Apply supplier credit to a bill

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

Body

application/json
billId
string<uuid>

The bill to net this credit against. Must belong to the same supplier and currency.

amount

Amount of credit to apply. Must be > 0, <= the credit note's available balance, and <= the bill's outstanding balance.

Response

Created

currency
string
required
id
string<uuid>
supplierCreditNoteId
string<uuid>
billId
string<uuid>
supplierId
string<uuid>
amount
status
enum<string>

Applied or Reversed.

Available options:
Applied,
Reversed
createdAt
string<date-time>
createdBy
null | string<uuid>
updatedAt
string<date-time>