676 lines
27 KiB
HTML
676 lines
27 KiB
HTML
<!DOCTYPE html>
|
|
<!-- saved from url=(0051)https://console.4docs.cloud/doc-json?customer_id=65 -->
|
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>4docs Console</title><style>@font-face {
|
|
font-family: Dosis;
|
|
src: url(/fonts/Dosis-Regular.ttf);
|
|
font-style: normal;
|
|
font-weight: normal;
|
|
}
|
|
@font-face {
|
|
font-family: Dosis;
|
|
src: url(/fonts/Dosis-Bold.ttf);
|
|
font-style: normal;
|
|
font-weight: bold;
|
|
}
|
|
@font-face {
|
|
font-family: Sofia;
|
|
src: url(/fonts/sofia/SofiaSansCondensed-Regular.ttf);
|
|
font-style: normal;
|
|
font-weight: normal;
|
|
}
|
|
@font-face {
|
|
font-family: Sofia;
|
|
src: url(/fonts/sofia/SofiaSansCondensed-Bold.ttf);
|
|
font-style: normal;
|
|
font-weight: bold;
|
|
}
|
|
@font-face {
|
|
font-family: Barlow;
|
|
src: url(/fonts/barlow/BarlowCondensed-Regular.ttf);
|
|
font-style: normal;
|
|
font-weight: normal;
|
|
}
|
|
@font-face {
|
|
font-family: Barlow;
|
|
src: url(/fonts/barlow/BarlowCondensed-Bold.ttf);
|
|
font-style: normal;
|
|
font-weight: bold;
|
|
}
|
|
@font-face {
|
|
font-family: PT;
|
|
src: url(/fonts/pt/PTSansNarrow-Regular.ttf);
|
|
font-style: normal;
|
|
font-weight: normal;
|
|
}
|
|
@font-face {
|
|
font-family: PT;
|
|
src: url(/fonts/pt/PTSansNarrow-Bold.ttf);
|
|
font-style: normal;
|
|
font-weight: bold;
|
|
}
|
|
body{
|
|
font-family: 'PT', sans-serif;
|
|
font-size: 105%;
|
|
color: rgb(28, 21, 91);
|
|
}</style><link href="./jsonDoc_files/global.css" rel="stylesheet" type="text/css"><link href="https://console.4docs.cloud/favicon.png" rel="icon" type="image/png"><link href="./jsonDoc_files/quick_jump.css" rel="stylesheet" type="text/css"><link href="./jsonDoc_files/org.css" rel="stylesheet" type="text/css"></head><body><div class="before_header"></div><header data-customer-id="65" id="header"><div class="bef"></div><nav class="left"><p><a href="https://console.4docs.cloud/">4docs Console</a></p></nav><nav class="center"><p><a href="https://console.4docs.cloud/">Smart Energia</a></p></nav><nav class="right"><ul><li><a href="https://console.4docs.cloud/logout">Logout</a></li></ul></nav><div class="aft"></div></header><div id="popup"><div id="quick_jump_start"><ul class="quick_jump"><li><div class="menu"><b>L</b> location</div><div class="action" data-action="" data-key="l" data-go="no"><div><ul class="quick_jump"><li><div class="menu"><b>L</b> location id</div><div class="action" data-action="goto_location_id" data-key="l" data-input="yes" data-go="wait-input"><div></div></div></li><li><div class="menu"><b>C</b> customer name</div><div class="action" data-action="" data-key="c" data-input="yes" data-go="no"><span class="input"></span><div><ul class="quick_jump"><li><div class="menu"><b>ENTER</b> go</div><div class="action" data-action="goto_location_customer" data-key="Enter" data-go="yes"><div></div></div></li><li><div class="menu"><b>N</b> location number</div><div class="action" data-action="goto_location_customer_location_number" data-key="n" data-input="yes" data-go="wait-input"><div></div></div></li><li><div class="menu"><b>P</b> provider name</div><div class="action" data-action="goto_location_customer_provider" data-key="p" data-input="yes" data-go="wait-input"><div></div></div></li><li><div class="menu"><b>Z</b> delay load</div><div class="action" data-action="goto_location_customer_delay_load" data-key="z" data-go="yes"><div></div></div></li></ul></div></div></li></ul></div></div></li><li><div class="menu"><b>A</b> account</div><div class="action" data-action="" data-key="a" data-go="no"><div><ul class="quick_jump"><li><div class="menu"><b>A</b> account id</div><div class="action" data-action="goto_account_id" data-key="a" data-input="yes" data-go="wait-input"><div></div></div></li><li><div class="menu"><b>C</b> customer name</div><div class="action" data-action="" data-key="c" data-input="yes" data-go="no"><span class="input"></span><div><ul class="quick_jump"><li><div class="menu"><b>ENTER</b> go</div><div class="action" data-action="goto_account_customer" data-key="Enter" data-go="yes"><div></div></div></li><li><div class="menu"><b>S</b> access point name</div><div class="action" data-action="goto_account_customer_access_point" data-key="s" data-input="yes" data-go="wait-input"><div></div></div></li><li><div class="menu"><b>Z</b> delay load</div><div class="action" data-action="goto_account_customer_delay_load" data-key="z" data-go="yes"><div></div></div></li></ul></div></div></li></ul></div></div></li><li><div class="menu"><b>R</b> request</div><div class="action" data-action="" data-key="r" data-go="no"><div><ul class="quick_jump"><li><div class="menu"><b>R</b> request id</div><div class="action" data-action="goto_request_id" data-key="r" data-input="yes" data-go="wait-input"><div></div></div></li><li><div class="menu"><b>M</b> request md5</div><div class="action" data-action="goto_request_md5" data-key="m" data-input="yes" data-go="wait-input"><div></div></div></li><li><div class="menu"><b>C</b> customer name</div><div class="action" data-action="" data-key="c" data-input="yes" data-go="no"><span class="input"></span><div><ul class="quick_jump"><li><div class="menu"><b>ENTER</b> go</div><div class="action" data-action="goto_request_customer" data-key="Enter" data-go="yes"><div></div></div></li><li><div class="menu"><b>M</b> request md5</div><div class="action" data-action="goto_request_customer_md5" data-key="m" data-input="yes" data-go="wait-input"><div></div></div></li></ul></div></div></li></ul></div></div></li><li><div class="menu"><b>V</b> invoice</div><div class="action" data-action="" data-key="v" data-go="no"><div><ul class="quick_jump"><li><div class="menu"><b>V</b> invoice id</div><div class="action" data-action="goto_invoice_id" data-key="v" data-input="yes" data-go="wait-input"><div></div></div></li><li><div class="menu"><b>L</b> invoices for location id</div><div class="action" data-action="goto_invoices_for_location_id" data-key="l" data-input="yes" data-go="wait-input"><div></div></div></li></ul></div></div></li><li><div class="menu"><b>B</b> bot report</div><div class="action" data-action="" data-key="b" data-go="no"><div><ul class="quick_jump"><li><div class="menu"><b>B</b> go</div><div class="action" data-action="goto_bot_report" data-key="b" data-go="yes"><div></div></div></li><li><div class="menu"><b>L</b> location id</div><div class="action" data-action="goto_bot_report_location_id" data-key="l" data-input="yes" data-go="wait-input"><div></div></div></li><li><div class="menu"><b>Z</b> delay load</div><div class="action" data-action="goto_bot_report_delay_load" data-key="z" data-go="yes"><div></div></div></li></ul></div></div></li><li><div class="menu"><b>U</b> unified jobs</div><div class="action" data-action="" data-key="u" data-go="no"><div><ul class="quick_jump"><li><div class="menu"><b>U</b> job id</div><div class="action" data-action="goto_unified_job_id" data-key="u" data-input="yes" data-go="wait-input"><div></div></div></li><li><div class="menu"><b>Z</b> delay load</div><div class="action" data-action="goto_unified_jobs_delay_load" data-key="z" data-go="yes"><div></div></div></li></ul></div></div></li><li><div class="menu"><b>J</b> bot jobs</div><div class="action" data-action="" data-key="j" data-go="no"><div><ul class="quick_jump"><li><div class="menu"><b>L</b> location id</div><div class="action" data-action="goto_bot_jobs_location_id" data-key="l" data-input="yes" data-go="wait-input"><div></div></div></li><li><div class="menu"><b>Z</b> delay load</div><div class="action" data-action="goto_bot_jobs_delay_load" data-key="z" data-go="yes"><div></div></div></li></ul></div></div></li></ul></div><input id="quick_jump_input" type="text"></div><script src="./jsonDoc_files/quick_jump.js.download"></script><nav class="menu"><ul><li><a href="https://console.4docs.cloud/request/all?customer_id=65">Requests</a></li><li><a href="https://console.4docs.cloud/doc?customer_id=65">API documentation</a></li><li><a href="https://console.4docs.cloud/change_password?customer_id=65">Change password</a></li><li><a href="https://console.4docs.cloud/operations?customer_id=65">Operations</a></li><li><a href="https://console.4docs.cloud/locations?customer_id=65">Bots</a></li><li><a href="https://console.4docs.cloud/deliveries?customer_id=65">Deliveries</a></li><li><a href="https://console.4docs.cloud/groups?customer_id=65">Groups</a></li><li><a href="https://console.4docs.cloud/bot_status?customer_id=65">Bot Status</a></li><li><a href="https://console.4docs.cloud/bot/providers?customer_id=65">Providers</a></li><li><a href="https://console.4docs.cloud/bot/access_points?customer_id=65">Access points</a></li><li><a href="https://console.4docs.cloud/bot/log_create_update_requests?customer_id=65">Bot API requests</a></li><li><a href="https://console.4docs.cloud/spreadsheet-importer?customer_id=65">Importer</a></li><li><a href="https://console.4docs.cloud/calendar?customer_id=65">Calendar</a></li><li><a href="https://console.4docs.cloud/indexed_requests?customer_id=65">Index</a></li></ul></nav><main><div id="content" class="content" style="max-width: 1024px;">
|
|
<h1 class="title">JSON da fatura de energia</h1>
|
|
<p>O JSON produzido para uma fatura de energia em formato PDF tem o mesmo formato,
|
|
independentemente da concessionária.</p>
|
|
|
|
<p>A seguir são apresentados as propriedades que o objeto raiz possui.</p>
|
|
|
|
<h2><code>version</code>: string</h2>
|
|
|
|
<p>Identifica a versão do formato do JSON; atualmente é a string <code>"2.0"</code>.</p>
|
|
|
|
<h2><code>md5</code>: string</h2>
|
|
|
|
<p>O MD5 do arquivo que foi analisado para que o JSON fosse gerado.</p>
|
|
|
|
<h2><code>pipeline</code>: string:</h2>
|
|
|
|
<p>O tipo de documento analisado; para faturas de energia é a string <code>"energy"</code>.</p>
|
|
|
|
<h2><code>providerData</code>: object</h2>
|
|
|
|
<p>Exemplo:</p>
|
|
|
|
<pre><code>{
|
|
"providerData": {
|
|
"name": {
|
|
"value": "Equatorial Alagoas Distribuidora de Energia S.A.",
|
|
"confidence": "high"
|
|
},
|
|
"cnpj": {
|
|
"value": "12272084000100",
|
|
"confidence": "high"
|
|
}
|
|
}
|
|
}
|
|
</code></pre>
|
|
|
|
<p>Dados mais detalhados sobre a concessionária de energia, retirados do documento
|
|
original. Tem os atributos <code>name</code> e <code>cnpj</code>, cujos valores são objetos com
|
|
propriedades <code>value</code> e <code>confidence</code>. A propriedade <code>confidence</code> pode ter os
|
|
valores <code>"high"</code> ou <code>"low"</code>: <code>"high"</code> indica que o nome ou o CNPJ da
|
|
concessionária foi extraído diretamente do documento; <code>"low"</code> significa que o
|
|
nome ou o CNPJ foi apenas deduzido, pois não está textualmente presente no
|
|
documento.</p>
|
|
|
|
<h2><code>stdProvider</code>: string</h2>
|
|
|
|
<p>Exemplos:</p>
|
|
|
|
<ul>
|
|
<li><code>"cpfl_paulista"</code></li>
|
|
<li><code>"energisa_to"</code></li>
|
|
<li><code>"equatorial_al"</code></li>
|
|
<li><code>"light"</code></li>
|
|
<li><code>"celpe"</code></li>
|
|
</ul>
|
|
|
|
<p>Uma codificação padronizada da concessionária.</p>
|
|
|
|
<h2><code>locationNumber</code>: string</h2>
|
|
|
|
<p>Exemplos (fictícios):</p>
|
|
|
|
<ul>
|
|
<li>4000911399</li>
|
|
<li>6/8174432-1</li>
|
|
<li>193-4</li>
|
|
</ul>
|
|
|
|
<p>O número da unidade consumidora. Na fatura, este número pode estar descrito como "número da unidade consumidora", "número da instalação", etc. Este número pode ter maior ou menor importância, conforme a concessionária.</p>
|
|
|
|
<p>É extremamente raro, mas este campo pode estar ausente se a unidade consumidora não estiver identificada de nenhuma forma na fatura.</p>
|
|
|
|
<h2><code>clientCode</code>: string</h2>
|
|
|
|
<p>Exemplos (fictícios):</p>
|
|
|
|
<ul>
|
|
<li><code>"1209877"</code></li>
|
|
<li><code>"7004407898"</code></li>
|
|
</ul>
|
|
|
|
<p>O código do cliente, conforme consta na fatura. A interpretação do que
|
|
exatamente é o "código do cliente", para que serve, etc., depende da
|
|
concessionária.</p>
|
|
|
|
<h2><code>class</code>: string</h2>
|
|
|
|
<p>Exemplos:</p>
|
|
|
|
<ul>
|
|
<li><code>"INDUSTRIAL"</code></li>
|
|
<li><code>"Comercial"</code></li>
|
|
</ul>
|
|
|
|
<p>A classe de consumo, conforme consta na fatura.</p>
|
|
|
|
<h2><code>subclass</code>: string</h2>
|
|
|
|
<p>Exemplos:</p>
|
|
|
|
<ul>
|
|
<li><code>"Comerc. Outros Serviços e Atividades"</code></li>
|
|
<li><code>"Administração Condominial"</code></li>
|
|
</ul>
|
|
|
|
<p>A subclasse de consumo, conforme consta na fatura.</p>
|
|
|
|
<h2><code>subgroup</code>: string</h2>
|
|
|
|
<p>Exemplos:</p>
|
|
|
|
<ul>
|
|
<li><code>"A2"</code></li>
|
|
<li><code>"A3a"</code></li>
|
|
<li><code>"B3"</code></li>
|
|
</ul>
|
|
|
|
<p>O subgrupo de tensão, conforme consta na fatura.</p>
|
|
|
|
<h2><code>group</code>: string</h2>
|
|
|
|
<p>Exemplos:</p>
|
|
|
|
<ul>
|
|
<li><code>"A"</code></li>
|
|
<li><code>"B"</code></li>
|
|
</ul>
|
|
|
|
<p>O grupo de tensão, conforme consta na fatura.</p>
|
|
|
|
<h2><code>customer</code>: object</h2>
|
|
|
|
<p>Exemplo (fictício):</p>
|
|
|
|
<pre><code>{
|
|
"customer": {
|
|
"cnpj": "00.000.000/0001-91",
|
|
"name": "ACME LTDA",
|
|
"address": {
|
|
"streetAndNumber": "AV ALMIRANTE TAMANDARÉ, 99",
|
|
"city": "FLORIANÓPOLIS",
|
|
"state": "SC",
|
|
"zipCode": "88900320"
|
|
}
|
|
}
|
|
}
|
|
</code></pre>
|
|
|
|
<p>São os dados do consumidor, conforme consta na fatura. Para pessoas jurídicas a
|
|
propriedade é <code>cnpj</code>, e para pessoas físicas é <code>cpf</code> — mas é possível que nenhum
|
|
número de documento esteja presente no objeto <code>customer</code>, pois frequentemente
|
|
não consta nenhum na fatura.</p>
|
|
|
|
<p>O endereço está dividido nos seguintes itens, todos opcionais:</p>
|
|
|
|
<ul>
|
|
<li><code>"streetAndNumber"</code>: nome da rua e número.</li>
|
|
<li><code>"district"</code>: bairro.</li>
|
|
<li><code>"state"</code>: estado, unidade federativa.</li>
|
|
<li><code>"city"</code>: município</li>
|
|
<li><code>"zipCode"</code>: CEP.</li>
|
|
</ul>
|
|
|
|
<h2><code>totalCharges</code>: number</h2>
|
|
|
|
<p>Exemplos (fictícios):</p>
|
|
|
|
<ul>
|
|
<li>22987.11</li>
|
|
<li>0.00</li>
|
|
</ul>
|
|
|
|
<p>O valor a pagar da fatura. Em geral, mas não sempre, corresponde ao somatório
|
|
dos itens faturados.</p>
|
|
|
|
<h2><code>tariffModality</code>: string</h2>
|
|
|
|
<p>Exemplos:</p>
|
|
|
|
<ul>
|
|
<li><code>"blue"</code></li>
|
|
<li><code>"green"</code></li>
|
|
<li><code>"standard"</code></li>
|
|
<li><code>"white"</code></li>
|
|
</ul>
|
|
|
|
<p>A modalidade da tarifa: <code>"blue"</code> (azul), <code>"green"</code> (verde), <code>"standard"</code>
|
|
(convencional) ou <code>"white"</code> (branca). Frequentemente não está presente no JSON
|
|
por não existir na fatura.</p>
|
|
|
|
<h2><code>dates</code>: object</h2>
|
|
|
|
<p>Exemplo (fictício):</p>
|
|
|
|
<pre><code>{
|
|
"due": "2022-11-23T00:00:00",
|
|
"month": "2022-10-01T00:00:00",
|
|
"issue": "2022-10-03T00:00:00",
|
|
"reading": {
|
|
"periodFrom": "2022-09-01T00:00:00",
|
|
"periodUntil": "2022-10-02T00:00:00",
|
|
"dateRead": "2022-10-02T00:00:00",
|
|
"next": "2022-11-01T00:00:00"
|
|
}
|
|
}
|
|
</code></pre>
|
|
|
|
<p>São as datas da fatura: <code>"due"</code> (vencimento), <code>"month"</code> (mês de referência),
|
|
<code>"issue"</code> (data de emissão). Dentro de <code>"reading"</code> estão as datas de leitura:
|
|
<code>"periodFrom"</code> (leitura anterior), <code>"periodUntil"</code> e <code>"dateRead"</code> (ambos são a
|
|
data de leitura atual) e <code>"next"</code> (previsão da próxima leitura). O objeto
|
|
<code>"reading"</code> também pode conter o atributo <code>"days"</code>, que corresponde ao número de
|
|
dias considerados no período.</p>
|
|
|
|
<p>Nenhuma das datas garantidamente encontra-se em todas as faturas. É raro, mas
|
|
até mesmo a data de vencimento e o mês de referência podem estar ausentes.</p>
|
|
|
|
<h2><code>barcode</code>: string</h2>
|
|
|
|
<p>Exemplos (fictícios):</p>
|
|
|
|
<ul>
|
|
<li><code>"92620000026.0.09120052107.1.90991225411.4.10099952491.5"</code></li>
|
|
<li><code>"987100000033 987300412319 195957881999 900038747489"</code></li>
|
|
</ul>
|
|
|
|
<p>A linha digitável, conforme consta na fatura. Normalmente não corresponde
|
|
exatamente ao código de barras, que é codificado de outra maneira.</p>
|
|
|
|
<h2><code>invoiceNumber</code>: string</h2>
|
|
|
|
<p>Exemplos (fictícios):</p>
|
|
|
|
<ul>
|
|
<li><code>"129.512.256"</code></li>
|
|
<li><code>"918791873"</code></li>
|
|
</ul>
|
|
|
|
<p>O número da nota fiscal, conforme consta na fatura.</p>
|
|
|
|
<h2><code>invoiceSeries</code>: string</h2>
|
|
|
|
<p>Exemplos:</p>
|
|
|
|
<ul>
|
|
<li><code>"ÚNICA"</code></li>
|
|
<li><code>"001"</code></li>
|
|
</ul>
|
|
|
|
<p>A série da nota fiscal, conforme consta na fatura.</p>
|
|
|
|
<h2><code>connectionType</code>: string</h2>
|
|
|
|
<p>Exemplos:</p>
|
|
|
|
<ul>
|
|
<li><code>"one-phase"</code></li>
|
|
<li><code>"two-phase"</code></li>
|
|
<li><code>"three-phase"</code></li>
|
|
</ul>
|
|
|
|
<p>O tipo de ligação: <code>"one-phase"</code> (monofásica), <code>"two-phase"</code> (bifásica) ou
|
|
<code>"three-phase"</code> (trifásica).</p>
|
|
|
|
<h2><code>automaticDebitEnabled</code>: boolean</h2>
|
|
|
|
<p>Quando a propriedade está presente e tem o valor <code>true</code>, indica que a fatura
|
|
está em débito automático. Esta propriedade nunca tem o valor <code>false</code>, já que é
|
|
difícil ou impossível afirmar, a partir da fatura, que ela com certeza não está
|
|
em débito automático.</p>
|
|
|
|
<h2><code>losses</code>: number</h2>
|
|
|
|
<p>Exemplos:</p>
|
|
|
|
<ul>
|
|
<li><code>0.0</code></li>
|
|
<li><code>0.025</code></li>
|
|
</ul>
|
|
|
|
<p>O valor das perdas de transformação, expresso em percentual (ou seja, <code>0.025</code>
|
|
corresponde a 2,5% de perdas).</p>
|
|
|
|
<h2><code>measuredItems</code>: array</h2>
|
|
|
|
<p>Exemplo (fictício):</p>
|
|
|
|
<pre><code>{
|
|
"measuredItems": [
|
|
{
|
|
"type": "energy",
|
|
"kind": "Gen.",
|
|
"period": "off-peak",
|
|
"texts": [
|
|
"Energia kWh"
|
|
],
|
|
"measured": 3023.0,
|
|
"previousMeterReading": 90877.0,
|
|
"currentMeterReading": 93900.0,
|
|
"meterMultiplier": 1.0
|
|
}
|
|
]
|
|
}
|
|
</code></pre>
|
|
|
|
<p>São os itens medidos presentes na fatura. Cada elemento do array é a medição de uma grandeza diferente.</p>
|
|
|
|
<p>Os seguintes atributos estão sempre presentes:</p>
|
|
|
|
<ul>
|
|
<li><code>"type"</code>: identifica de forma geral a grandeza: energia, demanda, ultrapassagem de demanda.</li>
|
|
<li><code>"kind"</code>: especifica se a grandeza está sendo considerada enquanto <code>"TUSD"</code>, <code>"TE"</code> ou <code>"Gen."</code> (ou seja, nenhuma especificação está presente no documento).</li>
|
|
<li><code>"period"</code>: um atributo guarda-chuva que recebe especificações adicionais; tipicamente <code>"peak"</code> (ponta) ou <code>"off-peak"</code> (fora de ponta).</li>
|
|
</ul>
|
|
|
|
<p>Outros atributos:</p>
|
|
|
|
<ul>
|
|
<li><code>"texts"</code>: descrições utilizadas de forma textual na fatura para se referir ao
|
|
item; por vir direto do documento, está sujeito a inúmeras variações.</li>
|
|
<li><code>"measured"</code>: o valor medido. Energia está sempre em kWh; demanda sempre em kW.</li>
|
|
<li><code>"previousMeterReading"</code>: a leitura anterior do medidor.</li>
|
|
<li><code>"currentMeterReading"</code>: a leitura atual do medidor.</li>
|
|
<li><code>"meterMultiplier"</code>: a constante de multiplicação.</li>
|
|
</ul>
|
|
|
|
<h2><code>items</code>: array</h2>
|
|
|
|
<p>Exemplo (fictício):</p>
|
|
|
|
<pre><code>{
|
|
"items": [
|
|
{
|
|
"type": "energy",
|
|
"kind": "Gen.",
|
|
"period": "peak",
|
|
"billed": 1338.0,
|
|
"rate": 1.77483873,
|
|
"charge": 2374.73,
|
|
"tusdRate": 0,
|
|
"teRate": 0,
|
|
"texts": [
|
|
"Energia Ativa kWh HP"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
</code></pre>
|
|
|
|
<p>Este array contém os itens faturados do documento. O atributo <code>"type"</code>
|
|
identifica, de forma geral, o tipo da cobrança. Os atributos restantes variam
|
|
conforme o <code>"type"</code>.</p>
|
|
|
|
<h3><code>"type"</code>: regra geral</h3>
|
|
|
|
<p>Exemplo (fictício):</p>
|
|
|
|
<pre><code>{
|
|
"type": "energy",
|
|
"kind": "Gen.",
|
|
"period": "injected energy, same consumer, same period",
|
|
"billed": 13.0,
|
|
"rate": 0.62235,
|
|
"charge": -8.09,
|
|
"texts": [
|
|
"Energia Atv Injetada mUC 4/2023 mPT"
|
|
],
|
|
"basicRate": 0.59908
|
|
}
|
|
</code></pre>
|
|
|
|
<p>Quando o atributo <code>"type"</code> representa uma grandeza conhecida, então os demais
|
|
atributos seguem um mesmo padrão. Os tipos em questão são:</p>
|
|
|
|
<ul>
|
|
<li><code>"energy"</code>: energia.</li>
|
|
<li><code>"demand"</code>: demanda.</li>
|
|
<li><code>"excessDemand"</code>: ultrapassagem da demanda.</li>
|
|
<li><code>"excessReactiveEnergy"</code>: energia reativa excedente.</li>
|
|
<li><code>"excessReactiveDemand"</code>: demanda reativa excedente.</li>
|
|
</ul>
|
|
|
|
<p>Os demais atributos seguem este padrão:</p>
|
|
|
|
<ul>
|
|
<li><code>"kind"</code>: <code>"TE"</code>, <code>"TUSD"</code> ou <code>"Gen."</code> (nem TE, nem TUSD).</li>
|
|
<li><code>"period"</code>: atributo com especificações adicionais, tipicamente <code>"peak"</code> ou <code>"off-peak"</code>.</li>
|
|
<li><code>"billed"</code>: a quantidade faturada. Energia fica em kWh, demanda em kW.</li>
|
|
<li><code>"charge"</code>: o valor monetário cobrado.</li>
|
|
<li><code>"rate"</code>: a tarifa, com impostos.</li>
|
|
<li><code>"texts"</code>: os textos descritivos, conforme constam na fatura.</li>
|
|
</ul>
|
|
|
|
<h3><code>"type": "other"</code></h3>
|
|
|
|
<p>Exemplo (fictício):</p>
|
|
|
|
<pre><code>{
|
|
"type": "other",
|
|
"name": "Atualização Monetária IPCA",
|
|
"charge": 2.53
|
|
}
|
|
</code></pre>
|
|
|
|
<p>Quando o item não se encaixou em nenhuma categoria que o sistema reconhece, ele
|
|
figura com <code>"type": "other"</code>. O atributo <code>"name"</code> contém o texto conforme a
|
|
fatura. Outros atributos que podem estar presentes:</p>
|
|
|
|
<ul>
|
|
<li><code>"charge"</code>: valor monetário cobrado.</li>
|
|
<li><code>"rate"</code>: tarifa (com impostos).</li>
|
|
<li><code>"billed"</code>: quantidade faturada.</li>
|
|
</ul>
|
|
|
|
<p>Em alguns casos em que optou-se pela manutenção de compatibilidade, o campo
|
|
<code>"name"</code> pode vir padronizado e, neste caso, o texto original está no atributo
|
|
<code>"texts"</code>.</p>
|
|
|
|
<h3><code>"type": "flagSurcharge"</code></h3>
|
|
|
|
<p>Exemplo (fictício):</p>
|
|
|
|
<pre><code>{
|
|
"type": "flagSurcharge",
|
|
"color": "scarcity",
|
|
"charge": 837.0,
|
|
"summable": false,
|
|
"texts": [
|
|
"Bandeira Escassez Hídrica"
|
|
]
|
|
}
|
|
</code></pre>
|
|
|
|
<p>É uma cobrança de adicional de bandeira tarifária. A cor/tipo da bandeira está no atributo <code>"color"</code>, que pode conter os seguintes valores:</p>
|
|
|
|
<ul>
|
|
<li><code>"green"</code>: bandeira verde.</li>
|
|
<li><code>"yellow"</code>: bandeira amarela.</li>
|
|
<li><code>"red"</code>: bandeira vermelha.</li>
|
|
<li><code>"red2"</code>: bandeira vermelha patamar 2.</li>
|
|
<li><code>"scarcity"</code>: bandeira de escassez hídrica.</li>
|
|
</ul>
|
|
|
|
<p>O atributo <code>"summable"</code> indica se o adicional de bandeira deve ser incluído no
|
|
somatório de cobranças para que seja atingido o valor total da fatura.</p>
|
|
|
|
<h3><code>"type": "tax"</code></h3>
|
|
|
|
<p>Exemplo (fictício):</p>
|
|
|
|
<pre><code>{
|
|
"type": "tax",
|
|
"name": "COFINS",
|
|
"taxable": 998.33,
|
|
"rate": 0.0404,
|
|
"charge": 40.33,
|
|
"summable": true,
|
|
"texts": [
|
|
"COFINS"
|
|
]
|
|
}
|
|
</code></pre>
|
|
|
|
<p>Um item de impostos. O nome padronizado do imposto está em <code>"name"</code>. Os outros atributos, opcionais, são:</p>
|
|
|
|
<ul>
|
|
<li><code>"taxable"</code>: base de cálculo.</li>
|
|
<li><code>"rate"</code>: alíquota.</li>
|
|
<li><code>"charge"</code>: valor monetário.</li>
|
|
<li><code>"texts"</code>: a descrição do imposto, conforme consta na fatura.</li>
|
|
<li><code>"summable"</code>: booleano que especifica se o item deve ser somado para se chegar ao total da fatura.</li>
|
|
</ul>
|
|
|
|
<h3><code>"type": "publicLighting"</code></h3>
|
|
|
|
<pre><code>{
|
|
"type": "publicLighting",
|
|
"charge": 26.35,
|
|
"texts": [
|
|
"COBRANCA ILUM PUBLICA PARA"
|
|
]
|
|
}
|
|
</code></pre>
|
|
|
|
<p>Item de cobrança de contribuição de iluminação pública. O valor monetário está
|
|
em <code>"charge"</code> e a descrição textual em <code>"texts"</code>.</p>
|
|
|
|
<h2><code>distributedGeneration</code>: array</h2>
|
|
|
|
<p>Exemplo (fictício):</p>
|
|
|
|
<pre><code>[
|
|
{
|
|
"name": "global expiring balance",
|
|
"value": 0.0
|
|
},
|
|
{
|
|
"name": "global accumulated balance",
|
|
"value": 2296.10
|
|
},
|
|
{
|
|
"name": "global monthly balance",
|
|
"value": 1299.0
|
|
}
|
|
]
|
|
</code></pre>
|
|
|
|
<p>Este array contém pares de nome/valor com informações específicas de geração distribuída.</p>
|
|
|
|
<h2><code>history</code>: object</h2>
|
|
|
|
<p>Exemplo (fictício):</p>
|
|
|
|
<pre><code>{
|
|
"2023-05-01": {
|
|
"items": [
|
|
{
|
|
"name": "off-peak energy",
|
|
"value": 279.0
|
|
}
|
|
],
|
|
"days": 32
|
|
}
|
|
}
|
|
</code></pre>
|
|
|
|
<p>Este é o histórico que frequentemente aparece nas faturas.</p>
|
|
|
|
<h2><code>stdProvider</code>: lista completa</h2>
|
|
|
|
<ul>
|
|
<li><code>"amazonas"</code></li>
|
|
<li><code>"anita_garibaldi"</code></li>
|
|
<li><code>"cea"</code></li>
|
|
<li><code>"ceb"</code></li>
|
|
<li><code>"cedrap"</code></li>
|
|
<li><code>"ceee"</code></li>
|
|
<li><code>"celesc"</code></li>
|
|
<li><code>"celpe"</code></li>
|
|
<li><code>"cemig"</code></li>
|
|
<li><code>"cemig"</code></li>
|
|
<li><code>"cemirim"</code></li>
|
|
<li><code>"ceprag"</code></li>
|
|
<li><code>"ceral"</code></li>
|
|
<li><code>"cerbranorte"</code></li>
|
|
<li><code>"cerci"</code></li>
|
|
<li><code>"ceres"</code></li>
|
|
<li><code>"cergrand"</code></li>
|
|
<li><code>"ceriluz"</code></li>
|
|
<li><code>"cerim"</code></li>
|
|
<li><code>"ceripa"</code></li>
|
|
<li><code>"cermoful"</code></li>
|
|
<li><code>"cernhe"</code></li>
|
|
<li><code>"cerpro"</code></li>
|
|
<li><code>"cerrp"</code></li>
|
|
<li><code>"cersul"</code></li>
|
|
<li><code>"certaja"</code></li>
|
|
<li><code>"certel"</code></li>
|
|
<li><code>"cervam"</code></li>
|
|
<li><code>"chesp"</code></li>
|
|
<li><code>"cocel"</code></li>
|
|
<li><code>"coelba"</code></li>
|
|
<li><code>"coopera"</code></li>
|
|
<li><code>"cooperaliança"</code></li>
|
|
<li><code>"coopercocal"</code></li>
|
|
<li><code>"cooperzem"</code></li>
|
|
<li><code>"coorsel"</code></li>
|
|
<li><code>"copel"</code></li>
|
|
<li><code>"coprel"</code></li>
|
|
<li><code>"cosern"</code></li>
|
|
<li><code>"cpfl_paulista"</code></li>
|
|
<li><code>"cpfl_piratininga"</code></li>
|
|
<li><code>"cpfl_santa_cruz"</code></li>
|
|
<li><code>"cpfl_santa_cruz"</code></li>
|
|
<li><code>"cpfl_santa_cruz"</code></li>
|
|
<li><code>"creluz"</code></li>
|
|
<li><code>"creral"</code></li>
|
|
<li><code>"demei"</code></li>
|
|
<li><code>"dme"</code></li>
|
|
<li><code>"edp_es"</code></li>
|
|
<li><code>"edp_sp"</code></li>
|
|
<li><code>"eflul"</code></li>
|
|
<li><code>"elektro"</code></li>
|
|
<li><code>"elektro"</code></li>
|
|
<li><code>"eletrocar"</code></li>
|
|
<li><code>"enel_ce"</code></li>
|
|
<li><code>"enel_go"</code></li>
|
|
<li><code>"enel_rj"</code></li>
|
|
<li><code>"enel_sp"</code></li>
|
|
<li><code>"energisa_ac"</code></li>
|
|
<li><code>"energisa_borborema"</code></li>
|
|
<li><code>"energisa_mg"</code></li>
|
|
<li><code>"energisa_minas_rio"</code></li>
|
|
<li><code>"energisa_ms"</code></li>
|
|
<li><code>"energisa_mt"</code></li>
|
|
<li><code>"energisa_nova_friburgo"</code></li>
|
|
<li><code>"energisa_pb"</code></li>
|
|
<li><code>"energisa_ro"</code></li>
|
|
<li><code>"energisa_se"</code></li>
|
|
<li><code>"energisa_sul_sudeste"</code></li>
|
|
<li><code>"energisa_sul_sudeste"</code></li>
|
|
<li><code>"energisa_sul_sudeste"</code></li>
|
|
<li><code>"energisa_to"</code></li>
|
|
<li><code>"equatorial_al"</code></li>
|
|
<li><code>"equatorial_ma"</code></li>
|
|
<li><code>"equatorial_pa"</code></li>
|
|
<li><code>"equatorial_pi"</code></li>
|
|
<li><code>"hidropan"</code></li>
|
|
<li><code>"iguaçu"</code></li>
|
|
<li><code>"joão_cesa"</code></li>
|
|
<li><code>"light"</code></li>
|
|
<li><code>"missões"</code></li>
|
|
<li><code>"pacto"</code></li>
|
|
<li><code>"rge_sul"</code></li>
|
|
<li><code>"rge_sul"</code></li>
|
|
<li><code>"roraima"</code></li>
|
|
<li><code>"santa_maria"</code></li>
|
|
<li><code>"sulgipe"</code></li>
|
|
</ul>
|
|
</div>
|
|
</main></body></html> |