List all statements
Changed onThe endpoint returns a list of pay statements with dates, gross pay, net pay and earnings with deductions breakdown.
Request
- Base URLhttps://prod.truv.com
- URLhttps://prod.truv.com/v1/links/{link_id}/statements/
- AuthAPI key in header X-Access-Client-Id and API key in header X-Access-Secret
Query parameters
Filter pay_date greater than or equal (ISO-8601)
Filter pay_date less than or equal (ISO-8601)
Page number from the statement list
Number of results to return per page.
Employment ID. If not provided, the most recent employment will be used.
Whether to include all statements, ignoring customization template limits.
Response
Example response
{
"count": 100,
"next": "https://prod.truv.com/v1/link/0000000000/statements?page=1",
"previous": "https://prod.truv.com/v1/link/0000000000/statements?page=1",
"results": [
{
"id": "24d7e80942ce4ad58a93f70ce4115f5c",
"check_number": "29205182",
"pay_date": "2018-05-31",
"net_pay": "12915.44",
"net_pay_ytd": "39642.52",
"gross_pay": "18038.33",
"gross_pay_ytd": "55366.65",
"bonus": "100.00",
"commission": "12000.00",
"hours": "173.33",
"basis_of_pay": "S",
"period_start": "2018-05-01",
"period_end": "2018-05-31",
"regular": "5833.33",
"regular_ytd": "29166.65",
"other_pay_ytd": "700.00",
"bonus_ytd": "1000.00",
"commission_ytd": "24000.00",
"overtime": "45.00",
"overtime_ytd": "500.00",
"other_pay": "60.00",
"earnings": [
{
"name": "Regular",
"amount": "5833.33",
"category": "regular",
"rate": null,
"units": null
},
{
"name": "Overtime",
"amount": "45.00",
"category": "overtime",
"rate": "22.50",
"units": "2"
},
{
"name": "Commission",
"amount": "12000.00",
"category": "commission",
"rate": null,
"units": null
},
{
"name": "Bonus",
"amount": "100.00",
"category": "bonus",
"rate": null,
"units": null
},
{
"name": "Spot Award",
"amount": "60.00",
"category": "other_pay",
"rate": null,
"units": null
}
],
"earnings_ytd": [
{
"name": "Regular",
"amount": "29166.65",
"category": "regular",
"rate": null,
"units": null
},
{
"name": "Overtime",
"amount": "500.00",
"category": "overtime",
"rate": null,
"units": null
},
{
"name": "Commission",
"amount": "24000.00",
"category": "commission",
"rate": null,
"units": null
},
{
"name": "Bonus",
"amount": "1000.00",
"category": "bonus",
"rate": null,
"units": null
},
{
"name": "Spot Award",
"amount": "700.00",
"category": "other_pay",
"rate": null,
"units": null
}
],
"deductions": [
{
"name": "Federal Income Tax",
"amount": "2705.75",
"category": "federal"
},
{
"name": "Social Security Tax",
"amount": "1118.38",
"category": "socialsec"
},
{
"name": "Medicare Tax",
"amount": "261.56",
"category": "medicare"
},
{
"name": "VA State Income Tax",
"amount": "1037.20",
"category": "state"
}
],
"deductions_ytd": [
{
"name": "Federal Income Tax",
"amount": "8305.00",
"category": "federal"
},
{
"name": "Social Security Tax",
"amount": "3432.73",
"category": "socialsec"
},
{
"name": "Medicare Tax",
"amount": "802.82",
"category": "medicare"
},
{
"name": "VA State Income Tax",
"amount": "3183.58",
"category": "state"
}
],
"md5sum": "03639d6a6624f69a54a88ea90bd25e9d",
"file": "https://cdn.truv.com/paystub_sample.pdf",
"derived_fields": [
"basis_of_pay"
],
"missing_data_fields": [
"earnings_ytd"
]
}
]
}Changes
- warning
added the new
Cenum value to the//response property for the response status - info
the
//response's property pattern^-?\d{1,10}\.\d{2}$was added for the status - info
the
//response's property pattern^-?\d{1,10}\.\d{2}$was added for the status - info
the
//response's property pattern^-?\d{1,10}\.\d{2}$was added for the status - info
the
//response's property pattern^-?\d{1,10}\.\d{2}$was added for the status - info
the
////response's property pattern^-?\d{1,10}\.\d{2}$was added for the status - info
the
////response's property pattern^-?\d{1,10}\.\d{2}$was added for the status - info
the
////response's property pattern^-?\d{1,10}\.\d{2}$was added for the status - info
the
////response's property pattern^-?\d{1,10}\.\d{2}$was added for the status - info
the
//response's property pattern^-?\d{1,10}\.\d{2}$was added for the status - info
the
//response's property pattern^-?\d{1,10}\.\d{2}$was added for the status - info
the
//response's property pattern^-?\d{1,10}\.\d{2}$was added for the status - info
the
//response's property pattern^-?\d{1,10}\.\d{2}$was added for the status - info
the
//response's property pattern^-?\d{1,10}\.\d{2}$was added for the status - info
the
//response's property pattern^-?\d{1,10}\.\d{2}$was added for the status - info
the
//response's property pattern^-?\d{1,10}\.\d{2}$was added for the status - info
the
//response's property pattern^-?\d{1,10}\.\d{2}$was added for the status - info
the
//response's property pattern^-?\d{1,10}\.\d{2}$was added for the status - info
the
//response's property pattern^-?\d{1,10}\.\d{2}$was added for the status - info
the
//response's property pattern^-?\d{1,10}\.\d{2}$was added for the status
- warning
- info
added the non-success response with the status
- info