Fields

Les Fields définissent les données à extraire des documents. Ils peuvent être de type "General fields" (extraits une seule fois par document) ou "Line fields" (extraits pour chaque ligne du document).

---

Créer un Field

POST https://api.koncile.ai/v1/create_field

Crée un nouveau Field dans un Template.

Paramètres de requête

template_id Integer Obligatoire L'identifiant du Template contenant le Field

Corps de la requête

name String Obligatoire Le nom du Field

type String Obligatoire Le type de Field : "General fields" ou "Line fields"

desc String Optionnel Une description du Field

format String Optionnel Le format attendu (ex: date, nombre, texte)

position Integer Optionnel La position du Field dans l'ordre d'affichage

Retourne

L'objet Field créé.

Curl

curl -X POST "https://api.koncile.ai/v1/create_field/?template_id=10" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{"name": "Numéro de facture", "type": "General fields", "desc": "Le numéro unique de la facture"}'

Python

NodeJS

---

Récupérer un Field

GET https://api.koncile.ai/v1/fetch_field

Récupère toutes les informations d'un Field en utilisant le field_id.

Paramètres de requête

field_id Integer Obligatoire L'identifiant du Field à récupérer

Retourne

L'objet Field.

Curl

curl "https://api.koncile.ai/v1/fetch_field?field_id=100" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY"

Python

NodeJS

---

Mettre à jour un Field

PUT https://api.koncile.ai/v1/update_field

Met à jour un Field en utilisant le field_id.

Paramètres de requête

field_id Integer Obligatoire L'identifiant du Field à modifier

Corps de la requête

name String Optionnel Le nouveau nom du Field

desc String Optionnel La nouvelle description

format String Optionnel Le nouveau format

type String Optionnel Le nouveau type : "General fields" ou "Line fields"

position Integer Optionnel La nouvelle position

Retourne

L'objet Field modifié.

Curl

curl -X PUT "https://api.koncile.ai/v1/update_field?field_id=100" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{"name": "Nouveau nom", "desc": "Nouvelle description"}'

Python

NodeJS

---

Supprimer un Field

DELETE https://api.koncile.ai/v1/delete_field

Supprime un Field en utilisant le field_id.

Paramètres de requête

field_id Integer Obligatoire L'identifiant du Field à supprimer

Retourne

Réponse vide en cas de succès.

Curl

curl -X DELETE "https://api.koncile.ai/v1/delete_field?field_id=100" \
  -H "Authorization: Bearer $API_KEY"

Python

NodeJS

---

Structure de l'objet Field

id Integer Identifiant unique du Field

name String Le nom du Field

type String Le type : "General fields" ou "Line fields"

desc String La description du Field

format String Le format attendu

position Integer La position dans l'ordre d'affichage

template_id Integer L'identifiant du Template parent

Exemple :

{
  "id": 100,
  "name": "Numéro de facture",
  "type": "General fields",
  "desc": "Le numéro unique de la facture",
  "format": "text",
  "position": 1,
  "template_id": 10
}