addSupplementalPayPeriod
curl --request POST \
--url https://sandbox.rollfi.xyz/payroll/addSupplementalPayPeriod \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "addSupplementalPayPeriod",
"payPeriod": {
"companyId": "3c62037a-2bac-4910-839d-5c803f0d4f0a",
"payPeriodType": "Missing",
"workerType": "W2",
"payBeginDate": "2023-11-12",
"payEndDate": "2023-12-10",
"payDate": "2023-12-10"
}
}
'import requests
url = "https://sandbox.rollfi.xyz/payroll/addSupplementalPayPeriod"
payload = {
"method": "addSupplementalPayPeriod",
"payPeriod": {
"companyId": "3c62037a-2bac-4910-839d-5c803f0d4f0a",
"payPeriodType": "Missing",
"workerType": "W2",
"payBeginDate": "2023-11-12",
"payEndDate": "2023-12-10",
"payDate": "2023-12-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: 'addSupplementalPayPeriod',
payPeriod: {
companyId: '3c62037a-2bac-4910-839d-5c803f0d4f0a',
payPeriodType: 'Missing',
workerType: 'W2',
payBeginDate: '2023-11-12',
payEndDate: '2023-12-10',
payDate: '2023-12-10'
}
})
};
fetch('https://sandbox.rollfi.xyz/payroll/addSupplementalPayPeriod', 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/addSupplementalPayPeriod",
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' => 'addSupplementalPayPeriod',
'payPeriod' => [
'companyId' => '3c62037a-2bac-4910-839d-5c803f0d4f0a',
'payPeriodType' => 'Missing',
'workerType' => 'W2',
'payBeginDate' => '2023-11-12',
'payEndDate' => '2023-12-10',
'payDate' => '2023-12-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/addSupplementalPayPeriod"
payload := strings.NewReader("{\n \"method\": \"addSupplementalPayPeriod\",\n \"payPeriod\": {\n \"companyId\": \"3c62037a-2bac-4910-839d-5c803f0d4f0a\",\n \"payPeriodType\": \"Missing\",\n \"workerType\": \"W2\",\n \"payBeginDate\": \"2023-11-12\",\n \"payEndDate\": \"2023-12-10\",\n \"payDate\": \"2023-12-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/addSupplementalPayPeriod")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"addSupplementalPayPeriod\",\n \"payPeriod\": {\n \"companyId\": \"3c62037a-2bac-4910-839d-5c803f0d4f0a\",\n \"payPeriodType\": \"Missing\",\n \"workerType\": \"W2\",\n \"payBeginDate\": \"2023-11-12\",\n \"payEndDate\": \"2023-12-10\",\n \"payDate\": \"2023-12-10\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/payroll/addSupplementalPayPeriod")
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\": \"addSupplementalPayPeriod\",\n \"payPeriod\": {\n \"companyId\": \"3c62037a-2bac-4910-839d-5c803f0d4f0a\",\n \"payPeriodType\": \"Missing\",\n \"workerType\": \"W2\",\n \"payBeginDate\": \"2023-11-12\",\n \"payEndDate\": \"2023-12-10\",\n \"payDate\": \"2023-12-10\"\n }\n}"
response = http.request(request)
puts response.read_body{
"payPeriod": {
"payPeriodId": "91384C53-089C-42E9-8CB0-59978AF46DEA",
"status": "New",
"message": "Supplemental PayPeriod for Prism Ltd has been saved successfully."
}
}Payroll
addSupplementalPayPeriod
The addSupplementalPayPeriod API creates a supplemental pay period for processing additional payroll outside of the regular pay schedules.
What it does:
- Creates a special pay period for supplemental payroll processing (bonuses, commissions, off-cycle payments)
- Sets up pay period dates and worker type for the supplemental payroll
Notes:
- Requires pay period dates (payBeginDate, payEndDate, payDate)
- Returns a payPeriodId for use with supplemental payroll line items
POST
/
payroll
/
addSupplementalPayPeriod
addSupplementalPayPeriod
curl --request POST \
--url https://sandbox.rollfi.xyz/payroll/addSupplementalPayPeriod \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "addSupplementalPayPeriod",
"payPeriod": {
"companyId": "3c62037a-2bac-4910-839d-5c803f0d4f0a",
"payPeriodType": "Missing",
"workerType": "W2",
"payBeginDate": "2023-11-12",
"payEndDate": "2023-12-10",
"payDate": "2023-12-10"
}
}
'import requests
url = "https://sandbox.rollfi.xyz/payroll/addSupplementalPayPeriod"
payload = {
"method": "addSupplementalPayPeriod",
"payPeriod": {
"companyId": "3c62037a-2bac-4910-839d-5c803f0d4f0a",
"payPeriodType": "Missing",
"workerType": "W2",
"payBeginDate": "2023-11-12",
"payEndDate": "2023-12-10",
"payDate": "2023-12-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: 'addSupplementalPayPeriod',
payPeriod: {
companyId: '3c62037a-2bac-4910-839d-5c803f0d4f0a',
payPeriodType: 'Missing',
workerType: 'W2',
payBeginDate: '2023-11-12',
payEndDate: '2023-12-10',
payDate: '2023-12-10'
}
})
};
fetch('https://sandbox.rollfi.xyz/payroll/addSupplementalPayPeriod', 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/addSupplementalPayPeriod",
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' => 'addSupplementalPayPeriod',
'payPeriod' => [
'companyId' => '3c62037a-2bac-4910-839d-5c803f0d4f0a',
'payPeriodType' => 'Missing',
'workerType' => 'W2',
'payBeginDate' => '2023-11-12',
'payEndDate' => '2023-12-10',
'payDate' => '2023-12-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/addSupplementalPayPeriod"
payload := strings.NewReader("{\n \"method\": \"addSupplementalPayPeriod\",\n \"payPeriod\": {\n \"companyId\": \"3c62037a-2bac-4910-839d-5c803f0d4f0a\",\n \"payPeriodType\": \"Missing\",\n \"workerType\": \"W2\",\n \"payBeginDate\": \"2023-11-12\",\n \"payEndDate\": \"2023-12-10\",\n \"payDate\": \"2023-12-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/addSupplementalPayPeriod")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"addSupplementalPayPeriod\",\n \"payPeriod\": {\n \"companyId\": \"3c62037a-2bac-4910-839d-5c803f0d4f0a\",\n \"payPeriodType\": \"Missing\",\n \"workerType\": \"W2\",\n \"payBeginDate\": \"2023-11-12\",\n \"payEndDate\": \"2023-12-10\",\n \"payDate\": \"2023-12-10\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/payroll/addSupplementalPayPeriod")
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\": \"addSupplementalPayPeriod\",\n \"payPeriod\": {\n \"companyId\": \"3c62037a-2bac-4910-839d-5c803f0d4f0a\",\n \"payPeriodType\": \"Missing\",\n \"workerType\": \"W2\",\n \"payBeginDate\": \"2023-11-12\",\n \"payEndDate\": \"2023-12-10\",\n \"payDate\": \"2023-12-10\"\n }\n}"
response = http.request(request)
puts response.read_body{
"payPeriod": {
"payPeriodId": "91384C53-089C-42E9-8CB0-59978AF46DEA",
"status": "New",
"message": "Supplemental PayPeriod for Prism Ltd 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
