Documentation API Recouveo v19.02 (simplifié)

<title>Documentation API Recouveo v19.02 (simplifié)</title>

=== Format général ===
<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 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-url>/API/account</code>

JSON Object keys :
  * **IdSoc** : Code société / entité
  * **IdCli** : Identification unique du tiers
  * **NameCli** : Raison sociale du tiers //ou// Nom-Prénom du débiteur

Exemple:

<code>
[{
  "IdSoc": "VEO",
  "IdCli": "1234567890",
  "NameCli": "Alain MARTIN",
  "Meta:PAYS": "BE",
  "Meta:DIVISION": "005"
},{
  "IdSoc": "VEO",
  "IdCli": "9876543210",
  "NameCli": "Martine DURAND",
  "Meta:PAYS": "FR",
  "Meta:DIVISION": "101"
}]
</code>

=== Intégration de comptes acheteurs - Méthode ACCOUNT_ADRBOOKENTRY ===

<code>POST https://<server-url>/API/account_adrbookentry</code>

JSON Object keys :
  * **IdSoc** : Code société / entité
  * **IdCli** : Identification unique du tiers
  * **AdrType** : Type d'enregistrement
  * **Adr** : Adresse postale / Téléphone / Email

Exemple:

<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 de comptes acheteurs - Méthode RECORD ===

<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


Exemple:
<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>


=== Modification en masse - Méthode ACTION ===

<code>POST https://<server-url>/API/action</code>

JSON Object keys :
  * **IdSoc** : Code société / entité
  * **IdCli** : Identification unique du tiers
  * **IdRecord** : (optionnel) Identification de la pièce
  * **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)
  * **ScenMode** : Chgmt - Mode scénario (ex: AUTO/STOP/FORCE/PAUSE)
  * **ScenCode** : Chgmt - Changement scénario (ex: "Scénario 5")

Notes :
  * Ce format est également accessible par chargement CSV/Excel sous le libellé **Fiche navette : Modification en masse**.
  * Les intitulés de colonnes reprendront les clés décrites ci-dessus.