v1

latestOpenAPI 3.1.02026-07-22733584.5 KB

Payroll

Approve a payroll run (admin/approver only)

NOT available to API keys — requires an interactive admin/approver session. Approves a drafted payroll run for payment and reporting. API keys (even write-scoped ones) receive 403.

post/payroll/approve

Request body

customer_idstring

Target company. Optional for single-company sessions.

periodstring required

Payroll period, YYYY-MM.

run_idstring required

The drafted run to approve.

idempotency_keystring

Client-chosen key to deduplicate retries.

Response

Updated payroll workspace with the approved run.

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.