Skip to navigation

Get Pay In Monthly Totals

Posted pay-in totals for a company, one entry per month and currency, read from a stored aggregate. Backs the Payroll Expenses graph, which needs one number per month and not the pay-ins themselves.

Sits on its own path rather than under /pay-ins so it cannot be matched as a payInId. Months are inclusive and formatted YYYY-MM in UTC. A month with no posted pay-ins is absent from the response rather than returned as zero.

Authentication

X-Thera-API-Keystring
API Key authentication via header

Path parameters

companyIdstringRequired

Query parameters

startMonthstringRequired

First month to include, inclusive, YYYY-MM.

endMonthstringRequired

Last month to include, inclusive, YYYY-MM.

Response

This endpoint returns an object.
totalslist of objects