Version 1.1 archivée
Cette documentation conserve le contrat publié à l’époque. Pour une nouvelle intégration, consultez la version 1.2.

Référentiels / CDJ CONNECT 1.1

Les référentiels

Valeurs et conventions du format CDJ Connect 1.1.

Cette page regroupe les référentiels et enums du format CDJ Connect. Les codes sont stables et doivent être mappés côté logiciel métier. Ils expriment des intentions métier communes, sans imposer l'implémentation interne de chaque logiciel métier. Les enums CDJ Connect constituent le vocabulaire canonique du format. Un connecteur du logiciel métier ne doit pas inventer ses propres valeurs dans le flux: il doit mapper ces codes vers ses valeurs internes dans sa configuration locale. Quand un nouveau cas métier récurrent apparaît, il faut l'ajouter ici puis le reporter dans le JSON Schema v1.1.

Explorez les clés de lot.json, puis les propriétés des objets et tableaux.

lot.jsonobjet · v1.1
version_formatstringrequis#
version_format

Version du contrat utilisée pour valider ce lot.

Requis lorsque l’objet parent est présent.

Explications du référentiel

Valeur fixe : "1.1"

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "version_format": "1.1"
}
en_teteobjectrequis#
en_tete

Identité du lot, date de transmission et systèmes émetteur et destinataire.

Requis lorsque l’objet parent est présent.

additionalProperties
true
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "en_tete": {
    "id_lot": "LOT-20260520-0001",
    "date_lot": "2026-05-20T10:30:00+02:00",
    "environnement": "production",
    "sens_transmission": "EMETTEUR_VERS_ERP",
    "type_flux": "IMPORT_DOSSIERS",
    "emetteur": {
      "type": "PRESTATAIRE",
      "code": "RAYDOCS",
      "nom": "Raydocs"
    },
    "destinataire": {
      "type": "ERP",
      "code": "ETUDE_DUPONT",
      "nom": "SCP Dupont",
      "logiciel": "LOGICIEL_METIER"
    }
  }
}

Propriétés · 7

id_lotstringrequis#
en_tete.id_lot

Valeur de type string, à renseigner dans en_tete.id_lot.

Requis lorsque l’objet parent est présent.

minLength
1
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "id_lot": "LOT-20260520-0001"
}
date_lotstringrequis#
en_tete.date_lot

Valeur de type string, à renseigner dans en_tete.date_lot.

Requis lorsque l’objet parent est présent.

format
date-time
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "date_lot": "2026-05-20T10:30:00+02:00"
}
environnementstringrequis#
en_tete.environnement

Valeur de type string, à renseigner dans en_tete.environnement.

Requis lorsque l’objet parent est présent.

Explications du référentiel

environnement

  • test
  • recette
  • production
Valeurs autorisées
"test""recette""production"
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "environnement": "production"
}
sens_transmissionstringrequis#
en_tete.sens_transmission

Valeur de type string, à renseigner dans en_tete.sens_transmission.

Requis lorsque l’objet parent est présent.

Explications du référentiel

sens_transmission

  • EMETTEUR_VERS_ERP

Valeur fixe : "EMETTEUR_VERS_ERP"

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "sens_transmission": "EMETTEUR_VERS_ERP"
}
type_fluxstringrequis#
en_tete.type_flux

Valeur de type string, à renseigner dans en_tete.type_flux.

Requis lorsque l’objet parent est présent.

Explications du référentiel

type_flux

  • IMPORT_DOSSIERS En v1, toutes les données sont transmises dans dossiers[], y compris pièces, actes, créances et événements.

Valeur fixe : "IMPORT_DOSSIERS"

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "type_flux": "IMPORT_DOSSIERS"
}
emetteurobjectrequis#
en_tete.emetteur

Ouvrez les propriétés ci-dessous pour explorer cet objet.

Requis lorsque l’objet parent est présent.

additionalProperties
true
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "emetteur": {
    "type": "PRESTATAIRE",
    "code": "RAYDOCS",
    "nom": "Raydocs"
  }
}

Propriétés · 5

typestring#
en_tete.emetteur.type

Valeur de type string, à renseigner dans en_tete.emetteur.type.

Explications du référentiel

emetteur.type

  • PRESTATAIRE
  • AUTRE
Valeurs autorisées
"PRESTATAIRE""AUTRE"
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "type": "PRESTATAIRE"
}
codestringrequis#
en_tete.emetteur.code

Valeur de type string, à renseigner dans en_tete.emetteur.code.

Requis lorsque l’objet parent est présent.

minLength
1
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "code": "RAYDOCS"
}
nomstringrequis#
en_tete.emetteur.nom

Valeur de type string, à renseigner dans en_tete.emetteur.nom.

Requis lorsque l’objet parent est présent.

minLength
1
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "nom": "Raydocs"
}
logicielstring | null#
en_tete.emetteur.logiciel

Valeur de type string | null, à renseigner dans en_tete.emetteur.logiciel.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "logiciel": "Raydocs"
}
versionstring | null#
en_tete.emetteur.version

Valeur de type string | null, à renseigner dans en_tete.emetteur.version.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "version": "2026.1"
}
destinataireobjectrequis#
en_tete.destinataire

Ouvrez les propriétés ci-dessous pour explorer cet objet.

Requis lorsque l’objet parent est présent.

additionalProperties
true
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "destinataire": {
    "type": "ERP",
    "code": "ETUDE_DUPONT",
    "nom": "SCP Dupont",
    "logiciel": "LOGICIEL_METIER"
  }
}

Propriétés · 5

typestring#
en_tete.destinataire.type

Valeur de type string, à renseigner dans en_tete.destinataire.type.

Explications du référentiel

Valeur fixe : "ERP"

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "type": "ERP"
}
codestringrequis#
en_tete.destinataire.code

Valeur de type string, à renseigner dans en_tete.destinataire.code.

Requis lorsque l’objet parent est présent.

minLength
1
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "code": "ETUDE_DUPONT"
}
nomstringrequis#
en_tete.destinataire.nom

Valeur de type string, à renseigner dans en_tete.destinataire.nom.

Requis lorsque l’objet parent est présent.

minLength
1
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "nom": "SCP Dupont"
}
logicielstring | null#
en_tete.destinataire.logiciel

Valeur de type string | null, à renseigner dans en_tete.destinataire.logiciel.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "logiciel": "LOGICIEL_METIER"
}
reference_etudestring | null#
en_tete.destinataire.reference_etude

Valeur de type string | null, à renseigner dans en_tete.destinataire.reference_etude.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "reference_etude": "HJ001"
}
service_destinataireobjectrequis#
service_destinataire

Service cible commun à tous les dossiers du lot.

Requis lorsque l’objet parent est présent.

Explications du référentiel

service_destinataire.code est obligatoire au niveau du lot, mais ce n'est pas une enum globale CDJ Connect. Un ZIP CDJ Connect cible un seul service destinataire. Il ne doit pas mélanger des dossiers de plusieurs services. Le code identifie le service, pôle, bureau ou portefeuille du logiciel métier cible dans le périmètre du destinataire. Sa nomenclature est convenue par projet entre l'étude, le logiciel métier et le prestataire émetteur. Le logiciel métier peut mapper ce code vers son service interne, par exemple un service contentieux, recouvrement, actes détachés ou un portefeuille client.

additionalProperties
true
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "service_destinataire": {
    "code": "SVC-CONTENTIEUX",
    "libelle": "Contentieux"
  }
}

Propriétés · 2

codestringrequis#
service_destinataire.code

Valeur de type string, à renseigner dans service_destinataire.code.

Requis lorsque l’objet parent est présent.

minLength
1
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "code": "SVC-CONTENTIEUX"
}
libellestring | null#
service_destinataire.libelle

Valeur de type string | null, à renseigner dans service_destinataire.libelle.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "libelle": "Contentieux"
}
dossiers[]array<object>requis#
dossiers[]

Dossiers à créer ou enrichir. Chaque élément du tableau décrit un dossier.

Requis lorsque l’objet parent est présent.

Explications du référentiel

Ces enums servent au routage métier. Elles restent volontairement compactes en v1. Les cas non couverts doivent utiliser AUTRE avec un libelle_* explicite et, si utile, un code_*_externe.

minItems
1
Conditions du schéma (anyOf)

Ces conditions complètent les champs requis et les types affichés.

{
  "anyOf": [
    {
      "required": [
        "reference_client"
      ],
      "properties": {
        "reference_client": {
          "$ref": "#/$defs/non_empty_string"
        }
      }
    },
    {
      "required": [
        "reference_dossier_destinataire"
      ],
      "properties": {
        "reference_dossier_destinataire": {
          "$ref": "#/$defs/non_empty_string"
        }
      }
    }
  ]
}
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "dossiers": [
    {
      "reference_client": "CLI-12345",
      "reference_dossier_destinataire": null,
      "references_externes": [],
      "nature_dossier": "INJONCTION_DE_PAYER",
      "libelle_nature_dossier": "Injonction de payer",
      "code_nature_dossier_externe": null,
      "source_code_nature_dossier": null,
      "evenements": [
        {
          "code_evenement": "OUVERTURE_DOSSIER",
          "date_effet": "2026-05-20",
          "libelle": "Ouverture dossier"
        }
      ]
    }
  ]
}

Propriétés de chaque élément · 16

reference_clientstring#
dossiers[].reference_client

Référence attribuée par le client ou le système source.

minLength
1
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "reference_client": "CLI-12345"
}
reference_dossier_destinatairestring | null#
dossiers[].reference_dossier_destinataire

Valeur de type string | null, à renseigner dans dossiers[].reference_dossier_destinataire.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "reference_dossier_destinataire": null
}
references_externes[]array<object>#
dossiers[].references_externes[]

Références secondaires du dossier dans les systèmes externes.

Explications du référentiel

Les références externes complètent reference_client, mais ne la remplacent pas.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "references_externes": []
}

Propriétés de chaque élément · 4

type_referencestringrequis#
dossiers[].references_externes[].type_reference

Valeur de type string, à renseigner dans dossiers[].references_externes[].type_reference.

Requis lorsque l’objet parent est présent.

Explications du référentiel

type_reference_externe

  • REFERENCE_MANDANT
  • REFERENCE_CREANCIER
  • REFERENCE_PORTEFEUILLE
  • REFEXP
  • AUTRE
Valeurs autorisées
"REFERENCE_MANDANT""REFERENCE_CREANCIER""REFERENCE_PORTEFEUILLE""REFEXP""AUTRE"
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "type_reference": "REFERENCE_MANDANT"
}
valeurstringrequis#
dossiers[].references_externes[].valeur

Valeur de type string, à renseigner dans dossiers[].references_externes[].valeur.

Requis lorsque l’objet parent est présent.

minLength
1
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "valeur": "MANDAT-7788"
}
sourcestring | null#
dossiers[].references_externes[].source

Valeur de type string | null, à renseigner dans dossiers[].references_externes[].source.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "source": "CLIENT"
}
usage_rapprochementboolean#
dossiers[].references_externes[].usage_rapprochement

Valeur de type boolean, à renseigner dans dossiers[].references_externes[].usage_rapprochement.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "usage_rapprochement": true
}
nature_dossierstring#
dossiers[].nature_dossier

Valeur de type string, à renseigner dans dossiers[].nature_dossier.

Explications du référentiel

nature_dossier

  • RECOUVREMENT_CREANCE
  • INJONCTION_DE_PAYER
  • SIGNIFICATION_ACTE
  • ACTE_DETACHE
  • EXECUTION_TITRE
  • CONTENTIEUX_LOCATIF
  • MESURE_CONSERVATOIRE
  • EXPULSION
  • AUTRE
Valeurs autorisées
"RECOUVREMENT_CREANCE""INJONCTION_DE_PAYER""SIGNIFICATION_ACTE""ACTE_DETACHE""EXECUTION_TITRE""CONTENTIEUX_LOCATIF""MESURE_CONSERVATOIRE""EXPULSION""AUTRE"
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "nature_dossier": "INJONCTION_DE_PAYER"
}
libelle_nature_dossierstring | null#
dossiers[].libelle_nature_dossier

Valeur de type string | null, à renseigner dans dossiers[].libelle_nature_dossier.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "libelle_nature_dossier": "Injonction de payer"
}
code_nature_dossier_externestring | null#
dossiers[].code_nature_dossier_externe

Valeur de type string | null, à renseigner dans dossiers[].code_nature_dossier_externe.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "code_nature_dossier_externe": null
}
source_code_nature_dossierstring | null#
dossiers[].source_code_nature_dossier

Valeur de type string | null, à renseigner dans dossiers[].source_code_nature_dossier.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "source_code_nature_dossier": null
}
numero_rgstring | null#
dossiers[].numero_rg

Valeur de type string | null, à renseigner dans dossiers[].numero_rg.

evenements[]array<object>requis#
dossiers[].evenements[]

Actions demandées au logiciel destinataire pour ce dossier.

Requis lorsque l’objet parent est présent.

minItems
1
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "evenements": [
    {
      "code_evenement": "OUVERTURE_DOSSIER",
      "date_effet": "2026-05-20",
      "libelle": "Ouverture dossier"
    }
  ]
}

Propriétés de chaque élément · 4

code_evenementstringrequis#
dossiers[].evenements[].code_evenement

Valeur de type string, à renseigner dans dossiers[].evenements[].code_evenement.

Requis lorsque l’objet parent est présent.

Explications du référentiel

code_evenement_dossier

CodeLibelléSens pour le logiciel métierFamille métier
OUVERTURE_DOSSIEROuverture dossierCréer un nouveau dossier dans le logiciel métier.Dossier
MISE_A_JOUR_DOSSIERMise à jour dossierMettre à jour les métadonnées d'un dossier existant.Dossier
AJOUT_PIECEAjout pièceRattacher une ou plusieurs pièces au dossier.Document
ACTE_A_SIGNIFIERActe à signifierCréer ou préparer un acte à signifier.Acte
RETOUR_SIGNIFICATIONRetour significationImporter un retour ou résultat de signification.Retour
MISE_A_JOUR_CREANCEMise à jour créanceCréer ou mettre à jour créance, montants, intérêts.Finance
AJOUT_ACTION_AGENDAAjout action agendaCréer une action, tâche ou échéance côté logiciel métier.Agenda
CLOTURE_DOSSIERClôture dossierMarquer un dossier comme clôturé ou terminé.Statut
ANNULATION_ACTIONAnnulation actionAnnuler une action précédemment transmise.Correctif
Valeurs autorisées
"OUVERTURE_DOSSIER""MISE_A_JOUR_DOSSIER""AJOUT_PIECE""ACTE_A_SIGNIFIER""RETOUR_SIGNIFICATION""MISE_A_JOUR_CREANCE""AJOUT_ACTION_AGENDA""CLOTURE_DOSSIER""ANNULATION_ACTION"
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "code_evenement": "OUVERTURE_DOSSIER"
}
date_effetstringrequis#
dossiers[].evenements[].date_effet

Valeur de type string, à renseigner dans dossiers[].evenements[].date_effet.

Requis lorsque l’objet parent est présent.

format
date
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "date_effet": "2026-05-20"
}
libellestring | null#
dossiers[].evenements[].libelle

Valeur de type string | null, à renseigner dans dossiers[].evenements[].libelle.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "libelle": "Ouverture dossier"
}
renseignements[]array<object>#
dossiers[].evenements[].renseignements[]

Informations complémentaires typées.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "renseignements": [
    {
      "type": "commentaire",
      "valeur": "Le créancier confirme la mise à jour transmise."
    }
  ]
}

Propriétés de chaque élément · 2

typestringrequis#
dossiers[].evenements[].renseignements[].type

Valeur de type string, à renseigner dans dossiers[].evenements[].renseignements[].type.

Requis lorsque l’objet parent est présent.

Valeurs autorisées
"commentaire""point_attention""synthese_dossier""commentaire_pieces""commentaire_calcul""commentaire_calcul_loyer""instruction_import""anomalie_source""priorite""statut""autre"
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "type": "commentaire"
}
valeuranyrequis#
dossiers[].evenements[].renseignements[].valeur

Valeur de type any, à renseigner dans dossiers[].evenements[].renseignements[].valeur.

Requis lorsque l’objet parent est présent.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "valeur": "Le créancier confirme la mise à jour transmise."
}
renseignements[]array<object>#
dossiers[].renseignements[]

Informations complémentaires typées.

Explications du référentiel

Les renseignements[] portent des informations libres ou semi-structurées. Les types existants sont conservés. Règles de mapping:

  • type est la clé stable d'identification et de mapping; l'ordre du tableau n'a aucune sémantique;
  • dossiers[].renseignements[] est l'emplacement canonique des variables métier du dossier;
  • dossiers[].evenements[].renseignements[] décrit le contexte de l'événement concerné;
  • un logiciel métier peut mapper un type vers une variable, un champ ou une note;
  • un type inconnu peut être ignoré sans bloquer l'import;
  • l'absence d'un renseignement dans une mise à jour ne supprime aucune donnée;
  • les renseignements ne remplacent pas les champs canoniques du format, notamment nature_creance. Un connecteur du logiciel métier ne doit pas transformer automatiquement tous les renseignements en notes visibles. Il doit distinguer les renseignements faits pour être lus par un opérateur des renseignements structurants à mapper autrement.
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "renseignements": [
    {
      "type": "synthese_dossier",
      "valeur": "Impayés portant sur trois factures d'électricité."
    }
  ]
}

Propriétés de chaque élément · 2

typestringrequis#
dossiers[].renseignements[].type

Valeur de type string, à renseigner dans dossiers[].renseignements[].type.

Requis lorsque l’objet parent est présent.

Explications du référentiel

type_renseignement

Types adaptés à une note opérateur, selon la configuration du logiciel destinataire :

  • commentaire
  • point_attention
  • synthese_dossier
  • commentaire_pieces
  • commentaire_calcul
  • commentaire_calcul_loyer
  • instruction_import
  • anomalie_source Types structurants, à mapper vers des champs du logiciel métier ou des contrôles, mais pas en note visible par défaut:
  • priorite
  • statut
  • autrenumero_rg, numero_tva, numero_immatriculation et type_immatriculation ne sont plus des types de renseignements. Utiliser respectivement dossiers[].numero_rg et les champs de intervenants[].ipm.
Valeurs autorisées
"commentaire""point_attention""synthese_dossier""commentaire_pieces""commentaire_calcul""commentaire_calcul_loyer""instruction_import""anomalie_source""priorite""statut""autre"
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "type": "synthese_dossier"
}
valeuranyrequis#
dossiers[].renseignements[].valeur

Valeur de type any, à renseigner dans dossiers[].renseignements[].valeur.

Requis lorsque l’objet parent est présent.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "valeur": "Impayés portant sur trois factures d'électricité."
}
intervenants[]array<object>#
dossiers[].intervenants[]

Personnes liées à ce dossier, avec leur rôle et leur identité ou une référence déjà connue du logiciel métier.

Explications du référentiel

Références d'intervenant

La nomenclature des références suit celle du dossier:

  • dossiers[].reference_client: référence du dossier attribuée par le client ou le système source;
  • dossiers[].reference_dossier_destinataire: identifiant du dossier dans le logiciel métier destinataire;
  • dossiers[].intervenants[].reference_client: référence de l'intervenant attribuée par le client ou le système source;
  • dossiers[].intervenants[].reference_intervenant_destinataire: identifiant d'une fiche intervenant déjà connue dans le logiciel métier destinataire. Le role est toujours obligatoire. Sans référence destinataire, reference_client et exactement un objet ipp ou ipm sont requis. Avec reference_intervenant_destinataire, le logiciel métier réutilise la fiche existante sans exiger ipp ou ipm; une référence introuvable est une anomalie et ne déclenche jamais une création silencieuse. Si les deux références sont présentes, elles doivent désigner le même intervenant. Les données d'identité jointes à un ID destinataire ne doivent pas écraser automatiquement la fiche maître. Lors d'une MISE_A_JOUR_DOSSIER, les intervenants transmis sont ajoutés ou ciblés; les intervenants absents restent inchangés. Un même intervenant du logiciel métier peut avoir des rôles différents selon les dossiers.

contacts[] est optionnel sur chaque intervenant. Si un contact est transmis, son type et sa valeur sont obligatoires. TEL couvre les numéros fixes et mobiles; plusieurs contacts TEL peuvent être transmis pour un même intervenant. Les adresses sont représentées dans adresses[] sur ipp ou ipm. Chaque adresse est structurée avec les champs usuels ligne1, ligne2, ligne3, code_postal, ville et pays. Les champs type, label et principal sont optionnels. Les comptes bancaires sont représentés dans comptes_bancaires[] sur ipp ou ipm. Ils servent à transmettre IBAN/BIC et ne participent jamais au rapprochement dossier.

Conditions du schéma (not, anyOf)

Ces conditions complètent les champs requis et les types affichés.

{
  "not": {
    "required": [
      "ipp",
      "ipm"
    ]
  },
  "anyOf": [
    {
      "required": [
        "reference_intervenant_destinataire"
      ]
    },
    {
      "required": [
        "ipp"
      ]
    },
    {
      "required": [
        "ipm"
      ]
    }
  ]
}
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "intervenants": [
    {
      "reference_intervenant_destinataire": "ERP-INTERV-10",
      "role": "CRE01"
    }
  ]
}

Propriétés de chaque élément · 6

reference_clientstring#
dossiers[].intervenants[].reference_client

Référence attribuée par le client ou le système source.

minLength
1
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "reference_client": "DEF-001"
}
reference_intervenant_destinatairestring#
dossiers[].intervenants[].reference_intervenant_destinataire

Valeur de type string, à renseigner dans dossiers[].intervenants[].reference_intervenant_destinataire.

minLength
1
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "reference_intervenant_destinataire": "ERP-INTERV-10"
}
rolestringrequis#
dossiers[].intervenants[].role

Rôle de cet intervenant dans le dossier.

Requis lorsque l’objet parent est présent.

Explications du référentiel

role_intervenant

Les rôles utilisent des codes compacts et stables. Chaque logiciel métier peut les mapper vers ses propres rôles internes. Les suffixes numériques 01, 02, 03, etc. identifient l'occurrence dans une même famille de rôle: DEF01, DEF02, DEF03, etc. La liste ci-dessous donne les codes usuels; un projet peut continuer la numérotation si nécessaire.

CodeLibellé
DEF01Défendeur / débiteur principal
DEF02Défendeur / débiteur secondaire
CRE01Créancier principal
CRE02Créancier secondaire
EMD01DEF01Employeur ou tiers lié au défendeur
HUI01Commissaire de justice / étude
REP01Représentant
GAR01Garant
TIE01Tiers
COR01Correspondant
pattern
^[A-Z]{3}[0-9]{2}([A-Z]{3}[0-9]{2})?$
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "role": "CRE01"
}
ippobject#
dossiers[].intervenants[].ipp

Identité d’une personne physique.

additionalProperties
true
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "ipp": {
    "civilite": "M",
    "nom": "DUPONT",
    "prenom": "Jean",
    "adresses": [
      {
        "ligne1": "21 rue Victor Hugo",
        "ligne2": null,
        "ligne3": null,
        "code_postal": "75016",
        "ville": "PARIS",
        "pays": "FR",
        "type": "SIGNIFICATION",
        "label": "Adresse de signification",
        "principal": true
      }
    ]
  }
}

Propriétés · 5

civilitestring#
dossiers[].intervenants[].ipp.civilite

Valeur de type string, à renseigner dans dossiers[].intervenants[].ipp.civilite.

Explications du référentiel

civilite

  • M
  • MME
  • MLLE
  • MX
  • STE
  • MAITRE
  • DOCTEUR
  • AUTRE
Valeurs autorisées
"M""MME""MLLE""MX""STE""MAITRE""DOCTEUR""AUTRE"
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "civilite": "M"
}
nomstring | null#
dossiers[].intervenants[].ipp.nom

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipp.nom.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "nom": "DUPONT"
}
prenomstring | null#
dossiers[].intervenants[].ipp.prenom

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipp.prenom.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "prenom": "Jean"
}
adresses[]array<object>#
dossiers[].intervenants[].ipp.adresses[]

Adresses de cette personne.

Explications du référentiel

adresse

Champs standard d'une adresse :

  • ligne1 : première ligne d'adresse.
  • ligne2 : optionnel.
  • ligne3 : optionnel.
  • code_postal : optionnel mais recommandé.
  • ville : optionnel mais recommandé.
  • pays : optionnel, recommandé au format ISO 3166-1 alpha-2, par exemple FR.
  • type : optionnel, code libre projet si une distinction est utile, par exemple SIEGE, SIGNIFICATION ou FACTURATION.
  • label : optionnel, libellé lisible si le type ne suffit pas.
  • principal : optionnel, true si l'adresse est l'adresse principale de l'intervenant. Règles :
  • un intervenant peut avoir plusieurs adresses ;
  • un seul compte ou une seule adresse devrait être marqué principal: true par intervenant et par type d'objet ;
  • l'adresse ne doit jamais servir de clé de rapprochement dossier.
Conditions du schéma (anyOf)

Ces conditions complètent les champs requis et les types affichés.

{
  "anyOf": [
    {
      "required": [
        "ligne1"
      ],
      "properties": {
        "ligne1": {
          "$ref": "#/$defs/non_empty_string"
        }
      }
    },
    {
      "required": [
        "ligne2"
      ],
      "properties": {
        "ligne2": {
          "$ref": "#/$defs/non_empty_string"
        }
      }
    },
    {
      "required": [
        "ligne3"
      ],
      "properties": {
        "ligne3": {
          "$ref": "#/$defs/non_empty_string"
        }
      }
    },
    {
      "required": [
        "code_postal"
      ],
      "properties": {
        "code_postal": {
          "$ref": "#/$defs/non_empty_string"
        }
      }
    },
    {
      "required": [
        "ville"
      ],
      "properties": {
        "ville": {
          "$ref": "#/$defs/non_empty_string"
        }
      }
    },
    {
      "required": [
        "pays"
      ],
      "properties": {
        "pays": {
          "$ref": "#/$defs/non_empty_string"
        }
      }
    }
  ]
}
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "adresses": [
    {
      "ligne1": "21 rue Victor Hugo",
      "ligne2": null,
      "ligne3": null,
      "code_postal": "75016",
      "ville": "PARIS",
      "pays": "FR",
      "type": "SIGNIFICATION",
      "label": "Adresse de signification",
      "principal": true
    }
  ]
}

Propriétés de chaque élément · 9

ligne1string | null#
dossiers[].intervenants[].ipp.adresses[].ligne1

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipp.adresses[].ligne1.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "ligne1": "21 rue Victor Hugo"
}
ligne2string | null#
dossiers[].intervenants[].ipp.adresses[].ligne2

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipp.adresses[].ligne2.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "ligne2": null
}
ligne3string | null#
dossiers[].intervenants[].ipp.adresses[].ligne3

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipp.adresses[].ligne3.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "ligne3": null
}
code_postalstring | null#
dossiers[].intervenants[].ipp.adresses[].code_postal

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipp.adresses[].code_postal.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "code_postal": "75016"
}
villestring | null#
dossiers[].intervenants[].ipp.adresses[].ville

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipp.adresses[].ville.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "ville": "PARIS"
}
paysstring | null#
dossiers[].intervenants[].ipp.adresses[].pays

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipp.adresses[].pays.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "pays": "FR"
}
typestring | null#
dossiers[].intervenants[].ipp.adresses[].type

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipp.adresses[].type.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "type": "SIGNIFICATION"
}
labelstring | null#
dossiers[].intervenants[].ipp.adresses[].label

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipp.adresses[].label.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "label": "Adresse de signification"
}
principalboolean#
dossiers[].intervenants[].ipp.adresses[].principal

Valeur de type boolean, à renseigner dans dossiers[].intervenants[].ipp.adresses[].principal.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "principal": true
}
comptes_bancaires[]array<object>#
dossiers[].intervenants[].ipp.comptes_bancaires[]

Coordonnées bancaires de cette personne.

Explications du référentiel

compte_bancaire

Champs standard d'un compte bancaire :

  • reference_compte_bancaire : optionnel mais recommandé pour éviter les doublons lors des mises à jour.
  • iban : obligatoire.
  • bic : optionnel mais recommandé si connu.
  • titulaire : optionnel, utile si différent du nom ou de la raison sociale de l'intervenant.
  • domiciliation : optionnel.
  • principal : optionnel, true si le compte est le compte principal de l'intervenant. Règles :
  • l'IBAN doit être transmis sans espaces et en majuscules ;
  • le BIC doit être transmis sans espaces et en majuscules ;
  • un intervenant peut avoir plusieurs comptes bancaires ;
  • un seul compte bancaire devrait être marqué principal: true par intervenant ;
  • le logiciel métier doit valider l'IBAN avant création ou mise à jour ;
  • l'IBAN ne doit jamais servir de clé de rapprochement dossier.

Propriétés de chaque élément · 6

reference_compte_bancairestring | null#
dossiers[].intervenants[].ipp.comptes_bancaires[].reference_compte_bancaire

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipp.comptes_bancaires[].reference_compte_bancaire.

ibanstringrequis#
dossiers[].intervenants[].ipp.comptes_bancaires[].iban

Valeur de type string, à renseigner dans dossiers[].intervenants[].ipp.comptes_bancaires[].iban.

Requis lorsque l’objet parent est présent.

pattern
^[A-Z]{2}[0-9A-Z]{13,32}$
bicstring | null#
dossiers[].intervenants[].ipp.comptes_bancaires[].bic

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipp.comptes_bancaires[].bic.

pattern
^[A-Z0-9]{8}([A-Z0-9]{3})?$
titulairestring | null#
dossiers[].intervenants[].ipp.comptes_bancaires[].titulaire

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipp.comptes_bancaires[].titulaire.

domiciliationstring | null#
dossiers[].intervenants[].ipp.comptes_bancaires[].domiciliation

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipp.comptes_bancaires[].domiciliation.

principalboolean#
dossiers[].intervenants[].ipp.comptes_bancaires[].principal

Valeur de type boolean, à renseigner dans dossiers[].intervenants[].ipp.comptes_bancaires[].principal.

ipmobject#
dossiers[].intervenants[].ipm

Identité d’une personne morale.

Explications du référentiel

Identifiants de personne morale (ipm)

  • siret : identifiant établissement, déjà présent.
  • siren : identifiant de la personne morale.
  • numero_rcs et greffe_rcs : immatriculation RCS et greffe associé.
  • numero_tva : numéro de TVA intracommunautaire.
  • numero_rna : identifiant RNA d’une association. Ils sont optionnels. Le Kbis est porté comme pièce avec pieces_jointes[].categorie: KBIS.
additionalProperties
true
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "ipm": {
    "siret": "12345678900012",
    "raison_sociale": "ACME HABITAT",
    "statut_juridique": "SA",
    "adresses": [
      {
        "ligne1": "10 avenue de la Republique",
        "code_postal": "75011",
        "ville": "PARIS",
        "pays": "FR",
        "type": "SIEGE",
        "principal": true
      }
    ],
    "comptes_bancaires": [
      {
        "reference_compte_bancaire": "BANQUE-CRE-001",
        "iban": "FR7630006000011234567890189",
        "bic": "AGRIFRPP",
        "titulaire": "ACME HABITAT",
        "domiciliation": "CREDIT AGRICOLE",
        "principal": true
      }
    ]
  }
}

Propriétés · 10

siretstring | null#
dossiers[].intervenants[].ipm.siret

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipm.siret.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "siret": "12345678900012"
}
sirenstring | null#
dossiers[].intervenants[].ipm.siren

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipm.siren.

numero_rcsstring | null#
dossiers[].intervenants[].ipm.numero_rcs

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipm.numero_rcs.

greffe_rcsstring | null#
dossiers[].intervenants[].ipm.greffe_rcs

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipm.greffe_rcs.

numero_tvastring | null#
dossiers[].intervenants[].ipm.numero_tva

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipm.numero_tva.

numero_rnastring | null#
dossiers[].intervenants[].ipm.numero_rna

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipm.numero_rna.

raison_socialestring | null#
dossiers[].intervenants[].ipm.raison_sociale

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipm.raison_sociale.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "raison_sociale": "ACME HABITAT"
}
statut_juridiquestring | null#
dossiers[].intervenants[].ipm.statut_juridique

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipm.statut_juridique.

Explications du référentiel

statut_juridique

  • EI
  • EIRL
  • MICRO_ENTREPRISE
  • SARL
  • EURL
  • SAS
  • SASU
  • SA
  • SCI
  • SCPI
  • SCM
  • SNC
  • ASSOCIATION
  • COPROPRIETE
  • COLLECTIVITE
  • ETABLISSEMENT_PUBLIC
  • AUTRE
  • INCONNU
Valeurs autorisées
"EI""EIRL""MICRO_ENTREPRISE""SARL""EURL""SAS""SASU""SA""SCI""SCPI""SCM""SNC""ASSOCIATION""COPROPRIETE""COLLECTIVITE""ETABLISSEMENT_PUBLIC""AUTRE""INCONNU"null
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "statut_juridique": "SA"
}
adresses[]array<object>#
dossiers[].intervenants[].ipm.adresses[]

Adresses de cette personne.

Conditions du schéma (anyOf)

Ces conditions complètent les champs requis et les types affichés.

{
  "anyOf": [
    {
      "required": [
        "ligne1"
      ],
      "properties": {
        "ligne1": {
          "$ref": "#/$defs/non_empty_string"
        }
      }
    },
    {
      "required": [
        "ligne2"
      ],
      "properties": {
        "ligne2": {
          "$ref": "#/$defs/non_empty_string"
        }
      }
    },
    {
      "required": [
        "ligne3"
      ],
      "properties": {
        "ligne3": {
          "$ref": "#/$defs/non_empty_string"
        }
      }
    },
    {
      "required": [
        "code_postal"
      ],
      "properties": {
        "code_postal": {
          "$ref": "#/$defs/non_empty_string"
        }
      }
    },
    {
      "required": [
        "ville"
      ],
      "properties": {
        "ville": {
          "$ref": "#/$defs/non_empty_string"
        }
      }
    },
    {
      "required": [
        "pays"
      ],
      "properties": {
        "pays": {
          "$ref": "#/$defs/non_empty_string"
        }
      }
    }
  ]
}
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "adresses": [
    {
      "ligne1": "10 avenue de la Republique",
      "code_postal": "75011",
      "ville": "PARIS",
      "pays": "FR",
      "type": "SIEGE",
      "principal": true
    }
  ]
}

Propriétés de chaque élément · 9

ligne1string | null#
dossiers[].intervenants[].ipm.adresses[].ligne1

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipm.adresses[].ligne1.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "ligne1": "10 avenue de la Republique"
}
ligne2string | null#
dossiers[].intervenants[].ipm.adresses[].ligne2

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipm.adresses[].ligne2.

ligne3string | null#
dossiers[].intervenants[].ipm.adresses[].ligne3

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipm.adresses[].ligne3.

code_postalstring | null#
dossiers[].intervenants[].ipm.adresses[].code_postal

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipm.adresses[].code_postal.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "code_postal": "75011"
}
villestring | null#
dossiers[].intervenants[].ipm.adresses[].ville

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipm.adresses[].ville.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "ville": "PARIS"
}
paysstring | null#
dossiers[].intervenants[].ipm.adresses[].pays

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipm.adresses[].pays.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "pays": "FR"
}
typestring | null#
dossiers[].intervenants[].ipm.adresses[].type

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipm.adresses[].type.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "type": "SIEGE"
}
labelstring | null#
dossiers[].intervenants[].ipm.adresses[].label

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipm.adresses[].label.

principalboolean#
dossiers[].intervenants[].ipm.adresses[].principal

Valeur de type boolean, à renseigner dans dossiers[].intervenants[].ipm.adresses[].principal.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "principal": true
}
comptes_bancaires[]array<object>#
dossiers[].intervenants[].ipm.comptes_bancaires[]

Coordonnées bancaires de cette personne.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "comptes_bancaires": [
    {
      "reference_compte_bancaire": "BANQUE-CRE-001",
      "iban": "FR7630006000011234567890189",
      "bic": "AGRIFRPP",
      "titulaire": "ACME HABITAT",
      "domiciliation": "CREDIT AGRICOLE",
      "principal": true
    }
  ]
}

Propriétés de chaque élément · 6

reference_compte_bancairestring | null#
dossiers[].intervenants[].ipm.comptes_bancaires[].reference_compte_bancaire

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipm.comptes_bancaires[].reference_compte_bancaire.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "reference_compte_bancaire": "BANQUE-CRE-001"
}
ibanstringrequis#
dossiers[].intervenants[].ipm.comptes_bancaires[].iban

Valeur de type string, à renseigner dans dossiers[].intervenants[].ipm.comptes_bancaires[].iban.

Requis lorsque l’objet parent est présent.

pattern
^[A-Z]{2}[0-9A-Z]{13,32}$
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "iban": "FR7630006000011234567890189"
}
bicstring | null#
dossiers[].intervenants[].ipm.comptes_bancaires[].bic

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipm.comptes_bancaires[].bic.

pattern
^[A-Z0-9]{8}([A-Z0-9]{3})?$
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "bic": "AGRIFRPP"
}
titulairestring | null#
dossiers[].intervenants[].ipm.comptes_bancaires[].titulaire

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipm.comptes_bancaires[].titulaire.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "titulaire": "ACME HABITAT"
}
domiciliationstring | null#
dossiers[].intervenants[].ipm.comptes_bancaires[].domiciliation

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].ipm.comptes_bancaires[].domiciliation.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "domiciliation": "CREDIT AGRICOLE"
}
principalboolean#
dossiers[].intervenants[].ipm.comptes_bancaires[].principal

Valeur de type boolean, à renseigner dans dossiers[].intervenants[].ipm.comptes_bancaires[].principal.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "principal": true
}
contacts[]array<object>#
dossiers[].intervenants[].contacts[]

Moyens de contact de cet intervenant.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "contacts": [
    {
      "type": "EMAIL",
      "valeur": "jean.dupont@example.com"
    }
  ]
}

Propriétés de chaque élément · 4

typestringrequis#
dossiers[].intervenants[].contacts[].type

Valeur de type string, à renseigner dans dossiers[].intervenants[].contacts[].type.

Requis lorsque l’objet parent est présent.

Explications du référentiel

type_contact

  • EMAIL
  • TEL
  • FAX
Valeurs autorisées
"EMAIL""TEL""FAX"
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "type": "EMAIL"
}
valeurstringrequis#
dossiers[].intervenants[].contacts[].valeur

Valeur de type string, à renseigner dans dossiers[].intervenants[].contacts[].valeur.

Requis lorsque l’objet parent est présent.

minLength
1
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "valeur": "jean.dupont@example.com"
}
libellestring | null#
dossiers[].intervenants[].contacts[].libelle

Valeur de type string | null, à renseigner dans dossiers[].intervenants[].contacts[].libelle.

principalboolean#
dossiers[].intervenants[].contacts[].principal

Valeur de type boolean, à renseigner dans dossiers[].intervenants[].contacts[].principal.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "principal": true
}
elements_financiers[]array<object>#
dossiers[].elements_financiers[]

Créances et éléments financiers associés au dossier.

Explications du référentiel

Champs de créance

  • reference_element_financier reste l'identifiant stable de la créance;
  • nature_creance est optionnel mais recommandé et décrit la nature métier globale de l'élément financier;
  • libelle est optionnel dans chaque ligne de montant_details[]; lorsqu'il est transmis, il décrit lisiblement la ligne de montant;
  • l'ancien champ non défini nature ne doit pas être utilisé dans les lignes de montant.
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "elements_financiers": [
    {
      "reference_element_financier": "CREANCE-123",
      "nature_creance": "Loyers et charges impayés",
      "montant_details": [
        {
          "type": "principal",
          "classe": "CRE",
          "devise": "EUR",
          "signe": "+",
          "montant": "177.82",
          "date": "2024-10-02"
        }
      ],
      "interets": [
        {
          "reference_interet": "INT-001",
          "type": "legal",
          "base_montant": "177.82",
          "date_debut": "2024-10-02",
          "mode_taux": "taux_legal",
          "coefficient": "3.0",
          "periodicite": "journalier"
        }
      ]
    }
  ]
}

Propriétés de chaque élément · 4

reference_element_financierstringrequis#
dossiers[].elements_financiers[].reference_element_financier

Valeur de type string, à renseigner dans dossiers[].elements_financiers[].reference_element_financier.

Requis lorsque l’objet parent est présent.

minLength
1
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "reference_element_financier": "CREANCE-123"
}
nature_creancestring#
dossiers[].elements_financiers[].nature_creance

Valeur de type string, à renseigner dans dossiers[].elements_financiers[].nature_creance.

minLength
1
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "nature_creance": "Loyers et charges impayés"
}
montant_details[]array<object>#
dossiers[].elements_financiers[].montant_details[]

Lignes de montant de cet élément financier.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "montant_details": [
    {
      "type": "principal",
      "classe": "CRE",
      "devise": "EUR",
      "signe": "+",
      "montant": "177.82",
      "date": "2024-10-02"
    }
  ]
}

Propriétés de chaque élément · 7

typestring#
dossiers[].elements_financiers[].montant_details[].type

Valeur de type string, à renseigner dans dossiers[].elements_financiers[].montant_details[].type.

Explications du référentiel

type_montant

  • principal
  • interet
  • frais
  • depens
  • penalite
  • paiement
  • regularisation
  • autre
Valeurs autorisées
"principal""interet""frais""depens""penalite""paiement""regularisation""autre"
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "type": "principal"
}
libellestring#
dossiers[].elements_financiers[].montant_details[].libelle

Valeur de type string, à renseigner dans dossiers[].elements_financiers[].montant_details[].libelle.

minLength
1
classestring#
dossiers[].elements_financiers[].montant_details[].classe

Valeur de type string, à renseigner dans dossiers[].elements_financiers[].montant_details[].classe.

Explications du référentiel
Valeurs autorisées
"CRE""DBT""CRT"
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "classe": "CRE"
}
devisestring#
dossiers[].elements_financiers[].montant_details[].devise

Valeur de type string, à renseigner dans dossiers[].elements_financiers[].montant_details[].devise.

Explications du référentiel

Valeur fixe : "EUR"

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "devise": "EUR"
}
signestring#
dossiers[].elements_financiers[].montant_details[].signe

Valeur de type string, à renseigner dans dossiers[].elements_financiers[].montant_details[].signe.

Explications du référentiel
Valeurs autorisées
"+""-"
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "signe": "+"
}
montantstring#
dossiers[].elements_financiers[].montant_details[].montant

Valeur de type string, à renseigner dans dossiers[].elements_financiers[].montant_details[].montant.

pattern
^-?\d+(\.\d+)?$
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "montant": "177.82"
}
datestring#
dossiers[].elements_financiers[].montant_details[].date

Valeur de type string, à renseigner dans dossiers[].elements_financiers[].montant_details[].date.

format
date
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "date": "2024-10-02"
}
interets[]array<object>#
dossiers[].elements_financiers[].interets[]

Mécanismes d’intérêts appliqués à cet élément financier.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "interets": [
    {
      "reference_interet": "INT-001",
      "type": "legal",
      "base_montant": "177.82",
      "date_debut": "2024-10-02",
      "mode_taux": "taux_legal",
      "coefficient": "3.0",
      "periodicite": "journalier"
    }
  ]
}

Propriétés de chaque élément · 7

reference_interetstringrequis#
dossiers[].elements_financiers[].interets[].reference_interet

Valeur de type string, à renseigner dans dossiers[].elements_financiers[].interets[].reference_interet.

Requis lorsque l’objet parent est présent.

minLength
1
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "reference_interet": "INT-001"
}
typestring#
dossiers[].elements_financiers[].interets[].type

Valeur de type string, à renseigner dans dossiers[].elements_financiers[].interets[].type.

Explications du référentiel

type_interet

  • legal
  • contractuel
  • manuel
Valeurs autorisées
"legal""contractuel""manuel"
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "type": "legal"
}
base_montantstring#
dossiers[].elements_financiers[].interets[].base_montant

Valeur de type string, à renseigner dans dossiers[].elements_financiers[].interets[].base_montant.

pattern
^-?\d+(\.\d+)?$
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "base_montant": "177.82"
}
date_debutstring#
dossiers[].elements_financiers[].interets[].date_debut

Valeur de type string, à renseigner dans dossiers[].elements_financiers[].interets[].date_debut.

format
date
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "date_debut": "2024-10-02"
}
mode_tauxstring#
dossiers[].elements_financiers[].interets[].mode_taux

Valeur de type string, à renseigner dans dossiers[].elements_financiers[].interets[].mode_taux.

Explications du référentiel

mode_taux

  • taux_legal
  • taux_fixe
  • bareme_manuel
Valeurs autorisées
"taux_legal""taux_fixe""bareme_manuel"
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "mode_taux": "taux_legal"
}
coefficientstring#
dossiers[].elements_financiers[].interets[].coefficient

Valeur de type string, à renseigner dans dossiers[].elements_financiers[].interets[].coefficient.

pattern
^-?\d+(\.\d+)?$
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "coefficient": "3.0"
}
periodicitestring#
dossiers[].elements_financiers[].interets[].periodicite

Valeur de type string, à renseigner dans dossiers[].elements_financiers[].interets[].periodicite.

Explications du référentiel

periodicite

  • journalier
  • mensuel
  • trimestriel
  • annuel
Valeurs autorisées
"journalier""mensuel""trimestriel""annuel"
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "periodicite": "journalier"
}
mesures[]array<object>#
dossiers[].mesures[]

Mesures associées au dossier.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "mesures": [
    {
      "reference_mesure": "MES-001",
      "type_mesure": "EXPULSION",
      "libelle_mesure": "Procédure d'expulsion",
      "code_mesure_externe": null,
      "source_code_mesure": null
    }
  ]
}

Propriétés de chaque élément · 5

reference_mesurestringrequis#
dossiers[].mesures[].reference_mesure

Valeur de type string, à renseigner dans dossiers[].mesures[].reference_mesure.

Requis lorsque l’objet parent est présent.

minLength
1
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "reference_mesure": "MES-001"
}
type_mesurestringrequis#
dossiers[].mesures[].type_mesure

Valeur de type string, à renseigner dans dossiers[].mesures[].type_mesure.

Requis lorsque l’objet parent est présent.

Explications du référentiel

type_mesure

  • NANTISSEMENT
  • SAISIE_ATTRIBUTION
  • SAISIE_VENTE
  • SAISIE_REMUNERATIONS
  • SAISIE_CONSERVATOIRE
  • EXPULSION
  • AUTRE
Valeurs autorisées
"NANTISSEMENT""SAISIE_ATTRIBUTION""SAISIE_VENTE""SAISIE_REMUNERATIONS""SAISIE_CONSERVATOIRE""EXPULSION""AUTRE"
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "type_mesure": "EXPULSION"
}
libelle_mesurestring | null#
dossiers[].mesures[].libelle_mesure

Valeur de type string | null, à renseigner dans dossiers[].mesures[].libelle_mesure.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "libelle_mesure": "Procédure d'expulsion"
}
code_mesure_externestring | null#
dossiers[].mesures[].code_mesure_externe

Valeur de type string | null, à renseigner dans dossiers[].mesures[].code_mesure_externe.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "code_mesure_externe": null
}
source_code_mesurestring | null#
dossiers[].mesures[].source_code_mesure

Valeur de type string | null, à renseigner dans dossiers[].mesures[].source_code_mesure.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "source_code_mesure": null
}
actes[]array<object>#
dossiers[].actes[]

Actes associés au dossier.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "actes": [
    {
      "reference_acte": "ACT-001",
      "type_acte": "COMMANDEMENT_DE_PAYER",
      "libelle_acte": "Commandement de payer les loyers",
      "code_acte_externe": null,
      "source_code_acte": null,
      "date_acte": "2026-05-20",
      "references_pieces": [
        "DOC-BAIL"
      ]
    }
  ]
}

Propriétés de chaque élément · 7

reference_actestringrequis#
dossiers[].actes[].reference_acte

Valeur de type string, à renseigner dans dossiers[].actes[].reference_acte.

Requis lorsque l’objet parent est présent.

minLength
1
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "reference_acte": "ACT-001"
}
type_actestringrequis#
dossiers[].actes[].type_acte

Valeur de type string, à renseigner dans dossiers[].actes[].type_acte.

Requis lorsque l’objet parent est présent.

Explications du référentiel

type_acte

  • COMMANDEMENT_DE_PAYER
  • SIGNIFICATION_ACTE
  • SIGNIFICATION_ORDONNANCE_IP
  • DENONCIATION
  • SOMMATION
  • MISE_EN_DEMEURE
  • PV
  • ACTE_DETACHE
  • AUTRE
Valeurs autorisées
"COMMANDEMENT_DE_PAYER""SIGNIFICATION_ACTE""SIGNIFICATION_ORDONNANCE_IP""DENONCIATION""SOMMATION""MISE_EN_DEMEURE""PV""ACTE_DETACHE""AUTRE"
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "type_acte": "COMMANDEMENT_DE_PAYER"
}
libelle_actestring | null#
dossiers[].actes[].libelle_acte

Valeur de type string | null, à renseigner dans dossiers[].actes[].libelle_acte.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "libelle_acte": "Commandement de payer les loyers"
}
code_acte_externestring | null#
dossiers[].actes[].code_acte_externe

Valeur de type string | null, à renseigner dans dossiers[].actes[].code_acte_externe.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "code_acte_externe": null
}
source_code_actestring | null#
dossiers[].actes[].source_code_acte

Valeur de type string | null, à renseigner dans dossiers[].actes[].source_code_acte.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "source_code_acte": null
}
date_actestring#
dossiers[].actes[].date_acte

Valeur de type string, à renseigner dans dossiers[].actes[].date_acte.

format
date
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "date_acte": "2026-05-20"
}
references_pieces[]array<string>#
dossiers[].actes[].references_pieces[]

Valeur de type array, à renseigner dans dossiers[].actes[].references_pieces[].

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "references_pieces": [
    "DOC-BAIL"
  ]
}
agenda[]array<object>#
dossiers[].agenda[]

Actions et échéances du dossier.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "agenda": [
    {
      "reference_evenement": "ACT-001",
      "code_evenement": "TEL",
      "libelle": "RELANCE TELEPHONIQUE",
      "date_effet": "2026-05-22",
      "affecte_a": "MBO",
      "statut": "a_faire"
    }
  ]
}

Propriétés de chaque élément · 5

reference_evenementstringrequis#
dossiers[].agenda[].reference_evenement

Valeur de type string, à renseigner dans dossiers[].agenda[].reference_evenement.

Requis lorsque l’objet parent est présent.

minLength
1
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "reference_evenement": "ACT-001"
}
code_evenementstringrequis#
dossiers[].agenda[].code_evenement

Valeur de type string, à renseigner dans dossiers[].agenda[].code_evenement.

Requis lorsque l’objet parent est présent.

minLength
1
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "code_evenement": "TEL"
}
libellestring | null#
dossiers[].agenda[].libelle

Valeur de type string | null, à renseigner dans dossiers[].agenda[].libelle.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "libelle": "RELANCE TELEPHONIQUE"
}
date_effetstringrequis#
dossiers[].agenda[].date_effet

Valeur de type string, à renseigner dans dossiers[].agenda[].date_effet.

Requis lorsque l’objet parent est présent.

format
date
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "date_effet": "2026-05-22"
}
statutstring#
dossiers[].agenda[].statut

Valeur de type string, à renseigner dans dossiers[].agenda[].statut.

Explications du référentiel

statut_agenda

  • a_faire
  • fait
  • annule
Valeurs autorisées
"a_faire""fait""annule"
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "statut": "a_faire"
}
pieces_jointes[]array<object>#
dossiers[].pieces_jointes[]

Métadonnées et chemins des fichiers joints au dossier.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "pieces_jointes": [
    {
      "reference_piece": "PIECE-20260625-001",
      "nom": "mandat.eml",
      "chemin": "pieces/mandat.eml",
      "categorie": "COURRIER",
      "type": "EML",
      "mime_type": "message/rfc822",
      "hash": "sha256:abcdef"
    }
  ]
}

Propriétés de chaque élément · 8

reference_piecestringrequis#
dossiers[].pieces_jointes[].reference_piece

Valeur de type string, à renseigner dans dossiers[].pieces_jointes[].reference_piece.

Requis lorsque l’objet parent est présent.

minLength
1
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "reference_piece": "PIECE-20260625-001"
}
nomstringrequis#
dossiers[].pieces_jointes[].nom

Valeur de type string, à renseigner dans dossiers[].pieces_jointes[].nom.

Requis lorsque l’objet parent est présent.

minLength
1
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "nom": "mandat.eml"
}
cheminstringrequis#
dossiers[].pieces_jointes[].chemin

Valeur de type string, à renseigner dans dossiers[].pieces_jointes[].chemin.

Requis lorsque l’objet parent est présent.

pattern
^(?!/)(?!.*\.\./).+
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "chemin": "pieces/mandat.eml"
}
date_piecestring#
dossiers[].pieces_jointes[].date_piece

Valeur de type string, à renseigner dans dossiers[].pieces_jointes[].date_piece.

format
date
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "date_piece": "2024-10-02"
}
categoriestring | null#
dossiers[].pieces_jointes[].categorie

Valeur de type string | null, à renseigner dans dossiers[].pieces_jointes[].categorie.

Explications du référentiel

pieces_jointes[].categorie

  • ACTE
  • DECISION_JUDICIAIRE
  • TITRE
  • JUSTIFICATIF_CREANCE
  • MANDAT
  • KBIS
  • BAIL
  • FACTURE
  • DECOMPTE
  • COURRIER
  • IDENTITE
  • ATTESTATION
  • ANNEXE_NON_SIGNIFIEE
  • PIECE_GENERALE
  • AUTRE
Valeurs autorisées
"ACTE""DECISION_JUDICIAIRE""TITRE""JUSTIFICATIF_CREANCE""MANDAT""KBIS""BAIL""FACTURE""DECOMPTE""COURRIER""IDENTITE""ATTESTATION""ANNEXE_NON_SIGNIFIEE""PIECE_GENERALE""AUTRE"null
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "categorie": "COURRIER"
}
typestringrequis#
dossiers[].pieces_jointes[].type

Valeur de type string, à renseigner dans dossiers[].pieces_jointes[].type.

Requis lorsque l’objet parent est présent.

Explications du référentiel

type_piece

  • IMAGE
  • PDF
  • WORD
  • EXCEL
  • EML Règles:
  • IMAGE couvre les formats image usuels transmis comme pièces, par exemple JPEG, PNG ou TIFF selon le projet.
  • PDF couvre les documents PDF.
  • WORD couvre les documents bureautiques Word, notamment DOC et DOCX.
  • EXCEL couvre les tableurs, notamment XLS et XLSX.
  • EML couvre les emails complets au format message/rfc822.
Valeurs autorisées
"IMAGE""PDF""WORD""EXCEL""EML"
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "type": "EML"
}
mime_typestring | null#
dossiers[].pieces_jointes[].mime_type

Valeur de type string | null, à renseigner dans dossiers[].pieces_jointes[].mime_type.

Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "mime_type": "message/rfc822"
}
hashstring#
dossiers[].pieces_jointes[].hash

Valeur de type string, à renseigner dans dossiers[].pieces_jointes[].hash.

pattern
^sha256:[a-fA-F0-9]+$
Exemple JSON · extrait documenté

Fragment illustratif ; ce n’est pas un lot complet. Pour un tableau, seul le premier élément est montré.

{
  "hash": "sha256:abcdef"
}
extensions_prestataireobject#
extensions_prestataire

Traces techniques optionnelles propres au prestataire.

additionalProperties
{"type":"object","additionalProperties":true}
Conventions complémentaires · traitement et rejets

Ces précisions documentaires ne constituent pas des clés supplémentaires de lot.json.

Traitement et rejets

statut_traitement_lot

  • accepte
  • partiellement_accepte
  • rejete

niveau_erreur

  • warning
  • error

code_erreur_rejet

  • zip_invalide
  • json_absent
  • json_invalide
  • schema_invalide
  • piece_introuvable
  • piece_invalide
  • chemin_interdit
  • reference_manquante
  • reference_inconnue
  • doublon_reference
  • valeur_enum_invalide
  • date_invalide
  • montant_invalide
  • evenement_non_supporte
  • erreur_metier
  • erreur_technique

situation_maritale

  • celibataire
  • marie
  • pacse
  • concubinage
  • divorce
  • separe
  • veuf
  • inconnue

type_immatriculation

  • SIRET
  • SIREN
  • RCS
  • RNA
  • TVA_INTRACOMMUNAUTAIRE
  • AUTRE