Account Links4

Accounts2

Bank Accounts1

Bank Statements1

Bridge Token1

Companies and Data Providers5

Customization Templates5

Data Refresh2

DDS Reports1

Deposit Switch Reports2

Document Collections9

Employment2

Identity1

Income Insights Reports2

Income Report1

Insurance Reports3

Investments1

Key Management2

Liabilities1

Orders13

Parsed Documents2

Pay Statements2

Recurring Transactions1

Reports2

Scoring Attributes2

Shifts1

Tasks2

Tax Documents2

Transactions1

Uploaded Documents2

Users5

VOA Reports2

VOIE Reports2

Webhooks6

Pay Statements

Retrieve a statement

Get the pay statement

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

Response

idstring

Unique ID

check_numberstring string nullable

External ID of pay stub from the payroll provider

pay_datestring date required

Pay Date

net_paystring decimal nullable

Net pay

net_pay_ytdstring decimal nullable

Net pay year to date

gross_paystring decimal nullable

Gross pay

gross_pay_ytdstring decimal nullable

Gross pay year to date

bonusstring decimal nullable

Bonus

commissionstring decimal nullable

Commission

hoursstring decimal nullable

Work hours during a pay period

basis_of_pay'S' | 'H' | 'D' | 'W' | 'M' | 'C' | 'null' nullable

Basis of pay:

S - Salary,
H - Hourly,
D - Daily,
W - Weekly,
M - Monthly,
C - Contract,

period_startstring date nullable

Period start

period_endstring date nullable

Period end

regularstring decimal nullable

Regular pay

regular_ytdstring decimal nullable

Regular salary year to date

other_pay_ytdstring decimal nullable

All other pays year to date

bonus_ytdstring decimal nullable

Bonus year to date

commission_ytdstring decimal nullable

Commission year to date

overtimestring decimal nullable

Overtime pay

overtime_ytdstring decimal nullable

Overtime pay year to date

other_paystring decimal nullable

All other pays

md5sumstring string nullable

MD5 hash value computed based on the file content

filestring uri nullable

Link to a pay stub file (format is specified in the content-type)

derived_fieldsstring[]

Array of derived fields

missing_data_fieldsstring[]

List of the data fields which are missing in the payroll API response

Example response

{
  "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"
  ]
}

Changes

Changed in 1 of the 11 revisions of this API.119

Jul 27, 2026f7c013875516119See the full diff
- ●
  added the new C enum value to the basis_of_pay response property for the response status 200
  response-property-enum-value-added
- ○
  the bonus response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status 200
  response-property-pattern-added
- ○
  the bonus_ytd response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status 200
  response-property-pattern-added
- ○
  the commission response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status 200
  response-property-pattern-added
- ○
  the commission_ytd response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status 200
  response-property-pattern-added
- ○
  the deductions/items/amount response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status 200
  response-property-pattern-added
- ○
  the deductions_ytd/items/amount response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status 200
  response-property-pattern-added
- ○
  the earnings/items/amount response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status 200
  response-property-pattern-added
- ○
  the earnings_ytd/items/amount response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status 200
  response-property-pattern-added
- ○
  the gross_pay response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status 200
  response-property-pattern-added
- ○
  the gross_pay_ytd response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status 200
  response-property-pattern-added
- ○
  the hours response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status 200
  response-property-pattern-added
- ○
  the net_pay response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status 200
  response-property-pattern-added
- ○
  the net_pay_ytd response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status 200
  response-property-pattern-added
- ○
  the other_pay response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status 200
  response-property-pattern-added
- ○
  the other_pay_ytd response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status 200
  response-property-pattern-added
- ○
  the overtime response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status 200
  response-property-pattern-added
- ○
  the overtime_ytd response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status 200
  response-property-pattern-added
- ○
  the regular response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status 200
  response-property-pattern-added
- ○
  the regular_ytd response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status 200
  response-property-pattern-added

Full history