Referência da API › Notas
Consultar nota
Devolve a nota completa, com situação, valores, tomador e links do XML e do PDF.
GET
/api/v1/notas/{id}Use para acompanhar uma nota depois da emissão, principalmente quando a emissão respondeu 202 ou quando a conexão caiu antes da resposta.
A nota só é encontrada com uma chave da mesma organização e do mesmo ambiente em que foi emitida. Com outra chave, a resposta é 404.
Parâmetros
idUUID (RFC 9562). Fora do padrão: 400 REQUISICAO_INVALIDA com campo igual ao nome do parâmetro. · UUID
Respostas
200 Nota completa
Campos da resposta
idUUID
id_externoorigemexterna = emitida por outro sistema ou pelo Portal Nacional; somente leitura (cancelar, solicitar análise e substituir respondem 409 CONFLITO) · Valores:
notem, externaempresa_idUUID
ambienteValores:
homologacao, producaosituacaoValores:
processando, em_verificacao, autorizada, rejeitada, cancelamento_em_analise, cancelada, substituida, cancelada_prefeiturarestricoesmanifestacaonumerochave_acesso50 posições; as 14 do CNPJ do emitente podem conter letras · Formato:
^[0-9]{9}[0-9A-Z]{14}[0-9]{27}$serie_dpsSérie da DPS, a declaração que a notem envia ao governo para gerar a nota; atribuída pela notem
numero_dpsNúmero da declaração enviada ao governo (DPS); não é o número da NFS-e, que está em numero
competenciadata AAAA-MM-DD
emitida_emdata e hora ISO 8601
autorizada_emdata e hora ISO 8601
tomadortomador.idUUID
tomador.id_externoÚnico por empresa · até 100 caracteres
tomador.tipoValores:
pj, pf, estrangeirotomador.nome1 a 150 caracteres
tomador.documentoCPF (11 números) ou CNPJ (14 posições, numérico ou alfanumérico) com dígitos verificadores válidos; máscara e minúsculas são normalizadas · até 18 caracteres
tomador.nifaté 40 caracteres
tomador.motivo_sem_nifValores:
dispensado, nao_exigidotomador.emailtomador.telefonetomador.inscricao_municipalaté 15 caracteres
tomador.enderecoNacional exige CEP/logradouro/número/bairro/IBGE. Exterior exige país/cidade/código postal/província/logradouro ou endereço livre/número/bairro. Complemento opcional.
tomador.endereco.cepFormato:
^[0-9]{8}$tomador.endereco.codigo_municipioFormato:
^[0-9]{7}$tomador.endereco.paisFormato:
^[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_emdata e hora ISO 8601
tomador.atualizada_emdata e hora ISO 8601
servicoservico.servico_idUUID
servico.codigo_servicoservico.descricaovaloresvalores.servicoValor em reais, ponto decimal, 2 casas · Formato:
^\d+\.\d{2}$valores.desconto_incondicionadoValor em reais, ponto decimal, 2 casas · Formato:
^\d+\.\d{2}$valores.desconto_condicionadoValor em reais, ponto decimal, 2 casas · Formato:
^\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_cbsvIBSTot + vCBS
ibs_cbs.valor_total_notavTotNF (valor líquido + IBS/CBS)
ibs_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_idUUID
substituida_por_nota_idUUID
operacao_pendentePedido aguardando confirmação do governo; null quando não houver
operacao_pendente.tipoValores:
cancelamento, analise_cancelamentooperacao_pendente.estadoValores:
em_verificacaooperacao_pendente.desdedata e hora ISO 8601
cancelamentoÚltimo pedido de cancelamento ou análise fiscal; null quando nunca houve
cancelamento.tipoValores:
cancelamento, analise_cancelamentocancelamento.motivoValores:
erro_emissao, servico_nao_prestado, outroscancelamento.justificativacancelamento.solicitado_emdata e hora ISO 8601
cancelamento.registrado_emdata e hora ISO 8601
cancelamento.situacaoValores:
em_verificacao, cancelado, em_analise, recusado, nao_registrado, nao_enviadocancelamento.pode_solicitar_analisecancelamento.registrado_fora_da_notemcancelamento.erros_governolinkslinks.xmlendereço (URL)
links.pdfendereço (URL)
links.consulta_publicahttps://www.nfse.gov.br/ConsultaPublica?tpc=1&chave={chave_acesso}; null somente sem chave válida
criada_emdata e hora ISO 8601
atualizada_emdata e hora ISO 8601
401 Chave ausente, inválida ou revogada
404 Erro no formato padrão
Limites
Valem também os limites gerais da chave. Veja Limites de uso.

