← Volver al índice de esquemas
BeneficiaryImportJobResponse
Respuesta de `GET /v1/beneficiaries/imports/{id}`. Devuelve el job completo con su estado actual y los contadores por bucket. Sondea hasta `preview_ready` (para mostrar el preview), `committed`/`completed` (para finalizar la UI) o `failed`/`cancelled` (para terminar el flujo).
Propiedades
| Campo | Tipo | Descripción |
|---|---|---|
type | string | Tipo del recurso JSON:API (siempre `beneficiary_import`). |
id | string | ID numérico del job expresado como string (formato JSON:API). |
attributes | object | Campos del job de importación. |
status | string | Estado del job: `pending` — subido, en espera de parseo; `parsing` — en proceso de extracción de filas; `preview_ready` — listo para revisión del usuario; `committing` — persistiendo filas confirmadas; `completed` — commit finalizado; `failed` — fallo no recuperable (ver `error_code`); `cancelled` — cancelado por el usuario. |
file_format | string | Formato del archivo subido. Aceptados: CSV, Excel (xls/xlsx), texto plano y PDF. |
parse_mode | string | Modo de parseo: `template` — formato de columnas fijo (plantilla descargable desde `/v1/beneficiaries/imports/template`); `free` — formato libre, el sistema deduce la estructura. |
total_rows | integer | Total de filas extraídas del archivo. Disponible una vez que el estado es `preview_ready` o posterior. |
valid_count | integer | Filas sin errores, listas para commit directo. |
correctable_count | integer | Filas con correcciones automáticas aplicadas (p.ej. alias auto-asignado). Se persisten salvo que el usuario las rechace. |
fatal_count | integer | Filas con errores no corregibles automáticamente. No se persisten y se omiten del commit. |
duplicate_count | integer | Suma de filas `duplicate_account` y `duplicate_alias`. Las `duplicate_account` se omiten del commit salvo que la cuenta esté archivada (en cuyo caso se reactiva); las `duplicate_alias` se persisten con sufijo de alias. |
committed_count | integer | Filas efectivamente persistidas en la lista de beneficiarios. Disponible una vez que el estado es `completed`. |
skipped_count | integer | Filas no persistidas (fatales o `duplicate_account` sin reactivación posible). |
llm_invoked | boolean | `true` si el motor de IA se utilizó durante el parseo para resolver filas ambiguas en modo libre. |
error_code | string | null | Código estable del error cuando `status=failed` (p.ej. `file_corrupt`, `plan_cap_exceeded`). `null` en estados no fallidos. |
error_summary | string | null | Mensaje diagnóstico legible cuando `status=failed`. Los números de tarjeta (PANs) aparecen enmascarados en este campo. |
created_at | string (date-time) | Timestamp ISO 8601 en UTC con sufijo `Z` explícito. Ejemplo: `"2026-05-01T05:14:38Z"`. Cada campo `*_at`, `*_end`, `*_start`, `*_date` de la API usa esta forma. El descriptor compañero en `meta.datetime` permite afirmar el contrato en tiempo de ejecución sin volver a leer este spec. El `new Date(value)` nativo del navegador, el `datetime.fromisoformat` (≥3.11) de Python y el `time.Parse(time.RFC3339)` de Go parsean este formato directamente. |
parsed_at | string | null | Timestamp (ISO 8601 UTC) de finalización del parseo. `null` hasta que el parseo completa. |
committed_at | string | null | Timestamp (ISO 8601 UTC) del inicio del commit. `null` hasta que el commit comienza. |
completed_at | string | null | Timestamp (ISO 8601 UTC) de finalización del job. `null` mientras el job no ha completado. |
Variantes
allOf
-
SuccessEnvelope -
object
Usado en operaciones
GET /v1/beneficiaries/imports/{id}