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

# Lister les données financières des commandes d’une organisation



## OpenAPI

````yaml /fr/api-reference/orders-v1.json get /v1/organizations/{organization_id}/orders/financials
openapi: 3.0.0
info:
  title: API Commandes Chataigne
  description: >-
    Consultez les commandes Chataigne et mettez à jour leur statut canonique
    depuis un POS connecté.
  version: '2026-05-01'
  contact: {}
servers:
  - url: https://server.chataigne.ai
security: []
tags: []
paths:
  /v1/organizations/{organization_id}/orders/financials:
    get:
      tags:
        - Commandes
      summary: Lister les données financières des commandes d’une organisation
      operationId: OrganizationOrdersV1Controller_listFinancials
      parameters:
        - name: organization_id
          required: true
          in: path
          schema:
            type: string
        - name: limit
          required: false
          in: query
          description: Taille de page (1–100).
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
        - name: starting_after
          required: false
          in: query
          description: >-
            Retourne la page suivante après cet identifiant de commande
            financière.
          schema:
            type: string
        - name: ending_before
          required: false
          in: query
          description: >-
            Retourne la page précédente avant cet identifiant de commande
            financière.
          schema:
            type: string
        - name: created_after
          required: false
          in: query
          description: Inclut les commandes créées à cet horodatage ISO 8601 ou après.
          schema:
            type: string
            format: date-time
        - name: created_before
          required: false
          in: query
          description: Inclut les commandes créées à cet horodatage ISO 8601 ou avant.
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: Un export paginé des données financières des commandes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialOrderList'
        '400':
          description: Période, taille de page ou curseur de pagination invalide.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Authentification requise pour cet endpoint.
        '403':
          description: |-
            L’identité ne dispose pas de la permission orders.export.

            L’identité authentifiée n’est pas autorisée à utiliser cet endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - organization-api-key: []
components:
  schemas:
    FinancialOrderList:
      type: object
      required:
        - object
        - data
        - has_more
        - url
      properties:
        object:
          type: string
          enum:
            - list
        data:
          type: array
          items:
            $ref: '#/components/schemas/FinancialOrderResource'
        has_more:
          type: boolean
        url:
          type: string
    Error:
      type: object
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - request_id
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - authorization_error
                - not_found_error
                - conflict_error
                - rate_limit_error
                - idempotency_error
                - api_error
            code:
              type: string
              example: resource_missing
            message:
              type: string
            param:
              type: string
            request_id:
              type: string
              example: req_8f2c…
            details:
              type: object
              additionalProperties: true
    FinancialOrderResource:
      type: object
      additionalProperties: false
      description: >-
        Une ligne financière de commande sans données personnelles. Elle ne
        contient aucune identité, coordonnée, adresse ou note client, ni aucun
        identifiant secret de fournisseur.
      required:
        - order_id
        - order_reference
        - location_id
        - location_name
        - organization_id
        - organization_name
        - order_created_at
        - order_timezone
        - currency
        - channel
        - service_type
        - order_status
        - payment_status
        - customer_paid_total_cents
        - customer_service_fee_cents
        - customer_delivery_fee_cents
        - delivery_count
        - delivery_provider
        - restaurant_delivery_cost_cents
        - provider_delivery_cost_source
        - chataigne_order_fee_cents
        - chataigne_payment_fee_cents
        - payment_refunded_cents
      properties:
        order_id:
          type: string
          description: Identifiant technique unique de la commande Châtaigne.
        order_reference:
          type: string
          nullable: true
          description: Référence courte affichée au restaurant, lorsqu’elle existe.
        location_id:
          type: string
          description: Identifiant technique du restaurant auquel appartient la commande.
        location_name:
          type: string
          description: Nom du restaurant au moment de l’export.
        organization_id:
          type: string
          nullable: true
          description: >-
            Identifiant de l’organisation propriétaire, vide pour un restaurant
            autonome.
        organization_name:
          type: string
          nullable: true
          description: >-
            Nom de l’organisation propriétaire, vide pour un restaurant
            autonome.
        order_created_at:
          type: string
          format: date-time
          description: >-
            Instant ISO 8601 absolu de création de la commande utilisé par le
            filtre de période. Les exports CSV le séparent en order_date et
            order_time dans order_timezone.
        order_timezone:
          type: string
          description: Fuseau IANA utilisé pour la date et l’heure de la commande.
        currency:
          type: string
          description: Code ISO 4217 de la devise de la commande.
        channel:
          type: string
          nullable: true
          description: Canal d’origine de la commande, par exemple WhatsApp ou Instagram.
        service_type:
          type: string
          description: Mode de retrait, de livraison ou de consommation sur place.
        order_status:
          type: string
          description: >-
            Statut actuel, y compris les commandes annulées, refusées ou en
            échec de livraison.
        payment_status:
          type: string
          nullable: true
          description: >-
            Statut du paiement principal, vide lorsqu’aucun paiement n’est
            enregistré.
        customer_paid_total_cents:
          type: integer
          nullable: true
          description: >-
            Montant total de la commande en centimes, frais client inclus. Une
            valeur null signifie que la donnée est indisponible et ne doit pas
            être interprétée comme zéro.
        customer_service_fee_cents:
          type: integer
          nullable: true
          description: >-
            Frais de service facturés au client en centimes et déjà inclus dans
            le total client. Une valeur null signifie que la donnée est
            indisponible et ne doit pas être interprétée comme zéro.
        customer_delivery_fee_cents:
          type: integer
          nullable: true
          description: >-
            Frais de livraison facturés au client en centimes et déjà inclus
            dans le total client. Une valeur null signifie que la donnée est
            indisponible et ne doit pas être interprétée comme zéro.
        delivery_count:
          type: integer
          minimum: 0
          description: >-
            Nombre de livraisons créées dont le coût est inclus dans le coût de
            livraison du restaurant. Vaut 0 lorsque le coût provient seulement
            d’un devis.
        delivery_provider:
          type: string
          nullable: true
          description: >-
            Fournisseur des livraisons connues. Plusieurs valeurs sont séparées
            par |.
        restaurant_delivery_cost_cents:
          type: integer
          nullable: true
          description: >-
            Coût de livraison supporté par le restaurant, en centimes : somme
            des coûts enregistrés lors de la création des livraisons, sinon
            montant du devis. Ce n’est pas un coût de facture fournisseur
            garanti. Une valeur null signifie que la donnée est indisponible et
            ne doit pas être interprétée comme zéro.
        provider_delivery_cost_source:
          type: string
          enum:
            - delivery_response
            - quote
            - missing
          description: >-
            delivery_response pour un coût de livraison créé, quote pour un
            devis ou missing si le coût est inconnu.
        chataigne_order_fee_cents:
          type: integer
          nullable: true
          description: >-
            Frais Châtaigne TTC enregistrés pour la commande, en centimes. Une
            valeur null signifie que la donnée est indisponible et ne doit pas
            être interprétée comme zéro.
        chataigne_payment_fee_cents:
          type: integer
          nullable: true
          description: >-
            Frais contractuels de paiement TTC facturés par Châtaigne, en
            centimes. Une valeur null signifie que la donnée est indisponible et
            ne doit pas être interprétée comme zéro.
        payment_refunded_cents:
          type: integer
          nullable: true
          description: >-
            Somme en centimes des remboursements de paiement réussis. Une valeur
            null signifie que la donnée est indisponible et ne doit pas être
            interprétée comme zéro.
  securitySchemes:
    organization-api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: Clé API d’établissement ou d’organisation.

````