In this article
API: Consumption Meter
The consumption meter endpoint is used to retrieve or modify existing billing details, insert new billing details, or delete or clear billing details.
Tip: For the most current and complete API information in Property Lease Management, run the following GET command.
Update the GET command to get the metadata for the product you want. Make a snippet from it and add it to all API pages
GET https://api.businesscentral.dynamics.com/v2.0/dd24e63d-2131-4bd0-bdd5-570c473ba440/api/binarystream/arcb/beta/$metadataWhen to Use
Provide info on when to use the endpoints.
| API Setup information | |
| Object ID: | 70701670 |
| Collection: | bssiPLMConsumptions |
The following pages are affected by this resource:
- Charge Details (Consumption Details dialog)
Display All Consumption Meters
Displays consumption data for all leases that have consumption charges.
Request:
- GET /bssiPLMConsumptions
Expand for detailed examples.
| Request Example |
| ODATA V4 example: |
|
GET https://api.businesscentral.dynamics.com/v2.0/dd24e63d-2131-4bd0-bdd5-570c473ba440/ODataV4/Company('CRONUS%20USA%2C%20Inc.')/bssiPLMConsumptions |
View example response body.
Select Copy to copy the sample to the clipboard.
Note: Use the FireFox web browser when selecting Copy to ensure that the tab spaces in the code are copied correctly. With other web browsers, the tab spaces are copied as non-breaking spaces, which can cause the code to fail.
Response (json)
{
"@odata.context": "http://tplm-default:7048/BC/ODataV4/$metadata#Company('CRONUS%20USA%2C%20Inc.')/BssiPLMConsumptionApi",
"value": [
{
"@odata.etag": "W/\"JzQ0O2djNkd4WTZsQTlBL2tSV1d1TktGekl6NjloaGxGR3RodjVDaTJpN2NWZ2s9MTswMDsn\"",
"SystemId": "54ccf4fd-a26d-ec11-be42-a367b810f4a7",
"BssiMeterNo": "CON 01",
"BssiReadingDate": "0001-01-01",
"BssiStartDate": "2020-01-01",
"BssiEndDate": "2020-01-31",
"BssiCurrentReading": 0,
"BssiQtyToInvoice": 0
},
{
"@odata.etag": "W/\"JzQ0O2FXSU9iSlRtN25kbWpGM1kwbDZkQnpYL3dtNFVaRElHVTVaLzlUT1hZRlU9MTswMDsn\"",
"SystemId": "b1f6b094-2a5d-ec11-99a5-a6dce45e433c",
"BssiMeterNo": "CON-01",
"BssiReadingDate": "0001-01-01",
"BssiStartDate": "2020-01-01",
"BssiEndDate": "2020-01-31",
"BssiCurrentReading": 0,
"BssiQtyToInvoice": 0
},
{
"@odata.etag": "W/\"JzQ0O3N4NVoxNkk1SnhTRDgvdkdmWlZoR2xTRWJUTTRod29GSjZoN0JQeG1CQWc9MTswMDsn\"",
"SystemId": "b2f6b094-2a5d-ec11-99a5-a6dce45e433c",
"BssiMeterNo": "CON-01",
"BssiReadingDate": "0001-01-01",
"BssiStartDate": "2020-02-01",
"BssiEndDate": "2020-02-29",
"BssiCurrentReading": 0,
"BssiQtyToInvoice": 0
},
{
"@odata.etag": "W/\"JzQ0O3Q3bVJQa2Q5QWpab1haVldxYlp4d1JqVTZZZ0pSU0ZaZW82MnVsdDRoYjg9MTswMDsn\"",
"SystemId": "b3f6b094-2a5d-ec11-99a5-a6dce45e433c",
"BssiMeterNo": "CON-01",
"BssiReadingDate": "0001-01-01",
"BssiStartDate": "2020-03-01",
"BssiEndDate": "2020-03-31",
"BssiCurrentReading": 0,
"BssiQtyToInvoice": 0
},
{
"@odata.etag": "W/\"JzQ0OzNFWm0yTmR6RmdIOFBMTENzVmR5UWh6OHNOaHdIMG9QUy9XOHlnUGQ3Zmc9MTswMDsn\"",
"SystemId": "b4f6b094-2a5d-ec11-99a5-a6dce45e433c",
"BssiMeterNo": "CON-01",
"BssiReadingDate": "0001-01-01",
"BssiStartDate": "2020-04-01",
"BssiEndDate": "2020-04-30",
"BssiCurrentReading": 0,
"BssiQtyToInvoice": 0
},
{
"@odata.etag": "W/\"JzQ0O2I0QlcwcTN0Tk5wSURCR0VlUEk2cnV2VzV3RmJ0QnlqdkRwcjJVbDdDTWc9MTswMDsn\"",
"SystemId": "b5f6b094-2a5d-ec11-99a5-a6dce45e433c",
"BssiMeterNo": "CON-01",
"BssiReadingDate": "0001-01-01",
"BssiStartDate": "2020-05-01",
"BssiEndDate": "2020-05-31",
"BssiCurrentReading": 0,
"BssiQtyToInvoice": 0
},
{
"@odata.etag": "W/\"JzQ0O045SVU0cDZXcnJheUN3cnZReHJqaXVGd2NNTHNsNU91c1Rsd0ZsWDhGOHc9MTswMDsn\"",
"SystemId": "b6f6b094-2a5d-ec11-99a5-a6dce45e433c",
"BssiMeterNo": "CON-01",
"BssiReadingDate": "0001-01-01",
"BssiStartDate": "2020-06-01",
"BssiEndDate": "2020-06-30",
"BssiCurrentReading": 0,
"BssiQtyToInvoice": 0
},
{
"@odata.etag": "W/\"JzQ0OzM3dk1zRFcvY1NFcFpoVE1zbml5Z2xwek5zVG90cHlrZFV6a2o0MG1GdFU9MTswMDsn\"",
"SystemId": "b7f6b094-2a5d-ec11-99a5-a6dce45e433c",
"BssiMeterNo": "CON-01",
"BssiReadingDate": "0001-01-01",
"BssiStartDate": "2020-07-01",
"BssiEndDate": "2020-07-31",
"BssiCurrentReading": 0,
"BssiQtyToInvoice": 0
},
{
"@odata.etag": "W/\"JzQ0O2k0MXFSMlBkVlhQbGNicUplQWZKa0Y4MWMraUlxK3A2aHRpQnNnVE5xblU9MTswMDsn\"",
"SystemId": "b8f6b094-2a5d-ec11-99a5-a6dce45e433c",
"BssiMeterNo": "CON-01",
"BssiReadingDate": "0001-01-01",
"BssiStartDate": "2020-08-01",
"BssiEndDate": "2020-08-31",
"BssiCurrentReading": 0,
"BssiQtyToInvoice": 0
},
{
"@odata.etag": "W/\"JzQ0O2dnTkhYajdwTWVwaWM5aVNOVUNySjh0S0tlOWlFQ1VJUW1wNUd1Zk1uL1E9MTswMDsn\"",
"SystemId": "b9f6b094-2a5d-ec11-99a5-a6dce45e433c",
"BssiMeterNo": "CON-01",
"BssiReadingDate": "0001-01-01",
"BssiStartDate": "2020-09-01",
"BssiEndDate": "2020-09-30",
"BssiCurrentReading": 0,
"BssiQtyToInvoice": 0
},
{
"@odata.etag": "W/\"JzQ0OzRFNmdqMnMyeTlhZjVZNU9maVVzQkc2QTFSZUJ4bTI4MSszelphZnVyRUU9MTswMDsn\"",
"SystemId": "baf6b094-2a5d-ec11-99a5-a6dce45e433c",
"BssiMeterNo": "CON-01",
"BssiReadingDate": "0001-01-01",
"BssiStartDate": "2020-10-01",
"BssiEndDate": "2020-10-31",
"BssiCurrentReading": 0,
"BssiQtyToInvoice": 0
},
{
"@odata.etag": "W/\"JzQ0O2tVd0ZYUVVsYjhDbWQ0cXIrNmJFaFpoTEZJS3FKU3J0WFl1M3JLS3I4Q009MTswMDsn\"",
"SystemId": "bbf6b094-2a5d-ec11-99a5-a6dce45e433c",
"BssiMeterNo": "CON-01",
"BssiReadingDate": "0001-01-01",
"BssiStartDate": "2020-11-01",
"BssiEndDate": "2020-11-30",
"BssiCurrentReading": 0,
"BssiQtyToInvoice": 0
},
{
"@odata.etag": "W/\"JzQ0OzNuVXBFajdyVHVzL3loS01tODlRcEM5d2Z6eFVucGRiT0VSMVRLaHZOZTg9MTswMDsn\"",
"SystemId": "bcf6b094-2a5d-ec11-99a5-a6dce45e433c",
"BssiMeterNo": "CON-01",
"BssiReadingDate": "0001-01-01",
"BssiStartDate": "2020-12-01",
"BssiEndDate": "2020-12-31",
"BssiCurrentReading": 0,
"BssiQtyToInvoice": 0
}
]
}Display Consumption for Specific Meter
Displays consumption data for specific meter number.
Request:
- GET /bssiPLMConsumptions?$filter=BssiMeterNo eq '<MeterNo>'
Expand for detailed examples.
| Request Example |
| ODATA V4 example: |
|
GET https://api.businesscentral.dynamics.com/v2.0/dd24e63d-2131-4bd0-bdd5-570c473ba440/ODataV4/Company('CRONUS%20USA%2C%20Inc.')/bssiPLMConsumptions?$filter=BssiMeterNo eq 'ABC' |
View example response body.
Select Copy to copy the sample to the clipboard.
Note: Use the FireFox web browser when selecting Copy to ensure that the tab spaces in the code are copied correctly. With other web browsers, the tab spaces are copied as non-breaking spaces, which can cause the code to fail.
Response (json)
{
"@odata.context": "http://tplm-default:7048/BC/ODataV4/$metadata#Company('CRONUS%20USA%2C%20Inc.')/BssiPLMConsumptionApi",
"value": [
{
"@odata.etag": "W/\"JzQ0O2djNkd4WTZsQTlBL2tSV1d1TktGekl6NjloaGxGR3RodjVDaTJpN2NWZ2s9MTswMDsn\"",
"SystemId": "54ccf4fd-a26d-ec11-be42-a367b810f4a7",
"BssiMeterNo": "CON 01",
"BssiReadingDate": "0001-01-01",
"BssiStartDate": "2020-01-01",
"BssiEndDate": "2020-01-31",
"BssiCurrentReading": 0,
"BssiQtyToInvoice": 0
}
]
}Update Meter Consumption Data
Updates meter consumption data for a meter with a reading type Consumption.
Request:
- POST /bssiPLMConsumptions
Expand for detailed examples.
| Request Example |
| ODATA V4 example: |
| POST https://api.businesscentral.dynamics.com/v2.0/dd24e63d-2131-4bd0-bdd5-570c473ba440/ODataV4/Company('CRONUS%20USA%2C%20Inc.')/bssiPLMConsumptions |
View example request body.
Select Copy to copy the sample to the clipboard.
Note: Use the FireFox web browser when selecting Copy to ensure that the tab spaces in the code are copied correctly. With other web browsers, the tab spaces are copied as non-breaking spaces, which can cause the code to fail.
View example response body.
Select Copy to copy the sample to the clipboard.
Note: Use the FireFox web browser when selecting Copy to ensure that the tab spaces in the code are copied correctly. With other web browsers, the tab spaces are copied as non-breaking spaces, which can cause the code to fail.
Response (json)
{
"@odata.context": "http://tplm-default:7048/BC/ODataV4/$metadata#Company('CRONUS%20USA%2C%20Inc.')/bssiPLMConsumptions/$entity",
"@odata.etag": "W/\"JzQ0O1dTOXFjcEhBNEZvQk5iWENnam9tcVRIeUcvSDFLdkFEaU8xUUJtRi9yMmc9MTswMDsn\"",
"SystemId": "00000000-0000-0000-0000-000000000000",
"BssiMeterNo": "ABC",
"BssiReadingDate": "2020-02-01",
"BssiStartDate": "0001-01-01",
"BssiEndDate": "0001-01-01",
"BssiCurrentReading": 0,
"BssiQtyToInvoice": 3
}Update Meter Reading Data
Updates meter reading data for a meter with reading type Reading.
Request:
- POST /bssiPLMConsumptions
Expand for detailed examples.
| Request Example |
| ODATA V4 example: |
| POST https://api.businesscentral.dynamics.com/v2.0/dd24e63d-2131-4bd0-bdd5-570c473ba440/ODataV4/Company('CRONUS%20USA%2C%20Inc.')/bssiPLMConsumptions |
View example request body.
Select Copy to copy the sample to the clipboard.
Note: Use the FireFox web browser when selecting Copy to ensure that the tab spaces in the code are copied correctly. With other web browsers, the tab spaces are copied as non-breaking spaces, which can cause the code to fail.
Request (json)
{
"BssiMeterNo": "CONSUMPTION READING TYPE",
"BssiReadingDate": "2020-02-01",
"BssiCurrentReading": 2
}Select Copy to copy the sample to the clipboard.
Note: Use the FireFox web browser when selecting Copy to ensure that the tab spaces in the code are copied correctly. With other web browsers, the tab spaces are copied as non-breaking spaces, which can cause the code to fail.
Response (json)
{
"@odata.context": "http://tplm-default:7048/BC/ODataV4/$metadata#Company('CRONUS%20USA%2C%20Inc.')/bssiPLMConsumptions/$entity",
"@odata.etag": "W/\"JzQ0OzJRUWxOY3kyczFQemFROWNnUHdiL2R5UHFTK2pGSndSa1NreERLRGVYTVk9MTswMDsn\"",
"SystemId": "00000000-0000-0000-0000-000000000000",
"BssiMeterNo": "CONSUMPTION READING TYPE",
"BssiReadingDate": "2020-02-01",
"BssiStartDate": "0001-01-01",
"BssiEndDate": "0001-01-01",
"BssiCurrentReading": 2,
"BssiQtyToInvoice": 2
}
Delete a Meter
Deletes a meter.
Request:
- DELETE /bssiPLMConsumptions
Expand for detailed examples.
| Request Example |
| ODATA V4 example: |
| DELETE https://api.businesscentral.dynamics.com/v2.0/dd24e63d-2131-4bd0-bdd5-570c473ba440/ODataV4/Company('CRONUS%20USA%2C%20Inc.')/bssiPLMConsumptions(e5c8e0ef-fc72-ec11-be42-a367b810f4a7) |