{"info":{"_postman_id":"ec1adda0-11a0-4510-8d58-dd67d101d713","name":"BILLJOBS — CARNET D’ADRESSES","description":"

Architecture

\n\n

Nos ressources sont regroupées sous le chemin : adresseAPI/API/json/v1.

Pour accéder à nos ressources, l'URL est constituée d'un chemin et d'une requête :

\n\n

Methode	Protocole	Adresse	Path	Version	ressource	Parametres
GET,POST ,PUT,PATCH ,DELETE	https://	127.0.0.1:8080	/API/json/	V1/	Connexion/	?Login=ee@e &MdP=Azty

\n\n

Le port d'accès au serveur d'APIs est le 8080.
Le SGBD peut être sur le même serveur (adresse IP 127.0.0.1) ou sur un autre serveur (solution moins préconisée).
adresseAPI peut donc par exemple être remplacé par ceci : 127.0.0.1:8080
Les autres éléments de la requête sont dans la description de chaque API.

\n\n

Base de données

\n\n \n

Mises à part les APIs de connexion et de déconnexion, il est obligatoire d'indiquer le nom de l'agence (en fait le nom correspondant dans la base de données).
Cette information est à indiquer dans les headers.
Pour faciliter le développement, nos headers comportent la variable {{base}} qui doit donc être définie dans l'environnement Postman utilisé.

Authentification

\n\n

Nos APIs sont sécurisées par le token de chaque utilisateur.

Une fois identifié, chaque utilisateur a le profil défini dans le logiciel Billjobs

La récupération de token est mentionnée dans la section \"Connexion\".
Le champ \"Authorization\" dans le \"Headers\" de la requête doit contenir le token retourné par la première connexion.

\n\n

Attention, la durée de vie d'un token est limitée (voir l'API de connexion à ce sujet).

Clé API

\n\n

L'accès aux jeux d'APIs est contrôlé par des clés d'API fournies par BillJobs.
Ces clés sont indiquées ici sous la désignation {{cleAPI}}.

\n\n

Envoi des données

\n\n

Pour les APIs de liste, les filtres sont passés en paramètre.

Pour les APIs de création ou de mise à jour de ressource, les données sont contenues dans un JSON passé en \"raw\" dans le \"Body\".

\n\n

Code retour

\n\n

Toutes nos APIs renvoient du JSON.

\n\n

Code Erreur

\n\n \n

Les codes d'erreur suivants sont communs à toutes les APIs (sauf celle ce connexion).

Codes	statut	description
ErreurDB	500	Erreur de base de données
ErrTokenAbsent	404	Token non transmis
ErrTokenInconnu	498	Token invalide
ErrTokenTermine	498	Token expiré
ErrNomBaseVide	403	Nom de la base de données non défini
ErrNomBaseAbsent	403	Nom de la base de données non fourni
ErrAgenceInconnue	400	La base de données indiquée n'existe pas
ErrBaseNonAccessible	403	Base de données inaccessible
ErrApiKeyAbsent	498	Clé API vide ou non fournie
ErrCleAPIInvalide	498	Clé API incorrecte
ErrTypeDonneeNonConforme	403	Le type de donnée n'est pas conforme à ce qui est attendu (string, date, double,integer ou numérique)
ErrPeriodeIncorrecte	400	La période indiquée est incorrecte
ErrAccesLectureImpossible	403	L'utilisateur n'a pas de droit de lecture de cette resource
ErrAccesCreationImpossible	403	L'utilisateur n'a pas de droit d'écriture sur cette resource
ErrAccesModificationImpossible	403	L'utilisateur n'a pas de droit de modifier cette resource
ErrAccesSuppressionImpossible	403	L'utilisateur n'a pas de droit de supprimer cette resource
ErrCommandeInconnue	404	Commande inconnue

\n\n \n \n \n

En cas d'erreurs, le JSON contient le champ 'Statut' qui reprend le code HTTP entre 400 et 500.

Code Succès

\n\n \n

En cas de succès, le JSON contient le champ 'Statut' qui reprend le code HTTP (si sa valeur est égale à 201, cela signifie que la ressource a été créée avec succès et 200 dans les autres cas).

En cas de création ou de mise à jour, la ressource est entièrement retournée dans le JSON.
En cas de suppression, le JSON contient le json \"OK\" ou \"suppressionOK\" avec, comme valeur, true ou l'ID de la ressource supprimée.

Type de données

\n\n

Les types de valeurs utilisés sont ceux définis dans la syntaxe JSON (string, number, object, array, boolean, null).

La mention dans cette documentation du type \"NUMERIQUE\" indique que la valeur transmise à nos APIs est soit du type JSON \"string\" (ex:\"1000.00\") soit du type JSON \"number\" (ex: 1000.00 ou 1000.0000000).

Dans l'autre sens, les valeurs de type \"NUMERIQUE\" retournées par nos APIs sont de type \"string\".

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Architecture","slug":"architecture"},{"content":"Base de données","slug":"base-de-donnees"},{"content":"Authentification","slug":"authentification"},{"content":"Envoi des données","slug":"envoi-des-donnees"},{"content":"Code retour","slug":"code-retour"},{"content":"Type de données","slug":"type-de-donnees"}],"owner":"6868803","collectionId":"ec1adda0-11a0-4510-8d58-dd67d101d713","publishedId":"SW7gV5LB","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-11-29T10:05:16.000Z"},"item":[{"name":"CONNEXIONS","item":[{"name":"Déconnexion","id":"67bef960-57ad-4ac7-b0d1-bd5427bf3ada","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","type":"text","value":"application/json"}],"url":"http://{{url}}/api/json/v1/Deconnexion/","description":"

API de déconnexion de l’utilisateur. Appel nécessaire pour pouvoir se reconnecter ensuite à partir de l’application BillJobs

Codes Erreurs

Cf. en tête de cette documentation.

\n","urlObject":{"protocol":"http","path":["api","json","v1","Deconnexion",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"0737555e-1870-4340-aeb6-1ecad924735d","name":"Déconnexion","originalRequest":{"method":"GET","header":[{"key":"base","type":"text","value":"bj_test17"}],"url":"http://127.0.0.1:8080/api/json/v1/Deconnexion/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Date","value":"Fri, 05 Apr 2019 14:00:04 GMT"},{"key":"Content-Length","value":"11"}],"cookie":[],"responseTime":null,"body":"{\n \"OK\": true\n}"}],"_postman_id":"67bef960-57ad-4ac7-b0d1-bd5427bf3ada"},{"name":"Liste référencés","id":"40c831af-baec-4b49-a211-c58634dc2f28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","type":"text","value":"application/json"}],"url":"http://{{url}}/api/json/v1/Serveur/Liste/","description":"

API donnant la liste des personnes déclarées pouvant utiliser BillJobs et, pour chcune d'elles, la liste de agences auxquelles elles ont accès.

Codes Erreurs

Cf. en tête de cette documentation.

\n","urlObject":{"protocol":"http","path":["api","json","v1","Serveur","Liste",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"40c831af-baec-4b49-a211-c58634dc2f28"},{"name":"Connexion","id":"7c584b5c-4195-4fa6-824b-92db6ae17dec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"

Le type MIME de la ressource

\n","type":"text"}],"body":{"mode":"file","file":{"src":""}},"url":"http://{{url}}/api/json/v1/Connexion/?Login={{loginPerso}}&MdP={{mdpPerso}}","description":"

API d’identification permettant de vérifier si l’utilisateur a le droit de se connecter. En cas de succès, elle retourne un token d'identification à fournir lors de chaque appel suivant d'API, la liste des bases BillJobs auxquelles a accès cet utilisateur et la dernière utilisée.\nLa durée de vie du token est de 10 minutes après chaque appel d'API.\nSi aucune API n'est appelée pendant ces 10 minutes, la validité du token est terminée et il faudra se reconnecter avec cette API.

Codes Erreurs

\n
\n

Exemple :{\"Erreur\":[{\"Contenu\":\"ErrLoginAbsent\"},{\"statut\":412}]}

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Codes	description
ErrLoginAbsent	Login non défini
ErrMdpAbsent	Mot de passe vide ou incorrect
ErrPersonneNonReferencee	Utilisateur non reférencé
ErrDepassementQuotaConnexions	nombre de connexions limité
ErrUtilisateurDejaConnecte	Utilisateur déja connecté
ErrTokenInconnu	Le token fourni ne correspond à rien
ErrTokenTermine	Le token fourni n'est lus valable
ErrAucuneBaseAccessible	Aucune base accessible
ErrAgenceInconnue	Agence inconnue

","urlObject":{"protocol":"http","path":["api","json","v1","Connexion",""],"host":["{{url}}"],"query":[{"description":{"content":"

Adresse email de la personne référencée de l'agence

\n","type":"text/plain"},"key":"Login","value":"{{loginPerso}}"},{"description":{"content":"

son mot de passe

\n","type":"text/plain"},"key":"MdP","value":"{{mdpPerso}}"}],"variable":[]}},"response":[{"id":"8701c07d-60ff-431a-8a21-941e114ad5a7","name":"Connexion","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://127.0.0.1:8080/api/json/v1/Connexion/?Login={{loginPerso}}&MdP={{mdpPerso}}","protocol":"http","host":["127","0","0","1"],"port":"8080","path":["api","json","v1","Connexion",""],"query":[{"key":"Login","value":"{{loginPerso}}","description":"Adresse email de la personne référencée de l'agence"},{"key":"MdP","value":"{{mdpPerso}}","description":"son mot de passe"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Date","value":"Wed, 15 May 2019 14:37:51 GMT"},{"key":"Content-Length","value":"125"}],"cookie":[],"responseTime":null,"body":"{\n \"listeAgences\": [\n {\n \"nom\": \"Test 17\",\n \"base\": \"bj_test17\"\n }\n ],\n \"token\": \"e70afcyph3p4ac2ac35qvk5sm\",\n \"nom\": \"Zigoulam ZoukouniBoudiné\"\n}"},{"id":"c01651c7-4b88-48aa-9ac0-99d6f83304a9","name":"Connexion","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"Le type MIME de la ressource","type":"text"}],"body":{"mode":"file","file":{"src":""}},"url":{"raw":"http://{{url}}/api/json/v1/Connexion/?Login={{loginPerso}}&MdP={{mdpPerso}}","protocol":"http","host":["{{url}}"],"path":["api","json","v1","Connexion",""],"query":[{"key":"Login","value":"{{loginPerso}}","description":"Adresse email de la personne référencée de l'agence"},{"key":"MdP","value":"{{mdpPerso}}","description":"son mot de passe"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Date","value":"Fri, 19 Jul 2019 12:37:43 GMT"},{"key":"Content-Length","value":"249"}],"cookie":[],"responseTime":null,"body":"{\n \"listeAgences\": [\n {\n \"nom\": \"Sonhgwane\",\n \"base\": \"bj_sonhgwane\"\n },\n {\n \"nom\": \"Test 17\",\n \"base\": \"bj_test17\"\n }\n ],\n \"derniereAgence\": {\n \"nom\": \"Oswald Orb\",\n \"schema\": \"bj_oswald_orb\"\n },\n \"token\": \"4qrywwqh047jh06599vgcef65\",\n \"nom\": \"Zongua Durand\",\n \"Adresse SGBD\": \"192.168.2.206\"\n}"}],"_postman_id":"7c584b5c-4195-4fa6-824b-92db6ae17dec"}],"id":"0a33259c-8a5c-4146-982e-d9c03fa3a368","description":"

Cette collection traite les APIs permettant de se connecter vers le serveur BillJobs ou de s'en déconnecter.

\n","event":[{"listen":"prerequest","script":{"id":"df572e06-1e2c-4269-ac6b-50ec4a00339b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9bc60476-76b6-41aa-a126-b9fdebcb9069","type":"text/javascript","exec":[""]}}],"_postman_id":"0a33259c-8a5c-4146-982e-d9c03fa3a368"},{"name":"Utilisateur","item":[{"name":"DescriptifsDroits","id":"268c3641-df0e-4347-9ce7-4a82607137eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","type":"text","value":"application/json"}],"url":"http://{{url}}/api/json/v1/Utilisateur/DescriptifsDroits/","description":"

API donnant le descriptif de l'ensemble des droits de l'utilisateur ou d'un utilisateur spécifié.

Codes Erreurs

\n\n \n \n \n \n \n \n \n \n \n \n

Codes	statut	description
ErrDroitsIDIncorrect	400	L'ID d'utilisateur indiqué n'est pas correct.

\nAutres erreurs : Cf. en tête de cette documentation.

","urlObject":{"protocol":"http","path":["api","json","v1","Utilisateur","DescriptifsDroits",""],"host":["{{url}}"],"query":[{"disabled":true,"description":{"content":"

(integer, optionnel) : Identifiant de la personne dans l'agence

\n","type":"text/plain"},"key":"id","value":"592"},{"disabled":true,"description":{"content":"

(string, optionnel) : Code ISO de la langue du descriptif soit FR, EN ou ES (inutilisé pour l'instant)

\n","type":"text/plain"},"key":"langue","value":"FR"}],"variable":[]}},"response":[{"id":"163ad453-5be9-4275-89c9-62df86e1d399","name":"DescriptifsDroits","originalRequest":{"method":"GET","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"bj_test17"},{"description":"Le type MIME de la ressource","key":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"http://127.0.0.1:8080/api/json/v1/Utilisateur/DescriptifsDroits/?id=592","protocol":"http","host":["127","0","0","1"],"port":"8080","path":["api","json","v1","Utilisateur","DescriptifsDroits",""],"query":[{"description":"(string, optionnel) : Code ISO de la langue du descriptif (inutilisé pour l'instant)","key":"langue","value":"FR","disabled":true},{"key":"id","value":"592","description":"(integer, optionnel) : Identifiant de la personne dans l'agence"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Date","value":"Fri, 14 Jun 2019 10:31:41 GMT"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"553"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalRows\": 25,\n \"personne\": \"Zigoulam ZoukouniBoudiné\",\n \"id\": \"592\",\n \"Statut\": \"Normal\",\n \"droits\": [\n {\n \"Categorie\": \"Activités\",\n \"Detail\": [\n \"Peut ajouter, modifier, supprimer et fusionner des activités et les changer de groupe\",\n \"Peut utiliser dans les pièces des activités du groupe «Frais généraux»\"\n ]\n },\n {\n \"Categorie\": \"Dossiers\",\n \"Detail\": [\n \"Peut ajuster des dossiers\",\n \"Peut archiver des dossiers\",\n \"Peut rendre ce dossier non facturable ou facturable\",\n \"Peut créer des noms de clients\",\n \"Peut lire, créer, renommer et supprimer des dossiers et gérer les coresponsables\"\n ]\n },\n {\n \"Categorie\": \"Saisie des absences\",\n \"Detail\": [\n \"Saisie de ses absences\",\n \"Saisie des absences de tout le monde\"\n ]\n },\n {\n \"Categorie\": \"Temps passés\",\n \"Detail\": [\n \"Peut créer, modifier et supprimer des temps passés\",\n \"Peut agir sur une feuille de temps, bien que n’étant pas son créateur\"\n ]\n },\n {\n \"Categorie\": \"Lignes de coûts internes\",\n \"Detail\": [\n \"Peut créer, modifier et supprimer des commandes internes\"\n ]\n },\n {\n \"Categorie\": \"Planning\",\n \"Detail\": [\n \"Peut attribuer du temps à des collaborateurs\",\n \"Peut lire et modifier les éléments du planning\",\n \"Peut voir les travaux de l’ensemble des collaborateurs\"\n ]\n }\n ]\n}"}],"_postman_id":"268c3641-df0e-4347-9ce7-4a82607137eb"},{"name":"Droits","id":"4a9d713c-03b0-40b7-a560-72a720b79fcb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","type":"text","value":"application/json"}],"url":"http://{{url}}/api/json/v1/Utilisateur/Droits/","description":"

API donnant les droits de l'utilisateur ou d'un utilisateur spécifié.
\nLes droits sont retournés sous forme de constante et de valeur.
\nLes valeurs peuvent être

soit le boolean true
soit un des chiffres suivants :
\n  1 = lecture seule
\n  2 = Lecture et modification
\n  3 = Lecture, modification et création
\n  4 = Lecture, modification, création et suppression

Codes Erreurs

\n\n \n \n \n \n \n \n \n \n

Codes	description
ErrDroitsIDIncorrect	L'ID d'utilisateur indiqué n'est pas correct.

\nAutres erreurs : Cf. en tête de cette documentation.

","urlObject":{"protocol":"http","path":["api","json","v1","Utilisateur","Droits",""],"host":["{{url}}"],"query":[{"disabled":true,"description":{"content":"

(integer, optionnel) : Identifiant de la personne dans l'agence

\n","type":"text/plain"},"key":"ID","value":"592"},{"disabled":true,"description":{"content":"

(string, optionnel) : Code ISO de la langue du descriptif (inutilisé pour l'instant)

\n","type":"text/plain"},"key":"langue","value":"FR"}],"variable":[]}},"response":[{"id":"19ae5c14-8c1c-4f97-bd40-be422f9e7b33","name":"Droits","originalRequest":{"method":"GET","header":[{"key":"base","value":"bj_test17","description":"La base de données de BillJobs","type":"text"},{"key":"Content-Type","value":"application/json","description":"Le type MIME de la ressource","type":"text"}],"url":{"raw":"http://127.0.0.1:8080/api/json/v1/Utilisateur/Droits/?ID=592","protocol":"http","host":["127","0","0","1"],"port":"8080","path":["api","json","v1","Utilisateur","Droits",""],"query":[{"key":"ID","value":"592","description":"(integer, optionnel) : Identifiant de la personne dans l'agence"},{"key":"langue","value":"FR","description":"(string, optionnel) : Code ISO de la langue du descriptif (inutilisé pour l'instant)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Date","value":"Fri, 14 Jun 2019 10:31:50 GMT"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"287"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalRows\": 25,\n \"personne\": \"Zigoulam ZoukouniBoudiné\",\n \"id\": \"592\",\n \"Statut\": \"Normal\",\n \"droits\": [\n {\n \"Activites\": [\n {\n \"acces\": 4\n },\n {\n \"accesFraisGeneraux\": true\n }\n ]\n },\n {\n \"Dossiers\": [\n {\n \"ajustement\": 4\n },\n {\n \"changerFacturable\": true\n },\n {\n \"acces\": 4\n },\n {\n \"changerArchivage\": true\n },\n {\n \"creerClient\": true\n }\n ]\n },\n {\n \"Absences\": [\n {\n \"gererSesAbsences\": true\n },\n {\n \"gererAbsencesDesAutres\": true\n }\n ]\n },\n {\n \"FdT\": [\n {\n \"acces\": 4\n },\n {\n \"modifierTempsDesAutres\": 1\n }\n ]\n },\n {\n \"Cmi\": [\n {\n \"acces\": 4\n }\n ]\n },\n {\n \"Planning\": [\n {\n \"modifierFdTDesAutres\": true\n },\n {\n \"attribuerDuTemps\": true\n },\n {\n \"acces\": 4\n }\n ]\n }\n ]\n}"}],"_postman_id":"4a9d713c-03b0-40b7-a560-72a720b79fcb"}],"id":"5d20c1ea-9695-4379-8bd2-0e354f4e4fed","_postman_id":"5d20c1ea-9695-4379-8bd2-0e354f4e4fed","description":""},{"name":"CARNET D'ADRESSES","item":[{"name":"MODÈLES DE RUBRIQUES ADDITIONNELLES","item":[{"name":"Liste des modèles de rubriques additionnelles","id":"ca136620-f501-4ed6-a46d-9d42eaca8169","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"

Votre clé API transmise par Billjobs

\n","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":""},"url":"http://{{url}}/api/json/v1/RubriquesAddit/Liste?SiAvecRubriquesContact=true&SiAvecRubriqueAdditionnelles=true","description":"

API pour obtenir une liste des modèles de rubriques additionnelles.

Le json de résultat contient 2 à 4 éléments selon la demande.

\"statut\" (toujours à 200)
\"TotalRows\" (nombre de rubriques retournées)
\"ListeRubriqueContact\" (si demandé)
\"listeRubriques\" (si demandé)

\"ListeRubriqueContact\" contient un tableau d’éléments des modèles de rubriques non modifiables fournis par BillJobs.

\"id\" : id du modèle de rubrique
\"Nom\" : nom du modèle de rubrique (à traduire dans l’application finale)

\"listeRubriques\" contient un tableau d’éléments des modèles de rubriques définis par le client pour les besoins de son agence.

\"id\": id du modèle de rubrique
\"Categorie\": fiche concernée par cette rubrique (\"entite\" ou \"personne\")
\"Nom\": nom du modèle de rubrique
\"Variable\": variable associée à ce modèle (toujours encadré de crochets) (exemple :\"[SOCRELATION]\"
\"Type\": type de donnée
\"Position\": position de la rubrique dans la liste
\"Utilise\": si présent (donc à true), indique que ce modèle de rubrique est utilisé.

Pour les rubriques de type liste ou liste + texte :

\"Elements\": liste des éléments proposés pour cette liste
\"IdElementDefaut\": id de l’élément par défaut parmi les éléments proposés
\"siAutre\": si présent (donc à true), indique pour une liste qu’il est possible de saisir une autre valeur que celles proposées.

Codes Erreurs

\n\n \n \n \n \n \n \n \n \n

Codes	description
ErrActiviteHomonyme	Activité Homonyme

\nAutres erreurs : Cf. en tête de cette documentation.","urlObject":{"protocol":"http","path":["api","json","v1","RubriquesAddit","Liste"],"host":["{{url}}"],"query":[{"disabled":true,"description":{"content":"

(integer,optionnel) identifiant de la rubrique additionnelle

\n","type":"text/plain"},"key":"id","value":"11"},{"description":{"content":"

(Boolean ,optionnel) si présent et égal à TRUE : ne liste que les rubriques de contact (téléphone, email, comptabilité, fonction)

\n","type":"text/plain"},"key":"SiAvecRubriquesContact","value":"true"},{"description":{"content":"

(Boolean ,optionnel) si présent et égal à TRUE : ne liste que les rubriques additionnelles définies dans les réglages agence

\n","type":"text/plain"},"key":"SiAvecRubriqueAdditionnelles","value":"true"},{"disabled":true,"description":{"content":"

(Boolean ,optionnel) si présent et égal à TRUE : ne liste que les rubriques additionnelles définies pour les entités

\n","type":"text/plain"},"key":"siPourEntite","value":"true"},{"disabled":true,"description":{"content":"

(Boolean ,optionnel) si présent et égal à TRUE : ne liste que les rubriques additionnelles définies pour les personnes et services

\n","type":"text/plain"},"key":"siPourPersonne","value":"true"}],"variable":[]}},"response":[],"_postman_id":"ca136620-f501-4ed6-a46d-9d42eaca8169"},{"name":"Création d’un modèle de rubrique additionnelle","id":"326364c4-a384-4d4c-b104-7c186aaa8cdb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"POST","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"

Votre clé API transmise par Billjobs

\n","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":"{\n \"nom\": \"huitième contact\",\n \"type\": \"Date\",\n \"categorie\": \"Entite\",\n \"position\": 12\n}\n"},"url":"http://{{url}}/api/json/v1/RubriquesAddit/RubriqueAddit","description":"

Cette API crée un modèle de rubrique additionnelle et retourne ses propriétés en Json

Le \"Body\" doit contenir un json décrivant la rubrique concernée.
\nLes données à transmettre dans ce JSON sont :

nom (string,obligatoire) : nom du modèle de la rubrique
type (integer,obligatoire) : Type du modèle , valeurs possibles : (\"Texte\",\"Booleen\",\"Montant\",\"Entier\",\"Date\",\"Liste\",\"ListePlusTexte\")
categorie (string,obligatoire) : catégorie du modèle, valeur possible (\"Entite\",\"Personne\")
variable (string,obligatoire) : nom de variable de ce modèle (utilisée dans les modèles d’impression)
position (integer,optionnelle) : définit la position dans la liste des rubriques, si absente, elle prend la dernière position
idElementDefaut (integer,optionnelle) : Identifiant de l’élément par défaut pour les rubriques de type \"Liste\" et \"ListePlusTexte\"
siAutre (Booleen,optionnelle) : n’intervient que sur les rubriques de type \"Liste\" et \"ListePlusTexte\", la valeur true autorise la saisie \"Hors liste\"

NB: les champs optionnels non valorisés n’ont pas besoin d'être indiqués.

En cas de succès, un json récapitulant la création est retourné (voir exemple).

Codes Erreurs

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Codes	description
ErrRubVariableAbsent	Variable du modèle de rubrique non indiqué
ErrRubTypeInconnu	Type du modèle de rubrique inconnu
ErrRubTypeAbsent	Type du modèle de rubrique non indiqué
ErrRubRubriqueDejaCreee	Un modèle de rubrique ayant ce nom existe déjà
ErrRubNomAbsent	Nom du modèle de rubrique non indiqué
ErrRubCategorieAbsente	Catégorie du modèle de rubrique non indiqué
ErrRubCategorieInconnue	Catégorie du modèle de rubrique inconnu
ErrRubPositionIncorrecte	La position indiquée est incorrecte

\nAutres erreurs : Cf. en tête de cette documentation.","urlObject":{"protocol":"http","path":["api","json","v1","RubriquesAddit","RubriqueAddit"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"0bfa87c1-78de-4c30-8d72-638cf43e4493","name":"Création d'une Rubrique additionnelle","originalRequest":{"method":"POST","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"Votre clé API transmise par Billjobs ","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":"{\n \"nom\": \"huitième contact\",\n \"type\": \"Date\",\n \"categorie\": \"Entite\",\n \"position\": 12\n}\n"},"url":"http://{{url}}/api/json/v1/RubriquesAddit/RubriqueAddit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Thu, 08 Jul 2021 13:52:27 GMT"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"151"}],"cookie":[],"responseTime":null,"body":"{\n \"statut\": 201,\n \"RubriqueAddit\": [\n {\n \"id\": 54,\n \"Categorie\": \"entite\",\n \"Nom\": \"huitième contact\",\n \"Variable\": \"[SOCHUITIEMECONTACT]\",\n \"Type\": \"date\",\n \"Position\": 12\n }\n ]\n}"}],"_postman_id":"326364c4-a384-4d4c-b104-7c186aaa8cdb"},{"name":"Création d'un élément de liste de rubrique additionnelle","id":"25b28144-2f5c-4607-a915-e8f580af70c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"POST","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"

Votre clé API transmise par Billjobs

\n","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":"{\n \"nom\": \"du boa\",\n \"position\":2,\n \"IdRub\": 44\n}\n"},"url":"http://{{url}}/api/json/v1/RubriquesAddit/RubriqueElement","description":"

Cette API crée un élément de liste pour une rubrique additionnelle.

\nLe \"Body\" doit contenir un json décrivant l’élément de la liste.
\nLes données à transmettre dans ce JSON sont :

nom (string,obligatoire) : Intitulé de l’élément
position (integer,optionnelle) : définit la position dans la liste des éléments, si absent, l’élément sera placé en queue de liste
IdRub (integer,obligatoire) : Identifiant de la rubrique additionnelle de type \"liste\" ou \"listeplustexte\"

En cas de succès, un json récapitulant la création est retourné.

Codes Erreurs

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Codes	description
ErrRubIdentifiantAbsent	Identifiant du modèle de la rubrique additionnelle non indiqué
ErrRubNomElementAbsent	Nom élément non indiqué
ErrRubIdentifiantInconnu	Identifiant du modèle de la rubrique inconnu
ErrRubElementDeRubriqueDejaCree	Il existe déjà un élément de liste ayant ce nom
ErrRubPositionElementDeRubriqueIncorrecte	La position indiquée n‘existe pas

\nAutres erreurs : Cf. en tête de cette documentation.","urlObject":{"protocol":"http","path":["api","json","v1","RubriquesAddit","RubriqueElement"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"807c3f57-2338-4c31-96b0-942a90ca748a","name":"Création d'un élément de Rubrique additionnelle","originalRequest":{"method":"POST","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"Votre clé API transmise par Billjobs ","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":"{\n \"nom\": \"du Lion\",\n \"IdRub\": 44\n}\n"},"url":"http://{{url}}/api/json/v1/RubriquesAddit/RubriqueElement"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Date","value":"Thu, 28 Nov 2019 16:04:40 GMT"},{"key":"Content-Length","value":"73"}],"cookie":[],"responseTime":null,"body":"{\n \"statut\": 201,\n \"RubriqueElement\": [\n {\n \"id\": 41,\n \"nom\": \"du Lion\",\n \"position\": 1\n }\n ]\n}"}],"_postman_id":"25b28144-2f5c-4607-a915-e8f580af70c9"},{"name":"Modification d’un modèle de rubrique additionnelle","id":"267f3c9a-904e-4a14-86eb-f7b1ae1fe2c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"PATCH","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"

Votre clé API transmise par Billjobs

\n","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":"{\n \"Id\":44,\n \"variable\": \"OCCASIONREVEE3\",\n \"type\":\"ListePlusTexte\"\n }\n"},"url":"http://{{url}}/api/json/v1/RubriquesAddit/RubriqueAddit","description":"

Cette API modifie un modèle de rubrique additionnelle et retourne ses propriétés en Json.

Le \"Body\" doit contenir un json décrivant le modèle de la rubrique additionnelle à modifier.
\nLe contenu de ce JSON est décrit dans le paragraphe \"Création d’un modèle de rubrique additionnelle\".

\nLa seule différence est la présence de la propriété supplémentaire \"ID\" :

Id (integer,obligatoire) : Identifiant du modèle de la rubrique à modifier.

Codes Erreurs

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Codes	description
ErrRubIdentifiantAbsent	ID du modèle non indiqué
ErrRubIdentifiantInconnu	ID d’un modèle inconnu de rubrique additionelle
ErrRubChangementTypeImpossible	Cette rubrique ne peut pas être modifiée

\nAutres erreurs : Cf. paragraphe \"Création d’un modèle de rubrique additionnelle\".","urlObject":{"protocol":"http","path":["api","json","v1","RubriquesAddit","RubriqueAddit"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"267f3c9a-904e-4a14-86eb-f7b1ae1fe2c9"},{"name":"Modification d'un élément d'une Rubrique additionnelle","id":"944c5062-0a2b-4b2d-a924-2e0bdb10db34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"PATCH","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"

Votre clé API transmise par Billjobs

\n","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":"{\n \"position\": 1,\n \"Id\": 41\n}\n\n"},"url":"http://{{url}}/api/json/v1/RubriquesAddit/RubriqueElement","description":"

Cet API modifie un élément d'une Rubrique additionnelle et retourne ses propriétés en Json.

Le \"Body\" doit contenir un json décrivant le modèle de la rubrique additionnelle à modifier.
\nLe contenu de ce JSON est décrit dans le paragraphe \"Création d’un élément d’une rubrique additionnelle\".

\nLa seule différence est la présence de la propriété supplémentaire \"ID\" :

Id (integer,obligatoire) : Identifiant de l’élément à modifier.

En cas de succès, un json récapitulant la modification est retourné (voir exemple).

Codes Erreurs

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n

Codes	description
ErrRubElementIdentifiantAbsent	Identifiant de l'élément non indiqué
ErrRubElementIdentifiantInconnu	Identifiant d’un élément inconnu

\nAutres erreurs : Cf. paragraphe \"Création d’un élément d’une rubrique additionnelle\".","urlObject":{"protocol":"http","path":["api","json","v1","RubriquesAddit","RubriqueElement"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"944c5062-0a2b-4b2d-a924-2e0bdb10db34"},{"name":"Suppression d’un modèle de rubrique additionnelle","id":"c60dc16b-bd7a-46ab-8390-be653183a0e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"DELETE","header":[{"description":"

La base de données de BillJobs

\n","key":"Base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","type":"text","value":"application/json"},{"description":"

Votre clé API transmise par Billjobs

\n","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":"{\"id\": 42}"},"url":"http://{{url}}/api/json/v1/RubriquesAddit/RubriqueAddit","description":"

API supprimant un modèle de rubrique additionnelle et ses éventuels éléments liés.

Le \"Body\" doit contenir un json indiquant le modèle de la rubrique à supprimer.
\nLes données à transmettre dans ce JSON sont:

Id (integer,obligatoire) : Identifiant du modèle de la rubrique à supprimer

En cas de succès, un json récapitulant la suppression est retourné (voir exemple).

Codes Erreurs

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Codes	description
ErrRubIdentifiantAbsent	Identifiant du modèle de rubrique non indiqué
ErrRubIdentifiantInconnu	Identifiant d’un modèle inconnu
ErrRubSuppressionRubriqueContactImpossible	On ne peut pas supprimer un modèle prédéfini par BillJobs

La base de données de BillJobs

\n","key":"Base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","type":"text","value":"application/json"},{"description":"

Votre clé API transmise par Billjobs

\n","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":"{\"id\": 41}\n"},"url":"http://{{url}}/api/json/v1/RubriquesAddit/RubriqueElement","description":"

API supprimant un élément d'une rubrique additionnelle de type liste.

Le \"Body\" doit contenir un json indiquant l'élément de la rubrique à supprimer.
\nLa donnée à transmettre dans ce JSON est:

Id (integer,obligatoire) : Identifiant de l'élément à supprimer

En cas de succès, un json récapitulant la suppression est retourné (voir exemple).

Codes Erreurs

\n\n \n \n \n \n \n \n \n \n \n \n \n

Codes	description
ErrRubElementIdentifiantAbsent	Identifiant élément du rubrique non indiqué
ErrRubElementIdentifiantInconnu	L’élément de rubrique indiqué par l’identifiant n’existe pas

\nAutres erreurs : Cf. en tête de cette documentation.","urlObject":{"protocol":"http","path":["api","json","v1","RubriquesAddit","RubriqueElement"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"18513996-beda-4dec-b58c-be2e863073f7","name":"Suppression d'un élément de Rubrique aditionnelle","originalRequest":{"method":"DELETE","header":[{"description":"La base de données de BillJobs","key":"Base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","type":"text","value":"application/json"},{"description":"Votre clé API transmise par Billjobs ","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":"{\"id\": 41}\n"},"url":"http://{{url}}/api/json/v1/RubriquesAddit/RubriqueElement"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Date","value":"Thu, 28 Nov 2019 16:10:40 GMT"},{"key":"Content-Length","value":"20"}],"cookie":[],"responseTime":null,"body":"{\n \"suppressionOK\": 41\n}"}],"_postman_id":"b952ba1b-9b32-4bde-b7c0-7294ad0e64cd"}],"id":"dae2a5fb-c991-4a7d-9f5c-20575f0cf6ee","description":"

EEn dehors du prénom, du nom et de l’adresse, les informations contenues dans une fiche du carnet d’adresses sont mémorisées dans des rubriques.
\nChacune de ces fiches comporte des rubriques \"fixes\" proposées par BillJobs (ce sont les rubriques dites \"contact\", \"communication\" et \"comptables\") et des rubriques \"additionnelles\" qui sont définies base par base par chaque client.
\nLes rubriques fixes sont non modifiables et gérés par BillJobs.

\nConcernant les rubriques additionnelles, il s’agit par exemple d’un type de relation (client, fournisseur), un RIB bancaire ou bien une date.
\nIl existe deux catégories de rubriques additionnelles, celles pour les entités et celles pour les personnes et services.
\nAvant de valoriser une rubrique dans une fiche de carnet d’adresses, il convient de définir son modèle. Les APIs de ce groupe permettent d’ajouter, de modifier ou de supprimer ces modèles de rubriques.\n
\nUne définition d’un modèle de rubrique comporte son nom, son type (\"texte\", \"montant\", \"entier\", \"date\", \"case à cocher\", \"liste\", \"listeplustexte\", \"separateur\"), un nom de variable pour être utilisé dans les modèles d’impression et une position au sein de la liste des rubriques.

Les rubriques de type \"Liste\" peuvent avoir une liste d’éléments prédéfinis et autoriser ou non la saisie de valeurs hors liste.\nExemple pour une rubrique \"relation\"\nLes éléments \"Client\", \"Prospect\" peuvent être prédéfinis.\nMais, si l’option \"Saisie hors liste possible\" est choisie, il sera possible de saisir un texte libre comme \"Fournisseur\" ou \"Administration\".

Un \"separateur\" est un type spécial qui permet de séparer par une ligne des groupes de rubriques dans l’affichage de ces dernières.\n

\nLes modèles de rubriques additionnelles ne peuvent être créés, modifiés ou supprimés qu’avec un profil utilisateur d’administrateur.

\n","event":[{"listen":"prerequest","script":{"id":"281445e9-5597-4b4b-b4b5-8fee005a70a8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d23d7119-eb14-4cc9-8801-6d892275fc73","type":"text/javascript","exec":[""]}}],"_postman_id":"dae2a5fb-c991-4a7d-9f5c-20575f0cf6ee"},{"name":"Civilités","item":[{"name":"Liste des civilités","id":"7856c4db-afcf-4070-b47a-d82baeed0a6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"

Votre clé API transmise par Billjobs

\n","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":""},"url":"http://{{url}}/api/json/v1/Civilites/Liste","description":"

API pour obtenir la liste des civilités de BillJobs et celles personnalisées enregistrées dans l’agence.

codeCivilite : code indépendant de la langue, identifiant la civilité.\nsiFemme : civilité concernant une femme.\nid : identifiant de la civilité, uniquement pour les civilités personnalisées.\nFR, EN, ES : les différents textes de la civilité regroupés par langue.

titreCourt : abréviation standard de la civilité.\ntitreLong : nom complet de la civilité.\ndetail : nom complet avec l’information Femme ou Homme (pour choix parmi une liste).

{\n        \"codeCivilite\": \"FMme\",\n        \"FR\": {\n            \"titreCourt\": \"Mme\",\n            \"titreLong\": \"Madame\",\n            \"detail\": \"Madame\"\n        },\n        \"EN\": {\n            \"titreCourt\": \"Mrs\",\n            \"titreLong\": \"Misses\",\n            \"detail\": \"Mrs.\"\n        },\n        \"ES\": {\n            \"titreCourt\": \"Sra\",\n            \"titreLong\": \"Señora\",\n            \"detail\": \"Señora\"\n        },\n        \"siFemme\": true\n    }

\n\n\n

Codes Erreurs

\n\n \n \n \n \n \n \n \n \n

Codes	description
ErrActiviteHomonyme	Activité Homonyme

\nAutres erreurs : Cf. en tête de cette documentation.","urlObject":{"protocol":"http","path":["api","json","v1","Civilites","Liste"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7856c4db-afcf-4070-b47a-d82baeed0a6d"},{"name":"Ajouter une civilité","id":"1eb3acc9-dd87-4e47-95c2-5a8430e3a679","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"POST","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"

Votre clé API transmise par Billjobs

\n","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":"{\n\"codeCivilite\": \"FMise\",\n\"FR\" : {\n\"titreCourt\": \"Mise\",\n\"titreLong\": \"Marquise\",\n\"detail\": \"Marquise (femme)\"\n},\n\"siFemme\": true\n}"},"url":"http://{{url}}/api/json/v1/Civilites/Ajouter","description":"

API pour ajouter une civilité personnalisée dans l’agence.

codeCivilite : (string, obligatoire) code indépendant de la langue, identifiant la civilité.
siFemme : (booléen, optionnel) civilité concernant une femme.
FR, EN, ES : les différents textes de la civilité regroupés par langue. Si FR est obligatoire, il n’est pas nécessaire de valoriser les autres langues.\n
Et, pour chaque langue :
titreCourt : (string, obligatoire)abréviation standard de la civilité.
titreLong : (string, obligatoire)nom complet de la civilité.
detail : (string, obligatoire) nom complet avec l’information Femme ou Homme (pour choix parmi une liste).

{\n        \"codeCivilite\": \"FMme\",\n        \"FR\": {\n            \"titreCourt\": \"Mme\",\n            \"titreLong\": \"Madame\",\n            \"detail\": \"Madame\"\n        },\n        \"EN\": {\n            \"titreCourt\": \"Mrs\",\n            \"titreLong\": \"Misses\",\n            \"detail\": \"Mrs.\"\n        },\n        \"ES\": {\n            \"titreCourt\": \"Sra\",\n            \"titreLong\": \"Señora\",\n            \"detail\": \"Señora\"\n        },\n        \"siFemme\": true\n    }

\n\n

En cas de succès, le json de la civilité est retourné.

Codes Erreurs

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Codes	description
ErrCiviliteCodeAbsent	Code civilité non indiqué
ErrCiviliteBillJobs	Code civilité utilisé pour une civilité BillJobs
ErrCiviliteExistante	Code civilité personnalisée déjà existante
ErrCiviliteFRAbsent	Civilité française absente
ErrCiviliteFRTitreAbsent	Le titre court ou le titre long français n’est pas indiqué
ErrCiviliteENTitreAbsent	Si EN est présent, le titre court ou le titre long anglais n’est pas indiqué
ErrCiviliteESTitreAbsent	Si ES est présent, le titre court ou le titre long espagnol n’est pas indiqué

\nAutres erreurs : Cf. en tête de cette documentation.","urlObject":{"protocol":"http","path":["api","json","v1","Civilites","Ajouter"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"4f6d8767-32fe-4eb3-bf58-4c6e3b452483","name":"Ajouter une civilité","originalRequest":{"method":"POST","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"Votre clé API transmise par Billjobs ","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":"{\n\"codeCivilite\": \"FMise\",\n\"FR\" : {\n\"titreCourt\": \"Mise\",\n\"titreLong\": \"Marquise\",\n\"detail\": \"Marquise (femme)\"\n},\n\"siFemme\": true\n}"},"url":"http://{{url}}/api/json/v1/Civilites/Ajouter"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Mon, 12 Jul 2021 10:24:01 GMT"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"127"}],"cookie":[],"responseTime":null,"body":"{\n \"codeCivilite\": \"FMise\",\n \"FR\": {\n \"titreCourt\": \"Mise\",\n \"titreLong\": \"Marquise\",\n \"detail\": \"Marquise (femme)\"\n },\n \"siFemme\": true,\n \"id\": 1663\n}"}],"_postman_id":"1eb3acc9-dd87-4e47-95c2-5a8430e3a679"},{"name":"Modifier une civilité","id":"3c4683d4-d4a3-475b-a85c-75facfbfa446","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"PATCH","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"

Votre clé API transmise par Billjobs

\n","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":"{\n\"id\": 1661,\n\"codeCivilite\": \"FMisr\",\n\"FR\" : {\n\"titreCourt\": \"Mise\",\n\"titreLong\": \"Belle Marquise\",\n\"detail\": \"Belle Marquise (femme)\"\n},\n\"siFemme\": true\n}"},"url":"http://{{url}}/api/json/v1/Civilites/Modifier","description":"

API pour modifier une civilité personnalisée dans l’agence.

id : (integer, obligatoire) : identifiant de la civilité.
codeCivilite : (string, optionnel) code indépendant de la langue, identifiant la civilité. On ne peut le changer que si la civilité n‘a pas déjà été attribuée à une personne.\nPour les autres propriétés se reporter au paragraphe \"Ajouter une civilité\".

En cas de succès, le json de la civilité est retourné.

Codes Erreurs

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Codes	description
ErrCiviliteIDAbsent	Identifiant de la civilité non indiqué
ErrCiviliteInexistante	La civilité personnalisée indiquée n‘existe pas
ErrCiviliteCodeDejaAttribue	La civilité indiquée est attribuée à au moins une personne
ErrCiviliteBillJobs	Code de civilité utilisé pour une civilité BillJobs
ErrCiviliteExistante	Ce code de civilité personnalisée existe déjà

\nAutres erreurs : Cf. paragraphe \"Ajouter une civilité\" et en tête de cette documentation.","urlObject":{"protocol":"http","path":["api","json","v1","Civilites","Modifier"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"a17ccf1c-85ec-4633-88db-f00c256bc0fa","name":"Modifier une civilité","originalRequest":{"method":"PATCH","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"Votre clé API transmise par Billjobs ","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":"{\n\"id\": 1663,\n\"codeCivilite\": \"FMisr\",\n\"FR\" : {\n\"titreCourt\": \"Mise\",\n\"titreLong\": \"Belle Marquise\",\n\"detail\": \"Belle Marquise (femme)\"\n},\n\"siFemme\": true\n}"},"url":"http://{{url}}/api/json/v1/Civilites/Modifier"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Mon, 12 Jul 2021 10:24:20 GMT"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"139"}],"cookie":[],"responseTime":null,"body":"{\n \"codeCivilite\": \"FMisr\",\n \"FR\": {\n \"titreCourt\": \"Mise\",\n \"titreLong\": \"Belle Marquise\",\n \"detail\": \"Belle Marquise (femme)\"\n },\n \"siFemme\": true,\n \"id\": 1663\n}"}],"_postman_id":"3c4683d4-d4a3-475b-a85c-75facfbfa446"},{"name":"Supprimer une civilité","id":"5f358f50-e726-4df9-82b1-90d47a5c1ed8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"DELETE","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"

Votre clé API transmise par Billjobs

\n","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":"{\n\"id\": 1663\n}"},"url":"http://{{url}}/api/json/v1/Civilites/Supprimer","description":"

API pour supprimer une civilité personnalisée dans l’agence.

id : (integer, obligatoire) : identifiant de la civilité.

En cas de succès, suppressionOK est retourné avec l’id de la civilité supprimée.

Codes Erreurs

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Codes	description
ErrCiviliteIDAbsent	Identifiant de la civilité non indiqué
ErrCiviliteInexistante	La civilité personnalisée indiquée n‘existe pas
ErrCiviliteAttribueeNonSupprimable	La civilité indiquée est attribuée à au moins une personne

\nAutres erreurs : Cf. en tête de cette documentation.","urlObject":{"protocol":"http","path":["api","json","v1","Civilites","Supprimer"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"2a76b56a-4c69-4360-8a58-11f01129b77f","name":"Supprimer une civilité","originalRequest":{"method":"DELETE","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"Votre clé API transmise par Billjobs ","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":"{\n\"id\": 1663\n}"},"url":"http://{{url}}/api/json/v1/Civilites/Supprimer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Mon, 12 Jul 2021 10:26:10 GMT"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"11"}],"cookie":[],"responseTime":null,"body":"{\n \"OK\": 1663\n}"}],"_postman_id":"5f358f50-e726-4df9-82b1-90d47a5c1ed8"}],"id":"920071c8-0ba2-4ae3-8061-82008a95349b","description":"

Les civilités sont utilisées principalement pour les adresses dans les modèles d’impression.

\nIl existe deux catégories de civilités : celles non modifiables fournies par BillJobs(Madame, Mademoiselle, Monsieur, Maître, Docteur, Professeur) et les civilités personnalisées que l’on ajoute pour chaque agence.

\nPour chaque civilité, il y a un code, un titre court (Prf), un titre long (Professeur) et un texte de détail (Professeur (femme)).\nCe dernier pouvant servir à la sélection dans un menu.

\nLes civilités personnalisées ont en outre un entier identifiant afin de pouvoir les modifier ou les supprimer.\nLes civilités de BillJobs sont en trois langues (français, espagnol, anglais).\nLes civilités personnalisées peuvent n’être qu’en une ou deux langues. Le français est toutefois obligatoire.

\n","_postman_id":"920071c8-0ba2-4ae3-8061-82008a95349b"},{"name":"FICHES ADRESSES","item":[{"name":"Liste par entité","id":"bee4bce5-93ab-4e08-9b33-03be0f57fefa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","type":"text","value":"application/json"}],"url":"http://{{url}}/api/json/v1/Adresses/ListeEntites/?$start=A&siAvecAdresse=true&siAvecRubriquesContacts=true&siPeuple=true","description":"

API donnant une liste de fiches d’entités ou d’indépendants du carnet d’adresses.\n
\nLes paramètres permettent de définir les critères de sélection des fiches et leur affichage.
\n
\nLe critère de recherche porte sur un mot contenu dans la fiche (prénom, nom, nom de l’entité, élément de l’adresse ou rubrique additionnelle).
\nCe critère unique est soit \"$eq\" soit \"$lk\" soit \"$start\".

\n\n\n\n\n\n\n\n\n\n\n\n

$eq	est égal à
$lk	contient	(pour une string)
$start	commence par	(pour une string)

\n

\n\n
\n\n

Codes Erreurs

Cf. en tête de cette documentation.

\n","urlObject":{"protocol":"http","path":["api","json","v1","Adresses","ListeEntites",""],"host":["{{url}}"],"query":[{"description":{"content":"

(string ,optionnel) si indiqué : filtre les fiches dont une information commence par cette valeur

\n","type":"text/plain"},"key":"$start","value":"A"},{"disabled":true,"description":{"content":"

(string ,optionnel) si indiqué : filtre les fiches dont une information contient cette valeur

\n","type":"text/plain"},"key":"$lk","value":"Gont"},{"disabled":true,"description":{"content":"

(string ,optionnel) si indiqué : filtre les fiches dont une information est égale à cette valeur

\n","type":"text/plain"},"key":"$eq","value":"Exe"},{"disabled":true,"description":{"content":"

(string, optionnel, valeurs possibles : parVille, parNom)

\n","type":"text/plain"},"key":"tri","value":"parVille"},{"disabled":true,"description":{"content":"

(integer, optionnel ou obligatoire si le critère \"page\" est fourni) nombre de lignes par plage

\n","type":"text/plain"},"key":"per_page","value":"1"},{"disabled":true,"description":{"content":"

(integer, optionnel ou obligatoire si le critère \"per_page\" est fourni) numéro de la plage

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

(boolean, optionnel) si valorisé : ajoute l’adresse

\n","type":"text/plain"},"key":"siAvecAdresse","value":"true"},{"description":{"content":"

(boolean, optionnel) si indiqué : ajoute les informations de communication (téléphone, email, fonction)

\n","type":"text/plain"},"key":"siAvecRubriquesContacts","value":"true"},{"disabled":true,"description":{"content":"

(boolean, optionnel) si indiqué : ajoute les informations de comptabilité (si la personne connectée en a les droits)

\n","type":"text/plain"},"key":"siAvecRubriquesComptabilite","value":"true"},{"disabled":true,"description":{"content":"

(boolean, optionnel) si indiqué : ajoute les informations des rubriques additionnelles

\n","type":"text/plain"},"key":"siAvecRubriquesAdditionelles","value":"true"},{"disabled":true,"description":{"content":"

(boolean, optionnel) si indiqué : la liste ne comprendra que les indépendants

\n","type":"text/plain"},"key":"siIndependantsSeuls","value":"true"},{"description":{"content":"

(boolean, optionnel) si indiqué et à true, une indication qu’une entité contient des services ou des personnes est ajoutée.

\n","type":"text/plain"},"key":"siPeuple","value":"true"}],"variable":[]}},"response":[{"id":"a0199af3-2283-4557-a0b7-e991b4b59871","name":"Liste","originalRequest":{"method":"GET","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"http://{{url}}/api/json/v1/Adresses/Liste/?id=162&siAvecMembres=true","protocol":"http","host":["{{url}}"],"path":["api","json","v1","Adresses","Liste",""],"query":[{"key":"$start","value":"TE","description":"(string ,optionnel) si indiqué : filtre les fiches dont un élément commence par cette valeur","disabled":true},{"key":"$lk","value":"Gont","description":"(string ,optionnel) si indiqué : filtre les fiches dont un élément contient cette valeur","disabled":true},{"description":"(string ,optionnel) si indiqué : filtre les fiches dont un élément est égal à cette valeur","key":"$eq","value":"Exe","disabled":true},{"key":"tri","value":"parVille","description":"(string, optionnel, valeurs possibles : parVille, parNom)","disabled":true},{"key":"per_page","value":"1","description":"(integer, optionnel ou obligatoire si le critère \"page\" est fourni) nombre de lignes par plage","disabled":true},{"key":"page","value":"1","description":"(integer, optionnel ou obligatoire si le critère \"per_page\" est fourni) numéro de la plage","disabled":true},{"key":"siAvecAdresse","value":"true","description":"(boolean, optionnel) si valorisé : ajoute l'adresse","disabled":true},{"key":"siAvecRubriquesContacts","value":"true","description":"(boolean, optionnel) si indiqué : ajoute les informations \"de contacts\" (téléphone, email, fonction)","disabled":true},{"key":"siAvecRubriquesComptabilite","value":"true","description":"(boolean, optionnel) si indiqué : ajoute les informations de comptabilité (si la personne connectée en a les droits)","disabled":true},{"key":"siAvecRubriquesAdditionelles","value":"true","description":"(boolean, optionnel) si indiqué : ajoute les informations des rubriques additionnelles","disabled":true},{"key":"siIndependantsSeuls","value":"true","description":"(boolean, optionnel) si indiqué : la liste ne comprendra que les indépendants","disabled":true},{"key":"id","value":"162","description":"(integer, optionnel) si indiqué : affiche le détail d'une fiche."},{"key":"siAvecMembres","value":"true","description":"(boolean, optionnel si ID est spécifié, inutile sinon) : affiche la hiérarchie de la fiche"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Date","value":"Thu, 28 Nov 2019 16:13:52 GMT"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"291"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalRows\": 4,\n \"Entite\": {\n \"id\": 160,\n \"nom\": \"Art & Fenêtres\",\n \"adresse\": {\n \"rue\": \"1 rue de la Paix\",\n \"cp\": \"75002\",\n \"ville\": \"Rome\",\n \"pays\": \"Italie\",\n \"isopays\": \"IT\"\n },\n \"membres\": [\n {\n \"type\": \"Service\",\n \"id\": 162,\n \"nom\": \"service comptabilité\",\n \"adresse\": {\n \"rue\": \"2 rue de la paix\",\n \"cp\": \"00100\",\n \"ville\": \"Rome\",\n \"pays\": \"Italie\",\n \"isopays\": \"IT\"\n },\n \"membres\": [\n {\n \"type\": \"Personne\",\n \"id\": 163,\n \"prenom\": \"Maria\",\n \"nom\": \"Rossi\",\n \"civilite\": \"Madame\",\n \"sexe\": \"F\"\n },\n {\n \"type\": \"Personne\",\n \"id\": 725,\n \"prenom\": \"Julio\",\n \"nom\": \"Lofiss-Modi\",\n \"civilite\": \"Maître\",\n \"sexe\": \"M\"\n }\n ]\n }\n ]\n }\n}"}],"_postman_id":"bee4bce5-93ab-4e08-9b33-03be0f57fefa"},{"name":"Liste globale","id":"ce8a8d93-7436-44fc-8e60-959fa7e5b155","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","type":"text","value":"application/json"}],"url":"http://{{url}}/api/json/v1/Adresses/ListeTout/","description":"

API donnant une liste de fiches d’entités, d’indépendant, personnes et de services du carnet d’adresses.\n
\nPour le reste de la documentation, se reporter au paragraphe \"Liste par entité\".

\n","urlObject":{"protocol":"http","path":["api","json","v1","Adresses","ListeTout",""],"host":["{{url}}"],"query":[{"disabled":true,"description":{"content":"

(string ,optionnel) si indiqué : filtre les fiches dont une information commence par cette valeur

\n","type":"text/plain"},"key":"$start","value":""},{"disabled":true,"description":{"content":"

(string ,optionnel) si indiqué : filtre les fiches dont une information contient cette valeur

\n","type":"text/plain"},"key":"$lk","value":"Gont"},{"disabled":true,"description":{"content":"

(string ,optionnel) si indiqué : filtre les fiches dont une information est égale à cette valeur

\n","type":"text/plain"},"key":"$eq","value":"Exe"},{"disabled":true,"description":{"content":"

(string, optionnel, valeurs possibles : parVille, parNom)

\n","type":"text/plain"},"key":"tri","value":"parNom"},{"disabled":true,"description":{"content":"

(integer, optionnel ou obligatoire si le critère \"page\" est fourni) nombre de lignes par plage

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

(integer, optionnel ou obligatoire si le critère \"per_page\" est fourni) numéro de la plage

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

(boolean, optionnel) si valorisé : ajoute l’adresse

\n","type":"text/plain"},"key":"siAvecAdresse","value":"true"},{"disabled":true,"description":{"content":"

(boolean, optionnel) si indiqué : ajoute les informations de communication (téléphone, email, fonction)

\n","type":"text/plain"},"key":"siAvecRubriquesContacts","value":"true"},{"disabled":true,"description":{"content":"

(boolean, optionnel) si indiqué : ajoute les informations de comptabilité (si la personne connectée en a les droits)

\n","type":"text/plain"},"key":"siAvecRubriquesComptabilite","value":"true"},{"disabled":true,"description":{"content":"

(boolean, optionnel) si indiqué : ajoute les informations des rubriques additionnelles

\n","type":"text/plain"},"key":"siAvecRubriquesAdditionelles","value":"true"},{"disabled":true,"description":{"content":"

(boolean, optionnel) si indiqué et à true, une indication qu’une entité ou un service contiennentt des services ou des personnes est ajoutée.

\n","type":"text/plain"},"key":"siPeuple","value":"true"},{"disabled":true,"description":{"content":"

(boolean, optionnel) si indiqué à false, l'affichage ne contient que les informations (nom,prénom,Id,Type)

\n","type":"text/plain"},"key":"SiAvecDetails","value":"false"}],"variable":[]}},"response":[{"id":"967f4bdf-ab02-4fc2-a8de-2b6181c5dcda","name":"Liste","originalRequest":{"method":"GET","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"http://{{url}}/api/json/v1/Adresses/Liste/?id=162&siAvecMembres=true","protocol":"http","host":["{{url}}"],"path":["api","json","v1","Adresses","Liste",""],"query":[{"key":"$start","value":"TE","description":"(string ,optionnel) si indiqué : filtre les fiches dont un élément commence par cette valeur","disabled":true},{"key":"$lk","value":"Gont","description":"(string ,optionnel) si indiqué : filtre les fiches dont un élément contient cette valeur","disabled":true},{"description":"(string ,optionnel) si indiqué : filtre les fiches dont un élément est égal à cette valeur","key":"$eq","value":"Exe","disabled":true},{"key":"tri","value":"parVille","description":"(string, optionnel, valeurs possibles : parVille, parNom)","disabled":true},{"key":"per_page","value":"1","description":"(integer, optionnel ou obligatoire si le critère \"page\" est fourni) nombre de lignes par plage","disabled":true},{"key":"page","value":"1","description":"(integer, optionnel ou obligatoire si le critère \"per_page\" est fourni) numéro de la plage","disabled":true},{"key":"siAvecAdresse","value":"true","description":"(boolean, optionnel) si valorisé : ajoute l'adresse","disabled":true},{"key":"siAvecRubriquesContacts","value":"true","description":"(boolean, optionnel) si indiqué : ajoute les informations \"de contacts\" (téléphone, email, fonction)","disabled":true},{"key":"siAvecRubriquesComptabilite","value":"true","description":"(boolean, optionnel) si indiqué : ajoute les informations de comptabilité (si la personne connectée en a les droits)","disabled":true},{"key":"siAvecRubriquesAdditionelles","value":"true","description":"(boolean, optionnel) si indiqué : ajoute les informations des rubriques additionnelles","disabled":true},{"key":"siIndependantsSeuls","value":"true","description":"(boolean, optionnel) si indiqué : la liste ne comprendra que les indépendants","disabled":true},{"key":"id","value":"162","description":"(integer, optionnel) si indiqué : affiche le détail d'une fiche."},{"key":"siAvecMembres","value":"true","description":"(boolean, optionnel si ID est spécifié, inutile sinon) : affiche la hiérarchie de la fiche"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Date","value":"Thu, 28 Nov 2019 16:13:52 GMT"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"291"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalRows\": 4,\n \"Entite\": {\n \"id\": 160,\n \"nom\": \"Art & Fenêtres\",\n \"adresse\": {\n \"rue\": \"1 rue de la Paix\",\n \"cp\": \"75002\",\n \"ville\": \"Rome\",\n \"pays\": \"Italie\",\n \"isopays\": \"IT\"\n },\n \"membres\": [\n {\n \"type\": \"Service\",\n \"id\": 162,\n \"nom\": \"service comptabilité\",\n \"adresse\": {\n \"rue\": \"2 rue de la paix\",\n \"cp\": \"00100\",\n \"ville\": \"Rome\",\n \"pays\": \"Italie\",\n \"isopays\": \"IT\"\n },\n \"membres\": [\n {\n \"type\": \"Personne\",\n \"id\": 163,\n \"prenom\": \"Maria\",\n \"nom\": \"Rossi\",\n \"civilite\": \"Madame\",\n \"sexe\": \"F\"\n },\n {\n \"type\": \"Personne\",\n \"id\": 725,\n \"prenom\": \"Julio\",\n \"nom\": \"Lofiss-Modi\",\n \"civilite\": \"Maître\",\n \"sexe\": \"M\"\n }\n ]\n }\n ]\n }\n}"}],"_postman_id":"ce8a8d93-7436-44fc-8e60-959fa7e5b155"},{"name":"Liste globale Pour AutoCompletion","id":"3dabc21a-cf65-4d70-83db-e92a149bccc8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","type":"text","value":"application/json"}],"url":"http://{{url}}/api/json/v1/Adresses/ListePourAutoCompletion/?$lk=françois&per_page=3&page=2","description":"

\n","urlObject":{"protocol":"http","path":["api","json","v1","Adresses","ListePourAutoCompletion",""],"host":["{{url}}"],"query":[{"disabled":true,"description":{"content":"

(string ,optionnel) si indiqué : filtre les fiches dont une information commence par cette valeur

\n","type":"text/plain"},"key":"$start","value":"fran"},{"description":{"content":"

(string ,optionnel) si indiqué : filtre les fiches dont une information contient cette valeur

\n","type":"text/plain"},"key":"$lk","value":"françois"},{"disabled":true,"description":{"content":"

(string ,optionnel) si indiqué : filtre les fiches dont une information est égale à cette valeur

\n","type":"text/plain"},"key":"$eq","value":"Exe"},{"disabled":true,"description":{"content":"

(string, optionnel, valeurs possibles : parVille, parNom)

\n","type":"text/plain"},"key":"tri","value":"parNom"},{"description":{"content":"

(integer, optionnel ou obligatoire si le critère \"page\" est fourni) nombre de lignes par plage

\n","type":"text/plain"},"key":"per_page","value":"3"},{"description":{"content":"

(integer, optionnel ou obligatoire si le critère \"per_page\" est fourni) numéro de la plage

\n","type":"text/plain"},"key":"page","value":"2"}],"variable":[]}},"response":[{"id":"48090ca9-8af4-4772-9079-c2ee2718ec00","name":"Liste","originalRequest":{"method":"GET","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"http://{{url}}/api/json/v1/Adresses/Liste/?id=162&siAvecMembres=true","protocol":"http","host":["{{url}}"],"path":["api","json","v1","Adresses","Liste",""],"query":[{"key":"$start","value":"TE","description":"(string ,optionnel) si indiqué : filtre les fiches dont un élément commence par cette valeur","disabled":true},{"key":"$lk","value":"Gont","description":"(string ,optionnel) si indiqué : filtre les fiches dont un élément contient cette valeur","disabled":true},{"description":"(string ,optionnel) si indiqué : filtre les fiches dont un élément est égal à cette valeur","key":"$eq","value":"Exe","disabled":true},{"key":"tri","value":"parVille","description":"(string, optionnel, valeurs possibles : parVille, parNom)","disabled":true},{"key":"per_page","value":"1","description":"(integer, optionnel ou obligatoire si le critère \"page\" est fourni) nombre de lignes par plage","disabled":true},{"key":"page","value":"1","description":"(integer, optionnel ou obligatoire si le critère \"per_page\" est fourni) numéro de la plage","disabled":true},{"key":"siAvecAdresse","value":"true","description":"(boolean, optionnel) si valorisé : ajoute l'adresse","disabled":true},{"key":"siAvecRubriquesContacts","value":"true","description":"(boolean, optionnel) si indiqué : ajoute les informations \"de contacts\" (téléphone, email, fonction)","disabled":true},{"key":"siAvecRubriquesComptabilite","value":"true","description":"(boolean, optionnel) si indiqué : ajoute les informations de comptabilité (si la personne connectée en a les droits)","disabled":true},{"key":"siAvecRubriquesAdditionelles","value":"true","description":"(boolean, optionnel) si indiqué : ajoute les informations des rubriques additionnelles","disabled":true},{"key":"siIndependantsSeuls","value":"true","description":"(boolean, optionnel) si indiqué : la liste ne comprendra que les indépendants","disabled":true},{"key":"id","value":"162","description":"(integer, optionnel) si indiqué : affiche le détail d'une fiche."},{"key":"siAvecMembres","value":"true","description":"(boolean, optionnel si ID est spécifié, inutile sinon) : affiche la hiérarchie de la fiche"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Date","value":"Thu, 28 Nov 2019 16:13:52 GMT"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"291"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalRows\": 4,\n \"Entite\": {\n \"id\": 160,\n \"nom\": \"Art & Fenêtres\",\n \"adresse\": {\n \"rue\": \"1 rue de la Paix\",\n \"cp\": \"75002\",\n \"ville\": \"Rome\",\n \"pays\": \"Italie\",\n \"isopays\": \"IT\"\n },\n \"membres\": [\n {\n \"type\": \"Service\",\n \"id\": 162,\n \"nom\": \"service comptabilité\",\n \"adresse\": {\n \"rue\": \"2 rue de la paix\",\n \"cp\": \"00100\",\n \"ville\": \"Rome\",\n \"pays\": \"Italie\",\n \"isopays\": \"IT\"\n },\n \"membres\": [\n {\n \"type\": \"Personne\",\n \"id\": 163,\n \"prenom\": \"Maria\",\n \"nom\": \"Rossi\",\n \"civilite\": \"Madame\",\n \"sexe\": \"F\"\n },\n {\n \"type\": \"Personne\",\n \"id\": 725,\n \"prenom\": \"Julio\",\n \"nom\": \"Lofiss-Modi\",\n \"civilite\": \"Maître\",\n \"sexe\": \"M\"\n }\n ]\n }\n ]\n }\n}"}],"_postman_id":"3dabc21a-cf65-4d70-83db-e92a149bccc8"},{"name":"Liste par personne","id":"21e2e908-aa0e-4539-bca5-156721cd0cfd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","type":"text","value":"application/json"}],"url":"http://{{url}}/api/json/v1/Adresses/ListePersonnes/","description":"

API donnant une liste de fiches de personnes et d’indépendants du carnet d’adresses.\n
\nPour le reste de la documentation, se reporter au paragraphe \"Liste par entité\".

\n","urlObject":{"protocol":"http","path":["api","json","v1","Adresses","ListePersonnes",""],"host":["{{url}}"],"query":[{"disabled":true,"description":{"content":"

(string ,optionnel) si indiqué : filtre les fiches dont un élément commence par cette valeur

\n","type":"text/plain"},"key":"$start","value":"TE"},{"disabled":true,"description":{"content":"

(string ,optionnel) si indiqué : filtre les fiches dont un élément contient cette valeur

\n","type":"text/plain"},"key":"$lk","value":"Gont"},{"disabled":true,"description":{"content":"

(string ,optionnel) si indiqué : filtre les fiches dont un élément est égal à cette valeur

\n","type":"text/plain"},"key":"$eq","value":"Exe"},{"disabled":true,"description":{"content":"

(string, optionnel, valeurs possibles : parVille, parNom)

\n","type":"text/plain"},"key":"tri","value":"parVille"},{"disabled":true,"description":{"content":"

(integer, optionnel ou obligatoire si le critère \"page\" est fourni) nombre de lignes par plage

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

(integer, optionnel ou obligatoire si le critère \"per_page\" est fourni) numéro de la plage

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

(boolean, optionnel) si valorisé : ajoute l'adresse

\n","type":"text/plain"},"key":"siAvecAdresse","value":"true"},{"disabled":true,"description":{"content":"

(boolean, optionnel) si indiqué : ajoute les informations \"de contacts\" (téléphone, email, fonction)

\n","type":"text/plain"},"key":"siAvecRubriquesContacts","value":"true"},{"disabled":true,"description":{"content":"

(boolean, optionnel) si indiqué : ajoute les informations de comptabilité (si la personne connectée en a les droits)

\n","type":"text/plain"},"key":"siAvecRubriquesComptabilite","value":"true"},{"disabled":true,"description":{"content":"

(boolean, optionnel) si indiqué : ajoute les informations des rubriques additionnelles

\n","type":"text/plain"},"key":"siAvecRubriquesAdditionelles","value":"true"}],"variable":[]}},"response":[{"id":"4346f092-00d4-4450-9813-17afbde4daf8","name":"Liste","originalRequest":{"method":"GET","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"http://{{url}}/api/json/v1/Adresses/Liste/?id=162&siAvecMembres=true","protocol":"http","host":["{{url}}"],"path":["api","json","v1","Adresses","Liste",""],"query":[{"key":"$start","value":"TE","description":"(string ,optionnel) si indiqué : filtre les fiches dont un élément commence par cette valeur","disabled":true},{"key":"$lk","value":"Gont","description":"(string ,optionnel) si indiqué : filtre les fiches dont un élément contient cette valeur","disabled":true},{"description":"(string ,optionnel) si indiqué : filtre les fiches dont un élément est égal à cette valeur","key":"$eq","value":"Exe","disabled":true},{"key":"tri","value":"parVille","description":"(string, optionnel, valeurs possibles : parVille, parNom)","disabled":true},{"key":"per_page","value":"1","description":"(integer, optionnel ou obligatoire si le critère \"page\" est fourni) nombre de lignes par plage","disabled":true},{"key":"page","value":"1","description":"(integer, optionnel ou obligatoire si le critère \"per_page\" est fourni) numéro de la plage","disabled":true},{"key":"siAvecAdresse","value":"true","description":"(boolean, optionnel) si valorisé : ajoute l'adresse","disabled":true},{"key":"siAvecRubriquesContacts","value":"true","description":"(boolean, optionnel) si indiqué : ajoute les informations \"de contacts\" (téléphone, email, fonction)","disabled":true},{"key":"siAvecRubriquesComptabilite","value":"true","description":"(boolean, optionnel) si indiqué : ajoute les informations de comptabilité (si la personne connectée en a les droits)","disabled":true},{"key":"siAvecRubriquesAdditionelles","value":"true","description":"(boolean, optionnel) si indiqué : ajoute les informations des rubriques additionnelles","disabled":true},{"key":"siIndependantsSeuls","value":"true","description":"(boolean, optionnel) si indiqué : la liste ne comprendra que les indépendants","disabled":true},{"key":"id","value":"162","description":"(integer, optionnel) si indiqué : affiche le détail d'une fiche."},{"key":"siAvecMembres","value":"true","description":"(boolean, optionnel si ID est spécifié, inutile sinon) : affiche la hiérarchie de la fiche"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Date","value":"Thu, 28 Nov 2019 16:13:52 GMT"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"291"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalRows\": 4,\n \"Entite\": {\n \"id\": 160,\n \"nom\": \"Art & Fenêtres\",\n \"adresse\": {\n \"rue\": \"1 rue de la Paix\",\n \"cp\": \"75002\",\n \"ville\": \"Rome\",\n \"pays\": \"Italie\",\n \"isopays\": \"IT\"\n },\n \"membres\": [\n {\n \"type\": \"Service\",\n \"id\": 162,\n \"nom\": \"service comptabilité\",\n \"adresse\": {\n \"rue\": \"2 rue de la paix\",\n \"cp\": \"00100\",\n \"ville\": \"Rome\",\n \"pays\": \"Italie\",\n \"isopays\": \"IT\"\n },\n \"membres\": [\n {\n \"type\": \"Personne\",\n \"id\": 163,\n \"prenom\": \"Maria\",\n \"nom\": \"Rossi\",\n \"civilite\": \"Madame\",\n \"sexe\": \"F\"\n },\n {\n \"type\": \"Personne\",\n \"id\": 725,\n \"prenom\": \"Julio\",\n \"nom\": \"Lofiss-Modi\",\n \"civilite\": \"Maître\",\n \"sexe\": \"M\"\n }\n ]\n }\n ]\n }\n}"}],"_postman_id":"21e2e908-aa0e-4539-bca5-156721cd0cfd"},{"name":"Liste des services d'une entité","id":"07dc5cf7-7986-41b6-bcd3-97478ae25f66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","type":"text","value":"application/json"}],"url":"http://{{url}}/api/json/v1/Adresses/ListeServices/?idEntite=337&siHierarchique=true&siPeuple=true","description":"

API donnant la liste des services d’une entité.\n
\nLes paramètres permettent de définir l’identifiant de l’entité et la présentation des informations.
\n

Codes Erreurs

\n\n \n \n \n \n \n \n \n \n

Codes	description
ErrEntiteIDAbsent	Identifiant de l’entité non indiqué

\nAutres erreurs : Cf. en tête de cette documentation.

","urlObject":{"protocol":"http","path":["api","json","v1","Adresses","ListeServices",""],"host":["{{url}}"],"query":[{"disabled":true,"description":{"content":"

(boolean, optionnel) si valorisé : ajoute l’adresse

\n","type":"text/plain"},"key":"siAvecAdresse","value":"true"},{"description":{"content":"

(integer, obligatoire) : identifiant de l’entité

\n","type":"text/plain"},"key":"idEntite","value":"337"},{"description":{"content":"

(boolean, optionnel) si indiqué : le résultat est un json hiérarchique

\n","type":"text/plain"},"key":"siHierarchique","value":"true"},{"description":{"content":"

(boolean, optionnel) si indiqué et à true, une indication qu’un service contient des services ou des personnes est ajoutée.

\n","type":"text/plain"},"key":"siPeuple","value":"true"}],"variable":[]}},"response":[{"id":"774237f6-b646-4156-abc6-ca2cf564e177","name":"Liste","originalRequest":{"method":"GET","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"http://{{url}}/api/json/v1/Adresses/Liste/?id=162&siAvecMembres=true","protocol":"http","host":["{{url}}"],"path":["api","json","v1","Adresses","Liste",""],"query":[{"key":"$start","value":"TE","description":"(string ,optionnel) si indiqué : filtre les fiches dont un élément commence par cette valeur","disabled":true},{"key":"$lk","value":"Gont","description":"(string ,optionnel) si indiqué : filtre les fiches dont un élément contient cette valeur","disabled":true},{"description":"(string ,optionnel) si indiqué : filtre les fiches dont un élément est égal à cette valeur","key":"$eq","value":"Exe","disabled":true},{"key":"tri","value":"parVille","description":"(string, optionnel, valeurs possibles : parVille, parNom)","disabled":true},{"key":"per_page","value":"1","description":"(integer, optionnel ou obligatoire si le critère \"page\" est fourni) nombre de lignes par plage","disabled":true},{"key":"page","value":"1","description":"(integer, optionnel ou obligatoire si le critère \"per_page\" est fourni) numéro de la plage","disabled":true},{"key":"siAvecAdresse","value":"true","description":"(boolean, optionnel) si valorisé : ajoute l'adresse","disabled":true},{"key":"siAvecRubriquesContacts","value":"true","description":"(boolean, optionnel) si indiqué : ajoute les informations \"de contacts\" (téléphone, email, fonction)","disabled":true},{"key":"siAvecRubriquesComptabilite","value":"true","description":"(boolean, optionnel) si indiqué : ajoute les informations de comptabilité (si la personne connectée en a les droits)","disabled":true},{"key":"siAvecRubriquesAdditionelles","value":"true","description":"(boolean, optionnel) si indiqué : ajoute les informations des rubriques additionnelles","disabled":true},{"key":"siIndependantsSeuls","value":"true","description":"(boolean, optionnel) si indiqué : la liste ne comprendra que les indépendants","disabled":true},{"key":"id","value":"162","description":"(integer, optionnel) si indiqué : affiche le détail d'une fiche."},{"key":"siAvecMembres","value":"true","description":"(boolean, optionnel si ID est spécifié, inutile sinon) : affiche la hiérarchie de la fiche"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Date","value":"Thu, 28 Nov 2019 16:13:52 GMT"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"291"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalRows\": 4,\n \"Entite\": {\n \"id\": 160,\n \"nom\": \"Art & Fenêtres\",\n \"adresse\": {\n \"rue\": \"1 rue de la Paix\",\n \"cp\": \"75002\",\n \"ville\": \"Rome\",\n \"pays\": \"Italie\",\n \"isopays\": \"IT\"\n },\n \"membres\": [\n {\n \"type\": \"Service\",\n \"id\": 162,\n \"nom\": \"service comptabilité\",\n \"adresse\": {\n \"rue\": \"2 rue de la paix\",\n \"cp\": \"00100\",\n \"ville\": \"Rome\",\n \"pays\": \"Italie\",\n \"isopays\": \"IT\"\n },\n \"membres\": [\n {\n \"type\": \"Personne\",\n \"id\": 163,\n \"prenom\": \"Maria\",\n \"nom\": \"Rossi\",\n \"civilite\": \"Madame\",\n \"sexe\": \"F\"\n },\n {\n \"type\": \"Personne\",\n \"id\": 725,\n \"prenom\": \"Julio\",\n \"nom\": \"Lofiss-Modi\",\n \"civilite\": \"Maître\",\n \"sexe\": \"M\"\n }\n ]\n }\n ]\n }\n}"}],"_postman_id":"07dc5cf7-7986-41b6-bcd3-97478ae25f66"},{"name":"Recherche de fiches","id":"7b11819d-8ce5-4a32-8f9c-20c5d79c41de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"http://{{url}}/api/json/v1/Adresses/Recherche/?siAvecRubriquesContacts=true&siAvecRubriquesComptabilite=true&siAvecRubriquesAdditionelles=true&siAvecAdresse=true&jsn={\"surPersonnes\": [{\"nom\": {\"$eq\": \"BAREO\"}},{\"prenom\": {\"$lk\": \"LAURA\"}}],\"surEntites\": [{\"nom\": {\"$eq\": \"TEAM MARINE\"}},{\"prenom\": {\"$lk\": \"MARINE\"}},{\"ville\":{\"$eq\":\"Paris\"}}]}","description":"

API de recherche de fiches dans le carnet d’adresses.

La recherche peut porter

sur des entités,
sur des services dans des entités,
sur des personnes dans des entités,
sur des personnes dans des services,
et enfin sur des personnes dans des services dans des entités.

Le filtre de recherche est un JSON contenu dans le paramètre \"jsn\".
\nCe JSON peut contenir les 3 propriétés suivantes :

\"surEntites\"
\"surServices\"
\"surPersonnes\"

Si une seule de ces propriétés est présente (par exemple \"surPersonnes\"), la recherche ne porte que sur les types de fiches correspondant (ici, les personnes).
\nIl est possible de définir un filtre composé , par exemple indiquer les filtres \"surEntites\" et \"surPersonnes\" pour rechercher certaines personnes dans certaines entités.

Le résultat porte sur l’élément le plus \"fin\".
\nPar exemple, en mettant les éléments \"surEntites\" et \"surPersonnes\", le résultat donnera les fiches de personnes.
\nEt en mettant les éléments \"surEntites\" et \"surServices\", le résultat donnera les fiches de services.

Chacune de ces 3 propriétés est un tableau JSON comportant les différents filtres de recherche.
\nChacun de ces filtres est lui-même un JSON dont la clé est le nom d’une rubrique du carnet d’adresses et la valeur, un JSON indiquant le type de recherche et la valeur cherchée.
\nExemple :

{\n    \"surEntites\": [\n        {\n            \"SOCRELATION\":{\"$eq\":\"Prospect\"}\n        }\n    ]\n}

\n\n

Exemple multicritere, ici pour rechercher les prospects à Lille :

{\n    \"surEntites\": [\n        {\n            \"SOCRELATION\":{\"$eq\":\"Prospect\"}\n        },\n        {\n            \"ville\":{\"$eq\":\"Lille\"}\n        }\n    ]\n}

\n\n\n

Les rubriques sont les suivantes :
\n\"telephone\", \"email\", \"mobile\", \"fax\", \"fonction\", \"compteClient\", \"compteFournisseur\", \"compteSuffixe\"
\n\"nom\", \"prenom\", \"rue\", \"cp\", \"ville\", \"pays\", \"note\", \"isopays\", \"isoregion\" (pour France et Canada)
\n\"dateCreation\", \"dateModification\"
\n\"siIndependant\", \"siRessourceInterne\"
\nainsi que les noms de variable des rubriques additionnelles.
\n
\nLes types de recherche sont les types normalisés avec quelques ajouts :
\n(Pour les valeurs de type string, la casse n'est pas significative.)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n

$eq	est égal à
$neq	est différent de	Cela inclut les fiches dont la rubrique est de valeur différente ET les fiches où la rubrique n’est pas définie
$lk	contient	(pour une string)
$nlk	ne contient pas	(pour une string) Cela inclut les fiches dont la valeur de la rubrique ne contient pas ET les fiches où la rubrique n’est pas définie
$start	commence par	(pour une string)
$nstart	ne commence pas par	Cela inclut les fiches dont la valeur de rubrique débute par la valeur ET les fiches où la rubrique n'est pas définie
$gt	supérieur à	(pour une valeur numérique)
$lt	inférieur à	(pour une valeur numérique)
$gte	supérieur ou égal à	(pour une valeur numérique)
$lte	inférieur ou égal à	(pour une valeur numérique)
$isin	si dans un intervalle	(pour une période)
$notin	si absent d'un intervalle	(pour une période)
$def	si défini (quelle que soit la valeur)
$ndef	si non défini

\n

\n\n\n

Les critères d’affichage des fiches sont décrits dans les paramètres.
\nIl y a l’éventuel tri, mais aussi la possibilité de faire figurer l’adresse, les rubriques de contact et les rubriques additionnelles.\n

Succès

En cas de succès, l’API retourne un JSON contenant la liste des fiches correspondant à la recherche avec les éventuelles informations optionnelles spécifiées dans les paramètres.\n

Codes Erreurs

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Codes	description
ErrAdresseCritereAbsent	Critères de recherche absents
ErrAdresseRubriqueInconnue	Une rubrique spécifiée est inconnue
ErrAdresseFiltreModeNonConforme	Le mode de recherche du filtre est inconnu
ErrAdresseFiltreModeAbsent	Le mode de recherche du filtre est absent
ErrAdresseFiltreValeurAbsente	La valeur de recherche du filtre est absente
ErrAdresseAbsenceFiltre	Aucun filtre de recherche spécifié
ErrAdresseFiltreMontantNonConforme	Montant incorrrectement spécifié
ErrAdresseFiltrePlageMontantNonConforme	Plage de montants incorrrectement spécifiée
ErrAdresseFiltreMontantAbsent	Aucun montant spécifié
ErrAdresseModeRechercheMontantInconnu	Mode inconnu de recherche des montants
ErrAdresseModeRechercheBooleanInconnu	Mode inconnu de recherche des valeurs bouléennes
ErrAdresseModeRechercheTexteInconnu	Mode inconnu de recherche des textes
ErrAdresseModeRechercheDateInconnu	Mode inconnu de recherche des dates
ErrAdresseFiltreDateNonConforme	Filtre de recherche de dates incorrect
ErrAdresseFiltreDateAbsent	Aucun filtre de recherche de dates spécifié
ErrAdresseFiltrePeriodeNonConforme	Filtre de recherche de période incorrect

\nAutres erreurs : Cf. en tête de cette documentation.

","urlObject":{"protocol":"http","path":["api","json","v1","Adresses","Recherche",""],"host":["{{url}}"],"query":[{"disabled":true,"description":{"content":"

(string, optionnel, valeurs possibles : parVille, parNom)

\n","type":"text/plain"},"key":"tri","value":"parVille"},{"disabled":true,"description":{"content":"

(integer, optionnel ou obligatoire si le critère \"page\" est fourni) nombre de lignes par plage

\n","type":"text/plain"},"key":"per_page","value":"1"},{"disabled":true,"description":{"content":"

(integer, optionnel ou obligatoire si le critère \"per_page\" est fourni) numéro de la plage

\n","type":"text/plain"},"key":"page","value":"2"},{"description":{"content":"

(boolean, optionnel) si valorisé : ajoute les informations de communication (téléphone, email, fonction)

\n","type":"text/plain"},"key":"siAvecRubriquesContacts","value":"true"},{"description":{"content":"

(boolean, optionnel) si valorisé : ajoute les informations de comptabilité (si la personne connectée en a les droits)

\n","type":"text/plain"},"key":"siAvecRubriquesComptabilite","value":"true"},{"description":{"content":"

(boolean, optionnel) si valorisé : ajoute les informations des rubriques additionnelles

\n","type":"text/plain"},"key":"siAvecRubriquesAdditionelles","value":"true"},{"description":{"content":"

(boolean, optionnel) si valorisé : ajoute l’adresse

\n","type":"text/plain"},"key":"siAvecAdresse","value":"true"},{"description":{"content":"

(Json,optionel): critères de recherche multicritère

\n","type":"text/plain"},"key":"jsn","value":"{\"surPersonnes\": [{\"nom\": {\"$eq\": \"BAREO\"}},{\"prenom\": {\"$lk\": \"LAURA\"}}],\"surEntites\": [{\"nom\": {\"$eq\": \"TEAM MARINE\"}},{\"prenom\": {\"$lk\": \"MARINE\"}},{\"ville\":{\"$eq\":\"Paris\"}}]}"}],"variable":[]}},"response":[{"id":"80b84fe8-ad95-4404-82b4-2ebe53e9edc0","name":"Recherche de fiches","originalRequest":{"method":"GET","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"surEntites\": [\n {\n \"SOCRELATION\":{\"$eq\":\"ProspecT\"}\n },\n {\n \"nom\":{\"$eq\":\"Canon\"}\n }\n \t\t]\n,\n \"surPersonnes\": [\n {\n \"compteClient\":{\"$eq\":\"411CanonCompta\"}\n }\n \t\t]\n\n}\n"},"url":{"raw":"http://{{url}}/api/json/v1/Adresses/Recherche/?siAvecRubriquesContacts=true&siAvecRubriquesComptabilite=true&siAvecRubriquesAdditionelles=true&siAvecAdresse=true","protocol":"http","host":["{{url}}"],"path":["api","json","v1","Adresses","Recherche",""],"query":[{"description":"(string, optionnel, valeurs possibles : parVille, parNom)","key":"tri","value":"parVille","disabled":true},{"description":"(integer, optionnel ou obligatoire si le critère \"page\" est fourni) nombre de lignes par plage","key":"per_page","value":"1","disabled":true},{"description":"(integer, optionnel ou obligatoire si le critère \"per_page\" est fourni) numéro de la plage","key":"page","value":"2","disabled":true},{"key":"siAvecRubriquesContacts","value":"true","description":"(boolean, optionnel) si valorisé : ajoute les informations \"de contacts\" (téléphone, email, fonction)"},{"key":"siAvecRubriquesComptabilite","value":"true","description":"(boolean, optionnel) si valorisé : ajoute les informations de comptabilité (si la personne connectée en a les droits)"},{"key":"siAvecRubriquesAdditionelles","value":"true","description":"(boolean, optionnel) si valorisé : ajoute les informations des rubriques additionnelles"},{"key":"siAvecAdresse","value":"true","description":"(boolean, optionnel) si valorisé : ajoute l'adresse"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Date","value":"Thu, 28 Nov 2019 16:15:24 GMT"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"296"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalRows\": 1,\n \"listeFichesPersonnes\": [\n {\n \"id\": 496,\n \"prenom\": \"Charles\",\n \"nom\": \"Henri de Villepinte\",\n \"civilite\": \"Monsieur\",\n \"idParent\": 495,\n \"nomParent\": \"Service comptabilité\",\n \"nomentite\": \"CANON\",\n \"identite\": 494,\n \"adresse\": {\n \"cp\": \"75001\",\n \"ville\": \"Paris\",\n \"isopays\": \"FR\"\n },\n \"rubriques\": [\n {\n \"nom\": \"ZOM !\",\n \"valeur\": \"ZOM\",\n \"id\": 1729\n },\n {\n \"nom\": \"Compte fournisseur\",\n \"valeur\": \"401founiVillepinte\",\n \"id\": 1732\n },\n {\n \"nom\": \"Compte client\",\n \"valeur\": \"411CanonCompta\",\n \"id\": 1733\n }\n ]\n }\n ]\n}"},{"id":"238ca6d1-e43d-4636-b27a-8c170af0c729","name":"Recherche de fiches avec critère Entité","originalRequest":{"method":"GET","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"http://{{url}}/api/json/v1/Adresses/Recherche/?siAvecRubriquesContacts=true&siAvecRubriquesComptabilite=true&siAvecRubriquesAdditionelles=true&siAvecAdresse=true&jsn={\"surEntites\": [{\"nom\": {\"$eq\": \"Test 17\"}}],\"surPersonnes\": [{\"nom\": {\"$lk\": \"Am\"}}]}","protocol":"http","host":["{{url}}"],"path":["api","json","v1","Adresses","Recherche",""],"query":[{"description":"(string, optionnel, valeurs possibles : parVille, parNom)","key":"tri","value":"parVille","disabled":true},{"description":"(integer, optionnel ou obligatoire si le critère \"page\" est fourni) nombre de lignes par plage","key":"per_page","value":"1","disabled":true},{"description":"(integer, optionnel ou obligatoire si le critère \"per_page\" est fourni) numéro de la plage","key":"page","value":"2","disabled":true},{"key":"siAvecRubriquesContacts","value":"true","description":"(boolean, optionnel) si valorisé : ajoute les informations \"de contacts\" (téléphone, email, fonction)"},{"key":"siAvecRubriquesComptabilite","value":"true","description":"(boolean, optionnel) si valorisé : ajoute les informations de comptabilité (si la personne connectée en a les droits)"},{"key":"siAvecRubriquesAdditionelles","value":"true","description":"(boolean, optionnel) si valorisé : ajoute les informations des rubriques additionnelles"},{"key":"siAvecAdresse","value":"true","description":"(boolean, optionnel) si valorisé : ajoute l'adresse"},{"key":"jsn","value":"{\"surEntites\": [{\"nom\": {\"$eq\": \"Test 17\"}}],\"surPersonnes\": [{\"nom\": {\"$lk\": \"Am\"}}]}","description":"(Json,optionel): critère de recherchemulticritère"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Thu, 07 Jan 2021 10:21:34 GMT"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"493"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalRows\": 1,\n \"listeFichesPersonnes\": [\n {\n \"id\": 465,\n \"prenom\": \"Dina\",\n \"nom\": \"Aharram\",\n \"civilite\": \"Monsieur\",\n \"idParent\": 477,\n \"nomParent\": \"Commercial\",\n \"nomentite\": \"Test 17\",\n \"identite\": 463,\n \"rubriques\": {\n \"rubriquesContact\": [\n {\n \"nom\": \"Email\",\n \"valeur\": \"dina@billjobs.com\",\n \"type\": \"Mail\",\n \"id\": 471\n },\n {\n \"nom\": \"Téléphone\",\n \"valeur\": \"0187876565\",\n \"type\": \"Tel\",\n \"id\": 895\n },\n {\n \"nom\": \"Fonction\",\n \"valeur\": \"consultante formatrice\",\n \"type\": \"Fonc\",\n \"id\": 896\n },\n {\n \"nom\": \"Téléphone\",\n \"valeur\": \"0676543234\",\n \"type\": \"Tel\",\n \"id\": 897\n }\n ]\n }\n }\n ]\n}"}],"_postman_id":"7b11819d-8ce5-4a32-8f9c-20c5d79c41de"},{"name":"Une fiche du carnet d'adresses","id":"e92bcd16-7d20-416e-a11c-3405401bfa46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","type":"text","value":"application/json"}],"url":"http://{{url}}/api/json/v1/Adresses/Fiche/?id=31&siAvecRubriquesAdditionelles=true","description":"

API donnant une fiche du carnet d'adresses.\n
\nLes paramètres permettent de définir les critères de sélection de la fiche et son affichage.
\n

Il faut spécifier l’Identifiant de la fiche.
\n
\nS’il s’agit d’une personne ou d’un service, la fiche est affichée avec celle de son entité.

Codes Erreurs

\n\n \n \n \n \n \n \n \n \n

Codes	description
ErrEntiteIDAbsent	Aucun ID de fiche indiqué.

\nAutres erreurs : Cf. en tête de cette documentation.

","urlObject":{"protocol":"http","path":["api","json","v1","Adresses","Fiche",""],"host":["{{url}}"],"query":[{"description":{"content":"

(integer, obligatoire) spécifie la fiche recherchée.

\n","type":"text/plain"},"key":"id","value":"31"},{"disabled":true,"description":{"content":"

(boolean, optionnel) si valorisé : ajoute l’adresse

\n","type":"text/plain"},"key":"siAvecAdresse","value":"true"},{"disabled":true,"description":{"content":"

(boolean, optionnel) si indiqué : ajoute les informations de communication (téléphone, email, fonction)

\n","type":"text/plain"},"key":"siAvecRubriquesContacts","value":"true"},{"disabled":true,"description":{"content":"

(boolean, optionnel) si indiqué : ajoute les informations de comptabilité (si la personne connectée en a les droits)

\n","type":"text/plain"},"key":"siAvecRubriquesComptabilite","value":"true"},{"description":{"content":"

(boolean, optionnel) si indiqué : ajoute les informations des rubriques additionnelles

\n","type":"text/plain"},"key":"siAvecRubriquesAdditionelles","value":"true"},{"disabled":true,"description":{"content":"

(boolean, optionnel si ID est spécifié, inutile sinon) : affiche la hiérarchie de la fiche

\n","type":"text/plain"},"key":"siAvecMembres","value":"true"},{"disabled":true,"description":{"content":"

(boolean, optionnel) si indiqué : ajoute le nombre de personnes et de services contenus. Inutile s'il s'agit d‘une fiche de personne.

\n","type":"text/plain"},"key":"siAvecComptage","value":"true"}],"variable":[]}},"response":[{"id":"dad7a123-7929-4941-8c99-192a017b184f","name":"Une fiche du carnet d'adresses","originalRequest":{"method":"GET","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"http://{{url}}/api/json/v1/Adresses/Fiche/?siAvecRubriquesContacts=true&id=759","protocol":"http","host":["{{url}}"],"path":["api","json","v1","Adresses","Fiche",""],"query":[{"description":"(boolean, optionnel) si valorisé : ajoute l'adresse","key":"siAvecAdresse","value":"true","disabled":true},{"key":"siAvecRubriquesContacts","value":"true","description":"(boolean, optionnel) si indiqué : ajoute les informations \"de contacts\" (téléphone, email, fonction)"},{"description":"(boolean, optionnel) si indiqué : ajoute les informations de comptabilité (si la personne connectée en a les droits)","key":"siAvecRubriquesComptabilite","value":"true","disabled":true},{"description":"(boolean, optionnel) si indiqué : ajoute les informations des rubriques additionnelles","key":"siAvecRubriquesAdditionelles","value":"true","disabled":true},{"key":"id","value":"759","description":"(integer, obligatoire) spécifie la fiche recherchée."},{"key":"siAvecMembres","value":"true","description":"(boolean, optionnel si ID est spécifié, inutile sinon) : affiche la hiérarchie de la fiche","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Date","value":"Thu, 28 Nov 2019 17:06:16 GMT"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"312"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalRows\": 2,\n \"Entite\": {\n \"id\": 756,\n \"nom\": \"SA MEMANK\",\n \"adresse\": {\n \"rue\": \"65 Bld Tistik\",\n \"cp\": \"14000\",\n \"ville\": \"Caen\",\n \"pays\": \"France\",\n \"isopays\": \"FR\",\n \"isoregion\": \"FR\"\n },\n \"membres\": [\n {\n \"type\": \"Personne\",\n \"id\": 759,\n \"prenom\": \"Klakinouvka\",\n \"nom\": \"ZOMBETAN\",\n \"civilite\": \"Monsieur\",\n \"sexe\": \"M\",\n \"rubriques\": [\n {\n \"nom\": \"Téléphone\",\n \"valeur\": \"0204568990\",\n \"id\": 1863\n },\n {\n \"nom\": \"Email\",\n \"valeur\": \"klak@memank.frc\",\n \"id\": 1864\n },\n {\n \"nom\": \"Téléphone\",\n \"valeur\": \"0204568900\",\n \"id\": 1869\n },\n {\n \"nom\": \"Email\",\n \"valeur\": \"klak@memank.fr\",\n \"id\": 1870\n }\n ]\n }\n ]\n }\n}"}],"_postman_id":"e92bcd16-7d20-416e-a11c-3405401bfa46"},{"name":"Création d'une Fiche entité ou Indépendant","id":"96dbfa42-c493-474d-8d94-2b13eaf290ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"POST","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"

Votre clé API transmise par Billjobs

\n","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":"{\n\t\"typeFiche\" : \"Entite\",\n\t\"nom\" : \"LE CERVIN\",\n\t\"adresse\" : {\n \"rue\": \"65 Bld Tistik\",\n \"ville\": \"Vevey\",\n \"cp\" : \"14000\",\n \"pays\": \"Suisse\"\n\t}\n}"},"url":"http://{{url}}/api/json/v1/Adresses/Fiche/","description":"

API créant la fiche de carnet d'adresse d’une entité ou d’un indépendant.

La création d’une entité ne peut utiliser que les rubriques dites de communication, de comptabilité et les rubriques additionnelles d’entités.
La création d’un indépendant peut utiliser les rubriques additionnelles de catégorie \"Entité\" et \"Personne\".

Les erreurs portant sur ces différentes rubriques (communication, comptabilité et rubriques additionnelles) ne bloquent pas la création de la fiche.
\nIl est possible ensuite d’ajouter les rubriques qui auront été mal définies avec l’API de modification d’une fiche.

Contenu du Body

Le JSON contenu dans le body est décrit dans la description en tête de ce chapitre.

Succès

L'API retourne un Json contenant l'identifiant de la fiche créée.
```
\n{\n \"IdFiche\": 752\n}
```

Codes Erreurs

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Codes	descriptions
ErrAdresseEntiteNomAbsent	Le nom n'est pas défini
ErrAdresseTypeFicheAbsent	le type de la fiche (typeFiche) n'est pas défini
ErrAdresseTypeFicheNonConforme	le type de la fiche (typeFiche) est incorrect
ErrAdresseEntiteNomExistant	Il existe déjà une entité ayant ce nom
ErrAdresseIndependantNomPrenomExistant	Il existe déjà un indépendant ayant ce nom et ce prénom

\nAutres erreurs : Cf. en tête de ce chapitre.","urlObject":{"protocol":"http","path":["api","json","v1","Adresses","Fiche",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"c0b26c95-f742-4211-aa30-d667403349c4","name":"Création d'une Fiche entité ou Indépendant","originalRequest":{"method":"POST","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"Votre clé API transmise par Billjobs ","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":"{\n\t\"typeFiche\" : \"Entite\",\n\t\"nom\" : \"SA MEMANK\",\n\t\"note\" : \"test création d'une fiche avec adresse et commentaire sans mise en forme mais l'éditer avec des textes longs\",\n\t\"adresse\" : {\n \"rue\": \"65 Bld Tistik\",\n \"ville\": \"Caen\",\n \"cp\" : \"14000\"\n },\n \"communication\" : [\n \t{\n\t\t\t\"nomRubrique\": \"tel\",\n\t\t\t\"valeur\": \"0204568789\",\n\t\t\t\"complement\": \"Standard\"\n\t\t},\n \t{\n\t\t\t\"nomRubrique\": \"fax\",\n\t\t\t\"valeur\": \"0204568787\"\n\t\t}\n\t],\n\t\"comptabilite\" : [\n \t{\n \t\t\"idRubrique\": 9,\n \t\t\"valeur\" : \"401102\"\n \t},\n \t{\n \t\t\"nomRubrique\" : \"CClt\",\n \t\t\"valeur\": \"411003\"\n \t}\n ],\n\t\"rubriquesAdditionnelles\" : [\n \t{\n \t\t\"idRubrique\": 13,\n \t\t\"valeur\" : \"Cosmétique\"\n \t},\n \t{\n \t\t\"nomRubrique\" : \"SOCINVENTAIRE\",\n \t\t\"valeur\": \"2019-11-01\"\n \t},\n \t{\n \t\t\"idRubrique\": 24,\n \t\t\"valeur\": true\n \t},\n \t{\n \t\t\"nomRubrique\": \"SOCREMISEPRO\",\n \t\t\"valeur\": \"20\"\n \t}\n ]\n}"},"url":"http://{{url}}/api/json/v1/Adresses/Fiche/"},"status":"CREATED","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Date","value":"Thu, 28 Nov 2019 16:18:01 GMT"},{"key":"Content-Length","value":"15"}],"cookie":[],"responseTime":null,"body":"{\n \"IdFiche\": 756\n}"}],"_postman_id":"96dbfa42-c493-474d-8d94-2b13eaf290ff"},{"name":"Création d'une Fiche de service ou de personne","event":[{"listen":"prerequest","script":{"id":"90d1f3c1-f16a-40c5-afa1-142d7bfb01e9","exec":[""],"type":"text/javascript"}}],"id":"1ebeeaf2-6caa-4b10-b0a6-bb6d2d3eb19d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"POST","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"

Votre clé API transmise par Billjobs

\n","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":"{\n\t\"idSup\" : 756,\n\t\"typeFiche\" : \"Personne\",\n\t\"nom\" : \"ZOMBETAN\",\n\t\"prenom\" : \"Klakinouvka\",\n\t\"civilite\" : \"M\",\n\t\"sexe\" : \"H\",\n\t\"note\" : \"test création d'une personne avec adresse et commentaire sans mise en forme\",\n\t\"communication\" : [\n \t{\n\t\t\t\"nomRubrique\": \"tel\",\n\t\t\t\"valeur\": \"0204568990\"\n\t\t},\n \t{\n\t\t\t\"nomRubrique\": \"Mail\",\n\t\t\t\"valeur\": \"klak@memank.frc\"\n\t\t}\n\t],\n\t\"comptabilite\" : [\n \t{\n \t\t\"idRubrique\": 9,\n \t\t\"valeur\" : \"4011ZOM\"\n \t},\n \t{\n \t\t\"nomRubrique\" : \"CClt\",\n \t\t\"valeur\": \"4110ZOM\"\n \t}\n ],\n\t\"rubriquesAdditionnelles\" : [\n \t{\n \t\t\"nomRubrique\" : \"PERINTERETPROSPECT\",\n \t\t\"valeur\": \"Prospect tiède\"\n \t},\n \t{\n \t\t\"nomRubrique\": \"PERZOM\",\n \t\t\"valeur\": \"YABON\"\n \t}\n ]\n}"},"url":"http://{{url}}/api/json/v1/Adresses/Fiche/","description":"

API créant une fiche d’un service ou d'une personne dans une entité préalablement créée.
\nLa création de service ou d’une personne ne peut utiliser que les rubriques additionnelles de catégorie \"Personne\".
\nLes erreurs sur ces rubriques ne bloquent pas la création de la fiche, on peut par la suite les ajouter/modifier par l’API de modification d’une fiche.

Une personne doit avoir la même adresse que le service ou l’entité dans lequel elle se trouve.

Contenu du Body

Le JSON contenu dans le body est décrit dans la description en tête de cette rubrique.

Réponse

L'API retourne un Json contenant le statut et l'identifiant de la fiche créée' .

Codes Erreurs

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Codes	descriptions
ErrAdresseServiceOuPersonneNomAbsent	Le nom n’est pas défini
ErrAdresseServiceOuPersonneTypeFicheAbsent	le type de la fiche n’est pas défini
ErrAdresseTypeFicheNonConforme	le type (typeFiche) de la fiche incorrecte
ErrAdresseIDSupInconnu	L’entité ou le service supérieur indiqué par l’identifiant est inconnu
ErrAdresseServiceNomExistant	Un service ayant ce nom existe déja
ErrAdressePersonneNomPrenomExistant	Une personne ayant ce nom et ce prénom existe déja
ErrAdresseIDSupAbsent	l’identifiant de l’entité ou service supérieur n’est pas défini

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"description":"

Votre clé API transmise par Billjobs

\n","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"file","file":{"src":"/Users/vincent2/Desktop/images.jpeg"}},"url":"http://{{url}}/api/json/v1/Adresses/photo/?IdFiche=759&Fichier=images.jpeg","description":"

Cet API permet d’ajouter ou de changer la photo associée à une fiche dans le carnet d’adresses.

Descriptions du contenu des \"params\" et du \"Body\"

IdFiche (integer, obligatoire) L’identidiant de la fiche du carnet d’adresses.
Fichier (string, obligatoire) Le nom du fichier.

Le \"Body\" doit contenir l’image en binaire.

\n{\n    data-binary (bloc binaire,obligatoire) : contient les données binaires de l’image, les types de fichier supportés sont (\"jpg\",\"tiff\",\"png\",\"bmp\",\"gif\")
\n}

\n\n

Réponse

L’API retourne un Json contenant le statut et l’identifiant de la fiche traitée.

Codes Erreurs

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Codes	descriptions
ErrAdresseFicheIdInconnu	La fiche indiquée par l’identifiant est inconnue
ErrAdresseIdFicheAbsent	L’identifiant de la fiche n’est pas défini
ErrAdresseNomFichierImageAbsent	Le nom de fichier n’est pas indiqué
ErrAdressePhotoNonConforme	Le type de fichier image n’est pas conforme
ErrAdresseFichierImageAbsent	Le fichier n’est pas sélectionné
ErrAdresseTransfertFichierImpossible	Le fichier n’a pas pu être transféré vers le serveur

\nAutres erreurs : Cf. en tête de cette documentation.","urlObject":{"protocol":"http","path":["api","json","v1","Adresses","photo",""],"host":["{{url}}"],"query":[{"description":{"content":"

identifiant de la fiche de carnet d’adresse

\n","type":"text/plain"},"key":"IdFiche","value":"759"},{"description":{"content":"

nom de fichier avec extension sélectionné sur data binary

\n","type":"text/plain"},"key":"Fichier","value":"images.jpeg"}],"variable":[]}},"response":[{"id":"b68086f6-6ad1-4ac4-9a87-f5385ececcbc","name":"Insertion d'une photo dans une fiche adresse","originalRequest":{"method":"POST","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"description":"Votre clé API transmise par Billjobs ","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"file","file":{}},"url":{"raw":"http://{{url}}/api/json/v1/Adresses/photo/?IdFiche=759&Fichier=images.jpeg","protocol":"http","host":["{{url}}"],"path":["api","json","v1","Adresses","photo",""],"query":[{"key":"IdFiche","value":"759","description":"identifiant de la fiche de carnet d'adresse"},{"key":"Fichier","value":"images.jpeg","description":"nom de fichier avec extension sélectionné sur data binary"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Date","value":"Fri, 29 Nov 2019 09:55:57 GMT"},{"key":"Content-Length","value":"41"}],"cookie":[],"responseTime":null,"body":"{\n \"Statut\": 200,\n \"idFiche\": 759,\n \"Photo\": \"OK\"\n}"}],"_postman_id":"ae57bd11-d2fe-49d8-835f-0dc833a4a123"},{"name":"Modification d'une Fiche Adresse","id":"a14d83cb-41b0-4744-a34f-ff2a957faf34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"PATCH","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"

Votre clé API transmise par Billjobs

\n","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":"{\n\t\"Id\" :666,\n \"codeCivilite\": \"FMme\",\n\t \"adresse\": {\n \"rue\": \"38 chouette Hulotte\",\n \"cp\": \"16538\",\n \"ville\": \"Bidule\",\n \"pays\": \"Canada\",\n \"isoregion\": \"CA-MB\"\n }\n}"},"url":"http://{{url}}/api/json/v1/Adresses/Fiche/","description":"

API permettant de modifier une fiche d’adresse.

Contenu du Body

Le JSON contenu dans le body est décrit dans la dscription en tête de cette rubrique.
\nToutefois, une donnée importante doit être ajoutée : l'identifiant de la fiche à modifier.

id (Integer,obligatoire) : identifiant de la fiche à modifier

Dans le cas de changement de service d'une personne ou d'un service, idSup doit être l'identifiant du nouveau service dans lequel est déplacée la fiche

Réponse

L'API retourne un Json contenant le statut et l'identifiant de la fiche traitée.

Codes Erreurs

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Codes	descriptions
ErrAdresseIdFicheAbsent	L'identifiant de la fiche n'est pas défini
ErrAdresseFicheIdInconnu	La fiche indiquée par l'identifiant est inconnue
ErrAdresseIDSupInconnu	L'entité ou le service supérieur indiqué par l'identifiant est inconnu

\nAutres erreurs : Cf. en tête de cette documentation.","urlObject":{"protocol":"http","path":["api","json","v1","Adresses","Fiche",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"9ad81829-7051-49bb-adf1-13a21d269a7a","name":"Modification d'une Fiche Adresse","originalRequest":{"method":"PATCH","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"Votre clé API transmise par Billjobs ","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":"{\n\t\"Id\" :759,\n\t\"note\" : \"test modification d'une personne avec adresse et commentaire sans mise en forme\",\n\t\"communication\" : [\n \t{\n\t\t\t\"id\": 1869,\n\t\t\t\"valeur\": \"0204568900\"\n\t\t},\n \t{\n\t\t\t\"id\": 1870,\n\t\t\t\"valeur\": \"klak@memank.fr\"\n\t\t}\n\t],\n\t\"comptabilite\" : [\n \t{\n \t\t\"id\": 1866,\n \t\t\"valeur\" : \"4011ZOM2\"\n \t}\n ],\n\t\"rubriquesAdditionnelles\" : [\n \t{\n \t\t\"id\": 1867,\n \t\t\"valeur\": \"Prospect froid\"\n \t}\n ]\n}"},"url":"http://{{url}}/api/json/v1/Adresses/Fiche/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Date","value":"Thu, 28 Nov 2019 17:09:36 GMT"},{"key":"Content-Length","value":"44"}],"cookie":[],"responseTime":null,"body":"{\n \"IdFiche\": 759,\n \"Nom\": \"Klakinouvka ZOMBETAN\"\n}"},{"id":"d13ebcce-9b19-405d-8840-b98d37aa10b1","name":"Modification d'une Fiche Adresse avec civilité","originalRequest":{"method":"PATCH","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"Votre clé API transmise par Billjobs ","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":"{\n\t\"Id\" :666,\n \"codeCivilite\": \"FMme\",\n\t \"adresse\": {\n \"rue\": \"38 chouette Hulotte\",\n \"cp\": \"16538\",\n \"ville\": \"Bidule\",\n \"pays\": \"Canada\",\n \"isoregion\": \"CA-MB\"\n }\n}"},"url":"http://{{url}}/api/json/v1/Adresses/Fiche/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Wed, 04 Aug 2021 09:08:36 GMT"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"27"}],"cookie":[],"responseTime":null,"body":"{\n \"IdFiche\": 666,\n \"Nom\": \"Rio\"\n}"},{"id":"4a77ea5c-eadf-4909-b818-74fc1f6c4263","name":"Modification d'une Fiche Adresse sur Communication","originalRequest":{"method":"PATCH","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"Votre clé API transmise par Billjobs ","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":"{\n\t\"Id\": 666,\n \"communication\" : [\n \t{\n\t\t\t\"nomRubrique\": \"tel\",\n\t\t\t\"valeur\": \"0204568990\"\n\t\t},\n \t{\n\t\t\t\"nomRubrique\": \"Mail\",\n\t\t\t\"valeur\": \"rio@goodgirl.com\"\n\t\t}\n\t]\n}"},"url":"http://{{url}}/api/json/v1/Adresses/Fiche/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Thu, 05 Aug 2021 07:38:20 GMT"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"27"}],"cookie":[],"responseTime":null,"body":"{\n \"IdFiche\": 666,\n \"Nom\": \"Rio\"\n}"},{"id":"93cea5db-d064-45ce-a1a9-452e3ed30a5d","name":"Modification d'une Fiche Adresse pour supprimer Tel et Mail","originalRequest":{"method":"PATCH","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"Votre clé API transmise par Billjobs ","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":"{\n\t\"Id\": 666,\n \"communication\" : [\n \t{\n \"valeur\": \"\",\n \"complement\": \"\",\n \"id\": 2063\n },\n {\n \"valeur\": \"\",\n \"complement\": \"\",\n \"id\": 2064\n }\n\t]\n}"},"url":"http://{{url}}/api/json/v1/Adresses/Fiche/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Thu, 05 Aug 2021 07:44:39 GMT"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"27"}],"cookie":[],"responseTime":null,"body":"{\n \"IdFiche\": 666,\n \"Nom\": \"Rio\"\n}"}],"_postman_id":"a14d83cb-41b0-4744-a34f-ff2a957faf34"},{"name":"Suppression d'une Fiche Adresse","id":"b6b36c8c-0365-4e15-a497-3063bcd12cc5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"DELETE","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"

Votre clé API transmise par Billjobs

\n","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":"{\n\t\"Id\" :758\n}\n"},"url":"http://{{url}}/api/json/v1/Adresses/Fiche/","description":"

API permettant de supprimer une fiche du carnet d’adresses.

Descriptions du paramètre

L’identifiant de la fiche à supprimer peut être transmis

soit directement dans l’URL
\n(exemple :http://{{url}}/api/json/v1/Adresses/Fiche/456)
soit dans le \"Body\" sous la forme
```
\n{\n \"id\" : 456\n}\n
```
\nAvec :id (Integer,obligatoire) : identifiant de la fiche à supprimer

Succès

En cas de succès, l’API retourne un Json de confirmation contenant l’Identifiant de la fiche supprimée.

{\n    \"suppressionOK\" : 456\n }\n\n\n#### Codes Erreurs #### \n\n        \n            \n            \n        \n        \n            \n            \n        \n        \n            \n            \n        \n        \n            \n            \n        \n        \nCodes descriptions
ErrAdresseIdFicheAbsent L'identifiant de la fiche n'est pas défini
ErrAdresseFicheSuppressionImpossible Suppression de la fiche impossible
ErrAdresseFicheIdInconnu l'identifiant indiqu une fiche inconnue
\nAutres erreurs : Cf. en tête de cette documentation.

","urlObject":{"protocol":"http","path":["api","json","v1","Adresses","Fiche",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"1e2c76a8-5539-4a50-b986-c9743e36c1d4","name":"Suppression d'une Fiche Adresse","originalRequest":{"method":"DELETE","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"Votre clé API transmise par Billjobs ","key":"APIKey","type":"text","value":"{{CleApi}}"}],"body":{"mode":"raw","raw":"{\n\t\"Id\" :757\n}\n"},"url":"http://{{url}}/api/json/v1/Adresses/Fiche/"},"status":"NO CONTENT","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Date","value":"Thu, 28 Nov 2019 16:21:59 GMT"},{"key":"Content-Length","value":"21"}],"cookie":[],"responseTime":null,"body":"{\n \"suppressionOK\": 757\n}"}],"_postman_id":"b6b36c8c-0365-4e15-a497-3063bcd12cc5"},{"name":"Une fiche Utilisateur connecté","id":"2452f701-066a-454a-9859-09ac039b43ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","type":"text","value":"application/json"}],"url":"http://{{url}}/api/json/v1/Adresses/FicheUtilisateur/","description":"

API donnant une fiche de l’utilisateur connecté.\nSa fiche est affichée avec celle de son entité.

Codes Erreurs

Cf. en tête de cette documentation.

\n","urlObject":{"protocol":"http","path":["api","json","v1","Adresses","FicheUtilisateur",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"13c7f579-2ff1-49fc-aa97-742df374e2ae","name":"Une fiche du carnet d'adresses","originalRequest":{"method":"GET","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"http://{{url}}/api/json/v1/Adresses/Fiche/?siAvecRubriquesContacts=true&id=759","protocol":"http","host":["{{url}}"],"path":["api","json","v1","Adresses","Fiche",""],"query":[{"description":"(boolean, optionnel) si valorisé : ajoute l'adresse","key":"siAvecAdresse","value":"true","disabled":true},{"key":"siAvecRubriquesContacts","value":"true","description":"(boolean, optionnel) si indiqué : ajoute les informations \"de contacts\" (téléphone, email, fonction)"},{"description":"(boolean, optionnel) si indiqué : ajoute les informations de comptabilité (si la personne connectée en a les droits)","key":"siAvecRubriquesComptabilite","value":"true","disabled":true},{"description":"(boolean, optionnel) si indiqué : ajoute les informations des rubriques additionnelles","key":"siAvecRubriquesAdditionelles","value":"true","disabled":true},{"key":"id","value":"759","description":"(integer, obligatoire) spécifie la fiche recherchée."},{"key":"siAvecMembres","value":"true","description":"(boolean, optionnel si ID est spécifié, inutile sinon) : affiche la hiérarchie de la fiche","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Date","value":"Thu, 28 Nov 2019 17:06:16 GMT"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"312"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalRows\": 2,\n \"Entite\": {\n \"id\": 756,\n \"nom\": \"SA MEMANK\",\n \"adresse\": {\n \"rue\": \"65 Bld Tistik\",\n \"cp\": \"14000\",\n \"ville\": \"Caen\",\n \"pays\": \"France\",\n \"isopays\": \"FR\",\n \"isoregion\": \"FR\"\n },\n \"membres\": [\n {\n \"type\": \"Personne\",\n \"id\": 759,\n \"prenom\": \"Klakinouvka\",\n \"nom\": \"ZOMBETAN\",\n \"civilite\": \"Monsieur\",\n \"sexe\": \"M\",\n \"rubriques\": [\n {\n \"nom\": \"Téléphone\",\n \"valeur\": \"0204568990\",\n \"id\": 1863\n },\n {\n \"nom\": \"Email\",\n \"valeur\": \"klak@memank.frc\",\n \"id\": 1864\n },\n {\n \"nom\": \"Téléphone\",\n \"valeur\": \"0204568900\",\n \"id\": 1869\n },\n {\n \"nom\": \"Email\",\n \"valeur\": \"klak@memank.fr\",\n \"id\": 1870\n }\n ]\n }\n ]\n }\n}"}],"_postman_id":"2452f701-066a-454a-9859-09ac039b43ec"}],"id":"def83542-9463-48d2-8236-b2b0d615958c","description":"

À chaque entité, personne ou service correspond une fiche dans le carnet d’adresses.
\nUne fiche d’entité peut contenir une ou plusieurs fiches de services ou de personnes.
\nUne fiche de services peut contenir une ou plusieurs fiches de services ou de personnes.
\nUne des caractéristiques de BillJobs est de n’avoir des adresses qu’au niveau des entités ou des services.
\nLes personnes héritent de l’adresse du niveau supérieur.
\nLes services peuvent avoir leur propre adresse ou bien hériter de celle du niveau supérieur.
\n

\nChaque fiche (entité, service ou personne) comporte des rubriques \"fixes\" proposées par BillJobs (ce sont les rubriques dites \"communication\" et \"comptables\") et des rubriques \"additionnelles\" qui sont définies agence par agence par chaque client.

CRÉATION OU MODIFICATION D’UNE FICHE

Toutes les informations d’une fiche sont décrites dans un JSON à transmettre dans le \"body\".
\nLes erreurs rencontrées dans l’analyse des données des différentes informations ne sont pas bloquantes : la fiche est créée avec les données sans erreur.\nIl sera ensuite possible d’ajouter ou de modifier les données des différentes informations par la modification de la fiche créée.
\n
\nContrôle des doublons :

il est impossible d’avoir 2 entités de même nom,
il est impossible d’avoir des services ou des personnes de même nom dans une même entité.

Contenu du JSON de création ou de modification de fiche

typeFiche (string,obligatoire) :\nLes valeurs possibles sont \"Entite\" ou \"Independant\". Pour un service ou une personne, les valeurs possibles sont \"Service\" ou \"Personne\".
\n
nom (string,obligatoire) : Intitulé de l’entité, du service ou nom de la personne
\n
prenom (string,optionnel) : ne concerne que la fiche d’une personne ou d’un indépendant.
\n
codeCivilite (string,optionnel) : ne concerne que les fiches de personne ou d’un indépendant. Les valeurs possibles des codes de civilités sont données par l’API \"Civilites/Liste\" (cf paragraphe \"Liste des civilités\").
\n
sexe (string,optionnel) : ne concerne que les fiches de personne. Les valeurs possibles sont \"F\" et \"H\" (par défaut).
\n
adresse (Json,optionnel et uniquement pour les entités et services) : définit l’adresse :
\n
- rue (string,optionnel) : le numéro et le nom de la rue
- ville (string,obligatoire) : la ville
- cp (string,optionnel) : le code postal
- pays (string,optionnel) : le nom de pays
- codeIsoregion (string,optionnel) : (cf ci-dessous les codes ISO des régions)
- codeIsoPays (string,optionnel) : (cf ci-dessous les codes ISO des pays)
\n
note (string,optionnel) : Un texte libre.
\n
communication (Json,optionnel) : tableau de JSON avec pour chaque information :
\n
- id (integer, présent et obligatoire uniquement lors de la mise à jour de la rubrique) Identifiant de la valeur de la rubrique dans la fiche d’adresse.
- idRubrique (integer, présent uniquement lors d’une création et obligatoire si nomRubrique est absent) Identifiant du modèle de rubrique additionnelle.
- nomRubrique (string, présent uniquement lors d’une création et obligatoire si idRubrique est absent) Nom du modèle de rubrique additionnelle.
- valeur (string, obligatoire) Si vide lors d’une mise à jour alors il y aura suppression de la valeur de la rubrique dans la fiche adresse.
- complement (string, optionnel) par exemple pour qualifier un numéro de téléphone (\"standard\", \"perso\"...)
\n

nomRubrique peut être
\npour un numéro de téléphone indifféremment : \"Telephone, \"tel\" ou \"phone\"\npour un numéro de portable indifféremment : \"mobile\",\"portable\",\"cell\", \"cellphone\" ou \"MBL\"\npour un numéro de télécopieur indifféremment : \"fax\" ou \"telecopie\"\npour une adresse email indifféremment : \"email\",\"mail\" ou \"mel\"\npour une fonction indifféremment : \"Fonction\" ou \"FONC\"\nLes rubriques dites de communication peuvent être multiples pour une même fiche d’adresse à l’exception de la \"Fonction\". Une erreur sera retournée en cas de création d’une rubrique \"Fonction\" déjà créée.

comptabilite (Json,optionnel) : tableau de JSON avec pour chaque :
\n
- id (integer, présent et obligatoire uniquement lors de la mise à jour de la rubrique). Identifiant de la valeur de la rubrique dans la fiche d’adresse.
- idRubrique (integer, obligatoire uniquement lors d’une création et si nomRubrique est absent) Identifiant du modèle de rubrique additionnelle.
- nomRubrique (string, obligatoire uniquement lors d’une création et si idRubrique est absent) Nom du modèle de rubrique additionnelle
  \"nomRubrique\" peut être
- pour un compte client indifféremment : \"client\",\"cclt\",\"cptclient\" ou \"compteclient\"
- pour un fournisseur indifféremment : \"fournisseur\",\"ccls\",\"cptfournisseur\" ou \"comptefournisseur\"
- pour le suffixe : \"suffixe\"...
- valeur (string, obligatoire) Si vide lors d’une mise à jour alors il y aura suppression de la rubrique dans la fiche adresse.\n Une fiche adresse peut contenir les 3 types de rubriques comptables (compte client, compte fournisseur et suffixe) mais chacune de ces dernières doit être unique par fiche. Une erreur sera retournée en cas de création d’une rubrique déjà créée.
\n
rubriques (Json,optionnel) : tableau de JSON avec pour chaque :
\n
- id (integer, présent et obligatoire uniquement lors de la mise à jour de la rubrique). Identifiant de la valeur de la rubrique dans la fiche d’adresse.
- idRubrique (integer, obligatoire uniquement lors d’une création et si nomRubrique est absent) Identifiant du modèle de rubrique additionnelle. Uniquement lors d’une création.
- nomRubrique (string, obligatoire uniquement lors d’une création et si nomRubrique est absent) Nom du modèle de rubrique additionnelle. nomRubrique est
- valeur (string, obligatoire)\nLa valeur et son format dépendent du type défini dans le modèle de rubrique.
  \nDATE : string de format AAAA-MM-JJ
  \nMONTANT : string exemple : 2000.33 ou 2000,33 ou -2000,33 ou -2000.33
  \nENTIER : integer exemple : 248 ou -456
  \nBOOLEEN : boolean exemple : true ou false
  \nTEXTE : string exemple : \"blabla\"
  \n
  Si vide lors d’une mise à jour alors il y aura suppression de la rubrique dans la fiche adresse
- complement (string, optionnel) Texte complémentaire uniquement pour les rubriques de type \"Listetexte\".
- idElement (integer, optionnel) ID de l’élément sélectionné, uniquement pour les rubriques de type \"Liste\" et \"ListeTexte\".
\n

Les rubriques additionnelles sont uniques dans la fiche d’adresse. Une erreur sera retournée en cas de création d’une rubrique déjà créée.\nIl est impossible d’attribuer une rubrique additionnelle de type \"personne\" à une entité.\nIl est impossible d’attribuer une rubrique additionnelle de type \"entité\" à un service ou une personne sauf à un indépendant.

NB: Les attributs non valorisés doivent être omis.

CODES PAYS

Il s’agit des codes ISO des pays, sur 2 lettres.\nSi rien n’est mentionné, le pays par défaut sera celui ou est située l’agence.

CODES RÉGIONS

Les adresses en France et au Canada peuvent comporter un code ISO de région.\nL’unique raison de ces codes est de permettre à BillJobs de déterminer les régimes de taxes des pièces.\nSi rien n’est mentionné, la région par défaut sera celle ou est située l’agence.

En France, il ne s’agit que des régions suivantes :

Métropole : \"FR\"
Guadeloupe : \"FR-GP\"
Martinique : \"FR-MQ\"
Île de la Réunion : \"FR-RE\"
Mayotte : \"FR-YT\"
Guyane : \"FR-GF\"

Pour le Canada, il s’agit des provinces dont les codes sont :
\n\"CA-QC\", \"CA-YT\", \"CA-NT\", \"CA-NU\", \"CA-BC\"\n\"CA-AB\", \"CA-SK\", \"CA-MB\", \"CA-ON\", \"CA-NL\", \"CA-NB\", \"CA-PE\", \"CA-NS\".

Codes Erreurs communs

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Codes	descriptions
ErrAdresseEntiteNomAbsent	Le nom n'est pas défini
ErrAdresseTypeFicheAbsent	le type de la fiche (typeFiche) n'est pas défini
ErrAdresseTypeFicheNonConforme	le type de la fiche (typeFiche) est incorrect
ErrAdresseEntiteNomExistant	Il existe déjà une entité ayant ce nom
ErrAdresseIndependantNomPrenomExistant	Il existe déjà un indépendant ayant ce nom et ce prénom
ErrAdresseCodeCiviliteNonConforme	Code civilité inconnu
ErrAdresseSexeNonConforme	Indication de sexe incorrecte (doit être M ou F)
ErrAdresseFicheIdInconnu	Il n’y a pas de fiche ayant l’id indiqué
ErrAdresseFicheIdInconnu	Il n’y a pas de fiche ayant l’id indiqué
ErrAdresseIDSupInconnu	Il n’y a pas d’entité ni de service ayant l’id de \"supérieur\" indiqué

\n

Pour les rubriques additionnelles\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Codes	descriptions
ErrAdresseIDRubriqueAdditInconnu	Valeur de rubrique inconnue pour l’id indiqué
ErrAdresseNomRubriqueAbsent	Le nom du modèle de la rubrique additionnelle n’est pas indiqué
ErrAdresseNomRubriqueInconnu	Le modèle de la rubrique additionnelle indiqué par nom n’existe pas
ErrAdresseRubriqueSansValeurIndiquee	La propriété valeur est absente
ErrAdresseRubriqueElementIDInexistant	L’élément de liste ayant l’ID indiqué n’existe pas
ErrAdresseRubriqueElementValeurInexistant	L’élément de liste ayant la valeur indiqué n’existe pas

\n\n

Autres erreurs : Cf. en tête de cette documentation.

\n","event":[{"listen":"prerequest","script":{"id":"cfc350cc-88b6-4c73-9cd6-35dc907b8ff4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c2e9e7a1-ed10-449c-ad68-0d13dbe9a2bb","type":"text/javascript","exec":[""]}}],"_postman_id":"def83542-9463-48d2-8236-b2b0d615958c"}],"id":"97cefc3c-8b78-4d0b-b356-c2a5ed4d62e6","description":"

Le carnet d'adresses est une des fondations de l'application BillJobs.\nToutes les entités et les personnes utilisées dans BillJobs ont une fiche dans le carnet d'adresses.\nIl existe un carnet d'adresses par base de données.

Il existe un ensemble d'APIs pour définir les rubriques additionnelles, rechercher, créer, lire, modifier ou supprimer des fiches.\nLes rubriques additionnelles ne peuvent être créées, modifiées ou supprimées qu'avec un compte ayant des droits d'administrateur.

\n","event":[{"listen":"prerequest","script":{"id":"709da7a1-7ece-4670-a3bf-2e1db833558c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2e88c1b7-9bd4-4ca6-8af3-dcfbbe574307","type":"text/javascript","exec":[""]}}],"_postman_id":"97cefc3c-8b78-4d0b-b356-c2a5ed4d62e6"},{"name":"APIs \"Internationales\"","item":[{"name":"ListePays","id":"53814c58-b776-41df-9fcc-448b90309979","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"http://{{url}}/api/json/v1/INTERNATIONAL/ListePays?Filtre=su","urlObject":{"protocol":"http","path":["api","json","v1","INTERNATIONAL","ListePays"],"host":["{{url}}"],"query":[{"key":"Filtre","value":"su"}],"variable":[]}},"response":[],"_postman_id":"53814c58-b776-41df-9fcc-448b90309979"},{"name":"ListePaysSelonISO","id":"e3f8c118-180c-44f8-9707-23edd5dae328","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"http://{{url}}/api/json/v1/INTERNATIONAL/ListePaysSelonISO?Filtre=MG","urlObject":{"protocol":"http","path":["api","json","v1","INTERNATIONAL","ListePaysSelonISO"],"host":["{{url}}"],"query":[{"key":"Filtre","value":"MG"}],"variable":[]}},"response":[],"_postman_id":"e3f8c118-180c-44f8-9707-23edd5dae328"},{"name":"GetSiPaysARegions","id":"fea46309-592c-4651-b0b1-cc6d788e1734","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"http://{{url}}/api/json/v1/INTERNATIONAL/GetSiPaysARegions?Filtre=FR","description":"

Dans BillJobs, les régions ont seulement un rôle fiscale.\nSeuls la France et le Canada ont donc de telels régions.

JSON de retour pour la France :

{\n    \"pays\": \"France\",\n    \"ISO\": \"FR\",\n    \"nom\": \"Région\",\n    \"listeRegions\": [\n        {\n            \"nom\": \"Métropole\",\n            \"ISO\": \"FR\",\n            \"defaut\": true\n        },\n        {\n            \"nom\": \"Guadeloupe\",\n            \"ISO\": \"FR-GP\"\n        },\n        {\n            \"nom\": \"Guyane\",\n            \"ISO\": \"FR-GF\",\n            \"sansTaxe1\": true\n        },\n        {\n            \"nom\": \"Île de la Réunion\",\n            \"ISO\": \"FR-RE\"\n        },\n        {\n            \"nom\": \"Martinique\",\n            \"ISO\": \"FR-MQ\"\n        },\n        {\n            \"nom\": \"Mayotte\",\n            \"ISO\": \"FR-YT\",\n            \"sansTaxe1\": true\n        }\n    ]\n}

Pour le Canada, il s'agit des différentes provinces.

Codes Erreurs

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Codes	description
ErrPaysSansRegion	Le pays indiqué n’a pas de région (dans BillJobs, seuls la France et le Canada ont des régions qui sont en fait des régions fiscales).
ErrCodeISOPaysAbsent	Le code ISO Pays est absent
ErrCodeISOPaysInconnu	Le code ISO du pays est inconnu.
ErrFichierInternationalAbsent	Fichier International n'est pas sur le serveur API

","urlObject":{"protocol":"http","path":["api","json","v1","INTERNATIONAL","GetSiPaysARegions"],"host":["{{url}}"],"query":[{"key":"Filtre","value":"FR"}],"variable":[]}},"response":[],"_postman_id":"fea46309-592c-4651-b0b1-cc6d788e1734"},{"name":"GetCodesISOPays","id":"edc14442-38e3-4f1e-a51a-4a4427d51751","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"http://{{url}}/api/json/v1/INTERNATIONAL/GetCodesISOPays?Filtre=99","urlObject":{"protocol":"http","path":["api","json","v1","INTERNATIONAL","GetCodesISOPays"],"host":["{{url}}"],"query":[{"key":"Filtre","value":"99"}],"variable":[]}},"response":[],"_postman_id":"edc14442-38e3-4f1e-a51a-4a4427d51751"},{"name":"GetISOPaysSelonNom","id":"7f305fa5-08b2-44e0-8fbc-14b893a026bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"http://{{url}}/api/json/v1/INTERNATIONAL/GetISOPaysSelonNom?Filtre=Allema","urlObject":{"protocol":"http","path":["api","json","v1","INTERNATIONAL","GetISOPaysSelonNom"],"host":["{{url}}"],"query":[{"key":"Filtre","value":"Allema"}],"variable":[]}},"response":[],"_postman_id":"7f305fa5-08b2-44e0-8fbc-14b893a026bf"},{"name":"GetISOPaysSelonISO","id":"3e202851-a964-49ee-a9bf-6497bbbf4049","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"http://{{url}}/api/json/v1/INTERNATIONAL/GetISOPaysSelonISO?Filtre=MG","urlObject":{"protocol":"http","path":["api","json","v1","INTERNATIONAL","GetISOPaysSelonISO"],"host":["{{url}}"],"query":[{"key":"Filtre","value":"MG"}],"variable":[]}},"response":[],"_postman_id":"3e202851-a964-49ee-a9bf-6497bbbf4049"}],"id":"5cb7acd2-1520-439b-9da7-cf9f5206accb","_postman_id":"5cb7acd2-1520-439b-9da7-cf9f5206accb","description":""},{"name":"Taxes","item":[{"name":"GetTauxSelonIdTaxe","id":"e22d62ea-a010-4c3d-8c27-3e3a64b29364","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"http://{{url}}/api/json/v1/Taxes/GetTauxTaxe?idTaxe=4","description":"

Cet API retourne le taux selon l'identifiant de la taxe

valeur Retour

\n\n \n \n \n \n \n \n \n \n \n

Champ	description
Autoliberatoire	0 : Sans TVA Auto-libératoire sur Achat\n 1 : Avec TVA Auto-libératoire sur Achat

","urlObject":{"protocol":"http","path":["api","json","v1","Taxes","GetTauxTaxe"],"host":["{{url}}"],"query":[{"description":{"content":"","type":"text/plain"},"key":"idTaxe","value":"4"}],"variable":[]}},"response":[{"id":"2fe2abd7-634c-4a4a-a26c-bc55a5c25abf","name":"GetTauxSelonIdTaxe","originalRequest":{"method":"GET","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"http://{{url}}/api/json/v1/Taxes/GetTauxTaxe?idTaxe=2","protocol":"http","host":["{{url}}"],"path":["api","json","v1","Taxes","GetTauxTaxe"],"query":[{"key":"idTaxe","value":"2","description":"\n"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Date","value":"Tue, 13 Oct 2020 08:20:37 GMT"},{"key":"Content-Length","value":"33"}],"cookie":[],"responseTime":null,"body":"{\n \"Taux%\": 7,\n \"autoliberatoire\": 1\n}"}],"_postman_id":"e22d62ea-a010-4c3d-8c27-3e3a64b29364"},{"name":"GetTaxesSelonIdTaxe","id":"1cbe3ada-3f1c-4d6f-9480-e38d779d4324","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"http://{{url}}/api/json/v1/Taxes/GetListeTaxes?listeidTaxe=4","description":"

Cet API retourne les informations sur la liste des identifiants de taxe

valeur Retour

\n\n \n \n \n \n \n \n \n \n \n \n \n

Champ	description
tvaoutaxe2	V : vente\n A : Achat\n 2 : vente et Achat
siactive	1 : Activé\n 0 : En sommeil

","urlObject":{"protocol":"http","path":["api","json","v1","Taxes","GetListeTaxes"],"host":["{{url}}"],"query":[{"description":{"content":"

id1,id2,id3.......

\n","type":"text/plain"},"key":"listeidTaxe","value":"4"}],"variable":[]}},"response":[],"_postman_id":"1cbe3ada-3f1c-4d6f-9480-e38d779d4324"},{"name":"GetListeClasseTaxes","id":"5554aba5-a69e-4c11-8369-7c410dedcc6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"http://{{url}}/api/json/v1/Taxes/GetListeClasses","description":"

Cet API retourne la liste de classe de taxe

valeur Retour

\n\n \n \n \n \n \n \n \n \n \n

Champ	description
typeclasse	V : vente\n A : Achat\n 2 : vente et Achat

","urlObject":{"protocol":"http","path":["api","json","v1","Taxes","GetListeClasses"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"7d5591bb-59a1-4f48-bc2e-3c5744a8a7f4","name":"GetListeClasseTaxes","originalRequest":{"method":"GET","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"http://{{url}}/api/json/v1/Taxes/GetListeClasses"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Date","value":"Mon, 12 Oct 2020 15:24:01 GMT"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"163"}],"cookie":[],"responseTime":null,"body":"{\n \"ListeClasseTaxes\": [\n {\n \"id\": 3,\n \"nom\": \"EXONERE\",\n \"typeclasse\": \"V\"\n },\n {\n \"id\": 4,\n \"nom\": \"Standard\",\n \"typeclasse\": \"V\",\n \"sidefaut\": true\n },\n {\n \"id\": 35,\n \"nom\": \"CEE\",\n \"typeclasse\": \"V\"\n },\n {\n \"id\": 2,\n \"nom\": \"7 %\",\n \"typeclasse\": \"V\"\n },\n {\n \"id\": 27,\n \"nom\": \"Taux réduit\",\n \"typeclasse\": \"V\"\n },\n {\n \"id\": 65,\n \"nom\": \"DOM TOM\",\n \"typeclasse\": \"V\"\n }\n ]\n}"}],"_postman_id":"5554aba5-a69e-4c11-8369-7c410dedcc6b"},{"name":"GetIDTaxeSelonClasseEtRegion","id":"e9d24e60-b9aa-4f0e-b048-b9d16f302db5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"http://{{url}}/api/json/v1/Taxes/GetIDTaxeSelonClasseEtRegion?idClasse=499&idDesti=695","description":"

Cet API retourne l'identifiant de la taxe selon sa classe et région du destinataire

Codes Erreurs

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Codes	description
ErrIDClasseTaxeNonConforme	Identifiant classe de taxe non conforme
ErrCodeISORegionAgenceNonConforme	Code ISO Region de l'Agence non Conforme
ErrCodeISORegionDestiNonConforme	Code ISO Region de destinataire non Conforme
ErrListeRegionsVide	Liste régions vide

","urlObject":{"protocol":"http","path":["api","json","v1","Taxes","GetIDTaxeSelonClasseEtRegion"],"host":["{{url}}"],"query":[{"key":"idClasse","value":"499"},{"key":"idDesti","value":"695"}],"variable":[]}},"response":[{"id":"9de4b208-80f9-4eff-9ba0-eaf782b09106","name":"GetIDTaxeSelonClasseEtRegion","originalRequest":{"method":"GET","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"http://{{url}}/api/json/v1/Taxes/GetIDTaxeSelonClasseEtRegion?idClasse=499&idDesti=695","protocol":"http","host":["{{url}}"],"path":["api","json","v1","Taxes","GetIDTaxeSelonClasseEtRegion"],"query":[{"key":"idClasse","value":"499","description":"identifiant de la classe de taxe"},{"key":"idDesti","value":"695","description":"identifiant du destinataire"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Date","value":"Tue, 10 Dec 2019 16:47:57 GMT"},{"key":"Content-Length","value":"12"}],"cookie":[],"responseTime":null,"body":"{\n \"idTaxe\": 0\n}"}],"_postman_id":"e9d24e60-b9aa-4f0e-b048-b9d16f302db5"},{"name":"GetTaxeSelonClasseEtRegion","id":"e373aae3-339e-47ef-9dcd-e902145b47a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

La base de données de BillJobs

\n","key":"base","type":"text","value":"{{agence}}"},{"description":"

Le type MIME de la ressource

\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"http://{{url}}/api/json/v1/Taxes/GetTaxeSelonClasseEtRegion?idClasse=4&idDesti=603","description":"

Cet API retourne un json avec l'identifiant,le nom et le taux de la taxe selon sa classe et région du destinataire

Codes Erreurs

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Codes	description
ErrIDClasseTaxeNonConforme	Identifiant classe de taxe non conforme
ErrCodeISORegionAgenceNonConforme	Code ISO Region de l'Agence non Conforme
ErrCodeISORegionDestiNonConforme	Code ISO Region de destinataire non Conforme
ErrListeRegionsVide	Liste régions vide
ErrClasseADefinir	La classe n'existe pas

","urlObject":{"protocol":"http","path":["api","json","v1","Taxes","GetTaxeSelonClasseEtRegion"],"host":["{{url}}"],"query":[{"key":"idClasse","value":"4"},{"key":"idDesti","value":"603"}],"variable":[]}},"response":[{"id":"cc3f51da-288a-467a-9208-aada8e43e9ee","name":"GetTaxeSelonClasseEtRegion","originalRequest":{"method":"GET","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"http://{{url}}/api/json/v1/Taxes/GetTaxeSelonClasseEtRegion?idClasse=4&idDesti=603","protocol":"http","host":["{{url}}"],"path":["api","json","v1","Taxes","GetTaxeSelonClasseEtRegion"],"query":[{"key":"idClasse","value":"4"},{"key":"idDesti","value":"603"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Wed, 25 Nov 2020 15:08:15 GMT"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"50"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 47,\n \"nom\": \"20 % (intracom)\",\n \"valeur\": \"20.00\"\n}"}],"_postman_id":"e373aae3-339e-47ef-9dcd-e902145b47a8"}],"id":"e05c3d4c-bbfa-49f9-a160-7998555d382d","_postman_id":"e05c3d4c-bbfa-49f9-a160-7998555d382d","description":""},{"name":"Détail erreur","id":"024d5efe-a509-4646-a0a8-723d215e06d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"key":"base","value":"{{agence}}","description":"

La base de données de BillJobs

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

Le type MIME de la ressource

\n","type":"text"}],"url":"http://{{url}}/api/json/v1/Erreur/?codeErreur=ErrErreurCodeInconnu","description":"

API donnant le descriptif d'un code d'erreur retourné par le serveur.

Codes Erreurs

Exemple :{\"Erreur\":[{\"Contenu\":\"ErreurDB\"},{\"statut\":400}]}

\n\n \n \n \n \n \n \n \n \n \n \n \n \n

Codes	description
ErrErreurCodeAbsent	Le code d'erreur n’est pas indiqué.
ErrErreurCodeInconnu	Le code d'erreur est inconnu.

\nAutres erreurs : Cf. en tête de cette documentation.

","urlObject":{"protocol":"http","path":["api","json","v1","Erreur",""],"host":["{{url}}"],"query":[{"description":{"content":"

(string, obligatoire) : Code d'erreur ayant été retourné par le serveur

\n","type":"text/plain"},"key":"codeErreur","value":"ErrErreurCodeInconnu"},{"disabled":true,"description":{"content":"

(string, optionnel) : Code ISO de la langue du descriptif (inutilisé pour l'instant)

\n","type":"text/plain"},"key":"langue","value":"FR"}],"variable":[]}},"response":[],"_postman_id":"024d5efe-a509-4646-a0a8-723d215e06d8"}],"event":[{"listen":"prerequest","script":{"id":"cf9be7da-2e54-4690-bd94-e583b756f5fb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"13d425bb-1d36-4d02-8a2f-6005e26b7ba8","type":"text/javascript","exec":[""]}}]}

Codes	descriptions
ErrAdresseIdFicheAbsent	L'identifiant de la fiche n'est pas défini
ErrAdresseFicheSuppressionImpossible	Suppression de la fiche impossible
ErrAdresseFicheIdInconnu	l'identifiant indiqu une fiche inconnue