← Volver al índice de esquemas

BeneficiaryImportJobResponse

Respuesta de `GET /v1/beneficiaries/imports/{id}`. Devuelve la importación completo con su estado actual y los contadores por grupo. Sondea hasta `preview_ready` (para mostrar la vista previa), `committed`/`completed` (para finalizar la UI) o `failed`/`cancelled` (para terminar el flujo).

Propiedades

CampoTipoDescripción
dataobjectPayload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con `type`, `id`, `attributes`).
typestringTipo del recurso JSON:API (siempre `beneficiary_import`).
idstringIdentificador numérico del trabajo de importación (expresado como string).
attributesobjectCampos de la importación.
statusstringEstado del trabajo de importación — `pending`: Subido y 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`: Importación completada; `failed`: Fallo no recuperable (ver `error_code`); `cancelled`: Cancelado por el usuario.
file_formatstringFormato del archivo subido. Aceptados: `csv`, `xls`, `xlsx`, `txt` o `pdf`.
parse_modestringModo de parseo — `template`: Formato de columnas fijo (plantilla descargable); `free`: Formato libre, el sistema deduce la estructura.
total_rowsintegerTotal de filas extraídas del archivo (solo disponible una vez que el estado es `preview_ready` o posterior).
valid_countintegerConteo de filas sin errores, listas para confirmación de persistencia.
correctable_countintegerFilas con correcciones automáticas aplicadas. Se persisten salvo que el usuario las rechace.
fatal_countintegerFilas con errores no corregibles automáticamente. No se persisten y se omiten de la confirmación.
duplicate_countintegerSuma de filas `duplicate_account` y `duplicate_alias`. Las filas con `duplicate_account` se omiten de la confirmación salvo que la cuenta esté archivada (en cuyo caso se reactiva); las `duplicate_alias` se persisten con sufijo de alias.
committed_countintegerFilas efectivamente persistidas en la lista de beneficiarios (solo disponible una vez que el estado es `completed`).
skipped_countintegerFilas no persistidas (fatales o `duplicate_account` sin reactivación posible).
llm_invokedboolean`true` si el motor de IA (LLM) se utilizó durante el parseo para resolver filas ambiguas en modo libre.
error_codestring | nullCódigo estable del error cuando `status=failed` (p.ej. `file_corrupt`, `plan_cap_exceeded`). `null` en estados no fallidos.
error_summarystring | nullMensaje diagnóstico legible cuando `status=failed`. Los números de tarjeta (PANs) aparecen enmascarados en este campo.
created_atstring (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_atstring | nullTimestamp (ISO 8601 UTC) de finalización del parseo. `null` hasta que el parseo completa.
committed_atstring | nullTimestamp (ISO 8601 UTC) del inicio de la confirmación. `null` hasta que la confirmación comienza.
completed_atstring | nullTimestamp (ISO 8601 UTC) de finalización de la importación. `null` mientras la importación no ha completado.
metaobjectMetadatos de la respuesta, incluyendo versión de la API, prefijo de ruta, identificador único de la petición y marca temporal del servidor en UTC.
versionstringVersión de la API que procesó la petición.
api_versionstringVersión del prefijo de ruta de la API (ej. `v1`).
request_idstringIdentificador único de la petición (hex).
datetimeobjectDescriptor compañero presente en el bloque `meta` de cada respuesta (y en el `meta` del cuerpo de los webhooks salientes). Permite a los clientes afirmar el contrato de zona horaria sin releer el spec.
timezone*stringSiempre `UTC` — la zona canónica para cada campo datetime del cuerpo.
format*stringSiempre `ISO 8601` — sufijo `Z` explícito en cada datetime.
linksobjectEnlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada.

Usado en operaciones

  • GET /v1/beneficiaries/imports/{id}