Pular para o conteúdo principal

Notas Fiscais 2

Modelo na Plataforma

Sigla: NF_V2

Descrição: Notas Fiscais 2

Modelo Via API

Type: 64

Este modelo extrai informações-chave de um Notas Fiscais 2 (NF_V2).

O processo de extração é assíncrono e consiste em dois passos principais:

  1. Enviar o documento para a fila de processamento.
  2. Consultar o resultado após a conclusão do processamento.

Passo 1: Enviar o Documento para Processamento​

Para iniciar a extração, envie uma requisição POST para o endpoint abaixo.

POST URL Ambiente/documents/upload

Headers​

IdentificadorValor
Content-Typemultipart/form-data
IDEXA-API-KEYsua_api_key

Payload (Corpo da Requisição)​

A requisição deve conter os seguintes parâmetros obrigatórios:

ParâmetroDescriçaoTipo
filesO arquivo do documento a ser processado.File
typeCódigo interno do modelo. Use 64 para INVOICE_V2.Integer

Os parâmetros a seguir são opcionais:

ParâmetroDescriçaoTipo
pagesDefine páginas específicas para análise (ex: "1,2,5-10").String
externalIdId externo para seu controle (não pode repetir).String

Exemplos de Requisição​

curl -X POST "URL_BASE/documents/upload" \
-H "IDEXA-API-KEY: sua_api_key" \
-H "Content-Type: multipart/form-data" \
-F "files=@/path/to/seu/documento.pdf" \
-F "type=64" \
-F "externalId=pedido-cliente-123"

Resposta Imediata (Status 200)​

A resposta confirma o recebimento. Guarde o id para consultar o resultado no próximo passo.

{
"id": "95893394-337c-429c-a63e-1b8210de47d2",
"externalId": "pedido-cliente-123",
"type": 64,
"status": 0,
"statusDesc": "RECEIVED",
"createdAt": "2026-01-07T14:38:50.045Z",
"updatedAt": "2026-01-07T14:38:50.045Z"
}
Processamento Assíncrono

A extração de dados pode levar alguns segundos. Por isso, a API funciona de forma assíncrona. Após enviar o documento, aguarde um momento e então use o id retornado para consultar o resultado final. Para ser notificado automaticamente, considere utilizar nossos Webhooks.

Passo 2: Consultar o Resultado​

Use o id do documento para fazer uma requisição GET e buscar o resultado completo da extração.

GET URL Ambiente/documents/[id]

Resposta Final (Status 200)​

Quando o status for 1 (FINISHED), o objeto data conterá os campos extraídos.

Exemplo de Resposta Completa
{
"id": "95893394-337c-429c-a63e-1b8210de47d2",
"externalId": "pedido-cliente-123",
"type": 64,
"data": {
"ipi": "",
"icms": "",
"type": "NFS-E",
"items": "[{\"product_service\": \"CONSULTORIA EM TI\", \"cfop\": \"5933\"}]",
"buyer_id": "09876543000155",
"currency": "BRL",
"nf_number": "2025/001",
"access_key": "A1B2C3D4",
"buyer_name": "CLIENTE FICTICIO S.A",
"company_id": "12345678000190",
"issue_date": "2025-06-10",
"total_value": "500,00",
"company_name": "EMPRESA EXEMPLO LTDA",
"payment_method": "",
"substitution_icms": "",
"products_total_value": "500,00",
"icms_calculation_base": "",
"substitution_icms_calculation_base": ""
},
"processTime": 8.123,
"status": 1,
"statusDesc": "FINISHED",
"createdAt": "2026-01-07T14:38:50.045Z",
"updatedAt": "2026-01-07T14:38:58.168Z"
}

Dicionário de Dados: Notas Fiscais 2​

Estes são os campos retornados dentro do objeto data.

CampoTipoDescriçãoExemplo
nfNumberStringnf_number"2025/001"
issueDateStringissue_date"2025-06-10"
companyIdStringcompany_id"12345678000190"
companyNameStringcompany_name"EMPRESA EXEMPLO LTDA"
buyerIdStringbuyer_id"09876543000155"
buyerNameStringbuyer_name"CLIENTE FICTICIO S.A"
typeStringtype"NFS-E"
accessKeyStringaccess_key"A1B2C3D4"
currencyStringcurrency"BRL"
productsTotalValueStringproducts_total_value"500,00"
totalValueStringtotal_value"500,00"
icmsCalculationBaseStringicms_calculation_base""
icmsStringicms""
substitutionIcmsCalculationBaseStringsubstitution_icms_calculation_base""
substitutionIcmsStringsubstitution_icms""
ipiStringipi""
paymentMethodStringpayment_method""
items[].productServiceStringproduct_service"CONSULTORIA EM TI"
items[].quantityStringquantity""
items[].unitValueStringunit_value""
items[].productTotalStringproduct_total""
items[].ncmStringncm""
items[].cstStringcst""
items[].cfopStringcfop"5933"