v1

latestOpenAPI 3.1.02026-07-22733584.5 KB

Payroll

Draft a payroll run

NOT available to API keys — requires an interactive admin/approver session. Computes a draft payroll run for the period from current employees, tax cards, and employer settings. Drafting does not pay anyone — a separate approval is required. Pass idempotency_key to make retries safe.

post/payroll/draft

Request body

customer_idstring

Target company. Optional for API keys.

periodstring required

Payroll period, YYYY-MM.

payment_datestring

Intended payment date, YYYY-MM-DD.

idempotency_keystring

Client-chosen key to deduplicate retries.

Response

Updated payroll workspace including the draft 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.