addUsersToSupplementalPayPeriod
curl --request POST \
--url https://sandbox.rollfi.xyz/payroll/addUsersToSupplementalPayPeriod \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "addUsersToSupplementalPayPeriod",
"companyId": "C8D57032-BF6F-4510-AA41-08A358365531",
"payPeriodId": "4083B766-8F3A-4A23-ABB7-FB67FA1F97D3",
"payrollLineItems": [
{
"userId": "7DDB8A83-29D5-4454-9467-53CC80307139",
"amount": 1000,
"paymentMethod": "Check"
},
{
"userId": "123DA511-5970-4C2F-AF7E-5C0FB11D23A3",
"amount": 1500,
"paymentMethod": "Direct Deposit"
}
]
}
'import requests
url = "https://sandbox.rollfi.xyz/payroll/addUsersToSupplementalPayPeriod"
payload = {
"method": "addUsersToSupplementalPayPeriod",
"companyId": "C8D57032-BF6F-4510-AA41-08A358365531",
"payPeriodId": "4083B766-8F3A-4A23-ABB7-FB67FA1F97D3",
"payrollLineItems": [
{
"userId": "7DDB8A83-29D5-4454-9467-53CC80307139",
"amount": 1000,
"paymentMethod": "Check"
},
{
"userId": "123DA511-5970-4C2F-AF7E-5C0FB11D23A3",
"amount": 1500,
"paymentMethod": "Direct Deposit"
}
]
}
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: 'addUsersToSupplementalPayPeriod',
companyId: 'C8D57032-BF6F-4510-AA41-08A358365531',
payPeriodId: '4083B766-8F3A-4A23-ABB7-FB67FA1F97D3',
payrollLineItems: [
{
userId: '7DDB8A83-29D5-4454-9467-53CC80307139',
amount: 1000,
paymentMethod: 'Check'
},
{
userId: '123DA511-5970-4C2F-AF7E-5C0FB11D23A3',
amount: 1500,
paymentMethod: 'Direct Deposit'
}
]
})
};
fetch('https://sandbox.rollfi.xyz/payroll/addUsersToSupplementalPayPeriod', 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/addUsersToSupplementalPayPeriod",
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' => 'addUsersToSupplementalPayPeriod',
'companyId' => 'C8D57032-BF6F-4510-AA41-08A358365531',
'payPeriodId' => '4083B766-8F3A-4A23-ABB7-FB67FA1F97D3',
'payrollLineItems' => [
[
'userId' => '7DDB8A83-29D5-4454-9467-53CC80307139',
'amount' => 1000,
'paymentMethod' => 'Check'
],
[
'userId' => '123DA511-5970-4C2F-AF7E-5C0FB11D23A3',
'amount' => 1500,
'paymentMethod' => 'Direct Deposit'
]
]
]),
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/addUsersToSupplementalPayPeriod"
payload := strings.NewReader("{\n \"method\": \"addUsersToSupplementalPayPeriod\",\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodId\": \"4083B766-8F3A-4A23-ABB7-FB67FA1F97D3\",\n \"payrollLineItems\": [\n {\n \"userId\": \"7DDB8A83-29D5-4454-9467-53CC80307139\",\n \"amount\": 1000,\n \"paymentMethod\": \"Check\"\n },\n {\n \"userId\": \"123DA511-5970-4C2F-AF7E-5C0FB11D23A3\",\n \"amount\": 1500,\n \"paymentMethod\": \"Direct Deposit\"\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/addUsersToSupplementalPayPeriod")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"addUsersToSupplementalPayPeriod\",\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodId\": \"4083B766-8F3A-4A23-ABB7-FB67FA1F97D3\",\n \"payrollLineItems\": [\n {\n \"userId\": \"7DDB8A83-29D5-4454-9467-53CC80307139\",\n \"amount\": 1000,\n \"paymentMethod\": \"Check\"\n },\n {\n \"userId\": \"123DA511-5970-4C2F-AF7E-5C0FB11D23A3\",\n \"amount\": 1500,\n \"paymentMethod\": \"Direct Deposit\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/payroll/addUsersToSupplementalPayPeriod")
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\": \"addUsersToSupplementalPayPeriod\",\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodId\": \"4083B766-8F3A-4A23-ABB7-FB67FA1F97D3\",\n \"payrollLineItems\": [\n {\n \"userId\": \"7DDB8A83-29D5-4454-9467-53CC80307139\",\n \"amount\": 1000,\n \"paymentMethod\": \"Check\"\n },\n {\n \"userId\": \"123DA511-5970-4C2F-AF7E-5C0FB11D23A3\",\n \"amount\": 1500,\n \"paymentMethod\": \"Direct Deposit\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"payrollLineItems": [
{
"userId": "7DDB8A83-29D5-4454-9467-53CC80307139",
"status": "Ready",
"message": "The PayrollLineItem for Const Jonas has been saved successfully."
},
{
"userId": "123DA511-5970-4C2F-AF7E-5C0FB11D23A3",
"status": "Ready",
"message": "The PayrollLineItem for Celina Gos has been saved successfully."
}
]
}Payroll
addUsersToSupplementalPayPeriod
The addUsersToSupplementalPayPeriod API is used to add employees to a supplemental pay period for bonuses, commissions, or adjustments.
When to use:
- When issuing bonuses, commissions, or one-time payments
- When processing termination payouts outside regular payroll
Note:
- To create a supplemental pay period use the
addSupplementalPayPeriodAPI
POST
/
payroll
/
addUsersToSupplementalPayPeriod
addUsersToSupplementalPayPeriod
curl --request POST \
--url https://sandbox.rollfi.xyz/payroll/addUsersToSupplementalPayPeriod \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "addUsersToSupplementalPayPeriod",
"companyId": "C8D57032-BF6F-4510-AA41-08A358365531",
"payPeriodId": "4083B766-8F3A-4A23-ABB7-FB67FA1F97D3",
"payrollLineItems": [
{
"userId": "7DDB8A83-29D5-4454-9467-53CC80307139",
"amount": 1000,
"paymentMethod": "Check"
},
{
"userId": "123DA511-5970-4C2F-AF7E-5C0FB11D23A3",
"amount": 1500,
"paymentMethod": "Direct Deposit"
}
]
}
'import requests
url = "https://sandbox.rollfi.xyz/payroll/addUsersToSupplementalPayPeriod"
payload = {
"method": "addUsersToSupplementalPayPeriod",
"companyId": "C8D57032-BF6F-4510-AA41-08A358365531",
"payPeriodId": "4083B766-8F3A-4A23-ABB7-FB67FA1F97D3",
"payrollLineItems": [
{
"userId": "7DDB8A83-29D5-4454-9467-53CC80307139",
"amount": 1000,
"paymentMethod": "Check"
},
{
"userId": "123DA511-5970-4C2F-AF7E-5C0FB11D23A3",
"amount": 1500,
"paymentMethod": "Direct Deposit"
}
]
}
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: 'addUsersToSupplementalPayPeriod',
companyId: 'C8D57032-BF6F-4510-AA41-08A358365531',
payPeriodId: '4083B766-8F3A-4A23-ABB7-FB67FA1F97D3',
payrollLineItems: [
{
userId: '7DDB8A83-29D5-4454-9467-53CC80307139',
amount: 1000,
paymentMethod: 'Check'
},
{
userId: '123DA511-5970-4C2F-AF7E-5C0FB11D23A3',
amount: 1500,
paymentMethod: 'Direct Deposit'
}
]
})
};
fetch('https://sandbox.rollfi.xyz/payroll/addUsersToSupplementalPayPeriod', 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/addUsersToSupplementalPayPeriod",
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' => 'addUsersToSupplementalPayPeriod',
'companyId' => 'C8D57032-BF6F-4510-AA41-08A358365531',
'payPeriodId' => '4083B766-8F3A-4A23-ABB7-FB67FA1F97D3',
'payrollLineItems' => [
[
'userId' => '7DDB8A83-29D5-4454-9467-53CC80307139',
'amount' => 1000,
'paymentMethod' => 'Check'
],
[
'userId' => '123DA511-5970-4C2F-AF7E-5C0FB11D23A3',
'amount' => 1500,
'paymentMethod' => 'Direct Deposit'
]
]
]),
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/addUsersToSupplementalPayPeriod"
payload := strings.NewReader("{\n \"method\": \"addUsersToSupplementalPayPeriod\",\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodId\": \"4083B766-8F3A-4A23-ABB7-FB67FA1F97D3\",\n \"payrollLineItems\": [\n {\n \"userId\": \"7DDB8A83-29D5-4454-9467-53CC80307139\",\n \"amount\": 1000,\n \"paymentMethod\": \"Check\"\n },\n {\n \"userId\": \"123DA511-5970-4C2F-AF7E-5C0FB11D23A3\",\n \"amount\": 1500,\n \"paymentMethod\": \"Direct Deposit\"\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/addUsersToSupplementalPayPeriod")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"addUsersToSupplementalPayPeriod\",\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodId\": \"4083B766-8F3A-4A23-ABB7-FB67FA1F97D3\",\n \"payrollLineItems\": [\n {\n \"userId\": \"7DDB8A83-29D5-4454-9467-53CC80307139\",\n \"amount\": 1000,\n \"paymentMethod\": \"Check\"\n },\n {\n \"userId\": \"123DA511-5970-4C2F-AF7E-5C0FB11D23A3\",\n \"amount\": 1500,\n \"paymentMethod\": \"Direct Deposit\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/payroll/addUsersToSupplementalPayPeriod")
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\": \"addUsersToSupplementalPayPeriod\",\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodId\": \"4083B766-8F3A-4A23-ABB7-FB67FA1F97D3\",\n \"payrollLineItems\": [\n {\n \"userId\": \"7DDB8A83-29D5-4454-9467-53CC80307139\",\n \"amount\": 1000,\n \"paymentMethod\": \"Check\"\n },\n {\n \"userId\": \"123DA511-5970-4C2F-AF7E-5C0FB11D23A3\",\n \"amount\": 1500,\n \"paymentMethod\": \"Direct Deposit\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"payrollLineItems": [
{
"userId": "7DDB8A83-29D5-4454-9467-53CC80307139",
"status": "Ready",
"message": "The PayrollLineItem for Const Jonas has been saved successfully."
},
{
"userId": "123DA511-5970-4C2F-AF7E-5C0FB11D23A3",
"status": "Ready",
"message": "The PayrollLineItem for Celina Gos 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
