v1
latestOpenAPI 3.1.02026-07-22733584.5 KBPayroll
Get the payroll workspace
NOT available to API keys — requires an interactive admin/approver session. Returns the payroll workspace for a period (YYYY-MM, default current): employees, employer settings, draft/approved runs. Amounts are integer cents; rates are basis points.
get/payroll
Query parameters
customer_idstring
Target company. Optional — API keys are pinned to one company, and single-company sessions default to it.
periodstring
Payroll period, YYYY-MM.
Response
Payroll workspace.
PayrollWorkspaceData required
The payroll workspace for a period: employees, employer settings, and runs. Amounts are integer cents; rates are basis points. Interior shapes beyond the top level vary and are returned as-is.