POST api/tenancy/{id}/rentdifferencewithschedule

Gets the rent split/consolidate summary for determining next rent amounts.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

UpdateRentAmountDataContract
NameDescriptionTypeAdditional information
RentAmount

decimal number

None.

PriceType

EnumDataContract

None.

RentSchedule

RecurringScheduleDataContract

None.

IsSplit

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "RentAmount": 1.0,
  "PriceType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "RentSchedule": {
    "Frequency": 1,
    "StartDate": "2020-12-02T13:19:23.82891Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "AnniversaryDay": 3,
    "AnniversaryMonth": 4
  },
  "IsSplit": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RentDayDifferenceDataContract
NameDescriptionTypeAdditional information
DaysDifference

integer

None.

Amount

decimal number

None.

NextRentAmountSplit

decimal number

None.

NextRentAmountConsolidate

decimal number

None.

DateDue

date

None.

NextFullRentDate

date

None.

NextSplitRentDate

date

None.

Response Formats

application/json, text/json

Sample:
{
  "DaysDifference": 1,
  "Amount": 2.0,
  "NextRentAmountSplit": 3.0,
  "NextRentAmountConsolidate": 4.0,
  "DateDue": "2020-12-02T13:19:23.8445357Z",
  "NextFullRentDate": "2020-12-02T13:19:23.8445357Z",
  "NextSplitRentDate": "2020-12-02T13:19:23.8445357Z"
}