Documentation technique CAIRN Media

Publier une annonce légale par l’API illico

Devis, commande, suivi de parution et récupération des attestations, justificatifs et factures. Version 1.29 de la documentation IDM Solutions, réécrite pour être lue par une équipe technique.

Format REST, JSON UTF-8Authentification clé publique et signature SHA-256Limite 300 requêtes par minute
Instance de test CAIRN Media — clés fournies séparémenthttps://fr-cairn-test.illico.io
Production CAIRN Mediahttps://fr-cairn.illico.io
Fichiers Spécification OpenAPI 3.0 (YAML) Collection Postman Dans Postman : Import, puis glisser le fichier. La collection calcule les en-têtes Timestamp et Signature à chaque appel ; il ne reste qu’à renseigner cle_publique, cle_secrete et base_url dans ses variables.

Le parcours d’une annonce, en cinq appels

  1. 1DevisPOST /devis
  2. 2CommandePOST /commande
  3. 3StatutGET /annonce/{ref}/statut
  4. 4DocumentsGET /annonce/{ref}/documents
  5. 5FacturesGET /annonce/{ref}/factures

Première annonce en cinq appels

Le parcours complet, avec les valeurs qui passent d'un appel au suivant. Les exemples utilisent le département 33 (Gironde) et une constitution de SARL.

1. Trouver la publication. GET /publications?departement=33 renvoie les journaux habilités sur le département, avec leur id et ce qu'ils acceptent (en-tête, justificatif papier, justificatif numérique). Gardez l'id de la publication retenue, ici 1.

2. Choisir une date. GET /dates-parutions?publication=1&departement=33&quantite=3 donne les trois prochaines parutions et, pour chacune, l'heure de bouclage réellement configurée. Vous pouvez aussi omettre date_parution au devis : la prochaine date valide est alors calculée pour vous.

3. Chiffrer et vérifier le rendu. POST /devis avec publication, departement, categorie (CONSTI), forfait (SARL) et texte. La réponse donne le tarif détaillé et, surtout, le texte composé tel qu'il sera publié : c'est le moment de le faire valider par l'utilisateur, car il n'y a pas de modification après commande.

4. Commander. POST /commande avec les mêmes champs, plus dossier, mode_facturation et, si vous facturez l'annonceur, l'objet facturation. Passez votre propre identifiant dans numero_commande : il remplacera la référence illico dans tous les appels de suivi. La réponse contient la reference illico (par exemple L22EJ00001) et la date de parution retenue.

5. Suivre et récupérer. GET /annonce/{reference}/statut renvoie a-paraitre, parue ou suspendue (avec un motif). Une fois parue, GET /annonce/{reference}/documents donne les liens de téléchargement de l'attestation, du justificatif et de la facture. Pour un lot d'annonces, POST /annonces/statuts et POST /annonces/documents prennent un tableau de références en un seul appel.

En cas de correction après commande : DELETE /annonce/{reference} puis nouvelle commande. En cas d'erreur d'appel, la réponse contient "resultat": "erreur" et la liste des codes en cause.

Scénario d’intégration

Moment Appel Ce qu'il apporte
Une fois, à l'intégration GET /client Coordonnées et mode de facturation par défaut du compte
GET /contacts, POST /contact Contacts rattachés à la clé, pour le champ contact de la commande
GET /categories Codes de catégories et classes de style disponibles par catégorie
GET /feuilles-styles Classes HTML utilisables dans le texte et leur CSS
GET /pays, GET /departements Référentiels pour la facturation et le département de parution
Avant chaque annonce GET /publications Journaux habilités sur le département
GET /dates-parutions Prochaines parutions et heures de bouclage
POST /devis Tarif détaillé et texte composé
Commande POST /commande Enregistrement, référence illico, date retenue
DELETE /annonce/{reference} Annulation, avec facture et avoir si déjà facturée
Suivi GET /annonce/{reference}/statut, POST /annonces/statuts Statut unitaire ou en lot
Après parution GET /annonce/{reference}/documents, POST /annonces/documents Attestation, justificatif, facture, avoir
GET /annonce/{reference}/factures, POST /annonces/factures Factures détaillées ligne à ligne, remises, TVA

Venir de l’API Les Echos

Lecture faite par CAIRN Media à partir de la spécification OpenAPI Les Echos (v1.0, périmètre annonces légales) et de la documentation illico v1.29 ; les correspondances sont indicatives, seule la documentation de chaque API fait foi.

Chez Les Echos Chez illico À savoir
Bearer token En-têtes Application, Timestamp, Signature (SHA-256) Trois lignes de code, voir les exemples de chaque appel
GET /newspapers/{departmentCode} GET /publications?departement= Même logique ; illico précise en-tête et justificatifs acceptés
GET /legal-notice-types GET /categories + GET /forfaits Deux niveaux chez illico : categorie, puis forfait pour les constitutions et modifications
POST /legal-notices/estimate (tous les journaux du département) POST /devis (une publication) Boucler sur les publications si vous voulez comparer ; le devis renvoie aussi le texte composé
POST /legal-notices POST /commande customerReference devient numero_commande ; header et logo deviennent l'objet entete ; supportingDocumentQuantity devient justificatifs_papiers et justificatif_numerique
newspaperId optionnel, journal par défaut publication obligatoire Le choix du journal est explicite
publicationDate absent = aujourd'hui date_parution absent = prochaine parution possible selon le bouclage
hasBodacc Pas d'équivalent dans l'API À traiter hors API si nécessaire
GET /legal-notices/{reference} GET /annonce/{reference}/statut, /documents, /factures Trois appels ciblés au lieu d'une fiche unique
GET /legal-notices (liste paginée filtrable) POST /annonces/statuts avec vos références Pas de recherche libre : conservez vos numero_commande côté Indy
Statuts review, pending, validated, published, refused, canceled a-paraitre, parue, suspendue (+ motif) Une annonce annulée n'apparaît plus dans les statuts
POST /legal-notices/{reference}/cancel DELETE /annonce/{reference} Ni l'un ni l'autre ne permet de modifier une annonce commandée
GET /legal-notices/documents/{id}/download URLs directes renvoyées par /documents Pas d'appel intermédiaire
GET /invoices GET /annonce/{reference}/factures, POST /annonces/factures illico détaille chaque ligne, les remises et la TVA
Webhook (PUT /webhook) Pas de webhook Interroger POST /annonces/statuts en lot, par exemple à chaque heure de bouclage
Codes HTTP et erreurs RFC 7807 resultat + tableau erreurs dans le corps Toujours HTTP 200, erreurs comprises : le champ resultat fait foi
Contenu HTML : h1 et p, br, strong, b p uniquement, br, strong, b, classes fs-* Même famille de règles ; le titre passe par <p class="fs-titre">
GET /dates-parutions, GET /feuilles-styles, appels en lot Sans équivalent chez Les Echos

Utilisation

Architecture RESTful. Les paramètres sont transmis dans le corps de la requête au format JSON encodé en UTF-8. Les réponses sont au format JSON encodé en UTF-8.

Toutes les réponses contiennent le champ resultat (succes | erreur). En cas d'erreur, le tableau erreurs contient un ou plusieurs codes (voir le schéma CodeErreur). Tous les appels renvoient le code HTTP 200, y compris en cas d'erreur métier, de signature invalide ou de dépassement de quota. Le seul indicateur fiable est donc le champ resultat : les réponses succès et erreur sont modélisées sur un 200 unique avec un oneOf discriminé par resultat.

Sécurisation

Couple clé publique / clé secrète fourni par IDM Solutions. Tous les appels doivent être effectués de serveur à serveur — jamais depuis du JavaScript client (les clés seraient exposées).

Trois en-têtes HTTP obligatoires sur chaque appel : - Application : la clé publique. - Timestamp : entier, secondes écoulées depuis le 01/01/1970 (Unix). Écart maximum de 5 secondes avec l'heure de Paris. - Signature : chaîne hexadécimale calculée comme suit.

Calcul de la signature

sha256("{cle_secrete}+{methode_http}+{chemin}+{body}+{timestamp}")
  • methode_http : GET / POST / PUT / DELETE
  • chemin : chemin de l'API sans les paramètres d'URL (query string exclue), ex. /annonce-legale/api/externe/publications
  • body : le body exactement tel qu'envoyé, octets bruts, espaces et retours à la ligne inclus (chaîne vide pour un GET). Le serveur vérifie la signature en lisant le body brut avant tout traitement ; ne pas re-sérialiser le JSON entre la signature et l'envoi.
  • Les éléments sont assemblés avec le caractère +.

Exemple 1 (GET, body vide)

sha256("f539e7fe-9f89-48cf-ac0e-e7378d6eda31+GET+/annonce-legale/api/externe/publications++1656679723")
→ cf594748bbd1e820cf71b37d903b9bc6a88ad9e86fa7f142184fdd761680331a

Exemple 2 (POST avec body)

sha256('f539e7fe-9f89-48cf-ac0e-e7378d6eda31+POST+/annonce-legale/api/externe/devis+{"publication":1,"departement":"33","date_parution":"2022-12-31","categorie":"CONSTI","forfait":"SARL","texte":"<p>Aux termes d'un acte sous ssp <br/> en date du …</p>","justificatifs_papiers":1,"justificatif_numerique":true}+1656679723')
→ 060ae4ee2a0a2771b882301ce72fc96c818859fd9d5df474cd0539d1be9bb5c5

Limitation

300 requêtes par minute (au-delà : err_requetes_max).

Texte et styles (annonces et en-têtes)

  • Le texte doit être du HTML. Seule la balise <p> est autorisée comme balise de contenu ; le texte de toute autre balise de contenu et le texte hors <p> sont ignorés.
  • Balises en ligne autorisées dans un <p> : <strong> / <b> (gras), <br> / <br/> (saut de ligne), et <span class="..."> pour les feuilles de style de type caractere.
  • Plage de caractères autorisée : Windows-1252. Tout caractère hors plage déclenche une erreur précisant le caractère fautif.
  • Les classes de style (class="fs-...") sont fournies par GET /feuilles-styles et, par catégorie, par GET /categories. Sans classe ou avec une classe incorrecte, la classe par défaut de la catégorie (généralement fs-texte) ou de l'en-tête (généralement fs-prescripteur_adresse) est appliquée. Si un paragraphe possède plusieurs classes valides, celle de plus petit rang l'emporte.
  • Filets : si au moins une feuille de style de type filet existe, <hr class="fs-filet"></hr> peut remplacer <p class="fs-filet"></p>. Le texte d'un <p> portant une classe de type filet n'est pas traité et n'apparaît pas.

Délai de bouclage

Le délai de bouclage est en général identique quel que soit le jour de parution. Si un jour non ouvré se situe entre le jour de bouclage et le jour de parution, le bouclage est reculé de 24h, puis à nouveau jusqu'au premier jour ouvré. Exemple (parution mardi/jeudi, bouclage la veille 16h) : semaine du lundi de Pentecôte → bouclage vendredi 16h ; semaine du jeudi de l'Ascension → bouclage mardi 16h. Le journal peut aussi modifier exceptionnellement ses délais (ponts de mai, fermeture annuelle) : GET /dates-parutions retourne le bouclage réellement configuré.

Modifier une annonce

L'API ne propose pas de modification d'une annonce commandée : il n'y a pas d'endpoint PUT. Pour corriger une annonce, le parcours est annuler puis recommander : 1. DELETE /annonce/{reference} annule l'annonce. Si elle avait déjà été facturée, la réponse renvoie la facture et l'avoir correspondant. 2. POST /commande enregistre la nouvelle annonce avec le texte corrigé (et, si vous le souhaitez, un nouveau numero_commande pour tracer le remplacement côté prescripteur).

Pour éviter les corrections après commande, calculez d'abord un POST /devis : il renvoie le texte composé tel qu'il sera publié (classes de style résolues) et permet de faire valider le rendu et le tarif avant de commander.

Publications autorisées

La clé API est rattachée à un compte client illico. Les publications accessibles à ce compte sont configurées par le journal, et cette configuration s'applique à GET /publications comme à POST /devis et POST /commande. Concrètement : les identifiants renvoyés par GET /publications?departement=XX sont les seuls titres dans lesquels la clé peut commander, et ce sont ceux couverts par l'accord commercial avec CAIRN Media. Une commande sur un autre identifiant renvoie une erreur (err_publication_non_habilite ou err_publication_introuvable).

Formats de dates

AAAA-MM-JJ (date) et AAAA-MM-JJ HH:MM:SS (date et heure de bouclage, 24h) partout : Devis, Commande et Dates de parutions.

Codes départements

Corse-du-Sud : 2A — Haute-Corse : 2B.

Historique des versions

Date Version Évolution
18/10/2022 1.00 Première version publiée
02/11/2022 1.01 Catégories ; paramètres d'URL retirés du calcul de signature
15/12/2022 1.05 Champ contact à la commande ; API Contacts
20/12/2022 1.06 Limite de 300 requêtes/minute ; API Statut ; logo par publication
20/02/2023 1.09 API Annulation ; statut et documents d'une annonce ; codes d'erreur
23/03/2023 1.12 Styles et disposition des en-têtes
13/06/2023 1.13 Plage de caractères autorisée (Windows-1252)
15/09/2023 1.16 API Dates de parutions
11/12/2023 1.17 Forfaits 2024 : catégorie MODIF et ses forfaits ; AUTRE devient CONSTI_AUTRE
26/01/2024 1.18 Motif des annonces suspendues ; suivi par numero_commande
28/02/2024 1.19 Création de contacts ; /dates-parution déprécié au profit de /dates-parutions
02/07/2024 1.20 Routes /annonces/documents et /annonces/statuts ; API Factures
05/08/2024 1.21 envoi_justificatif à la commande ; lignes de factures
30/10/2024 1.22 Objet remises sur les factures
20/11/2024 1.23 envoi_justificatif passe à false par défaut
24/12/2024 1.24 Forfait MOD_NON_DISSOL
12/02/2025 1.26 API Client ; "clé privée" renommée "clé secrète"
01/09/2025 1.27 Email de l'annonceur non obligatoire
19/03/2026 1.28 API Feuilles de styles ; classes par catégorie ; texte composé au retour du devis
08/09/2026 1.29 API Forfaits ; date_bouclage au retour du devis ; corrections des exemples et des types

Annonces

Devis, commande, annulation et suivi des annonces

Devis

POST/annonce-legale/api/externe/devis

Calcule le tarif d'une annonce sans l'enregistrer.

  • Si date_parution n'est pas précisée, la prochaine date est proposée en tenant compte du délai de bouclage.
  • Si la date demandée ne respecte pas le bouclage, la prochaine date est calculée et retournée dans date_parution.
  • forfait est obligatoire selon la catégorie (CONSTI, MODIF).
  • Justificatifs papier : 0 par défaut si la publication propose le justificatif numérique, sinon 1.
  • Retourne également le texte composé après traitement (classes de style résolues).

Corps de la requête

publicationentierobligatoire
Identifiant de la publication (cf. GET /publications).
departementchaîneobligatoire
Département de parution (2A / 2B pour la Corse).
date_parutionchaîne, date
Date de parution souhaitée (AAAA-MM-JJ). Si absente, la prochaine date est proposée en tenant compte du délai de bouclage.
categoriechaîne, énuméréeobligatoire
Codes de catégorie (annexe "Catégories").
Valeurs : ADDITIAUTRECHG_PATCHG_REGCLOTURCONSTI+11 autres voir la liste
forfaitchaîne, énumérée
Forfaits (annexe "Forfaits").
Valeurs : EURLSASARLSASSASUSC+22 autres voir la liste
enteteobjet
En-tête (carton) de l'annonce, avec logo et/ou texte.
mime_typechaîne, énumérée
Format du logo.
Valeurs : image/jpegimage/pngapplication/pdf
datachaîne, base64
Chaîne base64 du logo. Obligatoire si mime_type est présent.
dispositionchaîne, énumérée
Disposition de l'en-tête (annexe "Disposition en-tête").
Valeurs : carton_texte_sans_imagecarton_image_sans_textecarton_image_texte_droitecarton_image_texte_bas voir la liste
textechaîne
Texte de l'en-tête au format HTML. Chaque paragraphe doit être encadré de <p> et </p> ; retours à la ligne forcés par <br/>. Classes de type entete disponibles via GET /feuilles-styles?type=entete (généralement fs-prescripteur_nom rang 1 et fs-prescripteur_adresse rang 2 / défaut).
textechaîneobligatoire
Texte de l'annonce au format HTML (<p> uniquement, <br/> pour les retours forcés, classes fs-*).
justificatifs_papiersentier
Nombre de justificatifs papier souhaités, si la publication les propose. Défaut 0 si la publication propose le justificatif numérique, sinon 1.
justificatif_numeriquebooléen
Demande la génération d'un justificatif numérique.

Réponse en succès

Toujours accompagnée de "resultat": "succes". En cas d’erreur, la réponse contient "resultat": "erreur" et un tableau erreurs de codes (liste des codes).

date_parutionchaîne, date
Date de parution retenue (AAAA-MM-JJ). Égale à la date demandée si le bouclage est respecté, sinon la prochaine date calculée.
date_bouclagechaîne
Date et heure de bouclage au format AAAA-MM-JJ HH:MM:SS.
textechaîne
Texte de l'annonce composé après traitement (classes résolues).
tarifobjet
Tarif détaillé d'une annonce (devis ou commande). Les postes justificatif_papier, justificatif_numerique et frais_port sont absents s'ils ne s'appliquent pas.
annonceobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
justificatif_papierobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
justificatif_numeriqueobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
frais_portobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
totauxobjet
montant_htnombre
Montant hors taxe total.
montant_tvanombre
Montant total de TVA.
montant_ttcnombre
Montant TTC total.
tvatableau d'objets
tauxnombre
Taux de TVA.
montantnombre
Montant total de TVA au taux exprimé.

Commande

POST/annonce-legale/api/externe/commande

Enregistre la commande d'une annonce.

  • Si date_parution n'est pas précisée, la prochaine date est automatiquement affectée en tenant compte du délai de bouclage.
  • forfait est obligatoire selon la catégorie (CONSTI, MODIF).
  • facturation est obligatoire si mode_facturation = annonceur.
  • Si contact n'est pas spécifié, le contact par défaut du compte API est utilisé.
  • numero_commande (50 caractères max.) permet ensuite d'utiliser ce numéro à la place de la reference illico dans tous les endpoints de suivi.
  • Justificatifs papier : 0 par défaut si la publication propose le justificatif numérique, sinon 1.
  • largeur / largeur_texte : leur prise en compte dépend du paramétrage du journal et de la clé API.

Corps de la requête

publicationentierobligatoire
Identifiant de la publication.
departementchaîneobligatoire
Département de parution (2A / 2B pour la Corse).
date_parutionchaîne, date
Date de parution souhaitée (AAAA-MM-JJ). Si absente, la prochaine date est affectée en tenant compte du délai de bouclage.
categoriechaîne, énuméréeobligatoire
Codes de catégorie (annexe "Catégories").
Valeurs : ADDITIAUTRECHG_PATCHG_REGCLOTURCONSTI+11 autres voir la liste
forfaitchaîne, énumérée
Forfaits (annexe "Forfaits").
Valeurs : EURLSASARLSASSASUSC+22 autres voir la liste
contactentier
Identifiant du contact (cf. GET /contacts). Si absent, le contact par défaut du compte API est utilisé.
numero_commandechaîne
N° de commande unique de l'annonce dans la base du prescripteur. S'il est fourni, il peut remplacer la référence illico pour le suivi.
50 caractères max.
dossierchaîneobligatoire
Référence du dossier du prescripteur.
enteteobjet
En-tête (carton) de l'annonce, avec logo et/ou texte.
mime_typechaîne, énumérée
Format du logo.
Valeurs : image/jpegimage/pngapplication/pdf
datachaîne, base64
Chaîne base64 du logo. Obligatoire si mime_type est présent.
dispositionchaîne, énumérée
Disposition de l'en-tête (annexe "Disposition en-tête").
Valeurs : carton_texte_sans_imagecarton_image_sans_textecarton_image_texte_droitecarton_image_texte_bas voir la liste
textechaîne
Texte de l'en-tête au format HTML. Chaque paragraphe doit être encadré de <p> et </p> ; retours à la ligne forcés par <br/>. Classes de type entete disponibles via GET /feuilles-styles?type=entete (généralement fs-prescripteur_nom rang 1 et fs-prescripteur_adresse rang 2 / défaut).
textechaîneobligatoire
Texte de l'annonce au format HTML (<p> uniquement, <br/> pour les retours forcés, classes fs-*).
mode_facturationchaîne, énuméréeobligatoire
Destinataire de la facture.
Valeurs : prescripteurannonceur voir la liste
facturationobjet
Coordonnées de facturation. Obligatoire si mode_facturation = annonceur.
nom_raison_socialechaîneobligatoire
Nom ou raison sociale.
prenom_nom_complementchaîne
Prénom ou complément de nom.
adressechaîneobligatoire
adresse_complementchaîne
Complément d'adresse.
code_postalchaîneobligatoire
villechaîneobligatoire
payschaîneobligatoire
Code pays ISO 3166 alpha-3, fourni par GET /pays.
emailchaîne, email
Email. Non obligatoire depuis la v1.27.
telephonechaîne
Numéro de téléphone.
mobilechaîne
Numéro de téléphone mobile.
justificatifs_papiersentier
Nombre de justificatifs papier souhaités, si la publication les propose. Défaut 0 si la publication propose le justificatif numérique, sinon 1.
justificatif_numeriquebooléen
Demande la génération d'un justificatif numérique.
envoi_justificatifbooléen
Demande l'envoi du justificatif numérique par email lorsqu'il est généré.
défaut false
largeurnombre
Nombre total de colonnes sur lesquelles l'annonce sera publiée. Application dépendante du paramétrage du journal et de la clé API.
largeur_textenombre
Largeur d'une colonne de texte, en nombre de colonnes journal. Application dépendante du paramétrage du journal et de la clé API.

Réponse en succès

Toujours accompagnée de "resultat": "succes". En cas d’erreur, la réponse contient "resultat": "erreur" et un tableau erreurs de codes (liste des codes).

referencechaîne
Référence unique interne au système illico.
numero_commandechaîne
N° de commande du prescripteur. Présent s'il a été fourni à l'appel.
date_parutionchaîne, date
date_bouclagechaîne
Date et heure de bouclage au format AAAA-MM-JJ HH:MM:SS.
tarifobjet
Tarif détaillé d'une annonce (devis ou commande). Les postes justificatif_papier, justificatif_numerique et frais_port sont absents s'ils ne s'appliquent pas.
annonceobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
justificatif_papierobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
justificatif_numeriqueobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
frais_portobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
totauxobjet
montant_htnombre
Montant hors taxe total.
montant_tvanombre
Montant total de TVA.
montant_ttcnombre
Montant TTC total.
tvatableau d'objets
tauxnombre
Taux de TVA.
montantnombre
Montant total de TVA au taux exprimé.

Annulation

DELETE/annonce-legale/api/externe/annonce/{reference}

Annule une annonce. Le tableau documents (facture + avoir) peut être absent si l'annonce n'avait pas été facturée avant l'annulation. Route DELETE /annonce/{reference}.

Paramètres

referencechaîne, dans l’URLobligatoire
Référence interne de l'annonce au système illico (ex. L2200001) ou numero_commande fourni lors de l'appel à l'API Commande.

Réponse en succès

Toujours accompagnée de "resultat": "succes". En cas d’erreur, la réponse contient "resultat": "erreur" et un tableau erreurs de codes (liste des codes).

referencechaîne
Référence interne de l'annonce au système illico.
numero_commandechaîne
N° de commande du prescripteur. Présent s'il a été fourni à la commande.
documentstableau d'objets
Facture et avoir générés. Absent si l'annonce n'avait pas été facturée avant l'annulation.
typechaîne, énuméréeobligatoire
Type de document de facturation.
Valeurs : factureavoir voir la liste
numerochaîne
Numéro de l'attestation, de la facture ou de l'avoir.
urlchaîne, URLobligatoire
URL de téléchargement du document (PDF).

Statuts en lot

POST/annonce-legale/api/externe/annonces/statuts

Récupère les statuts d'un ensemble d'annonces identifiées par leur référence illico ou par le numero_commande fourni à la commande.

Route /annonces/statuts. L'ancienne route /statut reste servie pour compatibilité.

Corps de la requête

referencestableau de chaînesobligatoire
Références internes illico des annonces, ou numéros de commande fournis lors de l'appel à l'API Commande.

Réponse en succès

Toujours accompagnée de "resultat": "succes". En cas d’erreur, la réponse contient "resultat": "erreur" et un tableau erreurs de codes (liste des codes).

annoncestableau d'objets
referencechaîne
Référence interne de l'annonce au système illico.
numero_commandechaîne
Présent s'il a été fourni à la commande.
statutchaîne, énumérée
Statut de l'annonce.
Valeurs : a-paraitreparuesuspendue voir la liste
motifchaîne
Si l'annonce a été suspendue, un motif peut être fourni.

Statut d'une annonce

GET/annonce-legale/api/externe/annonce/{reference}/statut

Paramètres

referencechaîne, dans l’URLobligatoire
Référence interne de l'annonce au système illico (ex. L2200001) ou numero_commande fourni lors de l'appel à l'API Commande.

Réponse en succès

Toujours accompagnée de "resultat": "succes". En cas d’erreur, la réponse contient "resultat": "erreur" et un tableau erreurs de codes (liste des codes).

referencechaîne
Référence interne de l'annonce au système illico.
numero_commandechaîne
Présent s'il a été fourni à la commande.
statutchaîne, énumérée
Statut de l'annonce.
Valeurs : a-paraitreparuesuspendue voir la liste
motifchaîne
Si l'annonce a été suspendue, un motif peut être fourni.

Factures

Factures et avoirs liés aux annonces

Factures en lot

POST/annonce-legale/api/externe/annonces/factures

Récupère les factures et avoirs d'un ensemble d'annonces identifiées par leur référence illico ou par le numero_commande fourni à la commande.

Corps de la requête

referencestableau de chaînesobligatoire
Références internes illico des annonces, ou numéros de commande fournis lors de l'appel à l'API Commande.

Réponse en succès

Toujours accompagnée de "resultat": "succes". En cas d’erreur, la réponse contient "resultat": "erreur" et un tableau erreurs de codes (liste des codes).

annoncestableau d'objets
referencechaîne
numero_commandechaîne
Présent s'il a été fourni à la commande.
facturestableau d'objets
typechaîne, énumérée
Type de document de facturation.
Valeurs : factureavoir voir la liste
numerochaîne
Numéro de la facture ou de l'avoir.
date_facturechaîne, date
date_echeancechaîne, date
Date d'échéance de la facture.
montant_htnombre
Montant HT total de la facture (annonce + justificatifs + frais de port + autres majorations éventuelles).
montant_ttcnombre
Montant TTC de la facture.
urlchaîne, URL
URL de téléchargement du document (PDF).
lignestableau d'objets
referencechaîne
Référence de l'annonce facturée par la ligne.
annonceobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
justificatif_papierobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
justificatif_numeriqueobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
frais_portobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
remisestableau d'objets
Remises appliquées (montants HT de remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
totauxobjet
montant_htnombre
Montant hors taxe total.
montant_tvanombre
Montant total de TVA.
montant_ttcnombre
Montant TTC total.
tvatableau d'objets
tauxnombre
Taux de TVA.
montantnombre
Montant total de TVA au taux exprimé.

Factures d'une annonce

GET/annonce-legale/api/externe/annonce/{reference}/factures

Paramètres

referencechaîne, dans l’URLobligatoire
Référence interne de l'annonce au système illico (ex. L2200001) ou numero_commande fourni lors de l'appel à l'API Commande.

Réponse en succès

Toujours accompagnée de "resultat": "succes". En cas d’erreur, la réponse contient "resultat": "erreur" et un tableau erreurs de codes (liste des codes).

referencechaîne
numero_commandechaîne
Présent s'il a été fourni à la commande.
facturestableau d'objets
typechaîne, énumérée
Type de document de facturation.
Valeurs : factureavoir voir la liste
numerochaîne
Numéro de la facture ou de l'avoir.
date_facturechaîne, date
date_echeancechaîne, date
Date d'échéance de la facture.
montant_htnombre
Montant HT total de la facture (annonce + justificatifs + frais de port + autres majorations éventuelles).
montant_ttcnombre
Montant TTC de la facture.
urlchaîne, URL
URL de téléchargement du document (PDF).
lignestableau d'objets
referencechaîne
Référence de l'annonce facturée par la ligne.
annonceobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
justificatif_papierobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
justificatif_numeriqueobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
frais_portobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
remisestableau d'objets
Remises appliquées (montants HT de remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
totauxobjet
montant_htnombre
Montant hors taxe total.
montant_tvanombre
Montant total de TVA.
montant_ttcnombre
Montant TTC total.
tvatableau d'objets
tauxnombre
Taux de TVA.
montantnombre
Montant total de TVA au taux exprimé.

Documents

Attestations, justificatifs, factures et avoirs (liens de téléchargement)

Documents en lot

POST/annonce-legale/api/externe/annonces/documents

Récupère les liens de téléchargement des documents (attestation, justificatif, facture, avoir) liés à un ensemble d'annonces commandées. Le champ numero est absent pour les justificatifs.

Corps de la requête

referencestableau de chaînesobligatoire
Références internes illico des annonces, ou numéros de commande fournis lors de l'appel à l'API Commande.

Réponse en succès

Toujours accompagnée de "resultat": "succes". En cas d’erreur, la réponse contient "resultat": "erreur" et un tableau erreurs de codes (liste des codes).

annoncestableau d'objets
referencechaîne
numero_commandechaîne
Présent s'il a été fourni à la commande.
documentstableau d'objets
typechaîne, énuméréeobligatoire
Type de document.
Valeurs : attestationjustificatiffactureavoir voir la liste
numerochaîne
Numéro de l'attestation, de la facture ou de l'avoir.
urlchaîne, URLobligatoire
URL de téléchargement du document (PDF).

Documents d'une annonce

GET/annonce-legale/api/externe/annonce/{reference}/documents

Récupère les documents d'une annonce. Le champ numero est absent pour les justificatifs.

Paramètres

referencechaîne, dans l’URLobligatoire
Référence interne de l'annonce au système illico (ex. L2200001) ou numero_commande fourni lors de l'appel à l'API Commande.

Réponse en succès

Toujours accompagnée de "resultat": "succes". En cas d’erreur, la réponse contient "resultat": "erreur" et un tableau erreurs de codes (liste des codes).

referencechaîne
numero_commandechaîne
Présent s'il a été fourni à la commande.
documentstableau d'objets
typechaîne, énuméréeobligatoire
Type de document.
Valeurs : attestationjustificatiffactureavoir voir la liste
numerochaîne
Numéro de l'attestation, de la facture ou de l'avoir.
urlchaîne, URLobligatoire
URL de téléchargement du document (PDF).

Publications

Publications habilitées et dates de parution

Publications habilitées sur un département

GET/annonce-legale/api/externe/publications

Liste des publications (papier ou web) habilitées sur le département demandé. La liste est mise à jour régulièrement. Le tableau publications peut être vide s'il n'y a aucune publication dans ce département. Sans le paramètre departement, l'endpoint retourne la liste complète des publications.

Publications autorisées : la clé API est rattachée à un compte client illico sur lequel les publications accessibles sont configurées. Cet endpoint ne renvoie que ces publications, et Devis/Commande refusent toute autre publication. Pour un prescripteur, la liste renvoyée est donc la liste contractuelle : il n'y a pas à filtrer côté client.

Paramètres

departementchaîne, paramètre d’URL
Code du département souhaité (2 à 3 caractères). Corse-du-Sud 2A, Haute-Corse 2B.
2 à 3 caractères

Réponse en succès

Toujours accompagnée de "resultat": "succes". En cas d’erreur, la réponse contient "resultat": "erreur" et un tableau erreurs de codes (liste des codes).

publicationstableau d'objets
Peut être vide s'il n'y a aucune publication dans ce département.
identier
Identifiant unique de la publication.
departementchaîne
Code du département d'habilitation de la publication.
libellechaîne
periodicitechaîne
Libellé de la périodicité (ex. hebdomadaire).
typechaîne, énumérée
Valeurs : papierweb
entetebooléen
En-tête autorisée.
justificatif_papierbooléen
Envoi des justificatifs au format papier.
justificatif_numeriquebooléen
Envoi des justificatifs au format numérique (PDF).
logo_webobjet
mime_typechaîne, énumérée
Valeurs : image/jpegimage/png
datachaîne, base64
Chaîne base64 du logo.

Dates de parution à venir

GET/annonce-legale/api/externe/dates-parutions

Liste des prochaines dates de parution (et bouclage réellement configuré) de toutes les publications, ou filtrée par publication/département.

L'ancienne route /dates-parution (dépréciée en v1.19) reste servie pour compatibilité ; utiliser /dates-parutions.

Paramètres

quantiteentier, paramètre d’URL
Nombre de dates de parution souhaitées.
de 1 à 20 — défaut 1
publicationentier, paramètre d’URL
Filtre sur l'identifiant de la publication. Si présent, departement devient obligatoire.
departementchaîne, paramètre d’URL
Filtre sur le code du département (2 à 3 caractères). Obligatoire si publication est présent.
2 à 3 caractères

Réponse en succès

Toujours accompagnée de "resultat": "succes". En cas d’erreur, la réponse contient "resultat": "erreur" et un tableau erreurs de codes (liste des codes).

publicationstableau d'objets
identier
Identifiant de la publication.
departementchaîne
Code du département d'habilitation.
datestableau d'objets
date_parutionchaîne, date
AAAA-MM-JJ
date_bouclagechaîne
Date et heure de bouclage réellement configurées, au format AAAA-MM-JJ HH:MM:SS.

Compte

Compte client et contacts associés à la clé API

Client

GET/annonce-legale/api/externe/client

Réponse en succès

Toujours accompagnée de "resultat": "succes". En cas d’erreur, la réponse contient "resultat": "erreur" et un tableau erreurs de codes (liste des codes).

numero_comptechaîne
Numéro du compte client interne au système illico.
raison_socialechaîne
nom_complementchaîne
Complément de la raison sociale.
adressechaîne
adresse_complementchaîne
code_postalchaîne
villechaîne
emailchaîne, email
Email affecté au client. Peut différer de l'email associé au contact.
mode_facturationchaîne, énumérée
Mode de facturation par défaut (aucun = pas de facturation par défaut).
Valeurs : prescripteurannonceuraucun
entetestableau d'objets
En-têtes enregistrées sur le client.
mime_typechaîne, énumérée
Valeurs : image/jpegimage/pngapplication/pdf
datachaîne, base64
Chaîne base64 du logo.

Contacts associés à la clé API

GET/annonce-legale/api/externe/contacts

Réponse en succès

Toujours accompagnée de "resultat": "succes". En cas d’erreur, la réponse contient "resultat": "erreur" et un tableau erreurs de codes (liste des codes).

contactstableau d'objets
identier
Identifiant unique du contact.
nomchaîne
prenomchaîne
emailchaîne, email

Contact

POST/annonce-legale/api/externe/contact

Crée un contact associé à la clé API. - Si mot_passe est fourni, un accès au portail web est également créé. - Si l'email est déjà associé à un contact, ce contact est retourné. - S'il existe plusieurs contacts avec ce même email, une erreur err_multiple_contact est retournée.

Corps de la requête

nomchaîne
prenomchaîne
emailchaîne, email
mot_passechaîne
Mot de passe pour l'accès au portail web. Si fourni, un accès portail est également créé.

Réponse en succès

Toujours accompagnée de "resultat": "succes". En cas d’erreur, la réponse contient "resultat": "erreur" et un tableau erreurs de codes (liste des codes).

identier
Identifiant unique du contact.
nomchaîne
prenomchaîne
emailchaîne, email

Référentiels

Pays, départements, feuilles de styles, catégories, forfaits

Pays (codes ISO 3166 alpha-3)

GET/annonce-legale/api/externe/pays

Réponse en succès

Toujours accompagnée de "resultat": "succes". En cas d’erreur, la réponse contient "resultat": "erreur" et un tableau erreurs de codes (liste des codes).

paystableau d'objets
codechaîne
Code ISO 3166 alpha-3.
libellechaîne

Départements

GET/annonce-legale/api/externe/departements

Liste des départements. Corse-du-Sud 2A, Haute-Corse 2B.

Réponse en succès

Toujours accompagnée de "resultat": "succes". En cas d’erreur, la réponse contient "resultat": "erreur" et un tableau erreurs de codes (liste des codes).

departementstableau d'objets
codechaîne
Code unique du département (2A / 2B pour la Corse).
libellechaîne
libelle_enrichichaîne

Feuilles de styles

GET/annonce-legale/api/externe/feuilles-styles

Récupère les feuilles de styles du journal permettant de mettre en forme les annonces. - Types paragraphe, filet, entete : s'appliquent sur la balise <p> (et <hr> pour filet). - Type caractere : s'applique via <span class="..."> à l'intérieur d'un <p>.

Le retour est un tableau feuilles_styles dont chaque élément porte un champ classe.

Paramètres

typechaîne, énumérée, paramètre d’URL
Filtre sur le type de feuille de style.
Valeurs : paragraphefiletentetecaractere

Réponse en succès

Toujours accompagnée de "resultat": "succes". En cas d’erreur, la réponse contient "resultat": "erreur" et un tableau erreurs de codes (liste des codes).

feuilles_stylestableau d'objets
libellechaîne
Libellé de la feuille de style.
classechaîne
Classe HTML à utiliser (class="...").
definition_csschaîne
Définition CSS de la classe.
rangentier
Rang de la feuille de style (en cas de classes multiples, le plus petit rang l'emporte).
typechaîne, énumérée
Niveau d'application d'une feuille de style.
Valeurs : paragraphefiletentetecaractere voir la liste

Catégories d'annonces et classes de style disponibles

GET/annonce-legale/api/externe/categories

Liste des catégories, avec pour chacune les classes HTML de feuilles de style disponibles et la classe par défaut. Les catégories SUC_VAC et SUC_DES sont réservées aux confrères habilités.

Réponse en succès

Toujours accompagnée de "resultat": "succes". En cas d’erreur, la réponse contient "resultat": "erreur" et un tableau erreurs de codes (liste des codes).

categoriestableau d'objets
codechaîne
Code de la catégorie (cf. CodeCategorie). L'API peut retourner des codes non listés dans l'annexe (ex. VNT_ENC).
libellechaîne
classes_htmltableau de chaînes
Classes HTML disponibles pour cette catégorie.
classe_html_defautchaîne
Classe appliquée par défaut si aucune classe (ou une classe incorrecte) n'est précisée.

Forfaits et catégories associées

GET/annonce-legale/api/externe/forfaits

Liste des forfaits (constitutions et modifications) avec, pour chacun, le code de la catégorie à laquelle il s'applique. Disponible depuis la v1.29.

Le retour est un tableau forfaits.

Réponse en succès

Toujours accompagnée de "resultat": "succes". En cas d’erreur, la réponse contient "resultat": "erreur" et un tableau erreurs de codes (liste des codes).

forfaitstableau d'objets
codechaîne, énumérée
Forfaits (annexe "Forfaits").
Valeurs : EURLSASARLSASSASUSC+22 autres voir la liste
libellechaîne
Libellé du forfait.
categorie_codechaîne, énumérée
Codes de catégorie (annexe "Catégories").
Valeurs : ADDITIAUTRECHG_PATCHG_REGCLOTURCONSTI+11 autres voir la liste

Annexes

Catégories

Codes de catégorie (annexe "Catégories"). La liste à jour est disponible via GET /categories.

Catégorie Code Forfait obligatoire
ADDITIF ADDITI
AUTRE ANNONCE AUTRE
CHANGEMENT DE NOM PATRONYMIQUE CHG_PAT
CHANGEMENT DE RÉGIME MATRIMONIAL CHG_REG
CLÔTURE DE LIQUIDATION CLOTUR
CONSTITUTION CONSTI Oui
CONVOCATION CONVOC
DISSOLUTION DE SOCIÉTÉ DISSOL
FONDS DE COMMERCE FONDS
FUSION FUSION
LOCATION GÉRANCE LOC_GER
MODIFICATION MODIF Oui
POURSUITE ACTIVITÉ PRS_ACT
RECTIFICATIF RECTIF
TRANSMISSION UNIVERSELLE DE PATRIMOINE TUP
SUCCESSION VACANTE (réservé confrères habilités) SUC_VAC
SUCCESSION EN DÉSHÉRENCE (réservé confrères habilités) SUC_DES

Forfaits

Forfaits (annexe "Forfaits"). Obligatoire pour les catégories CONSTI et MODIF.

Forfaits de constitution (CONSTI) | Forme juridique | Valeur | |---|---| | EURL | EURL | | SA | SA | | SARL, SELARL | SARL | | SAS | SAS | | SASU | SASU | | EARL, SC, SCEA, SCP, SCPI | SC | | SCI, SCCV | SCI | | SNC | SNC | | Toute autre forme juridique | CONSTI_AUTRE |

Forfaits de modification (MODIF) | Type de modification | Valeur | |---|---| | Autre modification / modifications multiples (caractère) | MOD_AUTRE | | Transfert du siège social | MOD_TRS_SIE | | Mouvement des dirigeants | MOD_DIR | | Nomination du commissaire aux comptes | MOD_CAC_NOM | | Cessation du commissaire aux comptes | MOD_CAC_CES | | Modification de la durée | MOD_DUREE | | Modification de la date de clôture des comptes | MOD_DATE_CLOT | | Modification de la date de début d'activité | MOD_DATE_DEB | | Reconstitution de l'actif net ou des capitaux propres | MOD_REC_ACTIF | | Modification de capital | MOD_CAP | | Modification de l'objet social | MOD_OBJET | | Mouvement d'activité | MOD_ACT | | Nomination d'un administrateur judiciaire | MOD_JUD_NOM | | Modification de la dénomination | MOD_DENOM | | Modification de la forme juridique | MOD_FORME | | Mouvement d'associés | MOD_ASSO | | Cession de parts sociales | MOD_CESSION | | Résiliation de bail | MOD_RES_BAIL | | Non dissolution | MOD_NON_DISSOL |

La liste à jour est disponible via GET /forfaits (documenté depuis la v1.29).

Dispositions d’en-tête

Disposition de l'en-tête (annexe "Disposition en-tête"). - carton_texte_sans_image : texte sans image - carton_image_sans_texte : image sans texte - carton_image_texte_droite : image à gauche, texte à droite - carton_image_texte_bas : image en haut centrée, texte en bas

Statuts d’annonce

Statut de l'annonce.

a-paraitreparuesuspendue

Modes de facturation

Destinataire de la facture. - prescripteur : facturation au prescripteur - annonceur : facturation à l'annonceur (nécessite l'objet facturation)

prescripteurannonceur

Types de feuilles de styles

Niveau d'application d'une feuille de style.

paragraphefiletentetecaractere

Codes d’erreur

Codes d'erreur (annexe "Codes d'erreurs").

Erreurs de contrôles - err_annonce_introuvable : l'annonce est introuvable - err_annonce_commandee : l'annonce est déjà commandée (numéro de commande déjà enregistré) - err_publication_introuvable : la parution est introuvable - err_bouclage_depasse : le bouclage pour cette date de parution a été dépassé - err_date_indisponible : la date de parution n'est pas disponible - err_client_inactif : l'accès n'est pas finalisé - err_forfait_inconnu : le forfait n'existe pas - err_categorie_inconnu : la catégorie n'existe pas - err_publication_non_habilite : la publication n'est pas habilitée à diffuser dans le département souhaité - err_mode_facturation_non_autorisee : le mode de facturation choisi n'est pas disponible pour le client - err_annonce_suspendue : l'annonce est suspendue - err_multiple_contact : il existe plusieurs contacts avec cet email

Erreurs de champs manquants : err_{champ}_absent — le paramètre {champ} est absent.

Erreurs de champs incorrects : err_{champ}_incorrect — le paramètre {champ} est incorrect.

Erreurs d'environnement - err_internal_server : erreur interne du serveur - err_timestamp_controle : écart de timestamp trop grand (> 5 s) - err_signature_calculee : la signature envoyée ne correspond pas à la signature calculée - err_body_incorrect : le body de la requête est incorrect - err_cle_inconnue : la clé envoyée ne correspond à aucune clé de l'API - err_requetes_max : nombre maximal de requêtes par minute atteint (300) - err_application_absent / err_signature_absent / err_timestamp_absent : header absent - err_application_incorrect / err_signature_incorrect : header incorrect

Schémas

Structures d’objets réutilisées entre plusieurs appels, repliées : elles servent surtout à la génération de code. Cliquez pour ouvrir.

ReponseErreurRéponse retournée en cas d'erreur (resultat = erreur).

Réponse retournée en cas d'erreur (resultat = erreur).

resultatchaîne, énuméréeobligatoire
Valeurs : erreur
erreurstableauobligatoire
Codes d'erreurs (cf. CodeErreur).
LigneTarifDétail tarifaire d'un poste (annonce, justificatif, frais de port, remise).

Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).

quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
Totaux
montant_htnombre
Montant hors taxe total.
montant_tvanombre
Montant total de TVA.
montant_ttcnombre
Montant TTC total.
VentilationTva
tauxnombre
Taux de TVA.
montantnombre
Montant total de TVA au taux exprimé.
TarifTarif détaillé d'une annonce (devis ou commande).

Tarif détaillé d'une annonce (devis ou commande). Les postes justificatif_papier, justificatif_numerique et frais_port sont absents s'ils ne s'appliquent pas.

annonceobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
justificatif_papierobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
justificatif_numeriqueobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
frais_portobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
totauxobjet
montant_htnombre
Montant hors taxe total.
montant_tvanombre
Montant total de TVA.
montant_ttcnombre
Montant TTC total.
tvatableau d'objets
tauxnombre
Taux de TVA.
montantnombre
Montant total de TVA au taux exprimé.
EnteteEn-tête (carton) de l'annonce, avec logo et/ou texte.

En-tête (carton) de l'annonce, avec logo et/ou texte.

mime_typechaîne, énumérée
Format du logo.
Valeurs : image/jpegimage/pngapplication/pdf
datachaîne, base64
Chaîne base64 du logo. Obligatoire si mime_type est présent.
dispositionchaîne, énumérée
Disposition de l'en-tête (annexe "Disposition en-tête").
Valeurs : carton_texte_sans_imagecarton_image_sans_textecarton_image_texte_droitecarton_image_texte_bas voir la liste
textechaîne
Texte de l'en-tête au format HTML. Chaque paragraphe doit être encadré de <p> et </p> ; retours à la ligne forcés par <br/>. Classes de type entete disponibles via GET /feuilles-styles?type=entete (généralement fs-prescripteur_nom rang 1 et fs-prescripteur_adresse rang 2 / défaut).
FacturationCoordonnées de facturation.

Coordonnées de facturation. Obligatoire si mode_facturation = annonceur.

nom_raison_socialechaîneobligatoire
Nom ou raison sociale.
prenom_nom_complementchaîne
Prénom ou complément de nom.
adressechaîneobligatoire
adresse_complementchaîne
Complément d'adresse.
code_postalchaîneobligatoire
villechaîneobligatoire
payschaîneobligatoire
Code pays ISO 3166 alpha-3, fourni par GET /pays.
emailchaîne, email
Email. Non obligatoire depuis la v1.27.
telephonechaîne
Numéro de téléphone.
mobilechaîne
Numéro de téléphone mobile.
DevisRequete
publicationentierobligatoire
Identifiant de la publication (cf. GET /publications).
departementchaîneobligatoire
Département de parution (2A / 2B pour la Corse).
date_parutionchaîne, date
Date de parution souhaitée (AAAA-MM-JJ). Si absente, la prochaine date est proposée en tenant compte du délai de bouclage.
categoriechaîne, énuméréeobligatoire
Codes de catégorie (annexe "Catégories").
Valeurs : ADDITIAUTRECHG_PATCHG_REGCLOTURCONSTI+11 autres voir la liste
forfaitchaîne, énumérée
Forfaits (annexe "Forfaits").
Valeurs : EURLSASARLSASSASUSC+22 autres voir la liste
enteteobjet
En-tête (carton) de l'annonce, avec logo et/ou texte.
mime_typechaîne, énumérée
Format du logo.
Valeurs : image/jpegimage/pngapplication/pdf
datachaîne, base64
Chaîne base64 du logo. Obligatoire si mime_type est présent.
dispositionchaîne, énumérée
Disposition de l'en-tête (annexe "Disposition en-tête").
Valeurs : carton_texte_sans_imagecarton_image_sans_textecarton_image_texte_droitecarton_image_texte_bas voir la liste
textechaîne
Texte de l'en-tête au format HTML. Chaque paragraphe doit être encadré de <p> et </p> ; retours à la ligne forcés par <br/>. Classes de type entete disponibles via GET /feuilles-styles?type=entete (généralement fs-prescripteur_nom rang 1 et fs-prescripteur_adresse rang 2 / défaut).
textechaîneobligatoire
Texte de l'annonce au format HTML (<p> uniquement, <br/> pour les retours forcés, classes fs-*).
justificatifs_papiersentier
Nombre de justificatifs papier souhaités, si la publication les propose. Défaut 0 si la publication propose le justificatif numérique, sinon 1.
justificatif_numeriquebooléen
Demande la génération d'un justificatif numérique.
DevisReponse
resultatchaîne, énuméréeobligatoire
Valeurs : succes
date_parutionchaîne, date
Date de parution retenue (AAAA-MM-JJ). Égale à la date demandée si le bouclage est respecté, sinon la prochaine date calculée.
date_bouclagechaîne
Date et heure de bouclage au format AAAA-MM-JJ HH:MM:SS.
textechaîne
Texte de l'annonce composé après traitement (classes résolues).
tarifobjet
Tarif détaillé d'une annonce (devis ou commande). Les postes justificatif_papier, justificatif_numerique et frais_port sont absents s'ils ne s'appliquent pas.
annonceobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
justificatif_papierobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
justificatif_numeriqueobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
frais_portobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
totauxobjet
montant_htnombre
Montant hors taxe total.
montant_tvanombre
Montant total de TVA.
montant_ttcnombre
Montant TTC total.
tvatableau d'objets
tauxnombre
Taux de TVA.
montantnombre
Montant total de TVA au taux exprimé.
CommandeRequete
publicationentierobligatoire
Identifiant de la publication.
departementchaîneobligatoire
Département de parution (2A / 2B pour la Corse).
date_parutionchaîne, date
Date de parution souhaitée (AAAA-MM-JJ). Si absente, la prochaine date est affectée en tenant compte du délai de bouclage.
categoriechaîne, énuméréeobligatoire
Codes de catégorie (annexe "Catégories").
Valeurs : ADDITIAUTRECHG_PATCHG_REGCLOTURCONSTI+11 autres voir la liste
forfaitchaîne, énumérée
Forfaits (annexe "Forfaits").
Valeurs : EURLSASARLSASSASUSC+22 autres voir la liste
contactentier
Identifiant du contact (cf. GET /contacts). Si absent, le contact par défaut du compte API est utilisé.
numero_commandechaîne
N° de commande unique de l'annonce dans la base du prescripteur. S'il est fourni, il peut remplacer la référence illico pour le suivi.
50 caractères max.
dossierchaîneobligatoire
Référence du dossier du prescripteur.
enteteobjet
En-tête (carton) de l'annonce, avec logo et/ou texte.
mime_typechaîne, énumérée
Format du logo.
Valeurs : image/jpegimage/pngapplication/pdf
datachaîne, base64
Chaîne base64 du logo. Obligatoire si mime_type est présent.
dispositionchaîne, énumérée
Disposition de l'en-tête (annexe "Disposition en-tête").
Valeurs : carton_texte_sans_imagecarton_image_sans_textecarton_image_texte_droitecarton_image_texte_bas voir la liste
textechaîne
Texte de l'en-tête au format HTML. Chaque paragraphe doit être encadré de <p> et </p> ; retours à la ligne forcés par <br/>. Classes de type entete disponibles via GET /feuilles-styles?type=entete (généralement fs-prescripteur_nom rang 1 et fs-prescripteur_adresse rang 2 / défaut).
textechaîneobligatoire
Texte de l'annonce au format HTML (<p> uniquement, <br/> pour les retours forcés, classes fs-*).
mode_facturationchaîne, énuméréeobligatoire
Destinataire de la facture.
Valeurs : prescripteurannonceur voir la liste
facturationobjet
Coordonnées de facturation. Obligatoire si mode_facturation = annonceur.
nom_raison_socialechaîneobligatoire
Nom ou raison sociale.
prenom_nom_complementchaîne
Prénom ou complément de nom.
adressechaîneobligatoire
adresse_complementchaîne
Complément d'adresse.
code_postalchaîneobligatoire
villechaîneobligatoire
payschaîneobligatoire
Code pays ISO 3166 alpha-3, fourni par GET /pays.
emailchaîne, email
Email. Non obligatoire depuis la v1.27.
telephonechaîne
Numéro de téléphone.
mobilechaîne
Numéro de téléphone mobile.
justificatifs_papiersentier
Nombre de justificatifs papier souhaités, si la publication les propose. Défaut 0 si la publication propose le justificatif numérique, sinon 1.
justificatif_numeriquebooléen
Demande la génération d'un justificatif numérique.
envoi_justificatifbooléen
Demande l'envoi du justificatif numérique par email lorsqu'il est généré.
défaut false
largeurnombre
Nombre total de colonnes sur lesquelles l'annonce sera publiée. Application dépendante du paramétrage du journal et de la clé API.
largeur_textenombre
Largeur d'une colonne de texte, en nombre de colonnes journal. Application dépendante du paramétrage du journal et de la clé API.
CommandeReponse
resultatchaîne, énuméréeobligatoire
Valeurs : succes
referencechaîne
Référence unique interne au système illico.
numero_commandechaîne
N° de commande du prescripteur. Présent s'il a été fourni à l'appel.
date_parutionchaîne, date
date_bouclagechaîne
Date et heure de bouclage au format AAAA-MM-JJ HH:MM:SS.
tarifobjet
Tarif détaillé d'une annonce (devis ou commande). Les postes justificatif_papier, justificatif_numerique et frais_port sont absents s'ils ne s'appliquent pas.
annonceobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
justificatif_papierobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
justificatif_numeriqueobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
frais_portobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
totauxobjet
montant_htnombre
Montant hors taxe total.
montant_tvanombre
Montant total de TVA.
montant_ttcnombre
Montant TTC total.
tvatableau d'objets
tauxnombre
Taux de TVA.
montantnombre
Montant total de TVA au taux exprimé.
DocumentDocument téléchargeable.

Document téléchargeable. numero est absent pour les justificatifs.

typechaîne, énuméréeobligatoire
Type de document.
Valeurs : attestationjustificatiffactureavoir voir la liste
numerochaîne
Numéro de l'attestation, de la facture ou de l'avoir.
urlchaîne, URLobligatoire
URL de téléchargement du document (PDF).
AnnulationReponse
resultatchaîne, énuméréeobligatoire
Valeurs : succes
referencechaîne
Référence interne de l'annonce au système illico.
numero_commandechaîne
N° de commande du prescripteur. Présent s'il a été fourni à la commande.
documentstableau d'objets
Facture et avoir générés. Absent si l'annonce n'avait pas été facturée avant l'annulation.
typechaîne, énuméréeobligatoire
Type de document de facturation.
Valeurs : factureavoir voir la liste
numerochaîne
Numéro de l'attestation, de la facture ou de l'avoir.
urlchaîne, URLobligatoire
URL de téléchargement du document (PDF).
ReferencesRequete
referencestableau de chaînesobligatoire
Références internes illico des annonces, ou numéros de commande fournis lors de l'appel à l'API Commande.
StatutAnnonceItem
referencechaîne
Référence interne de l'annonce au système illico.
numero_commandechaîne
Présent s'il a été fourni à la commande.
statutchaîne, énumérée
Statut de l'annonce.
Valeurs : a-paraitreparuesuspendue voir la liste
motifchaîne
Si l'annonce a été suspendue, un motif peut être fourni.
StatutsLotReponse
resultatchaîne, énuméréeobligatoire
Valeurs : succes
annoncestableau d'objets
referencechaîne
Référence interne de l'annonce au système illico.
numero_commandechaîne
Présent s'il a été fourni à la commande.
statutchaîne, énumérée
Statut de l'annonce.
Valeurs : a-paraitreparuesuspendue voir la liste
motifchaîne
Si l'annonce a été suspendue, un motif peut être fourni.
StatutAnnonceReponse
resultatchaîne, énuméréeobligatoire
Valeurs : succes
referencechaîne
Référence interne de l'annonce au système illico.
numero_commandechaîne
Présent s'il a été fourni à la commande.
statutchaîne, énumérée
Statut de l'annonce.
Valeurs : a-paraitreparuesuspendue voir la liste
motifchaîne
Si l'annonce a été suspendue, un motif peut être fourni.
LigneFactureLigne de facture (une annonce facturée).

Ligne de facture (une annonce facturée).

referencechaîne
Référence de l'annonce facturée par la ligne.
annonceobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
justificatif_papierobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
justificatif_numeriqueobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
frais_portobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
remisestableau d'objets
Remises appliquées (montants HT de remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
totauxobjet
montant_htnombre
Montant hors taxe total.
montant_tvanombre
Montant total de TVA.
montant_ttcnombre
Montant TTC total.
tvatableau d'objets
tauxnombre
Taux de TVA.
montantnombre
Montant total de TVA au taux exprimé.
FactureFacture ou avoir.

Facture ou avoir. Pour un avoir, les montants sont négatifs. Les montants sont des nombres réels.

typechaîne, énumérée
Type de document de facturation.
Valeurs : factureavoir voir la liste
numerochaîne
Numéro de la facture ou de l'avoir.
date_facturechaîne, date
date_echeancechaîne, date
Date d'échéance de la facture.
montant_htnombre
Montant HT total de la facture (annonce + justificatifs + frais de port + autres majorations éventuelles).
montant_ttcnombre
Montant TTC de la facture.
urlchaîne, URL
URL de téléchargement du document (PDF).
lignestableau d'objets
referencechaîne
Référence de l'annonce facturée par la ligne.
annonceobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
justificatif_papierobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
justificatif_numeriqueobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
frais_portobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
remisestableau d'objets
Remises appliquées (montants HT de remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
totauxobjet
montant_htnombre
Montant hors taxe total.
montant_tvanombre
Montant total de TVA.
montant_ttcnombre
Montant TTC total.
tvatableau d'objets
tauxnombre
Taux de TVA.
montantnombre
Montant total de TVA au taux exprimé.
FacturesLotReponse
resultatchaîne, énuméréeobligatoire
Valeurs : succes
annoncestableau d'objets
referencechaîne
numero_commandechaîne
Présent s'il a été fourni à la commande.
facturestableau d'objets
typechaîne, énumérée
Type de document de facturation.
Valeurs : factureavoir voir la liste
numerochaîne
Numéro de la facture ou de l'avoir.
date_facturechaîne, date
date_echeancechaîne, date
Date d'échéance de la facture.
montant_htnombre
Montant HT total de la facture (annonce + justificatifs + frais de port + autres majorations éventuelles).
montant_ttcnombre
Montant TTC de la facture.
urlchaîne, URL
URL de téléchargement du document (PDF).
lignestableau d'objets
referencechaîne
Référence de l'annonce facturée par la ligne.
annonceobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
justificatif_papierobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
justificatif_numeriqueobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
frais_portobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
remisestableau d'objets
Remises appliquées (montants HT de remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
totauxobjet
montant_htnombre
Montant hors taxe total.
montant_tvanombre
Montant total de TVA.
montant_ttcnombre
Montant TTC total.
tvatableau d'objets
tauxnombre
Taux de TVA.
montantnombre
Montant total de TVA au taux exprimé.
FacturesAnnonceReponse
resultatchaîne, énuméréeobligatoire
Valeurs : succes
referencechaîne
numero_commandechaîne
Présent s'il a été fourni à la commande.
facturestableau d'objets
typechaîne, énumérée
Type de document de facturation.
Valeurs : factureavoir voir la liste
numerochaîne
Numéro de la facture ou de l'avoir.
date_facturechaîne, date
date_echeancechaîne, date
Date d'échéance de la facture.
montant_htnombre
Montant HT total de la facture (annonce + justificatifs + frais de port + autres majorations éventuelles).
montant_ttcnombre
Montant TTC de la facture.
urlchaîne, URL
URL de téléchargement du document (PDF).
lignestableau d'objets
referencechaîne
Référence de l'annonce facturée par la ligne.
annonceobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
justificatif_papierobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
justificatif_numeriqueobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
frais_portobjet
Détail tarifaire d'un poste (annonce, justificatif, frais de port, remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
remisestableau d'objets
Remises appliquées (montants HT de remise).
quantiteentier
Quantité d'éléments facturés.
prix_unitairenombre
Prix d'un élément (HT).
montant_htnombre
Montant HT du poste.
taux_tvanombre
Taux de TVA à appliquer au montant du poste (ex. 20, 2.1).
totauxobjet
montant_htnombre
Montant hors taxe total.
montant_tvanombre
Montant total de TVA.
montant_ttcnombre
Montant TTC total.
tvatableau d'objets
tauxnombre
Taux de TVA.
montantnombre
Montant total de TVA au taux exprimé.
DocumentsLotReponse
resultatchaîne, énuméréeobligatoire
Valeurs : succes
annoncestableau d'objets
referencechaîne
numero_commandechaîne
Présent s'il a été fourni à la commande.
documentstableau d'objets
typechaîne, énuméréeobligatoire
Type de document.
Valeurs : attestationjustificatiffactureavoir voir la liste
numerochaîne
Numéro de l'attestation, de la facture ou de l'avoir.
urlchaîne, URLobligatoire
URL de téléchargement du document (PDF).
DocumentsAnnonceReponse
resultatchaîne, énuméréeobligatoire
Valeurs : succes
referencechaîne
numero_commandechaîne
Présent s'il a été fourni à la commande.
documentstableau d'objets
typechaîne, énuméréeobligatoire
Type de document.
Valeurs : attestationjustificatiffactureavoir voir la liste
numerochaîne
Numéro de l'attestation, de la facture ou de l'avoir.
urlchaîne, URLobligatoire
URL de téléchargement du document (PDF).
Publication
identier
Identifiant unique de la publication.
departementchaîne
Code du département d'habilitation de la publication.
libellechaîne
periodicitechaîne
Libellé de la périodicité (ex. hebdomadaire).
typechaîne, énumérée
Valeurs : papierweb
entetebooléen
En-tête autorisée.
justificatif_papierbooléen
Envoi des justificatifs au format papier.
justificatif_numeriquebooléen
Envoi des justificatifs au format numérique (PDF).
logo_webobjet
mime_typechaîne, énumérée
Valeurs : image/jpegimage/png
datachaîne, base64
Chaîne base64 du logo.
PublicationsReponse
resultatchaîne, énuméréeobligatoire
Valeurs : succes
publicationstableau d'objets
Peut être vide s'il n'y a aucune publication dans ce département.
identier
Identifiant unique de la publication.
departementchaîne
Code du département d'habilitation de la publication.
libellechaîne
periodicitechaîne
Libellé de la périodicité (ex. hebdomadaire).
typechaîne, énumérée
Valeurs : papierweb
entetebooléen
En-tête autorisée.
justificatif_papierbooléen
Envoi des justificatifs au format papier.
justificatif_numeriquebooléen
Envoi des justificatifs au format numérique (PDF).
logo_webobjet
mime_typechaîne, énumérée
Valeurs : image/jpegimage/png
datachaîne, base64
Chaîne base64 du logo.
DatesParutionsReponse
resultatchaîne, énuméréeobligatoire
Valeurs : succes
publicationstableau d'objets
identier
Identifiant de la publication.
departementchaîne
Code du département d'habilitation.
datestableau d'objets
date_parutionchaîne, date
AAAA-MM-JJ
date_bouclagechaîne
Date et heure de bouclage réellement configurées, au format AAAA-MM-JJ HH:MM:SS.
ClientReponse
resultatchaîne, énuméréeobligatoire
Valeurs : succes
numero_comptechaîne
Numéro du compte client interne au système illico.
raison_socialechaîne
nom_complementchaîne
Complément de la raison sociale.
adressechaîne
adresse_complementchaîne
code_postalchaîne
villechaîne
emailchaîne, email
Email affecté au client. Peut différer de l'email associé au contact.
mode_facturationchaîne, énumérée
Mode de facturation par défaut (aucun = pas de facturation par défaut).
Valeurs : prescripteurannonceuraucun
entetestableau d'objets
En-têtes enregistrées sur le client.
mime_typechaîne, énumérée
Valeurs : image/jpegimage/pngapplication/pdf
datachaîne, base64
Chaîne base64 du logo.
Contact
identier
Identifiant unique du contact.
nomchaîne
prenomchaîne
emailchaîne, email
ContactsReponse
resultatchaîne, énuméréeobligatoire
Valeurs : succes
contactstableau d'objets
identier
Identifiant unique du contact.
nomchaîne
prenomchaîne
emailchaîne, email
ContactRequeteTous les champs sont optionnels.

Tous les champs sont optionnels. Si l'email est déjà associé à un contact, celui-ci est renvoyé ; s'il existe plusieurs contacts avec cet email, une erreur err_multiple_contact est renvoyée.

nomchaîne
prenomchaîne
emailchaîne, email
mot_passechaîne
Mot de passe pour l'accès au portail web. Si fourni, un accès portail est également créé.
ContactReponse
resultatchaîne, énuméréeobligatoire
Valeurs : succes
identier
Identifiant unique du contact.
nomchaîne
prenomchaîne
emailchaîne, email
PaysReponse
resultatchaîne, énuméréeobligatoire
Valeurs : succes
paystableau d'objets
codechaîne
Code ISO 3166 alpha-3.
libellechaîne
DepartementsReponse
resultatchaîne, énuméréeobligatoire
Valeurs : succes
departementstableau d'objets
codechaîne
Code unique du département (2A / 2B pour la Corse).
libellechaîne
libelle_enrichichaîne
FeuilleStyle
libellechaîne
Libellé de la feuille de style.
classechaîne
Classe HTML à utiliser (class="...").
definition_csschaîne
Définition CSS de la classe.
rangentier
Rang de la feuille de style (en cas de classes multiples, le plus petit rang l'emporte).
typechaîne, énumérée
Niveau d'application d'une feuille de style.
Valeurs : paragraphefiletentetecaractere voir la liste
FeuillesStylesReponse
resultatchaîne, énuméréeobligatoire
Valeurs : succes
feuilles_stylestableau d'objets
libellechaîne
Libellé de la feuille de style.
classechaîne
Classe HTML à utiliser (class="...").
definition_csschaîne
Définition CSS de la classe.
rangentier
Rang de la feuille de style (en cas de classes multiples, le plus petit rang l'emporte).
typechaîne, énumérée
Niveau d'application d'une feuille de style.
Valeurs : paragraphefiletentetecaractere voir la liste
Categorie
codechaîne
Code de la catégorie (cf. CodeCategorie). L'API peut retourner des codes non listés dans l'annexe (ex. VNT_ENC).
libellechaîne
classes_htmltableau de chaînes
Classes HTML disponibles pour cette catégorie.
classe_html_defautchaîne
Classe appliquée par défaut si aucune classe (ou une classe incorrecte) n'est précisée.
CategoriesReponse
resultatchaîne, énuméréeobligatoire
Valeurs : succes
categoriestableau d'objets
codechaîne
Code de la catégorie (cf. CodeCategorie). L'API peut retourner des codes non listés dans l'annexe (ex. VNT_ENC).
libellechaîne
classes_htmltableau de chaînes
Classes HTML disponibles pour cette catégorie.
classe_html_defautchaîne
Classe appliquée par défaut si aucune classe (ou une classe incorrecte) n'est précisée.
Forfait
codechaîne, énumérée
Forfaits (annexe "Forfaits").
Valeurs : EURLSASARLSASSASUSC+22 autres voir la liste
libellechaîne
Libellé du forfait.
categorie_codechaîne, énumérée
Codes de catégorie (annexe "Catégories").
Valeurs : ADDITIAUTRECHG_PATCHG_REGCLOTURCONSTI+11 autres voir la liste
ForfaitsReponse
resultatchaîne, énuméréeobligatoire
Valeurs : succes
forfaitstableau d'objets
codechaîne, énumérée
Forfaits (annexe "Forfaits").
Valeurs : EURLSASARLSASSASUSC+22 autres voir la liste
libellechaîne
Libellé du forfait.
categorie_codechaîne, énumérée
Codes de catégorie (annexe "Catégories").
Valeurs : ADDITIAUTRECHG_PATCHG_REGCLOTURCONSTI+11 autres voir la liste