addSupplementalPayrollLineItem
curl --request POST \
--url https://sandbox.rollfi.xyz/payroll/addSupplementalPayrollLineItem \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "addSupplementalPayrollLineItem",
"payrollLineItem": {
"payPeriodId": "00b8b220-f329-4554-bd7b-d0ef53fc0542",
"companyId": "8D728FCE-2993-42E0-8797-832C930506E1",
"userId": "30da3ca7-8b39-4a3c-8ab9-050f17fbcb3b",
"amount": 10
}
}
'import requests
url = "https://sandbox.rollfi.xyz/payroll/addSupplementalPayrollLineItem"
payload = {
"method": "addSupplementalPayrollLineItem",
"payrollLineItem": {
"payPeriodId": "00b8b220-f329-4554-bd7b-d0ef53fc0542",
"companyId": "8D728FCE-2993-42E0-8797-832C930506E1",
"userId": "30da3ca7-8b39-4a3c-8ab9-050f17fbcb3b",
"amount": 10
}
}
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: 'addSupplementalPayrollLineItem',
payrollLineItem: {
payPeriodId: '00b8b220-f329-4554-bd7b-d0ef53fc0542',
companyId: '8D728FCE-2993-42E0-8797-832C930506E1',
userId: '30da3ca7-8b39-4a3c-8ab9-050f17fbcb3b',
amount: 10
}
})
};
fetch('https://sandbox.rollfi.xyz/payroll/addSupplementalPayrollLineItem', 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/payroll/addSupplementalPayrollLineItem",
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' => 'addSupplementalPayrollLineItem',
'payrollLineItem' => [
'payPeriodId' => '00b8b220-f329-4554-bd7b-d0ef53fc0542',
'companyId' => '8D728FCE-2993-42E0-8797-832C930506E1',
'userId' => '30da3ca7-8b39-4a3c-8ab9-050f17fbcb3b',
'amount' => 10
]
]),
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/payroll/addSupplementalPayrollLineItem"
payload := strings.NewReader("{\n \"method\": \"addSupplementalPayrollLineItem\",\n \"payrollLineItem\": {\n \"payPeriodId\": \"00b8b220-f329-4554-bd7b-d0ef53fc0542\",\n \"companyId\": \"8D728FCE-2993-42E0-8797-832C930506E1\",\n \"userId\": \"30da3ca7-8b39-4a3c-8ab9-050f17fbcb3b\",\n \"amount\": 10\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/payroll/addSupplementalPayrollLineItem")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"addSupplementalPayrollLineItem\",\n \"payrollLineItem\": {\n \"payPeriodId\": \"00b8b220-f329-4554-bd7b-d0ef53fc0542\",\n \"companyId\": \"8D728FCE-2993-42E0-8797-832C930506E1\",\n \"userId\": \"30da3ca7-8b39-4a3c-8ab9-050f17fbcb3b\",\n \"amount\": 10\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/payroll/addSupplementalPayrollLineItem")
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\": \"addSupplementalPayrollLineItem\",\n \"payrollLineItem\": {\n \"payPeriodId\": \"00b8b220-f329-4554-bd7b-d0ef53fc0542\",\n \"companyId\": \"8D728FCE-2993-42E0-8797-832C930506E1\",\n \"userId\": \"30da3ca7-8b39-4a3c-8ab9-050f17fbcb3b\",\n \"amount\": 10\n }\n}"
response = http.request(request)
puts response.read_body{
"payrollLineItem": {
"employeeId": "30da3ca7-8b39-4a3c-8ab9-050f17fbcb3b",
"status": "Ready",
"message": "The PayrollLineItem for Nelson John has been saved successfully."
}
}addSupplementalPayrollLineItem
addSupplementalPayrollLineItem
The addSupplementalPayrollLineItem API adds supplemental pay for an employee within a company.
What it does:
- Adds specific payment amounts to employees outside of regular payroll processing
- Allows one time additions for non-regular pay such as bonuses, rebates, corrections etc.
Notes:
- Requires a payPeriodId for a supplemental or regular pay period
- Used for processing payments outside of regular pay schedules like bonuses or corrections
POST
/
payroll
/
addSupplementalPayrollLineItem
addSupplementalPayrollLineItem
curl --request POST \
--url https://sandbox.rollfi.xyz/payroll/addSupplementalPayrollLineItem \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "addSupplementalPayrollLineItem",
"payrollLineItem": {
"payPeriodId": "00b8b220-f329-4554-bd7b-d0ef53fc0542",
"companyId": "8D728FCE-2993-42E0-8797-832C930506E1",
"userId": "30da3ca7-8b39-4a3c-8ab9-050f17fbcb3b",
"amount": 10
}
}
'import requests
url = "https://sandbox.rollfi.xyz/payroll/addSupplementalPayrollLineItem"
payload = {
"method": "addSupplementalPayrollLineItem",
"payrollLineItem": {
"payPeriodId": "00b8b220-f329-4554-bd7b-d0ef53fc0542",
"companyId": "8D728FCE-2993-42E0-8797-832C930506E1",
"userId": "30da3ca7-8b39-4a3c-8ab9-050f17fbcb3b",
"amount": 10
}
}
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: 'addSupplementalPayrollLineItem',
payrollLineItem: {
payPeriodId: '00b8b220-f329-4554-bd7b-d0ef53fc0542',
companyId: '8D728FCE-2993-42E0-8797-832C930506E1',
userId: '30da3ca7-8b39-4a3c-8ab9-050f17fbcb3b',
amount: 10
}
})
};
fetch('https://sandbox.rollfi.xyz/payroll/addSupplementalPayrollLineItem', 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/payroll/addSupplementalPayrollLineItem",
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' => 'addSupplementalPayrollLineItem',
'payrollLineItem' => [
'payPeriodId' => '00b8b220-f329-4554-bd7b-d0ef53fc0542',
'companyId' => '8D728FCE-2993-42E0-8797-832C930506E1',
'userId' => '30da3ca7-8b39-4a3c-8ab9-050f17fbcb3b',
'amount' => 10
]
]),
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/payroll/addSupplementalPayrollLineItem"
payload := strings.NewReader("{\n \"method\": \"addSupplementalPayrollLineItem\",\n \"payrollLineItem\": {\n \"payPeriodId\": \"00b8b220-f329-4554-bd7b-d0ef53fc0542\",\n \"companyId\": \"8D728FCE-2993-42E0-8797-832C930506E1\",\n \"userId\": \"30da3ca7-8b39-4a3c-8ab9-050f17fbcb3b\",\n \"amount\": 10\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/payroll/addSupplementalPayrollLineItem")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"addSupplementalPayrollLineItem\",\n \"payrollLineItem\": {\n \"payPeriodId\": \"00b8b220-f329-4554-bd7b-d0ef53fc0542\",\n \"companyId\": \"8D728FCE-2993-42E0-8797-832C930506E1\",\n \"userId\": \"30da3ca7-8b39-4a3c-8ab9-050f17fbcb3b\",\n \"amount\": 10\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/payroll/addSupplementalPayrollLineItem")
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\": \"addSupplementalPayrollLineItem\",\n \"payrollLineItem\": {\n \"payPeriodId\": \"00b8b220-f329-4554-bd7b-d0ef53fc0542\",\n \"companyId\": \"8D728FCE-2993-42E0-8797-832C930506E1\",\n \"userId\": \"30da3ca7-8b39-4a3c-8ab9-050f17fbcb3b\",\n \"amount\": 10\n }\n}"
response = http.request(request)
puts response.read_body{
"payrollLineItem": {
"employeeId": "30da3ca7-8b39-4a3c-8ab9-050f17fbcb3b",
"status": "Ready",
"message": "The PayrollLineItem for Nelson John has been saved successfully."
}
}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
