Comptabilite.BanqueRib
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/banquerib |
Lister les enregistrements |
POST |
/v2/banquerib |
Créer l'enregistrement |
PUT |
/v2/banquerib |
Mettre à jour l'enregistrement |
DELETE |
/v2/banquerib |
Supprimer l'enregistrement |
GET |
/v2/banquerib/count |
Compter les enregistrements |
POST |
/v2/banquerib/count |
Compter les enregistrements |
POST |
/v2/banquerib/recherche |
Rechercher des enregistrements |
POST |
/v2/banquerib/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/banquerib
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/banquerib?sort=<sort>&where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/banquerib
Créer l'enregistrement.
Corps de la requête (application/json)
Schéma BanqueRibDto - 21 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/banquerib" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"idBanque": 0, "abregeBanque": "…", "abrege": "…"}'
PUT /v2/banquerib
Mettre à jour l'enregistrement.
Corps de la requête (application/json)
Schéma BanqueRibDto - 21 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/banquerib" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"idBanque": 0, "abregeBanque": "…", "abrege": "…"}'
DELETE /v2/banquerib
Supprimer l'enregistrement.
Corps de la requête (application/json)
Schéma BanqueRibDto - 21 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/banquerib" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"idBanque": 0, "abregeBanque": "…", "abrege": "…"}'
GET /v2/banquerib/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/banquerib/count?where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/banquerib/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/banquerib/count" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/banquerib/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/banquerib/recherche" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/banquerib/save
Créer ou mettre à jour l'enregistrement (upsert).
Corps de la requête (application/json)
Schéma BanqueRibDto - 21 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/banquerib/save" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"idBanque": 0, "abregeBanque": "…", "abrege": "…"}'
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.
BanqueRibDto
BanqueRibDto - 21 propriétés
| Propriété | Type | Notes |
|---|---|---|
idBanque |
integer (int32) |
Numéro interne de la banque parente (BQ_No). |
abregeBanque |
string |
nullable, Code abrégé de la banque parente (résolu, hors table - pour l'écriture). |
abrege |
string |
nullable, Abrégé du RIB (clé dans la banque, EB_Abrege). |
codeBanque |
string |
nullable, Code banque. |
guichet |
string |
nullable, Guichet. |
compte |
string |
nullable, Compte. |
cle |
string |
nullable, Clé RIB. |
commentaire |
string |
nullable, Commentaire. |
structure |
integer (int32) |
Structure de RIB (RibType : 0=Local/FR, 1=Autre, 2=BBAN, 3=IBAN). |
idDevise |
integer (int32) |
Identifiant devise (N_Devise). |
codeJournal |
string |
nullable, Code journal de trésorerie (JO_Num). |
bic |
string |
nullable, Code BIC / SWIFT. |
iban |
string |
nullable, Code IBAN. |
nomAgence |
string |
nullable, Nom de l'agence. |
adresse |
string |
nullable, Adresse de l'agence. |
complement |
string |
nullable, Complément d'adresse. |
codePostal |
string |
nullable, Code postal. |
ville |
string |
nullable, Ville. |
codeRegion |
string |
nullable, Code région de l'agence. |
pays |
string |
nullable, Pays. |
enSommeil |
boolean |
Mise en sommeil. |