skipPayPeriod
curl --request POST \
--url https://sandbox.rollfi.xyz/payroll/skipPayPeriod \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "skipPayPeriod",
"companyId": "C8D57032-BF6F-4510-AA41-08A358365531",
"payPeriodId": "81A0AE81-F817-4012-B058-46B2C0B9B72C"
}
'import requests
url = "https://sandbox.rollfi.xyz/payroll/skipPayPeriod"
payload = {
"method": "skipPayPeriod",
"companyId": "C8D57032-BF6F-4510-AA41-08A358365531",
"payPeriodId": "81A0AE81-F817-4012-B058-46B2C0B9B72C"
}
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: 'skipPayPeriod',
companyId: 'C8D57032-BF6F-4510-AA41-08A358365531',
payPeriodId: '81A0AE81-F817-4012-B058-46B2C0B9B72C'
})
};
fetch('https://sandbox.rollfi.xyz/payroll/skipPayPeriod', 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/skipPayPeriod",
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' => 'skipPayPeriod',
'companyId' => 'C8D57032-BF6F-4510-AA41-08A358365531',
'payPeriodId' => '81A0AE81-F817-4012-B058-46B2C0B9B72C'
]),
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/skipPayPeriod"
payload := strings.NewReader("{\n \"method\": \"skipPayPeriod\",\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodId\": \"81A0AE81-F817-4012-B058-46B2C0B9B72C\"\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/skipPayPeriod")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"skipPayPeriod\",\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodId\": \"81A0AE81-F817-4012-B058-46B2C0B9B72C\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/payroll/skipPayPeriod")
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\": \"skipPayPeriod\",\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodId\": \"81A0AE81-F817-4012-B058-46B2C0B9B72C\"\n}"
response = http.request(request)
puts response.read_body{
"skipPayPeriod": {
"status": "Skipped",
"message": "PayPeriod skipped Successfully"
}
}Payroll
skipPayPeriod
The skipPayPeriod API is used to skip a pay period
When to use:
- If payroll for a payperiod is handled outside of the rollfi system
- When a payPeriod is no longer required, such as during a furlough period
Notes:
- payPeriodStatus becomes
Skippedafter using this API - This is a finalized state. To recreate a skipped payroll, use a supplemental payPeriod
POST
/
payroll
/
skipPayPeriod
skipPayPeriod
curl --request POST \
--url https://sandbox.rollfi.xyz/payroll/skipPayPeriod \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "skipPayPeriod",
"companyId": "C8D57032-BF6F-4510-AA41-08A358365531",
"payPeriodId": "81A0AE81-F817-4012-B058-46B2C0B9B72C"
}
'import requests
url = "https://sandbox.rollfi.xyz/payroll/skipPayPeriod"
payload = {
"method": "skipPayPeriod",
"companyId": "C8D57032-BF6F-4510-AA41-08A358365531",
"payPeriodId": "81A0AE81-F817-4012-B058-46B2C0B9B72C"
}
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: 'skipPayPeriod',
companyId: 'C8D57032-BF6F-4510-AA41-08A358365531',
payPeriodId: '81A0AE81-F817-4012-B058-46B2C0B9B72C'
})
};
fetch('https://sandbox.rollfi.xyz/payroll/skipPayPeriod', 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/skipPayPeriod",
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' => 'skipPayPeriod',
'companyId' => 'C8D57032-BF6F-4510-AA41-08A358365531',
'payPeriodId' => '81A0AE81-F817-4012-B058-46B2C0B9B72C'
]),
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/skipPayPeriod"
payload := strings.NewReader("{\n \"method\": \"skipPayPeriod\",\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodId\": \"81A0AE81-F817-4012-B058-46B2C0B9B72C\"\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/skipPayPeriod")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"skipPayPeriod\",\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodId\": \"81A0AE81-F817-4012-B058-46B2C0B9B72C\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/payroll/skipPayPeriod")
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\": \"skipPayPeriod\",\n \"companyId\": \"C8D57032-BF6F-4510-AA41-08A358365531\",\n \"payPeriodId\": \"81A0AE81-F817-4012-B058-46B2C0B9B72C\"\n}"
response = http.request(request)
puts response.read_body{
"skipPayPeriod": {
"status": "Skipped",
"message": "PayPeriod skipped 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
⌘I
