GET api/progression/lettings/{roleId}/tenantcharges
Get all charges for tenant. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| roleId |
The unique identifier of the role resource. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The response returned after the operation completes.
Collection of TenantChargeDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
The name value. |
string |
None. |
| PriceValue |
The price value value. |
decimal number |
None. |
| CurrencyCode |
The currency code value. |
string |
None. |
| TenantChargeInfo |
The tenant charge info value. |
TenantChargeInfoDataContract |
None. |
| ChargeType |
The charge type value. |
EnumDataContract |
None. |
| FeeType |
The fee type value. |
EnumDataContract |
None. |
| VatRatePercentage |
The vat rate percentage value. |
decimal number |
None. |
| IsSplit |
Indicates whether this item is split. |
boolean |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Name": "sample string 1",
"PriceValue": 2.1,
"CurrencyCode": "sample string 3",
"TenantChargeInfo": {
"Paid": true,
"AmountPaid": 2.1,
"DiscountPercentage": 3.1,
"DueDate": "2026-08-04T22:26:19.8850356Z",
"PercentageAmount": 4.0,
"Id": 5
},
"ChargeType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FeeType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"VatRatePercentage": 4.0,
"IsSplit": true,
"Id": 5
},
{
"Name": "sample string 1",
"PriceValue": 2.1,
"CurrencyCode": "sample string 3",
"TenantChargeInfo": {
"Paid": true,
"AmountPaid": 2.1,
"DiscountPercentage": 3.1,
"DueDate": "2026-08-04T22:26:19.8850356Z",
"PercentageAmount": 4.0,
"Id": 5
},
"ChargeType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FeeType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"VatRatePercentage": 4.0,
"IsSplit": true,
"Id": 5
}
]