Pular para o conteúdo
MyClinicAPI Docs
GET

/v1/fiscal/candidates

Fila de revisão (candidatos a nota)

Cada candidato traz a situação no modo atual e as pendências explícitas (o que falta e onde corrigir). CPF sempre mascarado.

Permissão:fiscal: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

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

Parâmetros

Parâmetros de consulta

  • 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

  • viewstringOpcional

    fila = ainda sem nota no modo atual; emitidas = com nota no modo atual. · Valores: fila, emitidas, ignoradas, todas · Padrão: "fila"

  • fromstringOpcional

    Formato AAAA-MM-DD

  • tostringOpcional

    Formato AAAA-MM-DD

  • qstringOpcional

    Nome do tomador ou serviço. · Até 100 caracteres

Cabeçalhos

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

const res = await fetch("https://myclinc.leadpoint.com.br/v1/fiscal/candidates?limit=25", {  method: "GET",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",  },})​if (!res.ok) {  const { error } = await res.json()  throw new Error(`${error.code}: ${error.message} (${error.requestId})`)}const { data } = await res.json()

Resposta

200OK — Sucesso.
JSON
{  "data": [    {      "id": "<id>",      "source": "atendimento",      "sourceId": "<sourceId>",      "appointmentId": "<appointmentId>",      "transactionId": "<transactionId>",      "patientId": "<patientId>",      "serviceKey": "<serviceKey>",      "serviceName": "<serviceName>",      "serviceDate": "<serviceDate>",      "amount": 1,      "amountSource": "<amountSource>",      "amountConfirmed": true,      "taker": {        "name": "<name>",        "nameSource": "<nameSource>",        "cpfMasked": "<cpfMasked>",        "cpfSource": "<cpfSource>",        "address": {          "street": "<street>",          "number": "<number>",          "complement": "<complement>",          "district": "<district>",          "zip": "<zip>",          "cityIbge": "<cityIbge>",          "cityName": "<cityName>",          "uf": "<uf>"        },        "addressSource": "<addressSource>"      },      "status": "pendente",      "reviewStatus": "<reviewStatus>",      "issues": [        {          "code": "<code>",          "message": "<message>",          "field": "<field>",          "blocks": [],          "blocksCurrentMode": true        }      ],      "ignoredReason": "<ignoredReason>",      "reviewedAt": "<reviewedAt>",      "batchId": "<batchId>",      "documentId": "<documentId>",      "documentStatus": "reservada",      "documents": {        "simulacao": "<simulacao>",        "homologacao": "<homologacao>",        "producao": "<producao>"      },      "capturedAt": "<capturedAt>",      "rawHash": "<rawHash>"    }  ],  "meta": {    "hasNext": true,    "nextCursor": "<nextCursor>",    "total": 1,    "limit": 1  }}

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(abre em nova aba)