Skip to main content
POST
Approve a payroll run

Authorizations

Authorization
string
header
required

Firebase ID token from an interactive portal session. Required for interactive operations (payroll, company settings, API-key management) and invoice decisions allowed by the member's review permissions.

Body

application/json
period
string
required

Payroll period, YYYY-MM.

run_id
string
required

The drafted run to approve.

customer_id
string

Target company. Optional for single-company sessions.

idempotency_key
string

Client-chosen key to deduplicate retries.

Response

Updated payroll workspace with the approved run.

The payroll workspace for a period: employees, employer settings, and runs. Amounts are integer cents; rates are basis points. Interior shapes beyond the documented payment evidence fields vary and are returned as-is.

known_people
object[]

The employee parties this company already reimburses, offered to the employee form so a new or existing payroll employee can be bound to the person they already are. Each entry carries the exact business.party reference — revision included — to send back as expected_party; a picker that showed one person cannot commit a link to whoever that id names by the time it is saved. Only the last four digits of a saved reimbursement account travel with this read, and only under the admin/approver payroll role this whole workspace already requires.

run
object | null