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

# Lista Saldo de Tratamento

> Equivalente ao Relatório de Saldo de Tratamentos.



## OpenAPI

````yaml /openapi/cris-rest.yaml get /listaSaldoTratamento
openapi: 3.1.0
info:
  title: CRIS REST API
  version: 1.0.0
  description: >
    API REST do CRIS (Clínica de Resultado). Use o playground para enviar
    pedidos reais ao ambiente configurado em `servers`.

    Obtenha o token com **loginApi** e utilize-o no campo Bearer (header
    `Authorization`) nos endpoints em `cris.clinicaderesultado.com.br`.

    Operações na tag **Integrações IO** usam o host
    `io.clinicaderesultado.com.br` e autenticação **x-api-key** (não o Bearer do
    login).
servers:
  - url: https://cris.clinicaderesultado.com.br/rest/v1
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Autenticação
    description: Token para os demais endpoints
  - name: Entrada — Atração
    description: Cadastro e atualização de contatos
  - name: Entrada — Conversão e entrega
    description: Agendamentos
  - name: Entrada — Apoio
    description: Campanhas
  - name: Saída — Atração
    description: Lista de prospects e clientes
  - name: Saída — Conversão
    description: Orçamentos e vendas
  - name: Saída — Entrega e retenção
    description: Agendamentos
  - name: Saída — Apoio
    description: Listas de referência (IDs)
  - name: Integrações IO
    description: >-
      Webhooks em io.clinicaderesultado.com.br com header x-api-key (não utiliza
      loginApi / Bearer).
paths:
  /listaSaldoTratamento:
    get:
      tags:
        - Saída — Entrega e retenção
      summary: Lista Saldo de Tratamento
      description: Equivalente ao Relatório de Saldo de Tratamentos.
      operationId: listaSaldoTratamento
      parameters:
        - $ref: '#/components/parameters/PaginaAtual'
        - $ref: '#/components/parameters/PorPagina'
        - $ref: '#/components/parameters/ClinicaMaster'
        - name: cliente
          in: query
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: Lista paginada de saldos do cliente.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SaldoTratamentoResponse'
components:
  parameters:
    PaginaAtual:
      name: pagina_atual
      in: query
      required: true
      schema:
        type: integer
        example: 1
      description: Número da página atual.
    PorPagina:
      name: por_pagina
      in: query
      required: true
      schema:
        type: integer
        example: 20
      description: >-
        Registros por página. Recomenda-se um valor baixo para não sobrecarregar
        a API.
    ClinicaMaster:
      name: clinica
      in: query
      required: true
      schema:
        type: integer
      description: >-
        ID da clínica. Preenchido automaticamente para usuários de clínica.
        Obrigatório para admin_master.
  schemas:
    SaldoTratamentoResponse:
      type: array
      items:
        type: object
        properties:
          error:
            type: integer
            example: 0
          error_msg:
            type: string
            example: ''
          error_type:
            type: string
            example: ''
          data:
            $ref: '#/components/schemas/SaldoData'
          msg:
            type: string
            example: ok
    SaldoData:
      type: object
      properties:
        total_paginas:
          type: integer
          example: 1
        qtd_saldos:
          type: string
          example: '19'
        saldos:
          type: array
          items:
            $ref: '#/components/schemas/Saldo'
    Saldo:
      type: object
      properties:
        cliente_nome:
          type: string
          example: Nome Cliente
        cliente_id:
          type: string
          example: '123456'
        clinica_id:
          type: string
          example: '11'
        clinica_nome:
          type: string
          example: OligoFlora Unidade
        telefone:
          type: string
          example: (00) 0000-0000
        data:
          type: string
          example: 00/00/0000 00:00:00
        categoria:
          type: string
          example: Categoria
        unidade:
          type: string
          example: OligoFlora Unidade
        servico_nome:
          type: string
          example: Nome do Procedimento
        servico_id:
          type: string
          example: '0000'
        qtd_contratada:
          type: integer
          example: 1
        qtd_utilizado:
          type: integer
          example: 1
        qtd_agendado:
          type: integer
          example: 0
        qtd_cancelado:
          type: integer
          example: 0
        qtd_transferido:
          type: integer
          example: 0
        saldo:
          type: integer
          example: 0
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Token retornado por `POST /loginApi` (valor sem prefixo "Bearer" se a
        API esperar só o token; caso contrário inclua conforme o CRIS).

````