POST api/tenancy/{id}/setrent
Set Rent Amount. Processes this tenancy 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
The update rent amount data contract supplied with the request.
UpdateRentAmountDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| RentAmount |
The rent amount value. |
decimal number |
None. |
| PriceType |
The price type value. |
EnumDataContract |
None. |
| RentSchedule |
The rent schedule value. |
RecurringScheduleDataContract |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{
"RentAmount": 1.0,
"PriceType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"RentSchedule": {
"Frequency": 1,
"StartDate": "2026-08-04T22:24:37.5130435Z",
"DaysOfWeek": [
1,
1
],
"DayOfMonth": 1,
"Interval": 2,
"IsSplit": true,
"AnniversaryDay": 4,
"AnniversaryMonth": 5,
"IsNewTenancy": true
}
}
Response Information
Resource Description
The response returned after the operation completes.
TenancyPriceDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| RentAmount |
The rent amount value. |
decimal number |
None. |
| PriceType |
The price type value. |
EnumDataContract |
None. |
| RentSchedule |
The rent schedule value. |
RecurringScheduleDataContract |
None. |
Response Formats
application/json, text/json
Sample:
{
"RentAmount": 1.0,
"PriceType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"RentSchedule": {
"Frequency": 1,
"StartDate": "2026-08-04T22:24:37.5130435Z",
"DaysOfWeek": [
1,
1
],
"DayOfMonth": 1,
"Interval": 2,
"IsSplit": true,
"AnniversaryDay": 4,
"AnniversaryMonth": 5,
"IsNewTenancy": true
}
}