deactivatePaySchedule
curl --request POST \
--url https://sandbox.rollfi.xyz/payroll/deactivatePaySchedule \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "deactivatePaySchedule",
"payScheduleId": "141D6357-CB56-42C9-951D-E80E10C5853A"
}
'import requests
url = "https://sandbox.rollfi.xyz/payroll/deactivatePaySchedule"
payload = {
"method": "deactivatePaySchedule",
"payScheduleId": "141D6357-CB56-42C9-951D-E80E10C5853A"
}
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: 'deactivatePaySchedule',
payScheduleId: '141D6357-CB56-42C9-951D-E80E10C5853A'
})
};
fetch('https://sandbox.rollfi.xyz/payroll/deactivatePaySchedule', 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/deactivatePaySchedule",
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' => 'deactivatePaySchedule',
'payScheduleId' => '141D6357-CB56-42C9-951D-E80E10C5853A'
]),
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/deactivatePaySchedule"
payload := strings.NewReader("{\n \"method\": \"deactivatePaySchedule\",\n \"payScheduleId\": \"141D6357-CB56-42C9-951D-E80E10C5853A\"\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/deactivatePaySchedule")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"deactivatePaySchedule\",\n \"payScheduleId\": \"141D6357-CB56-42C9-951D-E80E10C5853A\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/payroll/deactivatePaySchedule")
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\": \"deactivatePaySchedule\",\n \"payScheduleId\": \"141D6357-CB56-42C9-951D-E80E10C5853A\"\n}"
response = http.request(request)
puts response.read_body{
"PaySchedule": {
"PayScheduleID": "1F67BE13-4E3E-4578-AC25-5660DFDE9E39",
"Status": "InActive",
"Message": "The PaySchedule has been deactivated successfully."
}
}Payroll
deactivatePaySchedule
The deactivatePaySchedule API Deactivates an existing pay schedule (cannot be undone).
When to Use
- Changing pay frequency
- Company restructuring
- Ending contractor arrangements
Warnings:
- ⚠️ This action is permanent. Create new pay schedule if needed.
- ⚠️ Any unprocessed payPeriods belonging to the paySchedule will be removed. Please initiate the current payPeriod before deactivating the pay schedule if you’d like the change to only take affect for the following period.
POST
/
payroll
/
deactivatePaySchedule
deactivatePaySchedule
curl --request POST \
--url https://sandbox.rollfi.xyz/payroll/deactivatePaySchedule \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "deactivatePaySchedule",
"payScheduleId": "141D6357-CB56-42C9-951D-E80E10C5853A"
}
'import requests
url = "https://sandbox.rollfi.xyz/payroll/deactivatePaySchedule"
payload = {
"method": "deactivatePaySchedule",
"payScheduleId": "141D6357-CB56-42C9-951D-E80E10C5853A"
}
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: 'deactivatePaySchedule',
payScheduleId: '141D6357-CB56-42C9-951D-E80E10C5853A'
})
};
fetch('https://sandbox.rollfi.xyz/payroll/deactivatePaySchedule', 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/deactivatePaySchedule",
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' => 'deactivatePaySchedule',
'payScheduleId' => '141D6357-CB56-42C9-951D-E80E10C5853A'
]),
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/deactivatePaySchedule"
payload := strings.NewReader("{\n \"method\": \"deactivatePaySchedule\",\n \"payScheduleId\": \"141D6357-CB56-42C9-951D-E80E10C5853A\"\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/deactivatePaySchedule")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"deactivatePaySchedule\",\n \"payScheduleId\": \"141D6357-CB56-42C9-951D-E80E10C5853A\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/payroll/deactivatePaySchedule")
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\": \"deactivatePaySchedule\",\n \"payScheduleId\": \"141D6357-CB56-42C9-951D-E80E10C5853A\"\n}"
response = http.request(request)
puts response.read_body{
"PaySchedule": {
"PayScheduleID": "1F67BE13-4E3E-4578-AC25-5660DFDE9E39",
"Status": "InActive",
"Message": "The PaySchedule has been deactivated successfully."
}
}