Create a payroll run
Crew module
POST/payroll-runspayrollRuns.create
A payroll run. It cannot jump from Draft to Accepted. Creates a payroll run. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability crew.pay_period.manage.
- OAuth scopes: crew.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: PayrollRunCreate
| Field | Type | Required | Description |
|---|---|---|---|
| pay_period_id | string (uuid) | Yes | Identifier of the pay period. |
| currency_code | string | Yes | ISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$ |
{
"pay_period_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"currency_code": "USD"
}Response 201: PayrollRun
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the payroll run. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| pay_period_id | string (uuid) | Yes | Identifier of the pay period. |
| payroll_run_state | "Draft" | "Calculated" | "Approved" | "Exported" | "Accepted" | "Canceled" | Yes | Payroll run state. |
| currency_code | string | Yes | ISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$ |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"pay_period_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"payroll_run_state": "Draft",
"currency_code": "USD"
}Code samples
curl -X POST "$XOS_BASE_URL/payroll-runs" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"pay_period_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","currency_code":"USD"}'const { data } = await xos.payrollRuns.create({
"pay_period_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"currency_code": "USD"
});response = xos.payroll_runs.create({"pay_period_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "currency_code": "USD"})xos payroll-runs create --data '{"pay_period_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","currency_code":"USD"}'