Pular para o conteúdo
notemnotemDocumentação

Referência da API › Notas recebidas

Listar notas recebidas

Lista as notas em que a empresa aparece como cliente (tomadora) ou intermediária.

GET/api/v1/empresas/{id}/notas-recebidas

As notas vêm do governo pela sincronização feita no painel. A lista é paginada e segue o ambiente da chave.

Por segurança, a lista só fica disponível para empresas que já tiveram certificado digital cadastrado nesta organização. O certificado comprova que a organização representa a empresa.

Parâmetros

idtextono caminhoobrigatório
Empresa da organização da chave (de outra organização → 404). UUID (RFC 9562); fora do padrão → 400 REQUISICAO_INVALIDA com campo id. · UUID
limiteinteirona consulta
de 1 a 100 · Padrão: 50
cursortextona consulta
situacaotextona consulta
Valores: autorizada, cancelamento_em_analise, cancelada, substituida, cancelada_prefeitura
prestador_cnpjtextona consulta
até 18 caracteres
emitida_detextona consulta
data AAAA-MM-DD
emitida_atetextona consulta
data AAAA-MM-DD

Respostas

200 Lista paginada

Campos da resposta
dadoslista de objeto
dados[].idtexto
UUID
dados[].empresa_idtexto
UUID
dados[].origemtexto
Valores: notem, externa
dados[].papeltexto
Valores: tomador, intermediario
dados[].ambientetexto
Valores: homologacao, producao
dados[].situacaotexto
Valores: autorizada, cancelamento_em_analise, cancelada, substituida, cancelada_prefeitura
dados[].restricoeslista de objeto
dados[].manifestacaoobjeto ou null
dados[].numerotexto ou null
dados[].chave_acessotexto
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 ou null
Série da DPS, a declaração que a notem envia ao governo para gerar a nota
dados[].numero_dpstexto ou null
Número da declaração enviada ao governo (DPS); não é o número da NFS-e, que está em numero
dados[].competenciatexto ou null
data AAAA-MM-DD
dados[].emitida_emtexto ou null
data e hora ISO 8601
dados[].autorizada_emtexto ou null
data e hora ISO 8601
dados[].prestadorobjeto
dados[].prestador.cnpjtexto ou null
dados[].prestador.nometexto ou null
dados[].intermediarioobjeto ou null
dados[].intermediario.documentotexto
dados[].intermediario.nometexto ou null
dados[].tomadorobjeto
dados[].servicoobjeto
dados[].valoresobjeto
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[].cancelamentoobjeto ou null
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

404 Erro no formato padrão

Limites

Esta operação: 60 por minuto. Valem também os limites gerais da chave. Veja Limites de uso.