v4

OpenAPI 3.0.12026-07-3189233676.2 KB

Pay Statements

List all statements

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

get/v1/links/{link_id}/statements/

Query parameters

pay_date_fromstring

Filter pay_date greater than or equal (ISO-8601)

pay_date_tostring

Filter pay_date less than or equal (ISO-8601)

pageinteger

Page number from the statement list

page_sizeinteger

Number of results to return per page.

employment_idstring

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

return_all_statementsboolean

Whether to include all statements, ignoring customization template limits.

Response

countinteger required

Number of the results in total

nextstring nullable required

Link to the next page

previousstring nullable required

Link to the previous page

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-15",
      "net_pay": "11500.32",
      "net_pay_ytd": "31980.64",
      "gross_pay": "13900.11",
      "gross_pay_ytd": "49200.00",
      "bonus": "100.00",
      "commission": "12000.00",
      "hours": "40.00",
      "basis_of_pay": "S",
      "period_start": "2018-05-01",
      "period_end": "2018-05-15",
      "regular": "1695.11",
      "regular_ytd": "23000.00",
      "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": "1935.77",
          "category": "regular",
          "rate": null,
          "units": null
        },
        {
          "name": "Overtime",
          "amount": "60.58",
          "category": "overtime",
          "rate": "30.29",
          "units": "2"
        }
      ],
      "earnings_ytd": [
        {
          "name": "Regular",
          "amount": "1935.77",
          "category": "regular",
          "rate": null,
          "units": null
        },
        {
          "name": "Overtime",
          "amount": "60.58",
          "category": "overtime",
          "rate": "30.29",
          "units": "2"
        }
      ],
      "deductions": [
        {
          "name": "Social Security Tax",
          "amount": "127.01",
          "category": "socialsec"
        },
        {
          "name": "VA State Income Tax",
          "amount": "46.23",
          "category": "state"
        },
        {
          "name": "Medicare Tax",
          "amount": "29.70",
          "category": "medicare"
        }
      ],
      "deductions_ytd": [
        {
          "name": "Social Security Tax",
          "amount": "127.01",
          "category": "socialsec"
        },
        {
          "name": "VA State Income Tax",
          "amount": "46.23",
          "category": "state"
        },
        {
          "name": "Medicare Tax",
          "amount": "29.70",
          "category": "medicare"
        }
      ],
      "md5sum": "03639d6a6624f69a54a88ea90bd25e9d",
      "file": "https://cdn.truv.com/paystub_sample.pdf",
      "derived_fields": [
        "basis_of_pay"
      ],
      "missing_data_fields": [
        "earnings_ytd"
      ]
    }
  ]
}