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

# Close cash register

> Closes the cash register with the declared cash and calculates the difference against the expected amount. Records the `user_id` sent as the closer (`closed_by_user`) or, if omitted, the shift's cashier.

**Required permission:** `cash_register.operate`



## OpenAPI

````yaml /api-reference/openapi.en.json post /cash-registers/{id}/close
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:
  /cash-registers/{id}/close:
    post:
      tags:
        - Cash
      summary: Close cash register
      description: >-
        Closes the cash register with the declared cash and calculates the
        difference against the expected amount. Records the `user_id` sent as
        the closer (`closed_by_user`) or, if omitted, the shift's cashier.


        **Required permission:** `cash_register.operate`
      parameters:
        - name: id
          in: path
          required: true
          description: Cash register ID
          schema:
            type: string
            format: uuid
          example: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CashRegisterCloseRequest'
            example:
              declared_amount: 295
              user_id: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
              notes: Sin novedades
              cash_count_breakdown:
                bills:
                  hundred: 0
                  fifty: 0
                  twenty: 12
                  ten: 5
                  five: 0
                  one: 0
                coins:
                  quarter: 20
                  dime: 0
                  nickel: 0
                  penny: 0
                total: 295
      responses:
        '200':
          description: Cash register closed
          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
                  point_of_sale:
                    id: 3b8e2f10-7c4d-4a9e-b1f2-5d6c7e8f9a01
                    code: P001
                    name: Caja principal
                  opened_by_user:
                    id: 3b8e2f10-7c4d-4a9e-b1f2-5d6c7e8f9a01
                    name: Ana Martínez
                  closed_by_user:
                    id: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
                    name: Luis Pérez
                  status: closed
                  cashier:
                    id: 3b8e2f10-7c4d-4a9e-b1f2-5d6c7e8f9a01
                    name: Ana Martínez
                  opening_date: '2026-10-06T08:00:00-06:00'
                  closing_date: '2026-10-06T18:00:00-06:00'
                  opening_amount: 100
                  declared_amount: 295
                  difference_amount: 0
                  total_sales: 410
                  total_cash_sales: 215
                  total_card_sales: 180
                  total_other_sales: 15
                  total_expenses: 20
                  total_other_incomes: 0
                  notes: null
                  opened_by: 'API: Mi POS'
                  closed_by: 'API: Mi POS'
          headers:
            Idempotent-Replayed:
              $ref: '#/components/headers/IdempotentReplayed'
        '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: Cash register not found
        '409':
          description: Cash register already closed or idempotency conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                closed:
                  summary: Caja ya cerrada
                  value:
                    status: false
                    message: Cash register is not open.
                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: Validation, cash count that does not balance, or user without access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                breakdown:
                  summary: Arqueo no cuadra
                  value:
                    status: false
                    message: >-
                      The cash count breakdown total does not match the declared
                      amount.
                user:
                  summary: Usuario sin acceso
                  value:
                    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: >-
        Optional. Unique key per operation (max. 100 characters, valid for 24 h
        per integration). A retry with the same key and the same body returns
        the original response (header `Idempotent-Replayed: true`) without
        repeating the operation; with a different body, or while the first is
        still in progress, it returns 409.
      schema:
        type: string
        maxLength: 100
      example: pago-2026-10-06-000123
  schemas:
    CashRegisterCloseRequest:
      type: object
      properties:
        declared_amount:
          type: number
          minimum: 0
          description: Counted cash.
        user_id:
          type: string
          format: uuid
          description: >-
            User closing the shift (with access to the branch). Default: the
            shift's cashier.
        notes:
          type: string
          maxLength: 500
        cash_count_breakdown:
          type: object
          properties:
            bills:
              type: object
              properties:
                hundred:
                  type: integer
                  minimum: 0
                fifty:
                  type: integer
                  minimum: 0
                twenty:
                  type: integer
                  minimum: 0
                ten:
                  type: integer
                  minimum: 0
                five:
                  type: integer
                  minimum: 0
                one:
                  type: integer
                  minimum: 0
              description: Number of bills per denomination.
            coins:
              type: object
              properties:
                quarter:
                  type: integer
                  minimum: 0
                dime:
                  type: integer
                  minimum: 0
                nickel:
                  type: integer
                  minimum: 0
                penny:
                  type: integer
                  minimum: 0
              description: Number of coins per denomination.
            total:
              type: number
              description: Cash count total; must match declared_amount.
          required:
            - total
      required:
        - declared_amount
    CashRegister:
      type: object
      properties:
        id:
          type: string
          format: uuid
        branch_id:
          type: string
          format: uuid
        point_of_sale:
          type: object
          properties:
            id:
              type: string
              format: uuid
            code:
              type: string
            name:
              type: string
          required:
            - id
            - code
          nullable: true
        opened_by_user:
          type: object
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
              nullable: true
          required:
            - id
          nullable: true
        closed_by_user:
          type: object
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
              nullable: true
          required:
            - id
          nullable: true
          description: null while open.
        status:
          type: string
          description: Status.
          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: Declared − expected.
        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: 'Who opened it (from the API: "API: <integration>").'
        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: Errors per field (validation only).
      required:
        - status
        - message
  headers:
    IdempotentReplayed:
      description: >-
        `true` when the response is the replay of a previous request with the
        same Idempotency-Key.
      schema:
        type: string
        enum:
          - 'true'
  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.