Skip to main content
GET
Get expenditures

Authorizations

X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Path Parameters

entityId
string<uuid>
required

Query Parameters

options[from]
string<date-time>

Filter by invoice issuing date (greater than)

options[to]
string<date-time>

Filter by invoice issuing date (less than)

options[periodicity]
enum<string>
default:monthly

The data set is grouped by this field

Available options:
daily,
weekly,
monthly,
quarterly,
yearly
options[type]
enum<string>
default:total

The type of expenditure

Available options:
total,
currency,
counterparty,
invoice-type,
payment-type

Response

Expenditures

data
object[]

Expenditure data grouped by period and dimension

stats
object[]

Data quality statistics per period, indicating how many invoices had the required fields for accurate calculation.