Demonstração do Resultado do Exercício
Modelo na Plataforma
Sigla: DRE
Descrição: Demonstração do Resultado do Exercício
Modelo Via API
Type: 69
Este modelo extrai informações-chave de um Demonstração do Resultado do Exercício (DRE), como dados do funcionário, da empresa, tipo de exame e aptidão para o trabalho.
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 69 para INCOME_STATEMENT. | 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/atestado.pdf" -F "type=69" -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], "atestado.pdf");
formdata.append("type", "69");
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': '69', 'externalId': 'pedido-123'}
files=[('files',('atestado.pdf',open('/path/to/atestado.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/atestado.pdf'),
'type' => '69',
'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": 69,
"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": 69,
"data": {
"receita_operacional_bruta": "1.500.000,00",
"abatimentos_e_devolucoes": "50.000,00",
"impostos_faturados": "180.000,00",
"receita_operacional_liquida": "1.270.000,00",
"custo_produtos_vendidos": "600.000,00",
"resultado_operacional_bruto": "670.000,00",
"despesas_operacionais": "250.000,00",
"despesas_com_vendas": "150.000,00",
"despesas_administrativas": "100.000,00",
"resultado_financeiro": "-10.000,00",
"receitas_financeiras": "5.000,00",
"despesas_financeiras": "15.000,00",
"desp_amortizacao_agio_investimento": "0,00",
"desp_depreciacao_amortizacao": "40.000,00",
"outras_receitas_operacionais": "25.000,00",
"outras_despesas_operacionais": "15.000,00",
"resultado_equivalencia_patrimonial": "0,00",
"resultado_operacional": "380.000,00",
"resultado_nao_operacional": "0,00",
"receitas_nao_operacionais": "0,00",
"despesas_nao_operacionais": "0,00",
"saldo_correcao_monetaria": "0,00",
"lucro_antes_ir": "380.000,00",
"provisoes_tributacao_impostos_pagos": "95.000,00",
"participacoes_contribicoes_estatutarias": "10.000,00",
"reserva_juros_capital_proprio": "0,00",
"resultado_liquido_exercicio": "275.000,00"
},
"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: Demonstração do Resultado do Exercício
Estes são os campos retornados dentro do objeto data.
| Campo | Tipo | Descrição |
|---|---|---|
| receitaOperacionalBruta | String | Receita Operacional Bruta |
| abatimentosEDevolucoes | String | Abatimentos e Devoluções |
| impostosFaturados | String | Impostos Faturados |
| receitaOperacionalLiquida | String | Receita Operacional Líquida |
| custoProdutosVendidos | String | Custo dos Produtos Vendidos |
| resultadoOperacionalBruto | String | Resultado Operacional Bruto |
| despesasOperacionais | String | Despesas Operacionais |
| despesasComVendas | String | Despesas com Vendas |
| despesasAdministrativas | String | Despesas Administrativas |
| resultadoFinanceiro | String | Resultado Financeiro |
| receitasFinanceiras | String | Receitas Financeiras |
| despesasFinanceiras | String | Despesas Financeiras |
| despAmortizacaoAgioInvestimento | String | Despesa de Amortização de Ágio em Investimento |
| despDepreciacaoAmortizacao | String | Despesa de Depreciação e Amortização |
| outrasReceitasOperacionais | String | Outras Receitas Operacionais |
| outrasDespesasOperacionais | String | Outras Despesas Operacionais |
| resultadoEquivalenciaPatrimonial | String | Resultado de Equivalência Patrimonial |
| resultadoOperacional | String | Resultado Operacional |
| resultadoNaoOperacional | String | Resultado Não Operacional |
| receitasNaoOperacionais | String | Receitas Não Operacionais |
| despesasNaoOperacionais | String | Despesas Não Operacionais |
| saldoCorrecaoMonetaria | String | Saldo de Correção Monetária |
| lucroAntesIr | String | Lucro Antes do Imposto de Renda (IR) |
| provisoesTributacaoImpostosPagos | String | Provisões para Tributação e Impostos Pagos |
| participacoesContribicoesEstatutarias | String | Participações e Contribuições Estatutárias |
| reservaJurosCapitalProprio | String | Reserva de Juros sobre Capital Próprio |
| resultadoLiquidoExercicio | String | Resultado Líquido do Exercício |