Create a payroll export
Crew module
POST/payroll-exportspayrollExports.create
A payroll export file for a payroll provider. Creates a payroll export. 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.payroll.export.
- 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: PayrollExportCreate
| Field | Type | Required | Description |
|---|---|---|---|
| payroll_run_id | string (uuid) | Yes | Identifier of the payroll run. |
| provider | string | Yes | Target payroll provider.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
{
"payroll_run_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"provider": "payroll_csv"
}Response 201: PayrollExport
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the payroll export. |
| 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. |
| payroll_run_id | string (uuid) | Yes | Identifier of the payroll run. |
| provider | string | Yes | Target payroll provider.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| file_uri | string | Yes | Logical location of the export file.Constraints: length 1 to 1000 |
| checksum_sha256 | string | Yes | SHA-256 of the export file, lowercase hex.Constraints: pattern ^[0-9a-f]{64}$ |
{
"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",
"payroll_run_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"provider": "payroll_csv",
"file_uri": "payroll-exports/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f.csv",
"checksum_sha256": "9f2c4e1a7b3d5f6e8a0c2e4f6a8b0d2c4e6f8a0b2c4d6e8f0a2b4c6d8e0f2a4b"
}Code samples
curl -X POST "$XOS_BASE_URL/payroll-exports" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"payroll_run_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","provider":"payroll_csv"}'const { data } = await xos.payrollExports.create({
"payroll_run_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"provider": "payroll_csv"
});response = xos.payroll_exports.create({"payroll_run_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "provider": "payroll_csv"})xos payroll-exports create --data '{"payroll_run_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","provider":"payroll_csv"}'