GET GetRenewalLeaseData?leaseId={leaseId}&leaseStartDate={leaseStartDate}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
leaseId

integer

Required
leaseStartDate

integer

Required

Body Parameters

None.

Response Information

Resource Description

LeaseRenewalsRepository
NameDescriptionTypeAdditional information
successful

boolean

None.
message

string

None.
data

LeaseRenewalInfo

None.
ysdata

YSLeaseRenewalInfo

None.

Response Formats

application/json, text/json

Sample: 
{
  "successful": true,
  "message": "sample string 2",
  "data": {
    "leaseId": 1,
    "tabData": [
      {
        "monthData": [
          {
            "monthYear": "sample string 1",
            "monthDay": 2,
            "calendarDate": 3,
            "isBlocked": true,
            "leaseTermId": 5,
            "leaseTermInMonths": 6,
            "dayPremium": 7.0,
            "weekPremium": 8.0,
            "monthPremium": 9.0,
            "renewalBaseRent": 10.0,
            "renewalLeaseTermIncrease": 11.0,
            "totalRenewalRent": 12.0,
            "amenityCharges": 13.0,
            "totalRenewalRentIncludeAmenities": 14.0,
            "isSelectable": true
          },
          {
            "monthYear": "sample string 1",
            "monthDay": 2,
            "calendarDate": 3,
            "isBlocked": true,
            "leaseTermId": 5,
            "leaseTermInMonths": 6,
            "dayPremium": 7.0,
            "weekPremium": 8.0,
            "monthPremium": 9.0,
            "renewalBaseRent": 10.0,
            "renewalLeaseTermIncrease": 11.0,
            "totalRenewalRent": 12.0,
            "amenityCharges": 13.0,
            "totalRenewalRentIncludeAmenities": 14.0,
            "isSelectable": true
          }
        ],
        "monthYear": "sample string 1",
        "minNetLeaseRent": 1.0,
        "validDays": 2,
        "year": 3,
        "month": 4,
        "minDate": 5,
        "maxDate": 6,
        "minNetLeaseRentIncludeAmenities": 1.0,
        "showTab": true,
        "enableTab": true,
        "enableSubmit": true,
        "monthDate": "sample string 10",
        "defaultFocusDate": "sample string 11",
        "minRentDate": "sample string 12"
      },
      {
        "monthData": [
          {
            "monthYear": "sample string 1",
            "monthDay": 2,
            "calendarDate": 3,
            "isBlocked": true,
            "leaseTermId": 5,
            "leaseTermInMonths": 6,
            "dayPremium": 7.0,
            "weekPremium": 8.0,
            "monthPremium": 9.0,
            "renewalBaseRent": 10.0,
            "renewalLeaseTermIncrease": 11.0,
            "totalRenewalRent": 12.0,
            "amenityCharges": 13.0,
            "totalRenewalRentIncludeAmenities": 14.0,
            "isSelectable": true
          },
          {
            "monthYear": "sample string 1",
            "monthDay": 2,
            "calendarDate": 3,
            "isBlocked": true,
            "leaseTermId": 5,
            "leaseTermInMonths": 6,
            "dayPremium": 7.0,
            "weekPremium": 8.0,
            "monthPremium": 9.0,
            "renewalBaseRent": 10.0,
            "renewalLeaseTermIncrease": 11.0,
            "totalRenewalRent": 12.0,
            "amenityCharges": 13.0,
            "totalRenewalRentIncludeAmenities": 14.0,
            "isSelectable": true
          }
        ],
        "monthYear": "sample string 1",
        "minNetLeaseRent": 1.0,
        "validDays": 2,
        "year": 3,
        "month": 4,
        "minDate": 5,
        "maxDate": 6,
        "minNetLeaseRentIncludeAmenities": 1.0,
        "showTab": true,
        "enableTab": true,
        "enableSubmit": true,
        "monthDate": "sample string 10",
        "defaultFocusDate": "sample string 11",
        "minRentDate": "sample string 12"
      }
    ]
  },
  "ysdata": {
    "leaseId": 1,
    "leaseTerms": [
      {
        "leaseTermId": 1,
        "description": "sample string 2",
        "termInMonths": "sample string 3",
        "finalRent": 4.0,
        "marketRent": 5.0,
        "endDate": 6,
        "endDateDate": "2025-07-06T12:05:15.4757786-05:00",
        "best": true
      },
      {
        "leaseTermId": 1,
        "description": "sample string 2",
        "termInMonths": "sample string 3",
        "finalRent": 4.0,
        "marketRent": 5.0,
        "endDate": 6,
        "endDateDate": "2025-07-06T12:05:15.4757786-05:00",
        "best": true
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<LeaseRenewalsRepository xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.YottaResident.WebAPIs.Services">
  <data>
    <leaseId>1</leaseId>
    <tabData>
      <TabData>
        <defaultFocusDate>sample string 11</defaultFocusDate>
        <enableSubmit>true</enableSubmit>
        <enableTab>true</enableTab>
        <maxDate>6</maxDate>
        <minDate>5</minDate>
        <minNetLeaseRent>1</minNetLeaseRent>
        <minNetLeaseRentIncludeAmenities>1</minNetLeaseRentIncludeAmenities>
        <minRentDate>sample string 12</minRentDate>
        <month>4</month>
        <monthData>
          <MonthData>
            <amenityCharges>13</amenityCharges>
            <calendarDate>3</calendarDate>
            <dayPremium>7</dayPremium>
            <isBlocked>true</isBlocked>
            <isSelectable>true</isSelectable>
            <leaseTermId>5</leaseTermId>
            <leaseTermInMonths>6</leaseTermInMonths>
            <monthDay>2</monthDay>
            <monthPremium>9</monthPremium>
            <monthYear>sample string 1</monthYear>
            <renewalBaseRent>10</renewalBaseRent>
            <renewalLeaseTermIncrease>11</renewalLeaseTermIncrease>
            <totalRenewalRent>12</totalRenewalRent>
            <totalRenewalRentIncludeAmenities>14</totalRenewalRentIncludeAmenities>
            <weekPremium>8</weekPremium>
          </MonthData>
          <MonthData>
            <amenityCharges>13</amenityCharges>
            <calendarDate>3</calendarDate>
            <dayPremium>7</dayPremium>
            <isBlocked>true</isBlocked>
            <isSelectable>true</isSelectable>
            <leaseTermId>5</leaseTermId>
            <leaseTermInMonths>6</leaseTermInMonths>
            <monthDay>2</monthDay>
            <monthPremium>9</monthPremium>
            <monthYear>sample string 1</monthYear>
            <renewalBaseRent>10</renewalBaseRent>
            <renewalLeaseTermIncrease>11</renewalLeaseTermIncrease>
            <totalRenewalRent>12</totalRenewalRent>
            <totalRenewalRentIncludeAmenities>14</totalRenewalRentIncludeAmenities>
            <weekPremium>8</weekPremium>
          </MonthData>
        </monthData>
        <monthDate>sample string 10</monthDate>
        <monthYear>sample string 1</monthYear>
        <showTab>true</showTab>
        <validDays>2</validDays>
        <year>3</year>
      </TabData>
      <TabData>
        <defaultFocusDate>sample string 11</defaultFocusDate>
        <enableSubmit>true</enableSubmit>
        <enableTab>true</enableTab>
        <maxDate>6</maxDate>
        <minDate>5</minDate>
        <minNetLeaseRent>1</minNetLeaseRent>
        <minNetLeaseRentIncludeAmenities>1</minNetLeaseRentIncludeAmenities>
        <minRentDate>sample string 12</minRentDate>
        <month>4</month>
        <monthData>
          <MonthData>
            <amenityCharges>13</amenityCharges>
            <calendarDate>3</calendarDate>
            <dayPremium>7</dayPremium>
            <isBlocked>true</isBlocked>
            <isSelectable>true</isSelectable>
            <leaseTermId>5</leaseTermId>
            <leaseTermInMonths>6</leaseTermInMonths>
            <monthDay>2</monthDay>
            <monthPremium>9</monthPremium>
            <monthYear>sample string 1</monthYear>
            <renewalBaseRent>10</renewalBaseRent>
            <renewalLeaseTermIncrease>11</renewalLeaseTermIncrease>
            <totalRenewalRent>12</totalRenewalRent>
            <totalRenewalRentIncludeAmenities>14</totalRenewalRentIncludeAmenities>
            <weekPremium>8</weekPremium>
          </MonthData>
          <MonthData>
            <amenityCharges>13</amenityCharges>
            <calendarDate>3</calendarDate>
            <dayPremium>7</dayPremium>
            <isBlocked>true</isBlocked>
            <isSelectable>true</isSelectable>
            <leaseTermId>5</leaseTermId>
            <leaseTermInMonths>6</leaseTermInMonths>
            <monthDay>2</monthDay>
            <monthPremium>9</monthPremium>
            <monthYear>sample string 1</monthYear>
            <renewalBaseRent>10</renewalBaseRent>
            <renewalLeaseTermIncrease>11</renewalLeaseTermIncrease>
            <totalRenewalRent>12</totalRenewalRent>
            <totalRenewalRentIncludeAmenities>14</totalRenewalRentIncludeAmenities>
            <weekPremium>8</weekPremium>
          </MonthData>
        </monthData>
        <monthDate>sample string 10</monthDate>
        <monthYear>sample string 1</monthYear>
        <showTab>true</showTab>
        <validDays>2</validDays>
        <year>3</year>
      </TabData>
    </tabData>
  </data>
  <message>sample string 2</message>
  <successful>true</successful>
  <ysdata>
    <leaseId>1</leaseId>
    <leaseTerms>
      <YSLeaseTerms>
        <best>true</best>
        <description>sample string 2</description>
        <endDate>6</endDate>
        <endDateDate>2025-07-06T12:05:15.4757786-05:00</endDateDate>
        <finalRent>4</finalRent>
        <leaseTermId>1</leaseTermId>
        <marketRent>5</marketRent>
        <termInMonths>sample string 3</termInMonths>
      </YSLeaseTerms>
      <YSLeaseTerms>
        <best>true</best>
        <description>sample string 2</description>
        <endDate>6</endDate>
        <endDateDate>2025-07-06T12:05:15.4757786-05:00</endDateDate>
        <finalRent>4</finalRent>
        <leaseTermId>1</leaseTermId>
        <marketRent>5</marketRent>
        <termInMonths>sample string 3</termInMonths>
      </YSLeaseTerms>
    </leaseTerms>
  </ysdata>
</LeaseRenewalsRepository>