version-company-company-leave-plans-planType-get

GET

Leave Plans Details by Plan Type

{
  "effectiveDate":"datetime",
  "planType":"string",
  "planTypeDescription":"string",
  "benefitPlan":"string",
  "benefitPlanDescription":"string",
  "serviceUnits":"string",
  "accrualMethod":"string",
  "specialCalc":"string",
  "serviceCalcAtYearBegin":"string",
  "maxLeaveBalance":"number",
  "maxLeaveCarryover":"number",
  "accrualCalc": [
   {
    "afterServiceInterval":"number",
    "accrualRatio":"number",
    "accrualMax":"number"
    }
   ],
  "serviceBonusValues":[
   {
    "afterServiceInterval":"number",
    "awardBonusHours":"number"
   }
 ],
  "firstYearAwardValues":[
   {
    "employmentMonth":"number",
    "hoursEarned":"number",
    "monthEligible":"number"
   }
  ]
}
 

Resource URL

https://api.trinet.com /{version}/company/{company}/leave-plans/{planType}

Query Parameters


Name Values Description
effectiveDate

Provides information for leave plan as of date. Allows retrieving historical information. YYYY-MM-DD format.


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:

benefits-read

Working...