Pular para o conteúdo
MyClinicAPI Docs
POST

/v1/fiscal/documents/{id}/cancel

Cancelar nota autorizada (evento fiscal, nunca exclusão)

Motivo obrigatório (15–255 caracteres). Produção: mesmo portão da emissão + frase exata CANCELAR NOTA <número>. A nota continua no histórico como cancelada e o candidato volta para revisão.

Permissão:fiscal:emitDispara:fiscal.document_cancelled

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 caminho

  • idstringObrigatório

    Id do recurso. · Entre 1 e 64 caracteres · Padrão (regex): ^[A-Za-z0-9._-]+$

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

  • reasonstringObrigatório

    Entre 15 e 255 caracteres

  • phrasestringOpcional

    Frase de confirmação exigida em Produção (exata). · Até 80 caracteres

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/documents/<id>/cancel", {  method: "POST",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "reason": "<reason>",    "phrase": "<phrase>"  }),})​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>",    "candidateId": "<candidateId>",    "batchId": "<batchId>",    "environment": "simulacao",    "environmentLabel": "<environmentLabel>",    "simulated": true,    "generation": 1,    "provider": "<provider>",    "status": "reservada",    "statusLabel": "<statusLabel>",    "series": "<series>",    "number": 1,    "amount": 1,    "serviceKey": "<serviceKey>",    "serviceDate": "<serviceDate>",    "rule": {      "id": "<id>",      "version": 1,      "status": "<status>"    },    "takerName": "<takerName>",    "takerDocMasked": "<takerDocMasked>",    "nfseNumber": "<nfseNumber>",    "verificationCode": "<verificationCode>",    "accessKey": "<accessKey>",    "authorizedAt": "<authorizedAt>",    "providerStatus": "<providerStatus>",    "error": {      "code": "<code>",      "message": "<message>"    }  }}

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

404

Not Found — Recurso não encontrado na clínica ativa.

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)