POST api/tenancy/{id}/setdates

Set start date, terms, end date and notice period for tenancy. assertions

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

SetTenancyDatesDataContract

Name	Type	Additional information
NoticePeriod	EnumDataContract	None.
StartDate	date	None.
TenancyType	EnumDataContract	None.
Term	EnumDataContract	None.
EndDate	date	None.
RentAmount	decimal number	None.
PriceType	EnumDataContract	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "NoticePeriod": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "StartDate": "2023-02-04T21:18:34.1947666Z",
  "TenancyType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Term": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "EndDate": "2023-02-04T21:18:34.1947666Z",
  "RentAmount": 1.0,
  "PriceType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  }
}

Response Information

Resource Description

TenantRoleDataContract

Name	Type	Additional information
AcceptedOffer	LettingOfferDataContract	None.
Deposit	DepositDataContract	None.
RentAmount	decimal number	None.
NextRentDate	date	None.
RentSchedule	RecurringScheduleDataContract	None.
Term	EnumDataContract	None.
ServiceLevel	EnumDataContract	None.
PriceType	EnumDataContract	None.
BreakClauseType	EnumDataContract	None.
EstimatedStartDate	date	None.
StartDate	date	None.
EndDate	date	None.
OriginalEndDate	date	None.
RenewalDate	date	None.
MoveInDate	date	None.
Commission	decimal number	None.
TenantInfo	Collection of TenantInfoDataContact	None.
LandlordInfo	Collection of LandlordInfoDataContract	None.
Guarantors	Collection of GuarantorDataContract	None.
PermittedPets	Collection of PermittedPetDataContract	None.
PermittedOccupiers	Collection of PermittedOccupierDataContract	None.
TenantAdditionalDeposits	Collection of TenantDepositDataContract	None.
TenantFees	Collection of TenantFeeDataContract	None.
TenantBills	Collection of TenantBillDataContract	None.
TenantCharges	Collection of TenantChargeDataContract	None.
Payments	Collection of PaymentDataContract	None.
TenancyStatus	EnumDataContract	None.
TenancyType	EnumDataContract	None.
AgreementType	EnumDataContract	None.
NoticePeriod	EnumDataContract	None.
IssueNoticeDate	date	None.
Requirements	TenantRequirementDataContract	None.
Milestones	Collection of ProgressionMilestoneDataContract	None.
TenantClauses	Collection of TenantClauseDataContract	None.
LettingRoleId	integer	None.
NextAction	TenancyNextActionDataContract	None.
ForwardingAddress	AddressDataContract	None.
TenancyReference	string	None.
OwningTeam	OwningTeamDataContract	None.
Branch	BranchDataContract	None.
FurnishLevel	EnumDataContract	None.
ParkingSpaces	integer	None.
ParkingDescription	string	None.
PropertyAddress	string	None.
AdditionalServices	Collection of AdditionalServiceDataContract	None.
TenancyAgreementId	integer	None.
TenancyRenewalAgreementId	integer	None.
HasFinancialAccounts	boolean	None.
TenancyEndingDateOption	EnumDataContract	None.
ServeNotices	Collection of ServeNoticeDataContract	None.
PropertyId	integer	None.
GroupId	integer	None.
FinancialStatus	EnumDataContract	None.
Origin	EnumDataContract	None.
Grade	EnumDataContract	None.
OwningTeamId	integer	None.
BranchId	integer	None.
Name	string	None.
TeamAccessType	string	None.
RoleType	EnumDataContract	None.
RoleStatus	EnumDataContract	None.
CustomFields	Collection of CustomFieldGroupWithValuesDataContract	None.
CreatedDate	date	None.
CreatedBy	CreatedByDataContract	None.
Id	integer	None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.