Skip to main content
GET
List Reports

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
string
required

Query Parameters

report_type
enum<string>
required

Business report types. Grows here — never in DocumentType.

Available options:
gtn_gb,
gtn_ae,
variance_gb,
p45_leavers_gb,
p60_gb,
wps_ae,
ytd_gb,
p11d_gb,
pension_gb,
fps_summary_gb,
high_earners_gb,
payroll_liability_gb,
p32_gb,
pension_variance_gb,
ae_assessment_gb,
statutory_payments_gb,
eps_gb,
paye_ni_details_gb,
paye_ni_summary_gb,
bank_detail_change_audit_gb
tax_year
integer
required
Required range: 1901 <= x <= 2100
tax_month
integer | null
Required range: 1 <= x <= 12
employee_id
string[] | null

Employee-scoped reports only (YTD). Repeat to batch the check across several employees in one call (e.g. one page of an employee table) instead of one request per employee.

Maximum array length: 100

Response

Successful Response

format
string
required
report_id
string
required
status
enum<string>
required

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

Available options:
pending,
generating,
ready,
failed
regenerable
boolean
required
employee_id
string | null