> ## Documentation Index
> Fetch the complete documentation index at: https://developers.avest.fr/llms.txt
> Use this file to discover all available pages before exploring further.

# Mettre à jour une vente ciblée par identifiant

> Met à jour une vente existante en la **ciblant par son identifiant**, ce qui supprime tout risque de doublon.

`POST /external-integration/sale` retrouve la vente par contact + adresse : si l'adresse envoyée ne correspond pas exactement à celle enregistrée, une seconde vente est créée. Utilisez cette route dès que vous connaissez déjà la vente — typiquement pour faire avancer son étape.

`saleId` accepte l'`id` (ObjectId) **ou** le `customId` de la vente, tous deux renvoyés en lecture. Si un `customId` correspond à plusieurs ventes de votre périmètre, la requête est refusée (`400`) plutôt que d'en modifier une au hasard : ciblez alors par `id`.

Seuls les champs listés dans `UpdateSaleBody` sont modifiables. `contacts`, `customId`, `parsingCustomId`, `commission` et `state` ne le sont pas.

Pour poser un rendez-vous d'estimation, utilisez `appointment` : il renseigne les dates officielles de la fiche **et** crée l'activité correspondante. Écrire `timeline` seul renseigne les dates sans créer d'activité.

En cas de modification concurrente : `409` avec le code `TRANSACTION_EDIT_CONFLICT`, rejouer la requête.



## OpenAPI

````yaml /openapi.yaml patch /external-integration/sale/{saleId}
openapi: 3.1.0
info:
  title: Avest External Integration API
  version: 1.0.0
  description: >-
    API d'intégration externe Avest. Permet de rechercher des contacts et des
    collaborateurs, de récupérer des transactions (ventes, acquisitions,
    locations) et de créer/mettre à jour des transactions avec déduplication
    automatique.


    Tous les endpoints requièrent un token LinkedAPI (scope
    `externalIntegration`) dont la clé doit avoir un `agencyGroup` configuré.
    Les données sont strictement limitées au périmètre autorisé du token :
    aucune fiche hors `agencyGroup` n'est jamais retournée.
servers:
  - url: https://api.avest.fr/v1
    description: API de production Avest
security:
  - linkedApiToken: []
tags:
  - name: Contacts
    description: Recherche et récupération de contacts.
  - name: Users
    description: Récupération des collaborateurs (annuaire).
  - name: Transactions
    description: Récupération et recherche de ventes, acquisitions et locations.
  - name: Lead generation
    description: Création / mise à jour de transactions (ventes, acquisitions, locations).
  - name: Matches
    description: Récupération et recherche de rapprochements (matches vente / acquisition).
  - name: Activities
    description: Récupération et création des activités liées à un document.
  - name: Ads
    description: Récupération et recherche d'annonces (listings publiques).
  - name: Key
    description: Type de la clé API et méthodes qu'elle autorise.
  - name: Agencies
    description: Découverte des agences accessibles par la clé.
  - name: Shift planning
    description: >-
      Planning de permanence d'une agence, semaine par semaine. Écriture
      réservée aux clés autorisées en écriture.
paths:
  /external-integration/sale/{saleId}:
    patch:
      tags:
        - Transactions
      summary: Mettre à jour une vente ciblée par identifiant
      description: >-
        Met à jour une vente existante en la **ciblant par son identifiant**, ce
        qui supprime tout risque de doublon.


        `POST /external-integration/sale` retrouve la vente par contact +
        adresse : si l'adresse envoyée ne correspond pas exactement à celle
        enregistrée, une seconde vente est créée. Utilisez cette route dès que
        vous connaissez déjà la vente — typiquement pour faire avancer son
        étape.


        `saleId` accepte l'`id` (ObjectId) **ou** le `customId` de la vente,
        tous deux renvoyés en lecture. Si un `customId` correspond à plusieurs
        ventes de votre périmètre, la requête est refusée (`400`) plutôt que
        d'en modifier une au hasard : ciblez alors par `id`.


        Seuls les champs listés dans `UpdateSaleBody` sont modifiables.
        `contacts`, `customId`, `parsingCustomId`, `commission` et `state` ne le
        sont pas.


        Pour poser un rendez-vous d'estimation, utilisez `appointment` : il
        renseigne les dates officielles de la fiche **et** crée l'activité
        correspondante. Écrire `timeline` seul renseigne les dates sans créer
        d'activité.


        En cas de modification concurrente : `409` avec le code
        `TRANSACTION_EDIT_CONFLICT`, rejouer la requête.
      operationId: updateSale
      parameters:
        - name: saleId
          in: path
          required: true
          description: '`id` (ObjectId) ou `customId` de la vente.'
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSaleBody'
            examples:
              step:
                summary: Faire avancer l'étape
                value:
                  step: MND
              estimation:
                summary: Consigner une estimation terrain
                value:
                  fieldValue:
                    low: 285000
                    high: 310000
              appointment:
                summary: Poser le rendez-vous d'estimation et passer en RDV
                value:
                  step: RDV
                  appointment:
                    date: '2026-09-01T14:00:00.000Z'
                    endAt: '2026-09-01T15:00:00.000Z'
                    note: Rendez-vous pris depuis notre outil.
              timeline:
                summary: Renseigner les dates du compromis
                value:
                  timeline:
                    agreementDate: '2026-09-15T00:00:00.000Z'
                    mortgageDeadline: '2026-10-30T00:00:00.000Z'
                    closingDate: '2026-12-05T00:00:00.000Z'
      responses:
        '200':
          description: Vente mise à jour.
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimit-Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimit-Reset'
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  sale:
                    $ref: '#/components/schemas/SaleRead'
                  activity:
                    allOf:
                      - $ref: '#/components/schemas/Activity'
                    description: >-
                      Activité « Rendez-vous estimation » créée. Présente
                      uniquement si `appointment` était fourni.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  schemas:
    UpdateSaleBody:
      type: object
      description: >-
        Au moins un champ. `contacts`, `customId`, `parsingCustomId`,
        `commission` et `state` ne sont pas modifiables par cette route.
      properties:
        step:
          type: string
          description: >-
            Nouvelle étape de la vente. Le changement produit les mêmes effets
            que depuis l'interface (activité de changement d'étape,
            `stepUpdatedAt`, commission, séquences paramétrées par l'agence).
            Vers une étape de `QUL` à `DLV`, les activités à faire de la fiche
            sont closes (rendez-vous compris, visites et offres exceptées). Une
            vente sans responsable ne sort de `STK`, `TRN`, `PQUL`, `ARC`, `SLD`
            ou `TARC` qu'avec `owner` dans la même requête : sinon l'étape reste
            inchangée, avec un `200`. Passer en `STK` retire le responsable et
            supprime les activités non clôturées (visites et offres conservées).
          enum:
            - STK
            - TRN
            - ARC
            - PQUL
            - QUL
            - CNV
            - RDV
            - DLV
            - MND
            - TARC
            - OFR
            - AGT
            - MTG
            - SLD
        stepUpdateReason:
          type: string
          enum:
            - fakePhone
            - unreachable
            - spam
            - noFollowUp
            - lostMandate
            - marketedElsewhere
            - soldByOtherAgency
            - soldByOwner
            - saleWithdrawn
          description: >-
            Motif accompagnant le changement d'étape. Vers `ARC` : `fakePhone`,
            `unreachable`, `spam`, `noFollowUp` ou `lostMandate`. Vers `TARC` :
            `marketedElsewhere`, `soldByOtherAgency`, `soldByOwner`,
            `saleWithdrawn`, `lostMandate` ou `noFollowUp`. Sinon `400`
            (`Invalid stepUpdateReason for step ARC`). `fakePhone` marque aussi
            les téléphones du contact comme invalides.
        project:
          type: string
          description: Projet du vendeur (`S|S`, `S|L`, `S|O`, `APT`, ...).
        status:
          type: string
          description: Statut, dépendant de l'étape courante.
        fieldValue:
          $ref: '#/components/schemas/Range'
        onlineValue:
          $ref: '#/components/schemas/Range'
        timeline:
          allOf:
            - $ref: '#/components/schemas/SaleTimelineInput'
          description: >-
            Dates officielles du dossier. Ce sont les dates affichées sur la
            fiche : `estimationDate` est la date du rendez-vous d'estimation,
            pas la date d'une activité. Envoyer `null` sur une date l'efface.
        appointment:
          allOf:
            - $ref: '#/components/schemas/SaleAppointmentUpdate'
          description: >-
            Raccourci : renseigne le créneau d'estimation
            (`timeline.estimationDate` / `estimationStartAt` /
            `estimationEndAt`) **et** crée l'activité « Rendez-vous estimation
            ». Sur `POST /external-integration/sale`, le même champ crée
            l'activité sans renseigner les dates de la fiche. Envoyé avec
            `step`, le rendez-vous est créé après le changement d'étape et reste
            ouvert. L'activité créée est renvoyée dans la réponse.
        property:
          allOf:
            - $ref: '#/components/schemas/PropertyInput'
          description: >-
            Caractéristiques du bien. L'adresse ne s'écrit pas ici : utilisez le
            champ `address`.
        address:
          type: string
          description: >-
            Adresse en texte libre, géocodée comme à la création. Remplace
            l'adresse enregistrée sur le bien. Si Google ne situe que la ville,
            la vente est enregistrée sans numéro ni rue : contrôlez
            `property.addressData` dans la réponse.
        owner:
          allOf:
            - $ref: '#/components/schemas/ObjectId'
          description: >-
            Collaborateur responsable de la fiche. Doit appartenir aux agences
            de votre clé API, sinon la requête est refusée et rien n'est écrit.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/ObjectId'
          description: >-
            Liste **complète** des tags de la vente : les tags absents de la
            liste sont retirés. Chaque tag doit exister dans votre périmètre.
        mandate:
          $ref: '#/components/schemas/SaleMandateInput'
        offer:
          $ref: '#/components/schemas/SaleOfferInput'
    SaleRead:
      type: object
      description: >-
        Vente en lecture. `id`, `customId`, `agency`, `agencyGroup`, `step`,
        `createdAt`, `updatedAt`, `stepUpdatedAt`, `owner` et `mainContact` sont
        toujours présents (si la vente existe). Les autres champs sont absents
        s'ils ne sont pas renseignés.
      properties:
        id:
          $ref: '#/components/schemas/ObjectId'
        customId:
          type: string
        agency:
          $ref: '#/components/schemas/ObjectId'
        agencyGroup:
          $ref: '#/components/schemas/ObjectId'
        step:
          type: string
          description: Étape courante (`QUL`, `CNV`, `RDV`, `MND`, `ARC`, etc.).
        createdAt:
          type: string
          description: Date de création (ISO 8601).
        updatedAt:
          type: string
          description: >-
            Date de dernière modification (ISO 8601). Combiné à
            `sortField=updatedAt` sur `/search`, permet de ne resynchroniser que
            les ventes modifiées depuis votre dernier passage.
        stepUpdatedAt:
          type: string
          description: Date du dernier changement d'étape (ISO 8601).
        owner:
          $ref: '#/components/schemas/Owner'
        mainContact:
          oneOf:
            - $ref: '#/components/schemas/ObjectId'
            - type: 'null'
          description: ObjectId du vendeur principal. `null` si aucun contact lié.
        status:
          type: string
        state:
          type: string
        project:
          type: string
        parsingCustomId:
          type: string
        property:
          $ref: '#/components/schemas/PropertyRead'
        mandate:
          $ref: '#/components/schemas/SaleMandateRead'
        offer:
          type: object
          additionalProperties: true
        timeline:
          $ref: '#/components/schemas/Timeline'
        fieldValue:
          $ref: '#/components/schemas/Range'
        onlineValue:
          $ref: '#/components/schemas/Range'
        contacts:
          type: array
          description: >-
            Présent dans la réponse de recherche (`/search`). Le premier élément
            correspond au `mainContact`.
          items:
            $ref: '#/components/schemas/Contact'
    Activity:
      type: object
      description: >-
        Activité liée à un document Avest (note, tâche, appel, email, changement
        d'étape, etc.).
      properties:
        id:
          $ref: '#/components/schemas/ObjectId'
        type:
          type: string
          description: >-
            Type d'activité (`note`, `task`, `call`, `email`, `meeting`,
            `changeStep`, ...).
        startAt:
          type: string
          format: date-time
          nullable: true
        endAt:
          type: string
          format: date-time
          nullable: true
        deadline:
          type: string
          format: date-time
          nullable: true
        completionDate:
          type: string
          format: date-time
          nullable: true
        pinned:
          type: boolean
        owner:
          oneOf:
            - $ref: '#/components/schemas/ObjectId'
            - type: 'null'
          description: ObjectId de l'utilisateur auteur. `null` si non renseigné.
        linkedDocument:
          oneOf:
            - $ref: '#/components/schemas/ObjectId'
            - type: 'null'
          description: ObjectId du document lié. `null` si non renseigné.
        linkedModel:
          type: string
          description: Type du document lié.
        data:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            Données propres à l'activité. La forme dépend du `type` de
            l'activité. `null` si absent. Les chemins sensibles peuvent être
            masqués. Pour `changeStep` : `from` et `to` ; sur une vente,
            `isAutomatic: true` quand Avest a changé l'étape seul (séquence de
            relance, par exemple).
        file:
          oneOf:
            - $ref: '#/components/schemas/ActivityFile'
            - type: 'null'
        driveLinks:
          type: array
          items:
            type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Range:
      type: object
      description: Fourchette de valeurs.
      properties:
        low:
          type: number
        high:
          type: number
    SaleTimelineInput:
      type: object
      properties:
        estimationDate:
          type: string
        estimationStartAt:
          type: string
        estimationEndAt:
          type: string
        offerDate:
          type: string
        agreementDate:
          type: string
        mortgageDeadline:
          type: string
        closingDate:
          type: string
        mandateSignatureDate:
          type: string
        agreementExpirationDate:
          type: string
    SaleAppointmentUpdate:
      type: object
      required:
        - date
      properties:
        date:
          type: string
          description: >-
            Date ISO du rendez-vous d'estimation. Contrairement à la création,
            une date passée est acceptée : cette route sert aussi à rattraper un
            rendez-vous déjà tenu.
        startAt:
          type: string
          description: Heure de début (ISO 8601).
        endAt:
          type: string
          description: Heure de fin (ISO 8601).
        note:
          type: string
          description: Note reportée dans le contenu de l'activité créée.
    PropertyInput:
      type: object
      description: >-
        Bien immobilier (entrée). Tous les champs sont optionnels. Champs
        communs sale / rental.
      properties:
        mainType:
          type: string
          enum:
            - house
            - apartment
            - building
            - field
            - parking
            - cellar
            - office
            - shop
            - industry
            - business_assets
            - lease_transfer
        developmentType:
          type: string
          enum:
            - old
            - new
        generalCondition:
          type: string
          enum:
            - toRenovate
            - standard
            - renovated
        size:
          type: number
        carrezSurface:
          type: number
        livingSurface:
          type: number
        usefulSurface:
          type: number
        floorSurface:
          type: number
        landSurface:
          type: number
        fieldSurface:
          type: number
        isSemiDetached:
          type: boolean
        lotsNumbers:
          type: string
        buildingYear:
          type: integer
        renovationYear:
          type: integer
        floor:
          type: integer
        totalFloors:
          type: integer
        lastFloor:
          type: integer
        isConstructible:
          type: boolean
        isServiced:
          type: boolean
        rooms:
          type: integer
        bedrooms:
          type: integer
        bathrooms:
          type: integer
        showerRooms:
          type: integer
        toilets:
          type: integer
        isToiletIndependent:
          type: boolean
        kitchenType:
          type: string
          enum:
            - open
            - independent
        isKitchenEquipped:
          type: boolean
        balconyAmount:
          type: integer
        balconySurface:
          type: number
        loggiaAmount:
          type: integer
          minimum: 0
          description: Nombre de loggias.
        loggiaSurface:
          type: number
          minimum: 0
          description: Surface des loggias, en m².
        terraceAmount:
          type: integer
        terraceSurface:
          type: number
        gardenAmount:
          type: integer
        gardenSurface:
          type: number
        cellarAmount:
          type: integer
        cellarSurface:
          type: number
        atticAmount:
          type: integer
        atticSurface:
          type: number
        parkingType:
          type: string
          enum:
            - outdoor
            - covered
            - garage
        parkingAmount:
          type: integer
        parkingSurface:
          type: number
        hasDisabledAccess:
          type: boolean
        hasElevator:
          type: boolean
        hasPool:
          type: boolean
        hasOpticalFiber:
          type: boolean
        hasFireplace:
          type: boolean
        hasStove:
          type: boolean
        hasArmoredDoor:
          type: boolean
        hasVMC:
          type: boolean
        propertyTax:
          type: number
        propertyTaxResponsibility:
          type: string
          enum:
            - owner
            - tenant
          description: >-
            Taxe foncière à la charge du bailleur (`owner`) ou du preneur
            (`tenant`). Bien professionnel.
        vatRegime:
          type: string
          enum:
            - subject
            - exempt
          description: Bien professionnel soumis (`subject`) ou non (`exempt`) à la TVA.
        isCollectiveOwnership:
          type: boolean
        collectiveMonthlyCost:
          type: number
        numberOfLots:
          type: integer
        isProcedure:
          type: boolean
        hasBuildingManager:
          type: boolean
        managedResidenceType:
          type: string
        heatingType:
          type: string
          enum:
            - individual
            - community
        heatingEnergyType:
          type: string
          enum:
            - electric
            - gas
            - fuel
            - heat_pump
            - wood
            - pellets
            - air_conditioning
            - district_heating
            - solar
            - geothermal
            - other
        waterDistributionType:
          type: string
          enum:
            - collective
            - individual_electric
            - individual_gas
            - individual_fuel
            - individual_solar
            - individual_heat_pump
            - individual_wood
            - individual_other
        isAirConditioning:
          type: boolean
        glazingType:
          type: string
          enum:
            - simple
            - double
            - triple
        DPENumber:
          type: string
        DPEEnergyValue:
          type: number
        DPEEnergyTag:
          $ref: '#/components/schemas/DPETag'
        DPEGESValue:
          type: number
        DPEGESTag:
          $ref: '#/components/schemas/DPETag'
        DPEDate:
          type: string
        DPEDate3Years:
          type: array
          items:
            type: integer
        minimumEnergyCost:
          type: number
        maximumEnergyCost:
          type: number
        energyCostDate:
          type: string
        hasBeautifulView:
          type: boolean
        availabilityDate:
          type: string
        hasRoofTop:
          type: boolean
        isDuplex:
          type: boolean
        occupancyStatus:
          type: string
          enum:
            - free
            - rented
        sanitationType:
          type: string
          enum:
            - mainsDrainage
            - septicTankCompliant
            - septicTankNonCompliant
        isPoolBuildable:
          type: boolean
        roomDetails:
          type: array
          items:
            type: object
            additionalProperties: true
      additionalProperties: true
    ObjectId:
      type: string
      description: Identifiant Mongo (24 caractères hexadécimaux).
      pattern: ^[a-fA-F0-9]{24}$
      example: 618a35a36d932054e195ca0a
    SaleMandateInput:
      type: object
      description: >-
        Montants en euros. `sellPrice` est le net vendeur. Le prix affiché
        honoraires inclus (`price`) est calculé : net vendeur + honoraires. Pour
        saisir les honoraires en pourcentage, envoyez `commissionType:
        percentage` et `commissionPercentage` : le montant des honoraires est
        alors calculé.
      properties:
        sellPrice:
          type: number
          description: >-
            Net vendeur, en euros. N'envoyez pas le prix honoraires inclus :
            `price` est calculé et n'est pas modifiable.
        agencyCommission:
          type: number
          description: >-
            Montant des honoraires, en euros (`12500` pour 12 500 €). En mode
            `percentage`, il est recalculé à partir de `commissionPercentage`.
        commissionType:
          type: string
          enum:
            - value
            - percentage
          description: >-
            `value` : vous envoyez le montant (`agencyCommission`). `percentage`
            : vous envoyez le pourcentage (`commissionPercentage`). Sans
            `commissionType`, `agencyCommission` est lu comme un montant.
        commissionPercentage:
          type: number
          minimum: 0
          exclusiveMaximum: 100
          description: >-
            Pourcentage d'honoraires, lu quand `commissionType` vaut
            `percentage`. Sa base dépend de `feeResponsibility` : à charge
            vendeur, le prix honoraires inclus ; à charge acquéreur, le net
            vendeur. Sur PATCH Sale, hors du mode `value`, une valeur hors de
            cette plage est refusée (`400`), sauf à renvoyer la valeur déjà
            enregistrée. En mode `value`, elle est ignorée : Avest la calcule
            depuis les montants.
        type:
          type: string
          enum:
            - exclusive
            - semiExclusive
            - notExclusive
        expirationDate:
          type: string
        mandateDuration:
          type: integer
        maxMandateDuration:
          type: integer
        referenceNumber:
          type: string
        feeResponsibility:
          type: string
          enum:
            - seller
            - buyer
            - both
        sellerAgencyCommission:
          type: number
          minimum: 0
          description: >-
            Part vendeur des honoraires, en charge `both` seulement. Négative,
            non numérique ou supérieure à `agencyCommission` : `400`.
        sellerAgencyCommissionPercentage:
          type: number
          minimum: 0
          exclusiveMaximum: 100
          description: >-
            Part vendeur en %, lue en mode `percentage`, en charge `both`
            seulement.
    SaleOfferInput:
      type: object
      description: >-
        Mêmes règles que le mandat : montants en euros, `sellPrice` net vendeur,
        honoraires en pourcentage avec `commissionType: percentage` (montants
        arrondis à l'euro, pourcentage inférieur à 100). L'offre n'est
        enregistrée que sur une vente à `MND` ou au-delà ; un changement d'étape
        vers une autre étape que `OFR`, `AGT`, `MTG` ou `SLD` l'efface.
      properties:
        sellPrice:
          type: number
          description: Net vendeur de l'offre, en euros.
        agencyCommission:
          type: number
          description: >-
            Montant des honoraires, en euros. En mode `percentage`, il est
            recalculé à partir de `commissionPercentage`.
        commissionType:
          type: string
          enum:
            - value
            - percentage
          description: >-
            `value` : vous envoyez le montant. `percentage` : vous envoyez le
            pourcentage (`commissionPercentage`).
        commissionPercentage:
          type: number
          minimum: 0
          exclusiveMaximum: 100
          description: >-
            Pourcentage d'honoraires, lu quand `commissionType` vaut
            `percentage`. Montants arrondis à l'euro.
        feeResponsibility:
          type: string
          enum:
            - seller
            - buyer
            - both
        sellerAgencyCommission:
          type: number
          minimum: 0
          description: >-
            Part vendeur des honoraires, en charge `both` seulement. Négative,
            non numérique ou supérieure à `agencyCommission` : `400`.
        sellerAgencyCommissionPercentage:
          type: number
          minimum: 0
          exclusiveMaximum: 100
          description: >-
            Part vendeur en %, lue en mode `percentage`, en charge `both`
            seulement.
        financing:
          type: string
          enum:
            - loan
            - cash
    Owner:
      type: object
      nullable: true
      description: Utilisateur Avest responsable du dossier. `null` si non attribué.
      properties:
        id:
          $ref: '#/components/schemas/ObjectId'
        firstName:
          type: string
        lastName:
          type: string
        picture:
          type: string
          description: URL de la photo (optionnelle).
    PropertyRead:
      type: object
      description: >-
        Bien immobilier tel que retourné en lecture. Seuls les champs renseignés
        sont présents ; cette liste n'est pas exhaustive.
      properties:
        mainType:
          type: string
          description: 'Ex: `apartment`, `house`, `field`, `building`, `parking`, etc.'
        developmentType:
          type: string
          enum:
            - old
            - new
        size:
          type: number
        floor:
          type: integer
        lastFloor:
          type: integer
        lotsNumbers:
          type: string
        rooms:
          type: integer
        bedrooms:
          type: integer
        bathrooms:
          type: integer
        toilets:
          type: integer
        kitchenType:
          type: string
        isCollectiveOwnership:
          type: boolean
        collectiveMonthlyCost:
          type: number
        numberOfLots:
          type: integer
        heatingType:
          type: string
        heatingEnergyType:
          type: string
        DPENumber:
          type: string
        DPEEnergyValue:
          type: number
        DPEEnergyTag:
          $ref: '#/components/schemas/DPETag'
        DPEGESValue:
          type: number
        DPEGESTag:
          $ref: '#/components/schemas/DPETag'
        DPEDate:
          type: string
        availabilityDate:
          type: string
        propertyTaxResponsibility:
          type: string
          enum:
            - owner
            - tenant
          description: >-
            Taxe foncière à la charge du bailleur (`owner`) ou du preneur
            (`tenant`). Bien professionnel.
        vatRegime:
          type: string
          enum:
            - subject
            - exempt
          description: Bien professionnel soumis (`subject`) ou non (`exempt`) à la TVA.
        addressData:
          $ref: '#/components/schemas/AddressData'
      additionalProperties: true
    SaleMandateRead:
      type: object
      description: >-
        Mandat de vente, renseigné à partir de l'étape `MND`. Avant, l'objet
        peut être présent avec seulement `mandateHistory`.
      properties:
        price:
          type: number
          description: Prix affiché honoraires inclus (HAI), calculé automatiquement.
        sellPrice:
          type: number
          description: Net vendeur.
        agencyCommission:
          type: number
          description: Montant des honoraires.
        feeResponsibility:
          type: string
          enum:
            - seller
            - buyer
            - both
        commissionPercentage:
          type: number
        commissionType:
          type: string
          enum:
            - value
            - percentage
        sellerAgencyCommission:
          type: number
          description: >-
            Part vendeur des honoraires, renseignée seulement en charge `both`.
            La part acquéreur vaut `agencyCommission` moins cette part.
        sellerAgencyCommissionPercentage:
          type: number
          description: >-
            Part vendeur en %, sur la même base que `commissionPercentage`,
            renseignée seulement en charge `both`.
        type:
          type: string
          enum:
            - exclusive
            - semiExclusive
            - notExclusive
        referenceNumber:
          type: string
        mandateDuration:
          type: integer
        maxMandateDuration:
          type: integer
        expirationDate:
          type: string
        mandateHistory:
          type: array
          description: >-
            Historique des modifications du net vendeur, des honoraires et du
            type de mandat. Vide si le mandat n'a jamais été modifié.
          items:
            type: object
            additionalProperties: true
            properties:
              date:
                type: string
                description: Date de la modification (ISO 8601).
              changes:
                type: array
                items:
                  type: object
                  additionalProperties: true
                  properties:
                    field:
                      type: string
                    from: {}
                    to: {}
    Timeline:
      type: object
      description: Dates clés du dossier (uniquement les dates renseignées).
      properties:
        mandateSignatureDate:
          type: string
        agreementDate:
          type: string
        agreementExpirationDate:
          type: string
        offerDate:
          type: string
        mortgageDeadline:
          type: string
        closingDate:
          type: string
        estimationDate:
          type: string
        estimationStartAt:
          type: string
        estimationEndAt:
          type: string
    Contact:
      type: object
      description: >-
        Contact. `firstName` / `lastName` si `isIndividual: true` ;
        `commercialName` / `corporateName` si entreprise (`isIndividual:
        false`).
      properties:
        id:
          $ref: '#/components/schemas/ObjectId'
        title:
          type: string
          enum:
            - mr
            - mme
        firstName:
          type: string
        lastName:
          type: string
        commercialName:
          type: string
        corporateName:
          type: string
        isIndividual:
          type: boolean
        contactDetails:
          type: array
          items:
            $ref: '#/components/schemas/ContactDetail'
    ActivityFile:
      type: object
      description: Fichier attaché à une activité.
      properties:
        name:
          type: string
        mimetype:
          type: string
        size:
          type: integer
        url:
          oneOf:
            - type: string
            - type: 'null'
          description: >-
            URL S3 signée temporaire (privée), `null` si le lien n'a pas pu être
            généré.
    ErrorResponse:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          const: false
        errorCode:
          type: string
          description: >-
            Code stable, présent sur certaines erreurs seulement (par exemple
            `VISIT_DATE_REQUIRED`, `CONTACT_DELETED`). À préférer à `message`
            pour reconnaître une erreur.
        message:
          type: string
    RateLimitErrorResponse:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          const: false
        message:
          type: string
          example: Rate limit exceeded
        retryAfter:
          type: integer
          description: Secondes avant de pouvoir réessayer.
    DPETag:
      type: string
      enum:
        - A
        - B
        - C
        - D
        - E
        - F
        - G
    AddressData:
      type: object
      description: Adresse splittée.
      properties:
        streetNumber:
          type: string
        route:
          type: string
        city:
          type: string
        postalCode:
          type: string
        country:
          type: string
        countryCode:
          type: string
          description: Code pays ISO 3166-1 alpha-2.
        formattedAddress:
          type: string
        department:
          type: string
        region:
          type: string
    ContactDetail:
      type: object
      properties:
        type:
          type: string
          enum:
            - email
            - phone
        data:
          type: string
      required:
        - type
        - data
  headers:
    RateLimit-Limit:
      description: Nombre de requêtes autorisées dans la fenêtre courante.
      schema:
        type: integer
    RateLimit-Remaining:
      description: Requêtes restantes dans la fenêtre courante.
      schema:
        type: integer
    RateLimit-Reset:
      description: Secondes avant la réinitialisation de la fenêtre.
      schema:
        type: integer
    Retry-After:
      description: Secondes à attendre avant de réessayer (présent sur les réponses `429`).
      schema:
        type: integer
  responses:
    BadRequest:
      description: >-
        Requête invalide. Le champ `message` précise la cause (paramètre
        manquant, invalide, mutuellement exclusif, clé de query inconnue,
        `LinkedAPI agencyGroup is required`, etc.).


        Les exemples ci-dessous sont **illustratifs et non exhaustifs** : les
        messages réellement renvoyés dépendent de la route. En particulier, le
        rejet des clés de query inconnues n'est appliqué que par `/contact`,
        `/contacts`, `/user`, `/users` et `/{transaction}/search`.


        La plupart des messages de validation sont préfixés par le contexte qui
        les émet, sous la forme `"<Contexte> : <message>"`. **Ne faites jamais
        de correspondance exacte sur `message`** : basez-vous sur le code HTTP
        et traitez `message` comme du texte destiné au diagnostic.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            unParametreRequis:
              value:
                success: false
                message: One of phone, email, or search is required
            exclusif:
              value:
                success: false
                message: Provide exactly one of phone, email, or search
            queryInconnue:
              value:
                success: false
                message: 'Unsupported query parameter: foo'
            telephoneInvalide:
              value:
                success: false
                message: Invalid phone number
            emailInvalide:
              value:
                success: false
                message: Invalid email
            searchTropCourt:
              value:
                success: false
                message: search must be at least 3 characters
            pageHorsLimites:
              value:
                success: false
                message: page must be <= 100
            agencyGroupManquant:
              value:
                success: false
                message: LinkedAPI agencyGroup is required
    Unauthorized:
      description: >-
        Token invalide. Renvoyé quand le header `Authorization: Bearer` est
        présent mais que sa valeur n'est pas un token exploitable (malformé,
        signature invalide, valeur vide) — `message` vaut alors `Invalid bearer
        token`.


        Un token bien formé mais qui ne correspond plus à aucune clé (révoquée
        ou régénérée) donne aussi un `401`, avec le message `Not authorized to
        access this resource`.


        L'absence du header, une clé en lecture seule et une IP non autorisée
        renvoient un `403`, pas un `401`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            tokenInvalide:
              value:
                success: false
                message: Invalid bearer token
            cleInconnue:
              value:
                success: false
                message: Not authorized to access this resource
    Forbidden:
      description: >-
        Accès refusé. Trois causes donnent **exactement la même réponse** (même
        code, même `message`) :


        1. le header `Authorization` est absent ;

        2. la clé est en **lecture seule** et la requête est un `POST` ou un
        `PATCH` (voir le guide Authentification) ;

        3. la clé est en mode **sécurisé** et l'IP d'appel, lue dans
        `X-Real-IP`, n'est pas celle autorisée.


        Sur les routes d'écriture, un document lié hors du périmètre de la clé
        renvoie également ce `403`.


        Un `403` sur vos seules écritures alors que vos lectures passent = clé
        en lecture seule.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: Not authorized to access this resource
    TooManyRequests:
      description: >-
        Limite de débit dépassée : limite de la route (par groupe d'agences et
        par chemin) ou limite globale (200 requêtes / 10 s par clé, `message`
        `Too many requests, please try again later`).
      headers:
        Retry-After:
          $ref: '#/components/headers/Retry-After'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimit-Limit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimit-Remaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitErrorResponse'
          example:
            success: false
            message: Rate limit exceeded
            retryAfter: 27
  securitySchemes:
    linkedApiToken:
      type: http
      scheme: bearer
      description: >-
        Token LinkedAPI avec scope `externalIntegration`. La clé doit avoir un
        `agencyGroup` configuré (sinon `400 LinkedAPI agencyGroup is required`).
        Fourni via l'en-tête `Authorization: Bearer {linkedAPI_token}`. Si la
        clé a `secure === true`, l'IP appelante doit être whitelistée (en-tête
        `X-Real-IP`), sinon `403 Not authorized to access this resource`.


        La clé porte aussi un **niveau d'accès** : en lecture seule, elle
        n'autorise que les `GET` ; un `POST` ou un `PATCH` renvoie alors `403
        Not authorized to access this resource`, soit la même réponse qu'une
        requête sans en-tête `Authorization`. Voir le guide Authentification.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.