Através do serviço de cancelamento de NF3-e é possível cancelar uma NF3-e previamente autorizada através da API.
Obs.: O cancelamento de NF3-e possui regras e prazos definidos pela Secretaria da Fazenda que devem ser consideradas e respeitadas. Para maiores informações clique aqui e verifique a versão mais atualizada o Manual de Orientações do Contribuinte da Sefaz.
URL
Produção: POST https://nf3e.ns.eti.br/v1/nf3e/cancel
Dados de entrada
Campo | Descrição | Observação |
---|---|---|
X-AUTH-TOKEN | Token de acesso do usuário | |
chNF3e | Chave de acesso da NF3-e | |
tpAmb | Tipo do ambiente de autorização do NF3-e 1 - Produção 2 - Homologação | |
dhEvento | Data e hora da ocorrência do cancelamento | Padrão Sefaz AAAA-MM-DDTHH:MM:SS + UTC Ex.: 2016-06-13T15:04:10-02:00 |
nProt | Número do protocolo de autorização do NF3e-e | |
xJust | Descrição literal do motivo de cancelamento da NF3-e | Mínimo 15 caracteres (não há restrições da API quanto a caracteres especiais) |
Exemplo de requisição
Requisição de cancelamento de NF3-e
curl -X POST \
-H "Content-Type: application/json" \
-d '{"chNF3e": "11111111111111111111111111111111111111111111", "tpAmb": 2, "dhEvento": "2021-02-22T10:26:00-03:00", "nProt": "111111111111111", "xJust": "teste de integração"}'\
https://nf3e.ns.eti.br/v1/nf3e/cancel
Dados retornados
Campo | Descrição | Tipo | Pai | Observação |
---|---|---|---|---|
status | Código de status do processamento | N | ||
motivo | Descrição literal do status de processamento | A | ||
retEvento | Objeto contendo os dados de processamento do cancelamento na Sefaz | O | Somente em status = 200 | |
cStat | Código de situação do processamento | C | retEvento | |
xMotivo | Descrição literal da situação do processamento na Sefaz | A | retEvento | |
idEvento | Id do evento gerado | N | retEvento | |
chNF3e | Chave de acesso do NF3-e | N | retEvento | Somente em cStat = 135 |
dhRegEvento | Data e hora de registro do evento na Sefaz | D | retEvento | Padrão Sefaz AAAA-MM-DDTHH:MM:SS + UTC Ex.: 2016-06-13T15:04:10-03:00 Somente em cStat = 135 |
nProt | Número do protocolo de autorização do evento | N | retEvento | Somente em cStat = 135 |
xml | XML de distribuição do evento de cancelamento | S | retEvento | Somente em cStat = 135 |
erro | Objeto contendo as informações de erro caso o cancelamento não possa ser realizado com sucesso | O | Somente em status diferente de 200 | |
cStat | Código de status do erro | N | erro | |
xMotivo | Descrição literal do erro | A | erro |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "NF3e cancelado com sucesso",
"retEvento": {
"cStat": "135",
"xMotivo": "Evento registrado e vinculado a NF3e ",
"idEvento": "11011111111111111111111111111111111111111111111111",
"chNF3e": "11111111111111111111111111111111111111111111",
"dhRegEvento": "2021-02-25T17:56:36-03:00",
"nProt": "111111111111111",
"xml": "<procEventoNF3e>... </procEventoNF3e>"
}
}
Códigos de retorno
Código | Descrição |
---|---|
200 | NF3-e cancelada com sucesso |
-2 | Chave de acesso inválida |
-3 | Não foi possível cancelar a NF3-e Verifique o objeto erro para maiores informações |
-4 | Problema com certificado digital Verifique o objeto erro para maiores informações |
-5 | Evento inválido de acordo com a validação contra schema |
Download do Cancelamento de NF3-e
Você pode fazer o download das informações completas de distribuição do cancelamento em XML ou JSON e também de uma representação gráfica do mesmo em formato PDF. Para isso confira o método Download de Evento na NS NF3-e API.