GET api/ChargesDescription/{id}
Get charges description. Processes this charges description API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The unique identifier of the requested resource. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The response returned after the operation completes.
ChargesDescriptionDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| ChiefRent |
The chief rent value. |
decimal number |
None. |
| AnnualGroundRent |
The annual ground rent value. |
decimal number |
None. |
| GroundRentReviewPeriodYears |
The ground rent review period years value. |
integer |
None. |
| Maintenance |
The maintenance value. |
decimal number |
None. |
| Other |
The other value. |
decimal number |
None. |
| AnnualServiceCharge |
The annual service charge value. |
decimal number |
None. |
| Name |
The name value. |
string |
None. |
| Order |
The order value. |
integer |
None. |
| Type |
The type value. |
EnumDataContract |
None. |
| PropertyId |
The unique identifier of the related property resource. |
integer |
None. |
| Notes |
The notes value. |
string |
None. |
| Roles |
The collection of roles. |
Collection of DescriptionRoleDataContract |
None. |
| CreatedDate |
The created date, expressed as a date and time. |
date |
None. |
| CreatedBy |
The created by value. |
CreatedByDataContract |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Response Formats
application/json, text/json
{
"ChiefRent": 1.1,
"AnnualGroundRent": 1.1,
"GroundRentReviewPeriodYears": 1,
"Maintenance": 2.1,
"Other": 3.1,
"AnnualServiceCharge": 1.1,
"Name": "sample string 4",
"Order": 5,
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"PropertyId": 6,
"Notes": "sample string 7",
"Roles": [
{
"Name": "sample string 1",
"RoleType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"RoleStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Id": 2
},
{
"Name": "sample string 1",
"RoleType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"RoleStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Id": 2
}
],
"CreatedDate": "2026-07-23T08:14:40.1988035Z",
"CreatedBy": {
"Initials": "sample string 1",
"ContactName": "sample string 2",
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Title": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"PrimaryTelephone": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"PrimaryEmail": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"JobTitle": "sample string 6",
"Id": 7
},
"Id": 9
}