Skip to main content
GET
Get a tenant's monthly report

Subtenants

Pass includeSubtenants=true to return a combined report covering the tenant and all of its subtenants. When the parameter is false or omitted, the report contains only the tenant’s own data. Subtenant API keys automatically receive a subtenant-specific report. You don’t need to set includeSubtenants. The includeSubtenants parameter applies to the csv and json formats.

Example report file

The response is a signed url. A csv report looks like this:

Authorizations

Api-Key
string
header
required

Path Parameters

year
string
required

Year of the report

Pattern: ^\d{4}$
month
string
required

Month of the report, will contain transactions settled in the previous month

Pattern: ^\d{2}$

Query Parameters

format
enum<string>

The format of the report

Available options:
csv,
json
includeSubtenants
boolean

Include subtenant activity in the report.

Response

A short-lived signed URL to download the report. Issue a GET to url to download the file; the link expires at expiresAt (1 hour after issuance).

url
string<uri>
required

Short-lived signed URL to download the monthly report in the requested format.

expiresAt
string<date-time>
required

ISO 8601 timestamp when the signed URL expires (1 hour after issuance).