← Volver al índice de esquemas

ValidationImportJob

Envelope JSON:API de la importación masiva de validaciones. Lifecycle de estados: pending → parsing → preview_ready → committing → completed (o failed / cancelled).

ExtiendeJsonApiResourceBase

Propiedades

CampoTipoDescripción
typestringTipo de recurso JSON:API (siempre `validation_import`).
idstringID numérico de la importación como string (convención JSON:API).
attributesobjectAtributos de la importación.
statusstringEstado actual en el ciclo de vida: `pending` = recibido, en cola de parseo; `parsing` = extrayendo y validando filas; `preview_ready` = parseo completado, esperando revisión del usuario; `committing` = procesando filas aprobadas contra Banxico; `completed` = todas las filas procesadas; `failed` = error irrecuperable; `cancelled` = cancelado por el usuario.
upload_typestringTipo de archivo subido: `text` = archivo de texto (CSV, XLSX, TXT, JSON); `images` = ZIP con imágenes de comprobantes.
file_formatstringFormato del archivo subido (`csv`, `xls`, `xlsx`, `txt`, `json`, `zip_text` o `zip_images`).
parse_modestringModo de parseo: `template` = columnas en orden predefinido de la plantilla; `free` = detección automática de columnas con un modelo de IA como fallback.
total_rowsintegerTotal de filas detectadas en el archivo tras el parseo.
valid_countintegerFilas válidas en vista previa (datos completos listos para enviar a Banxico).
correctable_countintegerFilas corregibles en vista previa (uno o más campos faltantes o incorrectos que el usuario puede editar).
fatal_countintegerFilas fatales en vista previa (no procesables incluso después de editar, ej. clave de rastreo inválida).
duplicate_countintegerFilas duplicadas dentro del mismo lote (mismo clave_rastreo u otros campos clave repetidos).
dispatched_countintegerFilas despachadas al stream de validaciones tras la confirmación. Disponible solo en estados `committing` y `completed`.
completed_valid_countintegerFilas cuya validación Banxico CEP devolvió `valid`.
completed_not_found_countintegerFilas cuya validación Banxico CEP no encontró en sus registros.
completed_invalid_countintegerFilas rechazadas por Banxico por datos inválidos.
completed_cep_unavailable_countintegerFilas donde Banxico CEP no estaba disponible durante la validación.
completed_error_countintegerFilas con errores terminales no resolubles (red, captcha, preflight failure).
skipped_countintegerFilas omitidas del procesamiento (duplicados entre lotes o canceladas por el usuario).
ocr_invokedbooleantrue si el OCR de comprobantes fue invocado durante el parseo. Solo relevante cuando `upload_type = images`.
ocr_input_tokensintegerTokens de entrada consumidos por el modelo de IA en el OCR del lote. 0 si `ocr_invoked = false`.
ocr_output_tokensintegerTokens de salida generados por el modelo de IA en el OCR del lote. 0 si `ocr_invoked = false`.
error_codestring | nullCódigo de error si la importación terminó en estado `failed`. null en todos los demás estados.
error_summarystring | nullDescripción del error si la importación terminó en estado `failed`. null si la importación no falló.
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 | nullMarca temporal ISO 8601 en que el parseo fue completado. `null` si aún no se ha completado.
committed_atstring | nullMarca temporal ISO 8601 en que la confirmación fue completado. `null` si aún no se ha realizado.
completed_atstring | nullMarca temporal ISO 8601 en que todas las filas fueron procesadas. `null` si la importación no ha completado.

Usado en operaciones

  • GET /v1/validations/imports/{id}
  • GET /v1/validations/imports/{id}/preview