POST api/tenancy/{id}/setagreement

Set Agreement type for the tenancy.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Tenant Role Id

integer

Required

Body Parameters

Dezrez.Core.DataContracts.External.Api.Lettings.Command.SetAgreementDataContract
NameDescriptionTypeAdditional information
AgreementType

Dezrez.Core.DataContracts.External.Api.System.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

Dezrez.Core.DataContracts.External.Api.Role.Query.Get.Group.TenantRoleDataContract
NameDescriptionTypeAdditional information
AcceptedOffer

Dezrez.Core.DataContracts.External.Api.Events.Progression.Query.Offer.LettingOfferDataContract

None.

Deposit

Dezrez.Core.DataContracts.External.Api.Role.Query.Get.Marketing.DepositDataContract

None.

RentAmount

decimal number

None.

NextRentDate

date

None.

RentSchedule

Dezrez.Core.DataContracts.External.Api.Events.ScheduledEvents.Command.RecurringScheduleDataContract

None.

Term

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

ServiceLevel

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

PriceType

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

BreakClauseType

Dezrez.Core.DataContracts.External.Api.System.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 Dezrez.Core.DataContracts.External.Api.Role.Query.Get.Group.TenantInfoDataContact

None.

LandlordInfo

Collection of Dezrez.Core.DataContracts.External.Api.Role.Query.Get.Group.LandlordInfoDataContract

None.

Guarantors

Collection of Dezrez.Core.DataContracts.External.Api.Role.Query.Get.Group.GuarantorDataContract

None.

PermittedPets

Collection of Dezrez.Core.DataContracts.External.Api.Role.Query.Get.Group.PermittedPetDataContract

None.

PermittedOccupiers

Collection of Dezrez.Core.DataContracts.External.Api.Role.Query.Get.Group.PermittedOccupierDataContract

None.

TenantAdditionalDeposits

Collection of Dezrez.Core.DataContracts.External.Api.Role.Query.Get.Group.Charges.TenantDepositDataContract

None.

TenantFees

Collection of Dezrez.Core.DataContracts.External.Api.Role.Query.Get.Group.Charges.TenantFeeDataContract

None.

TenantBills

Collection of Dezrez.Core.DataContracts.External.Api.Role.Query.Get.Group.TenantBillDataContract

None.

TenantCharges

Collection of Dezrez.Core.DataContracts.External.Api.Role.Query.Get.Group.Charges.TenantChargeDataContract

None.

Payments

Collection of Dezrez.Core.DataContracts.External.Api.Finances.PaymentDataContract

None.

TenancyStatus

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

TenancyType

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

AgreementType

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

NoticePeriod

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

IssueNoticeDate

date

None.

Requirements

Dezrez.Core.DataContracts.External.Api.Role.Query.Get.Group.TenantRequirementDataContract

None.

Milestones

Collection of Dezrez.Core.DataContracts.External.Api.Progression.Query.ProgressionMilestoneDataContract

None.

TenantClauses

Collection of Dezrez.Core.DataContracts.External.Api.Role.Query.Get.Group.TenantClauseDataContract

None.

LettingRoleId

integer

None.

NextAction

Dezrez.Core.DataContracts.External.Api.Lettings.Query.TenancyNextActionDataContract

None.

ForwardingAddress

Dezrez.Core.DataContracts.External.Api.Location.Query.AddressDataContract

None.

TenancyReference

string

None.

OwningTeam

Dezrez.Core.DataContracts.External.Api.Role.Query.Get.Marketing.OwningTeamDataContract

None.

Branch

Dezrez.Core.DataContracts.External.Api.Branch.Query.Get.BranchDataContract

None.

FurnishLevel

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

ParkingSpaces

integer

None.

ParkingDescription

string

None.

PropertyAddress

string

None.

AdditionalServices

Collection of Dezrez.Core.DataContracts.External.Api.Lettings.Query.AdditionalServiceDataContract

None.

TenancyAgreementId

integer

None.

TenancyRenewalAgreementId

integer

None.

HasFinancialAccounts

boolean

None.

TenancyEndingDateOption

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

ServeNotices

Collection of Dezrez.Core.DataContracts.External.Api.Lettings.Query.ServeNoticeDataContract

None.

PropertyId

integer

None.

GroupId

integer

None.

FinancialStatus

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

Origin

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

Grade

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

OwningTeamId

integer

None.

BranchId

integer

None.

Name

string

None.

TeamAccessType

string

None.

RoleType

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

RoleStatus

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

CustomFields

Collection of Dezrez.Core.DataContracts.External.Api.Custom.Command.SaveCustomField.CustomFieldGroupWithValuesDataContract

None.

CreatedDate

date

None.

CreatedBy

Dezrez.Core.DataContracts.External.Api.People.Query.Get.CreatedByDataContract

None.

Id

integer

None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.