Notas Fiscais
Modelo na Plataforma
Sigla: NF
Descrição: Notas Fiscais
Modelo Via API
Type: 76
Este modelo extrai informações-chave de um Notas Fiscais (NF).
O processo de extração é assíncrono e consiste em dois passos principais:
- Enviar o documento para a fila de processamento.
- 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
| Identificador | Valor |
|---|---|
Content-Type | multipart/form-data |
IDEXA-API-KEY | sua_api_key |
Payload (Corpo da Requisição)
A requisição deve conter os seguintes parâmetros obrigatórios:
| Parâmetro | Descriçao | Tipo |
|---|---|---|
files | O arquivo do documento a ser processado. | File |
type | Código interno do modelo. Use 76 para INVOICE. | Integer |
Os parâmetros a seguir são opcionais:
| Parâmetro | Descriçao | Tipo |
|---|---|---|
pages | Define páginas específicas para análise (ex: "1,2,5-10"). | String |
externalId | Id externo para seu controle (não pode repetir). | String |
Exemplos de Requisição
- cURL
- JavaScript
- Python
- PHP
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=76" \
-F "externalId=pedido-cliente-123"
const myHeaders = new Headers();
myHeaders.append("IDEXA-API-KEY", "sua_api_key");
const formdata = new FormData();
formdata.append("files", fileInput.files[0], "documento.pdf");
formdata.append("type", "76");
formdata.append("externalId", "pedido-cliente-123");
const requestOptions = { method: 'POST', headers: myHeaders, body: formdata };
fetch("URL_BASE/documents/upload", requestOptions)
.then(response => response.json())
.then(result => console.log(result));
import requests
url = "URL_BASE/documents/upload"
payload = {'type': '76', 'externalId': 'pedido-123'}
files=[('files',('documento.pdf',open('/path/to/documento.pdf','rb'),'application/pdf'))]
headers = {'IDEXA-API-KEY': 'sua_api_key'}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.json())
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "URL_BASE/documents/upload",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => [
'files' => new CURLFile('/path/to/documento.pdf'),
'type' => '76',
'externalId' => 'pedido-cliente-123'
],
CURLOPT_HTTPHEADER => [
"IDEXA-API-KEY: sua_api_key"
],
]);
$response = curl_exec($curl);
curl_close($curl);
echo $response;
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": 76,
"status": 0,
"statusDesc": "RECEIVED",
"createdAt": "2026-01-07T14:38:50.045Z",
"updatedAt": "2026-01-07T14:38:50.045Z"
}
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.
{
"id": "95893394-337c-429c-a63e-1b8210de47d2",
"externalId": "pedido-cliente-123",
"type": 76,
"data": {
"results": [
{
"nf_number": "2025/001",
"issue_date": "2025-06-10",
"company_id": "12345678000190",
"company_name": "EMPRESA EXEMPLO LTDA",
"buyer_id": "09876543000155",
"buyer_name": "CLIENTE FICTICIO S.A",
"type": "NFS-E",
"access_key": "A1B2C3D4",
"products_total_value": "500,00",
"total_value": "500,00",
"items": [
{
"product_service": "CONSULTORIA EM TI",
"quantity": "String",
"unit_value": "String",
"product_total": "String",
"ncm": "String",
"cst": "String",
"cfop": "5933"
}
]
}
]
},
"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
Estes são os campos retornados dentro do objeto data.
- Modelo
| Campo | Tipo | Descrição | Exemplo |
|---|---|---|---|
| results[].nfNumber | String | Número da Nota Fiscal | "2025/001" |
| results[].issueDate | String | Data de Emissão | "2025-06-10" |
| results[].companyId | String | CNPJ da Empresa Emitente | "12345678000190" |
| results[].companyName | String | Nome da Empresa Emitente | "EMPRESA EXEMPLO LTDA" |
| results[].buyerId | String | CNPJ do Tomador | "09876543000155" |
| results[].buyerName | String | Nome do Tomador | "CLIENTE FICTICIO S.A" |
| results[].type | String | Tipo de Nota | "NFS-E" |
| results[].accessKey | String | Chave de Acesso | "A1B2C3D4" |
| results[].productsTotalValue | String | Valor Total dos Produtos/Serviços | "500,00" |
| results[].totalValue | String | Valor Total da Nota | "500,00" |
| results[].items[].productService | String | Serviço ou Produto | "CONSULTORIA EM TI" |
| results[].items[].quantity | String | Quantidade | "" |
| results[].items[].unitValue | String | Valor Unitário | "" |
| results[].items[].productTotal | String | Valor Total do Item | "" |
| results[].items[].ncm | String | NCM | "" |
| results[].items[].cst | String | CST | "" |
| results[].items[].cfop | String | CFOP | "5933" |