Skip to main content

Fatura de Energia de Alta e Baixa Tensão

Modelo na Plataforma

Sigla: FATURA-AB

Descrição: Fatura de Energia de Alta e Baixa Tensão

Modelo Via API

Type: 35

Este modelo extrai informações-chave de um Fatura de Energia de Alta e Baixa Tensão (FATURA-AB).

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 35 para LV_HV_ELECTRICITY_BILL.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=35" \
-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": 35,
"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": 35,
"data": {
"titular": {
"id": "*****3000000007000143***",
"uf": "RS",
"cep": "12345-678",
"nome": "EMPRESA",
"bairro": "BAIRRO",
"cidade": "PORTO ALEGRE",
"numero": "12",
"endereco": "RUA X",
"complemento": "AP 00003",
"conta_contrato": "0000000000",
"parceiro_negocio": "0000000000",
"unidade_consumidora": "00000000"
},
"bandeira": {
"cor": "VERDE",
"adicional": "0,00"
},
"tributos": {
"pis": {
"base": "100,00",
"valor": "17,00",
"aliquota": "17,00"
},
"icms": {
"base": "100,00",
"valor": "17,00",
"aliquota": "17,00"
},
"cofins": {
"base": "100,00",
"valor": "17,00",
"aliquota": "17,00"
}
},
"historico": [
{
"dias": "32",
"mes_ref": "MAI/2024",
"consumo_p_t": "32",
"demanda_p_t": "32",
"consumo_f_p_t": "32",
"consumo_unico": "32",
"demanda_f_p_t": "32"
}
],
"nota_fiscal": [
{
"serie": "0",
"numero": "00000000",
"chave_acesso": "38545619",
"data_emissao": "11/06/2024",
"protocolo_autorizacao": "00000000"
}
],
"dados_fatura": {
"conta_ref": "MAI/2024",
"vencimento": "11/06/2024",
"aviso_corte": false,
"cip_municipal": "10,50",
"total_a_pagar": "103,50",
"concessionaria": "EMPRESA LTDA",
"leitura_debito": false
},
"itens_fatura": [
{
"icms": "22,06",
"item": "CONSUMO",
"valor": "112,60",
"tarifa": "TUSD",
"horario": "PONTA",
"unidade": "KWH",
"pis_cofins": "4,20",
"quantidade": "116",
"tarifa_unitaria": "0,364490",
"preco_unitario_tributos": "0,460142"
}
],
"juros_multas": [
{
"valor": "5,00",
"descricao": "MULTA"
}
],
"dados_energia": {
"classificacao": "RESIDENCIAL",
"tensao_nominal": "127-125",
"grupo_tarifario": "B1",
"tipo_fornecimento": "TRIFÁSICO",
"modalidade_tarifaria": "CONVENCIONAL"
},
"datas_leituras": {
"qtd_dias": "30",
"leitura_atual": "11/06/2024",
"proxima_leitura": "11/07/2024",
"leitura_anterior": "11/05/2024"
},
"informacoes_cliente": [
{
"descricao": "SALDO DE ENERGIA",
"quantidade": "100",
"posto_horario": "FORA PONTA"
}
],
"detalhamento_leitura": [
{
"medidor": "50342063",
"unidade": "KWH",
"grandeza": "CONSUMO",
"consumok_wh": "282",
"const_medidor": "1",
"leitura_atual": "4018",
"postos_horarios": "TP",
"leitura_anterior": "3736"
}
]
},
"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: Fatura de Energia de Alta e Baixa Tensão​

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

CampoTipoDescriçãoExemplo
titular.idStringid"**3000000007000143"
titular.ufStringuf"RS"
titular.cepStringcep"12345-678"
titular.nomeStringnome"EMPRESA"
titular.bairroStringbairro"BAIRRO"
titular.cidadeStringcidade"PORTO ALEGRE"
titular.numeroStringnumero"12"
titular.enderecoStringendereco"RUA X"
titular.complementoStringcomplemento"AP 00003"
titular.contaContratoStringconta_contrato"0000000000"
titular.parceiroNegocioStringparceiro_negocio"0000000000"
titular.unidadeConsumidoraStringunidade_consumidora"00000000"
bandeira.corStringcor"VERDE"
bandeira.adicionalStringadicional"0,00"
tributos.pis.baseStringbase"100,00"
tributos.pis.valorStringvalor"17,00"
tributos.pis.aliquotaStringaliquota"17,00"
tributos.icms.baseStringbase"100,00"
tributos.icms.valorStringvalor"17,00"
tributos.icms.aliquotaStringaliquota"17,00"
tributos.cofins.baseStringbase"100,00"
tributos.cofins.valorStringvalor"17,00"
tributos.cofins.aliquotaStringaliquota"17,00"
historico[].mesRefStringmes_ref"MAI/2024"
historico[].consumoUnicoStringconsumo_unico"32"
historico[].consumoPTStringconsumo_p_t"32"
historico[].consumoFPTStringconsumo_f_p_t"32"
historico[].diasStringdias"32"
historico[].demandaPTStringdemanda_p_t"32"
historico[].demandaFPTStringdemanda_f_p_t"32"
notaFiscal[].numeroStringnumero"00000000"
notaFiscal[].serieStringserie"0"
notaFiscal[].dataEmissaoStringdata_emissao"11/06/2024"
notaFiscal[].chaveAcessoStringchave_acesso"38545619"
notaFiscal[].protocoloAutorizacaoStringprotocolo_autorizacao"00000000"
dadosFatura.contaRefStringconta_ref"MAI/2024"
dadosFatura.vencimentoStringvencimento"11/06/2024"
dadosFatura.avisoCorteBooleanaviso_cortefalse
dadosFatura.cipMunicipalStringcip_municipal"10,50"
dadosFatura.totalAPagarStringtotal_a_pagar"103,50"
dadosFatura.concessionariaStringconcessionaria"EMPRESA LTDA"
dadosFatura.leituraDebitoBooleanleitura_debitofalse
itensFatura[].itemStringitem"CONSUMO"
itensFatura[].horarioStringhorario"PONTA"
itensFatura[].tarifaStringtarifa"TUSD"
itensFatura[].unidadeStringunidade"KWH"
itensFatura[].quantidadeStringquantidade"116"
itensFatura[].valorStringvalor"112,60"
itensFatura[].precoUnitarioTributosStringpreco_unitario_tributos"0,460142"
itensFatura[].tarifaUnitariaStringtarifa_unitaria"0,364490"
itensFatura[].pisCofinsStringpis_cofins"4,20"
itensFatura[].icmsStringicms"22,06"
jurosMultas[].descricaoStringdescricao"MULTA"
jurosMultas[].valorStringvalor"5,00"
dadosEnergia.classificacaoStringclassificacao"RESIDENCIAL"
dadosEnergia.tensaoNominalStringtensao_nominal"127-125"
dadosEnergia.grupoTarifarioStringgrupo_tarifario"B1"
dadosEnergia.tipoFornecimentoStringtipo_fornecimento"TRIFÁSICO"
dadosEnergia.modalidadeTarifariaStringmodalidade_tarifaria"CONVENCIONAL"
datasLeituras.qtdDiasStringqtd_dias"30"
datasLeituras.leituraAtualStringleitura_atual"11/06/2024"
datasLeituras.proximaLeituraStringproxima_leitura"11/07/2024"
datasLeituras.leituraAnteriorStringleitura_anterior"11/05/2024"
informacoesCliente[].descricaoStringdescricao"SALDO DE ENERGIA"
informacoesCliente[].quantidadeStringquantidade"100"
informacoesCliente[].postoHorarioStringposto_horario"FORA PONTA"
detalhamentoLeitura[].grandezaStringgrandeza"CONSUMO"
detalhamentoLeitura[].constMedidorStringconst_medidor"1"
detalhamentoLeitura[].unidadeStringunidade"KWH"
detalhamentoLeitura[].postosHorariosStringpostos_horarios"TP"
detalhamentoLeitura[].leituraAnteriorStringleitura_anterior"3736"
detalhamentoLeitura[].leituraAtualStringleitura_atual"4018"
detalhamentoLeitura[].consumokWhStringconsumok_wh"282"
detalhamentoLeitura[].medidorStringmedidor"50342063"