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

# Cargos

> Lista lo que deben los pacientes: un cargo por sesión, venta de bono o concepto suelto, con importe, cobrado y pendiente.

**Cuándo usarla:** Para ver las sesiones pendientes de un paciente, lo que queda por cobrar o por facturar. Usa settlement=pending o partial para la deuda abierta. Los importes van en céntimos.


## OpenAPI

````yaml /api-reference/openapi.es.json get /charges
openapi: 3.1.0
info:
  title: API de Brelio
  version: '1'
  description: >-
    Todo lo que una persona hace en Brelio lo puede hacer un programa, con los
    mismos permisos, auditoría y límites. Cada endpoint se deriva del catálogo
    de operaciones.
servers:
  - url: https://api.brelio.app/v1
security: []
tags:
  - name: Agenda
  - name: Huecos libres
  - name: Citas
  - name: Pacientes
  - name: Profesionales
  - name: Servicios
  - name: Webhooks
  - name: Centros y accesos
  - name: Datos para integraciones
  - name: Facturación
paths:
  /charges:
    get:
      tags:
        - Facturación
      summary: Cargos
      description: >-
        Lista lo que deben los pacientes: un cargo por sesión, venta de bono o
        concepto suelto, con importe, cobrado y pendiente.


        **Cuándo usarla:** Para ver las sesiones pendientes de un paciente, lo
        que queda por cobrar o por facturar. Usa settlement=pending o partial
        para la deuda abierta. Los importes van en céntimos.
      operationId: charges.list
      parameters:
        - name: cursor
          in: query
          required: false
          schema:
            type: string
            maxLength: 200
          description: '`next_cursor` de la página anterior. Omítelo para la primera página.'
        - name: limit
          in: query
          required: false
          schema:
            default: 25
            type: integer
            minimum: 1
            maximum: 100
          description: Tamaño de página, de 1 a 100.
        - name: patientId
          in: query
          required: false
          schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
          description: Solo los cargos de este paciente.
        - name: settlement
          in: query
          required: false
          schema:
            type: string
            enum:
              - pending
              - partial
              - settled
          description: Solo los cargos en este estado de cobro.
        - name: uninvoiced
          in: query
          required: false
          schema:
            type: boolean
          description: Solo los cargos abiertos que todavía no documenta ninguna factura.
        - name: from
          in: query
          required: false
          schema:
            type: string
            format: date
            pattern: >-
              ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
          description: Solo los cargos con fecha de servicio igual o posterior, YYYY-MM-DD.
        - name: to
          in: query
          required: false
          schema:
            type: string
            format: date
            pattern: >-
              ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
          description: Solo los cargos con fecha de servicio igual o anterior, YYYY-MM-DD.
      responses:
        '200':
          description: Correcto
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          pattern: >-
                            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                        patientId:
                          type: string
                          format: uuid
                          pattern: >-
                            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                          description: Quién lo debe.
                        centerId:
                          type: string
                          format: uuid
                          pattern: >-
                            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                          description: El centro en el que se registró.
                        kind:
                          type: string
                          enum:
                            - session
                            - package
                            - manual
                          description: >-
                            Una sesión, la venta de un bono o un concepto
                            suelto.
                        sessionId:
                          anyOf:
                            - type: string
                              format: uuid
                              pattern: >-
                                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                            - type: 'null'
                          description: La sesión que cobra, si kind es session.
                        packageId:
                          anyOf:
                            - type: string
                              format: uuid
                              pattern: >-
                                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                            - type: 'null'
                          description: El bono que cobra, si kind es package.
                        description:
                          type: string
                          description: El concepto, como el nombre del servicio.
                        serviceDate:
                          type: string
                          format: date
                          pattern: >-
                            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
                          description: Fecha del servicio o de la venta.
                        currency:
                          type: string
                          description: Código ISO 4217, como EUR.
                        amount:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                          description: Importe debido, impuestos incluidos, en céntimos.
                        collected:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                          description: Cobrado hasta ahora, en céntimos.
                        pending:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                          description: Pendiente de cobro, en céntimos.
                        settlement:
                          type: string
                          enum:
                            - pending
                            - partial
                            - settled
                          description: pending, partial o settled, según lo cobrado.
                        status:
                          type: string
                          enum:
                            - open
                            - voided
                          description: >-
                            Los cargos voided no deben nada (cortesía, error de
                            registro, cancelación).
                        voidReason:
                          anyOf:
                            - type: string
                              enum:
                                - courtesy
                                - recording_error
                                - session_cancelled
                                - covered_by_package
                            - type: 'null'
                          description: Por qué se anuló.
                        invoiceId:
                          anyOf:
                            - type: string
                              format: uuid
                              pattern: >-
                                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                            - type: 'null'
                          description: >-
                            La factura vigente que lo documenta; null mientras
                            no está facturado.
                        invoiceNumber:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Número de esa factura; null si es un borrador.
                        createdAt:
                          type: string
                          format: date-time
                          pattern: >-
                            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                          description: ISO 8601, en UTC.
                      required:
                        - id
                        - patientId
                        - centerId
                        - kind
                        - sessionId
                        - packageId
                        - description
                        - serviceDate
                        - currency
                        - amount
                        - collected
                        - pending
                        - settlement
                        - status
                        - voidReason
                        - invoiceId
                        - invoiceNumber
                        - createdAt
                      additionalProperties: false
                  next_cursor:
                    anyOf:
                      - type: string
                      - type: 'null'
                    description: >-
                      Pásalo como `cursor` para leer la página siguiente; null
                      en la última página.
                  has_more:
                    type: boolean
                required:
                  - data
                  - next_cursor
                  - has_more
                additionalProperties: false
        '401':
          description: Problem Details (RFC 9457) con un `code` estable
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '402':
          description: Problem Details (RFC 9457) con un `code` estable
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: Problem Details (RFC 9457) con un `code` estable
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '422':
          description: Problem Details (RFC 9457) con un `code` estable
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: Problem Details (RFC 9457) con un `code` estable
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '503':
          description: Problem Details (RFC 9457) con un `code` estable
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      security:
        - bearer: []
components:
  schemas:
    Problem:
      type: object
      required:
        - type
        - title
        - status
        - code
        - detail
        - request_id
        - params
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        code:
          type: string
        detail:
          type: string
        request_id:
          type: string
        hint:
          type: string
        retryAfterSeconds:
          type: integer
        params:
          type: object
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: >-
        Clave de API de Brelio (de organización o personal) o un token de acceso
        de WorkOS.

````

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