getPaidEmployeesCountBasedOnDateRange

The getPaidEmployeesCountBasedOnDateRange API returns the total count of employees who received payment within a specified date range.

What it does:

• Returns the number of employees paid during a specific time period

GET /reports#getPaidEmployeesCountBasedOnDateRange

getPaidEmployeesCountBasedOnDateRange

cURL

curl --request GET \
  --url 'https://sandbox.rollfi.xyz/reports#getPaidEmployeesCountBasedOnDateRange' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "getPaidEmployeesCountBasedOnDateRange",
  "companyId": "A7FC17FF-B50E-4A89-97DC-D900F3327D8E",
  "startDate": "2024-01-01",
  "endDate": "2024-04-20"
}
'

200

[
  {
    "filterStartDate": "2024-01-01",
    "filterEndDate": "2024-04-20",
    "companies": [
      {
        "company": " WonderHub Inc",
        "companyId": "A7FC17FF-B50E-4A89-97DC-D900F3327D8E",
        "paidEmployeesDistinctCount": 1,
        "payPeriods": [
          {
            "payPeriod": "02/26/2024 - 03/10/2024",
            "payDate": "2024-02-26",
            "paidEmployeesCount": 1,
            "employees": [
              {
                "employee": "David  Martin",
                "employeeId": "149B7B64-25AE-4AFB-8032-3BEC18B1B656"
              }
            ]
          },
          {
            "payPeriod": "03/11/2024 - 03/24/2024",
            "payDate": "2024-03-11",
            "paidEmployeesCount": 1,
            "employees": [
              {
                "employee": "David  Martin",
                "employeeId": "149B7B64-25AE-4AFB-8032-3BEC18B1B656"
              }
            ]
          },
          {
            "payPeriod": "03/25/2024 - 04/07/2024",
            "payDate": "2024-03-25",
            "paidEmployeesCount": 1,
            "employees": [
              {
                "employee": "David  Martin",
                "employeeId": "149B7B64-25AE-4AFB-8032-3BEC18B1B656"
              }
            ]
          },
          {
            "payPeriod": "04/08/2024 - 04/21/2024",
            "payDate": "2024-04-08",
            "paidEmployeesCount": 1,
            "employees": [
              {
                "employee": "David  Martin",
                "employeeId": "149B7B64-25AE-4AFB-8032-3BEC18B1B656"
              }
            ]
          }
        ]
      }
    ]
  }
]

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 · default: getPaidEmployeesCountBasedOnDateRange · required

Example:

"getPaidEmployeesCountBasedOnDateRange"

startDate · string · required

endDate · string · required

companyId · string · required

Response

200 - application/json

filterStartDate · string

filterEndDate · string

companies · object[]

Show child attributes