Endpoint que exporta rateio para Excel.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| POST | /api/v3/apportionments/{apportionmentId}/export-excel/ | Content-Type:application/json | Authorization: Bearer token |
apportionmentId: 1 (integer) - "Id do Rateio."date: '2021-06-01' (string, required) - "Mês/ano de referência do rateio."
send_cost_centers: true (bool, nullable) - "Envia excel indivisual de cada centro de custo." {success} Response 200 (application/json)
[
"Processo iniciado com sucesso, ao concluir enviaremos via email!"
]{warning} Response 422 (application/json)
{
"date": [
"Não existe ainda rateio processado no período informado."
]
}{primary} Response 204 (application/json).
Quando os critérios de parâmetros não contiver registros a serem retornados.
Endpoint que retorna os dados do rateio utilizado no Excel.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| GET | /api/v3/apportionments/{apportionmentId}/data-excel?date={date} | Content-Type:application/json | Authorization: Bearer token |
apportionmentId: 1 (integer) - "Id do Rateio."
date: '2021-06-01' (string, required) - "Mês/ano de referência do rateio."{success} Response 200 (application/json)
{
"name": "Apportionment name",
"type": "Energia",
"company": "Company Name",
"current_date": "2021-06-01",
"current_value": 1350,
"percentage_diff": 237.5,
"one_ago_date": "2021-05-01",
"one_ago_value": 400,
"cost_centers": [
{
"name": "Cost Center name",
"tariff_used": 150,
"tariff_type": "Livre",
"composition": 77.78,
"current_value": 1050,
"percentage_diff": 425,
"percentage_diff_consumption_used": 100.75,
"equipments": [
{
"name": "Equipment name",
"usage_limit": 25,
"current_value": 162,
"percentage_diff": 50,
"data_log": {
"counter": {
"final_date": "2023-01-26 00:00:01",
"initial_date": "2023-01-13 23:59:59",
"final_consumption": 251,
"consumption_counter": 152,
"initial_consumption": 99
},
"measurements":{
"final_period":{
"date_final": "2023-01-31 00:00:00",
"consumption": 0,
"date_initial": "2023-01-26 00:00:02"
},
"initial_period":{
"date_final": "2023-01-13 23:59:58",
"consumption": 10,
"date_initial": "2023-01-01 00:00:01"
},
"consumption_measurements": 10
}
}
}
],
"additional_fees": [
{
"fee_name": "Fee name",
"value": 10,
"fee_value_used": 100,
"composition_used": 35
}
],
"additional_consumption": [
{
"value": 10,
"consumption_used": 0.1,
"tariff_used": 100
}
]
}
]
} {primary} Response 204 (application/json).
Quando os critérios de parâmetros não contiver registros a serem retornados.
Endpoint que exporta rateio para Excel.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| POST | /api/v3/cost-centers/{costCenterId}/export-excel/ | Content-Type:application/json | Authorization: Bearer token |
costCenterId: 1 (integer) - "Id do cento de custo."date: '2023-11-01' (string, required) - "Mês/ano de referência do rateio."{info} Observações:
Caso o centro de custo não tiver email vinculado irá retornar erro no campo email.
{success} Response 200 (application/json)
[
"Processo iniciado com sucesso, ao concluir enviaremos via email!"
]{warning} Response 422 (application/json)
{
"date": [
"Não existe ainda rateio processado no período informado."
],
"email": [
"É necessário vincular um email para o processo de download."
]
}