Documentation Veostack

Documentation API Recouveo v19.02 (simplifié)

Ceci est une ancienne révision du document !


Accès à l'API

Format général

POST https://<server-node>/API/<method-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

Exemple authentification HTTPS

USER : prod@veo
PASS : xxxxxxxxxxxxxxx

Intégration de comptes acheteurs - Méthode ACCOUNT

POST https://<server-node>/API/account

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:

[{
  "IdSoc": "FC",
  "IdCli": "1234567890",
  "NameCli": "Alain MARTIN"
},{
  "IdSoc": "FC",
  "IdCli": "9876543210",
  "NameCli": "Martine DURAND"
}]

POST https://<server-node>/API/account_adrbookentry

  • Intégration des coordonnées d'un compte acheteur

POST https://<server-node>/API/record

  • Intégration de factures

POST https://<server-node>/API/scenario

  • Intégration

POST https://<server-node>/API/assignement

Tout les champs en gras sont des champs obligatoires.

POST 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

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

[{
    "Adr": "9 rue de la Plumerette 94000 Créteil",
    "Lib": "11 BIS COMMUNICATIONS",
    "IdCli": "C11BISCOMMUNICAT",
    "IdSoc": "TTV",
    "AdrType": "POSTAL"
  },
  {
    "Adr": "note faire le 8000 avant.",
    "Lib": "INDEX  Multimédia",
    "IdCli": "C123",
    "IdSoc": "Trace TV",
    "AdrType": "EMAIL"
  },
  {
    "Adr": "06XXXXXXXXXX",
    "Lib": "INDEX  Multimédia",
    "IdCli": "C123",
    "IdSoc": "TTV",
    "AdrType": "TEL"
}]

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

[{

    "IdSoc": "TTV",
    "IdCli": "C123MULTIMEDIA",
    "IdFact": "050618_6290_FAC22727",
    "MontantTTC": 103.300,
    "DateFact": "2018-06-05 00:00:00"
  },
  {

    "IDSoc": "TTV",
    "IdCli": "C123MULTIMEDIA",
    "IdFact": "050618_6292_FAC22725",
    "DateFact": "2018-06-05 00:00:00",
    "MontantTTC": 112.070
    "Journal": "VT",
    "NumFact": "FAC22725",
    "Letter": "C",
  },
  {

    "IDSoc": "TTV",
    "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"

  },
  {
    "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,
}]