Esse endpoint permite consultar notas fiscais (Invoices) emitidas no sistema. A busca pode ser refinada por datas de emissão, competência, envio, status, tipos de nota, membro vinculado, entre outros filtros. O retorno traz todas as informações da nota fiscal, incluindo cliente, itens, impostos, valores e links de acesso aos documentos.
Parâmetros de Consulta (Query Parameters)
Este endpoint suporta filtros opcionais através de query parameters para refinar os resultados.
Parâmetro
Tipo
Obrigatório
Descrição
issueDateStart
string(date-time)
Não
Data inicial da emissão da nota fiscal no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).
issueDateEnd
string(date-time)
Não
Data final da emissão da nota fiscal no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).
competencyDateStart
string(date-time)
Não
Data inicial da competência da nota fiscal no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).
competencyDateEnd
string(date-time)
Não
Data final da competência da nota fiscal no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).
sendDateStart
string(date-time)
Não
Data inicial do envio da nota fiscal no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).
sendDateEnd
string(date-time)
Não
Data final do envio da nota fiscal no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).
take
int32
Não
Número total de registros a serem retornados. Valor padrão é 25. Máximo permitido: 250.
skip
int32
Não
Número total de registros a serem ignorados. Valor padrão é 0.
idMember
int32
Não
ID do membro a ser filtrado.
statusInvoice
string
Não
Filtrar pelo status da nota fiscal (separado por vírgula).
Valores: 1 - Emitida, 2 - Com erro, 3 - Cancelada.
typesInvoice
string
Não
Filtrar pelos tipos de nota (separados por vírgula).
Valores: 1 - NFSe, 2 - NFe, 3 - NFCe.
lastDateChangeStart
string(date-time)
Não
Filtrar pela última alteração da fatura na data inicial no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).
lastDateChangeEnd
string(date-time)
Não
Filtrar pela última alteração da fatura na data final no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).
nfNumber
string
Não
Filtra pelo número da nota.
Estrutura da Resposta
O endpoint retorna os dados completos de uma nota fiscal (NFS-e/NF-e/NFC-e) emitida pelo sistema, incluindo informações de identificação, status, cliente, transporte, protocolo, itens com detalhamento fiscal (ICMS/PIS/COFINS), dados de serviço (quando aplicável), totais e metadados.
Campos de nível raiz
Campo
Tipo
Descrição
id
string
Identificador único da nota no sistema.
tipo
string
Tipo de nota (ex.: NFSe, NFe, NFCe).
idExterno
string
Identificador externo da nota, quando houver.
status
string
Status atual da nota (ex.: Emitida, Com erro, Cancelada).
motivoStatus
string
Motivo detalhado do status, quando aplicável.
ambienteEmissao
string
Ambiente de emissão (ex.: Produção, Homologação).
enviadaPorEmail
boolean
Indica se a nota foi enviada por e-mail ao cliente.
dataCriacao
string (date-time)
Data/hora de criação do registro da nota.
dataUltimaAlteracao
string (date-time)
Data/hora da última alteração do registro.
forcarEmissaoContingencia
boolean
Indica se a emissão em contingência foi forçada.
pedido
object
Informações do pedido associado à nota. Ver Objeto pedido.
cliente
object
Dados do cliente/tomador. Ver Objeto cliente.
numero
string
Número da nota.
serie
string
Série da nota.
dataEmissao
string (date-time)
Data/hora de emissão da nota.
codigoVerificacao
string
Código de verificação (quando aplicável, ex. NFS-e).
chaveAcesso
string
Chave de acesso (aplicável a NF-e/NFC-e).
transporte
object
Dados de transporte/frete. Ver Objeto transporte.
dataAutorizacao
string (date-time)
Data/hora de autorização da nota no SEFAZ/município.
linkDownloadPDF
string
URL para download do PDF da nota/DANFE/DANFSe.
linkDownloadXML
string
URL para download do XML autorizado.
linkDanfe
string
URL direto para o DANFE (quando aplicável).
linkConsultaPorChaveAcesso
string
URL de consulta pública pela chave de acesso.
protocolo
object
Dados do protocolo de autorização. Ver Objeto protocolo.
emitidaEmContingencia
boolean
Indica se a nota foi emitida em contingência.
itens
array
Lista de itens/serviços da nota. Ver Itens da nota (itens[]).
numeroRps
number
Número do RPS (apenas NFS-e).
serieRps
string
Série do RPS (apenas NFS-e).
dataCompetenciaRps
string (date-time)
Data de competência do RPS (apenas NFS-e).
servico
object
Detalhes do serviço (NFS-e). Ver Objeto servico.
naturezaOperacao
string
Natureza da operação (descrição).
naturezaOperacaoNfe
string
Natureza da operação utilizada na NF-e.
valorCofins
number
Valor total de COFINS.
valorCsll
number
Valor total de CSLL.
valorInss
number
Valor total de INSS.
valorIr
number
Valor total de IR.
valorPis
number
Valor total de PIS.
deducoes
number
Valor total de deduções.
descontos
number
Valor total de descontos.
outrasRetencoes
number
Outras retenções aplicadas.
valorTotal
number
Valor total da nota.
informacoesAdicionais
string
Informações adicionais/impressas no documento.
valorIss
number
Valor total de ISS.
observacoes
string
Observações internas/gerais da nota.
metadados
object
Objeto chave–valor com metadados adicionais.
tipoNf
string
Tipo de NF (ex.: entrada, saída — conforme implementação).
idFilial
int32
ID da filial emissora no sistema.
idRecebimento
int32
ID do recebimento vinculado, quando existir.
numeroNF
string
Número fiscal (pode repetir numero conforme o modelo).
Objeto pedido
Campo
Tipo
Descrição
presencaConsumidor
string
Indicador de presença do consumidor no ato (ex.: presencial, internet).
pagamento
object
Informações de pagamento. Ver Objeto pedido.pagamento.
intermediadorTransacao
string
Identificação do intermediador (ex.: gateway/marketplace).
Objeto pedido.pagamento
Campo
Tipo
Descrição
tipo
string
Tipo de pagamento (ex.: à vista, a prazo).
formas
array
Formas de pagamento utilizadas (ex.: Cartão, Pix).
Objeto cliente
Campo
Tipo
Descrição
idCliente
int32
ID do cliente no sistema.
idProspect
int32
ID do prospect, se aplicável.
indicadorContribuinteICMS
string
Indicador de contribuinte do ICMS.
tipoPessoa
string
Tipo de pessoa (Física/Jurídica).
nome
string
Nome/Razão social do cliente.
email
string
E-mail do cliente.
cpfCnpj
string
CPF/CNPJ do cliente.
inscricaoMunicipal
string
Inscrição municipal do cliente.
inscricaoEstadual
string
Inscrição estadual do cliente.
telefone
string
Telefone do cliente.
endereco
object
Endereço do cliente. Ver Objeto cliente.endereco.
Objeto cliente.endereco
Campo
Tipo
Descrição
pais
string
País.
uf
string
Unidade federativa/estado.
cidade
string
Cidade.
logradouro
string
Logradouro.
numero
string
Número.
complemento
string
Complemento.
bairro
string
Bairro.
cep
string
CEP.
Objeto transporte
Campo
Tipo
Descrição
frete
object
Dados do frete. Ver Objeto transporte.frete.
Objeto transporte.frete
Campo
Tipo
Descrição
modalidade
string
Modalidade do frete (por conta de quem).
valor
number
Valor do frete.
Objeto protocolo
Campo
Tipo
Descrição
numero
string
Número do protocolo de autorização.
digestValue
string
Digest do documento autorizado.
Itens da nota (itens[])
Campo
Tipo
Descrição
cfop
string
CFOP do item.
codigo
string
Código interno/externo do item.
descricao
string
Descrição do item/serviço.
ncm
string
NCM do produto (quando aplicável).
cest
string
CEST do produto (quando aplicável).
extipi
string
EX TIPI (quando aplicável).
codigoBeneficioFiscal
string
Código de benefício fiscal (UF).
quantidade
number
Quantidade do item.
quantidadeTributavel
number
Quantidade tributável.
sku
string
SKU do item.
unidadeMedida
string
Unidade de medida comercial.
unidadeMedidaTributavel
string
Unidade de medida tributável.
valorUnitario
number
Valor unitário.
valorTotal
number
Valor total do item.
descontos
number
Descontos aplicados ao item.
impostos
object
Detalhes de impostos. Ver Objeto itens[].impostos.
Objeto itens[].impostos
Campo
Tipo
Descrição
percentualAproximadoTributos
object
Informações da Lei da Transparência. Ver percentualAproximadoTributos.simplificado.
icms
object
Grupo de ICMS. Ver Objeto icms.
pis
object
Grupo de PIS. Ver Objeto pis.
cofins
object
Grupo de COFINS. Ver Objeto cofins.
Objeto percentualAproximadoTributos.simplificado
Campo
Tipo
Descrição
percentual
number
Percentual aproximado de tributos.
valor
number
Valor aproximado de tributos.
Objeto icms
Campo
Tipo
Descrição
origem
number
Origem da mercadoria (0–8 conforme tabela).
situacaoTributaria
string
CST/CSOSN do ICMS.
modalidadeBaseCalculo
number
Modalidade da base de cálculo.
baseCalculo
number
Base de cálculo do ICMS.
aliquota
number
Alíquota de ICMS.
percentualReducaoBaseCalculo
number
Redução da base de cálculo (%).
aliquotaST
number
Alíquota do ICMS-ST.
modalidadeBaseCalculoST
number
Modalidade da base de cálculo do ST.
baseCalculoST
number
Base de cálculo do ICMS-ST.
percentualReducaoBaseCalculoST
number
Redução da base do ST (%).
percentualMargemValorAdicionadoST
number
MVA ST (%).
Objeto pis
Campo
Tipo
Descrição
situacaoTributaria
string
CST de PIS.
Objeto cofins
Campo
Tipo
Descrição
situacaoTributaria
string
CST de COFINS.
Objeto servico (NFS-e)
Campo
Tipo
Descrição
descricao
string
Descrição do serviço prestado.
aliquotaIss
number
Alíquota de ISS.
issRetidoFonte
boolean
Indica se há retenção de ISS na fonte.
codigoServicoMunicipio
string
Código do serviço no município.
itemListaServicoLC116
string
Item da lista de serviços (LC 116/2003).
cnae
string
CNAE do serviço.
municipioPrestacaoServico
number
Código do município de prestação (IBGE).
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!