Comptes tiers et clients

Adresses

Création d'une adresse

POST /accounts/addresses/create

Headers

Name
Type
Description

Authorization*

Bearer <token>

Request Body

Name
Type
Description

args*

json

{"args": {"address1": "", "address2: "", "city": "", "country": "", "postal_code": ""}}

Récupération d'une adresse par identifiant

POST /accounts/getAdressById/<int:address_id>

Path Parameters

Name
Type
Description

address_id

integer

Identifiant de l'adresse

Headers

Name
Type
Description

Authorization*

Bearer <token>

Retour du web service
{
    "address1": "98 Avenue Pierre Semard",
    "address2": null,
    "city": "CARPENTRAS",
    "country": "FRANCE",
    "creation_date": "Fri, 28 Jul 2023 16:50:45 GMT",
    "id": 1,
    "postal_code": "84200"
}

Comptes tiers

Récupération des comptes tiers

GET /accounts/suppliers/list

Path Parameters

Name
Type
Description

limit

String

Nombres de résultats maximum à retourner

offset

String

Commencer à partir du Xème résultat

search

String

Filtrer fournisseur sur nom, email, SIRET, SIREN et numéro de TVA

order

String

Choix de la colonne utilisé pour l'ordre.

Headers

Name
Type
Description

Authorization*

Bearer <token>

Retour du web service
{
    "suppliers": [
        {
            "address_id": 23,
            "creation_date": "Fri, 24 Mar 2023 16:07:33 GMT",
            "document_lang": "fra",
            "email": null,
            "form_id": null,
            "get_only_raw_footer": false,
            "iban": null,
            "id": 15,
            "lang": "fra",
            "name": "Au bon moulin",
            "pages": {},
            "positions": {},
            "siren": "787878784",
            "siret": "78787878400035",
            "skip_auto_validate": false,
            "status": "OK",
            "total": 8,
            "vat_number": "FR11999999998"
        }
    ]
}

Récupération d'un compte tiers par identifiant

GET /accounts/suppliers/getById/<int:supplier_id>

Path Parameters

Name
Type
Description

supplier_id*

integer

Identifiant du compte fournisseur

Headers

Name
Type
Description

Authorization*

Bearer <token>

Retour du web service
{
    "address_id": 8,
    "creation_date": "Tue, 04 Apr 2023 14:59:52 GMT",
    "document_lang": "fra",
    "email": null,
    "form_id": null,
    "get_only_raw_footer": false,
    "iban": null,
    "id": 7,
    "lang": "fra",
    "name": "Au bon moulin",
    "pages": {},
    "positions": {},
    "siren": "787878784",
    "siret": "78787878400035",
    "skip_auto_validate": false,
    "status": "OK",
    "vat_number": "FR11999999998"
}

Création d'un compte tiers

POST /accounts/suppliers/create

Headers

Name
Type
Description

Authorization*

Bearer <token>

Request Body

Name
Type
Description

args*

json

{"args": {"get_only_raw_footer": false, "name": "", "vat_number": "", "siret": "", "siren": "", "iban": "", "email": "", "form_id": 0, "document_lang": "fra", "address_id": 0}}

Suppression d'un compte tiers

DELETE accounts/suppliers/delete/<int:supplier_id>

Path Parameters

Name
Type
Description

supplier_id*

integer

Identifiant du compte fournisseur

Comptes clients

Récupération des comptes clients

GET /accounts/customers/list

Path Parameters

Name
Type
Description

limit

String

Nombres de résultats maximum à retourner

offset

String

Commencer à partir du Xème résultat

search

String

Filtrer fournisseur sur nom, email, SIRET, SIREN et numéro de TVA

order

String

Choix de la colonne utilisé pour l'ordre.

module

verifier ou splitter

Headers

Name
Type
Description

Authorization*

Bearer <token>

Retour du web service
{
    "customers": [
        {
            "address_id": null,
            "company_number": null,
            "creation_date": "Mon, 09 Jan 2023 11:26:38 GMT",
            "id": 1,
            "module": "splitter",
            "name": "Splitter - Compte client par défaut",
            "siren": null,
            "siret": null,
            "status": "OK",
            "total": 2,
            "vat_number": null
        },
        {
            "address_id": 3,
            "company_number": null,
            "creation_date": "Wed, 22 Feb 2023 16:52:07 GMT",
            "id": 2,
            "module": "verifier",
            "name": "Edissyum Consulting",
            "siren": "510268261",
            "siret": "51026826100011",
            "status": "OK",
            "total": 2,
            "vat_number": "FR71510268261"
        }
    ]
}

Récupération d'un compte client par identifiant

GET /accounts/customers/getById/<int:custom_id>

Path Parameters

Name
Type
Description

customer_id*

integer

Identifiant du compte client

Headers

Name
Type
Description

Authorization*

Bearer <token>

Retour du web service
{
    "address_id": 3,
    "company_number": null,
    "creation_date": "Wed, 22 Feb 2023 16:52:07 GMT",
    "id": 2,
    "module": "verifier",
    "name": "Edissyum Consulting",
    "siren": "510268261",
    "siret": "51026826100011",
    "status": "OK",
    "vat_number": "FR71510268261"
}

Création d'un compte client

POST /accounts/customers/create

Headers

Name
Type
Description

Authorization*

Bearer <token>

Request Body

Name
Type
Description

args*

json

{"args": {"name": "", "vat_number": "", "siret": "", "siren": "", "company_number": "", "address_id": 0, "module": "verifier"}}

Suppression d'un compte client

DELETE accounts/customers/delete/<int:customer_id>

Path Parameters

Name
Type
Description

customer_id>*

integer

Identifiant du compte client

PreviousAuthentificationNextConfigurations

Last updated