getProcessedPayperiodsDetails
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getProcessedPayperiodsDetails \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getProcessedPayperiodsDetails",
"companyId": "4934E42A-F448-4AF5-8273-850ECF17647C",
"workerType": "W2"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getProcessedPayperiodsDetails"
payload = {
"method": "getProcessedPayperiodsDetails",
"companyId": "4934E42A-F448-4AF5-8273-850ECF17647C",
"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: 'getProcessedPayperiodsDetails',
companyId: '4934E42A-F448-4AF5-8273-850ECF17647C',
workerType: 'W2'
})
};
fetch('https://sandbox.rollfi.xyz/reports/getProcessedPayperiodsDetails', 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/getProcessedPayperiodsDetails",
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' => 'getProcessedPayperiodsDetails',
'companyId' => '4934E42A-F448-4AF5-8273-850ECF17647C',
'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/getProcessedPayperiodsDetails"
payload := strings.NewReader("{\n \"method\": \"getProcessedPayperiodsDetails\",\n \"companyId\": \"4934E42A-F448-4AF5-8273-850ECF17647C\",\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/getProcessedPayperiodsDetails")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getProcessedPayperiodsDetails\",\n \"companyId\": \"4934E42A-F448-4AF5-8273-850ECF17647C\",\n \"workerType\": \"W2\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getProcessedPayperiodsDetails")
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\": \"getProcessedPayperiodsDetails\",\n \"companyId\": \"4934E42A-F448-4AF5-8273-850ECF17647C\",\n \"workerType\": \"W2\"\n}"
response = http.request(request)
puts response.read_body{
"processedPayPeriods": [
{
"payPeriodId": "5D23FFB1-A33D-453C-BBBA-15D3320B9D70",
"payPeriod": "06/11/2024 - 06/24/2024",
"payPeriodType": "Regular",
"payBeginDate": "2024-06-11",
"payEndDate": "2024-06-24",
"payDate": "2024-06-25",
"deadLineToRunPayroll": "2024-06-21",
"workerType": "W2"
}
]
}{
"error": {
"code": 400,
"message": "Invalid WorkerType"
}
}Reports
getProcessedPayperiodsDetails
The getProcessedPayPeriods API retrieves all pay periods that have been processed for a company.
What it does:
- Returns a list of completed pay periods with their associated IDs
- Provides date range, start date, end date, payroll deadline and workerType for each completed pay period
Note:
getPayPeriodDetailscan be used to retrieve more in-depth information for a completed pay period using the payPeriodIDs returned by this API
GET
/
reports
/
getProcessedPayperiodsDetails
getProcessedPayperiodsDetails
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getProcessedPayperiodsDetails \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getProcessedPayperiodsDetails",
"companyId": "4934E42A-F448-4AF5-8273-850ECF17647C",
"workerType": "W2"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getProcessedPayperiodsDetails"
payload = {
"method": "getProcessedPayperiodsDetails",
"companyId": "4934E42A-F448-4AF5-8273-850ECF17647C",
"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: 'getProcessedPayperiodsDetails',
companyId: '4934E42A-F448-4AF5-8273-850ECF17647C',
workerType: 'W2'
})
};
fetch('https://sandbox.rollfi.xyz/reports/getProcessedPayperiodsDetails', 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/getProcessedPayperiodsDetails",
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' => 'getProcessedPayperiodsDetails',
'companyId' => '4934E42A-F448-4AF5-8273-850ECF17647C',
'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/getProcessedPayperiodsDetails"
payload := strings.NewReader("{\n \"method\": \"getProcessedPayperiodsDetails\",\n \"companyId\": \"4934E42A-F448-4AF5-8273-850ECF17647C\",\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/getProcessedPayperiodsDetails")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getProcessedPayperiodsDetails\",\n \"companyId\": \"4934E42A-F448-4AF5-8273-850ECF17647C\",\n \"workerType\": \"W2\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getProcessedPayperiodsDetails")
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\": \"getProcessedPayperiodsDetails\",\n \"companyId\": \"4934E42A-F448-4AF5-8273-850ECF17647C\",\n \"workerType\": \"W2\"\n}"
response = http.request(request)
puts response.read_body{
"processedPayPeriods": [
{
"payPeriodId": "5D23FFB1-A33D-453C-BBBA-15D3320B9D70",
"payPeriod": "06/11/2024 - 06/24/2024",
"payPeriodType": "Regular",
"payBeginDate": "2024-06-11",
"payEndDate": "2024-06-24",
"payDate": "2024-06-25",
"deadLineToRunPayroll": "2024-06-21",
"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
