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
    }
  }
}

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
Garnishments in the electronicFundsTransferSummary are handled by Rollfi and are part of the debit amount. otherGarnishments are 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"
}
'

{
  "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

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

Show child attributes

getPayrollJournalReports Company