addTimeOffPolicy
curl --request POST \
--url https://sandbox.rollfi.xyz/adminPortal/addTimeOffPolicy \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "addTimeOffPolicy",
"timeOffPolicy": {
"companyId": "BE2EE31D-B043-44E1-B78F-5E97A3EDA919",
"timeOffPolicyType": "Personal Days",
"timeOffPolicyName": "PTO Full Time",
"earningMethod": "Lump Sum (All at once)",
"lumpSumHoursEarned": 80,
"accrualRatePerHour": 1.5,
"canCarryoverHours": true,
"carryoverLimitHours": 40,
"maxAccumulatedHours": 160,
"carryoverDate": "2024-06-02",
"waitingPeriodUnit": "Weeks",
"waitingPeriodQuantity": 30,
"isProratedByStartDate": true,
"timeOffReceivedWhen": "Start of Year",
"payoutOnTerminations": true,
"maxPayoutHours": 40,
"effectiveStartDate": "2024-01-01",
"effectiveEndDate": "2026-01-01"
}
}
'import requests
url = "https://sandbox.rollfi.xyz/adminPortal/addTimeOffPolicy"
payload = {
"method": "addTimeOffPolicy",
"timeOffPolicy": {
"companyId": "BE2EE31D-B043-44E1-B78F-5E97A3EDA919",
"timeOffPolicyType": "Personal Days",
"timeOffPolicyName": "PTO Full Time",
"earningMethod": "Lump Sum (All at once)",
"lumpSumHoursEarned": 80,
"accrualRatePerHour": 1.5,
"canCarryoverHours": True,
"carryoverLimitHours": 40,
"maxAccumulatedHours": 160,
"carryoverDate": "2024-06-02",
"waitingPeriodUnit": "Weeks",
"waitingPeriodQuantity": 30,
"isProratedByStartDate": True,
"timeOffReceivedWhen": "Start of Year",
"payoutOnTerminations": True,
"maxPayoutHours": 40,
"effectiveStartDate": "2024-01-01",
"effectiveEndDate": "2026-01-01"
}
}
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: 'addTimeOffPolicy',
timeOffPolicy: {
companyId: 'BE2EE31D-B043-44E1-B78F-5E97A3EDA919',
timeOffPolicyType: 'Personal Days',
timeOffPolicyName: 'PTO Full Time',
earningMethod: 'Lump Sum (All at once)',
lumpSumHoursEarned: 80,
accrualRatePerHour: 1.5,
canCarryoverHours: true,
carryoverLimitHours: 40,
maxAccumulatedHours: 160,
carryoverDate: '2024-06-02',
waitingPeriodUnit: 'Weeks',
waitingPeriodQuantity: 30,
isProratedByStartDate: true,
timeOffReceivedWhen: 'Start of Year',
payoutOnTerminations: true,
maxPayoutHours: 40,
effectiveStartDate: '2024-01-01',
effectiveEndDate: '2026-01-01'
}
})
};
fetch('https://sandbox.rollfi.xyz/adminPortal/addTimeOffPolicy', 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/adminPortal/addTimeOffPolicy",
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' => 'addTimeOffPolicy',
'timeOffPolicy' => [
'companyId' => 'BE2EE31D-B043-44E1-B78F-5E97A3EDA919',
'timeOffPolicyType' => 'Personal Days',
'timeOffPolicyName' => 'PTO Full Time',
'earningMethod' => 'Lump Sum (All at once)',
'lumpSumHoursEarned' => 80,
'accrualRatePerHour' => 1.5,
'canCarryoverHours' => true,
'carryoverLimitHours' => 40,
'maxAccumulatedHours' => 160,
'carryoverDate' => '2024-06-02',
'waitingPeriodUnit' => 'Weeks',
'waitingPeriodQuantity' => 30,
'isProratedByStartDate' => true,
'timeOffReceivedWhen' => 'Start of Year',
'payoutOnTerminations' => true,
'maxPayoutHours' => 40,
'effectiveStartDate' => '2024-01-01',
'effectiveEndDate' => '2026-01-01'
]
]),
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/adminPortal/addTimeOffPolicy"
payload := strings.NewReader("{\n \"method\": \"addTimeOffPolicy\",\n \"timeOffPolicy\": {\n \"companyId\": \"BE2EE31D-B043-44E1-B78F-5E97A3EDA919\",\n \"timeOffPolicyType\": \"Personal Days\",\n \"timeOffPolicyName\": \"PTO Full Time\",\n \"earningMethod\": \"Lump Sum (All at once)\",\n \"lumpSumHoursEarned\": 80,\n \"accrualRatePerHour\": 1.5,\n \"canCarryoverHours\": true,\n \"carryoverLimitHours\": 40,\n \"maxAccumulatedHours\": 160,\n \"carryoverDate\": \"2024-06-02\",\n \"waitingPeriodUnit\": \"Weeks\",\n \"waitingPeriodQuantity\": 30,\n \"isProratedByStartDate\": true,\n \"timeOffReceivedWhen\": \"Start of Year\",\n \"payoutOnTerminations\": true,\n \"maxPayoutHours\": 40,\n \"effectiveStartDate\": \"2024-01-01\",\n \"effectiveEndDate\": \"2026-01-01\"\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/adminPortal/addTimeOffPolicy")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"addTimeOffPolicy\",\n \"timeOffPolicy\": {\n \"companyId\": \"BE2EE31D-B043-44E1-B78F-5E97A3EDA919\",\n \"timeOffPolicyType\": \"Personal Days\",\n \"timeOffPolicyName\": \"PTO Full Time\",\n \"earningMethod\": \"Lump Sum (All at once)\",\n \"lumpSumHoursEarned\": 80,\n \"accrualRatePerHour\": 1.5,\n \"canCarryoverHours\": true,\n \"carryoverLimitHours\": 40,\n \"maxAccumulatedHours\": 160,\n \"carryoverDate\": \"2024-06-02\",\n \"waitingPeriodUnit\": \"Weeks\",\n \"waitingPeriodQuantity\": 30,\n \"isProratedByStartDate\": true,\n \"timeOffReceivedWhen\": \"Start of Year\",\n \"payoutOnTerminations\": true,\n \"maxPayoutHours\": 40,\n \"effectiveStartDate\": \"2024-01-01\",\n \"effectiveEndDate\": \"2026-01-01\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/adminPortal/addTimeOffPolicy")
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\": \"addTimeOffPolicy\",\n \"timeOffPolicy\": {\n \"companyId\": \"BE2EE31D-B043-44E1-B78F-5E97A3EDA919\",\n \"timeOffPolicyType\": \"Personal Days\",\n \"timeOffPolicyName\": \"PTO Full Time\",\n \"earningMethod\": \"Lump Sum (All at once)\",\n \"lumpSumHoursEarned\": 80,\n \"accrualRatePerHour\": 1.5,\n \"canCarryoverHours\": true,\n \"carryoverLimitHours\": 40,\n \"maxAccumulatedHours\": 160,\n \"carryoverDate\": \"2024-06-02\",\n \"waitingPeriodUnit\": \"Weeks\",\n \"waitingPeriodQuantity\": 30,\n \"isProratedByStartDate\": true,\n \"timeOffReceivedWhen\": \"Start of Year\",\n \"payoutOnTerminations\": true,\n \"maxPayoutHours\": 40,\n \"effectiveStartDate\": \"2024-01-01\",\n \"effectiveEndDate\": \"2026-01-01\"\n }\n}"
response = http.request(request)
puts response.read_body{
"timeOffPolicy": {
"timeOffPolicyId": "EBA8563B-A2EA-46D6-A68A-5CEA5341575F",
"status": "active",
"message": "Time off policy has been added successfully"
}
}Admin Portal
addTimeOffPolicy
The addTimeOffPolicy API adds a company-wide time off policy that can be assigned to employees
Notes:
- earningMethod, waitingPeriodUnit and timeOffRecievedWhen fields dictate when, and for how long, timeOffPolicyAssignments can be applied to employees
- multiple timeOffPolicies (even of the same type) can be added to a company
- timeOffPolicyTypes can be retrieved using the
getTimeOffPolicyTypesAPI - ** lumpSumHoursEarned** and ** accrualRatePerHour** are only necessary for Accrual PTO policies
After a timeOffPolicy is added to a company, employees must be assigned to it using addTimeOffPolicyAssignment
POST
/
adminPortal
/
addTimeOffPolicy
addTimeOffPolicy
curl --request POST \
--url https://sandbox.rollfi.xyz/adminPortal/addTimeOffPolicy \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "addTimeOffPolicy",
"timeOffPolicy": {
"companyId": "BE2EE31D-B043-44E1-B78F-5E97A3EDA919",
"timeOffPolicyType": "Personal Days",
"timeOffPolicyName": "PTO Full Time",
"earningMethod": "Lump Sum (All at once)",
"lumpSumHoursEarned": 80,
"accrualRatePerHour": 1.5,
"canCarryoverHours": true,
"carryoverLimitHours": 40,
"maxAccumulatedHours": 160,
"carryoverDate": "2024-06-02",
"waitingPeriodUnit": "Weeks",
"waitingPeriodQuantity": 30,
"isProratedByStartDate": true,
"timeOffReceivedWhen": "Start of Year",
"payoutOnTerminations": true,
"maxPayoutHours": 40,
"effectiveStartDate": "2024-01-01",
"effectiveEndDate": "2026-01-01"
}
}
'import requests
url = "https://sandbox.rollfi.xyz/adminPortal/addTimeOffPolicy"
payload = {
"method": "addTimeOffPolicy",
"timeOffPolicy": {
"companyId": "BE2EE31D-B043-44E1-B78F-5E97A3EDA919",
"timeOffPolicyType": "Personal Days",
"timeOffPolicyName": "PTO Full Time",
"earningMethod": "Lump Sum (All at once)",
"lumpSumHoursEarned": 80,
"accrualRatePerHour": 1.5,
"canCarryoverHours": True,
"carryoverLimitHours": 40,
"maxAccumulatedHours": 160,
"carryoverDate": "2024-06-02",
"waitingPeriodUnit": "Weeks",
"waitingPeriodQuantity": 30,
"isProratedByStartDate": True,
"timeOffReceivedWhen": "Start of Year",
"payoutOnTerminations": True,
"maxPayoutHours": 40,
"effectiveStartDate": "2024-01-01",
"effectiveEndDate": "2026-01-01"
}
}
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: 'addTimeOffPolicy',
timeOffPolicy: {
companyId: 'BE2EE31D-B043-44E1-B78F-5E97A3EDA919',
timeOffPolicyType: 'Personal Days',
timeOffPolicyName: 'PTO Full Time',
earningMethod: 'Lump Sum (All at once)',
lumpSumHoursEarned: 80,
accrualRatePerHour: 1.5,
canCarryoverHours: true,
carryoverLimitHours: 40,
maxAccumulatedHours: 160,
carryoverDate: '2024-06-02',
waitingPeriodUnit: 'Weeks',
waitingPeriodQuantity: 30,
isProratedByStartDate: true,
timeOffReceivedWhen: 'Start of Year',
payoutOnTerminations: true,
maxPayoutHours: 40,
effectiveStartDate: '2024-01-01',
effectiveEndDate: '2026-01-01'
}
})
};
fetch('https://sandbox.rollfi.xyz/adminPortal/addTimeOffPolicy', 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/adminPortal/addTimeOffPolicy",
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' => 'addTimeOffPolicy',
'timeOffPolicy' => [
'companyId' => 'BE2EE31D-B043-44E1-B78F-5E97A3EDA919',
'timeOffPolicyType' => 'Personal Days',
'timeOffPolicyName' => 'PTO Full Time',
'earningMethod' => 'Lump Sum (All at once)',
'lumpSumHoursEarned' => 80,
'accrualRatePerHour' => 1.5,
'canCarryoverHours' => true,
'carryoverLimitHours' => 40,
'maxAccumulatedHours' => 160,
'carryoverDate' => '2024-06-02',
'waitingPeriodUnit' => 'Weeks',
'waitingPeriodQuantity' => 30,
'isProratedByStartDate' => true,
'timeOffReceivedWhen' => 'Start of Year',
'payoutOnTerminations' => true,
'maxPayoutHours' => 40,
'effectiveStartDate' => '2024-01-01',
'effectiveEndDate' => '2026-01-01'
]
]),
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/adminPortal/addTimeOffPolicy"
payload := strings.NewReader("{\n \"method\": \"addTimeOffPolicy\",\n \"timeOffPolicy\": {\n \"companyId\": \"BE2EE31D-B043-44E1-B78F-5E97A3EDA919\",\n \"timeOffPolicyType\": \"Personal Days\",\n \"timeOffPolicyName\": \"PTO Full Time\",\n \"earningMethod\": \"Lump Sum (All at once)\",\n \"lumpSumHoursEarned\": 80,\n \"accrualRatePerHour\": 1.5,\n \"canCarryoverHours\": true,\n \"carryoverLimitHours\": 40,\n \"maxAccumulatedHours\": 160,\n \"carryoverDate\": \"2024-06-02\",\n \"waitingPeriodUnit\": \"Weeks\",\n \"waitingPeriodQuantity\": 30,\n \"isProratedByStartDate\": true,\n \"timeOffReceivedWhen\": \"Start of Year\",\n \"payoutOnTerminations\": true,\n \"maxPayoutHours\": 40,\n \"effectiveStartDate\": \"2024-01-01\",\n \"effectiveEndDate\": \"2026-01-01\"\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/adminPortal/addTimeOffPolicy")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"addTimeOffPolicy\",\n \"timeOffPolicy\": {\n \"companyId\": \"BE2EE31D-B043-44E1-B78F-5E97A3EDA919\",\n \"timeOffPolicyType\": \"Personal Days\",\n \"timeOffPolicyName\": \"PTO Full Time\",\n \"earningMethod\": \"Lump Sum (All at once)\",\n \"lumpSumHoursEarned\": 80,\n \"accrualRatePerHour\": 1.5,\n \"canCarryoverHours\": true,\n \"carryoverLimitHours\": 40,\n \"maxAccumulatedHours\": 160,\n \"carryoverDate\": \"2024-06-02\",\n \"waitingPeriodUnit\": \"Weeks\",\n \"waitingPeriodQuantity\": 30,\n \"isProratedByStartDate\": true,\n \"timeOffReceivedWhen\": \"Start of Year\",\n \"payoutOnTerminations\": true,\n \"maxPayoutHours\": 40,\n \"effectiveStartDate\": \"2024-01-01\",\n \"effectiveEndDate\": \"2026-01-01\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/adminPortal/addTimeOffPolicy")
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\": \"addTimeOffPolicy\",\n \"timeOffPolicy\": {\n \"companyId\": \"BE2EE31D-B043-44E1-B78F-5E97A3EDA919\",\n \"timeOffPolicyType\": \"Personal Days\",\n \"timeOffPolicyName\": \"PTO Full Time\",\n \"earningMethod\": \"Lump Sum (All at once)\",\n \"lumpSumHoursEarned\": 80,\n \"accrualRatePerHour\": 1.5,\n \"canCarryoverHours\": true,\n \"carryoverLimitHours\": 40,\n \"maxAccumulatedHours\": 160,\n \"carryoverDate\": \"2024-06-02\",\n \"waitingPeriodUnit\": \"Weeks\",\n \"waitingPeriodQuantity\": 30,\n \"isProratedByStartDate\": true,\n \"timeOffReceivedWhen\": \"Start of Year\",\n \"payoutOnTerminations\": true,\n \"maxPayoutHours\": 40,\n \"effectiveStartDate\": \"2024-01-01\",\n \"effectiveEndDate\": \"2026-01-01\"\n }\n}"
response = http.request(request)
puts response.read_body{
"timeOffPolicy": {
"timeOffPolicyId": "EBA8563B-A2EA-46D6-A68A-5CEA5341575F",
"status": "active",
"message": "Time off policy has been added successfully"
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Response
Show child attributes
Show child attributes
⌘I
