HR Software Employee Benefits API Support

Employee Benefits
Home > Resources > Employee Benefits

This API retrieves existing benefits data for a specified employee. The Benefits Enrollment by Plan API allows you to retrieve plan level enrollment data.

Resource URL

https://serverurl/path/v1.1/employee/[employeeuid]/benefits

[employeeuid] is the unique employee identifier.

Example Request
GET	https://serverurl/api/v1.1/employee/26/benefits
Request Content
Parameter (added in v1.1): [asof] date format: <yyyy>-<dd>-<mm>

Return Value

Http header "Accept" value -- "text/xml" or "application/xml" will return XML, otherwise JSON will be returned.

XML

<benefits>
  <benefit>
    <planId>22</planId>
    <planName>401K Plan</planName>
    <startDate>2004-08-01T00:00:00</startDate>
    <endDate xsi:nil="true" />
    <employeeMonthlyContribution>32.0000</employeeMonthlyContribution>
    
	<employeePaycheckContribution>16.85</employeePaycheckContribution>
    
	<companyMonthlyContribution>100.55</companyMonthlyContribution>
    <contributionFrequency>26</contributionFrequency>
    <percentage>true</percentage>
    <changeReasonId>190</changeReasonId>
    <changeReason>New hire</changeReason>
  </benefit>
  ...
</benefits>

JSON

{
    "benefits": [
        {
            "planId": 22,
            "planName": "401K Plan",
            "startDate": "2004-08-01T00:00:00",
            "employeeMonthlyContribution": 
	32,
            "employeePaycheckContribution": 
	16.85,
            "companyMonthlyContribution": 100.55,
            "contributionFrequency": 26,
            "percentage": true,
            "changeReasonId": 190,
            "changeReason": "New hire"
        },
        ...
    ]
}

Resource Information
Requires Authentication?	Yes
Response Formats	json xml
HTTP Methods	GET
Request Content	N/A
Return Code	200: Response Completed 403: Incorrect Authorization 400: Bad Data 404: Employee does not exist
Version	v1.0, v1.1 (Company contribution added in v1.1)