v4

OpenAPI 3.0.12026-07-3189233676.2 KB

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