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

# Charges

> Lists what patients owe: one charge per session, bono sale or loose concept, with amount, collected and pending.

**When to use it:** To see a patient’s pending sessions, what is left to collect or to invoice. Use settlement=pending or partial for open debt. Amounts are in cents.


## OpenAPI

````yaml /api-reference/openapi.en.json get /charges
openapi: 3.1.0
info:
  title: Brelio API
  version: '1'
  description: >-
    Everything a person can do in Brelio, a program can do, with the same
    permissions, audit and limits. Every endpoint is derived from the operation
    catalogue.
servers:
  - url: https://api.brelio.app/v1
security: []
tags:
  - name: Calendar
  - name: Scheduling
  - name: Appointments
  - name: Patients
  - name: Professionals
  - name: Services
  - name: Webhooks
  - name: Organizations
  - name: Platform policy
  - name: Billing
paths:
  /charges:
    get:
      tags:
        - Billing
      summary: Charges
      description: >-
        Lists what patients owe: one charge per session, bono sale or loose
        concept, with amount, collected and pending.


        **When to use it:** To see a patient’s pending sessions, what is left to
        collect or to invoice. Use settlement=pending or partial for open debt.
        Amounts are in cents.
      operationId: charges.list
      parameters:
        - name: cursor
          in: query
          required: false
          schema:
            type: string
            maxLength: 200
          description: '`next_cursor` of the previous page. Omit it for the first page.'
        - name: limit
          in: query
          required: false
          schema:
            default: 25
            type: integer
            minimum: 1
            maximum: 100
          description: Page size, 1 to 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: Only this patient’s charges.
        - name: settlement
          in: query
          required: false
          schema:
            type: string
            enum:
              - pending
              - partial
              - settled
          description: Only charges in this settlement state.
        - name: uninvoiced
          in: query
          required: false
          schema:
            type: boolean
          description: Only open charges that no invoice documents yet.
        - 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: Only charges with a service date on or after, 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: Only charges with a service date on or before, YYYY-MM-DD.
      responses:
        '200':
          description: Success
          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: Who owes it.
                        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: The center it was recorded in.
                        kind:
                          type: string
                          enum:
                            - session
                            - package
                            - manual
                          description: A session, a bono sale or a loose concept.
                        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: The session it charges, for kind 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: The bono it charges, for kind package.
                        description:
                          type: string
                          description: The concept, such as the service name.
                        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: Date of the service or sale.
                        currency:
                          type: string
                          description: ISO 4217 code, such as EUR.
                        amount:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                          description: Amount owed, tax included, in cents.
                        collected:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                          description: Collected so far, in cents.
                        pending:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                          description: Left to collect, in cents.
                        settlement:
                          type: string
                          enum:
                            - pending
                            - partial
                            - settled
                          description: >-
                            pending, partial or settled, derived from what was
                            collected.
                        status:
                          type: string
                          enum:
                            - open
                            - voided
                          description: >-
                            voided charges owe nothing (courtesy, recording
                            error, cancelled).
                        voidReason:
                          anyOf:
                            - type: string
                              enum:
                                - courtesy
                                - recording_error
                                - session_cancelled
                                - covered_by_package
                            - type: 'null'
                          description: Why it was voided.
                        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: >-
                            The live invoice that documents it; null while
                            uninvoiced.
                        invoiceNumber:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: That invoice’s number; null for a draft.
                        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, 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: >-
                      Pass it as `cursor` to read the next page; null on the
                      last page.
                  has_more:
                    type: boolean
                required:
                  - data
                  - next_cursor
                  - has_more
                additionalProperties: false
        '401':
          description: Problem Details (RFC 9457) with a stable `code`
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '402':
          description: Problem Details (RFC 9457) with a stable `code`
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: Problem Details (RFC 9457) with a stable `code`
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '422':
          description: Problem Details (RFC 9457) with a stable `code`
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: Problem Details (RFC 9457) with a stable `code`
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '503':
          description: Problem Details (RFC 9457) with a stable `code`
          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: Brelio API key (organization or user) or a WorkOS access token.

````

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