Create a payroll export

Módulo Crew

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.

Requiere la capacidad crew.payroll.export.
Alcances de OAuth: crew.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: PayrollExportCreate

payrollExports.create: PayrollExportCreate
Campo	Tipo	Obligatorio	Descripción
payroll_run_id	string (uuid)	Sí	Identifier of the payroll run.
provider	string	Sí	Target payroll provider.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

{
  "payroll_run_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "provider": "payroll_csv"
}

Respuesta 201: PayrollExport

payrollExports.create: PayrollExport
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the payroll export.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
payroll_run_id	string (uuid)	Sí	Identifier of the payroll run.
provider	string	Sí	Target payroll provider.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
file_uri	string	Sí	Logical location of the export file.Restricciones: length 1 to 1000
checksum_sha256	string	Sí	SHA-256 of the export file, lowercase hex.Restricciones: 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"
}

Ejemplos de código

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"}'