Skip to main content
GET
List all payroll documents

Authorizations

Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Query Parameters

account
string<uuid>

Filter by account ID.

user
string<uuid>

Filter by user ID.

employment
string<uuid>

Filter by employment ID.

from_available_date
string<date-time>

Filter for payroll documents with an available_date on or after this timestamp (ISO 8601).

to_available_date
string<date-time>

Filter for payroll documents with an available_date on or before this timestamp (ISO 8601).

limit
integer

Number of payroll document objects returned per page. Default: 10. Maximum: 200.

cursor
string

The URL returned in next or previous used to retrieve another page of results.

Response

200 - application/json
next
string<uri> | null

URL for the next page of results, if available.

previous
string<uri> | null

URL for the previous page of results, if available.

results
object[]