← Volver al índice de esquemas
ValidationImportJob
Recurso JSON:API de un trabajo de importación masiva y su estado de ejecución.
ExtiendeJsonApiResourceBase
Propiedades
| Campo | Tipo | Descripción |
|---|---|---|
type | string | Tipo de recurso JSON:API. Siempre `validation_import`. |
id | string | Identificador numérico del trabajo de importación, expresado como cadena. |
attributes | object | Datos del trabajo de importación. |
status | string | Estado actual — `pending`: Recibido y pendiente de lectura; `parsing`: Extrayendo y validando filas; `preview_ready`: Lectura terminada y pendiente de revisión; `committing`: Procesando las filas aprobadas; `completed`: Todas las filas procesadas; `failed`: Error irrecuperable; `cancelled`: Trabajo cancelado por el usuario. |
upload_type | string | Modalidad de entrada: `text` para datos estructurados o libres; `images` para imágenes de comprobantes. |
file_format | string | Formato del archivo subido (`csv`, `xls`, `xlsx`, `txt`, `json`, `zip_text` o `zip_images`). |
parse_mode | string | Modo de lectura del archivo — `template`: Respeta los encabezados canónicos; `free`: Formato libre, el sistema deduce la estructura. |
total_rows | integer | Cantidad de filas extraídas del archivo. |
plan_cap | object | Tope de carga masiva del plan (`bulk_validations_max`, por lote) comparado contra `total_rows`, para avisar en la vista previa antes de que la confirmación rechace el lote de verdad con `422` `plan_cap_exceeded`. |
max | integer | Tope de filas por lote del plan activo. |
exceeded | boolean | `true` cuando `total_rows` ya excede `max`. |
valid_count | integer | Cantidad de filas sin errores, listas para la confirmación. |
correctable_count | integer | Cantidad de filas con errores que admiten corrección. |
fatal_count | integer | Cantidad de filas que no pueden procesarse con sus datos actuales. |
duplicate_count | integer | Cantidad de filas detectadas como duplicadas dentro del trabajo. |
dispatched_count | integer | Cantidad de filas enviadas a validación tras confirmar el trabajo. |
completed_valid_count | integer | Cantidad de filas cuya validación terminó en `valid`. |
completed_not_found_count | integer | Cantidad de filas cuya validación terminó en `not_found`. |
completed_invalid_count | integer | Cantidad de filas cuya validación terminó en `invalid`. |
completed_cep_unavailable_count | integer | Cantidad de filas cuya validación terminó en `cep_unavailable`. |
completed_returned_count | integer | Cantidad de filas cuya validación terminó en `returned` (la operación se liquidó y después se devolvió). |
completed_error_count | integer | Cantidad de filas cuya validación terminó en `error` o `failed`. |
skipped_count | integer | Cantidad de filas omitidas durante la ejecución del trabajo. |
ocr_invoked | boolean | `true` cuando se utilizó OCR durante la lectura. Solo es relevante cuando `upload_type` es `images`. |
ocr_input_tokens | integer | Tokens de entrada acumulados por el OCR del trabajo. Es `0` si `ocr_invoked` es `false`. |
ocr_output_tokens | integer | Tokens de salida acumulados por el OCR del trabajo. Es `0` si `ocr_invoked` es `false`. |
error_code | string | null | Código estable del fallo del trabajo. `null` cuando no terminó en `failed`. |
error_summary | string | null | Resumen legible del fallo del trabajo. `null` cuando no terminó en `failed`. |
created_at | string (date-time) | Timestamp ISO 8601 en UTC con sufijo `Z` explícito; por ejemplo, `"2026-05-01T05:14:38Z"`. Los campos `*_at`, `*_end`, `*_start` y `*_date` adoptan esta forma. `meta.datetime` describe el mismo contrato en la respuesta. |
parsed_at | string | null | Fecha y hora del fin de la lectura del archivo, en ISO 8601 UTC. `null` mientras no haya terminado. |
committed_at | string | null | Fecha y hora del inicio de la confirmación, en ISO 8601 UTC. `null` mientras no se haya confirmado. |
completed_at | string | null | Fecha y hora de la finalización, en ISO 8601 UTC. `null` mientras no haya terminado. |
Usado en operaciones
GET /v1/validations/imports/{id}GET /v1/validations/imports/{id}/preview