Fields

Fields to be extracted

Create field

POSThttps://api.koncile.ai/v1/create_field

Creates a field to extract

Request body

template_id Integer Required The id of the template inside which the field is created

name String Required The name of the field to create, unique

type String Required Defines whether the field is extracted once (General fields) or for every line (Line fields)

desc String Optional The description of the field to create

format String Optional The kind of field to extract, with their custom formatting. By default "text". For all the field formats, please refer to this page.

position Integer Optional The field position in the output, relative to the other fields. Default: appended to the end

Returns

The created field object

Curl

curl api.koncile.ai/v1/create_field/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{
    "template_id": integer,
    "name": "string",
    "type": "string"
  }'

Python

Node

Fetching field

GEThttps://api.koncile.ai/v1/fetch_field?field_id={field_id}

Fetches all the informations about a field, using the field_id

Path parameters

field_id Integer Required The id of the field to fetch

Returns

The field object

Curl

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

Python

Node

Update field

PUThttps://api.koncile.ai/v1/update_field?field_id={field_id} Updates a field, using the field_id

Path parameters

field_id Integer Required The id of the field to update

Request body

name String Optional The name of the field to create, unique

desc String Optional The description of the field to create

format String Optional The kind of field to extract, with their custom formatting. By default "text". For all the field formats, please refer to this page.

type String Optional Defines whether the field is extracted once (General fields) or for every line (Line fields)

position Integer Optional The field position in the output, relative to the other fields. Default: appended to the end

Returns

The field object

Curl

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

Python

Node

Delete field

DELETEhttps://api.koncile.ai/v1/delete_field?field_id={field_id} Deletes a field, using the field_id

Path parameters

field_id Integer Required The id of the field to update

Curl

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

Python

Node

Field Object

id Integer

name String The name of the field, unique

desc String The description of the field

format String The kind of field to extract, with their custom formatting. By default "text". For all the field formats, please refer to this page.

type String Defines whether the field is extracted once (General fields) or for every line (Line fields)

position Integer The field position in the output, relative to the other fields. Default: appended to the end

template_id Integer The id from the template the field is linked to

{
    "id": 100,
    "name": "Invoice Number",
    "type": "General fields",
    "desc": "The unique invoice identifier",
    "format": "text",
    "position": 1,
    "template_id": 10
}