Pular para o conteúdo
notemnotemDocumentação

Referência da API › Notas recebidas

Consultar nota recebida

Devolve uma nota recebida pela empresa.

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

Use para ver os dados de uma nota emitida contra a empresa por outro prestador. Notas recebidas são somente leitura: não podem ser canceladas nem substituídas pela notem.

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
nota_idtextono caminhoobrigatório
UUID (RFC 9562). Fora do padrão: 400 REQUISICAO_INVALIDA com campo igual ao nome do parâmetro. · UUID

Respostas

200 Nota recebida

Campos da resposta
idtexto
UUID
empresa_idtexto
UUID
origemtexto
Valores: notem, externa
papeltexto
Valores: tomador, intermediario
ambientetexto
Valores: homologacao, producao
situacaotexto
Valores: autorizada, cancelamento_em_analise, cancelada, substituida, cancelada_prefeitura
restricoeslista de objeto
manifestacaoobjeto ou null
numerotexto ou null
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}$
serie_dpstexto ou null
Série da DPS, a declaração que a notem envia ao governo para gerar a nota
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
competenciatexto ou null
data AAAA-MM-DD
emitida_emtexto ou null
data e hora ISO 8601
autorizada_emtexto ou null
data e hora ISO 8601
prestadorobjeto
prestador.cnpjtexto ou null
prestador.nometexto ou null
intermediarioobjeto ou null
intermediario.documentotexto
intermediario.nometexto ou null
tomadorobjeto
servicoobjeto
valoresobjeto
ibs_cbsobjeto ou null
ibs_cbs.classificacaoobjeto
ibs_cbs.classificacao.csttexto ou null
ibs_cbs.classificacao.codigotexto ou null
ibs_cbs.indicador_operacaotexto ou null
ibs_cbs.consumidor_finalbooleano
ibs_cbs.localidade_incidenciaobjeto
ibs_cbs.localidade_incidencia.codigo_municipiotexto ou null
ibs_cbs.localidade_incidencia.nometexto ou null
ibs_cbs.percentual_redutortexto ou null
ibs_cbs.base_calculotexto ou null
ibs_cbs.ajuste_base_calculotexto ou null
ibs_cbs.ajuste_base_locacao_imoveistexto ou null
ibs_cbs.ibs_ufobjeto
ibs_cbs.ibs_uf.aliquotatexto ou null
ibs_cbs.ibs_uf.reducao_aliquotatexto ou null
ibs_cbs.ibs_uf.aliquota_efetivatexto ou null
ibs_cbs.ibs_uf.valortexto ou null
ibs_cbs.ibs_uf.diferimentotexto ou null
ibs_cbs.ibs_municipalobjeto
ibs_cbs.ibs_municipal.aliquotatexto ou null
ibs_cbs.ibs_municipal.reducao_aliquotatexto ou null
ibs_cbs.ibs_municipal.aliquota_efetivatexto ou null
ibs_cbs.ibs_municipal.valortexto ou null
ibs_cbs.ibs_municipal.diferimentotexto ou null
ibs_cbs.cbsobjeto
ibs_cbs.cbs.aliquotatexto ou null
ibs_cbs.cbs.reducao_aliquotatexto ou null
ibs_cbs.cbs.aliquota_efetivatexto ou null
ibs_cbs.cbs.valortexto ou null
ibs_cbs.cbs.diferimentotexto ou null
ibs_cbs.valor_total_ibstexto ou null
ibs_cbs.valor_total_ibs_cbstexto ou null
vIBSTot + vCBS
ibs_cbs.valor_total_notatexto ou null
vTotNF (valor líquido + IBS/CBS)
ibs_cbs.credito_presumido_ibsobjeto ou null
ibs_cbs.credito_presumido_ibs.percentualtexto ou null
ibs_cbs.credito_presumido_ibs.valortexto ou null
ibs_cbs.credito_presumido_cbsobjeto ou null
ibs_cbs.credito_presumido_cbs.percentualtexto ou null
ibs_cbs.credito_presumido_cbs.valortexto ou null
ibs_cbs.receita_bruta_simplestexto ou null
ibs_cbs.versao_calculadoratexto ou null
cancelamentoobjeto ou null
linksobjeto
links.xmltexto
endereço (URL)
links.pdftexto
endereço (URL)
links.consulta_publicatexto ou null
criada_emtexto
data e hora ISO 8601
atualizada_emtexto
data 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.