> ## 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.

# Créer ou mettre à jour une acquisition

> Crée ou met à jour une acquisition (fiche acquéreur) avec déduplication automatique du contact et de la transaction, et possibilité de créer un match avec une vente existante.

Déduplication : recherche d'un contact par téléphone/email (mise à jour ou création), puis recherche d'une acquisition de ce contact, quelle que soit son étape. Allocation et routing d'étape automatiques (forçables via `settings`) ; sur une acquisition retrouvée, l'étape ne change pas.

`settings.matching` (acquisition uniquement) crée un match avec une vente existante via `ref` (référence d'annonce) OU `saleId` — mutuellement exclusifs. Le match est initialisé à l'étape `MRQT` ; il n'est pas recréé s'il existe déjà — mais un match existant situé avant `MRQT` (`MSND` ou une étape « sans suite » `_NF`) est **remonté** à `MRQT`, ce qui rouvre une mise en relation close. Si la vente n'est pas trouvée, l'acquisition est quand même créée. `note` crée une activité « note ». `parsingCustomId` est enregistré et renvoyé en lecture ; il ne sert pas à la déduplication.

`settings.allocation.agencyGroupId` doit être le groupe de votre clé, et `agencyId`, s'il est fourni, une agence de GET Agencies. Sinon `400`, aucun lead créé (`LeadGenerationExternalAcquisition : Agency group is not in the authorized scope of this LinkedAPI`, `LeadGenerationExternalAcquisition : Agency is not in the authorized scope of this LinkedAPI`). Sans `agencyId`, l'attribution est automatique, parmi les agences du groupe. Les identifiants de l'exemple sont ceux de l'exemple de GET Agencies : remplacez-les par ceux que GET Agencies renvoie pour votre clé, et `userId` par un collaborateur de cette agence (GET Users liste ceux du groupe).



## OpenAPI

````yaml /openapi.yaml post /external-integration/acquisition
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/acquisition:
    post:
      tags:
        - Lead generation
      summary: Créer ou mettre à jour une acquisition
      description: >-
        Crée ou met à jour une acquisition (fiche acquéreur) avec déduplication
        automatique du contact et de la transaction, et possibilité de créer un
        match avec une vente existante.


        Déduplication : recherche d'un contact par téléphone/email (mise à jour
        ou création), puis recherche d'une acquisition de ce contact, quelle que
        soit son étape. Allocation et routing d'étape automatiques (forçables
        via `settings`) ; sur une acquisition retrouvée, l'étape ne change pas.


        `settings.matching` (acquisition uniquement) crée un match avec une
        vente existante via `ref` (référence d'annonce) OU `saleId` —
        mutuellement exclusifs. Le match est initialisé à l'étape `MRQT` ; il
        n'est pas recréé s'il existe déjà — mais un match existant situé avant
        `MRQT` (`MSND` ou une étape « sans suite » `_NF`) est **remonté** à
        `MRQT`, ce qui rouvre une mise en relation close. Si la vente n'est pas
        trouvée, l'acquisition est quand même créée. `note` crée une activité «
        note ». `parsingCustomId` est enregistré et renvoyé en lecture ; il ne
        sert pas à la déduplication.


        `settings.allocation.agencyGroupId` doit être le groupe de votre clé, et
        `agencyId`, s'il est fourni, une agence de GET Agencies. Sinon `400`,
        aucun lead créé (`LeadGenerationExternalAcquisition : Agency group is
        not in the authorized scope of this LinkedAPI`,
        `LeadGenerationExternalAcquisition : Agency is not in the authorized
        scope of this LinkedAPI`). Sans `agencyId`, l'attribution est
        automatique, parmi les agences du groupe. Les identifiants de l'exemple
        sont ceux de l'exemple de GET Agencies : remplacez-les par ceux que GET
        Agencies renvoie pour votre clé, et `userId` par un collaborateur de
        cette agence (GET Users liste ceux du groupe).
      operationId: postAcquisition
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostAcquisitionBody'
            example:
              settings:
                allocation:
                  agencyGroupId: 66cc8a8e75c9fac35c6ecd73
                  agencyId: 66cc91d475c9fac35c86ed80
                  userId: 66cc91f05f84c9b212d9ec24
                  disableDeduplication: false
                step: AQUL
                matching:
                  ref: REF-2025-001
              note:
                title: Demande sur annonce
                content: Client intéressé par l'annonce REF-2025-001
              transactionType: acquisition
              contact:
                firstName: Jean
                lastName: Dupont
                email: jean.dupont@email.com
                phone: '+33612345678'
              transaction:
                project: buyer
                activityLevel: hot
                propertiesTypes:
                  - apartment
                  - house
                priceRange:
                  low: 200000
                  high: 350000
                sizeRange:
                  low: 60
                  high: 120
                bedroomRange:
                  low: 2
                  high: 4
                elevator: preferable
                outdoor: essential
                parking: unnecessary
                mortgageType: standard
                purpose: primaryResidence
                areas:
                  - type: postalCode
                    postalCode: '75001'
                    name: Paris
                    countryCode: FR
                parsingCustomId: EXT-ACQ-2025-001
      responses:
        '200':
          description: >-
            Acquisition créée ou mise à jour. Peut aussi retourner `{ success:
            true, message: "BILLING_STANDBY" }` lorsque le compte est en standby
            de facturation.
          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:
                $ref: '#/components/schemas/PostTransactionResponse'
              examples:
                cree:
                  summary: Acquisition créée
                  value:
                    success: true
                    avestId: A-2025-001
                    user:
                      id: 66cc91f05f84c9b212d9ec24
                      firstName: Marie
                      lastName: Martin
                      jobTitle: Agent immobilier
                      email: marie.martin@agence.com
                      phone: '+33601020304'
                    contact:
                      id: 618a35a36d932054e195ca0a
                      firstName: Jean
                      lastName: Dupont
                    transaction:
                      id: 619b46b47e043165f206db1c
                      customId: A-2025-001
                      step: AQUL
                      project: buyer
                billingStandby:
                  summary: Standby de facturation
                  value:
                    success: true
                    message: BILLING_STANDBY
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  schemas:
    PostAcquisitionBody:
      type: object
      required:
        - settings
        - transactionType
        - transaction
      properties:
        settings:
          allOf:
            - $ref: '#/components/schemas/SettingsBase'
            - type: object
              properties:
                matching:
                  $ref: '#/components/schemas/Matching'
        note:
          $ref: '#/components/schemas/Note'
        transactionType:
          type: string
          const: acquisition
        contact:
          $ref: '#/components/schemas/ContactInput'
        transaction:
          $ref: '#/components/schemas/TransactionAcquisition'
    PostTransactionResponse:
      type: object
      properties:
        success:
          type: boolean
          const: true
        avestId:
          type: string
          description: Identifiant métier de la transaction créée / mise à jour.
        user:
          $ref: '#/components/schemas/PostUserSummary'
        contact:
          type: object
          properties:
            id:
              $ref: '#/components/schemas/ObjectId'
            firstName:
              type: string
            lastName:
              type: string
        transaction:
          type: object
          properties:
            id:
              $ref: '#/components/schemas/ObjectId'
            customId:
              type: string
            step:
              type: string
            project:
              type: string
            property:
              type: object
              description: >-
                Pour une vente ou une location, porte l'adresse reconnue et
                enregistrée, au format de GET Sale et GET Rental : comparez-la à
                l'`address` envoyée pour repérer une adresse mal reconnue. Elle
                n'est pas renvoyée si la fiche est attribuée à une agence que
                votre clé ne couvre pas, comme sur GET.
              properties:
                addressData:
                  $ref: '#/components/schemas/AddressData'
                addresses:
                  type: array
                  items:
                    $ref: '#/components/schemas/AddressData'
        message:
          type: string
          description: >-
            Présent lorsque le compte est en standby de facturation
            (`BILLING_STANDBY`).
    SettingsBase:
      type: object
      required:
        - allocation
      properties:
        allocation:
          $ref: '#/components/schemas/Allocation'
        step:
          type: string
          description: Force l'étape (sinon calculée automatiquement).
        disableAlerts:
          type: boolean
          default: false
          description: >-
            Si `true`, l'email d'alerte nouveau lead n'est pas envoyé. Seul cet
            email est coupé : la notification Slack de l'agence part quand même.
    Matching:
      type: object
      description: >-
        Crée un match avec une vente existante. `ref` et `saleId` sont
        mutuellement exclusifs.
      properties:
        ref:
          type: string
          description: Référence de l'annonce à matcher.
        saleId:
          allOf:
            - $ref: '#/components/schemas/ObjectId'
          description: ID de la vente à matcher.
    Note:
      type: object
      required:
        - title
      properties:
        title:
          type: string
        content:
          type: string
    ContactInput:
      type: object
      properties:
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
          format: email
        isEmailVerified:
          type: boolean
        phone:
          type: string
          description: Téléphone au format international.
        isPhoneVerified:
          type: boolean
    TransactionAcquisition:
      type: object
      properties:
        project:
          type: string
          enum:
            - buyer
            - buyerOwner
            - buyerSeller
          description: Requis si `settings.step` n'est pas fourni.
        parsingCustomId:
          type: string
        activityLevel:
          type: string
          enum:
            - hot
            - warm
            - cold
            - mandate
        purpose:
          type: string
          enum:
            - primaryResidence
            - secondaryResidence
            - businessPremise
            - investment
            - propertyTrade
        propertiesTypes:
          type: array
          items:
            type: string
            enum:
              - house
              - apartment
              - building
              - field
              - parking
              - cellar
              - office
              - shop
              - industry
              - business_assets
              - lease_transfer
        areas:
          type: array
          items:
            $ref: '#/components/schemas/AreaInput'
        priceRange:
          $ref: '#/components/schemas/Range'
        sizeRange:
          $ref: '#/components/schemas/Range'
        fieldRange:
          $ref: '#/components/schemas/Range'
        roomRange:
          $ref: '#/components/schemas/Range'
        bedroomRange:
          $ref: '#/components/schemas/Range'
        floorRange:
          $ref: '#/components/schemas/Range'
        elevator:
          $ref: '#/components/schemas/NecessityCriteria'
        outdoor:
          $ref: '#/components/schemas/NecessityCriteria'
        parking:
          $ref: '#/components/schemas/NecessityCriteria'
        pool:
          $ref: '#/components/schemas/NecessityCriteria'
        bikeShed:
          type: boolean
        mortgageType:
          type: string
          enum:
            - relay
            - standard
            - none
        mortgage:
          type: boolean
        mandate:
          $ref: '#/components/schemas/AcquisitionMandateInput'
    PostUserSummary:
      type: object
      description: Utilisateur alloué à la transaction.
      properties:
        id:
          $ref: '#/components/schemas/ObjectId'
        firstName:
          type: string
        lastName:
          type: string
        jobTitle:
          type: string
        email:
          type: string
        phone:
          type: string
    ObjectId:
      type: string
      description: Identifiant Mongo (24 caractères hexadécimaux).
      pattern: ^[a-fA-F0-9]{24}$
      example: 618a35a36d932054e195ca0a
    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
    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.
    Allocation:
      type: object
      required:
        - agencyGroupId
      properties:
        agencyGroupId:
          allOf:
            - $ref: '#/components/schemas/ObjectId'
          description: >-
            Groupe d'agences de votre clé (`agencyGroup.id` de GET Agencies). Un
            autre groupe est refusé (`400`).
        agencyId:
          allOf:
            - $ref: '#/components/schemas/ObjectId'
          description: >-
            Agence à qui attribuer le lead (force l'allocation). Doit être une
            agence de GET Agencies : une agence que votre clé ne couvre pas, ou
            désactivée, est refusée (`400`). Sans `agencyId`, l'attribution est
            automatique, parmi les agences du groupe.
        userId:
          allOf:
            - $ref: '#/components/schemas/ObjectId'
          description: ID de l'utilisateur (force l'allocation, requiert `agencyId`).
        disableDeduplication:
          type: boolean
          default: false
          description: Désactive la déduplication de transaction.
    AreaInput:
      type: object
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - postalCode
            - inseeCode
            - departmentCode
            - geometry
        postalCode:
          type: string
          description: Requis si `type = postalCode`.
        inseeCode:
          type: string
          description: Requis si `type = inseeCode`.
        departmentCode:
          type: string
          description: Requis si `type = departmentCode`.
        name:
          type: string
        countryCode:
          type: string
          default: FR
          description: Code pays ISO.
        geometry:
          type: object
          description: Requis si `type = geometry`.
          properties:
            type:
              type: string
              enum:
                - Polygon
            coordinates:
              type: array
              items:
                type: array
                items:
                  type: array
                  items:
                    type: number
        center:
          type: object
          description: >-
            Centre d'une zone tracée en cercle, avec `type = geometry`. À
            transmettre avec le polygone du cercle dans `geometry`, jamais seul.
            Un `type` autre que `Point` est refusé (`400`).
          properties:
            type:
              type: string
              enum:
                - Point
            coordinates:
              type: array
              minItems: 2
              maxItems: 2
              items:
                type: number
              description: '[longitude, latitude]'
        radius:
          type: number
          exclusiveMinimum: 0
          description: Rayon du cercle, en km. Nul ou négatif, il est refusé (`400`).
    Range:
      type: object
      description: Fourchette de valeurs.
      properties:
        low:
          type: number
        high:
          type: number
    NecessityCriteria:
      type: string
      description: '`excluded` : critère éliminatoire, le bien ne doit pas en avoir.'
      enum:
        - unnecessary
        - preferable
        - essential
        - excluded
    AcquisitionMandateInput:
      type: object
      properties:
        signatureDate:
          type: string
        type:
          type: string
          enum:
            - exclusive
            - notExclusive
        commission:
          type: number
          description: Commission en €.
  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.