Plantillas y Campos

Una Plantilla es una lista guardada y reutilizable de Campos que deseas extraer de un documento — un campo por columna de salida. Pasa el id de una Plantilla a Iniciar procesamiento de un lote en lugar de volver a listar tus campos en cada llamada. También puedes crear una Plantilla a partir de un preajuste integrado, u omitir las Plantillas por completo y pasar campos ad-hoc fields directamente a process para una ejecución única.

Listar plantillas

Devuelve tus plantillas guardadas, cada una con su lista de campos completa y ordenada incorporada.

Parámetros

Posibles errores

• missing_api_key / invalid_api_key / plan_required — consulta Manejo de errores.
• invalid_parameter — limit o page_token incorrectos.

Crear una plantilla

Dos formas de crear una plantilla en un solo endpoint: desde cero (opcionalmente clonando los campos de otra plantilla mediante base_template_id), o desde un preset incorporado mediante preset_id.

Parámetros

Posibles errores

• missing_api_key / invalid_api_key / plan_required — consulta Manejo de errores.
• missing_parameter (param: "name") — no hay name ni preset_id.
• invalid_parameter (param: "name") — ya existe una plantilla con ese nombre (solo en creación sin preset).
• invalid_parameter (param: "preset_id") — ID de preset desconocido.
• internal_error

Eliminar una plantilla

Elimina una plantilla y todos sus campos (en cascada, no se necesita una llamada de limpieza aparte). No afecta a los documentos que ya usaron esta plantilla en una llamada process anterior; sus resultados ya extraídos no se modifican.

Parámetros

Posibles errores

• missing_api_key / invalid_api_key / plan_required — consulte Manejo de errores.
• template_not_found
• internal_error

Listar preajustes

Listas de campos predefinidas para tipos de documentos comunes (facturas, recibos, estados de cuenta bancarios y más): pase el id de un preajuste como preset_id a Crear una plantilla para obtener una plantilla funcional sin tener que enumerar los campos manualmente. Los preajustes son configuración estática, no filas de base de datos; no hay forma de crear, editar o eliminar uno a través de la API.

Parámetros

Posibles errores

• missing_api_key / invalid_api_key / plan_required — consulta Manejo de errores.
• invalid_parameter — limit o page_token incorrectos.

Listar y crear campos

fields es el nombre público v1 de lo que la interfaz del producto llama "reglas de coincidencia": un campo por columna de salida, en el orden en que la extracción los emitirá. GET devuelve todos los campos de la plantilla, ya ordenados por sort_order. POST añade un nuevo campo al final.

Parámetros

Posibles errores

• missing_api_key / invalid_api_key / plan_required — consulta Manejo de errores.
• template_not_found
• missing_parameter (param: "name") — solo POST.
• duplicate_field_name — ya existe un campo con este name en esta plantilla.
• internal_error

Actualizar y eliminar un campo

PUT renombra un campo (y reemplaza su format_requirement) — es un reemplazo completo, no un parche parcial, así que incluye ambos valores aunque solo uno haya cambiado. DELETE lo elimina.

Parámetros

Posibles errores

• missing_api_key / invalid_api_key / plan_required — consulta Manejo de errores.
• template_not_found — la plantilla no existe o no es tuya, o (con un mensaje que lo indica) el field_id no pertenece a esta plantilla.
• missing_parameter (param: "name") — solo PUT.
• duplicate_field_name — solo PUT, al renombrar a un nombre que ya tiene otro campo en esta plantilla.
• internal_error

Reordenar campos

Define explícitamente el orden de los campos, que determina el orden de las columnas de salida en line_items y en exportaciones a Excel/Word. Los IDs de la lista que no pertenezcan a esta plantilla se ignoran silenciosamente, sin rechazar toda la solicitud.

Parámetros

Posibles errores

• missing_api_key / invalid_api_key / plan_required — consulta Manejo de errores.
• template_not_found
• invalid_parameter (param: "field_ids") — no es una lista de enteros.
• internal_error