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

# Retrieve deal splits

> Lire un lot d'objets de répartition de transactions par leur ID interne d'objet de la transaction associé.

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/legacy/v3/crm-deal-splits-v3.json POST /crm/objects/v3/deals/splits/batch/read
openapi: 3.0.1
info:
  title: CRM Deal Splits
  description: Basepom for all HubSpot Projects
  version: v3
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: ENTERPRISE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
  x-hubspot-api-use-case: >-
    When two sales reps work together to close a deal, add a split to the deal
    to reflect that the credit and commission are being shared.
  x-hubspot-related-documentation:
    - name: Deal splits overview
      url: https://developers.hubspot.com/docs/guides/api/crm/objects/deal-splits
  x-hubspot-introduction: >-
    Use the deal splits API to split existing deals between owners when credit
    and/or commission are shared between them. 
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Batch
paths:
  /crm/objects/v3/deals/splits/batch/read:
    post:
      tags:
        - Batch
      summary: >-
        Lire un lot d'objets de répartition de transactions par leur ID interne
        d'objet de la transaction associé.
      description: >-
        Lire un lot d'objets de répartition de transactions par leur ID interne
        d'objet de la transaction associé.
      operationId: >-
        post-/crm/objects/v3/deals/splits/batch/read_/crm/objects/v3/deals/splits/batch/read
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchInputPublicObjectId'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchResponseDealToDealSplits'
        '207':
          description: multiple statuses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchResponseDealToDealSplitsWithErrors'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - crm.dealsplits.read_write
components:
  schemas:
    BatchInputPublicObjectId:
      required:
        - inputs
      type: object
      properties:
        inputs:
          type: array
          description: Un tableau d'entrées de répartition de transactions
          items:
            $ref: '#/components/schemas/PublicObjectId'
    BatchResponseDealToDealSplits:
      required:
        - completedAt
        - results
        - startedAt
        - status
      type: object
      properties:
        completedAt:
          type: string
          description: >-
            L'horodatage indiquant la date et l'heure auxquelles l'opération par
            lots a été effectuée, au format date-heure.
          format: date-time
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Une carte des noms de liens vers les URI associés pour des
            ressources ou de la documentation supplémentaires.
        requestedAt:
          type: string
          description: >-
            L'horodatage indiquant la date et l'heure auxquelles l'opération par
            lots a été demandée, au format date-heure.
          format: date-time
        results:
          type: array
          description: >-
            Un tableau d'objets de répartition de transaction par transaction
            représentant les résultats de l'opération par lots.
          items:
            $ref: '#/components/schemas/DealToDealSplits'
        startedAt:
          type: string
          description: >-
            L'horodatage indiquant la date et l'heure auxquelles l'opération par
            lots a commencé, au format date-heure.
          format: date-time
        status:
          type: string
          description: "Statut actuel de l'opération par lots, avec les valeurs possibles suivantes\_: ANNULÉ, TERMINÉ, EN ATTENTE, EN COURS DE TRAITEMENT."
          enum:
            - CANCELED
            - COMPLETE
            - PENDING
            - PROCESSING
    BatchResponseDealToDealSplitsWithErrors:
      required:
        - completedAt
        - results
        - startedAt
        - status
      type: object
      properties:
        completedAt:
          type: string
          description: >-
            L'horodatage indiquant la date et l'heure auxquelles l'opération par
            lots a été effectuée, au format date-heure.
          format: date-time
        errors:
          type: array
          description: >-
            Tableau d'objets d'erreur détaillant les erreurs survenues pendant
            l'opération par lots.
          items:
            $ref: '#/components/schemas/StandardError'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Une carte des noms de liens vers les URI associés pour des
            ressources ou de la documentation supplémentaires.
        numErrors:
          type: integer
          description: Le nombre total d'erreurs rencontrées pendant l'opération par lot.
          format: int32
        requestedAt:
          type: string
          description: >-
            L'horodatage indiquant la date et l'heure auxquelles l'opération par
            lots a été demandée, au format date-heure.
          format: date-time
        results:
          type: array
          description: >-
            Un tableau d'objets de répartition de transaction par transaction
            représentant les résultats de l'opération par lots.
          items:
            $ref: '#/components/schemas/DealToDealSplits'
        startedAt:
          type: string
          description: >-
            L'horodatage indiquant la date et l'heure auxquelles l'opération par
            lots a commencé, au format date-heure.
          format: date-time
        status:
          type: string
          description: "Statut actuel de l'opération par lots, avec les valeurs possibles suivantes\_: ANNULÉ, TERMINÉ, EN ATTENTE, EN COURS DE TRAITEMENT."
          enum:
            - CANCELED
            - COMPLETE
            - PENDING
            - PROCESSING
    PublicObjectId:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          description: L'identifiant unique de l'objet public.
      description: Contient l'ID d'un objet public
    DealToDealSplits:
      required:
        - id
        - splits
      type: object
      properties:
        id:
          type: string
          description: >-
            L'identifiant unique de la transaction associée à la répartition de
            transaction.
        splits:
          type: array
          description: >-
            Un tableau d'objets de répartition des transactions, chacun
            représentant une partie de la transaction attribuée à un
            propriétaire.
          items:
            $ref: '#/components/schemas/SimplePublicObject'
    StandardError:
      required:
        - category
        - context
        - errors
        - links
        - message
        - status
      type: object
      properties:
        category:
          type: string
          description: La catégorie d'erreur
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexte concernant la condition d'erreur
        errors:
          type: array
          description: Les objets d'erreur détaillés.
          items:
            $ref: '#/components/schemas/ErrorDetail'
        id:
          type: string
          description: L'ID de l'erreur
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Une carte des noms de liens vers les URI associés contenant de la
            documentation sur l'erreur ou les mesures correctives recommandées
        message:
          type: string
          description: Le message d'erreur
        status:
          type: string
          description: >-
            Un message lisible par la personne décrivant l'erreur ainsi que les
            mesures correctives possibles, le cas échéant
        subCategory:
          type: object
          properties: {}
          description: >-
            Une catégorie spécifique qui contient des détails plus précis sur
            l'erreur
      description: >-
        Représente une réponse aux erreurs standard dans l'API HubSpot,
        fournissant des informations détaillées sur une erreur survenue lors
        d'une requête API.
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: La catégorie d'erreur
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexte concernant la condition d'erreur
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Un identifiant unique pour la demande. Incluez cette valeur dans
            tous les rapports d'erreurs ou tickets d'assistance
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: informations supplémentaires à propos de l'erreur
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Une carte des noms de liens vers les URI associés contenant de la
            documentation sur l'erreur ou les mesures correctives recommandées
        message:
          type: string
          description: >-
            Un message lisible par la personne décrivant l'erreur ainsi que les
            mesures correctives possibles, le cas échéant
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Une catégorie spécifique qui contient des détails plus précis sur
            l'erreur
      description: >-
        Représente une réponse d'erreur renvoyée par l'API lorsqu'une opération
        échoue. Ce composant est utilisé dans divers points de terminaison pour
        fournir des informations détaillées sur l'erreur rencontrée.
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    SimplePublicObject:
      required:
        - archived
        - createdAt
        - id
        - properties
        - updatedAt
      type: object
      properties:
        archived:
          type: boolean
          description: Si l'objet est archivé.
        archivedAt:
          type: string
          description: "L'horodatage du moment où l'objet a été archivé, au format ISO\_8601."
          format: date-time
        createdAt:
          type: string
          description: "L'horodatage du moment où l'objet a été créé, au format ISO\_8601."
          format: date-time
        id:
          type: string
          description: L'ID unique de l'objet.
        objectWriteTraceId:
          type: string
          description: "Un identifiant utilisé pour tracer la demande d'écriture de l'objet. Définissez un ID unique pour chaque opération d'écriture\_; il est renvoyé avec toute erreur afin que vous puissiez déterminer quelle demande a rencontré telle ou telle erreur."
        properties:
          type: object
          additionalProperties:
            type: string
          description: Paires clé-valeur représentant les propriétés de l'objet.
        propertiesWithHistory:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/ValueWithTimestamp'
          description: >-
            Paires clé-valeur représentant les propriétés de l'objet ainsi que
            leur historique. Chacune est accompagnée d'un horodatage et
            d'informations sur la source.
        updatedAt:
          type: string
          description: "L'horodatage du moment où l'objet a été mis à jour pour la dernière fois, au format ISO\_8601."
          format: date-time
        url:
          type: string
          description: L'URL associée à l'objet.
      description: Un objet public simple.
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: Le code du statut associé au détail de l'erreur
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexte concernant la condition d'erreur
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: Le nom du champ ou du paramètre dans lequel l'erreur a été trouvée.
        message:
          type: string
          description: >-
            Un message lisible par la personne décrivant l'erreur ainsi que les
            mesures correctives possibles, le cas échéant
        subCategory:
          type: string
          description: >-
            Une catégorie spécifique qui contient des détails plus précis sur
            l'erreur
      description: >-
        Représente des informations détaillées sur une erreur survenue dans
        l'API. Ce composant est utilisé pour fournir un contexte et des
        spécificités supplémentaires sur les erreurs, généralement dans le cadre
        d'une réponse d'erreur.
    ValueWithTimestamp:
      required:
        - sourceType
        - timestamp
        - value
      type: object
      properties:
        sourceId:
          type: string
          description: Une chaîne identifiant la source spécifique de la valeur.
        sourceLabel:
          type: string
          description: Un libellé lisible par l'homme.
        sourceType:
          type: string
          description: Une chaîne indiquant le type de source d'où provient la valeur.
        timestamp:
          type: string
          description: "Date à laquelle la propriété a été mise à jour, au format ISO\_8601."
          format: date-time
        updatedByUserId:
          type: integer
          description: >-
            L'ID de l'utilisateur qui a mis à jour la propriété pour la dernière
            fois.
          format: int32
        value:
          type: string
          description: La valeur de la propriété.
      description: Modèle de propriété qui inclut un horodatage.
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            crm.dealsplits.read_write: ''

````