addSupplementalPayPeriodWithLineItems
curl --request POST \
--url https://sandbox.rollfi.xyz/payroll/addSupplementalPayPeriodWithLineItems \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "addSupplementalPayPeriodWithLineItems",
"payPeriod": {
"companyId": "C8D57032-BF6F-4510-AA41-08A358365531",
"payPeriodType": "Off-Cycle",
"workerType": "W2",
"payBeginDate": "2024-01-15",
"payEndDate": "2024-01-15",
"payDate": "2025-10-15",
"payrollLineItem": [
{
"userId": "123DA511-5970-4C2F-AF7E-5C0FB11D23A3",
"amount": 500,
"paymentMethod": "Direct Deposit"
},
{
"userId": "3D971CE4-3DA9-4031-AB0E-D0E1A364444B",
"amount": 300
}
]
}
}
'import requests
url = "https://sandbox.rollfi.xyz/payroll/addSupplementalPayPeriodWithLineItems"
payload = {
"method": "addSupplementalPayPeriodWithLineItems",
"payPeriod": {
"companyId": "C8D57032-BF6F-4510-AA41-08A358365531",
"payPeriodType": "Off-Cycle",
"workerType": "W2",
"payBeginDate": "2024-01-15",
"payEndDate": "2024-01-15",
"payDate": "2025-10-15",
"payrollLineItem": [
{
"userId": "123DA511-5970-4C2F-AF7E-5C0FB11D23A3",
"amount": 500,
"paymentMethod": "Direct Deposit"
},
{
"userId": "3D971CE4-3DA9-4031-AB0E-D0E1A364444B",
"amount": 300
}
]
}
}
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: 'addSupplementalPayPeriodWithLineItems',
payPeriod: {
companyId: 'C8D57032-BF6F-4510-AA41-08A358365531',
payPeriodType: 'Off-Cycle',
workerType: 'W2',
payBeginDate: '2024-01-15',
payEndDate: '2024-01-15',
payDate: '2025-10-15',
payrollLineItem: [
{
userId: '123DA511-5970-4C2F-AF7E-5C0FB11D23A3',
amount: 500,
paymentMethod: 'Direct Deposit'
},
{userId: '3D971CE4-3DA9-4031-AB0E-D0E1A364444B', amount: 300}
]
}
})
};
fetch('https://sandbox.rollfi.xyz/payroll/addSupplementalPayPeriodWithLineItems', 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/addSupplementalPayPeriodWithLineItems",
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' => 'addSupplementalPayPeriodWithLineItems',
'payPeriod' => [
'companyId' => 'C8D57032-BF6F-4510-AA41-08A358365531',
'payPeriodType' => 'Off-Cycle',
'workerType' => 'W2',
'payBeginDate' => '2024-01-15',
'payEndDate' => '2024-01-15',
'payDate' => '2025-10-15',
'payrollLineItem' => [
[
'userId' => '123DA511-5970-4C2F-AF7E-5C0FB11D23A3',
'amount' => 500,
'paymentMethod' => 'Direct Deposit'
],
[
'userId' => '3D971CE4-3DA9-4031-AB0E-D0E1A364444B',
'amount' => 300
]
]
]
]),
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/addSupplementalPayPeriodWithLineItems"
payload := strings.NewReader("{\n \"method\": \"addSupplementalPayPeriodWithLineItems\",\n \"payPeriod\": {\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodType\": \"Off-Cycle\",\n \"workerType\": \"W2\",\n \"payBeginDate\": \"2024-01-15\",\n \"payEndDate\": \"2024-01-15\",\n \"payDate\": \"2025-10-15\",\n \"payrollLineItem\": [\n {\n \"userId\": \"123DA511-5970-4C2F-AF7E-5C0FB11D23A3\",\n \"amount\": 500,\n \"paymentMethod\": \"Direct Deposit\"\n },\n {\n \"userId\": \"3D971CE4-3DA9-4031-AB0E-D0E1A364444B\",\n \"amount\": 300\n }\n ]\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/addSupplementalPayPeriodWithLineItems")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"addSupplementalPayPeriodWithLineItems\",\n \"payPeriod\": {\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodType\": \"Off-Cycle\",\n \"workerType\": \"W2\",\n \"payBeginDate\": \"2024-01-15\",\n \"payEndDate\": \"2024-01-15\",\n \"payDate\": \"2025-10-15\",\n \"payrollLineItem\": [\n {\n \"userId\": \"123DA511-5970-4C2F-AF7E-5C0FB11D23A3\",\n \"amount\": 500,\n \"paymentMethod\": \"Direct Deposit\"\n },\n {\n \"userId\": \"3D971CE4-3DA9-4031-AB0E-D0E1A364444B\",\n \"amount\": 300\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/payroll/addSupplementalPayPeriodWithLineItems")
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\": \"addSupplementalPayPeriodWithLineItems\",\n \"payPeriod\": {\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodType\": \"Off-Cycle\",\n \"workerType\": \"W2\",\n \"payBeginDate\": \"2024-01-15\",\n \"payEndDate\": \"2024-01-15\",\n \"payDate\": \"2025-10-15\",\n \"payrollLineItem\": [\n {\n \"userId\": \"123DA511-5970-4C2F-AF7E-5C0FB11D23A3\",\n \"amount\": 500,\n \"paymentMethod\": \"Direct Deposit\"\n },\n {\n \"userId\": \"3D971CE4-3DA9-4031-AB0E-D0E1A364444B\",\n \"amount\": 300\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"payPeriod": {
"payPeriodId": "80B0DE7E-BB68-4EDE-B418-36FC21B90914",
"status": "Ready",
"message": "Supplemental PayPeriod for Payroll MonthlyBiweekly has been saved successfully."
}
}Payroll
addSupplementalPayPeriodWithLineItems
The addSupplementalPayPeriodWithLineItems API is used to fully import a supplemental payPeriod to the rollfi system
Notes:
- This API is used when all the data for a supplemental payPeriod, including individual pay items, is readily available
- If you do not have access to the lineItem data at the time of import use
addSupplementalPayPeriodandaddSupplementalPayrollLineItemto achieve the same results
POST
/
payroll
/
addSupplementalPayPeriodWithLineItems
addSupplementalPayPeriodWithLineItems
curl --request POST \
--url https://sandbox.rollfi.xyz/payroll/addSupplementalPayPeriodWithLineItems \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "addSupplementalPayPeriodWithLineItems",
"payPeriod": {
"companyId": "C8D57032-BF6F-4510-AA41-08A358365531",
"payPeriodType": "Off-Cycle",
"workerType": "W2",
"payBeginDate": "2024-01-15",
"payEndDate": "2024-01-15",
"payDate": "2025-10-15",
"payrollLineItem": [
{
"userId": "123DA511-5970-4C2F-AF7E-5C0FB11D23A3",
"amount": 500,
"paymentMethod": "Direct Deposit"
},
{
"userId": "3D971CE4-3DA9-4031-AB0E-D0E1A364444B",
"amount": 300
}
]
}
}
'import requests
url = "https://sandbox.rollfi.xyz/payroll/addSupplementalPayPeriodWithLineItems"
payload = {
"method": "addSupplementalPayPeriodWithLineItems",
"payPeriod": {
"companyId": "C8D57032-BF6F-4510-AA41-08A358365531",
"payPeriodType": "Off-Cycle",
"workerType": "W2",
"payBeginDate": "2024-01-15",
"payEndDate": "2024-01-15",
"payDate": "2025-10-15",
"payrollLineItem": [
{
"userId": "123DA511-5970-4C2F-AF7E-5C0FB11D23A3",
"amount": 500,
"paymentMethod": "Direct Deposit"
},
{
"userId": "3D971CE4-3DA9-4031-AB0E-D0E1A364444B",
"amount": 300
}
]
}
}
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: 'addSupplementalPayPeriodWithLineItems',
payPeriod: {
companyId: 'C8D57032-BF6F-4510-AA41-08A358365531',
payPeriodType: 'Off-Cycle',
workerType: 'W2',
payBeginDate: '2024-01-15',
payEndDate: '2024-01-15',
payDate: '2025-10-15',
payrollLineItem: [
{
userId: '123DA511-5970-4C2F-AF7E-5C0FB11D23A3',
amount: 500,
paymentMethod: 'Direct Deposit'
},
{userId: '3D971CE4-3DA9-4031-AB0E-D0E1A364444B', amount: 300}
]
}
})
};
fetch('https://sandbox.rollfi.xyz/payroll/addSupplementalPayPeriodWithLineItems', 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/addSupplementalPayPeriodWithLineItems",
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' => 'addSupplementalPayPeriodWithLineItems',
'payPeriod' => [
'companyId' => 'C8D57032-BF6F-4510-AA41-08A358365531',
'payPeriodType' => 'Off-Cycle',
'workerType' => 'W2',
'payBeginDate' => '2024-01-15',
'payEndDate' => '2024-01-15',
'payDate' => '2025-10-15',
'payrollLineItem' => [
[
'userId' => '123DA511-5970-4C2F-AF7E-5C0FB11D23A3',
'amount' => 500,
'paymentMethod' => 'Direct Deposit'
],
[
'userId' => '3D971CE4-3DA9-4031-AB0E-D0E1A364444B',
'amount' => 300
]
]
]
]),
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/addSupplementalPayPeriodWithLineItems"
payload := strings.NewReader("{\n \"method\": \"addSupplementalPayPeriodWithLineItems\",\n \"payPeriod\": {\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodType\": \"Off-Cycle\",\n \"workerType\": \"W2\",\n \"payBeginDate\": \"2024-01-15\",\n \"payEndDate\": \"2024-01-15\",\n \"payDate\": \"2025-10-15\",\n \"payrollLineItem\": [\n {\n \"userId\": \"123DA511-5970-4C2F-AF7E-5C0FB11D23A3\",\n \"amount\": 500,\n \"paymentMethod\": \"Direct Deposit\"\n },\n {\n \"userId\": \"3D971CE4-3DA9-4031-AB0E-D0E1A364444B\",\n \"amount\": 300\n }\n ]\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/addSupplementalPayPeriodWithLineItems")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"addSupplementalPayPeriodWithLineItems\",\n \"payPeriod\": {\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodType\": \"Off-Cycle\",\n \"workerType\": \"W2\",\n \"payBeginDate\": \"2024-01-15\",\n \"payEndDate\": \"2024-01-15\",\n \"payDate\": \"2025-10-15\",\n \"payrollLineItem\": [\n {\n \"userId\": \"123DA511-5970-4C2F-AF7E-5C0FB11D23A3\",\n \"amount\": 500,\n \"paymentMethod\": \"Direct Deposit\"\n },\n {\n \"userId\": \"3D971CE4-3DA9-4031-AB0E-D0E1A364444B\",\n \"amount\": 300\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/payroll/addSupplementalPayPeriodWithLineItems")
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\": \"addSupplementalPayPeriodWithLineItems\",\n \"payPeriod\": {\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodType\": \"Off-Cycle\",\n \"workerType\": \"W2\",\n \"payBeginDate\": \"2024-01-15\",\n \"payEndDate\": \"2024-01-15\",\n \"payDate\": \"2025-10-15\",\n \"payrollLineItem\": [\n {\n \"userId\": \"123DA511-5970-4C2F-AF7E-5C0FB11D23A3\",\n \"amount\": 500,\n \"paymentMethod\": \"Direct Deposit\"\n },\n {\n \"userId\": \"3D971CE4-3DA9-4031-AB0E-D0E1A364444B\",\n \"amount\": 300\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"payPeriod": {
"payPeriodId": "80B0DE7E-BB68-4EDE-B418-36FC21B90914",
"status": "Ready",
"message": "Supplemental PayPeriod for Payroll MonthlyBiweekly has been saved successfully."
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Response
Show child attributes
Show child attributes