getCashRequirementsReport
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getCashRequirementsReport \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getCashRequirementsReport",
"payPeriodId": "5465C126-BACD-4593-97CE-24243FFFC998",
"companyId": "C3C91397-CDBA-44E0-A296-0BFC9A4DFDF5"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getCashRequirementsReport"
payload = {
"method": "getCashRequirementsReport",
"payPeriodId": "5465C126-BACD-4593-97CE-24243FFFC998",
"companyId": "C3C91397-CDBA-44E0-A296-0BFC9A4DFDF5"
}
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: 'getCashRequirementsReport',
payPeriodId: '5465C126-BACD-4593-97CE-24243FFFC998',
companyId: 'C3C91397-CDBA-44E0-A296-0BFC9A4DFDF5'
})
};
fetch('https://sandbox.rollfi.xyz/reports/getCashRequirementsReport', 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/getCashRequirementsReport",
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' => 'getCashRequirementsReport',
'payPeriodId' => '5465C126-BACD-4593-97CE-24243FFFC998',
'companyId' => 'C3C91397-CDBA-44E0-A296-0BFC9A4DFDF5'
]),
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/getCashRequirementsReport"
payload := strings.NewReader("{\n \"method\": \"getCashRequirementsReport\",\n \"payPeriodId\": \"5465C126-BACD-4593-97CE-24243FFFC998\",\n \"companyId\": \"C3C91397-CDBA-44E0-A296-0BFC9A4DFDF5\"\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/getCashRequirementsReport")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getCashRequirementsReport\",\n \"payPeriodId\": \"5465C126-BACD-4593-97CE-24243FFFC998\",\n \"companyId\": \"C3C91397-CDBA-44E0-A296-0BFC9A4DFDF5\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getCashRequirementsReport")
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\": \"getCashRequirementsReport\",\n \"payPeriodId\": \"5465C126-BACD-4593-97CE-24243FFFC998\",\n \"companyId\": \"C3C91397-CDBA-44E0-A296-0BFC9A4DFDF5\"\n}"
response = http.request(request)
puts response.read_body{
"cashRequirementsReport": {
"company": "test150UsersV2",
"payBeginDate": "2026-05-01",
"payEndDate": "2026-05-31",
"payDate": "2026-05-29",
"payPeriodStatus": "new",
"payPeriodDisplay": "Pay Period: 05/01/2026 - 05/31/2026 - DRAFT: NOT SUBMITTED",
"cashRequirementSummary": {
"totalElectronicFundsTransfer": 469781.41,
"cashRequiredForCheckPayments": 0,
"remainingDeductionsLiabilitiesAndWithholdings": 620,
"totalCashRequired": 470401.41
},
"electronicFundsTransferSummary": {
"totalDirectDeposits": 331132.86,
"totalEmployeeTaxes": 104517.99,
"totalEmployerTaxes": 34130.56,
"garnishments": 0,
"totalEft": 469781.41
},
"checkPaymentSummary": {
"employees": [
{
"employee": "Danielle Edwards",
"amount": 0
}
],
"totalCheckPayments": 0
},
"remainingDeductionsAndLiabilities": {
"totalBenefitsDeductionsAndContributions": 620,
"otherGarnishments": 0,
"totalRemainingDeductionsAndLiabilities": 620
}
}
}Reports
getCashRequirementsReport
The getCashRequirementsReport API generates cash requirements including payroll account debits and other payroll liabilities settled outside of the Rollfi system
What it does:
- Returns the total that will be pulled from the employer’s account
- Returns total cash required for check payments
- Includes cash required for remaining liabilites handled outside of Rollfi including benefits contribuitons
Notes:
- Used to confirm the business has the required funds to run the payroll and cover other liabilites
- Provides a breakdown of the employee and employer taxes included in the total debit amount
- Check employees are included in the cash requirement report even if their totals are $0
Garnishmentsin the electronicFundsTransferSummary are handled by Rollfi and are part of the debit amount.otherGarnishmentsare settled by the employer
GET
/
reports
/
getCashRequirementsReport
getCashRequirementsReport
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getCashRequirementsReport \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getCashRequirementsReport",
"payPeriodId": "5465C126-BACD-4593-97CE-24243FFFC998",
"companyId": "C3C91397-CDBA-44E0-A296-0BFC9A4DFDF5"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getCashRequirementsReport"
payload = {
"method": "getCashRequirementsReport",
"payPeriodId": "5465C126-BACD-4593-97CE-24243FFFC998",
"companyId": "C3C91397-CDBA-44E0-A296-0BFC9A4DFDF5"
}
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: 'getCashRequirementsReport',
payPeriodId: '5465C126-BACD-4593-97CE-24243FFFC998',
companyId: 'C3C91397-CDBA-44E0-A296-0BFC9A4DFDF5'
})
};
fetch('https://sandbox.rollfi.xyz/reports/getCashRequirementsReport', 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/getCashRequirementsReport",
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' => 'getCashRequirementsReport',
'payPeriodId' => '5465C126-BACD-4593-97CE-24243FFFC998',
'companyId' => 'C3C91397-CDBA-44E0-A296-0BFC9A4DFDF5'
]),
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/getCashRequirementsReport"
payload := strings.NewReader("{\n \"method\": \"getCashRequirementsReport\",\n \"payPeriodId\": \"5465C126-BACD-4593-97CE-24243FFFC998\",\n \"companyId\": \"C3C91397-CDBA-44E0-A296-0BFC9A4DFDF5\"\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/getCashRequirementsReport")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getCashRequirementsReport\",\n \"payPeriodId\": \"5465C126-BACD-4593-97CE-24243FFFC998\",\n \"companyId\": \"C3C91397-CDBA-44E0-A296-0BFC9A4DFDF5\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getCashRequirementsReport")
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\": \"getCashRequirementsReport\",\n \"payPeriodId\": \"5465C126-BACD-4593-97CE-24243FFFC998\",\n \"companyId\": \"C3C91397-CDBA-44E0-A296-0BFC9A4DFDF5\"\n}"
response = http.request(request)
puts response.read_body{
"cashRequirementsReport": {
"company": "test150UsersV2",
"payBeginDate": "2026-05-01",
"payEndDate": "2026-05-31",
"payDate": "2026-05-29",
"payPeriodStatus": "new",
"payPeriodDisplay": "Pay Period: 05/01/2026 - 05/31/2026 - DRAFT: NOT SUBMITTED",
"cashRequirementSummary": {
"totalElectronicFundsTransfer": 469781.41,
"cashRequiredForCheckPayments": 0,
"remainingDeductionsLiabilitiesAndWithholdings": 620,
"totalCashRequired": 470401.41
},
"electronicFundsTransferSummary": {
"totalDirectDeposits": 331132.86,
"totalEmployeeTaxes": 104517.99,
"totalEmployerTaxes": 34130.56,
"garnishments": 0,
"totalEft": 469781.41
},
"checkPaymentSummary": {
"employees": [
{
"employee": "Danielle Edwards",
"amount": 0
}
],
"totalCheckPayments": 0
},
"remainingDeductionsAndLiabilities": {
"totalBenefitsDeductionsAndContributions": 620,
"otherGarnishments": 0,
"totalRemainingDeductionsAndLiabilities": 620
}
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
Response
200 - application/json
Show child attributes
Show child attributes
⌘I
