The Statement endpoint returns a list of pay statements with dates, gross pay, net pay, and earnings with deductions breakdown. The statement is related to the link_id from Truv's Income and Employment API.

Attributes

The attributes of the Statement:

Attribute	Type	Description
id	string	The unique ID of the selected statement
check_number	string	The external ID of the pay stub from the payroll provider
pay_date	date	The pay date
net_pay	string	The net pay
net_pay_ytd	string	The net pay year to date
gross_pay	string	The gross pay
gross_pay_ytd	string	The gross pay year to date
bonus	string	The amount of bonus
commission	string	The amount of commission
hours	string	The work hours during a pay period
basis_of_pay	string	The basis of pay. There are three types of pay plans: S - Salary H - Hourly W - Weekly
period_start	date	The start of the pay period
period_end	date	The end of the pay period
regular	string	The regular salary
regular_ytd	string	The regular salary year to date
other_pay_ytd	string	All other pay years to date
bonus_ytd	string	The bonus year to date
commission_ytd	string	The commission year to date
overtime	string	The overtime pay
overtime_ytd	string	The year-to-date overtime pay
other_pay	string	Other pay
earnings	array of objects	The earnings for this pay cycle by type
earnings_ytd	array of objects	The year-to-date earnings
deductions	array of objects	The deductions for the pay cycle by type
deductions_ytd	array of objects	The year-to-date deductions by type
md5sum	string	MD5 hash value computed based on the file content
file	url	The link to the pay stub file
derived_fields	array of strings	The array of derived fields
missing_data_fields	array of strings	The list of data fields which are missing in the payroll API response

Endpoints

Available endpoint list for Statement:

Endpoint
List of Statements - GET/v1/link/{link_id}/statements
Get Statements - GET/link/{link_id}/statements/{statement_id}

Sample Object

The example object returned by the Get Statement endpoint:

{
  "id": "970c13c479b14f41b0b6a991ee8819f6",
  "pay_date": "2021-10-22",
  "net_pay": "1515.61",
  "net_pay_ytd": "35398.31",
  "gross_pay": "2153.85",
  "gross_pay_ytd": "45500.00",
  "bonus": null,
  "commission": null,
  "hours": "80.00",
  "basis_of_pay": "S",
  "period_start": "2021-10-03",
  "period_end": "2021-10-16",
  "regular": "2153.85",
  "regular_ytd": "42000.00",
  "bonus_ytd": "500.00",
  "commission_ytd": null,
  "overtime": null,
  "overtime_ytd": null,
  "other_pay": null,
  "other_pay_ytd": "3000.00",
  "earnings": [
    {
      "name": "Regular",
      "category": "regular",
      "amount": "2153.85",
      "rate": "2153.85",
      "units": "72.00"
    }
  ],
  "earnings_ytd": [
    {
      "name": "Regular",
      "category": "regular",
      "amount": "42000.00",
      "rate": null,
      "units": null
    },
    {
      "name": "Spot Award",
      "category": "other_pay",
      "amount": "3000.00",
      "rate": null,
      "units": null
    },
    {
      "name": "Bonus",
      "category": "bonus",
      "amount": "500.00",
      "rate": null,
      "units": null
    }
  ],
  "deductions": [
    {
      "name": "Blue Ash Income Tax",
      "amount": "-26.94",
      "category": "local"
    },
    {
      "name": "Medicare Tax",
      "amount": "-31.25",
      "category": "medicare"
    },
    {
      "name": "CA State Income Tax",
      "amount": "-54.68",
      "category": "state"
    },
    {
      "name": "Social Security Tax",
      "amount": "-133.63",
      "category": "socialsec"
    },
    {
      "name": "Federal Income Tax",
      "amount": "-154.37",
      "category": "federal"
    },
    {
      "name": "401K Dollars",
      "amount": "-237.37",
      "category": "retirement"
    }
  ],
  "deductions_ytd": [
    {
      "name": "Federal Income Tax",
      "amount": "3639.64",
      "category": "federal"
    },
    {
      "name": "Social Security Tax",
      "amount": "3090.03",
      "category": "socialsec"
    },
    {
      "name": "401K Dollars",
      "amount": "2148.46",
      "category": "retirement"
    },
    {
      "name": "CA State Income Tax",
      "amount": "1275.75",
      "category": "state"
    },
    {
      "name": "Medicare Tax",
      "amount": "722.67",
      "category": "medicare"
    },
    {
      "name": "Blue Ash Income Tax",
      "amount": "623.01",
      "category": "local"
    },
    {
      "name": "Exp Repay",
      "amount": "-1397.87",
      "category": "benefit"
    }
  ],
  "md5sum": null,
  "file": null,
  "derived_fields": [],
  "missing_data_fields": [],
  "check_number": null
}