Energy Cost Resource¶
Update Energy Cost¶
HTTP Request
PUT /api/energyCost/{id}
📋 Description: Updates the energy cost details for a specified resource, identified by the unique ID, ensuring accurate financial tracking and management of energy expenditures.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing updated energy cost details, including the cost value, effective date, and any relevant adjustments for the specified energy cost record. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "date": "2019-08-24",
7 "amount": 0,
8 "energyTypeId": 0,
9 "energyTypeName": "string",
10 "energyUnitId": 0,
11 "energyUnitName": "string",
12 "energyStatusId": 0,
13 "energyStatus": "string",
14 "energyStatusType": "string",
15 "premiseId": 0,
16 "premiseDisplayId": "string",
17 "documentIds": [
18 0
19 ],
20 "source": "MANUAL",
21 "consumedQuantity": 0
22}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{}
Response Schema
Delete Energy Cost¶
HTTP Request
DELETE /api/energyCost/{id}
📋 Description: Deletes the specified energy cost record identified by the unique ID, ensuring accurate financial tracking and management of energy expenses.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Create Energy Cost¶
HTTP Request
POST /api/energyCost
📋 Description: Submits energy cost data for processing, enabling businesses to analyze and manage their energy expenses effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the energy consumption data and associated cost metrics necessary for calculating and optimizing energy expenses. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "date": "2019-08-24",
7 "amount": 0,
8 "energyTypeId": 0,
9 "energyTypeName": "string",
10 "energyUnitId": 0,
11 "energyUnitName": "string",
12 "energyStatusId": 0,
13 "energyStatus": "string",
14 "energyStatusType": "string",
15 "premiseId": 0,
16 "premiseDisplayId": "string",
17 "documentIds": [
18 0
19 ],
20 "source": "MANUAL",
21 "consumedQuantity": 0
22}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "date": "2019-08-24",
7 "amount": 0,
8 "energyTypeId": 0,
9 "energyTypeName": "string",
10 "energyUnitId": 0,
11 "energyUnitName": "string",
12 "energyStatusId": 0,
13 "energyStatus": "string",
14 "energyStatusType": "string",
15 "premiseId": 0,
16 "premiseDisplayId": "string",
17 "documentIds": [
18 0
19 ],
20 "source": "MANUAL",
21 "consumedQuantity": 0
22}
Get Energy Cost By Premises ID¶
HTTP Request
GET /api/energyCost/premises/{premisesId}
📋 Description: Retrieves the energy cost details for a specified premises, enabling businesses to analyze and manage their energy expenditures effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
premisesId |
path |
integer(int64) |
true |
Unique identifier for the premises |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "displayId": "string",
7 "date": "2019-08-24",
8 "amount": 0,
9 "energyTypeId": 0,
10 "energyTypeName": "string",
11 "energyUnitId": 0,
12 "energyUnitName": "string",
13 "energyStatusId": 0,
14 "energyStatus": "string",
15 "energyStatusType": "string",
16 "premiseId": 0,
17 "premiseDisplayId": "string",
18 "documentIds": [
19 0
20 ],
21 "source": "MANUAL",
22 "consumedQuantity": 0
23 }
24]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the estimated energy costs associated with operational activities, enabling businesses to analyze and manage their energy expenditures effectively.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» displayId |
string |
false |
none |
Unique identifier for the display |
» date |
string(date) |
false |
none |
Date of the resource |
» amount |
number |
true |
none |
Amount value |
» energyTypeId |
integer(int64) |
false |
none |
Unique identifier for the energy type |
» energyTypeName |
string |
false |
none |
Name of the energy type |
» energyUnitId |
integer(int64) |
false |
none |
Unique identifier for the energy unit |
» energyUnitName |
string |
false |
none |
Name of the energy unit |
» energyStatusId |
integer(int64) |
false |
none |
Unique identifier for the energy status |
» energyStatus |
string |
false |
none |
Status of the energy |
» energyStatusType |
string |
false |
none |
Type of the energy status |
» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
» premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
» documentIds |
[integer] |
false |
none |
An array of unique identifiers for documents related to energy cost analysis, facilitating efficient tracking and management of associated data. |
» source |
string |
false |
none |
Indicates the origin of the energy cost data, providing essential context for analysis and reporting. |
» consumedQuantity |
number |
false |
none |
Quantity of consumed quantity |
Enumerated Values
Attribute |
Value |
|---|---|
source |
AUTOMATIC, MANUAL |
Get All Active Energy Unit IDs¶
HTTP Request
GET /api/energyCost/allActiveEnergyUnits
📋 Description: Retrieves a list of all active energy units, providing essential data for energy cost analysis and management.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 0
3]
Response Schema
Get All Active Energy Status IDs¶
HTTP Request
GET /api/energyCost/allActiveEnergyStatus
📋 Description: Retrieves the current status of all active energy costs, providing essential insights for energy management and cost optimization.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 0
3]
Response Schema
Get All Active Energy Cost Type IDs¶
HTTP Request
GET /api/energyCost/allActiveEnergyCostTypes
📋 Description: Retrieves a list of all active energy cost types, providing essential data for energy management and financial analysis.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 0
3]