Obtener Facturas (Notas Fiscales)

Descripción

Este endpoint permite consultar facturas (Invoices) emitidas en el sistema. La búsqueda puede filtrarse por fechas de emisión, competencia, envío, estado, tipos de factura, miembro vinculado, entre otros filtros. La respuesta incluye toda la información de la factura, incluyendo cliente, ítems, impuestos, valores y enlaces de acceso a los documentos.

🔑 Parámetros de Consulta (Query Params)

Parámetro	Tipo	Obligatorio	Descripción
`issueDateStart`	string(date-time)	No	Fecha inicial de emisión de la factura en formato ISO 8601 (`YYYY-MM-DDTHH:mm:ssZ`).
`issueDateEnd`	string(date-time)	No	Fecha final de emisión de la factura en formato ISO 8601 (`YYYY-MM-DDTHH:mm:ssZ`).
`competencyDateStart`	string(date-time)	No	Fecha inicial de la competencia de la factura en formato ISO 8601 (`YYYY-MM-DDTHH:mm:ssZ`).
`competencyDateEnd`	string(date-time)	No	Fecha final de la competencia de la factura en formato ISO 8601 (`YYYY-MM-DDTHH:mm:ssZ`).
`sendDateStart`	string(date-time)	No	Fecha inicial de envío de la factura en formato ISO 8601 (`YYYY-MM-DDTHH:mm:ssZ`).
`sendDateEnd`	string(date-time)	No	Fecha final de envío de la factura en formato ISO 8601 (`YYYY-MM-DDTHH:mm:ssZ`).
`take`	int32	No	Número total de registros a devolver. Valor por defecto: `25`. Máximo permitido: `250`.
`skip`	int32	No	Número total de registros a omitir. Valor por defecto: `0`.
`idMember`	int32	No	ID del miembro a filtrar.
`statusInvoice`	string	No	Filtrar por estado de la factura (separado por comas). Valores: 1 - Emitida, 2 - Con error, 3 - Cancelada, 4 - Creada.
`typesInvoice`	string	No	Filtrar por tipos de factura (separado por comas). Valores: 1 - NFSe, 2 - NFe, 3 - NFCe.
`lastDateChangeStart`	string(date-time)	No	Filtrar por última modificación de la factura desde la fecha inicial en formato ISO 8601.
`lastDateChangeEnd`	string(date-time)	No	Filtrar por última modificación de la factura hasta la fecha final en formato ISO 8601.
`nfNumber`	string	No	Filtrar por número de la factura.

📤 Estructura de la Respuesta

El endpoint devuelve los datos completos de una factura (NFS-e/NF-e/NFC-e) emitida por el sistema, incluyendo información de identificación, estado, cliente, transporte, protocolo, ítems con detalle fiscal (ICMS/PIS/COFINS), datos de servicio (cuando aplica), totales y metadatos.

Campo	Tipo	Descripción
`id`	string	Identificador único de la factura en el sistema.
`tipo`	string	Tipo de factura (ej.: `NFSe`, `NFe`, `NFCe`).
`idExterno`	string	Identificador externo de la factura, si existe.
`status`	string	Estado actual de la factura (ej.: Emitida, Con error, Cancelada).
`motivoStatus`	string	Motivo detallado del estado, cuando aplica.
`ambienteEmissao`	string	Ambiente de emisión (ej.: Producción, Homologación).
`enviadaPorEmail`	boolean	Indica si la factura fue enviada por correo al cliente.
`dataCriacao`	string(date-time)	Fecha/hora de creación del registro de la factura.
`dataUltimaAlteracao`	string(date-time)	Fecha/hora de la última modificación del registro.
`forcarEmissaoContingencia`	boolean	Indica si la emisión en contingencia fue forzada.
`pedido`	object	Información del pedido asociado a la factura. Ver Objeto `pedido`.
`cliente`	object	Datos del cliente/tomador. Ver Objeto `cliente`.
`numero`	string	Número de la factura.
`serie`	string	Serie de la factura.
`dataEmissao`	string(date-time)	Fecha/hora de emisión de la factura.
`codigoVerificacao`	string	Código de verificación (cuando aplica, ej. NFS-e).
`chaveAcesso`	string	Clave de acceso (aplicable a NF-e/NFC-e).
`transporte`	object	Datos de transporte/flete. Ver Objeto `transporte`.
`dataAutorizacao`	string(date-time)	Fecha/hora de autorización en SEFAZ/municipio.
`linkDownloadPDF`	string	URL para descargar el PDF de la factura/DANFE/DANFSe.
`linkDownloadXML`	string	URL para descargar el XML autorizado.
`linkDanfe`	string	URL directa al DANFE (cuando aplica).
`linkConsultaPorChaveAcesso`	string	URL de consulta pública mediante la clave de acceso.
`protocolo`	object	Datos del protocolo de autorización. Ver Objeto `protocolo`.
`emitidaEmContingencia`	boolean	Indica si la factura fue emitida en contingencia.
`itens`	array	Lista de ítems/servicios de la factura. Ver Ítems de la factura (`itens[]`).
`numeroRps`	number	Número del RPS (solo NFS-e).
`serieRps`	string	Serie del RPS (solo NFS-e).
`dataCompetenciaRps`	string(date-time)	Fecha de competencia del RPS (solo NFS-e).
`servico`	object	Detalles del servicio (NFS-e). Ver Objeto `servico`.
`naturezaOperacao`	string	Naturaleza de la operación (descripción).
`naturezaOperacaoNfe`	string	Naturaleza de la operación utilizada en la 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 deducciones.
`descontos`	number	Valor total de descuentos.
`outrasRetencoes`	number	Otras retenciones aplicadas.
`valorTotal`	number	Valor total de la factura.
`informacoesAdicionais`	string	Información adicional impresa en el documento.
`valorIss`	number	Valor total de ISS.
`observacoes`	string	Observaciones internas/generales de la factura.
`metadados`	object	Objeto clave–valor con metadatos adicionales.
`tipoNf`	string	Tipo de NF (ej.: entrada, salida — según implementación).
`idFilial`	int32	ID de la sucursal emisora en el sistema.
`idRecebimento`	int32	ID del recibo vinculado, cuando exista.
`numeroNF`	string	Número fiscal (puede repetir `numero` según el modelo).

🧩 Objeto `pedido`

Campo	Tipo	Descripción
presencaConsumidor	string	Indicador de presencia del consumidor en el acto (ej.: presencial, internet).
pagamento	object	Información de pago. Ver Objeto `pedido.pagamento`.
intermediadorTransacao	string	Identificación del intermediario (ej.: gateway/marketplace).

🧩 Objeto `pedido.pagamento`

Campo	Tipo	Descripción
tipo	string	Tipo de pago (ej.: al contado, a plazos).
formas	array	Formas de pago utilizadas (ej.: Tarjeta, Pix).

🧩 Objeto `cliente`

Campo	Tipo	Descripción
idCliente	int32	ID del cliente en el sistema.
idProspect	int32	ID del prospecto, si aplica.
indicadorContribuinteICMS	string	Indicador de contribuyente del ICMS.
tipoPessoa	string	Tipo de persona (Física/Jurídica).
nome	string	Nombre/Razón social del cliente.
email	string	Correo electrónico del cliente.
cpfCnpj	string	CPF/CNPJ del cliente.
inscricaoMunicipal	string	Registro municipal del cliente.
inscricaoEstadual	string	Registro estatal del cliente.
telefone	string	Teléfono del cliente.
endereco	object	Dirección del cliente. Ver Objeto `cliente.endereco`.

🧩 Objeto `cliente.endereco`

Campo	Tipo	Descripción
pais	string	País.
uf	string	Estado/Unidad federativa.
cidade	string	Ciudad.
logradouro	string	Calle/Dirección.
numero	string	Número.
complemento	string	Complemento.
bairro	string	Barrio.
cep	string	Código postal (CEP).

🧩 Objeto `transporte`

Campo	Tipo	Descripción
frete	object	Información del flete. Ver Objeto `transporte.frete`.

🧩 Objeto `transporte.frete`

Campo	Tipo	Descripción
modalidade	string	Modalidad del flete (a cargo de quién).
valor	number	Valor del flete.

🧩 Objeto `protocolo`

Campo	Tipo	Descripción
numero	string	Número del protocolo de autorización.
digestValue	string	Digest del documento autorizado.

🧩 Ítems de la factura (`itens[]`)

Campo	Tipo	Descripción
cfop	string	CFOP del ítem.
codigo	string	Código interno/externo del ítem.
descricao	string	Descripción del ítem/servicio.
ncm	string	NCM del producto (cuando aplica).
cest	string	CEST del producto (cuando aplica).
extipi	string	EX TIPI (cuando aplica).
codigoBeneficioFiscal	string	Código de beneficio fiscal (UF).
quantidade	number	Cantidad del ítem.
quantidadeTributavel	number	Cantidad sujeta a impuestos.
sku	string	SKU del ítem.
unidadeMedida	string	Unidad de medida comercial.
unidadeMedidaTributavel	string	Unidad de medida tributaria.
valorUnitario	number	Valor unitario.
valorTotal	number	Valor total del ítem.
descontos	number	Descuentos aplicados al ítem.
impostos	object	Detalle de impuestos. Ver Objeto `itens[].impostos`.

🧩 Objeto `itens[].impostos`

Campo	Tipo	Descripción
percentualAproximadoTributos	object	Información de la Ley de Transparencia. Ver `percentualAproximadoTributos.simplificado`.
icms	object	Grupo ICMS. Ver Objeto `icms`.
pis	object	Grupo PIS. Ver Objeto `pis`.
cofins	object	Grupo COFINS. Ver Objeto `cofins`.

🧩 Objeto `percentualAproximadoTributos.simplificado`

Campo	Tipo	Descripción
percentual	number	Porcentaje aproximado de impuestos.
valor	number	Valor aproximado de impuestos.

🧩 Objeto `icms`

Campo	Tipo	Descripción
origem	number	Origen de la mercadería (0–8 según tabla).
situacaoTributaria	string	CST/CSOSN del ICMS.
modalidadeBaseCalculo	number	Modalidad de la base de cálculo.
baseCalculo	number	Base de cálculo del ICMS.
aliquota	number	Alícuota del ICMS.
percentualReducaoBaseCalculo	number	Reducción de la base de cálculo (%).
aliquotaST	number	Alícuota del ICMS-ST.
modalidadeBaseCalculoST	number	Modalidad de la base de cálculo del ST.
baseCalculoST	number	Base de cálculo del ICMS-ST.
percentualReducaoBaseCalculoST	number	Reducción de la base del ST (%).
percentualMargemValorAdicionadoST	number	MVA ST (%).

🧩 Objeto `pis`

Campo	Tipo	Descripción
situacaoTributaria	string	CST de PIS.

🧩 Objeto `cofins`

Campo	Tipo	Descripción
situacaoTributaria	string	CST de COFINS.

🧩 Objeto `servico` (NFS-e)

Campo	Tipo	Descripción
descricao	string	Descripción del servicio prestado.
aliquotaIss	number	Alícuota del ISS.
issRetidoFonte	boolean	Indica si hay retención de ISS en la fuente.
codigoServicoMunicipio	string	Código del servicio en el municipio.
itemListaServicoLC116	string	Ítem de la lista de servicios (LC 116/2003).
cnae	string	CNAE del servicio.
municipioPrestacaoServico	number	Código del municipio de prestación (IBGE).

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

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

application/json

Success

Body

Exemplo

{
    "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"
            }
        ]
    },
    "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,
    "numeroNF": "string"
}

Get invoices by date

Obtener Facturas (Notas Fiscales)

Descripción

🔑 Parámetros de Consulta (Query Params)

📤 Estructura de la Respuesta

🧩 Objeto `pedido`

🧩 Objeto `pedido.pagamento`

🧩 Objeto `cliente`

🧩 Objeto `cliente.endereco`

🧩 Objeto `transporte`

🧩 Objeto `transporte.frete`

🧩 Objeto `protocolo`

🧩 Ítems de la factura (`itens[]`)

🧩 Objeto `itens[].impostos`

🧩 Objeto `percentualAproximadoTributos.simplificado`

🧩 Objeto `icms`

🧩 Objeto `pis`

🧩 Objeto `cofins`

🧩 Objeto `servico` (NFS-e)

Requisição

Exemplos de Requisição

Respostas

Get invoices by date

Obtener Facturas (Notas Fiscales)

Descripción

🔑 Parámetros de Consulta (Query Params)

📤 Estructura de la Respuesta

🧩 Objeto pedido

🧩 Objeto pedido.pagamento

🧩 Objeto cliente

🧩 Objeto cliente.endereco

🧩 Objeto transporte

🧩 Objeto transporte.frete

🧩 Objeto protocolo

🧩 Ítems de la factura (itens[])

🧩 Objeto itens[].impostos

🧩 Objeto percentualAproximadoTributos.simplificado

🧩 Objeto icms

🧩 Objeto pis

🧩 Objeto cofins

🧩 Objeto servico (NFS-e)

Requisição

Exemplos de Requisição

Respostas

🧩 Objeto `pedido`

🧩 Objeto `pedido.pagamento`

🧩 Objeto `cliente`

🧩 Objeto `cliente.endereco`

🧩 Objeto `transporte`

🧩 Objeto `transporte.frete`

🧩 Objeto `protocolo`

🧩 Ítems de la factura (`itens[]`)

🧩 Objeto `itens[].impostos`

🧩 Objeto `percentualAproximadoTributos.simplificado`

🧩 Objeto `icms`

🧩 Objeto `pis`

🧩 Objeto `cofins`

🧩 Objeto `servico` (NFS-e)