Fechamento de Fatura - Serviço de Leitura de Medidores

Modelo na Plataforma

Sigla: MEDIDORES

Descrição: Fechamento de Fatura - Serviço de Leitura de Medidores

Modelo Via API

Type: 56

Este modelo extrai informações-chave de um Fechamento de Fatura - Serviço de Leitura de Medidores (MEDIDORES), 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:

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

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 56 para METER_READING.	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

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=56" -F "externalId=pedido-cliente-123"

JavaScript

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", "56");
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));

Python

import requests

url = "URL_BASE/documents/upload"
payload = {'type': '56', '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

<?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' => '56',
    '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": 56,
  "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": 56,
  "data": {
    "contract": "0000000000",
    "contractor": "EMPRESA LTDA",
    "issue_date": "2023-06-26",
    "year_month": "2023-06",
    "closing-period": "2023-05-16 TO 2023-06-15",
    "subtotal": "000.000,00",
    "total_value": "000.000,00",
    "payable_amounts": "000.000,00",
    "fines": "000.000,00",
    "approver_signature": "JOAO DA SILVA",
    "has_approver_signature": "true",
    "agreement_signature": "JOAO DA SILVA",
    "has_agreement_signature": "true",
    "extra_values": "[{'value': '3.003,11', 'description': 'COLETA DE DADOS'}]"
  },
  "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: Fechamento de Fatura - Serviço de Leitura de Medidores

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

Campo	Tipo	Descrição
contract	String	Número do contrato
contractor	String	Nome da empreiteira
issueDate	String	Data de emissão
yearMonth	String	Ano e mês de referência
closingPeriod	String	Período de fechamento
subtotal	String	Valor subtotal
totalValue	String	Valor total
payableAmounts	String	Valores total a pagar
fines	String	Multas
approverSignature	String	Assinatura 'Aprovado Por'
hasApproverSignature	Boolean	Existe assinatura 'Aprovado Por'
agreementSignature	String	Assinatura 'De Acordo'
hasAgreementSignature	Boolean	Existe assinatura 'De Acordo'
extraValues	Array	Valores Extras