Skip to main content
POST
Draft 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.

customer_id
string

Target company. Optional for API keys.

payment_date
string

Intended payment date, YYYY-MM-DD.

idempotency_key
string

Client-chosen key to deduplicate retries.

Response

Updated payroll workspace including the draft run.

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.