Pular para o conteúdo
MyClinicAPI Docs
POST

/v1/fiscal/batches

Montar lote com prévia (nada é emitido)

Valida de novo cada candidato (inclusive a origem: atendimento ainda realizado, pagamento não estornado) e congela a prévia: itens, quantidade, valor, ambiente e próximo número. Candidatos com pendência ficam de fora, com o motivo. Máximo 50 por lote. O modo precisa estar liberado (409 com os bloqueios).

Permissão:fiscal:emit

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

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}$

Corpo da requisição

application/json · obrigatório

  • candidateIdsstring[]Obrigatório

    De 1 a 50 itens · Cada item: entre 1 e 64 caracteres, padrão (regex): ^[A-Za-z0-9._-]+$

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", {  method: "POST",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "candidateIds": [      "<candidateId>"    ]  }),})​if (!res.ok) {  const { error } = await res.json()  throw new Error(`${error.code}: ${error.message} (${error.requestId})`)}const { data } = await res.json()

Resposta

201Created — 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>"  }}

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

409

Conflict — Conflito de estado (duplicidade, transição inválida, conflito de agenda).

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)