Pular para o conteúdo
MyClinicAPI Docs
GET

/v1/fiscal/batches

Lotes

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

  • statusstringOpcional

    Valores: rascunho, emitindo, concluido, concluido_com_falhas, interrompido, descartado

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/batches?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>",      "environment": "simulacao",      "environmentLabel": "<environmentLabel>",      "status": "rascunho",      "itemCount": 1,      "total": 1,      "items": [        {          "candidateId": "<candidateId>",          "serviceKey": "<serviceKey>",          "serviceName": "<serviceName>",          "serviceDate": "<serviceDate>",          "amount": 1,          "takerName": "<takerName>",          "takerCpfMasked": "<takerCpfMasked>",          "ruleVersion": 1,          "ruleStatus": "<ruleStatus>"        }      ],      "blocked": [        {          "candidateId": "<candidateId>",          "issues": []        }      ],      "results": {},      "nextNumber": {        "series": "<series>",        "number": 1      },      "confirmationPhrase": "<confirmationPhrase>",      "createdAt": "2026-09-18T14:00:00.000Z",      "confirmedAt": "<confirmedAt>",      "finishedAt": "<finishedAt>"    }  ],  "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)