addRecurringPayItem
curl --request POST \
--url https://sandbox.rollfi.xyz/adminPortal/addRecurringPayItem \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "addRecurringPayItem",
"companyId": "336CB829-543B-451D-AAA2-18A1B03454F2",
"userId": "C8E5F6AB-4CB5-406C-B756-208B742F4281",
"payItem": "Garnishments",
"type": "CN RPP",
"amountPerPayPeriod": 450
}
'import requests
url = "https://sandbox.rollfi.xyz/adminPortal/addRecurringPayItem"
payload = {
"method": "addRecurringPayItem",
"companyId": "336CB829-543B-451D-AAA2-18A1B03454F2",
"userId": "C8E5F6AB-4CB5-406C-B756-208B742F4281",
"payItem": "Garnishments",
"type": "CN RPP",
"amountPerPayPeriod": 450
}
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: 'addRecurringPayItem',
companyId: '336CB829-543B-451D-AAA2-18A1B03454F2',
userId: 'C8E5F6AB-4CB5-406C-B756-208B742F4281',
payItem: 'Garnishments',
type: 'CN RPP',
amountPerPayPeriod: 450
})
};
fetch('https://sandbox.rollfi.xyz/adminPortal/addRecurringPayItem', 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/addRecurringPayItem",
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' => 'addRecurringPayItem',
'companyId' => '336CB829-543B-451D-AAA2-18A1B03454F2',
'userId' => 'C8E5F6AB-4CB5-406C-B756-208B742F4281',
'payItem' => 'Garnishments',
'type' => 'CN RPP',
'amountPerPayPeriod' => 450
]),
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/addRecurringPayItem"
payload := strings.NewReader("{\n \"method\": \"addRecurringPayItem\",\n \"companyId\": \"336CB829-543B-451D-AAA2-18A1B03454F2\",\n \"userId\": \"C8E5F6AB-4CB5-406C-B756-208B742F4281\",\n \"payItem\": \"Garnishments\",\n \"type\": \"CN RPP\",\n \"amountPerPayPeriod\": 450\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/addRecurringPayItem")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"addRecurringPayItem\",\n \"companyId\": \"336CB829-543B-451D-AAA2-18A1B03454F2\",\n \"userId\": \"C8E5F6AB-4CB5-406C-B756-208B742F4281\",\n \"payItem\": \"Garnishments\",\n \"type\": \"CN RPP\",\n \"amountPerPayPeriod\": 450\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/adminPortal/addRecurringPayItem")
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\": \"addRecurringPayItem\",\n \"companyId\": \"336CB829-543B-451D-AAA2-18A1B03454F2\",\n \"userId\": \"C8E5F6AB-4CB5-406C-B756-208B742F4281\",\n \"payItem\": \"Garnishments\",\n \"type\": \"CN RPP\",\n \"amountPerPayPeriod\": 450\n}"
response = http.request(request)
puts response.read_body{
"Status": "Success",
"Message": "Recurring pay item added successfully."
}{
"error": {
"code": 400,
"message": "Invalid companyId"
}
}Admin Portal
addRecurringPayItem
The addRecurringPayItem API is used to add a recurring item that will appear on an employee’s payroll.
What it does:
- Adds an employee-specific recurring pay item
- Used to add recurring deductions, additional compensations, and reimbursements without having to add them to pay periods
Notes:
- Either
allocatedPercentageoramountPerPayPeriodis required - Recurring items will be added to open pay periods until they are removed with
removeRecurringPayItem typeis restricted to the list of deductions and additional compensations available withgetDeductionDescriptionandgetAdditionalCompensationDescriptiontypeallows free-string entry for reimbursements- Only one recurring item per
typecan be added
| PayItem options | Restrictions |
|---|---|
| Deduction | getDeductionDescription |
| AdditionalCompensation | getAdditionalCompensationDescription |
| Reimbursement | No restriction. Free entry |
POST
/
adminPortal
/
addRecurringPayItem
addRecurringPayItem
curl --request POST \
--url https://sandbox.rollfi.xyz/adminPortal/addRecurringPayItem \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "addRecurringPayItem",
"companyId": "336CB829-543B-451D-AAA2-18A1B03454F2",
"userId": "C8E5F6AB-4CB5-406C-B756-208B742F4281",
"payItem": "Garnishments",
"type": "CN RPP",
"amountPerPayPeriod": 450
}
'import requests
url = "https://sandbox.rollfi.xyz/adminPortal/addRecurringPayItem"
payload = {
"method": "addRecurringPayItem",
"companyId": "336CB829-543B-451D-AAA2-18A1B03454F2",
"userId": "C8E5F6AB-4CB5-406C-B756-208B742F4281",
"payItem": "Garnishments",
"type": "CN RPP",
"amountPerPayPeriod": 450
}
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: 'addRecurringPayItem',
companyId: '336CB829-543B-451D-AAA2-18A1B03454F2',
userId: 'C8E5F6AB-4CB5-406C-B756-208B742F4281',
payItem: 'Garnishments',
type: 'CN RPP',
amountPerPayPeriod: 450
})
};
fetch('https://sandbox.rollfi.xyz/adminPortal/addRecurringPayItem', 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/addRecurringPayItem",
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' => 'addRecurringPayItem',
'companyId' => '336CB829-543B-451D-AAA2-18A1B03454F2',
'userId' => 'C8E5F6AB-4CB5-406C-B756-208B742F4281',
'payItem' => 'Garnishments',
'type' => 'CN RPP',
'amountPerPayPeriod' => 450
]),
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/addRecurringPayItem"
payload := strings.NewReader("{\n \"method\": \"addRecurringPayItem\",\n \"companyId\": \"336CB829-543B-451D-AAA2-18A1B03454F2\",\n \"userId\": \"C8E5F6AB-4CB5-406C-B756-208B742F4281\",\n \"payItem\": \"Garnishments\",\n \"type\": \"CN RPP\",\n \"amountPerPayPeriod\": 450\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/addRecurringPayItem")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"addRecurringPayItem\",\n \"companyId\": \"336CB829-543B-451D-AAA2-18A1B03454F2\",\n \"userId\": \"C8E5F6AB-4CB5-406C-B756-208B742F4281\",\n \"payItem\": \"Garnishments\",\n \"type\": \"CN RPP\",\n \"amountPerPayPeriod\": 450\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/adminPortal/addRecurringPayItem")
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\": \"addRecurringPayItem\",\n \"companyId\": \"336CB829-543B-451D-AAA2-18A1B03454F2\",\n \"userId\": \"C8E5F6AB-4CB5-406C-B756-208B742F4281\",\n \"payItem\": \"Garnishments\",\n \"type\": \"CN RPP\",\n \"amountPerPayPeriod\": 450\n}"
response = http.request(request)
puts response.read_body{
"Status": "Success",
"Message": "Recurring pay item added successfully."
}{
"error": {
"code": 400,
"message": "Invalid companyId"
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
⌘I
