This partner's usage record for a month; written nightly for the current and previous month
employeesPaid counts distinct employees in pay runs published in the month;
payrunsLodged counts lodgements handed to the channel, payrunsAccepted those the ATO
accepted (informational); activeEmployers the delegations active at the record's time.
404 until the nightly has written the month. Reads with status:read (implicit for an active partner): no new scope.
Query Parameters
- Type: stringmonthrequired
Responses
- application/json
- application/json
- application/json
- application/json
Request Example for get/usage
curl 'https://sandbox.payroo.com.au/api/v1/embedded/usage?month=' \
--header 'x-api-key: YOUR_SECRET_TOKEN'
{
"partnerId": "string",
"month": "string",
"activeEmployers": 0,
"employeesPaid": 0,
"payrunsLodged": 0,
"payrunsAccepted": 0,
"computedAt": "2026-11-13T16:16:18.148Z"
}