getUnProcessedPayPeriod
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getUnProcessedPayPeriod \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getUnProcessedPayPeriod",
"companyId": "2DFCA586-C2D4-4FD7-B823-063F2575A5E7",
"workerType": "W2"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getUnProcessedPayPeriod"
payload = {
"method": "getUnProcessedPayPeriod",
"companyId": "2DFCA586-C2D4-4FD7-B823-063F2575A5E7",
"workerType": "W2"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'getUnProcessedPayPeriod',
companyId: '2DFCA586-C2D4-4FD7-B823-063F2575A5E7',
workerType: 'W2'
})
};
fetch('https://sandbox.rollfi.xyz/reports/getUnProcessedPayPeriod', 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/reports/getUnProcessedPayPeriod",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'getUnProcessedPayPeriod',
'companyId' => '2DFCA586-C2D4-4FD7-B823-063F2575A5E7',
'workerType' => 'W2'
]),
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/reports/getUnProcessedPayPeriod"
payload := strings.NewReader("{\n \"method\": \"getUnProcessedPayPeriod\",\n \"companyId\": \"2DFCA586-C2D4-4FD7-B823-063F2575A5E7\",\n \"workerType\": \"W2\"\n}")
req, _ := http.NewRequest("GET", 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.get("https://sandbox.rollfi.xyz/reports/getUnProcessedPayPeriod")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getUnProcessedPayPeriod\",\n \"companyId\": \"2DFCA586-C2D4-4FD7-B823-063F2575A5E7\",\n \"workerType\": \"W2\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getUnProcessedPayPeriod")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"getUnProcessedPayPeriod\",\n \"companyId\": \"2DFCA586-C2D4-4FD7-B823-063F2575A5E7\",\n \"workerType\": \"W2\"\n}"
response = http.request(request)
puts response.read_body{
"unprocessedPayPeriods": [
{
"payPeriodId": "080EA408-D041-4C43-A745-9337AAEB9EAF",
"payPeriod": "09/17/2025 - 09/23/2025",
"payPeriodType": "Regular",
"payBeginDate": "2025-09-17",
"payEndDate": "2025-09-23",
"payDate": "2026-03-11",
"deadLineToRunPayroll": "2025-09-19",
"payPeriodStatus": "new",
"workerType": "1099-NEC"
},
{
"payPeriodId": "EDCDB86C-337A-4CA9-88AB-48750BE757D4",
"payPeriod": "03/16/2026 - 03/31/2026",
"payPeriodType": "Regular",
"payBeginDate": "2026-03-16",
"payEndDate": "2026-03-31",
"payDate": "2026-03-31",
"deadLineToRunPayroll": "2026-03-27",
"payPeriodStatus": "new",
"workerType": "W2"
},
{
"payPeriodId": "8EF7603A-8ECF-40E4-82E8-2C5FC5528D5F",
"payPeriod": "02/02/2026 - 02/09/2026",
"payPeriodType": "Off-Cycle",
"payBeginDate": "2026-02-02",
"payEndDate": "2026-02-09",
"payDate": "2026-04-01",
"deadLineToRunPayroll": "2026-03-30",
"payPeriodStatus": "new",
"workerType": "W2"
},
{
"payPeriodId": "CC4D8605-1FA4-4EB9-9E57-9EBEF1AFD703",
"payPeriod": "03/09/2026 - 03/23/2026",
"payPeriodType": "Off-Cycle",
"payBeginDate": "2026-03-09",
"payEndDate": "2026-03-23",
"payDate": "2026-04-01",
"deadLineToRunPayroll": "2026-03-30",
"payPeriodStatus": "new",
"workerType": "W2"
},
{
"payPeriodId": "7F52523F-EBF0-40BD-87D4-20E82AF5AD95",
"payPeriod": "02/02/2026 - 03/24/2026",
"payPeriodType": "Off-Cycle",
"payBeginDate": "2026-02-02",
"payEndDate": "2026-03-24",
"payDate": "2026-04-02",
"deadLineToRunPayroll": "2026-03-31",
"payPeriodStatus": "new",
"workerType": "W2"
},
{
"payPeriodId": "3BBB82F7-FDF0-4CAE-BF39-5611D8D6E304",
"payPeriod": "03/31/2026 - 03/31/2026",
"payPeriodType": "Missing",
"payBeginDate": "2026-03-31",
"payEndDate": "2026-03-31",
"payDate": "2026-04-03",
"deadLineToRunPayroll": "2026-04-01",
"payPeriodStatus": "new",
"workerType": "W2"
},
{
"payPeriodId": "329ED801-CE87-42F3-87AE-59AA65E007C6",
"payPeriod": "03/30/2026 - 03/30/2026",
"payPeriodType": "Missing",
"payBeginDate": "2026-03-30",
"payEndDate": "2026-03-30",
"payDate": "2026-04-03",
"deadLineToRunPayroll": "2026-04-01",
"payPeriodStatus": "new",
"workerType": "W2"
},
{
"payPeriodId": "DC815FD5-B8BA-4021-A51D-2DD2FF2971B4",
"payPeriod": "05/19/2026 - 05/25/2026",
"payPeriodType": "Missing",
"payBeginDate": "2026-05-19",
"payEndDate": "2026-05-25",
"payDate": "2026-05-20",
"deadLineToRunPayroll": "2026-05-18",
"payPeriodStatus": "new",
"workerType": "W2"
}
]
}{
"error": {
"code": 400,
"message": "Invalid WorkerType"
}
}Reports
getUnProcessedPayPeriod
The getUnProcessedPayPeriod API retrieves pay periods that have not yet been processed for payroll.
What it does:
- Returns pay periods that have not completed processing
- Provides pay period details for periods awaiting payroll processing including key dates and deadline to run payroll
Notes:
- Used to identify pay periods that are available for processing with
initiatePayroll - Returns payPeriods that are submitted but not yet paid out, and payPeriods that are editable
- Uses optional workerType to filter by W2 or 1099-NEC or can be used to return both
GET
/
reports
/
getUnProcessedPayPeriod
getUnProcessedPayPeriod
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getUnProcessedPayPeriod \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getUnProcessedPayPeriod",
"companyId": "2DFCA586-C2D4-4FD7-B823-063F2575A5E7",
"workerType": "W2"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getUnProcessedPayPeriod"
payload = {
"method": "getUnProcessedPayPeriod",
"companyId": "2DFCA586-C2D4-4FD7-B823-063F2575A5E7",
"workerType": "W2"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'getUnProcessedPayPeriod',
companyId: '2DFCA586-C2D4-4FD7-B823-063F2575A5E7',
workerType: 'W2'
})
};
fetch('https://sandbox.rollfi.xyz/reports/getUnProcessedPayPeriod', 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/reports/getUnProcessedPayPeriod",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'getUnProcessedPayPeriod',
'companyId' => '2DFCA586-C2D4-4FD7-B823-063F2575A5E7',
'workerType' => 'W2'
]),
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/reports/getUnProcessedPayPeriod"
payload := strings.NewReader("{\n \"method\": \"getUnProcessedPayPeriod\",\n \"companyId\": \"2DFCA586-C2D4-4FD7-B823-063F2575A5E7\",\n \"workerType\": \"W2\"\n}")
req, _ := http.NewRequest("GET", 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.get("https://sandbox.rollfi.xyz/reports/getUnProcessedPayPeriod")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getUnProcessedPayPeriod\",\n \"companyId\": \"2DFCA586-C2D4-4FD7-B823-063F2575A5E7\",\n \"workerType\": \"W2\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getUnProcessedPayPeriod")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"getUnProcessedPayPeriod\",\n \"companyId\": \"2DFCA586-C2D4-4FD7-B823-063F2575A5E7\",\n \"workerType\": \"W2\"\n}"
response = http.request(request)
puts response.read_body{
"unprocessedPayPeriods": [
{
"payPeriodId": "080EA408-D041-4C43-A745-9337AAEB9EAF",
"payPeriod": "09/17/2025 - 09/23/2025",
"payPeriodType": "Regular",
"payBeginDate": "2025-09-17",
"payEndDate": "2025-09-23",
"payDate": "2026-03-11",
"deadLineToRunPayroll": "2025-09-19",
"payPeriodStatus": "new",
"workerType": "1099-NEC"
},
{
"payPeriodId": "EDCDB86C-337A-4CA9-88AB-48750BE757D4",
"payPeriod": "03/16/2026 - 03/31/2026",
"payPeriodType": "Regular",
"payBeginDate": "2026-03-16",
"payEndDate": "2026-03-31",
"payDate": "2026-03-31",
"deadLineToRunPayroll": "2026-03-27",
"payPeriodStatus": "new",
"workerType": "W2"
},
{
"payPeriodId": "8EF7603A-8ECF-40E4-82E8-2C5FC5528D5F",
"payPeriod": "02/02/2026 - 02/09/2026",
"payPeriodType": "Off-Cycle",
"payBeginDate": "2026-02-02",
"payEndDate": "2026-02-09",
"payDate": "2026-04-01",
"deadLineToRunPayroll": "2026-03-30",
"payPeriodStatus": "new",
"workerType": "W2"
},
{
"payPeriodId": "CC4D8605-1FA4-4EB9-9E57-9EBEF1AFD703",
"payPeriod": "03/09/2026 - 03/23/2026",
"payPeriodType": "Off-Cycle",
"payBeginDate": "2026-03-09",
"payEndDate": "2026-03-23",
"payDate": "2026-04-01",
"deadLineToRunPayroll": "2026-03-30",
"payPeriodStatus": "new",
"workerType": "W2"
},
{
"payPeriodId": "7F52523F-EBF0-40BD-87D4-20E82AF5AD95",
"payPeriod": "02/02/2026 - 03/24/2026",
"payPeriodType": "Off-Cycle",
"payBeginDate": "2026-02-02",
"payEndDate": "2026-03-24",
"payDate": "2026-04-02",
"deadLineToRunPayroll": "2026-03-31",
"payPeriodStatus": "new",
"workerType": "W2"
},
{
"payPeriodId": "3BBB82F7-FDF0-4CAE-BF39-5611D8D6E304",
"payPeriod": "03/31/2026 - 03/31/2026",
"payPeriodType": "Missing",
"payBeginDate": "2026-03-31",
"payEndDate": "2026-03-31",
"payDate": "2026-04-03",
"deadLineToRunPayroll": "2026-04-01",
"payPeriodStatus": "new",
"workerType": "W2"
},
{
"payPeriodId": "329ED801-CE87-42F3-87AE-59AA65E007C6",
"payPeriod": "03/30/2026 - 03/30/2026",
"payPeriodType": "Missing",
"payBeginDate": "2026-03-30",
"payEndDate": "2026-03-30",
"payDate": "2026-04-03",
"deadLineToRunPayroll": "2026-04-01",
"payPeriodStatus": "new",
"workerType": "W2"
},
{
"payPeriodId": "DC815FD5-B8BA-4021-A51D-2DD2FF2971B4",
"payPeriod": "05/19/2026 - 05/25/2026",
"payPeriodType": "Missing",
"payBeginDate": "2026-05-19",
"payEndDate": "2026-05-25",
"payDate": "2026-05-20",
"deadLineToRunPayroll": "2026-05-18",
"payPeriodStatus": "new",
"workerType": "W2"
}
]
}{
"error": {
"code": 400,
"message": "Invalid WorkerType"
}
}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
