Vous êtes ici: Accueil » Documentation API Recouveo v19.02 (simplifié)

Différences

Ci-dessous, les différences entre deux révisions de la page.

--- api [2019/05/08 23:48]
rsiveo
+++ api [2021/08/23 14:18] (Version actuelle)
rsiveo
@@ Ligne 1: / Ligne 1: @@
-**Accès à l'API**
+<title>Documentation API Recouveo v19.02 (simplifié)</title>
 === Format général ===
-<code>POST https://<server-node>/API/<method-code></code>
+<code>POST https://<server-url>/API/<method-code></code>
   * les données sont transmises par tableau d'objets, encodé au format JSON
-  * les paramètres d'accès (code domaine, token) sont fournis par authentification HTTPS
+  * les paramètres d'accès (code domaine, token) sont transmis par authentification HTTPS
+Exemple authentification HTTPS
+<code>USER : prod@veo
+PASS : <token></code>
+Note : les informations d'accès (code domaine + token) seront fournies par RecouveoSI à la création du compte
 === Intégration de comptes acheteurs - Méthode ACCOUNT ===
-<code>POST https://<server-node>/API/account</code>
+<code>POST https://<server-url>/API/account</code>
 JSON Object keys :
@@ Ligne 19: / Ligne 23: @@
 <code>
 [{
-  "IdSoc": "FC",
+  "IdSoc": "VEO",
   "IdCli": "1234567890",
-  "NameCli": "Alain MARTIN"
+  "NameCli": "Alain MARTIN",
+  "Meta:PAYS": "BE",
+  "Meta:DIVISION": "005"
 },{
-  "IdSoc": "FC",
+  "IdSoc": "VEO",
   "IdCli": "9876543210",
-  "NameCli": "Martine DURAND"
+  "NameCli": "Martine DURAND",
+  "Meta:PAYS": "FR",
+  "Meta:DIVISION": "101"
 }]
 </code>
-POST [[https://<server-node|https://<server-node]]>/API/account_adrbookentry
+=== Intégration de comptes acheteurs - Méthode ACCOUNT_ADRBOOKENTRY ===
-  * Intégration des coordonnées d'un compte acheteur
+<code>POST https://<server-url>/API/account_adrbookentry</code>
-POST [[https://<server-node|https://<server-node]]>/API/record
+JSON Object keys :
+  * **IdSoc** : Code société / entité
+  * **IdCli** : Identification unique du tiers
+  * **AdrType** : Type d'enregistrement
+  * **Adr** : Adresse postale / Téléphone / Email
-  * Intégration de factures
+Exemple:
-POST [[https://<server-node|https://<server-node]]>/API/scenario
+<code>
+[{
+  "IdSoc": "VEO",
+  "IdCli": "9876543210",
+  "AdrType": "POSTAL",
+  "Adr": "1 rue de la Plumerette\n94000 Créteil"
+},{
+  "IdSoc": "VEO",
+  "IdCli": "9876543210",
+  "AdrType": "TEL",
+  "Adr": "0600000000"
+},{
+  "IdSoc": "VEO",
+  "IdCli": "9876543210",
+  "AdrType": "EMAIL",
+  "Adr": "martine.durand@email.com"
+}]
+</code>
-  * Intégration
-POST [[https://<server-node|https://<server-node]]>/API/assignement
-Tout les champs en gras sont des champs obligatoires.
+=== Intégration de comptes acheteurs - Méthode RECORD ===
-**POST [[https://<server-node|https://<server-node]]>/API/account - Format d'un enregistrement JSON:**
-  * **Société ou Code société → IdSoc**
-  * **Numéro client → IdCli**
-  * **Raison sociale → NameCli**
-  * SIRET –> SIRET
+<code>POST https://<server-url>/API/record</code>
+JSON Object keys :
+  * **IdSoc** : Code société / entité
+  * **IdCli** : Identification unique du tiers
+  * **IdRecord** : Clé primaire (unique) de la pièce
+  * **NumRecord** : Numéro facture / pièce comptable
+  * **LibRecord** : Libellé (optionnel)
+  * **DateRecord** : Date pièce
+  * **DateExpire** : Date échéance si différente de la date pièce
+  * **MontantTTC** : Montant TTC
+  * **Letter** : Code lettrage si lettré partiel ou soldé
+  * **LetterConfirm** : (Boolean) Lettrage soldé
+  * **LetterDate** : Date lettrage
+  * **XeCurrencyAmount** : Montant en devise
+  * **XeCurrencyCode** : Code devise
-**POST [[https://<server-node|https://<server-node]]>/API/account_adrbookentry - Format d'un enregistrement JSON**
-  * **Société ou code société → IdSoc**
-  * **Numéro client → IdCli**
-  * **Libellé → Lib**
-  * **Type d'adresse → AdrType**
-  * **Adresse → Adr**
-Types d'adresse valides: "EMAIL", "TEL" & "POSTAL" <WRAP center round important 60%> Pas de méta données pour l'adrbook </WRAP>
-Exemples:
+Exemple:
 <code>
 [{
-    "Adr": "9 rue de la Plumerette 94000 Créteil",
+    "IdSoc": "VEO",
-    "Lib": "11 BIS COMMUNICATIONS",
+    "IdCli": "9876543210",
-    "IdCli": "C11BISCOMMUNICAT",
+    "IdRecord": "10212",
-    "IdSoc": "TTV",
+    "NumRecord": "FAC12345",
-    "AdrType": "POSTAL"
+    "LibRecord": "Facture Mai 2018",
-  },
+    "MontantTTC": 903.30,
-  {
+    "DateRecord": "2018-06-05",
-    "Adr": "note faire le 8000 avant.",
+    "Meta:JOURNAL": "700",
-    "Lib": "INDEX  Multimédia",
+    "Meta:PROJET": "Webdesign SPHERE"
-    "IdCli": "C123",
+},{
-    "IdSoc": "Trace TV",
+    "IdSoc": "VEO",
-    "AdrType": "EMAIL"
+    "IdCli": "9876543210",
-  },
+    "IdRecord": "10399",
-  {
+    "NumRecord": "REGVIRT",
-    "Adr": "06XXXXXXXXXX",
+    "LibRecord": "Réglement par virement",
-    "Lib": "INDEX  Multimédia",
+    "MontantTTC": 250.00,
-    "IdCli": "C123",
+    "DateRecord": "2018-07-01",
-    "IdSoc": "TTV",
+    "Meta:JOURNAL": "501"
-    "AdrType": "TEL"
 }]
 </code>
-**POST [[https://<server-node|https://<server-node]]>/API/record - Format d'un enregistrement JSON**
-  * **ID Client –> IdCli**
-  * **Société ou code société → IdSoc**
-  * **ID Facture –> IdFact**
-  * **Date facture –> DateFact**
-  * **Montant TTC –> MontantTTC**
-  * Libellé –> LibFact
-  * Date de transmission –> DateTrans
-  * Date échéance –> DateLimite
-  * Numéro facture –> NumFact
-  * Journal
-  * Lettrage → Letter
-Exemples:
+=== Modification en masse - Méthode ACTION ===
-<code>
+<code>POST https://<server-url>/API/action</code>
-[{
-    "IdSoc": "TTV",
+JSON Object keys :
-    "IdCli": "C123MULTIMEDIA",
+  * **IdSoc** : Code société / entité
-    "IdFact": "050618_6290_FAC22727",
+  * **IdCli** : Identification unique du tiers
-    "MontantTTC": 103.300,
+  * **IdRecord** : (optionnel) Identification de la pièce
-    "DateFact": "2018-06-05 00:00:00"
+  * **ActionTxt** : Action/reprise - Commentaire de l'action
-  },
+  * **AccAffectation** : Chgmt - Affectation (CR)
-  {
+  * **StatusPrimary** : Chgmt - Statut du compte / pièce (ex: Action externe / Promesse)
+  * **StatusSub** : Chgmt - Sous-status (ex: Litige ADV / Réglement CB)
-    "IDSoc": "TTV",
+  * **ScenMode** : Chgmt - Mode scénario (ex: AUTO/STOP/FORCE/PAUSE)
-    "IdCli": "C123MULTIMEDIA",
+  * **ScenCode** : Chgmt - Changement scénario (ex: "Scénario 5")
-    "IdFact": "050618_6292_FAC22725",
-    "DateFact": "2018-06-05 00:00:00",
-    "MontantTTC": 112.070
-    "Journal": "VT",
-    "NumFact": "FAC22725",
-    "Letter": "C",
-  },
-  {
-    "IDSoc": "TTV",
+Notes :
-    "IdCli": "C123MULTIMEDIA",
+  * Ce format est également accessible par chargement CSV/Excel sous le libellé **Fiche navette : Modification en masse**.
-    "IdFact": "050618_6293_FAC22726",
+  * Les intitulés de colonnes reprendront les clés décrites ci-dessus.
-    "MontantTTC": 104.740,
-    "DateFact": "2018-06-05 00:00:00",
-    "Journal": "VT",
-    "NumFact": "FAC22726",
-    "Letter": "C",
-    "DateLimit": "2018-06-05 00:00:00",
-    "DateTrans": "2018-09-20 11:01:08",
-    "LibFact": "123 MULTIMEDIA FEVRIER 2018 Facture"
-  },
-  {
-    "LibFact": "VIRT 123",
-    "IDSoc": "TTV",
-    "IdCli": "C123MULTIMEDIA",
-    "IdFact": "070518_4689_",
-    "Journal": "BNP",
-    "NumFact": "",
-    "DateFact": "2018-05-07 00:00:00",
-    "Letter": "B",
-    "DateLimit": "2018-05-07 00:00:00",
-    "DateTrans": "2018-09-20 11:01:08",
-    "MontantTTC": -135.500,
-    "Meta:TTVF1": "XXX",
-    "Meta:TTVF2": "XXX,
-}]
-</code>