removeUsersFromRegularPayPeriod
curl --request POST \
--url https://sandbox.rollfi.xyz/payroll/removeUsersFromRegularPayPeriod \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "removeUsersFromRegularPayPeriod",
"companyId": "C8D57032-BF6F-4510-AA41-08A358365531",
"payPeriodId": "81A0AE81-F817-4012-B058-46B2C0B9B72C",
"payrollLineItems": [
{
"userId": "BEC0E358-C9F5-4FEA-AED3-6A25C205F599",
"reason": "sabatical vacation"
}
]
}
'import requests
url = "https://sandbox.rollfi.xyz/payroll/removeUsersFromRegularPayPeriod"
payload = {
"method": "removeUsersFromRegularPayPeriod",
"companyId": "C8D57032-BF6F-4510-AA41-08A358365531",
"payPeriodId": "81A0AE81-F817-4012-B058-46B2C0B9B72C",
"payrollLineItems": [
{
"userId": "BEC0E358-C9F5-4FEA-AED3-6A25C205F599",
"reason": "sabatical vacation"
}
]
}
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: 'removeUsersFromRegularPayPeriod',
companyId: 'C8D57032-BF6F-4510-AA41-08A358365531',
payPeriodId: '81A0AE81-F817-4012-B058-46B2C0B9B72C',
payrollLineItems: [{userId: 'BEC0E358-C9F5-4FEA-AED3-6A25C205F599', reason: 'sabatical vacation'}]
})
};
fetch('https://sandbox.rollfi.xyz/payroll/removeUsersFromRegularPayPeriod', 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/removeUsersFromRegularPayPeriod",
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' => 'removeUsersFromRegularPayPeriod',
'companyId' => 'C8D57032-BF6F-4510-AA41-08A358365531',
'payPeriodId' => '81A0AE81-F817-4012-B058-46B2C0B9B72C',
'payrollLineItems' => [
[
'userId' => 'BEC0E358-C9F5-4FEA-AED3-6A25C205F599',
'reason' => 'sabatical vacation'
]
]
]),
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/removeUsersFromRegularPayPeriod"
payload := strings.NewReader("{\n \"method\": \"removeUsersFromRegularPayPeriod\",\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodId\": \"81A0AE81-F817-4012-B058-46B2C0B9B72C\",\n \"payrollLineItems\": [\n {\n \"userId\": \"BEC0E358-C9F5-4FEA-AED3-6A25C205F599\",\n \"reason\": \"sabatical vacation\"\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/removeUsersFromRegularPayPeriod")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"removeUsersFromRegularPayPeriod\",\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodId\": \"81A0AE81-F817-4012-B058-46B2C0B9B72C\",\n \"payrollLineItems\": [\n {\n \"userId\": \"BEC0E358-C9F5-4FEA-AED3-6A25C205F599\",\n \"reason\": \"sabatical vacation\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/payroll/removeUsersFromRegularPayPeriod")
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\": \"removeUsersFromRegularPayPeriod\",\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodId\": \"81A0AE81-F817-4012-B058-46B2C0B9B72C\",\n \"payrollLineItems\": [\n {\n \"userId\": \"BEC0E358-C9F5-4FEA-AED3-6A25C205F599\",\n \"reason\": \"sabatical vacation\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"payrollLineItems": [
{
"userId": "BEC0E358-C9F5-4FEA-AED3-6A25C205F599",
"status": "Removed",
"message": "The PayrollLineItem for Brendon Mcln has been removed successfully."
}
]
}Payroll
removeUsersFromRegularPayPeriod
The removeUsersFromRegularPayPeriod API is used to remove employees from a regular pay period due to many different circumstances
When to use:
- When there are employee terminations mid-pay period that need to be reflected in payroll
- When payroll corrections are needed to fix accidental additions before payroll processing
Notes:
- Cannot remove all employees - at least one must remain in the pay period
- In the event that all employees need to be removed from a payroll use the
skipPayPeriodAPI
POST
/
payroll
/
removeUsersFromRegularPayPeriod
removeUsersFromRegularPayPeriod
curl --request POST \
--url https://sandbox.rollfi.xyz/payroll/removeUsersFromRegularPayPeriod \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "removeUsersFromRegularPayPeriod",
"companyId": "C8D57032-BF6F-4510-AA41-08A358365531",
"payPeriodId": "81A0AE81-F817-4012-B058-46B2C0B9B72C",
"payrollLineItems": [
{
"userId": "BEC0E358-C9F5-4FEA-AED3-6A25C205F599",
"reason": "sabatical vacation"
}
]
}
'import requests
url = "https://sandbox.rollfi.xyz/payroll/removeUsersFromRegularPayPeriod"
payload = {
"method": "removeUsersFromRegularPayPeriod",
"companyId": "C8D57032-BF6F-4510-AA41-08A358365531",
"payPeriodId": "81A0AE81-F817-4012-B058-46B2C0B9B72C",
"payrollLineItems": [
{
"userId": "BEC0E358-C9F5-4FEA-AED3-6A25C205F599",
"reason": "sabatical vacation"
}
]
}
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: 'removeUsersFromRegularPayPeriod',
companyId: 'C8D57032-BF6F-4510-AA41-08A358365531',
payPeriodId: '81A0AE81-F817-4012-B058-46B2C0B9B72C',
payrollLineItems: [{userId: 'BEC0E358-C9F5-4FEA-AED3-6A25C205F599', reason: 'sabatical vacation'}]
})
};
fetch('https://sandbox.rollfi.xyz/payroll/removeUsersFromRegularPayPeriod', 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/removeUsersFromRegularPayPeriod",
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' => 'removeUsersFromRegularPayPeriod',
'companyId' => 'C8D57032-BF6F-4510-AA41-08A358365531',
'payPeriodId' => '81A0AE81-F817-4012-B058-46B2C0B9B72C',
'payrollLineItems' => [
[
'userId' => 'BEC0E358-C9F5-4FEA-AED3-6A25C205F599',
'reason' => 'sabatical vacation'
]
]
]),
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/removeUsersFromRegularPayPeriod"
payload := strings.NewReader("{\n \"method\": \"removeUsersFromRegularPayPeriod\",\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodId\": \"81A0AE81-F817-4012-B058-46B2C0B9B72C\",\n \"payrollLineItems\": [\n {\n \"userId\": \"BEC0E358-C9F5-4FEA-AED3-6A25C205F599\",\n \"reason\": \"sabatical vacation\"\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/removeUsersFromRegularPayPeriod")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"removeUsersFromRegularPayPeriod\",\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodId\": \"81A0AE81-F817-4012-B058-46B2C0B9B72C\",\n \"payrollLineItems\": [\n {\n \"userId\": \"BEC0E358-C9F5-4FEA-AED3-6A25C205F599\",\n \"reason\": \"sabatical vacation\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/payroll/removeUsersFromRegularPayPeriod")
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\": \"removeUsersFromRegularPayPeriod\",\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodId\": \"81A0AE81-F817-4012-B058-46B2C0B9B72C\",\n \"payrollLineItems\": [\n {\n \"userId\": \"BEC0E358-C9F5-4FEA-AED3-6A25C205F599\",\n \"reason\": \"sabatical vacation\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"payrollLineItems": [
{
"userId": "BEC0E358-C9F5-4FEA-AED3-6A25C205F599",
"status": "Removed",
"message": "The PayrollLineItem for Brendon Mcln has been removed 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
