Skip to main content
POST
Generate P45 Leavers

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
string
required
tax_year
integer
required
Required range: 1901 <= x <= 2100

Body

application/json

Trigger body for the tax-year Leavers Summary report. format selects the file: csv or xlsx. Both share ReportType.P45_LEAVERS_GB.

Typed as plain string literals (not Literal[ReportFormat.CSV, ReportFormat.XLSX]): a Literal of enum members reprs each member with its class name in the 422 body (Input should be <ReportFormat.CSV: 'csv'> or <ReportFormat.XLSX: 'xlsx'>); string literals produce the clean Input should be 'csv' or 'xlsx'.

format
enum<string>
default:xlsx
Available options:
csv,
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