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"
  }
}
'

{
  "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 getTimeOffPolicyTypes API
** 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"
  }
}
'

{
  "timeOffPolicy": {
    "timeOffPolicyId": "EBA8563B-A2EA-46D6-A68A-5CEA5341575F",
    "status": "active",
    "message": "Time off policy has been added successfully"
  }
}

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

required

timeOffPolicy

object

required

Show child attributes

Response

timeOffPolicy

object

required

Show child attributes

updateUserWage updateTimeOffPolicy

Documentation Index

Authorizations

Body

Response