Templates & Champs

Un Template est une liste sauvegardée et réutilisable de Champs à extraire d'un document — un champ par colonne de sortie. Passez l'id d'un Template à Lancer le traitement d'un lot au lieu de lister vos champs à chaque appel. Vous pouvez aussi créer un Template à partir d'un modèle prédéfini intégré, ou ignorer les Templates et passer des fields ad-hoc directement à process pour une exécution unique.

Lister les templates

Renvoie vos templates sauvegardés, chacun avec sa liste de champs complète et ordonnée.

Paramètres

Erreurs possibles

• missing_api_key / invalid_api_key / plan_required — voir Gestion des erreurs.
• invalid_parameter — limit ou page_token invalide.

Créer un modèle

Deux façons de créer un modèle en un seul endpoint : à partir de zéro (en clonant éventuellement les champs d'un autre modèle via base_template_id), ou à partir d'un préréglage intégré via preset_id. Les comptes sont limités à 30 modèles — supprimez un modèle existant avant d'en créer un autre une fois la limite atteinte.

Paramètres

Erreurs possibles

• missing_api_key / invalid_api_key / plan_required — voir Gestion des erreurs.
• missing_parameter (param: "name") — ni name ni preset_id fournis.
• invalid_parameter (param: "name") — un modèle portant ce nom existe déjà (uniquement pour le chemin de création sans préréglage).
• invalid_parameter (param: "preset_id") — ID de préréglage inconnu.
• template_limit_reached — la limite de 30 modèles est déjà atteinte pour ce compte.
• internal_error

Mettre à jour les paramètres du modèle

Définit l'exigence de format globale d'un modèle (appliquée en plus de celle de chaque champ) et sa configuration Fusion multi-pages — si plusieurs pages téléchargées appartenant au même enregistrement logique (un bail multi-pages, un lot de reçus agrafés) doivent être regroupées en une seule ligne de sortie au lieu de rester une ligne par page. Une fois activée ici, la fusion est appliquée automatiquement partout où ce modèle est utilisé, à la fois pour le traitement et les résultats — voir ?merge=true sur Obtenir les résultats du lot et Exporter un lot (qui l'applique toujours, sans option à activer). Chaque champ du corps de la requête ci-dessous est facultatif ; seules les clés que vous envoyez sont mises à jour, tout le reste est laissé tel quel (il n'y a pas d'état de brouillon/aperçu séparé à confirmer — cet appel prend effet immédiatement, comme la boîte de dialogue Paramètres du modèle de l'application web).

Paramètres

Erreurs possibles

• missing_api_key / invalid_api_key / plan_required — voir Gestion des erreurs.
• template_not_found
• invalid_parameter — mauvais merge_mode / merge_trigger_type / merge_fixed_count / merge_conflict_policy / merge_conflict_separator.
• internal_error

Supprimer un modèle

Supprime un modèle et tous ses champs (en cascade — aucun appel de nettoyage séparé n'est nécessaire). Cela n'affecte pas les documents qui ont déjà utilisé ce modèle lors d'un appel process antérieur ; leurs résultats déjà extraits restent inchangés.

Paramètres

Erreurs possibles

• missing_api_key / invalid_api_key / plan_required — voir Gestion des erreurs.
• template_not_found
• internal_error

Lister les préréglages

Listes de champs intégrées pour les types de documents courants (factures, reçus, relevés bancaires, etc.) — transmettez l'id d'un préréglage comme preset_id à Créer un modèle pour obtenir un modèle fonctionnel sans lister les champs manuellement. Les préréglages sont une configuration statique, pas des lignes de base de données — il n'y a aucun moyen d'en créer, d'en modifier ou d'en supprimer via l'API.

Paramètres

Erreurs possibles

• missing_api_key / invalid_api_key / plan_required — voir Gestion des erreurs.
• invalid_parameter — limit ou page_token invalide.

Lister et créer des champs

fields est le nom public v1 de ce que l'interface produit appelle « règles de correspondance » — un champ par colonne de sortie, dans l'ordre où l'extraction les émettra. GET renvoie chaque champ du modèle, déjà trié par sort_order. POST ajoute un nouveau champ à la fin.

Paramètres

Erreurs possibles

• missing_api_key / invalid_api_key / plan_required — voir Gestion des erreurs.
• template_not_found
• missing_parameter (param: "name") — POST uniquement.
• duplicate_field_name — un champ avec ce name existe déjà sur ce modèle.
• internal_error

Mettre à jour et supprimer un champ

PUT renomme un champ (et remplace son format_requirement) — c'est un remplacement complet, pas une mise à jour partielle, donc incluez les deux valeurs même si une seule a changé. DELETE le supprime.

Paramètres

Erreurs possibles

• missing_api_key / invalid_api_key / plan_required — voir Gestion des erreurs.
• template_not_found — le modèle n'existe pas/n'est pas le vôtre, ou (avec un message le précisant) le field_id n'est pas sur ce modèle.
• missing_parameter (param: "name") — PUT uniquement.
• duplicate_field_name — PUT uniquement, renommage vers un nom qu'un autre champ de ce modèle possède déjà.
• internal_error

Réorganiser les champs

Définit explicitement l'ordre des champs, qui détermine l'ordre des colonnes de sortie dans line_items et dans les exports Excel/Word. Les ID de la liste qui n'appartiennent pas à ce modèle sont ignorés silencieusement plutôt que de rejeter toute la requête.

Paramètres

Erreurs possibles

• missing_api_key / invalid_api_key / plan_required — voir Gestion des erreurs.
• template_not_found
• invalid_parameter (param: "field_ids") — pas une liste d'entiers.
• internal_error