Documentation Veostack

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

Différences

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

Lien vers cette vue comparative

Les deux révisions précédentes Révision précédente
Prochaine révision 		Révision précédente
api [2019/05/09 00:08]
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 === === 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 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 Exemple authentification HTTPS
 <code>USER : prod@veo <code>USER : prod@veo
-PASS : xxxxxxxxxxxxxxx</code>+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 === === 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 : JSON Object keys :
Ligne 22: Ligne 23:
 <code> <code>
 [{ [{
-  "IdSoc": "FC",+  "IdSoc": "VEO",
   "IdCli": "1234567890",   "IdCli": "1234567890",
-  "NameCli": "Alain MARTIN"+  "NameCli": "Alain MARTIN", 
 +  "Meta:PAYS": "BE", 
 +  "Meta:DIVISION": "005"
 },{ },{
-  "IdSoc": "FC",+  "IdSoc": "VEO",
   "IdCli": "9876543210",   "IdCli": "9876543210",
-  "NameCli": "Martine DURAND"+  "NameCli": "Martine DURAND", 
 +  "Meta:PAYS": "FR", 
 +  "Meta:DIVISION": "101"
 }] }]
 </code> </code>
Ligne 34: Ligne 39:
 === Intégration de comptes acheteurs - Méthode ACCOUNT_ADRBOOKENTRY === === Intégration de comptes acheteurs - Méthode ACCOUNT_ADRBOOKENTRY ===
  
-<code>POST https://<server-node>/API/account_adrbookentry</code>+<code>POST https://<server-url>/API/account_adrbookentry</code>
  
 JSON Object keys : JSON Object keys :
Ligne 46: Ligne 51:
 <code> <code>
 [{ [{
-  "IdSoc": "FC",+  "IdSoc": "VEO",
   "IdCli": "9876543210",   "IdCli": "9876543210",
   "AdrType": "POSTAL",   "AdrType": "POSTAL",
-  "Adr": "1 rue de la Plumerette 94000 Créteil"+  "Adr": "1 rue de la Plumerette\n94000 Créteil"
 },{ },{
-  "IdSoc": "FC",+  "IdSoc": "VEO",
   "IdCli": "9876543210",   "IdCli": "9876543210",
   "AdrType": "TEL",   "AdrType": "TEL",
   "Adr": "0600000000"   "Adr": "0600000000"
 },{ },{
-  "IdSoc": "FC",+  "IdSoc": "VEO",
   "IdCli": "9876543210",   "IdCli": "9876543210",
   "AdrType": "EMAIL",   "AdrType": "EMAIL",
Ligne 67: Ligne 72:
 === Intégration de comptes acheteurs - Méthode RECORD === === Intégration de comptes acheteurs - Méthode RECORD ===
  
-<code>POST https://<server-node>/API/record</code>+<code>POST https://<server-url>/API/record</code>
  
 JSON Object keys : JSON Object keys :
   * **IdSoc** : Code société / entité   * **IdSoc** : Code société / entité
   * **IdCli** : Identification unique du tiers   * **IdCli** : Identification unique du tiers
-  * **Adr** : Adresse postale / Téléphone / Email +  * **IdRecord** : Clé primaire (unique) de la pièce 
-  * **Adr** : Adresse postale / Téléphone / Email +  * **NumRecord** : Numéro facture / pièce comptable 
-  * **Adr** : Adresse postale / Téléphone / Email +  * **LibRecord** : Libellé (optionnel) 
-  * **Adr** : Adresse postale / Téléphone / Email +  * **DateRecord** : Date pièce 
-  * **Adr** : Adresse postale / Téléphone / Email +  * **DateExpire** : Date échéance si différente de la date pièce 
-  * **Adr** : Adresse postale / Téléphone / Email +  * **MontantTTC** : Montant TTC 
-  * **Adr** : Adresse postale / Téléphone / Email +  * **Letter** : Code lettrage si lettré partiel ou soldé 
-  * **Adr** : Adresse postale / Téléphone / Email +  * **LetterConfirm** : (Boolean) Lettrage soldé 
-  * **Adr** : Adresse postale / Téléphone / Email +  * **LetterDate** : Date lettrage 
-  * **Adr** : Adresse postale / Téléphone / Email +  * **XeCurrencyAmount** : Montant en devise 
-  * **Adr** : Adresse postale / Téléphone / Email +  * **XeCurrencyCode** : Code devise
-  * **Adr** : Adresse postale / Téléphone / Email +
-  * **Adr** : Adresse postale / Téléphone / Email+
  
  
- +Exemple:
- +
- +
- +
- +
-POST [[https://<server-node|https://<server-node]]>/API/account_adrbookentry +
- +
-  * Intégration des coordonnées d'un compte acheteur +
- +
-POST [[https://<server-node|https://<server-node]]>/API/record +
- +
-  * Intégration de factures +
- +
- +
- +
-**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: +
 <code> <code>
 [{ [{
 +    "IdSoc": "VEO",
 +    "IdCli": "9876543210",
 +    "IdRecord": "10212",
 +    "NumRecord": "FAC12345",
 +    "LibRecord": "Facture Mai 2018",
 +    "MontantTTC": 903.30,
 +    "DateRecord": "2018-06-05",
 +    "Meta:JOURNAL": "700",
 +    "Meta:PROJET": "Webdesign SPHERE"
 +},{
 +    "IdSoc": "VEO",
 +    "IdCli": "9876543210",
 +    "IdRecord": "10399",
 +    "NumRecord": "REGVIRT",
 +    "LibRecord": "Réglement par virement",
 +    "MontantTTC": 250.00,
 +    "DateRecord": "2018-07-01",
 +    "Meta:JOURNAL": "501"
 +}]
 +</code>
  
-    "IdSoc": "TTV", 
-    "IdCli": "C123MULTIMEDIA", 
-    "IdFact": "050618_6290_FAC22727", 
-    "MontantTTC": 103.300, 
-    "DateFact": "2018-06-05 00:00:00" 
-  }, 
-  { 
  
-    "IDSoc": "TTV", +=== Modification en masse - Méthode ACTION ===
-    "IdCli": "C123MULTIMEDIA", +
-    "IdFact": "050618_6292_FAC22725", +
-    "DateFact": "2018-06-05 00:00:00", +
-    "MontantTTC": 112.070 +
-    "Journal": "VT", +
-    "NumFact": "FAC22725", +
-    "Letter": "C", +
-  }, +
-  {+
  
-    "IDSoc": "TTV", +<code>POST https://<server-url>/API/action</code>
-    "IdCli": "C123MULTIMEDIA", +
-    "IdFact": "050618_6293_FAC22726", +
-    "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"+
  
-  }, +JSON Object keys : 
-  { +  * **IdSoc** : Code société / entité 
-    "LibFact": "VIRT 123", +  * **IdCli** : Identification unique du tiers 
-    "IDSoc": "TTV", +  * **IdRecord** : (optionnel) Identification de la pièce 
-    "IdCli": "C123MULTIMEDIA", +  * **ActionTxt** : Action/reprise - Commentaire de l'action 
-    "IdFact": "070518_4689_", +  * **AccAffectation** : Chgmt - Affectation (CR) 
-    "Journal": "BNP", +  * **StatusPrimary** : Chgmt - Statut du compte / pièce (ex: Action externe / Promesse) 
-    "NumFact": "", +  * **StatusSub** : Chgmt - Sous-status (ex: Litige ADV / Réglement CB) 
-    "DateFact": "2018-05-07 00:00:00", +  * **ScenMode** : Chgmt - Mode scénario (ex: AUTO/STOP/FORCE/PAUSE) 
-    "Letter": "B", +  * **ScenCode** : Chgmt - Changement scénario (ex: "Scénario 5") 
-    "DateLimit": "2018-05-07 00:00:00", + 
-    "DateTrans": "2018-09-20 11:01:08", +Notes : 
-    "MontantTTC": -135.500, +  * Ce format est également accessible par chargement CSV/Excel sous le libellé **Fiche navette : Modification en masse**. 
-    "Meta:TTVF1": "XXX", +  * Les intitulés de colonnes reprendront les clés décrites ci-dessus.
-    "Meta:TTVF2": "XXX, +
-}] +
-</code>+