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

# Registrar cobro

> Aplica un cobro por factura (`allocations`) o repartido de la factura más antigua a la más reciente; todo o nada.

**Permiso requerido:** `receivables.payments`



## OpenAPI

````yaml /api-reference/openapi.json post /receivables/payments
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:
  /receivables/payments:
    post:
      tags:
        - Cuentas por cobrar
      summary: Registrar cobro
      description: >-
        Aplica un cobro por factura (`allocations`) o repartido de la factura
        más antigua a la más reciente; todo o nada.


        **Permiso requerido:** `receivables.payments`
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReceivablePaymentRequest'
            examples:
              allocations:
                summary: Por factura
                value:
                  payment_method_id: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
                  bank_id: 3b8e2f10-7c4d-4a9e-b1f2-5d6c7e8f9a01
                  reference_number: TRF-88231
                  payment_date: '2026-10-06'
                  notes: Cobro parcial
                  allocations:
                    - sale_id: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
                      amount: 300
              auto:
                summary: Reparto automático
                value:
                  payment_method_id: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
                  payment_date: '2026-10-06'
                  customer_id: 3b8e2f10-7c4d-4a9e-b1f2-5d6c7e8f9a01
                  branch_id: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
                  amount: 630
      responses:
        '201':
          description: Cobro aplicado
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - data
                properties:
                  status:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/PaymentResult'
              example:
                status: true
                data:
                  payments:
                    - payment_id: 3b8e2f10-7c4d-4a9e-b1f2-5d6c7e8f9a01
                      sale_id: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
                      generation_code: 6F1E2D3C-8A4B-4C5D-9E6F-0A1B2C3D4E5F
                      amount: 300
                      pending_amount: 330
                      payment_status: partial
                  total_applied: 300
          headers:
            Idempotent-Replayed:
              $ref: '#/components/headers/IdempotentReplayed'
        '401':
          $ref: '#/components/responses/E401'
        '403':
          $ref: '#/components/responses/E403'
        '404':
          description: Factura o sucursal inexistente o de otro negocio
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: false
                message: Invoice 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11 not found
        '409':
          description: Conflicto de idempotencia
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                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, método/banco inexistente, monto mayor al saldo o
            documento ya pagado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: false
                message: The amount exceeds the customer pending balance.
        '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:
    ReceivablePaymentRequest:
      type: object
      properties:
        payment_method_id:
          type: string
          format: uuid
          description: Forma de pago (GET /payment-methods).
        bank_id:
          type: string
          format: uuid
          description: Banco (GET /treasury/banks).
        reference_number:
          type: string
          description: Referencia (máx. 255).
        payment_date:
          type: string
          format: date
          description: Fecha del pago.
        notes:
          type: string
          description: Notas (máx. 500).
        branch_id:
          type: string
          format: uuid
          description: Requerido junto con el tercero (modo automático).
        amount:
          type: number
          exclusiveMinimum: true
          minimum: 0
          description: Monto a repartir (modo automático).
        customer_id:
          type: string
          format: uuid
          description: Cliente (modo automático, en lugar de allocations).
        allocations:
          type: array
          minItems: 1
          maxItems: 200
          description: Monto por factura (o usa customer_id).
          items:
            type: object
            properties:
              sale_id:
                type: string
                format: uuid
              amount:
                type: number
                exclusiveMinimum: true
                minimum: 0
            required:
              - sale_id
              - amount
      required:
        - payment_method_id
        - payment_date
    PaymentResult:
      type: object
      properties:
        payments:
          type: array
          items:
            type: object
            properties:
              payment_id:
                type: string
                format: uuid
              sale_id:
                type: string
                format: uuid
              generation_code:
                type: string
              amount:
                type: number
              pending_amount:
                type: number
              payment_status:
                type: string
                description: Estado de pago.
                enum:
                  - partial
                  - payed
            required:
              - payment_id
              - sale_id
              - amount
        total_applied:
          type: number
      required:
        - payments
        - total_applied
    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.