addCompanyEmployeeBenefits
curl --request POST \
--url 'https://sandbox.rollfi.xyz/benefits#addCompanyEmployeeBenefits' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "addCompanyEmployeeBenefits",
"benefitCompanyElection": {
"companyId": "9C952CC4-7652-4E2A-9303-912D876057AE",
"benefitType": "Dental",
"effectiveMonth": "December 2024"
},
"benefitEmployeeElections": [
{
"userId": "C0378C3F-0B62-491D-9CD9-1B4CE347D8F1",
"companyContributionAmountPerPayPeriod": 55,
"employeeDeductionAmountPerPayPeriod": 25
}
]
}
'import requests
url = "https://sandbox.rollfi.xyz/benefits#addCompanyEmployeeBenefits"
payload = {
"method": "addCompanyEmployeeBenefits",
"benefitCompanyElection": {
"companyId": "9C952CC4-7652-4E2A-9303-912D876057AE",
"benefitType": "Dental",
"effectiveMonth": "December 2024"
},
"benefitEmployeeElections": [
{
"userId": "C0378C3F-0B62-491D-9CD9-1B4CE347D8F1",
"companyContributionAmountPerPayPeriod": 55,
"employeeDeductionAmountPerPayPeriod": 25
}
]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'addCompanyEmployeeBenefits',
benefitCompanyElection: {
companyId: '9C952CC4-7652-4E2A-9303-912D876057AE',
benefitType: 'Dental',
effectiveMonth: 'December 2024'
},
benefitEmployeeElections: [
{
userId: 'C0378C3F-0B62-491D-9CD9-1B4CE347D8F1',
companyContributionAmountPerPayPeriod: 55,
employeeDeductionAmountPerPayPeriod: 25
}
]
})
};
fetch('https://sandbox.rollfi.xyz/benefits#addCompanyEmployeeBenefits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.rollfi.xyz/benefits#addCompanyEmployeeBenefits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'addCompanyEmployeeBenefits',
'benefitCompanyElection' => [
'companyId' => '9C952CC4-7652-4E2A-9303-912D876057AE',
'benefitType' => 'Dental',
'effectiveMonth' => 'December 2024'
],
'benefitEmployeeElections' => [
[
'userId' => 'C0378C3F-0B62-491D-9CD9-1B4CE347D8F1',
'companyContributionAmountPerPayPeriod' => 55,
'employeeDeductionAmountPerPayPeriod' => 25
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.rollfi.xyz/benefits#addCompanyEmployeeBenefits"
payload := strings.NewReader("{\n \"method\": \"addCompanyEmployeeBenefits\",\n \"benefitCompanyElection\": {\n \"companyId\": \"9C952CC4-7652-4E2A-9303-912D876057AE\",\n \"benefitType\": \"Dental\",\n \"effectiveMonth\": \"December 2024\"\n },\n \"benefitEmployeeElections\": [\n {\n \"userId\": \"C0378C3F-0B62-491D-9CD9-1B4CE347D8F1\",\n \"companyContributionAmountPerPayPeriod\": 55,\n \"employeeDeductionAmountPerPayPeriod\": 25\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.rollfi.xyz/benefits#addCompanyEmployeeBenefits")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"addCompanyEmployeeBenefits\",\n \"benefitCompanyElection\": {\n \"companyId\": \"9C952CC4-7652-4E2A-9303-912D876057AE\",\n \"benefitType\": \"Dental\",\n \"effectiveMonth\": \"December 2024\"\n },\n \"benefitEmployeeElections\": [\n {\n \"userId\": \"C0378C3F-0B62-491D-9CD9-1B4CE347D8F1\",\n \"companyContributionAmountPerPayPeriod\": 55,\n \"employeeDeductionAmountPerPayPeriod\": 25\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/benefits#addCompanyEmployeeBenefits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"addCompanyEmployeeBenefits\",\n \"benefitCompanyElection\": {\n \"companyId\": \"9C952CC4-7652-4E2A-9303-912D876057AE\",\n \"benefitType\": \"Dental\",\n \"effectiveMonth\": \"December 2024\"\n },\n \"benefitEmployeeElections\": [\n {\n \"userId\": \"C0378C3F-0B62-491D-9CD9-1B4CE347D8F1\",\n \"companyContributionAmountPerPayPeriod\": 55,\n \"employeeDeductionAmountPerPayPeriod\": 25\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"Benefits": {
"status": "Ready",
"message": "The Benefits for Dental has been saved successfully.",
"benefitType": "Dental"
}
}Benefits
addCompanyEmployeeBenefits
The addCompanyEmployeeBenefits API adds company benefits with employees enrolled in a single operation. Combines addCompanyBenefits and addEmployeeBenefits into a single, efficient API call.
What it does:
- Creates company-wide benefit plans and enrolls selected employees simultaneously
- Sets up benefit types, effective dates, and employee participation together
Note:
- Streamlines the process of setting up benefits and enrolling employees at the same time
POST
/
benefits#addCompanyEmployeeBenefits
addCompanyEmployeeBenefits
curl --request POST \
--url 'https://sandbox.rollfi.xyz/benefits#addCompanyEmployeeBenefits' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "addCompanyEmployeeBenefits",
"benefitCompanyElection": {
"companyId": "9C952CC4-7652-4E2A-9303-912D876057AE",
"benefitType": "Dental",
"effectiveMonth": "December 2024"
},
"benefitEmployeeElections": [
{
"userId": "C0378C3F-0B62-491D-9CD9-1B4CE347D8F1",
"companyContributionAmountPerPayPeriod": 55,
"employeeDeductionAmountPerPayPeriod": 25
}
]
}
'import requests
url = "https://sandbox.rollfi.xyz/benefits#addCompanyEmployeeBenefits"
payload = {
"method": "addCompanyEmployeeBenefits",
"benefitCompanyElection": {
"companyId": "9C952CC4-7652-4E2A-9303-912D876057AE",
"benefitType": "Dental",
"effectiveMonth": "December 2024"
},
"benefitEmployeeElections": [
{
"userId": "C0378C3F-0B62-491D-9CD9-1B4CE347D8F1",
"companyContributionAmountPerPayPeriod": 55,
"employeeDeductionAmountPerPayPeriod": 25
}
]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'addCompanyEmployeeBenefits',
benefitCompanyElection: {
companyId: '9C952CC4-7652-4E2A-9303-912D876057AE',
benefitType: 'Dental',
effectiveMonth: 'December 2024'
},
benefitEmployeeElections: [
{
userId: 'C0378C3F-0B62-491D-9CD9-1B4CE347D8F1',
companyContributionAmountPerPayPeriod: 55,
employeeDeductionAmountPerPayPeriod: 25
}
]
})
};
fetch('https://sandbox.rollfi.xyz/benefits#addCompanyEmployeeBenefits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.rollfi.xyz/benefits#addCompanyEmployeeBenefits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'addCompanyEmployeeBenefits',
'benefitCompanyElection' => [
'companyId' => '9C952CC4-7652-4E2A-9303-912D876057AE',
'benefitType' => 'Dental',
'effectiveMonth' => 'December 2024'
],
'benefitEmployeeElections' => [
[
'userId' => 'C0378C3F-0B62-491D-9CD9-1B4CE347D8F1',
'companyContributionAmountPerPayPeriod' => 55,
'employeeDeductionAmountPerPayPeriod' => 25
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.rollfi.xyz/benefits#addCompanyEmployeeBenefits"
payload := strings.NewReader("{\n \"method\": \"addCompanyEmployeeBenefits\",\n \"benefitCompanyElection\": {\n \"companyId\": \"9C952CC4-7652-4E2A-9303-912D876057AE\",\n \"benefitType\": \"Dental\",\n \"effectiveMonth\": \"December 2024\"\n },\n \"benefitEmployeeElections\": [\n {\n \"userId\": \"C0378C3F-0B62-491D-9CD9-1B4CE347D8F1\",\n \"companyContributionAmountPerPayPeriod\": 55,\n \"employeeDeductionAmountPerPayPeriod\": 25\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.rollfi.xyz/benefits#addCompanyEmployeeBenefits")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"addCompanyEmployeeBenefits\",\n \"benefitCompanyElection\": {\n \"companyId\": \"9C952CC4-7652-4E2A-9303-912D876057AE\",\n \"benefitType\": \"Dental\",\n \"effectiveMonth\": \"December 2024\"\n },\n \"benefitEmployeeElections\": [\n {\n \"userId\": \"C0378C3F-0B62-491D-9CD9-1B4CE347D8F1\",\n \"companyContributionAmountPerPayPeriod\": 55,\n \"employeeDeductionAmountPerPayPeriod\": 25\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/benefits#addCompanyEmployeeBenefits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"addCompanyEmployeeBenefits\",\n \"benefitCompanyElection\": {\n \"companyId\": \"9C952CC4-7652-4E2A-9303-912D876057AE\",\n \"benefitType\": \"Dental\",\n \"effectiveMonth\": \"December 2024\"\n },\n \"benefitEmployeeElections\": [\n {\n \"userId\": \"C0378C3F-0B62-491D-9CD9-1B4CE347D8F1\",\n \"companyContributionAmountPerPayPeriod\": 55,\n \"employeeDeductionAmountPerPayPeriod\": 25\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"Benefits": {
"status": "Ready",
"message": "The Benefits for Dental has been saved successfully.",
"benefitType": "Dental"
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
Response
Show child attributes
Show child attributes
⌘I