How many distinct employees may still be paid this month across the licence pool. capacity is the PERSON + EMPLOYEE billing units the pool is invoiced for, used is the distinct staff already holding a live payslip for the month in ANY organisation sharing the pool, and unlimited=true means no licence owner could be resolved and no cap applies. Call this before the Generate Salaries popup so the user sees the remaining count instead of building a selection and having it rejected.
Headers
-
API token (can be retrieved from account settings)
-
ID of organization, for which the operation must be performed
GET
/api-v1/payroll/licence-capacity/{organizationId}/{calendarYear}/{monthType}
curl \
--request GET 'https://wyzio.app/api-v1/payroll/licence-capacity/{organizationId}/{calendarYear}/{monthType}'
Response examples (200)
{
"capacity": 42,
"staffWithPayslip": [
42
],
"poolOrganizationIds": [
42
],
"unlimited": true,
"remaining": 42,
"used": 42
}