Skip to main content
POST
Generate High Earners Report

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
string
required

Body

application/json

Trigger body.

format is xlsx-only: the deliverable is a two-sheet workbook (Summary + Calculation Detail), which CSV and JSON cannot represent — only render_high_earners_xlsx is registered in generate_report.py's renderer dispatch for this report type.

tax_year
integer
required
Required range: 1901 <= x <= 2100
format
string
default:XLSX
Allowed value: "XLSX"

Response

Successful Response

Returned by the POST trigger — the handle the client polls on.

report_id
string
required
status
enum<string>
required

Report lifecycle, independent of the underlying Document's status.

Available options:
PENDING,
GENERATING,
READY,
FAILED