Returns the payroll totals for a period (start_date to end_date, default this month; end_date alone reads its own month): each posted pay run (approved or paid, not superseded, ending in the period) with its period_start, period_end, payment_date, status, kind, employee_count, gross, paye_income_tax, employee and employer social_insurance and gesy, and net; run_totals across every run (its employee_count counts a person once per run, as payslips, not distinct people); and for each payroll payable account its charged_to_date, settled_to_date and outstanding balance at the period end, read off the ledger, with unmapped_payables naming any account the company has not mapped (no balance is measured for it). Company totals only: no employee, payslip or per-person row is returned, though a run with one employee carries that employee's pay (hence the pay-bearing scope). Runs are paged, earliest first (runs ending on the same day by id), with page (at most 100000) and per_page (default 50, at most 200; truncated is true while more runs follow); the totals and payables cover every run. An end before the start is a 422; a period longer than 5 years (end_date on or after the same day 5 years after start_date) is a 422 payroll_summary_period_too_large on start_date. Read live on every request. Read only. Requires the employees:sensitive OAuth scope with view_payroll.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
