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

# Patient balance

> Returns a patient's balance: what they owe, what they paid, unapplied credit and what is still uninvoiced.

**When to use it:** To answer «does this patient owe anything?». Debt and credit are reported apart, never netted. Amounts are in cents.


## OpenAPI

````yaml /api-reference/openapi.en.json get /balances/{id}
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:
  /balances/{id}:
    get:
      tags:
        - Billing
      summary: Patient balance
      description: >-
        Returns a patient's balance: what they owe, what they paid, unapplied
        credit and what is still uninvoiced.


        **When to use it:** To answer «does this patient owe anything?». Debt
        and credit are reported apart, never netted. Amounts are in cents.
      operationId: balances.get
      parameters:
        - name: id
          in: path
          required: true
          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: The patient id.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                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)$
                    description: The patient id.
                  pending:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: Owed on open charges, in cents.
                  received:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: Money received, net of corrections, in cents.
                  credit:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: Money received and not applied to any charge, in cents.
                  uninvoiced:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: >-
                      Total of open charges that no invoice documents yet,
                      collected or not, in cents.
                  currency:
                    type: string
                    description: ISO 4217 code, such as EUR.
                required:
                  - id
                  - pending
                  - received
                  - credit
                  - uninvoiced
                  - currency
                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.