WebHook Mahalo

Modifié le  Ven, 21 Nov. à 12:41 H

TABLE DES MATIÈRES



Introduction


Opper propose le mécanisme de WebHook. La fonctionnalité majeure est la suivante : lorsque qu’un évènement survient par exemple la modification d’un contact dans Mahalo, Mahalo appelle une ou plusieurs urls HTTP via le protocol POST afin de notifier un système distant de la modification 



Liste des évènements concernés


Les évènements éligibles au mécanisme de push sont les suivants :

  • customer.created
  • customer.updated
  • customer.deleted
  • subscription.created
  • subscription.updated
  • subscription.deleted
  • subscription.beneficiary.created
  • subscription.beneficiary.deleted
  • invoice.created
  • invoice.updated
  • invoice.deleted
  • order.product.line.created
  • order.product.line.updated
  • order.product.line.deleted


NB : Il n’y a pas de subscription.beneficiary.updated car il s’agit d’ajouter ou supprimer un bénéficiaire sur

un abonnement.


Chaque envoie de message sera composé des informations suivantes :

  • event : évènement déclenché
  • messageId : Identifiant unique du message
  • value : contenu du message


La partie value pourra être de 2 formats au choix selon l’usage souhaité :

  • light : dans ce cas, seul la référence interne est envoyée en value
  • full : toutes les données de l’objet sont envoyées en value



Fonctionnement technique


Le push sera réalisé par l’appel d’une url WEB préenregistrée dans Mahalo et à laquelle sera associé :

  • Un ou plusieurs événements
  • Pour chaque évènement, un format d’envoie (full ou light)


L’appel se fera via la méthode POST et le format d’échange sera du JSON.


Un call sera en succès côté Mahalo lors de la réception d’un code retour HTTP 200. Si le call est en erreur (réponse autre que 200), le message sera remis dans la pile et renvoyée au maximum 5 fois. Une fois la limite atteinte, l’erreur sera logguée et le message supprimé.



Exemple de configuration


UrlEvènementFormat
http://www.monurl1.fr/webhookcustomer.createdFull
http://www.monurl1.fr/webhookcustomer.updatedLight
http://www.monurl1.fr/webhookcustomer.deletedLight
http://www.monurl2.fr/webhooksubscription.createdFull
http://www.monurl2.fr/webhooksubscription.updatedLight
http://www.monurl2.fr/webhooksubscription.deletedLight



Exemple d'informations envoyées


1. Création de contact : customer.created

Exemple d’informations envoyées en mode light :

{
    "event": "CUSTOMER_CREATED",
    "entity": { "codeClient" : 5248321 }
}


Exemple d’informations envoyées en mode full (identique à l’appel unitaire du WS https://apipreprod.mahalo-app.io/editeur/{refEditeur}/client/{codeClient}) : 

{
    "event": "CUSTOMER_CREATED ",
    "entity":{
        "codeClient":11212,
        "creation":"2020-04-06T15:43:36.000+0000",
        "modification":"2020-04-29T06:59:51.496+0000",
        "utilCreation":"ROBERT DUPOND",
        "utilModification":"ROBERT DUPOND",
        "typeClient":"0",
        "typeClientStr":"Client",
        "civilite":"M",
        "nom":"DUPOND",
        "prenom":"TESTRET",
        "societe":"",
        "siret":"",
        "adresse1":"",
        "adresse2":"10 PLACE DU GENERAL DE GAULLE",
        "adresse3":"",
        "adresse4":"",
        "adresseNormalisee1":"M TESTRET DUPOND",
        "adresseNormalisee2":"",
        "adresseNormalisee3":"",
        "adresseNormalisee4":"12 PLACE DU VERT BUISSON",
        "adresseNormalisee5":"",
        "adresseNormalisee6":"35000 RENNES",
        "adresseNormalisee7":"FRANCE",
        "cp":"35170",
        "ville":"BRUZ",
        "codeIsoPays":"FR",
        "telephone":"",
        "portable":"0640589765",
        "telecopie":"",
        "email":"rdupond@societe.com",
        "siteWeb":null,
        "reaboAuto":false,
        "relancerPaye":false,
        "pasMailing":false,
        "pasEmailing":false,
        "npai":false,
        "nePasDiffuser":false,
        "tauxRemiseAbo":0.0,
        "tauxRemiseArticle":0.0,
        "codeNii":"",
        "erreurAel":null,
        "origineAbm":"", "codeTiers":null,
        "nbNpai":0,
        "noteNpai":"",
        "noteEtat":"",
        "motPasseAbm":"",
        "pays":"FRANCE",
        "codeClientTransco":"",
        "codeZoneTva":"1",
        "libelleZoneTva":"TVA France",
        "etatClient":"OK",
        "nomAffichage":"TESTRET DUPOND",
        "bic":null,
        "iban":null,
        "banque":null,
        "titulaire":null,
        "solde":0.0,
        "estSociete":false,
        "nbContactsSociete":null,
        "langageFacture":null,
        "modePaiement":"1",
        "delaiPaiement":30,
        "compteGeneral":null,
        "compteAuxiliaire":null,
        "ancienCode":"TESTANCIEN",
        "dns":null,
        "echeance":null,
        "refCb":null,
        "cbTitulaire":null,
        "cbIdPsp":null,
        "cbCode":null,
        "cbNumero":null,
        "cbExpire":null,
        "cbCreation":null,
        "cbRefPrestataire":null,
        "cbPrestataire":null, "dateDernierRejet":null,
        "exonere":false,
        "refModePaiement":null,
        "codeInsee":"35047",
        "motDirecteur":"GENERAL DE GAULLE",
        "noVoie":"12",
        "codeQuartier":"0025",
        "nomDebiteur":"DUPOND TESTRET",
        "aDesFactures":false,
        "modeEnvoi":null,
        "fidelite":null,
        "dnl":null,
        "ape":"",
        "mauvaisPayeur":false,
        "arrondissement":"",
        "canton":"",
        "refMotifSuspension":1,
        "nbPayes":null,
        "codeSociete":null,
        "nomSociete":null,
        "fonction":null,
        "twitter":null,
        "facebook":null,
        "region":"BRETAGNE",
        "linkedin":null,
        "regimeForce":null,
        "codeServiceFacturation":"",
        "typeSemaine":null,
        "regimeTva":"1",
        "titreAdresse":null,
        "typeAdresse":"0",
        "refAdresse":null,
        "dateDebut":null,
        "dateFin":null,
        "tauxRemiseAl":0.0,
        "titulaireRib":null,
        "languageFac":null,
        "tauxRemiseAbos":0.0
    }
}


2. Modification de contact : customer.updated 

Exemple d’informations envoyées en mode light :

{
    "event": " CUSTOMER_UPDATED",
    "entity": { "codeClient" : 5248321 }
}


Exemple d’informations envoyées en mode full : 

{
    "event":"CUSTOMER_UPDATED",
    "entity":{
        "codeClient":11212,
        "creation":"2020-04-06T15:43:36.000+0000",
        "modification":"2020-04-29T06:59:51.496+0000",
        "utilCreation":"ROBERT DUPOND",
        "utilModification":"ROBERT DUPOND",
        "typeClient":"0",
        "typeClientStr":"Client",
        "civilite":"M",
        "nom":"DUPOND",
        "prenom":"TESTRET",
        "societe":"",
        "siret":"",
        "adresse1":"",
        "adresse2":"10 PLACE DU GENERAL DE GAULLE",
        "adresse3":"",
        "adresse4":"",
        "adresseNormalisee1":"M TESTRET DUPOND",
        "adresseNormalisee2":"",
        "adresseNormalisee3":"",
        "adresseNormalisee4":"12 PLACE DU VERT BUISSON",
        "adresseNormalisee5":"",
        "adresseNormalisee6":"35000 RENNES",
        "adresseNormalisee7":"FRANCE",
        "cp":"35170",
        "ville":"BRUZ",
        "codeIsoPays":"FR",
        "telephone":"",
        "portable":"0640589765",
        "telecopie":"",
        "email":"rdupond@societe.com",
        "siteWeb":null,
        "reaboAuto":false,
        "relancerPaye":false,
        "pasMailing":false,
        "pasEmailing":false,
        "npai":false,
        "nePasDiffuser":false,
        "tauxRemiseAbo":0.0,
        "tauxRemiseArticle":0.0,
        "codeNii":"",
        "erreurAel":null,
        "origineAbm":"",
        "codeTiers":null,
        "nbNpai":0,
        "noteNpai":"",
        "noteEtat":"",
        "motPasseAbm":"",
        "pays":"FRANCE",
        "codeClientTransco":"",
        "codeZoneTva":"1",
        "libelleZoneTva":"TVA France",
        "etatClient":"OK",
        "nomAffichage":"TESTRET DUPOND",
        "bic":null,
        "iban":null,
        "banque":null,
        "titulaire":null,
        "solde":0.0,
        "estSociete":false,
        "nbContactsSociete":null,
        "langageFacture":null,
        "modePaiement":"1",
        "delaiPaiement":30,
        "compteGeneral":null,
        "compteAuxiliaire":null,
        "ancienCode":"TESTANCIEN",
        "dns":null,
        "echeance":null, "refCb":null,
        "cbTitulaire":null,
        "cbIdPsp":null,
        "cbCode":null,
        "cbNumero":null,
        "cbExpire":null,
        "cbCreation":null,
        "cbRefPrestataire":null,
        "cbPrestataire":null,
        "dateDernierRejet":null,
        "exonere":false,
        "refModePaiement":null,
        "codeInsee":"35047",
        "motDirecteur":"GENERAL DE GAULLE",
        "noVoie":"12",
        "codeQuartier":"0025",
        "nomDebiteur":"DUPOND TESTRET",
        "aDesFactures":false,
        "modeEnvoi":null,
        "fidelite":null,
        "dnl":null,
        "ape":"",
        "mauvaisPayeur":false,
        "arrondissement":"",
        "canton":"",
        "refMotifSuspension":1,
        "nbPayes":null,
        "codeSociete":null,
        "nomSociete":null,
        "fonction":null,
        "twitter":null,
        "facebook":null,
        "region":"BRETAGNE",
        "linkedin":null,
        "regimeForce":null,
        "codeServiceFacturation":"",
        "typeSemaine":null,
        "regimeTva":"1",
        "titreAdresse":null,
        "typeAdresse":"0",
        "refAdresse":null,
        "dateDebut":null,
        "dateFin":null,
        "tauxRemiseAl":0.0,
        "titulaireRib":null,
        "languageFac":null,
        "tauxRemiseAbos":0.0
    }
}


3. Suppression de contact : customer.deleted 

Exemple d’informations envoyées en mode light :

{
    "event": "CUSTOMER_DELETED",
    "entity": { "codeClient" : 5248321 }
}


Exemple d’informations envoyées en mode full : 

{
    "event": "CUSTOMER_DELETED ",
    "entity":{
        "codeClient":11212,
        "creation":"2020-04-06T15:43:36.000+0000",
        "modification":"2020-04-29T06:59:51.496+0000",
        "utilCreation":"ROBERT DUPOND",
        "utilModification":"ROBERT DUPOND",
        "typeClient":"0",
        "typeClientStr":"Client",
        "civilite":"M",
        "nom":"DUPOND",
        "prenom":"TESTRET",
        "societe":"",
        "siret":"",
        "adresse1":"",
        "adresse2":"10 PLACE DU GENERAL DE GAULLE",
        "adresse3":"",
        "adresse4":"",
        "adresseNormalisee1":"M TESTRET DUPOND",
        "adresseNormalisee2":"",
        "adresseNormalisee3":"",
        "adresseNormalisee4":"12 PLACE DU VERT BUISSON",
        "adresseNormalisee5":"",
        "adresseNormalisee6":"35000 RENNES",
        "adresseNormalisee7":"FRANCE",
        "cp":"35170",
        "ville":"BRUZ",
        "codeIsoPays":"FR",
        "telephone":"",
        "portable":"0640589765",
        "telecopie":"",
        "email":"rdupond@societe.com",
        "siteWeb":null,
        "reaboAuto":false,
        "relancerPaye":false,
        "pasMailing":false,
        "pasEmailing":false,
        "npai":false,
        "nePasDiffuser":false,
        "tauxRemiseAbo":0.0,
        "tauxRemiseArticle":0.0,
        "codeNii":"",
        "erreurAel":null,
        "origineAbm":"",
        "codeTiers":null,
        "nbNpai":0,
        "noteNpai":"",
        "noteEtat":"",
        "motPasseAbm":"",
        "pays":"FRANCE",
        "codeClientTransco":"",
        "codeZoneTva":"1",
        "libelleZoneTva":"TVA France",
        "etatClient":"OK",
        "nomAffichage":"TESTRET DUPOND",
        "bic":null,
        "iban":null,
        "banque":null,
        "titulaire":null,
        "solde":0.0,
        "estSociete":false,
        "nbContactsSociete":null,
        "langageFacture":null,
        "modePaiement":"1",
        "delaiPaiement":30,
        "compteGeneral":null,
        "compteAuxiliaire":null,
        "ancienCode":"TESTANCIEN",
        "dns":null,
        "echeance":null,
        "refCb":null,
        "cbTitulaire":null,
        "cbIdPsp":null,
        "cbCode":null,
        "cbNumero":null,
        "cbExpire":null,
        "cbCreation":null,
        "cbRefPrestataire":null,
        "cbPrestataire":null,
        "dateDernierRejet":null,
        "exonere":false,
        "refModePaiement":null,
        "codeInsee":"35047",
        "motDirecteur":"GENERAL DE GAULLE",
        "noVoie":"12",
        "codeQuartier":"0025",
        "nomDebiteur":"DUPOND TESTRET",
        "aDesFactures":false,
        "modeEnvoi":null,
        "fidelite":null,
        "dnl":null,
        "ape":"",
        "mauvaisPayeur":false,
        "arrondissement":"",
        "canton":"",
        "refMotifSuspension":1,
        "nbPayes":null,
        "codeSociete":null,
        "nomSociete":null,
        "fonction":null,
        "twitter":null,
        "facebook":null,
        "region":"BRETAGNE",
        "linkedin":null,
        "regimeForce":null,
        "codeServiceFacturation":"",
        "typeSemaine":null,
        "regimeTva":"1",
        "titreAdresse":null,
        "typeAdresse":"0",
        "refAdresse":null,
        "dateDebut":null,
        "dateFin":null,
        "tauxRemiseAl":0.0,
        "titulaireRib":null,
        "languageFac":null,
        "tauxRemiseAbos":0.0
    }
}



4. Création d’abonnement : subscription.created  

Exemple d’informations envoyées en mode light :

{
    "event": "SUBSCRIPTION_CREATED",
    "entity": { "refAbonnement" : 154689 }
}


Exemple d’informations envoyées en mode full : 

{
 "event": " SUBSCRIPTION_CREATED",
 "entity": {
 "refAbonnement": 154689,
 "creation": "2019-12-17T16:17:45.000+0000",
 "modification": "2019-12-17T16:17:45.000+0000",
 "puHt": 6.54,
 "puTtc": 6.68,
 "tauxTva": 2.1,
 "aboGratuit": false,
 "servir": 24,
 "dateOrdre": "2019-12-16T23:00:00.000+0000",
 "pns": 1121,
 "dns": 1144,
 "dnl": null,
 "dateDnl": null,
 "nbExemplaires": 2,
 "nbEtiquettes": 2,
 "tauxRemise": 2,
 "montantHt": 12.82,
 "montantTtc": 13.09,
 "nivRelance": 0,
 "facture": true,
 "suspendu": false,
"suspenduAu": null,
 "obsolete": false,
 "nePasRelancer": true,
 "modeEnvoi": null,
 "noCommande": "",
 "passeEnCompta": false,
 "nivRelReabo": null,
 "fidelite": 1,
 "relanceParEmail": false,
 "cs1": null,
 "cs2": null,
 "cs3": null,
 "cs4": null,
 "cs5": null,
 "cs6": null,
 "cs7": null,
 "cs8": null,
 "cs9": "",
 "cs10": "",
 "reabonnement": false,
 "refTarif": 6032,
 "codeClient": 5248321,
"codeTiers": null,
 "codeParrain": null,
 "codePrescripteur": null,
 "refAncienAbo": null,
 "libParutionPns": "19/12/2019_687",
 "libParutionDns": "04/06/2020 710",
 "refSociete": 1,
 "refTitre": 6,
 "codeTarif": "XXXXX",
 "designationTarif": "MA DESIGNATION",
 "codeTitre": "CODE_TITRE",
 "refFacture": 1025571,
 "noFacture": "F1912185808",
 "dateDebut": "2019
-12
-12T23:00:00.000+0000",
 "dateFin": "2020
-06
-03T22:00:00.000+0000",
 "dateSuspenduAu": null,
 "etat": "01",
 "numeroEnCours": 1122,
 "refTarifFormule": 6057,
 "codeTarifFormule": "FXXXXX",
 "lstSuspension": [],
 "origineReabonnement": "",
 "titreEnClair": "MON TITRE",
 "nomAbonne": "MARC FDGADUAUUCLZU",
"codeRelance": null,
 "qteSuspensions": null,
 "disabled": false,
 "information": null,
 "pasdEmail": false,
 "codePartenaire": "0987654321",
 "partenaire": "FB",
 "regleSansFacture": null,
 "sequenceFormule": "902154320191217171744782",
 "refTarifReabo": 6057,
 "solde": 266.55,
 "dateRenouvellement": null,
 "adl": null,
 "dateProchainRenouvellement": null,
 "arrondiSurTtc": true,
 "dateDebutAbonnement": "2019-12-12T23:00:00.000+0000",
 "dateFinAbonnement": "2020-06-03T22:00:00.000+0000"
 } 
}



5. Modification d’abonnement : subscription.updated 

Exemple d’informations envoyées en mode light :

{
    "event": "SUBSCRIPTION_UPDATED",
    "entity": { "refAbonnement" : 154689 }
}


Exemple d’informations envoyées en mode full (identique à l’appel unitaire du WS https://apipreprod.mahalo-app.io/editeur/{refEditeur}/abonnement/{refAbonnement}) : 

{
    "event": "SUBSCRIPTION_UPDATED",
    "entity": {,
        "refAbonnement": 154689,
        "creation": "2019-12-17T16:17:45.000+0000",
        "modification": "2019-12-17T16:17:45.000+0000",
        "puHt": 6.54,
        "puTtc": 6.68
        "tauxTva": 2.1,
        "aboGratuit": false,
        "servir": 24,
        "dateOrdre": "2019-12-16T23:00:00.000+0000",
        "pns": 1121,
        "dns": 1144,
        "dnl": null,
        "dateDnl": null,
        "nbExemplaires": 2,
        "nbEtiquettes": 2,
        "tauxRemise": 2,
        "montantHt": 12.82,
        "montantTtc": 13.09,
        "nivRelance": 0,
        "facture": true,
        "suspendu": false,
        "suspenduAu": null,
        "obsolete": false,

        "nePasRelancer": true,
        "modeEnvoi": null,
        "noCommande": "",
        "passeEnCompta": false,
        "nivRelReabo": null,
        "fidelite": 1,
        "relanceParEmail": false,
        "cs1": null,
        "cs2": null,
        "cs3": null,
        "cs4": null,
        "cs5": null,
        "cs6": null,
        "cs7": null,
        "cs8": null,
        "cs9": "",
        "cs10": "",
        "reabonnement": false,
        "refTarif": 6032,
        "codeClient": 5248321,
        "codeTiers": null,
        "codeParrain": null,
        "codePrescripteur": null,
        "refAncienAbo": null,
        "libParutionPns": "19/12/2019_687",
        "libParutionDns": "04/06/2020 710",
        "refSociete": 1,
        "refTitre": 6,
        "codeTarif": "XXXXX",
        "designationTarif": "MA DESIGNATION",
        "codeTitre": "CODE_TITRE",
        "refFacture": 1025571,
        "noFacture": "F1912185808",
        "dateDebut": "2019
        -12
        -12T23:00:00.000+0000",
        "dateFin": "2020
        -06
        -03T22:00:00.000+0000",
        "dateSuspenduAu": null,
        "etat": "01",
        "numeroEnCours": 1122,
        "refTarifFormule": 6057,
        "codeTarifFormule": "FXXXXX",
        "lstSuspension": [],
        "origineReabonnement": "",
        "titreEnClair": "MON TITRE",
        "nomAbonne": "MARC FDGADUAUUCLZU",
        "codeRelance": null,
        "qteSuspensions": null,
        "disabled": false,
        "information": null,
        "pasdEmail": false,
        "codePartenaire": "0987654321",
        "partenaire": "FB",
        "regleSansFacture": null,
        "sequenceFormule": "902154320191217171744782",
        "refTarifReabo": 6057,
        "solde": 266.55,
        "dateRenouvellement": null,
        "adl": null,
        "dateProchainRenouvellement": null,
        "arrondiSurTtc": true,
        "dateDebutAbonnement": "2019-12-12T23:00:00.000+0000",
        "dateFinAbonnement": "2020-06-03T22:00:00.000+0000"
    }
}



6. Suppression d’abonnement : subscription.deleted 

Exemple d’informations envoyées en mode light :

{
    "event": "SUBSCRIPTION_DELETED",
    "entity": { "refAbonnement" : 154689 }
}


7. Création d’une relation abonnement-bénéficiare : subscription.beneficiary.created 

Exemple d’informations envoyées :

{
    "event": "BENEFICIARY_SUBSCRIPTION_CREATED ",
    "entity": {
        "refAbonnement":9999999,
        "codeClient":9999999
    }
}


8. Suppression d’une relation abonnement-bénéficiare : subscription.beneficiary.deleted 

Exemple d’informations envoyées :

{
    "event": "BENEFICIARY_SUBSCRIPTION_DELETED ",
    "entity": {
        "refAbonnement":9999999,
        "codeClient":9999999
    }
}


9. Création de factures : invoice.created 

Exemple d’informations envoyées en mode light :

{
    "event": "INVOICE_CREATED",
    "entity": { "refFacture" : 2548769 }
}


Exemple d’informations envoyées en mode full (identique à l’appel unitaire du WS https://apipreprod.mahalo-app.io/editeur/{refEditeur}/facture/{refFacture}):

{
    "event": "INVOICE_CREATED",
    "entity": {
        "refFacture": 2548769,
        "noFacture": "F1912185808",
        "dateFacture": "2019-12-16T23:00:00.000+0000",
        "dateEcheance": "2019-12-16T23:00:00.000+0000",
        "montantHt": 261.07,
        "montantTtc": 266.55,
        "solde": 266.55,
        "avoirOn": false,
        "dateImpression": null,
        "dateMail": null,
        "dateRelanceImp": null,
        "notesFacture": "Règlement à l´ordre de SOCIETE\r\nTVA Intracom XXXXXXXXX",
        "verrouillee": true,
        "objetFacture": "",
        "adresseFacturation": null,
        "adresseLivraison": null,
        "refAvoir": null,
        "noAvoir": null,
        "codeClient": 5248321,
        "nomAffichageClient": "MARC FDGADUAUUCLZU",
        "refSociete": 1,
        "refAdresseFacturation": 1510266,
        "refAdresseLivraison": 1510265,
        "refNatureFacture": null,
        "nivRelanceImp": 0,
        "libelleNatureFacture": null,
        "envoiChorus": null,
        "dateEnvoiChorus": null,
        "identifiantChorus": null,
        "download":
        "/DownloadServlet?param=cmVmX2VkaXRldXI9NjEwJnVzZXI9ZmRnYWR1YXV1Y2x6dUBmcmVlLmZyJnBhc3
        N3b3JkPUF0ZUp6UzVxJm5vX2ZhY3R1cmU9RjE5MTIxODU4MDgmcmVmX3NvY2lldGU9MQ==",
        "avoir": null,
        "codeFilleul": null,
        "engagementJuridique": null
    }
}


 

10. Modification de factures : invoice.updated 

Exemple d’informations envoyées en mode light :

{
    "event": "INVOICE_ UPDATED",
    "entity": { "refFacture" : 2548769 }
}


Exemple d’informations envoyées en mode full (identique à l’appel unitaire du WS https://apipreprod.mahalo-app.io/editeur/{refEditeur}/facture/{refFacture}):

{
    "event": "INVOICE_UPDATED",
    "entity": {
        "refFacture": 2548769,
        "noFacture": "F1912185808",
        "dateFacture": "2019-12-16T23:00:00.000+0000",
        "dateEcheance": "2019-12-16T23:00:00.000+0000",
        "montantHt": 261.07,
        "montantTtc": 266.55,
        "solde": 266.55,
        "avoirOn": false,
        "dateImpression": null,
        "dateMail": null,
        "dateRelanceImp": null,
        "notesFacture": "Règlement à l´ordre de SOCIETE\r\nTVA Intracom XXXXXXXXX",
        "verrouillee": true,
        "objetFacture": "",
        "adresseFacturation": null,
        "adresseLivraison": null,
        "refAvoir": null,
        "noAvoir": null,
        "codeClient": 5248321,
        "nomAffichageClient": "MARC FDGADUAUUCLZU",
        "refSociete": 1,
        "refAdresseFacturation": 1510266,
        "refAdresseLivraison": 1510265,
        "refNatureFacture": null,
        "nivRelanceImp": 0,
        "libelleNatureFacture": null,
        "envoiChorus": null,
        "dateEnvoiChorus": null,
        "identifiantChorus": null,
        "download":
        "/DownloadServlet?param=cmVmX2VkaXRldXI9NjEwJnVzZXI9ZmRnYWR1YXV1Y2x6dUBmcmVlLmZyJnBhc3
        N3b3JkPUF0ZUp6UzVxJm5vX2ZhY3R1cmU9RjE5MTIxODU4MDgmcmVmX3NvY2lldGU9MQ==",
        "avoir": null,
        "codeFilleul": null,
        "engagementJuridique": null
    }
}

 

11. Suppression de factures : invoice.deleted 

Exemple d’informations envoyées en mode light :

{
    "event": "INVOICE_DELETED",
    "entity": { "refFacture" : 2548769 }
}


12. Création d’une ligne d’article libre dans une commande : order.product.line.created 

Exemple d’informations envoyées en mode light :

{
    "event": "ORDER_PRODUCT_LINE_CREATED",
    "entity": {"refArticleLigne": 99999999}
}


Exemple d’informations envoyées en mode full (identique à l’appel unitaire du WS https://apipreprod.mahalo-app.io/editeur/{refEditeur}/articleligne/{refArticleLigne}): 

{
    "event": "ORDER_PRODUCT_LINE_CREATED",
    "entity": {
        "refArticleLigne": 99999999,
        "creation": "2023-10-19T21:24:10.000+00:00",
        "utilCreation": null,
        "modification": "2023-10-19T21:24:10.000+00:00",
        "utilModification": null,
        "refGroupe": null,
        "puHt": 1.95,
        "puTtc": 1.99,
        "quantite": 1,
        "tauxTva": 2.1,
        "montantTva": 0.04,
        "montantHt": 1.95,
        "montantTtc": 1.99,
        "tauxRemise": 0.0,
        "montantRemise": 0.0,
        "dateLivraison": null,
        "livreOk": false,
        "dateValidationLivraison": null,
        "refFacture": 999999,
        "noFacture": "F99999999",
        "dateFacture": "2023-10-18T22:00:00.000+00:00",
        "refFormule": null,
        "refTarif": 999999999,
        "codeTarif": "XXXXX-000",
        "arrondiSurTtc": true,
        "refMouvement": null,
        "position": 1,
        "codeClient": 9999999999,
        "noCommande": "99999999",
        "portHt": 0.0,
        "portTauxTva": 2.1,
        "portTtc": 0.0,
        "fraisDePort": null,
        "noColissimo": "",
        "modeExpedition": null,
        "pointRelaisId": "",
        "suspendu": false,
        "sequenceFormule": null,
        "designationTarif": "Edition du 03/12/2021",
        "designationGroupe": null,
        "refSociete": null,
        "codeTarifTransco": null,
        "refTarifSubstitution": null,
        "codeTarifSubstitution": null,
        "familleTarif": "AAAAAA",
        "familleCompta": "AAAAAAA",
        "livrable": false
    }
}


13. Modification d’une ligne d’article libre dans une commande : order.product.line.updated 

Exemple d’informations envoyées en mode light :

{
    "event": "ORDER_PRODUCT_LINE_UPDATED ",
    "entity": {"refArticleLigne": 99999999}
}


Exemple d’informations envoyées en mode full (identique à l’appel unitaire du WS https://apipreprod.mahalo-app.io/editeur/{refEditeur}/articleligne/{refArticleLigne}): 

{
    "event": "ORDER_PRODUCT_LINE_UPDATED",
    "entity": {
        "refArticleLigne": 99999999,
        "creation": "2023-10-19T21:24:10.000+00:00",
        "utilCreation": null,
        "modification": "2023-10-19T21:24:10.000+00:00",
        "utilModification": null,
        "refGroupe": null,
        "puHt": 1.95,
        "puTtc": 1.99,
        "quantite": 1,
        "tauxTva": 2.1,
        "montantTva": 0.04,
        "montantHt": 1.95,
        "montantTtc": 1.99,
        "tauxRemise": 0.0,
        "montantRemise": 0.0,
        "dateLivraison": null,
        "livreOk": false,
        "dateValidationLivraison": null,
        "refFacture": 999999,
        "noFacture": "F99999999",
        "dateFacture": "2023-10-18T22:00:00.000+00:00",
        "refFormule": null,
        "refTarif": 999999999,
        "codeTarif": "XXXXX-000",
        "arrondiSurTtc": true,
        "refMouvement": null,
        "position": 1,
        "codeClient": 9999999999,
        "noCommande": "99999999",
        "portHt": 0.0,
        "portTauxTva": 2.1,
        "portTtc": 0.0,
        "fraisDePort": null,
        "noColissimo": "",
        "modeExpedition": null,
        "pointRelaisId": "",
        "suspendu": false,
        "sequenceFormule": null,
        "designationTarif": "Edition du 03/12/2021",
        "designationGroupe": null,
        "refSociete": null,
        "codeTarifTransco": null,
        "refTarifSubstitution": null,
        "codeTarifSubstitution": null,
        "familleTarif": "AAAAAA",
        "familleCompta": "AAAAAAA",
        "livrable": false
    }
}


14. Suppression d’une ligne d’article libre dans une commande : order.product.line. deleted 

Exemple d’informations envoyées en mode light :

{
    "event": "ORDER_PRODUCT_LINE_DELETED ",
    "entity": {"refArticleLigne": 99999999}
}

Cet article a-t-il été utile ?

C'est super !

Merci pour votre commentaire

Désolé ! Nous n'avons pas pu vous être utile

Merci pour votre commentaire

Dites-nous comment nous pouvons améliorer cet article !

Sélectionner au moins l'une des raisons
La vérification CAPTCHA est requise.

Commentaires envoyés

Nous apprécions vos efforts et nous allons corriger l'article