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-recebidasAs 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
idEmpresa da organização da chave (de outra organização → 404). UUID (RFC 9562); fora do padrão → 400 REQUISICAO_INVALIDA com campo id. · UUID
limitede 1 a 100 · Padrão:
50cursorsituacaoValores:
autorizada, cancelamento_em_analise, cancelada, substituida, cancelada_prefeituraprestador_cnpjaté 18 caracteres
emitida_dedata AAAA-MM-DD
emitida_atedata AAAA-MM-DD
Respostas
200 Lista paginada
Campos da resposta
dadosdados[].idUUID
dados[].empresa_idUUID
dados[].origemValores:
notem, externadados[].papelValores:
tomador, intermediariodados[].ambienteValores:
homologacao, producaodados[].situacaoValores:
autorizada, 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
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[].prestadordados[].prestador.cnpjdados[].prestador.nomedados[].intermediariodados[].intermediario.documentodados[].intermediario.nomedados[].tomadordados[].servicodados[].valoresdados[].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[].cancelamentodados[].linksdados[].links.xmlendereço (URL)
dados[].links.pdfendereço (URL)
dados[].links.consulta_publicadados[].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
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.

