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

# List location financial orders



## OpenAPI

````yaml /api-reference/orders-v1.json get /v1/locations/{location_id}/orders/financials
openapi: 3.0.0
info:
  title: Chataigne Orders API
  description: >-
    Read Chataigne orders and update their canonical status from a connected
    POS.
  version: '2026-05-01'
  contact: {}
servers:
  - url: https://server.chataigne.ai
security: []
tags: []
paths:
  /v1/locations/{location_id}/orders/financials:
    get:
      tags:
        - Orders
      summary: List location financial orders
      operationId: OrdersV1Controller_listFinancials
      parameters:
        - name: location_id
          required: true
          in: path
          schema:
            type: string
        - name: limit
          required: false
          in: query
          description: Page size (1–100).
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
        - name: starting_after
          required: false
          in: query
          description: Return the next page after this financial order id.
          schema:
            type: string
        - name: ending_before
          required: false
          in: query
          description: Return the preceding page before this financial order id.
          schema:
            type: string
        - name: created_after
          required: false
          in: query
          description: Include orders created at or after this ISO 8601 timestamp.
          schema:
            type: string
            format: date-time
        - name: created_before
          required: false
          in: query
          description: Include orders created at or before this ISO 8601 timestamp.
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: A paginated financial order export.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialOrderList'
        '400':
          description: Invalid range, page size, or pagination cursor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Authentication required for this endpoint.
        '403':
          description: |-
            The principal does not have orders.export.

            The authenticated principal is not allowed to use this 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: >-
        One privacy-safe financial order row. It contains no customer identity,
        contact, address, note, credential, or provider-secret fields.
      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
        - provider_delivery_cost_cents
        - provider_delivery_cost_source
        - chataigne_order_fee_cents
        - chataigne_payment_fee_cents
        - psp_processing_fee_cents
        - psp_fee_coverage_status
        - payment_refunded_cents
      properties:
        order_id:
          type: string
          description: Unique technical identifier of the Châtaigne order.
        order_reference:
          type: string
          nullable: true
          description: Short reference shown to the restaurant, when available.
        location_id:
          type: string
          description: Technical identifier of the restaurant that owns the order.
        location_name:
          type: string
          description: Restaurant name at the time of export.
        organization_id:
          type: string
          nullable: true
          description: Owning organization identifier; empty for a standalone restaurant.
        organization_name:
          type: string
          nullable: true
          description: Owning organization name; empty for a standalone restaurant.
        order_created_at:
          type: string
          format: date-time
          description: >-
            Absolute ISO 8601 order creation instant used by the period filter.
            CSV exports split this value into order_date and order_time in
            order_timezone.
        order_timezone:
          type: string
          description: IANA time zone used for the order date and time.
        currency:
          type: string
          description: ISO 4217 currency code of the order.
        channel:
          type: string
          nullable: true
          description: Order origin channel, such as WhatsApp or Instagram.
        service_type:
          type: string
          description: Pickup, delivery, or eat-in service mode.
        order_status:
          type: string
          description: >-
            Current status, including cancelled, rejected, or delivery-failed
            orders.
        payment_status:
          type: string
          nullable: true
          description: Primary payment status; empty when no payment is recorded.
        customer_paid_total_cents:
          type: integer
          nullable: true
          description: >-
            Total order amount in cents, including customer fees. Null means
            unavailable and must not be interpreted as zero.
        customer_service_fee_cents:
          type: integer
          nullable: true
          description: >-
            Service fee charged to the customer in cents and already included in
            the customer total. Null means unavailable and must not be
            interpreted as zero.
        customer_delivery_fee_cents:
          type: integer
          nullable: true
          description: >-
            Delivery fee charged to the customer in cents and already included
            in the customer total. Null means unavailable and must not be
            interpreted as zero.
        delivery_count:
          type: integer
          minimum: 0
          description: >-
            Number of created deliveries whose cost is included in the provider
            cost. It is 0 when the cost comes only from a quote.
        delivery_provider:
          type: string
          nullable: true
          description: Provider of known deliveries. Multiple values are separated by |.
        provider_delivery_cost_cents:
          type: integer
          nullable: true
          description: >-
            Sum in cents of costs recorded when deliveries were created, or
            otherwise the quote amount. This is not a guaranteed provider
            invoice cost. Null means unavailable and must not be interpreted as
            zero.
        provider_delivery_cost_source:
          type: string
          enum:
            - delivery_response
            - quote
            - missing
          description: >-
            delivery_response for a created delivery cost, quote for a quote, or
            missing when the cost is unknown.
        chataigne_order_fee_cents:
          type: integer
          nullable: true
          description: >-
            Recorded Châtaigne order fee including tax, in cents. Null means
            unavailable and must not be interpreted as zero.
        chataigne_payment_fee_cents:
          type: integer
          nullable: true
          description: >-
            Contractual payment fee including tax charged by Châtaigne, in
            cents. Null means unavailable and must not be interpreted as zero.
        psp_processing_fee_cents:
          type: integer
          nullable: true
          description: >-
            Processing fee actually recorded by the payment service provider, in
            cents. Null means unavailable and must not be interpreted as zero.
        psp_fee_coverage_status:
          type: string
          enum:
            - covered
            - partially_covered
            - not_covered
            - not_applicable
            - unknown
          description: >-
            Indicates whether the contractual payment fee covers the known PSP
            cost. unknown means the comparison is not possible.
        payment_refunded_cents:
          type: integer
          nullable: true
          description: >-
            Sum in cents of successful payment refunds. Null means unavailable
            and must not be interpreted as zero.
  securitySchemes:
    organization-api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: Location/organization API key.

````