Skip to main content
POST
Generate Variance Report

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
string
required

Body

application/json
tax_year
integer
required
Required range: 1901 <= x <= 2100
tax_month
integer | null
Required range: 1 <= x <= 12
format
enum<string>
default:xlsx
Available options:
xlsx,
csv,
json
threshold
default:10

Net pay variance threshold percentage; rows within this band are suppressed. Default 10 %.

Required range: 0 < x <= 100

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