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

# List sales

> Sales of a branch over a range of up to 93 days, for reconciliation with an ERP.

**Required permission:** `sales`



## OpenAPI

````yaml /api-reference/openapi.en.json get /sales
openapi: 3.0.3
info:
  title: FileXpress External API
  version: 1.0.0
  description: >-
    API for integrating third-party systems with FileXpress: billing, HR,
    accounting, inventory, projects, accounts receivable and payable, treasury,
    pricing and promotions, and cash. Current base URL: /api/external/v1. The
    legacy unversioned path (/api/external) will be removed on January 1, 2027;
    migrate to /api/external/v1 (same endpoints, only the base URL changes). The
    v2 API (/api/external/v2) exposes currencies and exchange rates, sales and
    purchases in foreign currency, taxes by id, payrolls with branch, and errors
    with a stable `code`; its operations carry the /v2 prefix in the path. We
    suggest migrating to the available v2 routes before March 30, 2027.
servers:
  - url: https://api.filexpress.app/api/external/v1
    description: Production
security:
  - ApiKey: []
tags:
  - name: General
  - name: Billing · Sales
  - name: Billing · Purchases
  - name: Billing · Customers
  - name: Billing · Suppliers
  - name: Billing · Products
  - name: Catalogs
  - name: HR · Employees
  - name: HR · Attendance
  - name: HR · Labor rules
  - name: HR · Schedules
  - name: HR · Holidays
  - name: HR · Attendance results
  - name: HR · Leave requests
  - name: HR · Payrolls
  - name: Accounting
  - name: Inventory
  - name: Projects
  - name: Accounts receivable
  - name: Accounts payable
  - name: Treasury
  - name: Pricing and promotions
  - name: Cash
  - name: Points of sale
  - name: API v2 · General
  - name: API v2 · Currencies and rates
  - name: API v2 · Countries
  - name: API v2 · Sales
  - name: API v2 · Purchases
  - name: API v2 · Payrolls
paths:
  /sales:
    get:
      tags:
        - Billing · Sales
      summary: List sales
      description: >-
        Sales of a branch over a range of up to 93 days, for reconciliation with
        an ERP.


        **Required permission:** `sales`
      parameters:
        - name: branch_id
          in: query
          required: true
          description: Branch (GET /branches). From another business → 404.
          schema:
            type: string
            format: uuid
          example: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
        - name: start_date
          in: query
          required: true
          description: Start date (YYYY-MM-DD). Maximum range 93 days.
          schema:
            type: string
            format: date
          example: '2026-10-01'
        - name: end_date
          in: query
          required: true
          description: End date (YYYY-MM-DD), greater than or equal to start_date.
          schema:
            type: string
            format: date
          example: '2026-10-15'
        - name: document_type
          in: query
          required: false
          description: Document type (fc, ccf, fex, nc, nd…).
          schema:
            type: string
          example: fc
        - name: status
          in: query
          required: false
          description: Document status (max. 30 characters).
          schema:
            type: string
          example: PROCESADO
        - name: payment_status
          in: query
          required: false
          description: Payment status.
          schema:
            type: string
            enum:
              - pending
              - partial
              - payed
        - name: customer_id
          in: query
          required: false
          description: Filter by customer.
          schema:
            type: string
            format: uuid
        - name: per_page
          in: query
          required: false
          description: Results per page (1–500, default 100).
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 100
        - name: page
          in: query
          required: false
          description: Page.
          schema:
            type: integer
            minimum: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - data
                properties:
                  status:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/SaleListItem'
                      pagination:
                        $ref: '#/components/schemas/Pagination'
                    required:
                      - data
                      - pagination
              example:
                status: true
                data:
                  data:
                    - sale_id: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
                      generation_code: 6F1E2D3C-8A4B-4C5D-9E6F-0A1B2C3D4E5F
                      control_number: DTE-01-M001P001-000000000000001
                      document_type: fc
                      status: PROCESADO
                      issue_time: '2026-10-01T10:30:00-06:00'
                      payment_status: payed
                      is_credit: false
                      nullified: false
                      customer:
                        id: 3b8e2f10-7c4d-4a9e-b1f2-5d6c7e8f9a01
                        name: Razón Social S.A. de C.V.
                      totals:
                        sale_total: 22.6
                        sale_to_payment: 22.6
                  pagination:
                    current_page: 1
                    last_page: 1
                    per_page: 100
                    total: 1
        '401':
          $ref: '#/components/responses/E401'
        '403':
          $ref: '#/components/responses/E403'
        '404':
          description: Not found or belongs to another business
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: false
                message: Branch not found
        '422':
          description: Validation error or range longer than 93 days
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: false
                message: The date range cannot exceed 93 days.
        '429':
          $ref: '#/components/responses/E429'
components:
  schemas:
    SaleListItem:
      type: object
      properties:
        sale_id:
          type: string
          format: uuid
        generation_code:
          type: string
          nullable: true
        control_number:
          type: string
          nullable: true
        document_type:
          type: string
        status:
          type: string
        issue_time:
          type: string
          format: date-time
        payment_status:
          type: string
          nullable: true
        is_credit:
          type: boolean
        nullified:
          type: boolean
        customer:
          type: object
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
          nullable: true
        totals:
          type: object
          properties:
            sale_total:
              type: number
            sale_to_payment:
              type: number
      required:
        - sale_id
        - status
    Pagination:
      type: object
      properties:
        current_page:
          type: integer
        last_page:
          type: integer
        per_page:
          type: integer
        total:
          type: integer
      required:
        - current_page
        - last_page
        - per_page
        - total
    Error:
      type: object
      properties:
        status:
          type: boolean
          example: false
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Errors per field (validation only).
      required:
        - status
        - message
  responses:
    E401:
      description: Missing or invalid API Key
      content:
        application/json:
          example:
            status: false
            message: Invalid API Key.
    E403:
      description: Integration without the required permission or deactivated
      content:
        application/json:
          example:
            status: false
            message: This integration does not have the 'hr.employees' permission.
            required_scope: hr.employees
    E429:
      description: Rate limit exceeded
      content:
        application/json:
          example:
            status: false
            message: Rate limit exceeded. Please try again later.
            rate_limit: 100
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Integration API Key (Integrations → New Integration).

````

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