Pular para o conteúdo
notemnotemDocumentação

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/notas

Use 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

limiteinteirona consulta
de 1 a 100 · Padrão: 50
cursortextona consulta
empresa_idtextona consulta
UUID
empresa_id_externotextona consulta
situacaotextona consulta
Valores: processando, em_verificacao, autorizada, rejeitada, cancelamento_em_analise, cancelada, substituida, cancelada_prefeitura
id_externotextona consulta
tomador_documentotextona consulta
emitida_detextona consulta
data AAAA-MM-DD
emitida_atetextona consulta
data AAAA-MM-DD
origemtextona consulta
notem = emitidas pela notem; externa = emitidas fora da notem por empresas da organização (trazidas pela sincronização) · Valores: notem, externa

Respostas

200 Lista paginada de notas

Campos da resposta
dadoslista de objeto
dados[].idtexto
UUID
dados[].id_externotexto ou null
dados[].origemtexto
externa = emitida por outro sistema ou pelo Portal Nacional; somente leitura (cancelar, solicitar análise e substituir respondem 409 CONFLITO) · Valores: notem, externa
dados[].empresa_idtexto
UUID
dados[].ambientetexto
Valores: homologacao, producao
dados[].situacaotexto
Valores: processando, em_verificacao, autorizada, rejeitada, cancelamento_em_analise, cancelada, substituida, cancelada_prefeitura
dados[].restricoeslista de texto
dados[].manifestacaoobjeto ou null
dados[].numerotexto ou null
dados[].chave_acessotexto ou null
50 posições; as 14 do CNPJ do emitente podem conter letras · Formato: ^[0-9]{9}[0-9A-Z]{14}[0-9]{27}$
dados[].serie_dpstexto
Série da DPS, a declaração que a notem envia ao governo para gerar a nota; atribuída pela notem
dados[].numero_dpstexto
Número da declaração enviada ao governo (DPS); não é o número da NFS-e, que está em numero
dados[].competenciatexto
data AAAA-MM-DD
dados[].emitida_emtexto
data e hora ISO 8601
dados[].autorizada_emtexto ou null
data e hora ISO 8601
dados[].tomadorobjeto ou null
dados[].tomador.idtexto
UUID
dados[].tomador.id_externotexto ou null
Único por empresa · até 100 caracteres
dados[].tomador.tipotexto
Valores: pj, pf, estrangeiro
dados[].tomador.nometexto
1 a 150 caracteres
dados[].tomador.documentotexto ou null
CPF (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.niftexto ou null
até 40 caracteres
dados[].tomador.motivo_sem_niftexto ou null
Valores: dispensado, nao_exigido
dados[].tomador.emailtexto ou null
dados[].tomador.telefonetexto ou null
dados[].tomador.inscricao_municipaltexto ou null
até 15 caracteres
dados[].tomador.enderecoobjeto ou null
Nacional 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.ceptexto
Formato: ^[0-9]{8}$
dados[].tomador.endereco.codigo_municipiotexto
Formato: ^[0-9]{7}$
dados[].tomador.endereco.paistexto
Formato: ^[A-Z]{2}$
dados[].tomador.endereco.cidadetexto
dados[].tomador.endereco.codigo_postaltexto
dados[].tomador.endereco.estado_provincia_regiaotexto
dados[].tomador.endereco.logradourotexto
dados[].tomador.endereco.endereco_livretexto
dados[].tomador.endereco.numerotexto
dados[].tomador.endereco.bairrotexto
dados[].tomador.endereco.complementotexto ou null
dados[].tomador.criada_emtexto
data e hora ISO 8601
dados[].tomador.atualizada_emtexto
data e hora ISO 8601
dados[].servicoobjeto
dados[].servico.servico_idtexto
UUID
dados[].servico.codigo_servicotexto
dados[].servico.descricaotexto
dados[].valoresobjeto
dados[].valores.servicotexto
Valor em reais, ponto decimal, 2 casas · Formato: ^\d+\.\d{2}$
dados[].valores.desconto_incondicionadotexto
Valor em reais, ponto decimal, 2 casas · Formato: ^\d+\.\d{2}$
dados[].valores.desconto_condicionadotexto
Valor em reais, ponto decimal, 2 casas · Formato: ^\d+\.\d{2}$
dados[].valores.base_calculotexto ou null
dados[].valores.aliquota_isstexto ou null
dados[].valores.valor_isstexto ou null
dados[].valores.valor_liquidotexto ou null
dados[].valores.iss_retidobooleano
dados[].local_prestacaoobjeto
dados[].ibs_cbsobjeto ou null
dados[].ibs_cbs.classificacaoobjeto
dados[].ibs_cbs.classificacao.csttexto ou null
dados[].ibs_cbs.classificacao.codigotexto ou null
dados[].ibs_cbs.indicador_operacaotexto ou null
dados[].ibs_cbs.consumidor_finalbooleano
dados[].ibs_cbs.localidade_incidenciaobjeto
dados[].ibs_cbs.localidade_incidencia.codigo_municipiotexto ou null
dados[].ibs_cbs.localidade_incidencia.nometexto ou null
dados[].ibs_cbs.percentual_redutortexto ou null
dados[].ibs_cbs.base_calculotexto ou null
dados[].ibs_cbs.ajuste_base_calculotexto ou null
dados[].ibs_cbs.ajuste_base_locacao_imoveistexto ou null
dados[].ibs_cbs.ibs_ufobjeto
dados[].ibs_cbs.ibs_uf.aliquotatexto ou null
dados[].ibs_cbs.ibs_uf.reducao_aliquotatexto ou null
dados[].ibs_cbs.ibs_uf.aliquota_efetivatexto ou null
dados[].ibs_cbs.ibs_uf.valortexto ou null
dados[].ibs_cbs.ibs_uf.diferimentotexto ou null
dados[].ibs_cbs.ibs_municipalobjeto
dados[].ibs_cbs.ibs_municipal.aliquotatexto ou null
dados[].ibs_cbs.ibs_municipal.reducao_aliquotatexto ou null
dados[].ibs_cbs.ibs_municipal.aliquota_efetivatexto ou null
dados[].ibs_cbs.ibs_municipal.valortexto ou null
dados[].ibs_cbs.ibs_municipal.diferimentotexto ou null
dados[].ibs_cbs.cbsobjeto
dados[].ibs_cbs.cbs.aliquotatexto ou null
dados[].ibs_cbs.cbs.reducao_aliquotatexto ou null
dados[].ibs_cbs.cbs.aliquota_efetivatexto ou null
dados[].ibs_cbs.cbs.valortexto ou null
dados[].ibs_cbs.cbs.diferimentotexto ou null
dados[].ibs_cbs.valor_total_ibstexto ou null
dados[].ibs_cbs.valor_total_ibs_cbstexto ou null
vIBSTot + vCBS
dados[].ibs_cbs.valor_total_notatexto ou null
vTotNF (valor líquido + IBS/CBS)
dados[].ibs_cbs.credito_presumido_ibsobjeto ou null
dados[].ibs_cbs.credito_presumido_ibs.percentualtexto ou null
dados[].ibs_cbs.credito_presumido_ibs.valortexto ou null
dados[].ibs_cbs.credito_presumido_cbsobjeto ou null
dados[].ibs_cbs.credito_presumido_cbs.percentualtexto ou null
dados[].ibs_cbs.credito_presumido_cbs.valortexto ou null
dados[].ibs_cbs.receita_bruta_simplestexto ou null
dados[].ibs_cbs.versao_calculadoratexto ou null
dados[].erros_governolista de objeto
dados[].substitui_nota_idtexto ou null
UUID
dados[].substituida_por_nota_idtexto ou null
UUID
dados[].operacao_pendenteobjeto ou null
Pedido aguardando confirmação do governo; null quando não houver
dados[].operacao_pendente.tipotexto
Valores: cancelamento, analise_cancelamento
dados[].operacao_pendente.estadotexto
Valores: em_verificacao
dados[].operacao_pendente.desdetexto ou null
data e hora ISO 8601
dados[].cancelamentoobjeto ou null
Último pedido de cancelamento ou análise fiscal; null quando nunca houve
dados[].cancelamento.tipotexto
Valores: cancelamento, analise_cancelamento
dados[].cancelamento.motivotexto
Valores: erro_emissao, servico_nao_prestado, outros
dados[].cancelamento.justificativatexto
dados[].cancelamento.solicitado_emtexto ou null
data e hora ISO 8601
dados[].cancelamento.registrado_emtexto ou null
data e hora ISO 8601
dados[].cancelamento.situacaotexto
Valores: em_verificacao, cancelado, em_analise, recusado, nao_registrado, nao_enviado
dados[].cancelamento.pode_solicitar_analisebooleano
dados[].cancelamento.registrado_fora_da_notembooleano
dados[].cancelamento.erros_governolista de objeto
dados[].linksobjeto
dados[].links.xmltexto
endereço (URL)
dados[].links.pdftexto
endereço (URL)
dados[].links.consulta_publicatexto ou null
dados[].criada_emtexto
data e hora ISO 8601
dados[].atualizada_emtexto
data e hora ISO 8601
proximo_cursortexto ou null

400 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.