v1

latestOpenAPI 3.0.32026-07-23215362.6 KB
Accounts

Get Account Report

Retrieve a reportUrl by accountId, month, year, and report type. The reportUrl can be appended to the /files endpoint to access the report.

get/v1/accounts/{accountId}/reports

Path parameters

accountIdstring uuid required

The account ID

Query parameters

reportType'MONTHLY_STATEMENT' | 'MONTHLY_TAX_NOTICE' required

The type of report

yearinteger required

The year of the report

monthinteger required

The month of the report (1-12)

Response

Successful response with signed report URL

accountIdstring uuid required

The account ID

monthinteger required

The month of the report

yearinteger required

The year of the report

reportType'MONTHLY_STATEMENT' | 'MONTHLY_TAX_NOTICE' required

The type of statement report

reportUrlstring uri required

Signed S3 URL for the report (valid for 5 minutes)