removeOvertime
curl --request POST \
--url https://sandbox.rollfi.xyz/payroll/removeOvertime \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "removeOvertime",
"companyId": "F59AE5EA-BE39-4120-A11E-DA2610D866CA",
"payPeriodId": "382005A7-7B3E-4787-9B2B-2A3BE1767D7B",
"userId": "A34C2BA9-900D-46B8-A297-644F82D68E29",
"overtimeType": "Comp off OT"
}
'import requests
url = "https://sandbox.rollfi.xyz/payroll/removeOvertime"
payload = {
"method": "removeOvertime",
"companyId": "F59AE5EA-BE39-4120-A11E-DA2610D866CA",
"payPeriodId": "382005A7-7B3E-4787-9B2B-2A3BE1767D7B",
"userId": "A34C2BA9-900D-46B8-A297-644F82D68E29",
"overtimeType": "Comp off OT"
}
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: 'removeOvertime',
companyId: 'F59AE5EA-BE39-4120-A11E-DA2610D866CA',
payPeriodId: '382005A7-7B3E-4787-9B2B-2A3BE1767D7B',
userId: 'A34C2BA9-900D-46B8-A297-644F82D68E29',
overtimeType: 'Comp off OT'
})
};
fetch('https://sandbox.rollfi.xyz/payroll/removeOvertime', 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/removeOvertime",
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' => 'removeOvertime',
'companyId' => 'F59AE5EA-BE39-4120-A11E-DA2610D866CA',
'payPeriodId' => '382005A7-7B3E-4787-9B2B-2A3BE1767D7B',
'userId' => 'A34C2BA9-900D-46B8-A297-644F82D68E29',
'overtimeType' => 'Comp off OT'
]),
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/removeOvertime"
payload := strings.NewReader("{\n \"method\": \"removeOvertime\",\n \"companyId\": \"F59AE5EA-BE39-4120-A11E-DA2610D866CA\",\n \"payPeriodId\": \"382005A7-7B3E-4787-9B2B-2A3BE1767D7B\",\n \"userId\": \"A34C2BA9-900D-46B8-A297-644F82D68E29\",\n \"overtimeType\": \"Comp off OT\"\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/removeOvertime")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"removeOvertime\",\n \"companyId\": \"F59AE5EA-BE39-4120-A11E-DA2610D866CA\",\n \"payPeriodId\": \"382005A7-7B3E-4787-9B2B-2A3BE1767D7B\",\n \"userId\": \"A34C2BA9-900D-46B8-A297-644F82D68E29\",\n \"overtimeType\": \"Comp off OT\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/payroll/removeOvertime")
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\": \"removeOvertime\",\n \"companyId\": \"F59AE5EA-BE39-4120-A11E-DA2610D866CA\",\n \"payPeriodId\": \"382005A7-7B3E-4787-9B2B-2A3BE1767D7B\",\n \"userId\": \"A34C2BA9-900D-46B8-A297-644F82D68E29\",\n \"overtimeType\": \"Comp off OT\"\n}"
response = http.request(request)
puts response.read_body{
"overtimeRemoval": {
"status": "Success",
"message": "Comp off OT have been removed successfully."
}
}Payroll
removeOvertime
The removeOvertime API is used to remove overtime entries for an employee in a pay period.
When to use:
- When correcting overtime mistakes before payroll submission
Notes:
- Pay period must be in an editable state (see the
PayrollProcessingguide) - overtimeType can be used to remove specific overtimes for a user
- Automatically updates earnings calculations after removal
POST
/
payroll
/
removeOvertime
removeOvertime
curl --request POST \
--url https://sandbox.rollfi.xyz/payroll/removeOvertime \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "removeOvertime",
"companyId": "F59AE5EA-BE39-4120-A11E-DA2610D866CA",
"payPeriodId": "382005A7-7B3E-4787-9B2B-2A3BE1767D7B",
"userId": "A34C2BA9-900D-46B8-A297-644F82D68E29",
"overtimeType": "Comp off OT"
}
'import requests
url = "https://sandbox.rollfi.xyz/payroll/removeOvertime"
payload = {
"method": "removeOvertime",
"companyId": "F59AE5EA-BE39-4120-A11E-DA2610D866CA",
"payPeriodId": "382005A7-7B3E-4787-9B2B-2A3BE1767D7B",
"userId": "A34C2BA9-900D-46B8-A297-644F82D68E29",
"overtimeType": "Comp off OT"
}
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: 'removeOvertime',
companyId: 'F59AE5EA-BE39-4120-A11E-DA2610D866CA',
payPeriodId: '382005A7-7B3E-4787-9B2B-2A3BE1767D7B',
userId: 'A34C2BA9-900D-46B8-A297-644F82D68E29',
overtimeType: 'Comp off OT'
})
};
fetch('https://sandbox.rollfi.xyz/payroll/removeOvertime', 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/removeOvertime",
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' => 'removeOvertime',
'companyId' => 'F59AE5EA-BE39-4120-A11E-DA2610D866CA',
'payPeriodId' => '382005A7-7B3E-4787-9B2B-2A3BE1767D7B',
'userId' => 'A34C2BA9-900D-46B8-A297-644F82D68E29',
'overtimeType' => 'Comp off OT'
]),
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/removeOvertime"
payload := strings.NewReader("{\n \"method\": \"removeOvertime\",\n \"companyId\": \"F59AE5EA-BE39-4120-A11E-DA2610D866CA\",\n \"payPeriodId\": \"382005A7-7B3E-4787-9B2B-2A3BE1767D7B\",\n \"userId\": \"A34C2BA9-900D-46B8-A297-644F82D68E29\",\n \"overtimeType\": \"Comp off OT\"\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/removeOvertime")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"removeOvertime\",\n \"companyId\": \"F59AE5EA-BE39-4120-A11E-DA2610D866CA\",\n \"payPeriodId\": \"382005A7-7B3E-4787-9B2B-2A3BE1767D7B\",\n \"userId\": \"A34C2BA9-900D-46B8-A297-644F82D68E29\",\n \"overtimeType\": \"Comp off OT\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/payroll/removeOvertime")
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\": \"removeOvertime\",\n \"companyId\": \"F59AE5EA-BE39-4120-A11E-DA2610D866CA\",\n \"payPeriodId\": \"382005A7-7B3E-4787-9B2B-2A3BE1767D7B\",\n \"userId\": \"A34C2BA9-900D-46B8-A297-644F82D68E29\",\n \"overtimeType\": \"Comp off OT\"\n}"
response = http.request(request)
puts response.read_body{
"overtimeRemoval": {
"status": "Success",
"message": "Comp off OT have 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
