Referência da API › Notas
Listar notas
Lista as notas da organização no ambiente da chave, da mais recente para a mais antiga.
GET
/api/v1/notasUse para acompanhar as notas emitidas ou montar relatórios. A lista é paginada e aceita filtros por empresa, situação, tomador e período de emissão.
Inclui também as notas que as empresas da organização emitiram fora da notem, por outro sistema ou pelo Portal Nacional. Elas aparecem depois da sincronização com o governo e vêm com origem: externa.
Parâmetros
limitede 1 a 100 · Padrão:
50cursorempresa_idUUID
empresa_id_externosituacaoValores:
processando, em_verificacao, autorizada, rejeitada, cancelamento_em_analise, cancelada, substituida, cancelada_prefeituraid_externotomador_documentoemitida_dedata AAAA-MM-DD
emitida_atedata AAAA-MM-DD
origemnotem = emitidas pela notem; externa = emitidas fora da notem por empresas da organização (trazidas pela sincronização) · Valores:
notem, externaRespostas
200 Lista paginada de notas
Campos da resposta
dadosdados[].idUUID
dados[].id_externodados[].origemexterna = emitida por outro sistema ou pelo Portal Nacional; somente leitura (cancelar, solicitar análise e substituir respondem 409 CONFLITO) · Valores:
notem, externadados[].empresa_idUUID
dados[].ambienteValores:
homologacao, producaodados[].situacaoValores:
processando, em_verificacao, autorizada, rejeitada, cancelamento_em_analise, cancelada, substituida, cancelada_prefeituradados[].restricoesdados[].manifestacaodados[].numerodados[].chave_acesso50 posições; as 14 do CNPJ do emitente podem conter letras · Formato:
^[0-9]{9}[0-9A-Z]{14}[0-9]{27}$dados[].serie_dpsSérie da DPS, a declaração que a notem envia ao governo para gerar a nota; atribuída pela notem
dados[].numero_dpsNúmero da declaração enviada ao governo (DPS); não é o número da NFS-e, que está em numero
dados[].competenciadata AAAA-MM-DD
dados[].emitida_emdata e hora ISO 8601
dados[].autorizada_emdata e hora ISO 8601
dados[].tomadordados[].tomador.idUUID
dados[].tomador.id_externoÚnico por empresa · até 100 caracteres
dados[].tomador.tipoValores:
pj, pf, estrangeirodados[].tomador.nome1 a 150 caracteres
dados[].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
dados[].tomador.nifaté 40 caracteres
dados[].tomador.motivo_sem_nifValores:
dispensado, nao_exigidodados[].tomador.emaildados[].tomador.telefonedados[].tomador.inscricao_municipalaté 15 caracteres
dados[].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.
dados[].tomador.endereco.cepFormato:
^[0-9]{8}$dados[].tomador.endereco.codigo_municipioFormato:
^[0-9]{7}$dados[].tomador.endereco.paisFormato:
^[A-Z]{2}$dados[].tomador.endereco.cidadedados[].tomador.endereco.codigo_postaldados[].tomador.endereco.estado_provincia_regiaodados[].tomador.endereco.logradourodados[].tomador.endereco.endereco_livredados[].tomador.endereco.numerodados[].tomador.endereco.bairrodados[].tomador.endereco.complementodados[].tomador.criada_emdata e hora ISO 8601
dados[].tomador.atualizada_emdata e hora ISO 8601
dados[].servicodados[].servico.servico_idUUID
dados[].servico.codigo_servicodados[].servico.descricaodados[].valoresdados[].valores.servicoValor em reais, ponto decimal, 2 casas · Formato:
^\d+\.\d{2}$dados[].valores.desconto_incondicionadoValor em reais, ponto decimal, 2 casas · Formato:
^\d+\.\d{2}$dados[].valores.desconto_condicionadoValor em reais, ponto decimal, 2 casas · Formato:
^\d+\.\d{2}$dados[].valores.base_calculodados[].valores.aliquota_issdados[].valores.valor_issdados[].valores.valor_liquidodados[].valores.iss_retidodados[].local_prestacaodados[].ibs_cbsdados[].ibs_cbs.classificacaodados[].ibs_cbs.classificacao.cstdados[].ibs_cbs.classificacao.codigodados[].ibs_cbs.indicador_operacaodados[].ibs_cbs.consumidor_finaldados[].ibs_cbs.localidade_incidenciadados[].ibs_cbs.localidade_incidencia.codigo_municipiodados[].ibs_cbs.localidade_incidencia.nomedados[].ibs_cbs.percentual_redutordados[].ibs_cbs.base_calculodados[].ibs_cbs.ajuste_base_calculodados[].ibs_cbs.ajuste_base_locacao_imoveisdados[].ibs_cbs.ibs_ufdados[].ibs_cbs.ibs_uf.aliquotadados[].ibs_cbs.ibs_uf.reducao_aliquotadados[].ibs_cbs.ibs_uf.aliquota_efetivadados[].ibs_cbs.ibs_uf.valordados[].ibs_cbs.ibs_uf.diferimentodados[].ibs_cbs.ibs_municipaldados[].ibs_cbs.ibs_municipal.aliquotadados[].ibs_cbs.ibs_municipal.reducao_aliquotadados[].ibs_cbs.ibs_municipal.aliquota_efetivadados[].ibs_cbs.ibs_municipal.valordados[].ibs_cbs.ibs_municipal.diferimentodados[].ibs_cbs.cbsdados[].ibs_cbs.cbs.aliquotadados[].ibs_cbs.cbs.reducao_aliquotadados[].ibs_cbs.cbs.aliquota_efetivadados[].ibs_cbs.cbs.valordados[].ibs_cbs.cbs.diferimentodados[].ibs_cbs.valor_total_ibsdados[].ibs_cbs.valor_total_ibs_cbsvIBSTot + vCBS
dados[].ibs_cbs.valor_total_notavTotNF (valor líquido + IBS/CBS)
dados[].ibs_cbs.credito_presumido_ibsdados[].ibs_cbs.credito_presumido_ibs.percentualdados[].ibs_cbs.credito_presumido_ibs.valordados[].ibs_cbs.credito_presumido_cbsdados[].ibs_cbs.credito_presumido_cbs.percentualdados[].ibs_cbs.credito_presumido_cbs.valordados[].ibs_cbs.receita_bruta_simplesdados[].ibs_cbs.versao_calculadoradados[].erros_governodados[].substitui_nota_idUUID
dados[].substituida_por_nota_idUUID
dados[].operacao_pendentePedido aguardando confirmação do governo; null quando não houver
dados[].operacao_pendente.tipoValores:
cancelamento, analise_cancelamentodados[].operacao_pendente.estadoValores:
em_verificacaodados[].operacao_pendente.desdedata e hora ISO 8601
dados[].cancelamentoÚltimo pedido de cancelamento ou análise fiscal; null quando nunca houve
dados[].cancelamento.tipoValores:
cancelamento, analise_cancelamentodados[].cancelamento.motivoValores:
erro_emissao, servico_nao_prestado, outrosdados[].cancelamento.justificativadados[].cancelamento.solicitado_emdata e hora ISO 8601
dados[].cancelamento.registrado_emdata e hora ISO 8601
dados[].cancelamento.situacaoValores:
em_verificacao, cancelado, em_analise, recusado, nao_registrado, nao_enviadodados[].cancelamento.pode_solicitar_analisedados[].cancelamento.registrado_fora_da_notemdados[].cancelamento.erros_governodados[].linksdados[].links.xmlendereço (URL)
dados[].links.pdfendereço (URL)
dados[].links.consulta_publicahttps://www.nfse.gov.br/ConsultaPublica?tpc=1&chave={chave_acesso}; null somente sem chave válida
dados[].criada_emdata e hora ISO 8601
dados[].atualizada_emdata e hora ISO 8601
proximo_cursor400 Erro no formato padrão
401 Chave ausente, inválida ou revogada
Limites
Esta operação: 60 por minuto. Valem também os limites gerais da chave. Veja Limites de uso.

