Get Invoices

Description

This endpoint allows querying invoices issued in the system. The search can be refined by issue dates, competency, sending, status, types of invoice, linked member, among other filters. The return includes all information of the invoice, including customer, items, taxes, values, and access links to the documents.

NOTE. Available for use with branch access key and also with General ADM access key.

Exclusive endpoint for invoices issued through eNotas in Brazil.

🔑 Query Parameters

This endpoint supports optional filters through query parameters to refine the results.

Parameter	Type	Required	Description
issueDateStart	string(date-time)	No	Start date of the invoice issue in ISO 8601 format (`YYYY-MM-DDTHH:mm:ssZ`).
issueDateEnd	string(date-time)	No	End date of the invoice issue in ISO 8601 format (`YYYY-MM-DDTHH:mm:ssZ`).
competencyDateStart	string(date-time)	No	Start date of the invoice competency in ISO 8601 format (`YYYY-MM-DDTHH:mm:ssZ`).
competencyDateEnd	string(date-time)	No	End date of the invoice competency in ISO 8601 format (`YYYY-MM-DDTHH:mm:ssZ`).
sendDateStart	string(date-time)	No	Start date of the invoice sending in ISO 8601 format (`YYYY-MM-DDTHH:mm:ssZ`).
sendDateEnd	string(date-time)	No	End date of the invoice sending in ISO 8601 format (`YYYY-MM-DDTHH:mm:ssZ`).
take	int32	No	Total number of records to be returned. Default value is `25`. Maximum allowed: `250`.
skip	int32	No	Total number of records to be skipped. Default value is `0`.
idMember	int32	No	ID of the member to be filtered.
statusInvoice	string	No	Filter by the status of the invoice (separated by commas). Values: 1 - Issued, 2 - With error, 3 - Canceled, 4 - Created.
typesInvoice	string	No	Filter by types of invoice (separated by commas). Values: 1 - NFSe, 2 - NFe, 3 - NFCe.
lastDateChangeStart	string(date-time)	No	Filter by the last change of the invoice on the start date in ISO 8601 format (`YYYY-MM-DDTHH:mm:ssZ`).
lastDateChangeEnd	string(date-time)	No	Filter by the last change of the invoice on the end date in ISO 8601 format (`YYYY-MM-DDTHH:mm:ssZ`).
nfNumber	string	No	Filter by the invoice number.
`idBranch`	`int32`	No	Filter by the branch number (only applicable for multi-location keys; ignored otherwise).

📤 Response Structure

The endpoint returns the complete data of an invoice (NFS-e/NF-e/NFC-e) issued by the system, including identification information, status, customer, transport, protocol, items with tax details (ICMS/PIS/COFINS), service data (when applicable), totals, and metadata.

Field	Type	Description
id	string	Unique identifier of the invoice in the system.
tipo	string	Type of invoice (e.g., `NFSe`, `NFe`, `NFCe`).
idExterno	string	External identifier of the invoice, if any.
status	string	Current status of the invoice (e.g., Issued, With error, Canceled).
motivoStatus	string	Detailed reason for the status, if applicable.
ambienteEmissao	string	Emission environment (e.g., Production, Homologation).
enviadaPorEmail	boolean	Indicates if the invoice was sent by email to the customer.
dataCriacao	string (date-time)	Date/time of the invoice record creation.
dataUltimaAlteracao	string (date-time)	Date/time of the last change of the record.
forcarEmissaoContingencia	boolean	Indicates if the emission in contingency was forced.
pedido	object	Information of the order associated with the invoice. See Object `pedido` .
cliente	object	Customer/taker data. See Object `cliente` .
numero	string	Invoice number.
serie	string	Series of the invoice.
dataEmissao	string (date-time)	Date/time of the invoice issuance.
codigoVerificacao	string	Verification code (if applicable, e.g., NFS-e).
chaveAcesso	string	Access key (applicable to NF-e/NFC-e).
transporte	object	Transport/freight data. See Object `transporte` .
dataAutorizacao	string (date-time)	Date/time of the invoice authorization in SEFAZ/municipality.
linkDownloadPDF	string	URL to download the PDF of the invoice/DANFE/DANFSe.
linkDownloadXML	string	URL to download the authorized XML.
linkDanfe	string	Direct URL to the DANFE (if applicable).
linkConsultaPorChaveAcesso	string	Public consultation URL by access key.
protocolo	object	Authorization protocol data. See Object `protocolo` .
emitidaEmContingencia	boolean	Indicates if the invoice was issued in contingency.
itens	array<object>	List of items/services of the invoice. See Invoice Items (`itens[]`).
numeroRps	number	RPS number (only NFS-e).
serieRps	string	RPS series (only NFS-e).
dataCompetenciaRps	string (date-time)	Competency date of the RPS (only NFS-e).
servico	object	Service details (NFS-e). See Object `servico` .
naturezaOperacao	string	Nature of the operation (description).
naturezaOperacaoNfe	string	Nature of the operation used in NF-e.
valorCofins	number	Total value of COFINS.
valorCsll	number	Total value of CSLL.
valorInss	number	Total value of INSS.
valorIr	number	Total value of IR.
valorPis	number	Total value of PIS.
deducoes	number	Total value of deductions.
descontos	number	Total value of discounts.
outrasRetencoes	number	Other applied withholdings.
valorTotal	number	Total value of the invoice.
informacoesAdicionais	string	Additional information printed on the document.
valorIss	number	Total value of ISS.
observacoes	string	Internal/general observations of the invoice.
metadados	object	Key-value object with additional metadata.
tipoNf	string	Type of NF (e.g., entry, exit — as per implementation).
idFilial	int32	ID of the issuing branch in the system.
idRecebimento	int32	ID of the linked receipt, if any.
idVenda	int32	Sale ID in EVO.
numeroNF	string	Fiscal number (may repeat `numero` as per the model).

🧩 Object `pedido`

Field	Type	Description
presencaConsumidor	string	Indicator of the consumer's presence at the time (e.g., in-person, online).
pagamento	object	Payment information. See Object `pedido.pagamento` .
intermediadorTransacao	string	Identification of the intermediary (e.g., gateway/marketplace).

🧩 Object `pedido.pagamento`

Field	Type	Description
tipo	string	Type of payment (e.g., upfront, installment).
formas	array<string>	Payment methods used (e.g., Card, Pix).

🧩 Object `cliente`

Field	Type	Description
idCliente	int32	ID of the customer in the system.
idProspect	int32	ID of the prospect, if applicable.
indicadorContribuinteICMS	string	ICMS contributor indicator.
tipoPessoa	string	Type of person (Individual/Legal Entity).
nome	string	Name/Corporate name of the customer.
email	string	Email of the customer.
cpfCnpj	string	CPF/CNPJ of the customer.
inscricaoMunicipal	string	Municipal registration of the customer.
inscricaoEstadual	string	State registration of the customer.
telefone	string	Phone number of the customer.
endereco	object	Address of the customer. See Object `cliente.endereco` .

🧩 Object `cliente.endereco`

Field	Type	Description
pais	string	Country.
uf	string	State.
cidade	string	City.
logradouro	string	Street.
numero	string	Number.
complemento	string	Complement.
bairro	string	Neighborhood.
cep	string	ZIP Code.

🧩 Object `transporte`

Field	Type	Description
frete	object	Freight data. See Object `transporte.frete` .

🧩 Object `transporte.frete`

Field	Type	Description
modalidade	string	Freight modality (who pays for it).
valor	number	Freight value.

🧩 Object `protocolo`

Field	Type	Description
numero	string	Authorization protocol number.
digestValue	string	Document's authorized Digest.

🧩 Invoice Items (`itens[]`)

Field	Type	Description
cfop	string	CFOP of the item.
codigo	string	Internal/external code of the item.
descricao	string	Description of the item/service.
ncm	string	NCM of the product (if applicable).
cest	string	CEST of the product (if applicable).
extipi	string	EX TIPI (if applicable).
codigoBeneficioFiscal	string	Tax benefit code (UF).
quantidade	number	Quantity of the item.
quantidadeTributavel	number	Taxable quantity.
sku	string	SKU of the item.
unidadeMedida	string	Commercial unit of measure.
unidadeMedidaTributavel	string	Taxable unit of measure.
valorUnitario	number	Unit value.
valorTotal	number	Total value of the item.
descontos	number	Discounts applied to the item.
impostos	object	Tax details. See Object `itens[].impostos` .

🧩 Object `itens[].impostos`

Field	Type	Description
percentualAproximadoTributos	object	Transparency Law information. See `percentualAproximadoTributos.simplificado`.
icms	object	ICMS group. See Object `icms` .
pis	object	PIS group. See Object `pis` .
cofins	object	COFINS group. See Object `cofins` .

🧩 Object `percentualAproximadoTributos.simplificado`

Field	Type	Description
percentual	number	Approximate tax percentage.
valor	number	Approximate tax value.

🧩 Object `icms`

Field	Type	Description
origem	number	Origin of the goods (0–8 according to the table).
situacaoTributaria	string	CST/CSOSN of ICMS.
modalidadeBaseCalculo	number	Calculation base modality.
baseCalculo	number	ICMS calculation base.
aliquota	number	ICMS rate.
percentualReducaoBaseCalculo	number	Reduction of the calculation base (%).
aliquotaST	number	ICMS-ST rate.
modalidadeBaseCalculoST	number	Calculation base modality of ST.
baseCalculoST	number	ICMS-ST calculation base.
percentualReducaoBaseCalculoST	number	Reduction of the ST base (%).
percentualMargemValorAdicionadoST	number	MVA ST (%).

🧩 Object `pis`

Field	Type	Description
situacaoTributaria	string	CST of PIS.

🧩 Object `cofins`

Field	Type	Description
situacaoTributaria	string	CST of COFINS.

🧩 Object `servico` (NFS-e)

Field	Type	Description
descricao	string	Description of the service provided.
aliquotaIss	number	ISS rate.
issRetidoFonte	boolean	Indicates if there is ISS withholding at source.
codigoServicoMunicipio	string	Service code in the municipality.
itemListaServicoLC116	string	Item from the service list (LC 116/2003).
cnae	string	CNAE of the service.
municipioPrestacaoServico	number	Code of the municipality of provision (IBGE).

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

Success

Body

Example

{
    "id": "string",
    "tipo": "string",
    "idExterno": "string",
    "status": "string",
    "motivoStatus": "string",
    "ambienteEmissao": "string",
    "enviadaPorEmail": true,
    "dataCriacao": "2019-08-24T14:15:22.123Z",
    "dataUltimaAlteracao": "2019-08-24T14:15:22.123Z",
    "forcarEmissaoContingencia": true,
    "pedido": {
        "presencaConsumidor": "string",
        "pagamento": {
            "tipo": "string",
            "formas": [
                null
            ]
        },
        "intermediadorTransacao": null
    },
    "cliente": {
        "idCliente": 0,
        "idProspect": 0,
        "idResponsible": 0,
        "idMemberResponsible": 0,
        "cpfResponsible": "string",
        "indicadorContribuinteICMS": "string",
        "tipoPessoa": "string",
        "nome": "string",
        "email": "string",
        "cpfCnpj": "string",
        "inscricaoMunicipal": "string",
        "inscricaoEstadual": "string",
        "telefone": "string",
        "endereco": {
            "pais": "string",
            "uf": "string",
            "cidade": "string",
            "logradouro": "string",
            "numero": "string",
            "complemento": "string",
            "bairro": "string",
            "cep": "string"
        },
        "responsibles": [
            {
                "idResponsible": 0,
                "idMember": 0,
                "name": "string",
                "cpf": "string",
                "email": "string",
                "phone": "string",
                "observation": "string",
                "idMemberResponsible": 0,
                "acessFiti": true,
                "financialResponsible": true,
                "personType": "string",
                "document": "string",
                "cep": "string",
                "adress": "string",
                "number": "string",
                "complement": "string",
                "district": "string",
                "city": "string",
                "state": "string"
            }
        ]
    },
    "numero": "string",
    "serie": "string",
    "dataEmissao": "2019-08-24T14:15:22.123Z",
    "codigoVerificacao": "string",
    "chaveAcesso": "string",
    "transporte": {
        "frete": {
            "modalidade": "string",
            "valor": 0
        }
    },
    "dataAutorizacao": "2019-08-24T14:15:22.123Z",
    "linkDownloadPDF": "string",
    "linkDownloadXML": "string",
    "linkDanfe": "string",
    "linkConsultaPorChaveAcesso": "string",
    "protocolo": {
        "numero": "string",
        "digestValue": "string"
    },
    "emitidaEmContingencia": true,
    "itens": [
        {
            "cfop": "string",
            "codigo": "string",
            "descricao": "string",
            "ncm": "string",
            "cest": "string",
            "extipi": "string",
            "codigoBeneficioFiscal": "string",
            "quantidade": 0,
            "quantidadeTributavel": 0,
            "sku": "string",
            "unidadeMedida": "string",
            "unidadeMedidaTributavel": "string",
            "valorUnitario": 0,
            "valorTotal": 0,
            "descontos": 0,
            "impostos": {
                "percentualAproximadoTributos": {
                    "simplificado": {
                        "percentual": 0,
                        "valor": 0
                    }
                },
                "icms": {
                    "origem": 0,
                    "situacaoTributaria": "string",
                    "modalidadeBaseCalculo": 0,
                    "baseCalculo": 0,
                    "aliquota": 0,
                    "percentualReducaoBaseCalculo": 0,
                    "aliquotaST": 0,
                    "modalidadeBaseCalculoST": 0,
                    "baseCalculoST": 0,
                    "percentualReducaoBaseCalculoST": 0,
                    "percentualMargemValorAdicionadoST": 0
                },
                "pis": {
                    "situacaoTributaria": "string"
                },
                "cofins": {
                    "situacaoTributaria": "string"
                }
            }
        }
    ],
    "numeroRps": 0,
    "serieRps": "string",
    "dataCompetenciaRps": "2019-08-24T14:15:22.123Z",
    "servico": {
        "descricao": "string",
        "aliquotaIss": 0,
        "issRetidoFonte": true,
        "codigoServicoMunicipio": "string",
        "itemListaServicoLC116": "string",
        "cnae": "string",
        "municipioPrestacaoServico": 0
    },
    "naturezaOperacao": "string",
    "naturezaOperacaoNfe": "string",
    "valorCofins": 0,
    "valorCsll": 0,
    "valorInss": 0,
    "valorIr": 0,
    "valorPis": 0,
    "deducoes": 0,
    "descontos": 0,
    "outrasRetencoes": 0,
    "valorTotal": 0,
    "informacoesAdicionais": "string",
    "valorIss": 0,
    "observacoes": "string",
    "metadados": {},
    "tipoNf": "string",
    "idFilial": 0,
    "idRecebimento": 0,
    "idVenda": 0,
    "numeroNF": "string"
}

🟠400

Get invoices by date

Get Invoices#

Description#

🔑 Query Parameters#

📤 Response Structure#

🧩 Object pedido#

🧩 Object pedido.pagamento#

🧩 Object cliente#

🧩 Object cliente.endereco#

🧩 Object transporte#

🧩 Object transporte.frete#

🧩 Object protocolo#

🧩 Invoice Items (itens[])#

🧩 Object itens[].impostos#

🧩 Object percentualAproximadoTributos.simplificado#

🧩 Object icms#

🧩 Object pis#

🧩 Object cofins#

🧩 Object servico (NFS-e)#

Request