Referência da API › Notas
Cancelar nota
Pede ao governo o cancelamento de uma nota autorizada e devolve a nota cancelada ou o motivo da recusa.
/api/v1/notas/{id}/cancelarUse quando a nota foi emitida por engano ou o serviço não foi prestado. Só é possível cancelar nota autorizada, emitida pela notem no ambiente da chave, e cada nota aceita um pedido por vez. Informe o motivo e uma justificativa de 15 a 255 caracteres.
O que esperar: 200 com a nota cancelada; 422 REJEITADO_GOVERNO quando o governo recusa, com o motivo original e uma explicação em português; 202 quando o governo ainda não confirmou. No caso do 202, a nota continua autorizada, com operacao_pendente preenchido, até a notem descobrir o resultado e avisar por webhook.
Alguns municípios não permitem cancelar diretamente, por exemplo depois do prazo ou acima de um valor. Nesses casos a recusa vem com pode_solicitar_analise: true, e você pode pedir que a prefeitura analise o cancelamento em Solicitar análise do cancelamento.
O cabeçalho Idempotency-Key é obrigatório. Repetir o pedido com a mesma chave é seguro: devolve o mesmo resultado, sem enviar outro pedido ao governo.
Se a nota já tiver sido cancelada por outro caminho, como o Portal Nacional, a notem encontra o cancelamento no governo, marca a nota como cancelada e responde 200. O histórico da nota mostra "Cancelamento registrado fora da notem".
Parâmetros
idIdempotency-KeyCorpo da requisição
motivoerro_emissao, servico_nao_prestado, outrosjustificativaRespostas
200 Cancelamento registrado; nota com situacao cancelada
Campos da resposta
idid_externoorigemnotem, externaempresa_idambientehomologacao, producaosituacaoprocessando, em_verificacao, autorizada, rejeitada, cancelamento_em_analise, cancelada, substituida, cancelada_prefeiturarestricoesmanifestacaonumerochave_acesso^[0-9]{9}[0-9A-Z]{14}[0-9]{27}$serie_dpsnumero_dpscompetenciaemitida_emautorizada_emtomadortomador.idtomador.id_externotomador.tipopj, pf, estrangeirotomador.nometomador.documentotomador.niftomador.motivo_sem_nifdispensado, nao_exigidotomador.emailtomador.telefonetomador.inscricao_municipaltomador.enderecotomador.endereco.cep^[0-9]{8}$tomador.endereco.codigo_municipio^[0-9]{7}$tomador.endereco.pais^[A-Z]{2}$tomador.endereco.cidadetomador.endereco.codigo_postaltomador.endereco.estado_provincia_regiaotomador.endereco.logradourotomador.endereco.endereco_livretomador.endereco.numerotomador.endereco.bairrotomador.endereco.complementotomador.criada_emtomador.atualizada_emservicoservico.servico_idservico.codigo_servicoservico.descricaovaloresvalores.servico^\d+\.\d{2}$valores.desconto_incondicionado^\d+\.\d{2}$valores.desconto_condicionado^\d+\.\d{2}$valores.base_calculovalores.aliquota_issvalores.valor_issvalores.valor_liquidovalores.iss_retidolocal_prestacaoibs_cbsibs_cbs.classificacaoibs_cbs.classificacao.cstibs_cbs.classificacao.codigoibs_cbs.indicador_operacaoibs_cbs.consumidor_finalibs_cbs.localidade_incidenciaibs_cbs.localidade_incidencia.codigo_municipioibs_cbs.localidade_incidencia.nomeibs_cbs.percentual_redutoribs_cbs.base_calculoibs_cbs.ajuste_base_calculoibs_cbs.ajuste_base_locacao_imoveisibs_cbs.ibs_ufibs_cbs.ibs_uf.aliquotaibs_cbs.ibs_uf.reducao_aliquotaibs_cbs.ibs_uf.aliquota_efetivaibs_cbs.ibs_uf.valoribs_cbs.ibs_uf.diferimentoibs_cbs.ibs_municipalibs_cbs.ibs_municipal.aliquotaibs_cbs.ibs_municipal.reducao_aliquotaibs_cbs.ibs_municipal.aliquota_efetivaibs_cbs.ibs_municipal.valoribs_cbs.ibs_municipal.diferimentoibs_cbs.cbsibs_cbs.cbs.aliquotaibs_cbs.cbs.reducao_aliquotaibs_cbs.cbs.aliquota_efetivaibs_cbs.cbs.valoribs_cbs.cbs.diferimentoibs_cbs.valor_total_ibsibs_cbs.valor_total_ibs_cbsibs_cbs.valor_total_notaibs_cbs.credito_presumido_ibsibs_cbs.credito_presumido_ibs.percentualibs_cbs.credito_presumido_ibs.valoribs_cbs.credito_presumido_cbsibs_cbs.credito_presumido_cbs.percentualibs_cbs.credito_presumido_cbs.valoribs_cbs.receita_bruta_simplesibs_cbs.versao_calculadoraerros_governosubstitui_nota_idsubstituida_por_nota_idoperacao_pendenteoperacao_pendente.tipocancelamento, analise_cancelamentooperacao_pendente.estadoem_verificacaooperacao_pendente.desdecancelamentocancelamento.tipocancelamento, analise_cancelamentocancelamento.motivoerro_emissao, servico_nao_prestado, outroscancelamento.justificativacancelamento.solicitado_emcancelamento.registrado_emcancelamento.situacaoem_verificacao, cancelado, em_analise, recusado, nao_registrado, nao_enviadocancelamento.pode_solicitar_analisecancelamento.registrado_fora_da_notemcancelamento.erros_governolinkslinks.xmllinks.pdflinks.consulta_publicacriada_ematualizada_em202 Aguardando confirmação do governo; nota segue autorizada com operacao_pendente
Campos da resposta
idid_externoorigemnotem, externaempresa_idambientehomologacao, producaosituacaoprocessando, em_verificacao, autorizada, rejeitada, cancelamento_em_analise, cancelada, substituida, cancelada_prefeiturarestricoesmanifestacaonumerochave_acesso^[0-9]{9}[0-9A-Z]{14}[0-9]{27}$serie_dpsnumero_dpscompetenciaemitida_emautorizada_emtomadortomador.idtomador.id_externotomador.tipopj, pf, estrangeirotomador.nometomador.documentotomador.niftomador.motivo_sem_nifdispensado, nao_exigidotomador.emailtomador.telefonetomador.inscricao_municipaltomador.enderecotomador.endereco.cep^[0-9]{8}$tomador.endereco.codigo_municipio^[0-9]{7}$tomador.endereco.pais^[A-Z]{2}$tomador.endereco.cidadetomador.endereco.codigo_postaltomador.endereco.estado_provincia_regiaotomador.endereco.logradourotomador.endereco.endereco_livretomador.endereco.numerotomador.endereco.bairrotomador.endereco.complementotomador.criada_emtomador.atualizada_emservicoservico.servico_idservico.codigo_servicoservico.descricaovaloresvalores.servico^\d+\.\d{2}$valores.desconto_incondicionado^\d+\.\d{2}$valores.desconto_condicionado^\d+\.\d{2}$valores.base_calculovalores.aliquota_issvalores.valor_issvalores.valor_liquidovalores.iss_retidolocal_prestacaoibs_cbsibs_cbs.classificacaoibs_cbs.classificacao.cstibs_cbs.classificacao.codigoibs_cbs.indicador_operacaoibs_cbs.consumidor_finalibs_cbs.localidade_incidenciaibs_cbs.localidade_incidencia.codigo_municipioibs_cbs.localidade_incidencia.nomeibs_cbs.percentual_redutoribs_cbs.base_calculoibs_cbs.ajuste_base_calculoibs_cbs.ajuste_base_locacao_imoveisibs_cbs.ibs_ufibs_cbs.ibs_uf.aliquotaibs_cbs.ibs_uf.reducao_aliquotaibs_cbs.ibs_uf.aliquota_efetivaibs_cbs.ibs_uf.valoribs_cbs.ibs_uf.diferimentoibs_cbs.ibs_municipalibs_cbs.ibs_municipal.aliquotaibs_cbs.ibs_municipal.reducao_aliquotaibs_cbs.ibs_municipal.aliquota_efetivaibs_cbs.ibs_municipal.valoribs_cbs.ibs_municipal.diferimentoibs_cbs.cbsibs_cbs.cbs.aliquotaibs_cbs.cbs.reducao_aliquotaibs_cbs.cbs.aliquota_efetivaibs_cbs.cbs.valoribs_cbs.cbs.diferimentoibs_cbs.valor_total_ibsibs_cbs.valor_total_ibs_cbsibs_cbs.valor_total_notaibs_cbs.credito_presumido_ibsibs_cbs.credito_presumido_ibs.percentualibs_cbs.credito_presumido_ibs.valoribs_cbs.credito_presumido_cbsibs_cbs.credito_presumido_cbs.percentualibs_cbs.credito_presumido_cbs.valoribs_cbs.receita_bruta_simplesibs_cbs.versao_calculadoraerros_governosubstitui_nota_idsubstituida_por_nota_idoperacao_pendenteoperacao_pendente.tipocancelamento, analise_cancelamentooperacao_pendente.estadoem_verificacaooperacao_pendente.desdecancelamentocancelamento.tipocancelamento, analise_cancelamentocancelamento.motivoerro_emissao, servico_nao_prestado, outroscancelamento.justificativacancelamento.solicitado_emcancelamento.registrado_emcancelamento.situacaoem_verificacao, cancelado, em_analise, recusado, nao_registrado, nao_enviadocancelamento.pode_solicitar_analisecancelamento.registrado_fora_da_notemcancelamento.erros_governolinkslinks.xmllinks.pdflinks.consulta_publicacriada_ematualizada_em400 Erro no formato padrão
401 Chave ausente, inválida ou revogada
404 Erro no formato padrão
409 CONFLITO (nota não autorizada, pedido ou substituição em andamento) ou IDEMPOTENCIA_CONFLITO
422 REGRA_DE_NEGOCIO (justificativa, certificado), EMPRESA_NAO_PRONTA ou REJEITADO_GOVERNO
503 Erro no formato padrão
Limites
Esta operação: 10 por minuto; 1 de cada vez por nota. Valem também os limites gerais da chave. Veja Limites de uso.

