Skip to main content

Documentation Index

Fetch the complete documentation index at: https://truv.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

The pay statement endpoints return a list of pay statements with attribute object breakdowns. The statement is related to the link_id from Truv’s Income and Employment API.

​
Attributes

The table below covers the values for pay statements.
AttributeTypeDescription
idstringUnique ID of selected statement
check_numberstringExternal ID of pay stub from payroll provider
pay_datedatePay date
net_paystringNet pay
net_pay_ytdstringNet pay year to date
gross_paystringGross pay
gross_pay_ytdstringGross pay year to date
bonusstringBonus amount
commissionstringCommission amount
hoursstringTotal work hours during a pay period
basis_of_paystringBasis of pay, includes four types of pay plans: S - Salary, H - Hourly, D - Daily, W - Weekly
period_startdatePay period start
period_enddatePay period end
regularstringRegular salary
regular_ytdstringRegular salary year to date
other_pay_ytdstringAll other pay forms year to date
bonus_ytdstringBonus year to date
commission_ytdstringCommission year to date
overtimestringOvertime pay
overtime_ytdstringOvertime pay year to date
other_paystringOther pay
earningsarray of objectsEarnings for pay cycle by type
earnings_ytdarray of objectsEarnings year to date
deductionsarray of objectsDeductions for the pay cycle by type
deductions_ytdarray of objectsDeductions by type year to date
md5sumstringMD5 hash value computed based on file content
fileurlLink to pay stub file (up to 2048 characters long)
derived_fieldsarray of stringsArray of derived fields
missing_data_fieldsarray of stringsList of missing data fields from payroll response

​
Endpoints

View the available endpoints for pay statements below.

​
Example response

The JSON below is a sample response from the 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
}