PUT 17.0/database/tenancies/{id}

Description
Update existing Tenancies

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

TenanciesUpdate

Name	Type	Additional information
ID	integer	None.
PropertyID	integer	None.
ContactID	integer	None.
StartDate	date	None.
EndDate	date	None.
Interval	byte	None.
PaymentDay	byte	None.
PaymentDayBenefit	byte	None.
PaymentFrequency	byte	None.
PaymentFrequencyBenefit	byte	None.
PaymentMethodID	integer	None.
ManagementType	integer	None.
ManagementTypeID	integer	None.
Amount	decimal number	None.
AmountBenefit	decimal number	None.
AdminFee	decimal number	None.
Deposit	decimal number	None.
DepositHeldBy	byte	None.
Notes	string	None.
CheckIn	byte	None.
CheckInDate	date	None.
CheckInGas	integer	None.
CheckInElectric	integer	None.
CheckInElectricLow	integer	None.
CheckInElectricPeak	integer	None.
CheckInWater	integer	None.
CheckOut	byte	None.
CheckOutDate	date	None.
CheckOutGas	integer	None.
CheckOutElectric	integer	None.
CheckOutElectricLow	integer	None.
CheckOutElectricPeak	integer	None.
CheckOutWater	integer	None.
UserID	integer	None.
SiteID	integer	None.
AutoRenew	byte	None.
InspectionDate	date	None.
InspectionFrequency	byte	None.
RentReviewDate	date	None.
TDSTenantID	string	String length: inclusive between 0 and 25
Status	byte	None.
TenantRenewalFee1Amount	decimal number	None.
TenantRenewalFee1ProductID	integer	None.
TenantRenewalFee2Amount	decimal number	None.
TenantRenewalFee2ProductID	integer	None.
LandlordRenewalFee1Amount	decimal number	None.
LandlordRenewalFee1ProductID	integer	None.
LandlordRenewalFee2Amount	decimal number	None.
LandlordRenewalFee2ProductID	integer	None.
ChargeIntroductionFeeOnRenewal	byte	None.
Bond	decimal number	None.
AddedDate	date	None.
StatusDate	date	None.
UpdatedDate	date	None.
TaxRateID	integer	None.
AgreementReturnedDate	date	None.
NoticeServedDate	date	None.
CreationMethod	byte	None.

application/json, text/json

Sample:

{
  "id": 1,
  "propertyID": 1,
  "contactID": 1,
  "startDate": "2025-01-09T20:41",
  "endDate": "2025-01-09T20:41",
  "interval": 64,
  "paymentDay": 64,
  "paymentDayBenefit": 64,
  "paymentFrequency": 64,
  "paymentFrequencyBenefit": 64,
  "paymentMethodID": 1,
  "managementType": 1,
  "managementTypeID": 1,
  "amount": 1.0,
  "amountBenefit": 1.0,
  "adminFee": 1.0,
  "deposit": 1.0,
  "depositHeldBy": 64,
  "notes": "sample string 1",
  "checkIn": 64,
  "checkInDate": "2025-01-09T20:41",
  "checkInGas": 1,
  "checkInElectric": 1,
  "checkInElectricLow": 1,
  "checkInElectricPeak": 1,
  "checkInWater": 1,
  "checkOut": 64,
  "checkOutDate": "2025-01-09T20:41",
  "checkOutGas": 1,
  "checkOutElectric": 1,
  "checkOutElectricLow": 1,
  "checkOutElectricPeak": 1,
  "checkOutWater": 1,
  "userID": 1,
  "siteID": 1,
  "autoRenew": 64,
  "inspectionDate": "2025-01-09T20:41",
  "inspectionFrequency": 64,
  "rentReviewDate": "2025-01-09T20:41",
  "tdsTenantID": "sample string 2",
  "status": 64,
  "tenantRenewalFee1Amount": 1.0,
  "tenantRenewalFee1ProductID": 1,
  "tenantRenewalFee2Amount": 1.0,
  "tenantRenewalFee2ProductID": 1,
  "landlordRenewalFee1Amount": 1.0,
  "landlordRenewalFee1ProductID": 1,
  "landlordRenewalFee2Amount": 1.0,
  "landlordRenewalFee2ProductID": 1,
  "chargeIntroductionFeeOnRenewal": 64,
  "bond": 1.0,
  "addedDate": "2025-01-09T20:41",
  "statusDate": "2025-01-09T20:41",
  "updatedDate": "2025-01-09T20:41",
  "taxRateID": 1,
  "agreementReturnedDate": "2025-01-09T20:41",
  "noticeServedDate": "2025-01-09T20:41",
  "creationMethod": 64
}

application/xml, text/xml

Sample:

<TenanciesUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>1</ID>
  <PropertyID>1</PropertyID>
  <ContactID>1</ContactID>
  <StartDate>2025-01-09T20:41:55.776865+00:00</StartDate>
  <EndDate>2025-01-09T20:41:55.776865+00:00</EndDate>
  <Interval>64</Interval>
  <PaymentDay>64</PaymentDay>
  <PaymentDayBenefit>64</PaymentDayBenefit>
  <PaymentFrequency>64</PaymentFrequency>
  <PaymentFrequencyBenefit>64</PaymentFrequencyBenefit>
  <PaymentMethodID>1</PaymentMethodID>
  <ManagementType>1</ManagementType>
  <ManagementTypeID>1</ManagementTypeID>
  <Amount>1</Amount>
  <AmountBenefit>1</AmountBenefit>
  <AdminFee>1</AdminFee>
  <Deposit>1</Deposit>
  <DepositHeldBy>64</DepositHeldBy>
  <Notes>sample string 1</Notes>
  <CheckIn>64</CheckIn>
  <CheckInDate>2025-01-09T20:41:55.776865+00:00</CheckInDate>
  <CheckInGas>1</CheckInGas>
  <CheckInElectric>1</CheckInElectric>
  <CheckInElectricLow>1</CheckInElectricLow>
  <CheckInElectricPeak>1</CheckInElectricPeak>
  <CheckInWater>1</CheckInWater>
  <CheckOut>64</CheckOut>
  <CheckOutDate>2025-01-09T20:41:55.776865+00:00</CheckOutDate>
  <CheckOutGas>1</CheckOutGas>
  <CheckOutElectric>1</CheckOutElectric>
  <CheckOutElectricLow>1</CheckOutElectricLow>
  <CheckOutElectricPeak>1</CheckOutElectricPeak>
  <CheckOutWater>1</CheckOutWater>
  <UserID>1</UserID>
  <SiteID>1</SiteID>
  <AutoRenew>64</AutoRenew>
  <InspectionDate>2025-01-09T20:41:55.776865+00:00</InspectionDate>
  <InspectionFrequency>64</InspectionFrequency>
  <RentReviewDate>2025-01-09T20:41:55.776865+00:00</RentReviewDate>
  <TDSTenantID>sample string 2</TDSTenantID>
  <Status>64</Status>
  <TenantRenewalFee1Amount>1</TenantRenewalFee1Amount>
  <TenantRenewalFee1ProductID>1</TenantRenewalFee1ProductID>
  <TenantRenewalFee2Amount>1</TenantRenewalFee2Amount>
  <TenantRenewalFee2ProductID>1</TenantRenewalFee2ProductID>
  <LandlordRenewalFee1Amount>1</LandlordRenewalFee1Amount>
  <LandlordRenewalFee1ProductID>1</LandlordRenewalFee1ProductID>
  <LandlordRenewalFee2Amount>1</LandlordRenewalFee2Amount>
  <LandlordRenewalFee2ProductID>1</LandlordRenewalFee2ProductID>
  <ChargeIntroductionFeeOnRenewal>64</ChargeIntroductionFeeOnRenewal>
  <Bond>1</Bond>
  <AddedDate>2025-01-09T20:41:55.776865+00:00</AddedDate>
  <StatusDate>2025-01-09T20:41:55.776865+00:00</StatusDate>
  <UpdatedDate>2025-01-09T20:41:55.776865+00:00</UpdatedDate>
  <TaxRateID>1</TaxRateID>
  <AgreementReturnedDate>2025-01-09T20:41:55.776865+00:00</AgreementReturnedDate>
  <NoticeServedDate>2025-01-09T20:41:55.776865+00:00</NoticeServedDate>
  <CreationMethod>64</CreationMethod>
</TenanciesUpdate>

application/x-www-form-urlencoded
Sample: Sample not available.

Tenancies

Name	Type	Additional information
ID	integer	None.
PropertyID	integer	None.
ContactID	integer	None.
StartDate	date	None.
EndDate	date	None.
Interval	byte	None.
PaymentDay	byte	None.
PaymentDayBenefit	byte	None.
PaymentFrequency	byte	None.
PaymentFrequencyBenefit	byte	None.
PaymentMethodID	integer	None.
ManagementType	integer	None.
ManagementTypeID	integer	None.
Amount	decimal number	None.
AmountBenefit	decimal number	None.
AdminFee	decimal number	None.
Deposit	decimal number	None.
DepositHeldBy	byte	None.
Notes	string	None.
CheckIn	byte	None.
CheckInDate	date	None.
CheckInGas	integer	None.
CheckInElectric	integer	None.
CheckInElectricLow	integer	None.
CheckInElectricPeak	integer	None.
CheckInWater	integer	None.
CheckOut	byte	None.
CheckOutDate	date	None.
CheckOutGas	integer	None.
CheckOutElectric	integer	None.
CheckOutElectricLow	integer	None.
CheckOutElectricPeak	integer	None.
CheckOutWater	integer	None.
UserID	integer	None.
SiteID	integer	None.
AutoRenew	byte	None.
InspectionDate	date	None.
InspectionFrequency	byte	None.
RentReviewDate	date	None.
TDSTenantID	string	String length: inclusive between 0 and 25
Status	byte	None.
TenantRenewalFee1Amount	decimal number	None.
TenantRenewalFee1ProductID	integer	None.
TenantRenewalFee2Amount	decimal number	None.
TenantRenewalFee2ProductID	integer	None.
LandlordRenewalFee1Amount	decimal number	None.
LandlordRenewalFee1ProductID	integer	None.
LandlordRenewalFee2Amount	decimal number	None.
LandlordRenewalFee2ProductID	integer	None.
ChargeIntroductionFeeOnRenewal	byte	None.
Bond	decimal number	None.
AddedDate	date	None.
StatusDate	date	None.
UpdatedDate	date	None.
TaxRateID	integer	None.
AgreementReturnedDate	date	None.
NoticeServedDate	date	None.
CreationMethod	byte	None.

application/json, text/json

Sample:

{
  "id": 1,
  "propertyID": 2,
  "contactID": 3,
  "startDate": "2025-01-09T20:41",
  "endDate": "2025-01-09T20:41",
  "interval": 64,
  "paymentDay": 64,
  "paymentDayBenefit": 64,
  "paymentFrequency": 64,
  "paymentFrequencyBenefit": 64,
  "paymentMethodID": 11,
  "managementType": 12,
  "managementTypeID": 13,
  "amount": 14.0,
  "amountBenefit": 15.0,
  "adminFee": 16.0,
  "deposit": 17.0,
  "depositHeldBy": 64,
  "notes": "sample string 19",
  "checkIn": 64,
  "checkInDate": "2025-01-09T20:41",
  "checkInGas": 22,
  "checkInElectric": 23,
  "checkInElectricLow": 24,
  "checkInElectricPeak": 25,
  "checkInWater": 26,
  "checkOut": 64,
  "checkOutDate": "2025-01-09T20:41",
  "checkOutGas": 29,
  "checkOutElectric": 30,
  "checkOutElectricLow": 31,
  "checkOutElectricPeak": 32,
  "checkOutWater": 33,
  "userID": 34,
  "siteID": 35,
  "autoRenew": 64,
  "inspectionDate": "2025-01-09T20:41",
  "inspectionFrequency": 64,
  "rentReviewDate": "2025-01-09T20:41",
  "tdsTenantID": "sample string 40",
  "status": 64,
  "tenantRenewalFee1Amount": 42.0,
  "tenantRenewalFee1ProductID": 43,
  "tenantRenewalFee2Amount": 44.0,
  "tenantRenewalFee2ProductID": 45,
  "landlordRenewalFee1Amount": 46.0,
  "landlordRenewalFee1ProductID": 47,
  "landlordRenewalFee2Amount": 48.0,
  "landlordRenewalFee2ProductID": 49,
  "chargeIntroductionFeeOnRenewal": 64,
  "bond": 51.0,
  "addedDate": "2025-01-09T20:41",
  "statusDate": "2025-01-09T20:41",
  "updatedDate": "2025-01-09T20:41",
  "taxRateID": 55,
  "agreementReturnedDate": "2025-01-09T20:41",
  "noticeServedDate": "2025-01-09T20:41",
  "creationMethod": 64
}

application/xml, text/xml

Sample:

<Tenancies xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>1</ID>
  <PropertyID>2</PropertyID>
  <ContactID>3</ContactID>
  <StartDate>2025-01-09T20:41:55.776865+00:00</StartDate>
  <EndDate>2025-01-09T20:41:55.776865+00:00</EndDate>
  <Interval>64</Interval>
  <PaymentDay>64</PaymentDay>
  <PaymentDayBenefit>64</PaymentDayBenefit>
  <PaymentFrequency>64</PaymentFrequency>
  <PaymentFrequencyBenefit>64</PaymentFrequencyBenefit>
  <PaymentMethodID>11</PaymentMethodID>
  <ManagementType>12</ManagementType>
  <ManagementTypeID>13</ManagementTypeID>
  <Amount>14</Amount>
  <AmountBenefit>15</AmountBenefit>
  <AdminFee>16</AdminFee>
  <Deposit>17</Deposit>
  <DepositHeldBy>64</DepositHeldBy>
  <Notes>sample string 19</Notes>
  <CheckIn>64</CheckIn>
  <CheckInDate>2025-01-09T20:41:55.776865+00:00</CheckInDate>
  <CheckInGas>22</CheckInGas>
  <CheckInElectric>23</CheckInElectric>
  <CheckInElectricLow>24</CheckInElectricLow>
  <CheckInElectricPeak>25</CheckInElectricPeak>
  <CheckInWater>26</CheckInWater>
  <CheckOut>64</CheckOut>
  <CheckOutDate>2025-01-09T20:41:55.776865+00:00</CheckOutDate>
  <CheckOutGas>29</CheckOutGas>
  <CheckOutElectric>30</CheckOutElectric>
  <CheckOutElectricLow>31</CheckOutElectricLow>
  <CheckOutElectricPeak>32</CheckOutElectricPeak>
  <CheckOutWater>33</CheckOutWater>
  <UserID>34</UserID>
  <SiteID>35</SiteID>
  <AutoRenew>64</AutoRenew>
  <InspectionDate>2025-01-09T20:41:55.776865+00:00</InspectionDate>
  <InspectionFrequency>64</InspectionFrequency>
  <RentReviewDate>2025-01-09T20:41:55.776865+00:00</RentReviewDate>
  <TDSTenantID>sample string 40</TDSTenantID>
  <Status>64</Status>
  <TenantRenewalFee1Amount>42</TenantRenewalFee1Amount>
  <TenantRenewalFee1ProductID>43</TenantRenewalFee1ProductID>
  <TenantRenewalFee2Amount>44</TenantRenewalFee2Amount>
  <TenantRenewalFee2ProductID>45</TenantRenewalFee2ProductID>
  <LandlordRenewalFee1Amount>46</LandlordRenewalFee1Amount>
  <LandlordRenewalFee1ProductID>47</LandlordRenewalFee1ProductID>
  <LandlordRenewalFee2Amount>48</LandlordRenewalFee2Amount>
  <LandlordRenewalFee2ProductID>49</LandlordRenewalFee2ProductID>
  <ChargeIntroductionFeeOnRenewal>64</ChargeIntroductionFeeOnRenewal>
  <Bond>51</Bond>
  <AddedDate>2025-01-09T20:41:55.776865+00:00</AddedDate>
  <StatusDate>2025-01-09T20:41:55.776865+00:00</StatusDate>
  <UpdatedDate>2025-01-09T20:41:55.776865+00:00</UpdatedDate>
  <TaxRateID>55</TaxRateID>
  <AgreementReturnedDate>2025-01-09T20:41:55.776865+00:00</AgreementReturnedDate>
  <NoticeServedDate>2025-01-09T20:41:55.776865+00:00</NoticeServedDate>
  <CreationMethod>64</CreationMethod>
</Tenancies>

PUT 17.0/database/tenancies/{id}

Description

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/xml, text/xml

application/x-www-form-urlencoded

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml