Referência da API › Notas
Substituir nota
Emite uma nova nota que corrige e substitui uma nota autorizada.
/api/v1/notas/{id}/substituirUse para corrigir uma nota autorizada sem cancelá-la antes. Envie o motivo, a justificativa e só os campos que mudam; os demais são copiados da nota original. A empresa é sempre a mesma da original.
Antes de gerar o número da nova nota, a notem faz as mesmas conferências da emissão e aplica as regras do governo sobre o que pode mudar. Empresa fora do Simples Nacional não pode mudar competência, código do serviço, código municipal nem local da prestação (E0060). Empresa MEI ou ME/EPP não pode mudar o documento do tomador, a competência nem o valor do serviço (E0061).
As respostas são iguais às de Emitir nota e se referem à nova nota. A original só passa a substituida quando a nova é autorizada. Se a nova for recusada, a original continua valendo.
Parâmetros
idIdempotency-KeyCorpo da requisição
Campos de NotaEntrada são opcionais; os não enviados vêm da nota original. empresa_id, se enviado, deve ser o da original.
motivodesenquadramento_simples, enquadramento_simples, inclusao_imunidade_isencao, exclusao_imunidade_isencao, rejeicao_tomador_intermediario, outrosjustificativaid_externoservico_idservico_id_externocompetenciadescricaotomadortomador.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_idtomador_id_externovaloresretencao_issnao_retido, retido_tomador, retido_intermediarioaliquota_iss_simpleslocal_prestacaolocal_prestacao.codigo_municipio^\d{7}$informacoes_complementaresRespostas
201 Nota substituta autorizada
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 Nota substituta em processamento ou verificação
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 (original não autorizada, pedido ou substituição em andamento) ou IDEMPOTENCIA_CONFLITO
422 REGRA_DE_NEGOCIO (empresa diferente da original, campo que não pode mudar na substituição ou justificativa inválida), EMPRESA_NAO_PRONTA ou REJEITADO_GOVERNO
503 Erro no formato padrão
Limites
Esta operação: 20 por minuto em produção e 10 em homologação; no máximo 2 ao mesmo tempo por empresa. Valem também os limites gerais da chave. Veja Limites de uso.

