Afficher la Table des Matières

# Web services REST pour gérer les devis depuis Salesforce vers Akuiteo

## : : Créer un devis

Ce web service vous permet de créer un devis dans Akuiteo depuis Salesforce.

Méthode : POST devisclient/{numeroDevisInterne}/revise

Exemple : {adresse du serveur Akuiteo}/{nom de l'application Akuiteo}/RS/devisclient/CC1877788/revise

Paramètres (body) :

{

"codeSociete" : "AK",

"numeroDevisExterne" : "Num devis ext",

"codeJournal" : "VEN",

"codeClient" : "C19771",

"dateDevis" : "30/07/2018",

"codeDevise" : "EUR",

"delaiPaiement": "010",

"ligneDevis" : [

{

"regroupement" : "AK_GROUPE",

"reference" : "1101",

"quantite" : "2",

"prixUnit" : "2.26",

"codeTVA" : "01",

"codeAffaire" : "MAI00002",

"compteCG" : "706000",

}

]

}

#### Paramètres possibles pour l'en-tête du devis

Paramètre | Description | Valeur | Obligatoire ?
--- | --- | --- | ---
`codeSociete` | Code société du devis | Caractère alphanumérique 20 caractères max. Ex : AK | Oui
`numeroDevisInterne` | Numéro du devis Akuiteo. S'il n'est pas renseigné, un numéro sera attribué directement grâce à la numérotation automatique des devis. | Caractère alphanumérique 15 caractères max. Ex : CC1877788 | Non
`numeroDevisExterne` | Numéro du devis Salesforce | Caractère alphanumérique 20 caractères max. Ex : 12345 | Non
`codeJournal` | Code journal | Caractère alphanumérique 20 caractères max. Ex : VENTE | Oui
`refClient1` | Référence client 1 | Caractère alphanumérique 60 caractères max. Ex : refcli1 | Non
`refClient2` | Référence client 2 | Caractère alphanumérique 60 caractères max. Ex : refcli2 | Non
`refClient3` | Référence client 3 | Caractère alphanumérique 60 caractères max. Ex : refcli3 | Non
`codeClient` | Code client du devis | Caractère alphanumérique 10 caractères max. Ex : C19771 | Oui
`codeClientFacture` | Code client facturé du devis | Caractère alphanumérique 10 caractères max. Ex : C19771 | Non
`dateDevis` | Date du devis | Format de date JJ/MM/AAAA Ex : 15/09/2018 | Oui
`dateRefClient` | Date de la référence client | Format de date JJ/MM/AAAA Ex : 15/09/2018 | Non
`respDevis` | Code du collaborateur responsable du devis | Caractère alphanumérique 14 caractères max. Ex : ABC | Non
`respEtablissement` | Code établissement du devis | Caractère alphanumérique 14 caractères max. Ex : ABC | Non
`codeDevise` | Code de la devise du devis | Caractère alphanumérique 3 caractères max. Ex : EUR | Oui
`dateSignPrev` | Date de signature prévisionnelle du devis | Format de date JJ/MM/AAAA Ex : 15/09/2018 | Non
`respComm` | Code du collaborateur responsable commercial du devis | Caractère alphanumérique 14 caractères max. Ex : ABC | Non
`texte` | Commentaire dans l'en-tête du devis | Caractère alphanumérique 4000 caractères max. Ex : Ceci est un commentaire. | Non
`ModePaiement` | Code des conditions de règlement : AU = Autres CB = Carte bancaire CH = Chèque ES = Espèces LC = Lettre cHèque PR = Prélèvement TR = Traite VD = Virement devise VI = Virement | Caractère alphanumérique 20 caractères max. Ex : CH | Non
`delaiPaiement` | Délai de paiement en nombre de jours | Caractère alphanumérique 3 caractères max. Ex : 15 | Non
`termePaiement` | Mois de règlement : 1 = Fin de mois 2 = Début de mois 3 = Fixe | Caractère alphanumérique 1 caractère max. Ex : 3 | Non
`jourPaiement` | Jour de paiement | Caractère alphanumérique 2 caractères max. Ex : 10 | Non
`indNotifie` | Soumis à notification : 0 = Non 1 = Oui | Booléen Ex : 1 | Non
`ligneDevis` | Permet de détailler les lignes d'un devis avec une liste d'éléments. Ajoutez autant de lignes de devis que nécessaire. Pour voir la liste des éléments pour le paramètre `ligneDevis`, voir Paramètres possibles pour les lignes de devis. |  | Oui
`ligneTitres` | Permet de détailler les lignes de titre du devis avec une liste d'éléments. Ajoutez autant de lignes de titre que nécessaire. Pour voir la liste des éléments pour le paramètre `ligneTitres`, voir Paramètres possibles pour les lignes de titre. |  | Non
`donneesPersonnaliseesDevis` | Permet de détailler les données personnalisées du devis avec une liste d'éléments. Ajoutez autant de données personnalisées que nécessaire. Pour voir la liste des éléments pour le paramètre `donneesPersonnaliseesDevis`, voir Paramètres possibles pour les données personnalisées. |  | Non

#### Paramètres possibles pour les lignes de devis

Paramètre | Description | Valeur | Obligatoire ?
--- | --- | --- | ---
`regroupement` | Code de regroupement du produit vendu | Caractère alphanumérique 20 caractères max. Ex : AK_GROUPE | Oui
`reference` | Code référence du produit vendu | Caractère alphanumérique 80 caractères max. Ex : 101010 | Oui
`descripLigne` | Description abrégée de la ligne du devis | Caractère alphanumérique 100 caractères max. Ex : Ceci est une description. | Non
`texteLigne` | Commentaire sur la ligne du devis | Caractère alphanumérique 4000 caractères max. Ex : Ceci est un commentaire. | Non
`quantite` | Quantité, qui peut être positive et négative | Nombre 17 chiffres et 5 décimales max. Ex : 3 | Oui
`prixUnit` | Prix unitaire HT | Nombre 17 chiffres et 5 décimales max. Ex : 3 | Oui
`codeTVA` | Code TVA | Caractère alphanumérique 20 caractères max. Ex : 01 | Oui
`remiseMNT` | Remise en montant | Nombre 14 chiffres et 2 décimales max. Ex : 25 | Non
`remisePourcent` | Remise en pourcentage | Nombre 9 chiffres et 2 décimales max. Ex : 25 | Non
`codeAffaire` | Code affaire | Caractère alphanumérique 10 caractères max. Ex : ABC | Oui
`codeLot` | Code lot | Caractère alphanumérique 10 caractères max. Ex : ABC | Non
`codeSousLot` | Code sous-lot | Caractère alphanumérique 10 caractères max. Ex : ABC | Non
`codeTache` | Code tâche | Caractère alphanumérique 10 caractères max. Ex : ABC | Non
`compteCG` | Compte de comptabilité générale de charge ou d'immobilisation | Caractère alphanumérique 10 caractères max. Ex : 706000 | Oui
`dateLivPrev` | Date de livraison prévisionnelle. Cette date est obligatoire si le pilote CC_DATLIV_N_OBL est inactif. | Format de date JJ/MM/AAAA Ex : 15/09/2018 | Non
`dateFacPrev` | Date de facturation prévisionnelle. Cette date est obligatoire si le pilote CC_DATLIV_N_OBL est inactif. | Format de date JJ/MM/AAAA Ex : 15/09/2018 | Non
`dateDebutPeriode` | Date de début de période | Format de date JJ/MM/AAAA Ex : 15/09/2018 | Non
`dateFinPeriode` | Date de fin de période | Format de date JJ/MM/AAAA Ex : 15/09/2018 | Non
`dateNotification` | Date de notification de la ligne de commande. Cette date sera égale à la date de commande pour les produits vendus non soumis à notification (contremarque). | Format de date JJ/MM/AAAA Ex : 15/09/2018 | Non
`numeroContrat` | Numéro de contrat N-1 dans le cas d'un renouvellement de contrat | Caractère alphanumérique 30 caractère max. Ex : C12345 | Non
`periodicite` | Périodicité de la facturation récurrente : 0 = Unique (par défaut) 1 = Annuelle 2 = Semestrielle 3 = Trimestrielle 4 = Mensuelle | Nombre 1 caractère max. Ex : 1 | Non
`periodiciteDuree` | Durée exprimée en mois pour la période de facturation récurrente | Nombre 4 caractères max. Ex : 12 | Non
`periodiciteTerme` | Terme de la facturation récurrente : 0 = Terme à échoir 1 = Terme échu | Nombre 1 caractère max. Ex : 1 | Non
`periodiciteTR` | Tacite reconduction de la facturation récurrente : 0 = Pas de tacite reconduction 1 = Tacite reconduction | Nombre 1 caractère max. Ex : 1 | Non
`periodiciteDateDebut` | Date de début de la facturation récurrente | Format de date JJ/MM/AAAA Ex : 15/09/2018 | Non
`editable` | Ligne éditable : 0 = Non 1 = Oui | Booléen Ex : 1 | Non
`idLigneTitreRattach` | Identifiant de la ligne de titre de rattachement | Nombre 2 caractères max. Ex : 1 | Non

#### Paramètres possibles pour les lignes de titre

Paramètre | Description | Valeur | Obligatoire ?
--- | --- | --- | ---
`idLigneTitre` | Identifiant de la ligne de titre | Nombre 2 caractères max. Ex : 1 | Non
`libelleTitre` | Libellé de la ligne de titre | Caractère alphanumérique 153 caractère max. Ex : Titre de la ligne | Non
`idLignePere` | Identifiant de la ligne père pour un sous-titre | Nombre 2 caractères max. Ex : 1 | Non

#### Paramètres possibles pour les données personnalisées

Paramètre | Description | Valeur | Obligatoire ?
--- | --- | --- | ---
`sequence` | Numéro de séquence de la donnée personnalisée | Nombre 1 caractère max. Ex : 1 | Non
`champ` | Type de champ de la donnée personnalisée, par exemple alpha01, num01, date01 ou booleen01 | Caractère alphanumérique 10 caractère max. Ex : alpha01 | Non
`stringValue` | Valeur de la donnée personnalisée si le `champ` est de type alpha | Caractère alphanumérique 4000 caractères max. Ex : Ceci est une donnée personnalisée. | Non
`numericValue` | Valeur de la donnée personnalisée si le `champ` est de type num | Nombre 15 chiffres et 3 décimales max. Ex : 25 | Non
`dateValue` | Valeur de la donnée personnalisée si le `champ` est de type date | Format de date JJ/MM/AAAA Ex : 15/09/2018 | Non
`doubleValue` | Valeur de la donnée personnalisée si le `champ` est de type booléen : 0 = Non 1 = Oui | Booléen Ex : 1 | Non

## : : Réviser un devis

Ce web service vous permet de modifier un devis correspondant aux critères renseignés dans Akuiteo depuis Salesforce. Ce web service passe le devis à l'état révisé et crée un nouveau devis rattaché au devis révisé.

Méthode : PUT devisclient/{numeroDevisInterne}/revise

Exemple : {adresse du serveur Akuiteo}/{nom de l'application Akuiteo}/RS/devisclient/CC1877788/revise

Paramètres (body) :

{

"codeSociete" : "AK",

"numeroDevisInterne" : "CC1877788",

"numeroDevisExterne" : "Num devis ext",

"codeJournal" : "VEN",

"codeClient" : "C19771",

"dateDevis" : "30/07/2018",

"codeDevise" : "EUR",

"delaiPaiement": "010",

"ligneDevis" : [

{

"regroupement" : "AK_GROUPE",

"reference" : "1101",

"quantite" : "2",

"prixUnit" : "2.26",

"codeTVA" : "01",

"codeAffaire" : "MAI00002",

"compteCG" : "706000",

}

]

}

#### Paramètres possibles

Les paramètres sont identiques à ceux pour Créer un devis.

Il y a seulement une exception pour le paramètre `numeroDevisInterne` qui est obligatoire pour la révision, alors qu'il est facultatif en création.

## : : Mettre à jour les validateurs

Ce web service vous permet de mettre à jour depuis Salesforce la liste des validateurs de niveau 1 et le validateur de niveau 2 pour un devis dans Akuiteo.

Méthode : POST devisclient/{numeroDevisInterne}/update-validators

Exemple : {adresse du serveur Akuiteo}/{nom de l'application Akuiteo}/RS/devisclient/CC1877788/update-validators

Paramètres (body) :

{

"codesCollaborateursN1": ["ADO", "AKSAS", "ERO"],

"codeCollaborateurN2" : "CPE",

"forcerMaj": false

}

#### Paramètres possibles

Paramètre | Description | Valeur | Obligatoire ?
--- | --- | --- | ---
`numeroDevisInterne` | Numéro du devis Salesforce | Caractère alphanumérique 15 caractère max. Ex : CC1877788 | Oui
`codesCollaborateursN1` | Codes des collaborateurs qui sont des validateurs de niveau 1 pour le devis | Caractère alphanumérique Ex : ABC | Oui
`codeCollaborateurN2` | Code du collaborateur qui est validateur de niveau 2 pour le devis | Caractère alphanumérique Ex : ABC | Oui
`forcerMAJ` | Forcer la mise à jour des validateurs : 0 = Non 1 = Oui | Booléen Ex : 1 | Oui

#### Retour

Réponse si OK :

{

"code": "OK",

"message": "Valideurs mis à jour",

"valueDouble": null,

"valueString": {numeroDevis},

"valueDate": null,

"status": true

}

Suivez-nous ! Produit Akuiteo version 4.2 Copyright © 2019 Akuiteo S.A.S. Documentation confidentielle | Support clients.akuiteo.fr Coordonnées Akuiteo S.A.S. 27 rue Auguste Comte 69002 LYON - FRANCE www.akuiteo.com

Afficher la Table des Matières