List all statements

The endpoint returns a list of pay statements with dates, gross pay, net pay and earnings with deductions breakdown.

Path Params
string
required
Query Params
string
Defaults to 2022-06-01

Filter pay_date greater than or equal (ISO-8601)

string
Defaults to 2022-06-02

Filter pay_date less than or equal (ISO-8601)

integer
Defaults to 1

Page number from the statement list

integer

Number of results to return per page.

string

Employment ID. If not provided, the most recent employment will be used.

boolean
Defaults to false

Whether to include all statements, ignoring customization template limits.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json