GET

/v1/finance/transactions

Transações (receitas e despesas)

Permissão:finance:read

Autenticação

Envie o token de acesso do usuário no cabeçalho Authorization e, se ele tiver mais de uma clínica, o X-Clinic-Id. Integrações servidor a servidor usam o token de serviço com X-Clinic-Id e X-Agent-Key. Como autenticar

1Authorization: Bearer <TOKEN>2X-Clinic-Id: <clinic_id>

Parâmetros

Parâmetros de consulta

Parâmetros de consulta
Parâmetro	Tipo	Obrigatório	Descrição
`limit`	integer	Não	Itens por página (1–100). · Padrão: `25` · Entre 1 e 100
`cursor`	string	Não	Cursor opaco recebido em meta.nextCursor. · Até 200 caracteres
`page`	integer	Não	Paginação numerada (tabelas): página 1-based, offset = (page − 1) × limit. Ignorado quando há `cursor`. Listas longas/feeds devem usar `cursor`. · Entre 1 e 200
`sort`	string	Não	Ordenação: campos separados por vírgula, prefixo "-" = decrescente. Permitidos: occurredAt, amount, dueDate, createdAt. Padrão: -occurredAt. · Até 120 caracteres
`type`	string	Não	Valores: `receita`, `despesa`
`status`	string	Não	Status separados por vírgula: recebido, pago, a-receber, a-pagar, atrasado, estornado.
`method`	string	Não	Formas de pagamento separadas por vírgula.
`from`	string	Não	Formato `AAAA-MM-DD`
`to`	string	Não	Formato `AAAA-MM-DD`
`service`	string	Não	service_keys separados por vírgula.
`patientId`	string	Não	Entre 1 e 64 caracteres · Padrão (regex): `^[A-Za-z0-9._-]+$`
`professional`	string	Não	professional_keys separados por vírgula.
`includeReversed`	boolean	Não	Inclui estornadas. Padrão: não (a menos que status peça "estornado"). · Padrão: `false`
`q`	string	Não	Descrição ou paciente/fornecedor. · Até 100 caracteres

limitintegerOpcional
Itens por página (1–100). · Padrão: 25 · Entre 1 e 100
cursorstringOpcional
Cursor opaco recebido em meta.nextCursor. · Até 200 caracteres
pageintegerOpcional
Paginação numerada (tabelas): página 1-based, offset = (page − 1) × limit. Ignorado quando há cursor. Listas longas/feeds devem usar cursor. · Entre 1 e 200
sortstringOpcional
Ordenação: campos separados por vírgula, prefixo "-" = decrescente. Permitidos: occurredAt, amount, dueDate, createdAt. Padrão: -occurredAt. · Até 120 caracteres
typestringOpcional
Valores: receita, despesa
statusstringOpcional
Status separados por vírgula: recebido, pago, a-receber, a-pagar, atrasado, estornado.
methodstringOpcional
Formas de pagamento separadas por vírgula.
fromstringOpcional
Formato AAAA-MM-DD
tostringOpcional
Formato AAAA-MM-DD
servicestringOpcional
service_keys separados por vírgula.
patientIdstringOpcional
Entre 1 e 64 caracteres · Padrão (regex): ^[A-Za-z0-9._-]+$
professionalstringOpcional
professional_keys separados por vírgula.
includeReversedbooleanOpcional
Inclui estornadas. Padrão: não (a menos que status peça "estornado"). · Padrão: false
qstringOpcional
Descrição ou paciente/fornecedor. · Até 100 caracteres

Cabeçalhos

Cabeçalhos
Parâmetro	Tipo	Obrigatório	Descrição
`X-Clinic-Id`	string	Não	Clínica ativa. Obrigatório só para quem tem acesso a mais de uma clínica (ou token de serviço). Validado contra o vínculo do usuário. · Padrão (regex): `^[A-Za-z0-9._-]{1,64}$`

X-Clinic-IdstringOpcional
Clínica ativa. Obrigatório só para quem tem acesso a mais de uma clínica (ou token de serviço). Validado contra o vínculo do usuário. · Padrão (regex): ^[A-Za-z0-9._-]{1,64}$

Exemplo de requisição

Gerado do contrato. Troque os marcadores entre < > pelos seus valores.

1const res = await fetch("https://myclinc.leadpoint.com.br/v1/finance/transactions?limit=25", {2  method: "GET",3  headers: {4    Authorization: "Bearer <TOKEN>",5    "X-Clinic-Id": "<clinic_id>",6  },7})89if (!res.ok) {10  const { error } = await res.json()11  throw new Error(`${error.code}: ${error.message} (${error.requestId})`)12}13const { data } = await res.json()

Resposta

200OK — Sucesso.

JSON

1{2  "data": [3    {4      "id": "<id>",5      "date": "2026-09-18",6      "time": "14:30",7      "occurredAt": "2026-09-18T14:00:00.000Z",8      "description": "<description>",9      "party": "<party>",10      "patientId": "<patientId>",11      "type": "receita",12      "amount": 1,13      "status": "recebido",14      "statusLabel": "<statusLabel>",15      "method": "<method>",16      "dueDate": "2026-09-18",17      "paidAt": "2026-09-18T14:00:00.000Z",18      "service": {19        "key": "<key>",20        "name": "<name>"21      },22      "professional": {23        "key": "<key>",24        "name": "<name>"25      },26      "appointmentId": "<appointmentId>",27      "agent": {28        "key": "<key>",29        "name": "<name>",30        "image": "<image>",31        "state": "executado",32        "action": "<action>",33        "at": "2026-09-18T14:00:00.000Z"34      },35      "reversedFrom": "<reversedFrom>",36      "category": "aluguel"37    }38  ],39  "meta": {40    "hasNext": true,41    "nextCursor": "<nextCursor>",42    "total": 1,43    "limit": 144  }45}

Exemplo gerado do esquema da resposta; valores entre < > são ilustrativos.

Códigos de erro

Corpo no formato padrão { error: { code, message, requestId } }. Veja todos os códigos.

400

Bad Request — Requisição malformada (JSON inválido, cursor inválido ou clínica ativa não informada).

401

Unauthorized — Token ausente, inválido ou expirado.

403

Forbidden — Autenticado, mas sem permissão (perfil ou clínica).

422

Unprocessable Entity — Dados semanticamente inválidos (erros por campo em details).

429

Too Many Requests — Limite de requisições excedido (veja Retry-After).

500

Internal Server Error — Erro interno (sem detalhes expostos).

503

Service Unavailable — Banco de dados indisponível ou não configurado.

Limites

Limite padrão: 120 requisições a cada 60 segundos por token. Sobre limites

Testar no Swagger