Comptabilite.Banque
En bref
8 opérations sur 4 chemins. Préfixe /v2. Authentification JWT (voir Démarrer).
Opérations
| Méthode | Chemin | Rôle |
|---|---|---|
GET |
/v2/banque |
Lister les enregistrements |
POST |
/v2/banque |
Créer l'enregistrement |
PUT |
/v2/banque |
Mettre à jour l'enregistrement |
DELETE |
/v2/banque |
Supprimer l'enregistrement |
GET |
/v2/banque/count |
Compter les enregistrements |
POST |
/v2/banque/count |
Compter les enregistrements |
POST |
/v2/banque/recherche |
Rechercher des enregistrements |
POST |
/v2/banque/save |
Créer ou mettre à jour l'enregistrement (upsert) |
Rôle déduit
La spécification ne porte ni summary ni description d'opération : la colonne Rôle est déduite mécaniquement de la méthode HTTP et du chemin.
Détail
GET /v2/banque
Lister les enregistrements.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
sort |
query | string |
non | - |
where |
query | string |
non | - |
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X GET "https://<votre-connecteur>/v2/banque?sort=<sort>&where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/banque
Créer l'enregistrement.
Corps de la requête (application/json)
Schéma BanqueDto - 25 propriétés (détail : Schémas).
Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X POST "https://<votre-connecteur>/v2/banque" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "abrege": "…", "intitule": "…"}'
PUT /v2/banque
Mettre à jour l'enregistrement.
Corps de la requête (application/json)
Schéma BanqueDto - 25 propriétés (détail : Schémas).
Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X PUT "https://<votre-connecteur>/v2/banque" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "abrege": "…", "intitule": "…"}'
DELETE /v2/banque
Supprimer l'enregistrement.
Corps de la requête (application/json)
Schéma BanqueDto - 25 propriétés (détail : Schémas).
Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X DELETE "https://<votre-connecteur>/v2/banque" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "abrege": "…", "intitule": "…"}'
GET /v2/banque/count
Compter les enregistrements.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
where |
query | string |
non | - |
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X GET "https://<votre-connecteur>/v2/banque/count?where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/banque/count
Compter les enregistrements.
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X POST "https://<votre-connecteur>/v2/banque/count" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/banque/recherche
Rechercher des enregistrements.
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X POST "https://<votre-connecteur>/v2/banque/recherche" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/banque/save
Créer ou mettre à jour l'enregistrement (upsert).
Corps de la requête (application/json)
Schéma BanqueDto - 25 propriétés (détail : Schémas).
Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X POST "https://<votre-connecteur>/v2/banque/save" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "abrege": "…", "intitule": "…"}'
Schémas
Schémas résolus à un niveau : les propriétés qui référencent un autre schéma sont citées par leur nom, sans être dépliées.
BanqueDto
BanqueDto - 25 propriétés
| Propriété | Type | Notes |
|---|---|---|
id |
integer (int32) |
Numéro interne (BQ_No). |
abrege |
string |
nullable, Code abrégé (clé). |
intitule |
string |
nullable, Intitulé. |
bic |
string |
nullable, Code BIC / SWIFT. |
codeIdentification |
string |
nullable, Code identifiant (ICS, etc.). |
contact |
string |
nullable, Contact. |
adresse |
string |
nullable, Adresse. |
complement |
string |
nullable, Complément d'adresse. |
codePostal |
string |
nullable, Code postal. |
ville |
string |
nullable, Ville. |
region |
string |
nullable, Code région. |
pays |
string |
nullable, Pays. |
telephone |
string |
nullable, Téléphone. |
telecopie |
string |
nullable, Télécopie. |
email |
string |
nullable, Email. |
site |
string |
nullable, Site web. |
formatVirement |
integer (int32) |
Format des virements (BQ_FormatVir - enum COM BanqueFormatVirement : 0=AFB, 1=SEPA, 2=320S). |
formatPrelevement |
integer (int32) |
Format des prélèvements (BQ_FormatPrel - BanqueFormatVirement). |
formatVirementInternational |
integer (int32) |
Format des virements internationaux (BQ_FormatVirInter - BanqueFormatVirement). |
modeRemise |
integer (int32) |
Mode de remise (BQ_ModeRemise - enum COM BanqueModeRemise : 0=Fichier, 1=Télétrans, 2=Papier, 3=Internet, 4=Messagerie). |
typeRemise |
integer (int32) |
Type de remise (BQ_Remise - enum COM BanqueRemise : mono/multi-devise × mono/multi-date, 0..3). |
modeleParametrage |
string |
nullable, Modèle de paramétrage bancaire (BQ_ModeleParam). |
teletransmissionEmail |
string |
nullable, Adresse e-mail d'envoi en télétransmission (BQ_TransEMailEnvoi). |
teletransmissionSite |
string |
nullable, Site de télétransmission (BQ_TransSite). |
codeServiceVirementInternational |
string |
nullable, Code service pour le virement international (BQ_VTCodeService). |