Skip to main content
GET
List all statements

Authorizations

X-Access-Client-Id
string
header
required

Client ID

X-Access-Secret
string
header
required

Client Access Key

Path Parameters

Link ID

Query Parameters

pay_date_from
string
default:2022-06-01

Filter pay_date greater than or equal (ISO-8601)

pay_date_to
string
default:2022-06-02

Filter pay_date less than or equal (ISO-8601)

page
integer
default:1

Page number from the statement list

page_size
integer

Number of results to return per page.

employment_id
string

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

return_all_statements
boolean
default:false

Whether to include all statements, ignoring customization template limits.

Response

Statements List

count
integer
required

Number of the results in total

Example:

100

next
string | null
required

Link to the next page

Example:

"https://prod.truv.com/v1/link/0000000000/statements?page=1"

previous
string | null
required

Link to the previous page

Example:

"https://prod.truv.com/v1/link/0000000000/statements?page=1"

results
object[]
required

List of the Pay Statements