version-payroll-company-employeeId-paycheck-details-id-get

GET

Pay Check Details

{
  "header":{
    "peoDesc":"string",
    "companyObj":"string",
    "companyId":"string",
    "payGroup":"string",
    "earnsBegDt":"datetime",
    "earnsEndDt":"datetime",
    "payEndDt":"datetime",
    "checkDt":"datetime",
    "checkNumber":"number",
    "employerName":"string",
    "employerAddress1":"string",
    "employerAddress2":"string",
    "employerAddress3":"string",
    "employerCountry":"string",
    "payCurrencyCd":"string",
    "employerPhone":"string",
    "name":"string",
    "address1":"string",
    "address2":"string",
    "address3":"string",
    "employeeId":"string",
    "ssn":"string",
    "department":"string",
    "location":"string",
    "businessTitle":"string",
    "payRate":"number",
    "payRateDesc":"string",
    "netPay":"number",
    "link":"string"
  },
  "detail":{
    "key":{
      "payGroup":"string",
      "payPeriodEndDate":"datetime",
      "payEndDt":"datetime",
      "pageNo":"number",
      "lineNo":"number",
      "sepChk":"boolean",
      "offCycle":"boolean",
      "effDt":"datetime"
    },
    "taxData":[
      {
        "taxWithHolding":"string",
        "maritalStatus":"string",
        "allowances":"number",
        "addlPct":"number",
        "addlAmt":"number",
        "netClaimAmt":"number",
        "splLetters":"string"
      }
    ],
    "earns":[
      {
        "curEarnsDesc":"string",
        "curEarnsRate":"number",
        "curEarnsHours":"number",
        "curEarnsEarn":"number",
        "ytdEarnsHours":"number",
        "ytdEarnsEarn":"number",
        "earnsBegDt":"datetime",
        "earnsEndDt":"datetime"
      }
    ],
    "taxWithholdings":[
      {
        "taxDesc":"string",
        "curTaxes":"number",
        "ytdTaxes":"number"
      }
    ],
    "preTaxDedns":[
      {
        "desc":"string",
        "curDedns":"number",
        "ytdDedns":"number",
        "pytdDedns":"number"
      }
    ],
    "postTaxDedns":[
      {
        "desc":"string",
        "curDedns":"number",
        "ytdDedns":"number"
      }
    ],
    "employerBenefits":[
      {
        "desc":"string",
        "curEmpBenf":"number",
        "ytdEmpBenf":"number"
      }
    ],
    "employerBenefitsTaxable":[
      {
        "desc":"string",
        "curEmpBenf":"number",
        "ytdEmpBenf":"number"
      }
    ],
    "employerBenefitsNonTaxable":[
      {
        "desc":"string",
        "curEmpBenf":"number",
        "ytdEmpBenf":"number"
      }
    ],
    "totals":{
      "curHour":"number",
      "curGross":"number",
      "ytdHrsEarn":"number",
      "ytdGross":"number",
      "curTaxes":"number",
      "ytdTaxes":"number",
      "curPreDedn":"number",
      "ytdPreDedn":"number",
      "ytdPreDDedn":"number",
      "curPostDedn":"number",
      "ytdPostDedn":"number",
      "ytdTotalDedn":"number",
      "curTotalDedn":"number",
      "curEmpBenf":"number",
      "ytdEmpBenf":"number",
      "curFedTaxableGross":"number",
      "ytdFedTaxableGross":"number",
      "curNetPay":"number",
      "ytdNetPay":"number",
      "curNonTaxableTot":"number",
      "ytdNonTaxableTot":"number",
      "curTaxableTot":"number",
      "ytdTaxableTot":"number",
      "totalBenefitsCurrent":"number",
      "totalBenefitsYtd":"number",
      "totDirectDeposit":"number"
    },
    "ptos":[
      {
        "desc":"string",
        "begBal":"number",
        "earned":"number",
        "taken":"number",
        "adjust":"number",
        "endBal":"number"
      }
    ],
    "netPayDistributions":[
      {
        "desc":"string",
        "refNum":"string",
        "depositAmt":"number"
      }
    ],
    "directDepositDistributions":[
      {
        "acctType":"string",
        "acctNum":"string",
        "depositAmount":"number"
      }
    ],
    "link":"string"
  },
  "link":"string"
}
 

Resource URL

https://api.trinet.com /{version}/payroll/{company}/{employeeId}/paycheck-details/{id}

Request Body

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 400

  • 401

  • 403

  • 404

Resource Summary

Security:

Scope:

hr-pay-read

Working...