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": "5E603770-184B-4AB3-B220-0733F2719542",
      "payPeriod": "02/07/2025 - 03/20/2025",
      "payPeriodType": "Missing",
      "payBeginDate": "2025-02-07",
      "payEndDate": "2025-03-20",
      "payDate": "2025-02-27",
      "deadLineToRunPayroll": "2025-02-25",
      "workerType": "W2"
    },
    {
      "payPeriodId": "4FA59BD4-98CE-4E03-A46F-F5CAA9DB0E3D",
      "payPeriod": "05/28/2025 - 06/03/2025",
      "payPeriodType": "Regular",
      "payBeginDate": "2025-05-28",
      "payEndDate": "2025-06-03",
      "payDate": "2025-06-04",
      "deadLineToRunPayroll": "2025-06-02",
      "workerType": "W2"
    },
    {
      "payPeriodId": "436547C5-5815-4663-B994-F817D3980AB0",
      "payPeriod": "07/23/2025 - 07/29/2025",
      "payPeriodType": "Regular",
      "payBeginDate": "2025-07-23",
      "payEndDate": "2025-07-29",
      "payDate": "2025-08-01",
      "deadLineToRunPayroll": "2025-07-30",
      "workerType": "W2"
    },
    {
      "payPeriodId": "8A19FBA9-8323-473F-8293-BF1BD7C92721",
      "payPeriod": "07/23/2025 - 07/29/2025",
      "payPeriodType": "Regular",
      "payBeginDate": "2025-07-23",
      "payEndDate": "2025-07-29",
      "payDate": "2025-08-01",
      "deadLineToRunPayroll": "2025-07-30",
      "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": "5E603770-184B-4AB3-B220-0733F2719542",
      "payPeriod": "02/07/2025 - 03/20/2025",
      "payPeriodType": "Missing",
      "payBeginDate": "2025-02-07",
      "payEndDate": "2025-03-20",
      "payDate": "2025-02-27",
      "deadLineToRunPayroll": "2025-02-25",
      "workerType": "W2"
    },
    {
      "payPeriodId": "4FA59BD4-98CE-4E03-A46F-F5CAA9DB0E3D",
      "payPeriod": "05/28/2025 - 06/03/2025",
      "payPeriodType": "Regular",
      "payBeginDate": "2025-05-28",
      "payEndDate": "2025-06-03",
      "payDate": "2025-06-04",
      "deadLineToRunPayroll": "2025-06-02",
      "workerType": "W2"
    },
    {
      "payPeriodId": "436547C5-5815-4663-B994-F817D3980AB0",
      "payPeriod": "07/23/2025 - 07/29/2025",
      "payPeriodType": "Regular",
      "payBeginDate": "2025-07-23",
      "payEndDate": "2025-07-29",
      "payDate": "2025-08-01",
      "deadLineToRunPayroll": "2025-07-30",
      "workerType": "W2"
    },
    {
      "payPeriodId": "8A19FBA9-8323-473F-8293-BF1BD7C92721",
      "payPeriod": "07/23/2025 - 07/29/2025",
      "payPeriodType": "Regular",
      "payBeginDate": "2025-07-23",
      "payEndDate": "2025-07-29",
      "payDate": "2025-08-01",
      "deadLineToRunPayroll": "2025-07-30",
      "workerType": "W2"
    }
  ]
}

{
  "error": {
    "code": 400,
    "message": "Invalid WorkerType"
  }
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

method

string

required

companyId

string

required

workerType

string

Response

unprocessedPayPeriods

object[]

required

Show child attributes