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

# Obtener resumen anual de facturas por estado

> Retorna los totales pagados, pendientes y vencidos para un año, respetando filtros de origen, tipo de facturación, cliente, búsqueda y OC/HES.



## OpenAPI

````yaml /generated/specs/finance.json get /api/v1/billing/invoices/status-summary
openapi: 3.0.0
info:
  title: Raul API - Finanzas
  description: >-
    Facturas, boletas, ejecuciones de billing, cuentas por pagar y medios de
    pago.
  version: 2.0.0
  contact: {}
servers:
  - url: https://api.raul.ugps.io
    description: Production
security: []
tags: []
paths:
  /api/v1/billing/invoices/status-summary:
    get:
      tags:
        - Invoices
      summary: Obtener resumen anual de facturas por estado
      description: >-
        Retorna los totales pagados, pendientes y vencidos para un año,
        respetando filtros de origen, tipo de facturación, cliente, búsqueda y
        OC/HES.
      operationId: InvoiceQueryController_getStatusSummary
      parameters:
        - name: payment_status
          required: false
          in: query
          description: >-
            Pago de facturas emitidas con total mayor que cero. Excluye
            borradores, pendientes de emisión, rechazadas, anuladas y notas de
            crédito; se intersecta con el estado comercial seleccionado.
          schema:
            type: string
            enum:
              - paid
              - partial
              - unpaid
        - name: dte_type
          required: false
          in: query
          description: >-
            Tipo guardado en la factura. UNDEFINED selecciona NULL: la emisión
            resuelve la preferencia del receptor legal o infiere el tipo por
            RUT.
          schema:
            type: string
            enum:
              - FACTURA
              - BOLETA
              - UNDEFINED
        - name: type
          required: false
          in: query
          description: Tipo de factura
          schema:
            type: string
            enum:
              - MANUAL
              - MENSUAL
        - name: invoice_type
          required: false
          in: query
          description: Tipo de facturación (regular, consolidada o filial)
          schema:
            type: string
            enum:
              - regular
              - consolidated
              - filial
        - name: client_id
          required: false
          in: query
          description: UUID del cliente
          schema:
            type: string
        - name: search
          required: false
          in: query
          description: Búsqueda por nombre, RUT, email o concepto
          schema:
            type: string
        - name: year
          required: true
          in: query
          description: Año del resumen (YYYY)
          schema:
            type: string
            example: '2026'
        - name: periodo
          required: false
          in: query
          description: >-
            Periodo exacto del resumen (YYYY-MM). Si se envía, tiene prioridad
            sobre el año.
          schema:
            example: 2026-03
            type: string
        - name: requires_oc
          required: false
          in: query
          description: >-
            Filtrar facturas de clientes que requieren OC (orden de compra) y no
            tienen OC cargada
          schema:
            type: boolean
      responses:
        '200':
          description: Resumen anual de facturas por estado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceStatusSummaryResponseDto'
      security:
        - bearerAuth: []
components:
  schemas:
    InvoiceStatusSummaryResponseDto:
      type: object
      properties:
        year:
          type: string
          example: '2026'
        billed:
          type: number
          example: 6279906
          description: Total pagado del año en CLP
        pending:
          type: number
          example: 100
          description: Total pendiente del año en CLP
        overdue:
          type: number
          example: 1075762
          description: Total vencido del año en CLP
      required:
        - year
        - billed
        - pending
        - overdue
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Token de sesión Better Auth para rutas de backoffice; las rutas de
        portal usan su token propio.

````

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