addEmployeeBenefits

The addEmployeeBenefits API enrolls an employee in company benefit plans.

What it does:

• Enrolls employees in existing company benefit plans
• Sets employee deduction amounts and company contribution amounts per pay period
• Establishes benefit enrollment with effective dates

Supported Benefits:

• Medical
• Dental
• Vision

Note:

• Benefits must be added using addCompanyBenefits before employees can enroll

POST /benefits#addEmployeeBenefits

addEmployeeBenefits

cURL

curl --request POST \
  --url 'https://sandbox.rollfi.xyz/benefits#addEmployeeBenefits' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "addEmployeeBenefits",
  "benefitEmployeeElection": {
    "userId": "C0378C3F-0B62-491D-9CD9-1B4CE347D8F1",
    "benefitType": "Medical",
    "effectiveMonth": "December 2024",
    "companyContributionAmountPerPayPeriod": 55,
    "employeeDeductionAmountPerPayPeriod": 25
  }
}
'

200

1

{
  "Benefits": {
    "status": "Ready",
    "message": "The Benefits for Medical has been saved successfully.",
    "benefitType": "Medical"
  }
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

method · string · default: addUserBankAccount · required

Example:

"addUserBankAccount"

benefitEmployeeElection · object · required

Show child attributes

Response

200

application/json

Benefits · object · required

Show child attributes