Consultar Analises

Requisição

GET [Url Ambiente]/Energia/Consultar

Identificador	Valor
Content-type	application/json
Accept	application/json
Token [Obtido na Autenticação]	"123123123"

Query

Parâmetro	Descrição	Tipo	Exemplos
Chave	Campo para identificação da requisição	String	"ChaveDefinidaPeloCliente"

Exemplo

curl -X GET "https://api-energia.plataformaacertpix.com.br/Energia/Consultar?Chave=5100053" \
     -H "Content-Type: application/json" \
     -H "Accept: application/json" \
     -H "Token: 12312334131"

Status Code 200

Retorno de sucesso.

Com acesso ao token e chave, será possível obter o retorno/consulta da análise. Segue campos que são retornados na consulta:

Parâmetro	Descrição	Tipo	Exemplos
StatusCode	Código de status da resposta	Int	200
Message	Descrição de sucesso ou falha da requisição	Objeto	{"TypeMessage": "200", "Message": "Processing succeeded"}
Analise.Status	Status da análise. Consultar: Status	Int	1
Analise.IdAnalise	ID da Análise	Int	37130
Analise.Chave	Chave da análise	String	"ChaveDefinidaPeloCliente"
Analise.DataCadastro	Data de cadastro da análise	String	"2024-07-23T16:51:59"
Analise.DataFinalizado	Data de finalização da análise	String	"2024-07-23T16:52:10"
Analise.Quantidade	Quantidade de imagens processadas nessa análise	Int	0
Analise.Result.Distribuidora.MasterType	Tipo principal da distribuidora. Consultar: MasterTypes	String	"ENEL"
Analise.Result.Distribuidora.SubType	Subtipo da distribuidora. Consultar: SubTypes	String	"enel ce"
Analise.Result.Nome_Completo	Nome completo	String	"FULANO DE TAL"
Analise.Result.CPF_CNPJ	CPF ou CNPJ	String	"12345678911"
Analise.Result.Endereco_Completo	Endereço completo	String	"RUA X, 136 - CENTRO, SÃO PAULO - SP"
Analise.Result.CEP	CEP	String	"11790-000"
Analise.Result.Cidade	Cidade	String	"SÃO PAULO"
Analise.Result.UF	Unidade federativa	String	"SP"
Analise.Result.Numero_Instalacao	Número da instalação. Consultar: CodigosDistribuidoras	String "14151537"
Analise.Result.Numero_Cliente	Número do cliente. Consultar: CódigosDistribuidoras	String	"14151537"
Analise.Result.Total_A_Pagar	Total a pagar	String	"153.31"
Analise.Result.Mes_Referencia	Mês de referência	String	"05/2024"
Analise.Result.Vencimento	Data de vencimento	String	"23/06/2024"
Analise.Result.Classificacao_Unidade_Consumidora	Classificação da unidade consumidora. Consultar: Classificações	String	"B1"
Analise.Result.Contas_Vencidas	Contas vencidas	Array	[{"vencimento": "04/2024", "valor": "253.48"}]
Analise.Result.Descricao_Do_Faturamento	Descrição do faturamento	Array	[{"item_fatura": "0601 CONSUMO TE", "mes_ref": null, "quantidade_kwh": "30.00", "valor": "3.89"}, ...]
Analise.Result.Leitura_Atual	Leitura atual	String	"03/04/2024"
Analise.Result.Proxima_Leitura	Próxima leitura	String	null
Analise.Result.Tarifa_Social	Indica se é do tipo Tarifa Social	Boolean	true
Analise.Result.Historico_De_Consumo	Histórico de consumo	Array	[{"mes_ano": "MAI/24", "consumo_faturado": "237.0"}, ...]
Analise.Result.Codigo_Barras	Código de barras	String	"34191094203571983293985387840009197430000020975"
Analise.Result.ImageIndex	Índice no array de imagens recebido	Int	0
Analise.Result.Erro	Em casos de erro, retorna uma mensagem de identificação de erro	String	"A senha não funcionou, então não foi possível abrir"

Exemplo

{
    "StatusCode": 200,
    "Message": {
        "TypeMessage": "200",
        "Message": "Processing succeeded"
    },
    "Analise": {
        "Status": 1,
        "IdAnalise": 36226,
        "Chave": "50828",
        "DataCadastro": "0001-01-01T00:00:00",
        "DataFinalizado": "0001-01-01T00:00:00",
        "Quantidade": 1,
        "Result": [
            {
                "Distribuidora": {
                    "MasterType": "ENEL",
                    "SubType": "enel ce"
                },
                "Nome_Completo": "FULANO DE TAL SILVA",
                "CPF_CNPJ": "*** 327.31 ****",
                "Endereco_Completo": "RUA X, 136 - CENTRO, SÃO PAULO - SP",
                "CEP": "11790-000",
                "Cidade": "SÃO PAULO",
                "UF": "SP",
                "Numero_Instalacao": "12345",
                "Numero_Cliente": "56789",
                "Total_A_Pagar": "209.76",
                "Mes_Referencia": "05/2024",
                "Vencimento": "10/06/2024",
                "Classificacao_Unidade_Consumidora": "B1",
                "Contas_Vencidas": [
                    {
                        "vencimento": "03/2024",
                        "valor": "167.35"
                    }
                ],
                "Descricao_Do_Faturamento": [
                    {
                        "item_fatura": "Energia Ahva Fornecida TE",
                        "mes_ref": null,
                        "quantidade_kwh": "194",
                        "valor": "72.38"
                    },
                    {
                        "item_fatura": "Cip Mum Pub Pref Municipal",
                        "mes_ref": null,
                        "quantidade_kwh": null,
                        "valor": "1.75"
                    },
                    {
                        "item_fatura": "SUBTOTAL FATURAMENTO",
                        "mes_ref": null,
                        "quantidade_kwh": null,
                        "valor": "185.59"
                    },
                    {
                        "item_fatura": "SUBTOTAL OUTROS",
                        "mes_ref": null,
                        "quantidade_kwh": null,
                        "valor": "24.17"
                    },
                    {
                        "item_fatura": "TOTAL",
                        "mes_ref": null,
                        "quantidade_kwh": null,
                        "valor": "283,89"
                    }
                ],
                "Leitura_Atual": "07/05/2024",
                "Proxima_Leitura": null,
                "Tarifa_Social": true,
                "Historico_De_Consumo": [
                    {
                        "mes_ano": "MEDIA",
                        "consumo_faturado": "165"
                    },
                    {
                        "mes_ano": "ABR24",
                        "consumo_faturado": "17"
                    },
                    {
                        "mes_ano": "MAR24",
                        "consumo_faturado": "14"
                    },
                    {
                        "mes_ano": "FEV24",
                        "consumo_faturado": "14"
                    },
                    {
                        "mes_ano": "JAN24",
                        "consumo_faturado": "14"
                    }
                ],
                "Codigo_Barras": "34191094203571983293985387840009197430000020975",
                "ImageIndex": 0,
                "Erro": ""
            }
        ]
    }
}

Status Code 400

Não encontrado.

Parâmetro	Descrição	Tipo	Exemplos
StatusCode	Status da requisição	Int	404
Message	Descrição da requisição	Object	{"TypeMessage":"404","Message":"Analise não encontrada"}

Exemplo

{
    "StatusCode": 404,
    "Message": {
        "TypeMessage": "404",
        "Message": "Analise não encontrada"
    }
}

Status Code 404

Erro 404 - Url não encontrado

O erro 404 é exibido quando um endpoint especificado pelo usuário não é encontrado na API. Isso pode ocorrer quando o usuário digitou um URL incorreto ou quando o endpoint não está mais disponível.

Status Code 500

Erro não tratado pelo sistema.

Parâmetro	Descrição	Tipo	Exemplos
StatusCode	Status da requisição	Int	500
Message	Descrição da requisição	Object	{"TypeMessage":"500","Message":"ERRO NO SERVIDOR"}

Exemplo

{
    "StatusCode": 500,
    "Message": {
        "TypeMessage": "500",
        "Message": "ERRO NO SERVIDOR"
    }
}

Consultar Analises

Requisição​

Header​

Query​

Exemplo​

Status Code 200​

Exemplo​

Status Code 400​

Exemplo​

Status Code 404​

Status Code 500​

Exemplo​

Requisição

Header

Query

Exemplo

Status Code 200

Exemplo

Status Code 400

Exemplo

Status Code 404

Status Code 500

Exemplo