In this article
API: Lease Charges
The lease charges endpoint is used to add lines to, delete lines from, or modify lines for leases.
Tip: For the most current and complete API information in Property Lease Management, run the following GET command.
GET https://api.businesscentral.dynamics.com/v2.0/dd24e63d-2131-4bd0-bdd5-570c473ba440/api/binarystream/plm/v1.0/$metadataWhen to Use
As a best practice, use this endpoint to add, update, or delete charges for a lease.
| API Setup information | |
| PLM Lease Charge API | |
| Object ID: | 70701627 |
| Collection: | bssiPLMLeaseCharges |
The following pages are affected by this resource:
Display All Charges
Displays all charge lines for all leases.
Request:
- GET /PLMLeaseChargeAPI
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.')/PLMLeaseChargesAPI |
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": "https://api.businesscentral.dynamics.com/v2.0/dd24e63d-2131-4bd0-bdd5-570c473ba440/ODataV4/$metadata#Company('CRONUS%20USA%2C%20Inc.')/PLMLeaseChargesAPI",
"value": [
{
"@odata.etag": "W/\"JzQ0O21lSWVwSUVSM2E3Y3h5VE1mSUwrZ1Q1TUhKNU9HSHgvRGlKWlhYYUlBM1E9MTswMDsn\"",
"SystemId": "f44198c0-0002-ec11-a4b3-8885d89ce942",
"BssiPlmLeaseNo": "PLM055",
"BssiPLMCategoryName": "PROPERTY MANAGEMENT AGENT",
"BssiPLMLevel1No": "1000 KINGSWAY",
"BssiPLMLevel2No": "1ST",
"BssiPLMLevel3No": "101",
"BssiPLMChargeNo": "CONFERENCE ROOM 101",
"BssiPLMChargeName": "Conference Room 101",
"BssiPLMChargeType": "Regular",
"BssiPLMBillingFrequency": "Weekly",
"BssiPLMMeterNo": "",
"BssiPLMQuantity": 1,
"BssiPLMUnit": "",
"BssiPlMTaxGroupCode": "",
"BssiPLMAmount": 100,
"BssiPLMExtendedAmount": 100,
"BssiPLMPeriodByPeriod": false,
"BssiPLMSeparateInvoice": false,
"BssiPLMChargeStatus": "Available",
"BssiPLMMeterReadingType": "Reading"
},
{
"@odata.etag": "W/\"JzQ0O1djMDFqbHZXb3N4eDF0WXFzMnZHdW9mUTBBQ05pQ3ljSGxZQzFyWDBsMjQ9MTswMDsn\"",
"SystemId": "11af600c-0102-ec11-a4b3-8885d89ce942",
"BssiPlmLeaseNo": "PLM056",
"BssiPLMCategoryName": "",
"BssiPLMLevel1No": "",
"BssiPLMLevel2No": "",
"BssiPLMLevel3No": "",
"BssiPLMChargeNo": "CONFERENCE ROOM 105",
"BssiPLMChargeName": "",
"BssiPLMChargeType": "Regular",
"BssiPLMBillingFrequency": "Weekly",
"BssiPLMMeterNo": "GMETER02",
"BssiPLMQuantity": 1,
"BssiPLMUnit": "",
"BssiPlMTaxGroupCode": "",
"BssiPLMAmount": 100,
"BssiPLMExtendedAmount": 0,
"BssiPLMPeriodByPeriod": false,
"BssiPLMSeparateInvoice": false,
"BssiPLMChargeStatus": "Available",
"BssiPLMMeterReadingType": "Consumption"
},
{
"@odata.etag": "W/\"JzQ0OzZYUWJuMzdMZG1JUU9VR3NuRTVVaVA2eDZBWVM1VGdpNHdxODRBVHh3c3M9MTswMDsn\"",
"SystemId": "a490f834-4d04-ec11-a4b3-8885d89ce942",
"BssiPlmLeaseNo": "PLM057",
"BssiPLMCategoryName": "PROPERTY MANAGEMENT AGENT",
"BssiPLMLevel1No": "1000 KINGSWAY",
"BssiPLMLevel2No": "1ST",
"BssiPLMLevel3No": "102",
"BssiPLMChargeNo": "EQUIP-001",
"BssiPLMChargeName": "Equipmnet 001",
"BssiPLMChargeType": "Consumption",
"BssiPLMBillingFrequency": "Weekly",
"BssiPLMMeterNo": "GMETER01",
"BssiPLMQuantity": 0,
"BssiPLMUnit": "",
"BssiPlMTaxGroupCode": "",
"BssiPLMAmount": 100,
"BssiPLMExtendedAmount": 0,
"BssiPLMPeriodByPeriod": false,
"BssiPLMSeparateInvoice": false,
"BssiPLMChargeStatus": "Available",
"BssiPLMMeterReadingType": "Consumption"
},
{
"@odata.etag": "W/\"JzQ0OzM4cWZaYXBid2ZiNHc4SDJ3WExLNU5ONWNudktsa1V2a2gwTE9uUXowdkU9MTswMDsn\"",
"SystemId": "b2fea98a-2705-ec11-a6b9-f7df9e04a6bf",
"BssiPlmLeaseNo": "PLM065",
"BssiPLMCategoryName": "PARKING LOT",
"BssiPLMLevel1No": "101",
"BssiPLMLevel2No": "",
"BssiPLMLevel3No": "",
"BssiPLMChargeNo": "CONFERENCE ROOM 101",
"BssiPLMChargeName": "Conference Room 101",
"BssiPLMChargeType": "Regular",
"BssiPLMBillingFrequency": "Weekly",
"BssiPLMMeterNo": "",
"BssiPLMQuantity": 1,
"BssiPLMUnit": "",
"BssiPlMTaxGroupCode": "",
"BssiPLMAmount": 100,
"BssiPLMExtendedAmount": 100,
"BssiPLMPeriodByPeriod": false,
"BssiPLMSeparateInvoice": false,
"BssiPLMChargeStatus": "Available",
"BssiPLMMeterReadingType": "Reading"
},
{
"@odata.etag": "W/\"JzQ0O3ZwcGJmaXpKRnB5R1ZhUnNFZlRoTFdFRkwvMFR3WjZidXNGY3JTcmYyTmc9MTswMDsn\"",
"SystemId": "19bdd6b7-c005-ec11-a6b9-f7df9e04a6bf",
"BssiPlmLeaseNo": "TESTLEASECHARGEAPI082521-01",
"BssiPLMCategoryName": "PROPERTY MANAGEMENT AGENT",
"BssiPLMLevel1No": "1000 KINGSWAY",
"BssiPLMLevel2No": "1ST",
"BssiPLMLevel3No": "101",
"BssiPLMChargeNo": "CONFERENCE ROOM 101",
"BssiPLMChargeName": "Conference Room 101",
"BssiPLMChargeType": "Regular",
"BssiPLMBillingFrequency": "Monthly",
"BssiPLMMeterNo": "",
"BssiPLMQuantity": 1,
"BssiPLMUnit": "",
"BssiPlMTaxGroupCode": "",
"BssiPLMAmount": 100,
"BssiPLMExtendedAmount": 100,
"BssiPLMPeriodByPeriod": false,
"BssiPLMSeparateInvoice": false,
"BssiPLMChargeStatus": "Active",
"BssiPLMMeterReadingType": "Reading"
},
{
"@odata.etag": "W/\"JzQ0O01BbVNlOXVOQm1pc0NLVVhLc1paRWQ1Nk1UODBacFViVy9HdUhkRzRLNVE9MTswMDsn\"",
"SystemId": "c2466345-c905-ec11-a6b9-f7df9e04a6bf",
"BssiPlmLeaseNo": "TESTLEASECHARGEAPI082521-02",
"BssiPLMCategoryName": "PROPERTY MANAGEMENT AGENT",
"BssiPLMLevel1No": "1000 KINGSWAY",
"BssiPLMLevel2No": "1ST",
"BssiPLMLevel3No": "101",
"BssiPLMChargeNo": "CONFERENCE ROOM 101",
"BssiPLMChargeName": "Conference Room 101",
"BssiPLMChargeType": "Regular",
"BssiPLMBillingFrequency": "Monthly",
"BssiPLMMeterNo": "",
"BssiPLMQuantity": 1,
"BssiPLMUnit": "",
"BssiPlMTaxGroupCode": "",
"BssiPLMAmount": 100,
"BssiPLMExtendedAmount": 100,
"BssiPLMPeriodByPeriod": false,
"BssiPLMSeparateInvoice": false,
"BssiPLMChargeStatus": "Active",
"BssiPLMMeterReadingType": "Reading"
}
]
}Display Specific Charge
Displays all charge lines for a specific lease.
Request:
- GET /PLMLeaseChargeAPI?$filter=BssiPlmLeaseNo eq 'LeaseNo'
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.')/PLMLeaseChargesAPI?$filter=BssiPlmLeaseNo eq 'PLM055' |
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": "https://api.businesscentral.dynamics.com/v2.0/dd24e63d-2131-4bd0-bdd5-570c473ba440/ODataV4/$metadata#Company('CRONUS%20USA%2C%20Inc.')/PLMLeaseChargesAPI",
"value": [
{
"@odata.etag": "W/\"JzQ0O21lSWVwSUVSM2E3Y3h5VE1mSUwrZ1Q1TUhKNU9HSHgvRGlKWlhYYUlBM1E9MTswMDsn\"",
"SystemId": "f44198c0-0002-ec11-a4b3-8885d89ce942",
"BssiPlmLeaseNo": "PLM055",
"BssiPLMCategoryName": "PROPERTY MANAGEMENT AGENT",
"BssiPLMLevel1No": "1000 KINGSWAY",
"BssiPLMLevel2No": "1ST",
"BssiPLMLevel3No": "101",
"BssiPLMChargeNo": "CONFERENCE ROOM 101",
"BssiPLMChargeName": "Conference Room 101",
"BssiPLMChargeType": "Regular",
"BssiPLMBillingFrequency": "Weekly",
"BssiPLMMeterNo": "",
"BssiPLMQuantity": 1,
"BssiPLMUnit": "",
"BssiPlMTaxGroupCode": "",
"BssiPLMAmount": 100,
"BssiPLMExtendedAmount": 100,
"BssiPLMPeriodByPeriod": false,
"BssiPLMSeparateInvoice": false,
"BssiPLMChargeStatus": "Available",
"BssiPLMMeterReadingType": "Reading"
}
]
}Create Charge
Creates a charge line for a lowest level for a lease.
Request:
- POST /PLMLeaseChargeAPI
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.')/PLMLeaseChargeAPI |
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)
{
"BssiPlmLeaseNo": "PLM077",
"BssiPLMCategoryName": "EQUIPMENT",
"BssiPLMLevel1No": "",
"BssiPLMLevel2No": "",
"BssiPLMLevel3No": "",
"BssiPLMChargeNo": "CONFERENCE ROOM 101",
"BssiPLMChargeName": "From API (0 Level)",
"BssiPLMChargeType": "Regular",
"BssiPLMBillingFrequency": "Weekly",
"BssiPLMMeterNo": "",
"BssiPLMQuantity": 1,
"BssiPLMUnit": "",
"BssiPlMTaxGroupCode": "",
"BssiPLMAmount": 100,
"BssiPLMExtendedAmount": 100,
"BssiPLMPeriodByPeriod": false,
"BssiPLMSeparateInvoice": false,
"BssiPLMChargeStatus": "Available",
"BssiPLMMeterReadingType": "Reading"
}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": https://api.businesscentral.dynamics.com/v2.0/dd24e63d-2131-4bd0-bdd5-570c473ba440/ODataV4/$metadata#Company('CRONUS%20USA%2C%20Inc.')/PLMLeaseChargesAPI/$entity,
"@odata.etag": "W/\"JzQ0O0lPY1FoWWgxU2lZMEc0a2FiSTZIWld5eWQrL1I2Q2ozUmdVcWlobHpsbUk9MTswMDsn\"",
"SystemId": "3526f8a8-1406-ec11-a6b9-f7df9e04a6bf",
"BssiPlmLeaseNo": "PLM077",
"BssiPLMCategoryName": "EQUIPMENT",
"BssiPLMLevel1No": "",
"BssiPLMLevel2No": "",
"BssiPLMLevel3No": "",
"BssiPLMChargeNo": "CONFERENCE ROOM 101",
"BssiPLMChargeName": "From API (0 Level)",
"BssiPLMChargeType": "Regular",
"BssiPLMBillingFrequency": "Weekly",
"BssiPLMMeterNo": "",
"BssiPLMQuantity": 1,
"BssiPLMUnit": "",
"BssiPlMTaxGroupCode": "",
"BssiPLMAmount": 100,
"BssiPLMExtendedAmount": 100,
"BssiPLMPeriodByPeriod": false,
"BssiPLMSeparateInvoice": false,
"BssiPLMChargeStatus": "Available",
"BssiPLMMeterReadingType": "Reading"
}Modify Charges
Modifies all charge lines for a lease.
Request:
- PATCH /PLMLeaseChargeAPI
Expand for detailed examples.
| Request Example |
| ODATA V4 example: |
|
PATCH https://api.businesscentral.dynamics.com/v2.0/dd24e63d-2131-4bd0-bdd5-570c473ba440/ODataV4/Company('CRONUS%20USA%2C%20Inc.')/PLMLeaseChargesAPI(5cc4f2de-af06-ec11-a6b9-f7df9e04a6bf) |
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": "https://api.businesscentral.dynamics.com/v2.0/dd24e63d-2131-4bd0-bdd5-570c473ba440/ODataV4/$metadata#Company('CRONUS%20USA%2C%20Inc.')/PLMLeaseChargesAPI/$entity",
"@odata.etag": "W/\"JzQ0O1RWNG5PY3NrT09LYnFjZ2RNVWhuVWQrQXVNS1loQkE1MU5iSUQ2WWFMNjQ9MTswMDsn\"",
"SystemId": "5cc4f2de-af06-ec11-a6b9-f7df9e04a6bf",
"BssiPlmLeaseNo": "PLM077",
"BssiPLMCategoryName": "EQUIPMENT",
"BssiPLMLevel1No": "",
"BssiPLMLevel2No": "",
"BssiPLMLevel3No": "",
"BssiPLMChargeNo": "EQUIP-001",
"BssiPLMChargeName": "Equipmnet 001",
"BssiPLMChargeType": "Consumption",
"BssiPLMBillingFrequency": "Monthly",
"BssiPLMMeterNo": "ONE TIME",
"BssiPLMQuantity": 1,
"BssiPLMUnit": "",
"BssiPlMTaxGroupCode": "NONTAXABLE",
"BssiPLMAmount": 100,
"BssiPLMExtendedAmount": 100,
"BssiPLMPeriodByPeriod": false,
"BssiPLMSeparateInvoice": false,
"BssiPLMChargeStatus": "Available",
"BssiPLMMeterReadingType": "Reading"
}Delete Charges
Delete all charge lines for a lease.
Request:
- DELETE /PLMLeaseChargeAPI
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.')/PLMLeaseChargeAPI(ad054e39-e505-ec11-a6b9-f7df9e04a6bf) |