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
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
nota_idUUID (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
idUUID
empresa_idUUID
origemValores:
notem, externapapelValores:
tomador, intermediarioambienteValores:
homologacao, producaosituacaoValores:
autorizada, cancelamento_em_analise, cancelada, substituida, cancelada_prefeiturarestricoesmanifestacaonumerochave_acesso50 posições; as 14 do CNPJ do emitente podem conter letras · Formato:
^[0-9]{9}[0-9A-Z]{14}[0-9]{27}$serie_dpsSérie da DPS, a declaração que a notem envia ao governo para gerar a nota
numero_dpsNúmero da declaração enviada ao governo (DPS); não é o número da NFS-e, que está em numero
competenciadata AAAA-MM-DD
emitida_emdata e hora ISO 8601
autorizada_emdata e hora ISO 8601
prestadorprestador.cnpjprestador.nomeintermediariointermediario.documentointermediario.nometomadorservicovaloresibs_cbsibs_cbs.classificacaoibs_cbs.classificacao.cstibs_cbs.classificacao.codigoibs_cbs.indicador_operacaoibs_cbs.consumidor_finalibs_cbs.localidade_incidenciaibs_cbs.localidade_incidencia.codigo_municipioibs_cbs.localidade_incidencia.nomeibs_cbs.percentual_redutoribs_cbs.base_calculoibs_cbs.ajuste_base_calculoibs_cbs.ajuste_base_locacao_imoveisibs_cbs.ibs_ufibs_cbs.ibs_uf.aliquotaibs_cbs.ibs_uf.reducao_aliquotaibs_cbs.ibs_uf.aliquota_efetivaibs_cbs.ibs_uf.valoribs_cbs.ibs_uf.diferimentoibs_cbs.ibs_municipalibs_cbs.ibs_municipal.aliquotaibs_cbs.ibs_municipal.reducao_aliquotaibs_cbs.ibs_municipal.aliquota_efetivaibs_cbs.ibs_municipal.valoribs_cbs.ibs_municipal.diferimentoibs_cbs.cbsibs_cbs.cbs.aliquotaibs_cbs.cbs.reducao_aliquotaibs_cbs.cbs.aliquota_efetivaibs_cbs.cbs.valoribs_cbs.cbs.diferimentoibs_cbs.valor_total_ibsibs_cbs.valor_total_ibs_cbsvIBSTot + vCBS
ibs_cbs.valor_total_notavTotNF (valor líquido + IBS/CBS)
ibs_cbs.credito_presumido_ibsibs_cbs.credito_presumido_ibs.percentualibs_cbs.credito_presumido_ibs.valoribs_cbs.credito_presumido_cbsibs_cbs.credito_presumido_cbs.percentualibs_cbs.credito_presumido_cbs.valoribs_cbs.receita_bruta_simplesibs_cbs.versao_calculadoracancelamentolinkslinks.xmlendereço (URL)
links.pdfendereço (URL)
links.consulta_publicacriada_emdata e hora ISO 8601
atualizada_emdata 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.

