GET/nfse/cancelar/status/{cancellationProtocol}

Check a cancellation request

Returns the status of a cancellation request. Watch the status field: CONCLUIDO on success, REJEITADO on failure. Notes: - In this context, status refers to the cancellation request, not the invoice status. - After success, the webhook fires and the invoice status becomes CANCELADO. - Some cities do not allow cancellation via webservice.

Production: https://api.otentecnologia.com.brSandbox: https://api.sandbox.otentecnologia.com.br

Parameters

cancellationProtocol

path · required

Cancellation request protocol, returned in the NFS-e cancellation response.

Request

cURL

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

Responses

200OK

JSON

{
  "message": "Solicitação de cancelamento processada",
  "data": {
    "response": "Cancelamento de NFS-e Homologado",
    "date": "2020-12-01T15:37:10.914Z",
    "protocol": "3f7799c7-44d7-a996-b43992",
    "status": "CONCLUIDO"
  }
}

201Created

JSON

{
  "message": "Cancelamento em processamento, aguarde alguns minutos e tente novamente."
}

400Bad Request

JSON

{
  "error": {
    "message": "Cancelamento de NFSe via WebService não suportado para o município RIOBRANCOAC.",
    "data": {}
  }
}

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 Solicitação de Cancelamento com os parâmetros informados",
    "data": {
      "protocol": "0000000000"
    }
  }
}