Skip to main content
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"
}
'
{
  "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
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://developer.rollfi.xyz/llms.txt

Use this file to discover all available pages before exploring further.

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
Example:

"getPayrollJournalReport"

payPeriodId
string<uuid>
required
companyId
string<uuid>
required

Response

200 - application/json
cashRequirementsReport
object
required