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": "5221FFCF-E84B-4690-B7DC-DE29D549096B",
"policyType": "Paid Time Off",
"policyName": "PTO Full Time",
"earningMethod": "Lump Sum",
"lumpSumHoursEarned": 80,
"canCarryoverHours": true,
"maximumCarryoverHours": 40,
"maxAccumulatedHours": 120,
"waitingPeriod": "0 Days",
"proratedByStartDate": false,
"whenTimeOffReceived": "Start of Year",
"payoutOnTerminations": true,
"maxPayoutHours": 80
}
}
'import requests
url = "https://sandbox.rollfi.xyz/adminPortal/addTimeOffPolicy"
payload = {
"method": "addTimeOffPolicy",
"timeOffPolicy": {
"companyId": "5221FFCF-E84B-4690-B7DC-DE29D549096B",
"policyType": "Paid Time Off",
"policyName": "PTO Full Time",
"earningMethod": "Lump Sum",
"lumpSumHoursEarned": 80,
"canCarryoverHours": True,
"maximumCarryoverHours": 40,
"maxAccumulatedHours": 120,
"waitingPeriod": "0 Days",
"proratedByStartDate": False,
"whenTimeOffReceived": "Start of Year",
"payoutOnTerminations": True,
"maxPayoutHours": 80
}
}
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: '5221FFCF-E84B-4690-B7DC-DE29D549096B',
policyType: 'Paid Time Off',
policyName: 'PTO Full Time',
earningMethod: 'Lump Sum',
lumpSumHoursEarned: 80,
canCarryoverHours: true,
maximumCarryoverHours: 40,
maxAccumulatedHours: 120,
waitingPeriod: '0 Days',
proratedByStartDate: false,
whenTimeOffReceived: 'Start of Year',
payoutOnTerminations: true,
maxPayoutHours: 80
}
})
};
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' => '5221FFCF-E84B-4690-B7DC-DE29D549096B',
'policyType' => 'Paid Time Off',
'policyName' => 'PTO Full Time',
'earningMethod' => 'Lump Sum',
'lumpSumHoursEarned' => 80,
'canCarryoverHours' => true,
'maximumCarryoverHours' => 40,
'maxAccumulatedHours' => 120,
'waitingPeriod' => '0 Days',
'proratedByStartDate' => false,
'whenTimeOffReceived' => 'Start of Year',
'payoutOnTerminations' => true,
'maxPayoutHours' => 80
]
]),
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\": \"5221FFCF-E84B-4690-B7DC-DE29D549096B\",\n \"policyType\": \"Paid Time Off\",\n \"policyName\": \"PTO Full Time\",\n \"earningMethod\": \"Lump Sum\",\n \"lumpSumHoursEarned\": 80,\n \"canCarryoverHours\": true,\n \"maximumCarryoverHours\": 40,\n \"maxAccumulatedHours\": 120,\n \"waitingPeriod\": \"0 Days\",\n \"proratedByStartDate\": false,\n \"whenTimeOffReceived\": \"Start of Year\",\n \"payoutOnTerminations\": true,\n \"maxPayoutHours\": 80\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\": \"5221FFCF-E84B-4690-B7DC-DE29D549096B\",\n \"policyType\": \"Paid Time Off\",\n \"policyName\": \"PTO Full Time\",\n \"earningMethod\": \"Lump Sum\",\n \"lumpSumHoursEarned\": 80,\n \"canCarryoverHours\": true,\n \"maximumCarryoverHours\": 40,\n \"maxAccumulatedHours\": 120,\n \"waitingPeriod\": \"0 Days\",\n \"proratedByStartDate\": false,\n \"whenTimeOffReceived\": \"Start of Year\",\n \"payoutOnTerminations\": true,\n \"maxPayoutHours\": 80\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\": \"5221FFCF-E84B-4690-B7DC-DE29D549096B\",\n \"policyType\": \"Paid Time Off\",\n \"policyName\": \"PTO Full Time\",\n \"earningMethod\": \"Lump Sum\",\n \"lumpSumHoursEarned\": 80,\n \"canCarryoverHours\": true,\n \"maximumCarryoverHours\": 40,\n \"maxAccumulatedHours\": 120,\n \"waitingPeriod\": \"0 Days\",\n \"proratedByStartDate\": false,\n \"whenTimeOffReceived\": \"Start of Year\",\n \"payoutOnTerminations\": true,\n \"maxPayoutHours\": 80\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"
}
}{
"error": {
"code": 400,
"message": "accrualRatePerHour is required when earningMethod is \"Accrual\"."
}
}Admin Portal
addTimeOffPolicy
The addTimeOffPolicy API creates a new PTO policy for a company.
What it does:
- Creates a time off policy with accrual or lump-sum earning rules.
- Stores policy-level carryover, waiting period, and payout settings.
Notes:
earningMethodcontrols conditional required fields.- For
Lump Sum, includelumpSumHoursEarned. - For
Accrual, includeaccrualRatePerHourandproratedByStartDate. - If
canCarryoverHoursistrue, includemaximunCaryoverHours.
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": "5221FFCF-E84B-4690-B7DC-DE29D549096B",
"policyType": "Paid Time Off",
"policyName": "PTO Full Time",
"earningMethod": "Lump Sum",
"lumpSumHoursEarned": 80,
"canCarryoverHours": true,
"maximumCarryoverHours": 40,
"maxAccumulatedHours": 120,
"waitingPeriod": "0 Days",
"proratedByStartDate": false,
"whenTimeOffReceived": "Start of Year",
"payoutOnTerminations": true,
"maxPayoutHours": 80
}
}
'import requests
url = "https://sandbox.rollfi.xyz/adminPortal/addTimeOffPolicy"
payload = {
"method": "addTimeOffPolicy",
"timeOffPolicy": {
"companyId": "5221FFCF-E84B-4690-B7DC-DE29D549096B",
"policyType": "Paid Time Off",
"policyName": "PTO Full Time",
"earningMethod": "Lump Sum",
"lumpSumHoursEarned": 80,
"canCarryoverHours": True,
"maximumCarryoverHours": 40,
"maxAccumulatedHours": 120,
"waitingPeriod": "0 Days",
"proratedByStartDate": False,
"whenTimeOffReceived": "Start of Year",
"payoutOnTerminations": True,
"maxPayoutHours": 80
}
}
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: '5221FFCF-E84B-4690-B7DC-DE29D549096B',
policyType: 'Paid Time Off',
policyName: 'PTO Full Time',
earningMethod: 'Lump Sum',
lumpSumHoursEarned: 80,
canCarryoverHours: true,
maximumCarryoverHours: 40,
maxAccumulatedHours: 120,
waitingPeriod: '0 Days',
proratedByStartDate: false,
whenTimeOffReceived: 'Start of Year',
payoutOnTerminations: true,
maxPayoutHours: 80
}
})
};
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' => '5221FFCF-E84B-4690-B7DC-DE29D549096B',
'policyType' => 'Paid Time Off',
'policyName' => 'PTO Full Time',
'earningMethod' => 'Lump Sum',
'lumpSumHoursEarned' => 80,
'canCarryoverHours' => true,
'maximumCarryoverHours' => 40,
'maxAccumulatedHours' => 120,
'waitingPeriod' => '0 Days',
'proratedByStartDate' => false,
'whenTimeOffReceived' => 'Start of Year',
'payoutOnTerminations' => true,
'maxPayoutHours' => 80
]
]),
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\": \"5221FFCF-E84B-4690-B7DC-DE29D549096B\",\n \"policyType\": \"Paid Time Off\",\n \"policyName\": \"PTO Full Time\",\n \"earningMethod\": \"Lump Sum\",\n \"lumpSumHoursEarned\": 80,\n \"canCarryoverHours\": true,\n \"maximumCarryoverHours\": 40,\n \"maxAccumulatedHours\": 120,\n \"waitingPeriod\": \"0 Days\",\n \"proratedByStartDate\": false,\n \"whenTimeOffReceived\": \"Start of Year\",\n \"payoutOnTerminations\": true,\n \"maxPayoutHours\": 80\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\": \"5221FFCF-E84B-4690-B7DC-DE29D549096B\",\n \"policyType\": \"Paid Time Off\",\n \"policyName\": \"PTO Full Time\",\n \"earningMethod\": \"Lump Sum\",\n \"lumpSumHoursEarned\": 80,\n \"canCarryoverHours\": true,\n \"maximumCarryoverHours\": 40,\n \"maxAccumulatedHours\": 120,\n \"waitingPeriod\": \"0 Days\",\n \"proratedByStartDate\": false,\n \"whenTimeOffReceived\": \"Start of Year\",\n \"payoutOnTerminations\": true,\n \"maxPayoutHours\": 80\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\": \"5221FFCF-E84B-4690-B7DC-DE29D549096B\",\n \"policyType\": \"Paid Time Off\",\n \"policyName\": \"PTO Full Time\",\n \"earningMethod\": \"Lump Sum\",\n \"lumpSumHoursEarned\": 80,\n \"canCarryoverHours\": true,\n \"maximumCarryoverHours\": 40,\n \"maxAccumulatedHours\": 120,\n \"waitingPeriod\": \"0 Days\",\n \"proratedByStartDate\": false,\n \"whenTimeOffReceived\": \"Start of Year\",\n \"payoutOnTerminations\": true,\n \"maxPayoutHours\": 80\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"
}
}{
"error": {
"code": 400,
"message": "accrualRatePerHour is required when earningMethod is \"Accrual\"."
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
Response
Policy created
Show child attributes
Show child attributes
⌘I
