POST/nfse/cancelar/{idNota}

Solicitar cancelamento da nota

Realiza uma solicitação de cancelamento de NFS-e por ID. Observações: - Somente é possível cancelar uma nota com situação CONCLUIDO. - Quando um cancelamento ocorrer com sucesso, o WEBHOOK será acionado, e o status da nota será atualizado para CANCELADO. - Algumas prefeituras solicitam que seja enviado um código de cancelamento no body da requisição. Para validar como isto pode ser realizado, acesse: *NFSe Nacional* - Para solicitar um cancelamento de uma nota do ambiente Nacional, é possível utilizar os seguintes códigos: - `1` - Erro na Emissão `2` - Serviço não Prestado `9` - Outros Obs.: Por default, para a NFSe Nacional será utilizado o código 9 e o motivo será 'Cancelamento a pedido do Prestador'

Produção: https://api.otentecnologia.com.brSandbox: https://api.sandbox.otentecnologia.com.br

Parâmetros

Esta rota não possui parâmetros de path ou query.

Requisição

cURL

curl -X POST 'https://api.otentecnologia.com.br/nfse/cancelar/{idNota}' \
  -H 'x-api-key: $OTEN_API_KEY' \
  -H 'Content-Type: application/json'

Respostas

200OK

JSON

{
  "message": "Cancelamento em processamento",
  "data": {
    "protocol": "888738ef-e738-427f-a391-44ea7b497644"
  }
}

400Bad Request

JSON

{
  "error": {
    "message": "A ação de Cancelar NFSe é permitida apenas para notas com status CONCLUIDO",
    "data": {
      "id": "0000000000",
      "idIntegracao": "XXXYY999",
      "status": "PROCESSANDO"
    }
  }
}

401Unauthorized

JSON

{
  "error": {
    "message": "O token informado é inválido. Para o ambiente de produção, Acesse https://www.otentecnologia.com.br/, e gere o seu TOKEN de acesso"
  }
}

404Not Found

JSON

{
  "error": {
    "message": "Não localizamos qualquer NFSe com os parâmetros informados",
    "data": {
      "id": "0000000000"
    }
  }
}