Skip to content

Get All employee balances - add a specified date range

Request

Security
ApiKeyAuth
Query
fromstring, (date-time)required

Start date and time for the balance period

tostring, (date-time)required

End date and time for the balance period YYYY-MM-DD HH:MM:SS

pageinteger, >= 1

Page number (1-based).

Default:1
limitinteger, >= 1

Number of items per page.

Default:50
curl -i -X GET \
  'https://developer.boyahq.com/_mock/employee/employees/balances?from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z&page=1&limit=50' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successful response

Bodyapplication/json
openingEmployeeWalletsTotalnumber
closingEmployeeWalletsTotalnumber
employeesobject
Response
{
  "openingEmployeeWalletsTotal": 0,
  "closingEmployeeWalletsTotal": 0,
  "employees": {
    "docs": [ … ],
    "total": 0,
    "limit": "string",
    "page": "string",
    "pages": 0
  }
}