# Formulaires

## Récupération des formulaires

<mark style="color:blue;">`GET`</mark> `/forms/list`

#### Path Parameters

| Name     | Type    | Description                                                                             |
| -------- | ------- | --------------------------------------------------------------------------------------- |
| limit    | String  | Nombres de résultats maximum à retourner                                                |
| offset   | String  | Commencer à partir du Xème résultat                                                     |
| module   | String  | verifier ou splitter                                                                    |
| time     | String  | today, yesterday, older                                                                 |
| user\_id | String  | Permet de récuperer les formulaires associés à un utilisateur                           |
| totals   | Boolean | Permet la récupération du nombre total de formulaire (sans compter les limit et offset) |

#### Headers

| Name                                            | Type            | Description |
| ----------------------------------------------- | --------------- | ----------- |
| Authorization<mark style="color:red;">\*</mark> | Bearer \<token> |             |

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}
{% endtabs %}

<details>

<summary>Retour du web service</summary>

```json
{
    "forms": [
        {
            "default_form": true,
            "enabled": true,
            "id": 1,
            "label": "Formulaire par défaut",
            "labels": {},
            "module": "verifier",
            "outputs": [],
            "settings": {
                "allow_automatic_validation": false,
                "automatic_validation_data": "invoice_number",
                "delete_documents_after_outputs": false,
                "display": {
                    "subtitles": [
                        {
                            "id": "invoice_number",
                            "label": "FACTURATION.invoice_number"
                        },
                        {
                            "id": "document_date",
                            "label": "FACTURATION.document_date"
                        },
                        {
                            "id": "date",
                            "label": "VERIFIER.register_date"
                        },
                        {
                            "id": "original_filename",
                            "label": "VERIFIER.original_file"
                        },
                        {
                            "id": "form_label",
                            "label": "ACCOUNTS.form"
                        }
                    ]
                },
                "supplier_verif": true
            },
            "status": "OK",
            "total": 1
        }
    ]
}
```

</details>

## Récupération d'un formulaire par identifiant

<mark style="color:blue;">`GET`</mark> `/forms/getById/<int:form_id>`

#### Path Parameters

| Name                                       | Type    | Description               |
| ------------------------------------------ | ------- | ------------------------- |
| form\_id<mark style="color:red;">\*</mark> | integer | Identifiant du formulaire |

#### Headers

| Name                                            | Type            | Description |
| ----------------------------------------------- | --------------- | ----------- |
| Authorization<mark style="color:red;">\*</mark> | Bearer \<token> |             |

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}

{% tab title="400: Bad Request Formulaire inexistant" %}

{% endtab %}
{% endtabs %}

<details>

<summary>Retour du web service</summary>

```json
{
    "default_form": true,
    "enabled": true,
    "id": 1,
    "label": "Formulaire par défaut",
    "labels": {},
    "module": "verifier",
    "outputs": [],
    "settings": {
        "allow_automatic_validation": false,
        "automatic_validation_data": "invoice_number",
        "delete_documents_after_outputs": false,
        "display": {
            "subtitles": [
                {
                    "id": "invoice_number",
                    "label": "FACTURATION.invoice_number"
                },
                {
                    "id": "document_date",
                    "label": "FACTURATION.document_date"
                },
                {
                    "id": "date",
                    "label": "VERIFIER.register_date"
                },
                {
                    "id": "original_filename",
                    "label": "VERIFIER.original_file"
                },
                {
                    "id": "form_label",
                    "label": "ACCOUNTS.form"
                }
            ]
        },
        "supplier_verif": true
    },
    "status": "OK"
}
```

</details>

## Champs des formulaires

## Récupération de la liste des champs par identifiant de formulaire

<mark style="color:blue;">`GET`</mark> `/forms/fields/getByFormId/<int:form_id>`

#### Path Parameters

| Name                                       | Type    | Description               |
| ------------------------------------------ | ------- | ------------------------- |
| form\_id<mark style="color:red;">\*</mark> | integer | Identifiant du formulaire |

#### Headers

| Name                                            | Type            | Description |
| ----------------------------------------------- | --------------- | ----------- |
| Authorization<mark style="color:red;">\*</mark> | Bearer \<token> |             |

{% tabs %}
{% tab title="200: OK Retour ci-dessous" %}

{% endtab %}

{% tab title="400: Bad Request Formulaire inexistant ou aucun champs associés" %}

{% endtab %}
{% endtabs %}

<details>

<summary>Retour du web service</summary>

```json
{
    "fields": {
        "facturation": [
            {
                "autocomplete": "none",
                "autocomplete_data": [],
                "autocomplete_icon": "fa-solid fa-ban",
                "class": "w-1/2",
                "class_label": "1/2",
                "color": "red",
                "display": "simple",
                "display_icon": "fas fa-file-alt",
                "format": "alphanum_extended",
                "format_icon": "fas fa-level-up-alt",
                "id": "invoice_number",
                "label": "FACTURATION.invoice_number",
                "required": true,
                "required_icon": "fas fa-star",
                "type": "text",
                "unit": "facturation"
            },
            {
                "class": "w-1/2",
                "class_label": "1/2",
                "color": "orange",
                "display": "simple",
                "display_icon": "fa-solid fa-print",
                "format": "alphanum_extended",
                "format_icon": "fa-solid fa-hashtag",
                "id": "quotation_number",
                "label": "FACTURATION.quotation_number",
                "required": false,
                "required_icon": "fa-solid fa-star",
                "type": "text",
                "unit": "facturation"
            },
            {
                "autocomplete": "none",
                "autocomplete_data": [],
                "autocomplete_icon": "fa-solid fa-ban",
                "class": "w-1/3",
                "class_label": "1/33",
                "color": "orange",
                "display": "multi",
                "display_icon": "fas fa-layer-group",
                "format": "alphanum_extended",
                "format_icon": "fas fa-hashtag fa-level-up-alt",
                "id": "delivery_number",
                "label": "FACTURATION.delivery_number",
                "required": false,
                "required_icon": "far fa-star",
                "type": "text",
                "unit": "facturation"
            },
            {
                "autocomplete": "none",
                "autocomplete_data": [],
                "autocomplete_icon": "fa-solid fa-ban",
                "class": "w-1/3",
                "class_label": "1/33",
                "color": "aqua",
                "display": "simple",
                "display_icon": "fas fa-file-alt",
                "format": "date",
                "format_icon": "fas fa-calendar-day",
                "id": "document_date",
                "label": "FACTURATION.document_date",
                "required": true,
                "required_icon": "fas fa-star",
                "type": "date",
                "unit": "facturation"
            },
            {
                "autocomplete": "none",
                "autocomplete_data": [],
                "autocomplete_icon": "fa-solid fa-ban",
                "class": "w-1/3",
                "class_label": "1/33",
                "color": "blue",
                "display": "simple",
                "display_icon": "fas fa-file-alt",
                "format": "date",
                "format_icon": "fas fa-calendar-day",
                "id": "document_due_date",
                "label": "FACTURATION.document_due_date",
                "required": false,
                "required_icon": "far fa-star",
                "type": "date",
                "unit": "facturation"
            },
            {
                "autocomplete": "none",
                "autocomplete_data": [],
                "autocomplete_icon": "fa-solid fa-ban",
                "class": "w-1/3",
                "class_label": "1/33",
                "color": "pink",
                "display": "multi",
                "display_icon": "fas fa-layer-group",
                "format": "number_float",
                "format_icon": "fas fa-calculator",
                "id": "vat_rate",
                "label": "FACTURATION.vat_rate",
                "lineSelected": true,
                "required": true,
                "required_icon": "fas fa-star",
                "type": "text",
                "unit": "facturation"
            },
            {
                "autocomplete": "none",
                "autocomplete_data": [],
                "autocomplete_icon": "fa-solid fa-ban",
                "class": "w-1/3",
                "class_label": "1/33",
                "color": "fuchsia",
                "display": "multi",
                "display_icon": "fas fa-layer-group",
                "format": "number_float",
                "format_icon": "fas fa-calculator",
                "id": "no_rate_amount",
                "label": "FACTURATION.no_rate_amount",
                "lineSelected": true,
                "required": true,
                "required_icon": "fas fa-star",
                "type": "text",
                "unit": "facturation"
            },
            {
                "autocomplete": "none",
                "autocomplete_data": [],
                "autocomplete_icon": "fa-solid fa-ban",
                "class": "w-1/3",
                "class_label": "1/33",
                "color": "purple",
                "display": "multi",
                "display_icon": "fas fa-layer-group",
                "format": "number_float",
                "format_icon": "fas fa-calculator",
                "fullSize": true,
                "fullSizeSelected": true,
                "id": "vat_amount",
                "label": "FACTURATION.vat_amount",
                "lineSelected": true,
                "required": true,
                "required_icon": "fas fa-star",
                "type": "text",
                "unit": "facturation"
            },
            {
                "autocomplete": "none",
                "autocomplete_data": [],
                "autocomplete_icon": "fa-solid fa-ban",
                "class": "w-1/3",
                "class_label": "1/33",
                "color": "",
                "display": "simple",
                "display_icon": "fas fa-file-alt",
                "format": "number_float",
                "format_icon": "fas fa-calculator",
                "id": "total_vat",
                "label": "FACTURATION.total_vat",
                "required": true,
                "required_icon": "fas fa-star",
                "type": "text",
                "unit": "facturation"
            },
            {
                "autocomplete": "none",
                "autocomplete_data": [],
                "autocomplete_icon": "fa-solid fa-ban",
                "class": "w-1/3",
                "class_label": "1/33",
                "display": "simple",
                "display_icon": "fas fa-file-alt",
                "format": "number_float",
                "format_icon": "fas fa-calculator",
                "id": "total_ttc",
                "label": "FACTURATION.total_ttc",
                "required": true,
                "required_icon": "fas fa-star",
                "type": "text",
                "unit": "facturation"
            },
            {
                "autocomplete": "none",
                "autocomplete_data": [],
                "autocomplete_icon": "fa-solid fa-ban",
                "class": "w-1/3",
                "class_label": "1/33",
                "display": "simple",
                "display_icon": "fas fa-file-alt",
                "format": "number_float",
                "format_icon": "fas fa-calculator",
                "id": "total_ht",
                "label": "FACTURATION.total_ht",
                "required": true,
                "required_icon": "fas fa-star",
                "type": "text",
                "unit": "facturation"
            }
        ],
        "lines": [
            {
                "class": "w-1/4",
                "class_label": "1/4",
                "display": "simple",
                "display_icon": "fa-solid fa-file-alt",
                "format": "alphanum_extended_with_accent",
                "format_icon": "fa-solid fa-level-up-alt",
                "id": "description",
                "label": "FACTURATION.description",
                "lineSelected": true,
                "required": false,
                "required_icon": "far fa-star",
                "type": "text",
                "unit": "lines"
            },
            {
                "class": "w-1/4",
                "class_label": "1/4",
                "display": "simple",
                "display_icon": "fa-solid fa-file-alt",
                "format": "number_float",
                "format_icon": "fa-solid fa-calculator",
                "id": "quantity",
                "label": "FACTURATION.quantity",
                "lineSelected": true,
                "required": false,
                "required_icon": "far fa-star",
                "type": "text",
                "unit": "lines"
            },
            {
                "class": "w-1/4",
                "class_label": "1/4",
                "display": "simple",
                "display_icon": "fa-solid fa-file-alt",
                "format": "number_float",
                "format_icon": "fa-solid fa-calculator",
                "id": "unit_price",
                "label": "FACTURATION.unit_price",
                "lineSelected": true,
                "required": false,
                "required_icon": "far fa-star",
                "type": "text",
                "unit": "lines"
            },
            {
                "class": "w-1/4",
                "class_label": "1/4",
                "display": "simple",
                "display_icon": "fa-solid fa-file-alt",
                "format": "number_float",
                "format_icon": "fa-solid fa-calculator",
                "fullSize": true,
                "fullSizeSelected": true,
                "id": "line_ht",
                "label": "FACTURATION.no_rate_amount",
                "lineSelected": true,
                "required": false,
                "required_icon": "far fa-star",
                "type": "text",
                "unit": "lines"
            }
        ],
        "other": [],
        "supplier": [
            {
                "class": "w-full",
                "class_label": "1",
                "color": "white",
                "display": "simple",
                "display_icon": "fa-solid fa-file-alt",
                "format": "alphanum",
                "format_icon": "fa-solid fa-hashtag",
                "id": "name",
                "label": "ACCOUNTS.supplier_name",
                "required": true,
                "required_icon": "fa-solid fa-star",
                "type": "text",
                "unit": "supplier"
            },
            {
                "autocomplete": "none",
                "autocomplete_data": [],
                "autocomplete_icon": "fa-solid fa-ban",
                "class": "w-1/2",
                "class_label": "1/2",
                "display": "simple",
                "display_icon": "fas fa-file-alt",
                "format": "alphanum_extended_with_accent",
                "format_icon": "fas fas fa-hashtag",
                "id": "address1",
                "label": "ADDRESSES.address_1",
                "required": true,
                "required_icon": "fas fa-star",
                "type": "text",
                "unit": "addresses"
            },
            {
                "autocomplete": "none",
                "autocomplete_data": [],
                "autocomplete_icon": "fa-solid fa-ban",
                "class": "w-1/2",
                "class_label": "1/2",
                "display": "simple",
                "display_icon": "fas fa-file-alt",
                "format": "alphanum_extended_with_accent",
                "format_icon": "fas fas fa-hashtag",
                "id": "address2",
                "label": "ADDRESSES.address_2",
                "required": false,
                "required_icon": "far fa-star",
                "type": "text",
                "unit": "addresses"
            },
            {
                "autocomplete": "none",
                "autocomplete_data": [],
                "autocomplete_icon": "fa-solid fa-ban",
                "class": "w-1/3",
                "class_label": "1/33",
                "display": "simple",
                "display_icon": "fas fa-file-alt",
                "format": "number_int",
                "format_icon": "fas fa-calculator",
                "id": "postal_code",
                "label": "ADDRESSES.postal_code",
                "required": true,
                "required_icon": "fas fa-star",
                "type": "text",
                "unit": "addresses"
            },
            {
                "autocomplete": "none",
                "autocomplete_data": [],
                "autocomplete_icon": "fa-solid fa-ban",
                "class": "w-1/3",
                "class_label": "1/33",
                "display": "simple",
                "display_icon": "fas fa-file-alt",
                "format": "alphanum_extended_with_accent",
                "format_icon": "fas fa-font",
                "id": "city",
                "label": "ADDRESSES.city",
                "required": true,
                "required_icon": "fas fa-star",
                "type": "text",
                "unit": "addresses"
            },
            {
                "autocomplete": "none",
                "autocomplete_data": [],
                "autocomplete_icon": "fa-solid fa-ban",
                "class": "w-1/3",
                "class_label": "1/33",
                "display": "simple",
                "display_icon": "fas fa-file-alt",
                "format": "alphanum_extended_with_accent",
                "format_icon": "fas fa-font",
                "id": "country",
                "label": "ADDRESSES.country",
                "required": true,
                "required_icon": "fas fa-star",
                "type": "text",
                "unit": "addresses"
            },
            {
                "class": "w-1/3",
                "class_label": "1/33",
                "color": "olive",
                "display": "simple",
                "display_icon": "fas fa-file-alt",
                "format": "alphanum",
                "format_icon": "fas fas fa-hashtag",
                "id": "vat_number",
                "label": "ACCOUNTS.vat_number",
                "required": true,
                "required_icon": "fas fa-star",
                "type": "text",
                "unit": "supplier"
            },
            {
                "class": "w-1/6",
                "class_label": "1/6",
                "color": "lime",
                "display": "simple",
                "display_icon": "fas fa-file-alt",
                "format": "number_int",
                "format_icon": "fas fa-calculator",
                "id": "siren",
                "label": "ACCOUNTS.siren",
                "required": false,
                "required_icon": "far fa-star",
                "type": "text",
                "unit": "supplier"
            },
            {
                "class": "w-1/6",
                "class_label": "1/6",
                "color": "green",
                "display": "simple",
                "display_icon": "fas fa-file-alt",
                "format": "number_int",
                "format_icon": "fas fa-calculator",
                "id": "siret",
                "label": "ACCOUNTS.siret",
                "required": false,
                "required_icon": "far fa-star",
                "type": "text",
                "unit": "supplier"
            },
            {
                "autocomplete": "none",
                "autocomplete_data": [],
                "autocomplete_icon": "fa-solid fa-ban",
                "class": "w-1/3",
                "class_label": "1/33",
                "color": "green",
                "display": "simple",
                "display_icon": "fa-solid file-alt",
                "format": "email",
                "format_icon": "fa-solid fa-at",
                "id": "email",
                "label": "FORMATS.email",
                "required": false,
                "required_icon": "far fa-star",
                "type": "text",
                "unit": "supplier"
            },
            {
                "class": "w-1/3",
                "class_label": "1/33",
                "color": "green",
                "display": "simple",
                "display_icon": "fa-solid fa-file-alt",
                "format": "alphanum",
                "format_icon": "fa-solid fa-hashtag",
                "id": "iban",
                "label": "ACCOUNTS.iban",
                "required": false,
                "required_icon": "far fa-star",
                "type": "text",
                "unit": "supplier"
            }
        ]
    },
    "form_id": 1,
    "id": 1
}
```

</details>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://edissyum.gitbook.io/open-capture/technique/web-services/formulaires.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.