API ReferencePayroll

Salary Paid

Returns total salary paid per employee for the given month. Requires an active Payroll Pro entitlement.

Authentication

AuthorizationApi-Key

Format: “Api-Key {api-key}”

Query parameters

monthstringRequiredformat: "^\d{4}-(0[1-9]|1[0-2])$"

Month (YYYY-MM).

salarybox_idslist of stringsOptional
Repeatable. Filters to specific employees.
pageintegerOptional
Page number to fetch. Defaults to 1.
page_sizeintegerOptional

Number of results per page (max 500). Defaults to 25.

Response

datalist of objects
messagestring
statusboolean
countinteger
prevstring or null
nextstring or null