Skip to main content
The pay statement endpoints return a list of pay statements with attribute object breakdowns. The statement is related to the link_id from Truv’s Income and Employment API.

Attributes

The table below covers the values for pay statements.

Earnings object

Each item in earnings and earnings_ytd has this shape.

Deductions object

Each item in deductions and deductions_ytd has this shape.

How many statements to expect

Most employments return about 30 pay statements, and fewer than one in a hundred return more than 300. Gig work and long running weekly jobs go much higher, so size your handling for up to 2,000 statements for a single employment. There is no hard maximum today. Which path you read them from decides whether that matters:
  • List all statements is paginated. Use page and page_size, and narrow further with employment_id or a pay_date_from and pay_date_to range.
  • The income and employment report embeds the full array inside each employment, so a large history arrives in one response. This is the income product only. On the employment product statements is null, so volume is never a concern there.

Endpoints

View the available endpoints for pay statements below.

Example response

The JSON below is a sample response from the endpoint.