Endpoint que lista todos os rateios cadastrados.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| GET | /api/v3/apportionments | Content-Type:application/json | Authorization: Bearer {token} |
_q: 'texto' (string) - "Busca os rateios cadastrados."
_sort: 'id' (string) ('id', 'name') - "Define o campo de ordenação da lista."
_order: 'desc' (string) ('asc', 'desc') - "Define a ordem da lista com base no campo definido."
_limit: 10 (integer) - "Quantidade de itens por página."
_page: 1 (integer) - "Página a ser carregada."{success} Response 200 (application/json)
{
"items": [
{
"id": 1,
"name": "Rateio x",
"description": "Descrição do rateio",
"mixed_consumption": true,
"limit_day": 1,
"company": {
"id": 1,
"name": "Company name"
},
"apportionment_type": {
"id": 1,
"name": "Energia"
},
"apportionment_tariff_type": {
"id": 3,
"name": "Customizado"
},
"apportionment_measure_unit": {
"id": 1,
"name": "MWh"
},
"cost_center_ids": [
1,
8,
88
],
"apportionment_groups_ids": [
1,
8,
88
]
}
],
"total": 1,
"per_page": 10,
"current_page": 1
}{warning} Response 422 (application/json)
{
"_sort": [
"O campo sort selecionado é inválido."
],
"_order": [
"O campo order selecionado é inválido."
],
"_limit": [
"O campo limit deve ser um número inteiro."
],
"_page": [
"O campo page deve ser um número inteiro."
]
}{primary} Response 204 (application/json).
Quando os critérios de parâmetros não contiver registros a serem retornados.
Endpoint que pega um rateio específico.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| GET | /api/v3/apportionments/{id} | Content-Type:application/json | Authorization: Bearer {token} |
id: 1 (integer, required) - "Id do Rateio"{success} Response 200 (application/json)
{
"id": 1,
"name": "Rateio x",
"description": "Descrição do rateio",
"mixed_consumption": true,
"limit_day": 1,
"company": {
"id": 1,
"name": "Company name"
},
"apportionment_type": {
"id": 1,
"name": "Energia"
},
"apportionment_tariff_type": {
"id": 3,
"name": "Customizado"
},
"apportionment_measure_unit": {
"id": 1,
"name": "MWh"
},
"cost_center_ids": [
1,
8,
88
],
"apportionment_groups_ids": [
1,
8,
88
]
}{primary} Response 204 (application/json)
Quando o registro não existir ou o usuário não tiver permissão de visualização.
Endpoint que cria um rateio.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| POST | /api/v3/apportionments | Content-Type:application/json | Authorization: Bearer {token} |
{info} Regras por tipo de tarifa:
Tarifa mercado cativo: Empresa deve possuir o cadastro de um physical asset.
Tarifa mercado livre: Empresa deve possuir um contrato válido.
company_id: 1 (integer, required) - "Id da Empresa.",
apportionment_type_id: 1 (integer, required) - "Id do tipo de rateio.",
apportionment_tariff_type_id: 3 (integer, required) - "Id do tipo de tarifa de rateio.",
apportionment_measure_unit_id: 1 (integer, required) - "Id da unidade de medida do rateio.",
name: "Rateio x" (string, required) - "Nome do rateio.",
description: "Descrição do rateio" (string, required) - "Descrição do rateio.",
mixed_consumption: true (boolean) - "Utiliza dados de telemetria para compor o consumo do período."
limit_day: 1 (integer) - "Dia limite para processar o rateio."{success} Response 201 (application/json)
{
"id": 1,
"name": "Rateio x",
"description": "Descrição do rateio",
"mixed_consumption": true,
"limit_day": 1,
"company": {
"id": 1,
"name": "Company name"
},
"apportionment_type": {
"id": 1,
"name": "Energia"
},
"apportionment_tariff_type": {
"id": 3,
"name": "Customizado"
},
"apportionment_measure_unit": {
"id": 1,
"name": "MWh"
},
"cost_center_ids": [
1,
8,
88
],
"apportionment_groups_ids": [
1,
8,
88
]
}{primary} Response 204 (application/json)
Quando o registro não existir ou o usuário não tiver permissão de visualização.
Endpoint que atualiza um rateio específico.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| PUT | /api/v3/apportionments/{id} | Content-Type:application/json | Authorization: Bearer {token} |
id: 1 (integer, required) - "Id do Rateio"{info} Regras por tipo de tarifa:
Tarifa mercado cativo: Empresa deve possuir o cadastro de um physical asset.
Tarifa mercado livre: Empresa deve possuir um contrato válido.
apportionment_tariff_type_id: 3 (integer) - "Id do tipo de tarifa de rateio.",
name: "Rateio x" (string) - "Nome do rateio.",
description: "Descrição do rateio" (string) - "Descrição do rateio.",
mixed_consumption: false (boolean) - "Utiliza dados de telemetria para compor o consumo do período."
limit_day: 1 (integer) - "Dia limite para processar o rateio."{success} Response 200 (application/json)
{
"id": 1,
"name": "Rateio atualizado",
"description": "Descrição do rateio",
"mixed_consumption": false,
"limit_day": 1,
"company": {
"id": 1,
"name": "Company name"
},
"apportionment_type": {
"id": 1,
"name": "Energia"
},
"apportionment_tariff_type": {
"id": 3,
"name": "Customizado"
},
"apportionment_measure_unit": {
"id": 1,
"name": "MWh"
},
"cost_center_ids": [
1,
8,
88
],
"apportionment_groups_ids": [
1,
8,
88
]
}{primary} Response 204 (application/json)
Quando o registro não existir ou o usuário não tiver permissão de visualização.
Endpoint que deleta um rateio específico.
| Method | URI | Headers | Authorization |
|---|---|---|---|
| DELETE | /api/v3/apportionments/{id} | Content-Type:application/json | Authorization: Bearer {token} |
id: 1 (integer, required) - "Id do Rateio"{primary} Response 204 (application/json)
Quando o registro for excluído com sucesso.