Skip to main content
POST
Generate Ytd Report

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
string
required
employee_id
string
required

Body

application/json
tax_year
integer
required
Required range: 1901 <= x <= 2100
to_tax_month
integer | null

Cap the rightmost column at this tax month (partial-year). Defaults to the latest month with an approved payslip.

Required range: 1 <= x <= 12
format
enum<string>
default:xlsx
Available options:
xlsx,
pdf
include_employer_costs
boolean
default:true

Include the Employer Costs section (Employer NI, Employer Pension).

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