Pular para o conteúdo principal

Fatura de Energia de Baixa Tensão

Modelo na Plataforma

Sigla: FATURA-B

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

Modelo Via API

Type: 35

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

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

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

CampoTipoDescriçãoExemplo
titular.nomeStringNome"EMPRESA"
titular.idStringCPF/CNPJ"**3000000007000143"
titular.enderecoStringEndereco"RUA X"
titular.numeroStringNumero"12"
titular.complementoStringComplemento"AP 00003"
titular.bairroStringBairro"BAIRRO"
titular.cidadeStringCidade"PORTO ALEGRE"
titular.ufStringUF"RS"
titular.cepStringCEP"12345-678"
titular.parceiroNegocioStringParceiro de Negocio"0000000000"
titular.unidadeConsumidoraStringUnidade Consumidora"00000000"
dadosFatura.concessionariaStringNome da Empresa"Empresa LTDA"
dadosFatura.contaRefStringMes de Cobrança"MAI/2024"
dadosFatura.vencimentoStringVencimento"11/06/2024"
dadosFatura.totalAPagarStringTotal a Pagar"103,50"
dadosFatura.cipMunicipalStringContribuicao de Iluminacao Publica"103,50"
itensFatura[].itemStringItem"CONSUMO"
itensFatura[].horarioStringhorario""
itensFatura[].tarifaStringTarifa"TUSD"
itensFatura[].unidadeStringUnidade"kWh"
itensFatura[].quantidadeStringQuantidade Medida"116"
itensFatura[].valorStringValor"112,60"
itensFatura[].precoUnitarioTributosStringPreco Unitario Tributos"0,460142"
itensFatura[].tarifaUnitariaStringTarifa Unitaria"0,364490"
itensFatura[].pisStringPIS""
itensFatura[].cofinsStringCOFINS""
itensFatura[].icmsStringICMS"22,06"
detalhamentoLeitura[].grandezaStringGrandeza Medida"CONSUMO"
detalhamentoLeitura[].constMedidorStringConstante Medidor"1"
detalhamentoLeitura[].unidadeStringUnidade"kWh"
detalhamentoLeitura[].postosHorariosStringPostos Horarios"TP"
detalhamentoLeitura[].leituraAnteriorStringLeitura Anterios"3736"
detalhamentoLeitura[].leituraAtualStringLeitura Atual"4018"
detalhamentoLeitura[].consumokWhStringConsumo Medido"282"
detalhamentoLeitura[].medidorStringCodigo do Medidor"50342063"
dadosEnergia.classificacaoStringClassificacao"RESIDENCIAL"
dadosEnergia.tipoFornecimentoStringTipo de Fornecimento"TRIFÁSICO"
dadosEnergia.grupoTarifarioStringGrupo Tarifario"B1"
dadosEnergia.tensaoNominalStringTensao Nominal"127-125"
dadosEnergia.modalidadeTarifariaStringModalidade Tarifaria"CONVENCIONAL"
datasLeituras.leituraAnteriorStringLeitura Anterior"11/06/2024"
datasLeituras.leituraAtualStringLeitura Atual"11/06/2024"
datasLeituras.qtdDiasStringQuantidade de Dias"30"
datasLeituras.proximaLeituraStringProxima Leitura"11/06/2024"
notaFiscal[].numeroStringNumero"00000000"
notaFiscal[].serieStringSerie"0"
notaFiscal[].dataEmissaoStringData Emissao"11/06/2024"
notaFiscal[].chaveAcessoStringChave de Aceso"38545619"
notaFiscal[].protocoloAutorizacaoStringProtocolo de Autorizacao"00000000"
historico[].mesRefStringMes Referente"MAI/2024"
historico[].consumoUnicoStringConsumo Unico"32"
historico[].consumoPTStringConsumo Ponta"32"
historico[].consumoFPTStringConsumo Fora Ponta"32"
historico[].diasStringDias"32"
historico[].demandaPTStringDemanda Ponta"32"
historico[].demandaFPTStringDemanda Fora Ponta"32"
jurosMultas[].descricaoStringDescricao""
jurosMultas[].valorStringValor""
tributos.icms.baseStringbase""
tributos.icms.aliquotaStringAliquota""
tributos.icms.valorStringValor""
tributos.pis.baseStringbase""
tributos.pis.aliquotaStringAliquota""
tributos.pis.valorStringValor""
tributos.cofins.baseStringbase""
tributos.cofins.aliquotaStringAliquota""
tributos.cofins.valorStringValor""
bandeira.corStringcor"VERDE"
bandeira.adicionalStringAdicional""
informacoesCliente[].descricaoStringDescrição"SALDO DE ENERGIA"
informacoesCliente[].quantidadeStringQuantidade"100"
informacoesCliente[].postoHorarioStringPosto Horário"PONTA"