Modèles de données

Référence des types et schémas retournés par l'API Registeo. Toutes les valeurs énumérées (régimes, statuts, modes de paiement, champs spécifiques) sont issues du référentiel central servi par GET /referentiel — cette page est générée à partir de cette même source.

ObjetMobilier

Représente un objet enregistré dans le livre de police. Structure retournée par GET /api/objets et POST /api/objets.

type Regime =
  | 'OBJETS_OCCASION'               // art. 321-7 Code pénal
  | 'METAUX_PRECIEUX'               // art. L834-6 Code de commerce (douanes)
  | 'METAUX_FERREUX_ET_NON_FERREUX' // art. L112-6 CMF + 1649 bis CGI

interface ObjetMobilier {
  id: string
  numero: number | string          // Numéro d'ordre (ex: 1, 42, "2026-1" en mode annuel)
  typeOperation: string             // "achat", "dépôt", "reprise", "échange"
  designation: string
  marques: string
  provenanceDeclaree: string
  quantite: number
  prixAchat: number | null          // null si les régimes de l'entrée n'imposent pas de prix
  modePaiement: string | null       // "virement", "chèque", "espèces", "carte", "autre"
  dateAchat: string                 // ISO 8601
  regimes: Regime[]                 // Régimes juridiques applicables à cette entrée
  // Vendeur — particulier
  vendeurType: string               // "particulier" ou "professionnel"
  vendeurNom: string
  vendeurDateNaissance: string | null
  vendeurLieuNaissance: string
  vendeurNationalite: string
  vendeurAdresse: string
  vendeurIdentiteType: string
  vendeurIdentiteNumero: string
  vendeurIdentiteDelivrance: string
  // Vendeur — professionnel
  vendeurRaisonSociale: string
  vendeurSiret: string
  vendeurId: string | null          // ID interne du vendeur (répertoire Registeo)
  // Documents et photos
  vendeurDocuments: Document[]      // Documents du vendeur professionnel (Kbis, etc.)
  photos: Document[]                // Photos de l'objet
  signatureKey: string | null       // Clé de la signature vendeur
  signatureUrl: string | null       // URL de téléchargement de la signature
  // Champs spécifiques à l'activité ou au régime
  champsActivite: Record<string, any>  // Voir les sections plus bas
  // Stock et mouvements
  statut: string                    // Voir la section Statuts
  dateVente: string | null          // ISO 8601
  prixVente: number | null
  sorties: any[]                    // Sorties directes (legacy)
  mouvements: Mouvement[]           // Mouvements de stock
  // Métadonnées
  auditCount: number                // Nombre d'entrées dans le journal d'audit
  createdAt: string                 // ISO 8601
  deletedAt: string | null          // ISO 8601 (null si actif, date si soft-deleted)
}

Régimes juridiques

Chaque objet porte un ou plusieurs régimes qui déterminent les règles applicables. Les régimes disponibles dépendent de l'activité configurée sur l'établissement.

Règles de validation appliquées par l'API :

• Si le champ regimes est absent à la création, l'objet reprend les regimesActifs du profil.
• Les valeurs qui ne figurent pas dans regimesActifs du profil sont filtrées silencieusement (elles ne sont pas enregistrées).
• prixAchat est obligatoire pour tout régime dont la colonne Prix obligatoire est cochée ci-dessus (le serveur renvoie 400 sinon).

Champs spécifiques par régime

Certains régimes attendent des champs supplémentaires sous champsActivite. Ils sont alimentés en plus des champs métier de l'activité.

Activités

Valeurs acceptées par le champ activite à la création d'un objet ou d'un profil. Chaque activité expose ses propres régimes par défaut, statuts et champs spécifiques.

Activité hors référentiel : utilisez le préfixe autre: suivi du libellé personnalisé — par exemple autre:Tapissier, autre:Maroquinier. Cela retombe sur la configuration autre du référentiel (régimes par défaut, pas de champs métier spécifiques).

Champs spécifiques par activité

En plus du tronc commun et des champs de régime, chaque activité peut imposer ses propres champs sous champsActivite. La liste exhaustive ci-dessous est computed à partir du référentiel.

Document

Représente un fichier (photo d'objet, document vendeur) associé à un objet. Retourné dans les champs photos et vendeurDocuments.

interface Document {
  key: string                       // Identifiant unique du fichier
  url: string                       // URL de téléchargement (signée, expiration 1h)
  addedAt: string                   // ISO 8601
}

Mouvement

Représente un mouvement de stock (vente, casse, don, restitution, etc.) sur un objet. Retourné dans le champ mouvements d'un objet et dans les réponses de POST /api/objets/{id}/mouvements et PUT /api/objets/{id}/mouvements/{id}/resolve.

interface Mouvement {
  id: string
  quantite: number
  statut: string                    // Voir la section Statuts
  date: string                      // ISO 8601
  prixVente: number | null          // Uniquement pour les ventes
  acheteurType: 'particulier' | 'professionnel' | null
  acheteurNom: string | null        // Nom (particulier) ou nom du représentant (pro)
  acheteurAdresse: string | null    // Adresse de l'acheteur
  acheteurRaisonSociale: string | null // Raison sociale si professionnel
  acheteurSiret: string | null      // SIRET si professionnel
  resolvedAt: string | null         // ISO 8601 — si non null, le mouvement est annulé
}

Statuts

Les statuts disponibles dépendent de l'activité configurée pour l'établissement. Le statut par défaut est en_stock (état implicite : aucun mouvement actif). Tout changement de statut passe par un mouvement de stock.

Les catégories déterminent le comportement :

Liste complète des statuts par activité :