Get invoices by date

Permite obter notas fiscais por data.

Obter Notas Fiscais

Descrição

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âmetroTipoObrigatórioDescrição
issueDateStartstring(date-time)NãoData inicial da emissão da nota fiscal no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).
issueDateEndstring(date-time)NãoData final da emissão da nota fiscal no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).
competencyDateStartstring(date-time)NãoData inicial da competência da nota fiscal no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).
competencyDateEndstring(date-time)NãoData final da competência da nota fiscal no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).
sendDateStartstring(date-time)NãoData inicial do envio da nota fiscal no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).
sendDateEndstring(date-time)NãoData final do envio da nota fiscal no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).
takeint32NãoNúmero total de registros a serem retornados. Valor padrão é 25. Máximo permitido: 250.
skipint32NãoNúmero total de registros a serem ignorados. Valor padrão é 0.
idMemberint32NãoID do membro a ser filtrado.
statusInvoicestringNãoFiltrar pelo status da nota fiscal (separado por vírgula).
Valores: 1 - Emitida, 2 - Com erro, 3 - Cancelada.
typesInvoicestringNãoFiltrar pelos tipos de nota (separados por vírgula).
Valores: 1 - NFSe, 2 - NFe, 3 - NFCe.
lastDateChangeStartstring(date-time)NãoFiltrar pela última alteração da fatura na data inicial no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).
lastDateChangeEndstring(date-time)NãoFiltrar pela última alteração da fatura na data final no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).
nfNumberstringNãoFiltra 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

CampoTipoDescrição
idstringIdentificador único da nota no sistema.
tipostringTipo de nota (ex.: NFSe, NFe, NFCe).
idExternostringIdentificador externo da nota, quando houver.
statusstringStatus atual da nota (ex.: Emitida, Com erro, Cancelada).
motivoStatusstringMotivo detalhado do status, quando aplicável.
ambienteEmissaostringAmbiente de emissão (ex.: Produção, Homologação).
enviadaPorEmailbooleanIndica se a nota foi enviada por e-mail ao cliente.
dataCriacaostring (date-time)Data/hora de criação do registro da nota.
dataUltimaAlteracaostring (date-time)Data/hora da última alteração do registro.
forcarEmissaoContingenciabooleanIndica se a emissão em contingência foi forçada.
pedidoobjectInformações do pedido associado à nota. Ver Objeto pedido.
clienteobjectDados do cliente/tomador. Ver Objeto cliente.
numerostringNúmero da nota.
seriestringSérie da nota.
dataEmissaostring (date-time)Data/hora de emissão da nota.
codigoVerificacaostringCódigo de verificação (quando aplicável, ex. NFS-e).
chaveAcessostringChave de acesso (aplicável a NF-e/NFC-e).
transporteobjectDados de transporte/frete. Ver Objeto transporte.
dataAutorizacaostring (date-time)Data/hora de autorização da nota no SEFAZ/município.
linkDownloadPDFstringURL para download do PDF da nota/DANFE/DANFSe.
linkDownloadXMLstringURL para download do XML autorizado.
linkDanfestringURL direto para o DANFE (quando aplicável).
linkConsultaPorChaveAcessostringURL de consulta pública pela chave de acesso.
protocoloobjectDados do protocolo de autorização. Ver Objeto protocolo.
emitidaEmContingenciabooleanIndica se a nota foi emitida em contingência.
itensarrayLista de itens/serviços da nota. Ver Itens da nota (itens[]).
numeroRpsnumberNúmero do RPS (apenas NFS-e).
serieRpsstringSérie do RPS (apenas NFS-e).
dataCompetenciaRpsstring (date-time)Data de competência do RPS (apenas NFS-e).
servicoobjectDetalhes do serviço (NFS-e). Ver Objeto servico.
naturezaOperacaostringNatureza da operação (descrição).
naturezaOperacaoNfestringNatureza da operação utilizada na NF-e.
valorCofinsnumberValor total de COFINS.
valorCsllnumberValor total de CSLL.
valorInssnumberValor total de INSS.
valorIrnumberValor total de IR.
valorPisnumberValor total de PIS.
deducoesnumberValor total de deduções.
descontosnumberValor total de descontos.
outrasRetencoesnumberOutras retenções aplicadas.
valorTotalnumberValor total da nota.
informacoesAdicionaisstringInformações adicionais/impressas no documento.
valorIssnumberValor total de ISS.
observacoesstringObservações internas/gerais da nota.
metadadosobjectObjeto chave–valor com metadados adicionais.
tipoNfstringTipo de NF (ex.: entrada, saída — conforme implementação).
idFilialint32ID da filial emissora no sistema.
idRecebimentoint32ID do recebimento vinculado, quando existir.
numeroNFstringNúmero fiscal (pode repetir numero conforme o modelo).

Objeto pedido

CampoTipoDescrição
presencaConsumidorstringIndicador de presença do consumidor no ato (ex.: presencial, internet).
pagamentoobjectInformações de pagamento. Ver Objeto pedido.pagamento.
intermediadorTransacaostringIdentificação do intermediador (ex.: gateway/marketplace).

Objeto pedido.pagamento

CampoTipoDescrição
tipostringTipo de pagamento (ex.: à vista, a prazo).
formasarrayFormas de pagamento utilizadas (ex.: Cartão, Pix).

Objeto cliente

CampoTipoDescrição
idClienteint32ID do cliente no sistema.
idProspectint32ID do prospect, se aplicável.
indicadorContribuinteICMSstringIndicador de contribuinte do ICMS.
tipoPessoastringTipo de pessoa (Física/Jurídica).
nomestringNome/Razão social do cliente.
emailstringE-mail do cliente.
cpfCnpjstringCPF/CNPJ do cliente.
inscricaoMunicipalstringInscrição municipal do cliente.
inscricaoEstadualstringInscrição estadual do cliente.
telefonestringTelefone do cliente.
enderecoobjectEndereço do cliente. Ver Objeto cliente.endereco.

Objeto cliente.endereco

CampoTipoDescrição
paisstringPaís.
ufstringUnidade federativa/estado.
cidadestringCidade.
logradourostringLogradouro.
numerostringNúmero.
complementostringComplemento.
bairrostringBairro.
cepstringCEP.

Objeto transporte

CampoTipoDescrição
freteobjectDados do frete. Ver Objeto transporte.frete.

Objeto transporte.frete

CampoTipoDescrição
modalidadestringModalidade do frete (por conta de quem).
valornumberValor do frete.

Objeto protocolo

CampoTipoDescrição
numerostringNúmero do protocolo de autorização.
digestValuestringDigest do documento autorizado.

Itens da nota (itens[])

CampoTipoDescrição
cfopstringCFOP do item.
codigostringCódigo interno/externo do item.
descricaostringDescrição do item/serviço.
ncmstringNCM do produto (quando aplicável).
ceststringCEST do produto (quando aplicável).
extipistringEX TIPI (quando aplicável).
codigoBeneficioFiscalstringCódigo de benefício fiscal (UF).
quantidadenumberQuantidade do item.
quantidadeTributavelnumberQuantidade tributável.
skustringSKU do item.
unidadeMedidastringUnidade de medida comercial.
unidadeMedidaTributavelstringUnidade de medida tributável.
valorUnitarionumberValor unitário.
valorTotalnumberValor total do item.
descontosnumberDescontos aplicados ao item.
impostosobjectDetalhes de impostos. Ver Objeto itens[].impostos.

Objeto itens[].impostos

CampoTipoDescrição
percentualAproximadoTributosobjectInformações da Lei da Transparência. Ver percentualAproximadoTributos.simplificado.
icmsobjectGrupo de ICMS. Ver Objeto icms.
pisobjectGrupo de PIS. Ver Objeto pis.
cofinsobjectGrupo de COFINS. Ver Objeto cofins.

Objeto percentualAproximadoTributos.simplificado

CampoTipoDescrição
percentualnumberPercentual aproximado de tributos.
valornumberValor aproximado de tributos.

Objeto icms

CampoTipoDescrição
origemnumberOrigem da mercadoria (0–8 conforme tabela).
situacaoTributariastringCST/CSOSN do ICMS.
modalidadeBaseCalculonumberModalidade da base de cálculo.
baseCalculonumberBase de cálculo do ICMS.
aliquotanumberAlíquota de ICMS.
percentualReducaoBaseCalculonumberRedução da base de cálculo (%).
aliquotaSTnumberAlíquota do ICMS-ST.
modalidadeBaseCalculoSTnumberModalidade da base de cálculo do ST.
baseCalculoSTnumberBase de cálculo do ICMS-ST.
percentualReducaoBaseCalculoSTnumberRedução da base do ST (%).
percentualMargemValorAdicionadoSTnumberMVA ST (%).

Objeto pis

CampoTipoDescrição
situacaoTributariastringCST de PIS.

Objeto cofins

CampoTipoDescrição
situacaoTributariastringCST de COFINS.

Objeto servico (NFS-e)

CampoTipoDescrição
descricaostringDescrição do serviço prestado.
aliquotaIssnumberAlíquota de ISS.
issRetidoFontebooleanIndica se há retenção de ISS na fonte.
codigoServicoMunicipiostringCódigo do serviço no município.
itemListaServicoLC116stringItem da lista de serviços (LC 116/2003).
cnaestringCNAE do serviço.
municipioPrestacaoServiconumberCódigo do município de prestação (IBGE).
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!