Skip to main content
GET
Total paid summary

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).

Query Parameters

period
enum<string>
default:Last30Days
Available options:
Last7Days,
Last30Days,
Last90Days,
Last12Months,
MonthToDate,
QuarterToDate,
YearToDate
currency
string

Response

OK

granularity
string
required

daily | weekly | monthly

currency
string
required

The primary currency the Summary, Trend, PaymentTiming, Buckets, ByMethod and TopSuppliers fields are reported in. See PaidByCurrency for activity in every currency.

summary
object
required
trend
object
required
paymentTiming
object
required
asOf
string<date>
period
enum<string>
Available options:
Last7Days,
Last30Days,
Last90Days,
Last12Months,
MonthToDate,
QuarterToDate,
YearToDate
periodStart
string<date>
periodEnd
string<date>
paidByCurrency
object[]

Total paid per currency across the period — covers ALL currencies, not just the primary one. Use this for the headline figure when the org pays in multiple currencies so amounts are never reported as zero.

buckets
object[]
byMethod
object[]
topSuppliers
object[]