POST api/tenancy/{id}/rentdifferencewithschedule

Gets the rent split/consolidate summary for determining next rent amounts. 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-07-23T10:37:11.7818589Z",
    "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.

RentDayDifferenceDataContract

Name	Description	Type	Additional information
DaysDifference	The days difference value.	integer	None.
Amount	The amount value.	decimal number	None.
NextRentAmountSplit	The next rent amount split value.	decimal number	None.
NextRentAmountConsolidate	The next rent amount consolidate value.	decimal number	None.
DateDue	The date due, expressed as a date and time.	date	None.
NextFullRentDate	The next full rent date, expressed as a date and time.	date	None.
NextSplitRentDate	The next split rent date, expressed as a date and time.	date	None.

Response Formats

application/json, text/json

Sample:

{
  "DaysDifference": 1,
  "Amount": 2.0,
  "NextRentAmountSplit": 3.0,
  "NextRentAmountConsolidate": 4.0,
  "DateDue": "2026-07-23T10:37:11.7818589Z",
  "NextFullRentDate": "2026-07-23T10:37:11.7818589Z",
  "NextSplitRentDate": "2026-07-23T10:37:11.7818589Z"
}