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

# Abrir caja

> Abre la caja de la sucursal para un cajero (`user_id`, usuario de FileXpress con acceso a la sucursal). Solo puede haber una caja abierta por sucursal.

**Permiso requerido:** `cash_register.operate`



## OpenAPI

````yaml /api-reference/openapi.json post /cash-registers/open
openapi: 3.0.3
info:
  title: FileXpress API Externa
  version: 1.0.0
  description: >-
    API para integrar sistemas de terceros con FileXpress: facturación, RRHH,
    contabilidad, inventario, proyectos, cuentas por cobrar y pagar, tesorería,
    precios y promociones y caja.
servers:
  - url: https://api.filexpress.app/api/external
    description: Producción
security:
  - ApiKey: []
tags:
  - name: General
  - name: Facturación · Ventas
  - name: Facturación · Compras
  - name: Facturación · Clientes
  - name: Facturación · Proveedores
  - name: Facturación · Productos
  - name: Catálogos
  - name: RRHH · Empleados
  - name: RRHH · Asistencia
  - name: RRHH · Permisos
  - name: RRHH · Planillas
  - name: Contabilidad
  - name: Inventario
  - name: Proyectos
  - name: Cuentas por cobrar
  - name: Cuentas por pagar
  - name: Tesorería
  - name: Precios y promociones
  - name: Caja
paths:
  /cash-registers/open:
    post:
      tags:
        - Caja
      summary: Abrir caja
      description: >-
        Abre la caja de la sucursal para un cajero (`user_id`, usuario de
        FileXpress con acceso a la sucursal). Solo puede haber una caja abierta
        por sucursal.


        **Permiso requerido:** `cash_register.operate`
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CashRegisterOpenRequest'
            example:
              branch_id: 3b8e2f10-7c4d-4a9e-b1f2-5d6c7e8f9a01
              user_id: 3b8e2f10-7c4d-4a9e-b1f2-5d6c7e8f9a01
              opening_amount: 100
              notes: Turno mañana
      responses:
        '201':
          description: Caja abierta
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - data
                properties:
                  status:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/CashRegister'
              example:
                status: true
                data:
                  id: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
                  branch_id: 3b8e2f10-7c4d-4a9e-b1f2-5d6c7e8f9a01
                  status: open
                  cashier:
                    id: 3b8e2f10-7c4d-4a9e-b1f2-5d6c7e8f9a01
                    name: Ana Martínez
                  opening_date: '2026-10-06T08:00:00-06:00'
                  closing_date: null
                  opening_amount: 100
                  declared_amount: null
                  difference_amount: null
                  total_sales: null
                  total_cash_sales: null
                  total_card_sales: null
                  total_other_sales: null
                  total_expenses: null
                  total_other_incomes: null
                  notes: null
                  opened_by: 'API: Mi POS'
                  closed_by: null
          headers:
            Idempotent-Replayed:
              $ref: '#/components/headers/IdempotentReplayed'
        '401':
          $ref: '#/components/responses/E401'
        '403':
          $ref: '#/components/responses/E403'
        '404':
          description: No encontrado o de otro negocio
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: false
                message: Branch not found
        '409':
          description: Ya hay una caja abierta o conflicto de idempotencia
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                open:
                  summary: Caja ya abierta
                  value:
                    status: false
                    message: There is already an open cash register for this branch.
                idem_body:
                  summary: Idempotency-Key reutilizada con otro cuerpo
                  value:
                    status: false
                    message: >-
                      This Idempotency-Key was already used with a different
                      request.
                idem_busy:
                  summary: Petición con la misma llave en proceso
                  value:
                    status: false
                    message: >-
                      A request with this Idempotency-Key is already being
                      processed.
        '422':
          description: Validación o cajero sin acceso a la sucursal
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: false
                message: The user does not exist or has no access to this branch.
        '429':
          $ref: '#/components/responses/E429'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        Opcional. Llave única por operación (máx. 100 caracteres, vale 24 h por
        integración). Un reintento con la misma llave y el mismo cuerpo devuelve
        la respuesta original (header `Idempotent-Replayed: true`) sin repetir
        la operación; con otro cuerpo, o mientras la primera sigue en proceso,
        responde 409.
      schema:
        type: string
        maxLength: 100
      example: pago-2026-10-06-000123
  schemas:
    CashRegisterOpenRequest:
      type: object
      properties:
        branch_id:
          type: string
          format: uuid
        user_id:
          type: string
          format: uuid
          description: 'Cajero: usuario de FileXpress con acceso a la sucursal.'
        opening_amount:
          type: number
          minimum: 0
        notes:
          type: string
          maxLength: 500
      required:
        - branch_id
        - user_id
        - opening_amount
    CashRegister:
      type: object
      properties:
        id:
          type: string
          format: uuid
        branch_id:
          type: string
          format: uuid
        status:
          type: string
          description: Estado.
          enum:
            - open
            - closed
        cashier:
          type: object
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
              nullable: true
          required:
            - id
        opening_date:
          type: string
          format: date-time
        closing_date:
          type: string
          format: date-time
          nullable: true
        opening_amount:
          type: number
          nullable: true
        declared_amount:
          type: number
          nullable: true
        difference_amount:
          type: number
          nullable: true
          description: Declarado − esperado.
        total_sales:
          type: number
          nullable: true
        total_cash_sales:
          type: number
          nullable: true
        total_card_sales:
          type: number
          nullable: true
        total_other_sales:
          type: number
          nullable: true
        total_expenses:
          type: number
          nullable: true
        total_other_incomes:
          type: number
          nullable: true
        notes:
          type: string
          nullable: true
        opened_by:
          type: string
          nullable: true
          description: 'Quien abrió (desde la API: "API: <integración>").'
        closed_by:
          type: string
          nullable: true
      required:
        - id
        - status
    Error:
      type: object
      properties:
        status:
          type: boolean
          example: false
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Errores por campo (solo en validación).
      required:
        - status
        - message
  headers:
    IdempotentReplayed:
      description: >-
        `true` cuando la respuesta es la repetición de una petición anterior con
        la misma Idempotency-Key.
      schema:
        type: string
        enum:
          - 'true'
  responses:
    E401:
      description: API Key ausente o inválida
      content:
        application/json:
          example:
            status: false
            message: Invalid API Key.
    E403:
      description: Integración sin el permiso requerido o desactivada
      content:
        application/json:
          example:
            status: false
            message: This integration does not have the 'hr.employees' permission.
            required_scope: hr.employees
    E429:
      description: Límite de peticiones excedido
      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: API Key de la integración (Integraciones → Nueva Integración).

````

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