POST api/tenancy/{id}/setagreement

Set Agreement type for the tenancy. 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	Tenant Role Id	integer	Required

Body Parameters

The set agreement data contract supplied with the request.

SetAgreementDataContract

Name	Description	Type	Additional information
AgreementType	The agreement type value.	EnumDataContract	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "AgreementType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  }
}

Response Information

Resource Description

The response returned after the operation completes.

TenantRoleDataContract

Name	Description	Type	Additional information
AcceptedOffer	The accepted offer value.	LettingOfferDataContract	None.
Deposit	The deposit value.	DepositDataContract	None.
RentAmount	The rent amount value.	decimal number	None.
NextRentDate	The next rent date, expressed as a date and time.	date	None.
RentSchedule	The rent schedule value.	RecurringScheduleDataContract	None.
Term	The term value.	EnumDataContract	None.
ServiceLevel	The service level value.	EnumDataContract	None.
PriceType	The price type value.	EnumDataContract	None.
BreakClauseType	The break clause type value.	EnumDataContract	None.
SpecialClause	The special clause value.	string	None.
EstimatedStartDate	The estimated start date, expressed as a date and time.	date	None.
StartDate	The start date, expressed as a date and time.	date	None.
EndDate	The end date, expressed as a date and time.	date	None.
OriginalEndDate	The original end date, expressed as a date and time.	date	None.
RenewalDate	The renewal date, expressed as a date and time.	date	None.
MoveInDate	The move in date, expressed as a date and time.	date	None.
Commission	The commission value.	decimal number	None.
TenantInfo	The collection of tenant info.	Collection of TenantInfoDataContract	None.
LandlordInfo	The collection of landlord info.	Collection of LandlordInfoDataContract	None.
Guarantors	The collection of guarantors.	Collection of GuarantorDataContract	None.
PermittedPets	The collection of permitted pets.	Collection of PermittedPetDataContract	None.
PermittedOccupiers	The collection of permitted occupiers.	Collection of PermittedOccupierDataContract	None.
TenantAdditionalDeposits	The collection of tenant additional deposits.	Collection of TenantDepositDataContract	None.
TenantFees	The collection of tenant fees.	Collection of TenantFeeDataContract	None.
TenantBills	The collection of tenant bills.	Collection of TenantBillDataContract	None.
TenantCharges	The collection of tenant charges.	Collection of TenantChargeDataContract	None.
Payments	The collection of payments.	Collection of PaymentDataContract	None.
TenancyStatus	The tenancy status value.	EnumDataContract	None.
TenancyType	The tenancy type value.	EnumDataContract	None.
AgreementType	The agreement type value.	EnumDataContract	None.
NoticePeriod	The notice period value.	EnumDataContract	None.
IssueNoticeDate	The issue notice date, expressed as a date and time.	date	None.
Requirements	The requirements value.	TenantRequirementDataContract	None.
Milestones	The collection of milestones.	Collection of ProgressionMilestoneDataContract	None.
TenantClauses	The collection of tenant clauses.	Collection of TenantClauseDataContract	None.
LettingRoleId	The unique identifier of the related letting role resource.	integer	None.
NextAction	The next action value.	TenancyNextActionDataContract	None.
ForwardingAddress	The forwarding address value.	AddressDataContract	None.
TenancyReference	The tenancy reference value.	string	None.
OwningTeam	The owning team value.	OwningTeamDataContract	None.
Branch	The branch value.	BranchDataContract	None.
FurnishLevel	The furnish level value.	EnumDataContract	None.
ParkingSpaces	The parking spaces value.	integer	None.
ParkingDescription	The parking description value.	string	None.
PropertyAddress	The property address value.	string	None.
AdditionalServices	The collection of additional services.	Collection of AdditionalServiceDataContract	None.
TenancyAgreementId	The unique identifier of the related tenancy agreement resource.	integer	None.
TenancyRenewalAgreementId	The unique identifier of the related tenancy renewal agreement resource.	integer	None.
HasFinancialAccounts	Indicates whether this item has financial accounts.	boolean	None.
TenancyEndingDateOption	The tenancy ending date option value.	EnumDataContract	None.
ServeNotices	The collection of serve notices.	Collection of ServeNoticeDataContract	None.
PropertyId	The unique identifier of the related property resource.	integer	None.
GroupId	The unique identifier of the related group resource.	integer	None.
FinancialStatus	The financial status value.	EnumDataContract	None.
Origin	The origin value.	EnumDataContract	None.
Grade	The grade value.	EnumDataContract	None.
OwningTeamId	The unique identifier of the related owning team resource.	integer	None.
BranchId	The unique identifier of the related branch resource.	integer	None.
Name	The name value.	string	None.
TeamAccessType	The team access type value.	string	None.
RoleType	The role type value.	EnumDataContract	None.
RoleStatus	The role status value.	EnumDataContract	None.
CustomFields	The collection of custom fields.	Collection of CustomFieldGroupWithValuesDataContract	None.
CreatedDate	The created date, expressed as a date and time.	date	None.
CreatedBy	The created by value.	CreatedByDataContract	None.
Id	The unique identifier of this resource.	integer	None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.