Skip to main content
GET
Get supplier credit balance

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

supplierId
string<uuid>
required

Response

OK

currency
string
required

ISO 4217 currency code.

available

Total credit available to apply against this supplier's bills, in this currency.