CRM Integration - Tenancy

How to use the Palace API Web Service (Tenancies)

Palace offers the ability to perform various functions through a secure API Web Service.  This article describes the REST endpoint and contracts for 'Tenancies' in Palace.

  • Tenancy List (Sync)
  • Tenancy Insert

GET (Detailed List of 'Tenancies')

NZ: https://serviceapi.realbaselive.com/Service.svc/RestService/ViewAllDetailedTenancy
Aus: https://serviceapia.realbaselive.com/Service.svc/RestService/ViewAllDetailedTenancy

(No Parameters)

 Field Name Definition
 PropertyCode Code can be obtained from GET (Following contract):

 NZ
 https://serviceapi.realbaselive.com/Service.svc/RestService/ViewAllDetailedProperty

 AUS
 https://serviceapia.realbaselive.com/Service.svc/RestService/ViewAllDetailedProperty

 TenancyArchived  Indicates if a 'Tenancy' is archived or not (true / false)
 TenancyChangeCode  'TenancyChangeCode' allows developers to only update changed records if this information is recorded against the 'TenancyCode'.  If this information has not changed for a previous sync then no update is required within the 3rd party system.
 TenancyContactAddress  Address of 'Tenancy'
 TenancyContactEmail  Tenancy Email
 TenancyContactFax  Tenancy Fax
 TenancyContactPhone1  Tenancy 'Phone 1'
 TenancyContactPhone2  Tenancy 'Phone 2'
 TenancyDateEnded  Date the 'Tenancy' ended
 TenancyDateStarted  Date the 'Tenancy' started
 TenancyLastPaymentDate  Date of 'Last Payment' for 'Tenancy'
 TenancyLeaseDateEnded  'Lease End' date of the 'Tennacy'
 TenancyName  Tenancy Name
 TenancyNote  Tenancy Notes / Comments
 TenancyOtherOwing  Amount currently owed by 'Tenancy' (Excluding Rent)
 TenancyRentOwing  Amount currently owed by 'Tenancy' (Rent Only)
 TenancyRentPaidToDate  What date the 'Tenancy' is paid up to
 TenancyRentPaidToLastMonth  What date the 'Tenancy' was paid up to (last month)
 TenancyRentPartPayment  Amount of 'Rent' paid toward the next period (if it's not a complete amount)
 TenancyRentalPeriod  Tenancy Rental Period (only options below):
  • Day
  • Week
  • Fortnight
  • Month
 TenancySortCode  Tenancy 'Sort Code'
 TenancyTenants (ARRAY)

 DetailedTenant

  • TenantAddressPostal (Postal Address of Tenant)
  • TenantAddressService (Service Address of Tenant)
  • TenantEmail (Email Address of Tenant)
  • TenantFax (Fax Number of Tenant)
  • TenantFirstName (First name of Tenant)
  • TenantFullName (Full Name of Tenant)
  • TenantHead (Indicates if the Tenant is the 'Head Tenant' (true / false)
  • TenantLastName (Last name of Tenant)
  • TenantPhoneHome (Home phone number of Tenant)
  • TenantPhoneMobile (Mobile number of Tenant)
  • TenantPhoneWork (Work phone number of Tenant)

 


POST (Service Name 'v2InsertTenancy')

NZ: https://serviceapi.realbaselive.com/Service.svc/RestService/v2InsertTenancy
Aus: https://serviceapia.realbaselive.com/Service.svc/RestService/v2InsertTenancy

XSD Definition (RETURNS Tenancy Code)

(NOTE: Non-Mandatory elements may be missing, but existing elements must be  in the correct order as listed below)

Blue = Date Formats (Must be yyyy-MM-dd)
Red = Mandatory 

<xs:complexType name="v2InsertTenancy">
<xs:sequence>
<xs:element minOccurs="1" name="PropertyCode" nillable="true" type="xs:string"/>
<xs:element minOccurs="1" name="SystemBankCode" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyAddress" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyBondNumber" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyBondRequired" nillable="true" type="xs:double"/>
<xs:element minOccurs="0" name="TenancyBondTransferred" nillable="true" type="xs:double"/>
<xs:element minOccurs="1" name="TenancyCurrentRent" nillable="true" type="xs:double"/>
<xs:element minOccurs="1" name="TenancyCurrentRentPeriod" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyDateEnded" nillable="true" type="xs:string"/>
<xs:element minOccurs="1" name="TenancyDateStarted" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyEmail" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyFax" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyHeadDirectNextPaymentDate" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyHeadDirectOtherAmount" nillable="true" type="xs:double"/>
<xs:element minOccurs="1" name="TenancyHeadDirectPaymentMethod" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyHeadDirectPeriod" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyHeadDirectRentAmount" nillable="true" type="xs:double"/>
<xs:element minOccurs="0" name="TenancyHeadTenantAddressPostal" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyHeadTenantAddressService" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyHeadTenantDOB" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyHeadTenantDear" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyHeadTenantDriverLicenceNo" nillable="true" type="xs:string"/>
<xs:element minOccurs="1" name="TenancyHeadTenantFirstName" nillable="true" type="xs:string"/>
<xs:element minOccurs="1" name="TenancyHeadTenantFullName" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyHeadTenantInitials" nillable="true" type="xs:string"/>
<xs:element minOccurs="1" name="TenancyHeadTenantLastName" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyHeadTenantNotes" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyHeadTenantPassportNo" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyHeadTenantPhoneEmail" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyHeadTenantPhoneFax" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyHeadTenantPhoneHome" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyHeadTenantPhoneMobile" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyHeadTenantPhoneWork" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyHeadTenantTitle" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyLeaseEnded" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyLettingFeeRequired" nillable="true" type="xs:double"/>
<xs:element minOccurs="1" name="TenancyName" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyNotes" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyOurCode" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyPhone1" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyPhone2" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancyRentReviewAmount" nillable="true" type="xs:double"/>
<xs:element minOccurs="0" name="TenancyRentReviewDate" nillable="true" type="xs:string"/>
<xs:element minOccurs="1" name="TenancySortCode" nillable="true" type="xs:string"/>
</xs:sequence>
</xs:complexType>
 
Example

Definitions

 Field Name Definition
 PropertyCode Code can be obtained from GET (Following contract):

 NZ
 https://serviceapi.realbaselive.com/Service.svc/RestService/ViewAllDetailedProperty

 AUS
 https://serviceapia.realbaselive.com/Service.svc/RestService/ViewAllDetailedProperty

 SystemBankCode  Code can be obtained from GET (Following contract):

 NZ
 https://serviceapi.realbaselive.com/Service.svc/RestService/v2ViewAllDetailedSystemBank

 AUS
 https://serviceapia.realbaselive.com/Service.svc/RestService/v2ViewAllDetailedSystemBank

 TenancyAddress  Address of 'Tenancy'
 TenancyBondNumber  Tenancy Bond Number (Issued by Bond Centre)
 TenancyBondRequired  Amount of 'Bond' required for rental
 TenancyBondTransferred  Amount of 'Bond' transferred from a previous property
 TenancyCurrentRent  Amount of 'Rent' to pay / period
 TenancyCurrentRentPeriod  Tenancy Rental Period (only options below):
  • Day
  • Week
  • Fortnight
  • Month
 TenancyDateEnded  Date the 'Tenancy' ended
 TenancyDateStarted  Date the 'Tenancy' started
 TenancyEmail  Tenancy Email
 TenancyFax  Tenancy Fax
 TenancyHeadDirectNextPaymentDate  Head Tenant 'Next Payment Expected Date'
 TenancyHeadDirectOtherAmount  Head Tenant 'Amounts other than rent'
 TenancyHeadDirectPaymentMethod  Head Tenant 'Method of Payment'
 TenancyHeadDirectPeriod  Head Tenant 'Period of Payment' (M = Month or No. of Days)
 TenancyHeadDirectRentAmount  Head Tenant 'Rent Amount'
 TenancyHeadTenantAddressPostal  Head Tenant 'Postal Address'
 TenancyHeadTenantAddressService  Head Tenant 'Service Address'
 TenancyHeadTenantDOB  Head Tenant 'Date of Birth'
 TenancyHeadTenantDear  Head Tenant 'Dear' field for mail merge
 TenancyHeadTenantDriverLicenceNo  Head Tenant 'License No.' field for mail merge
 TenancyHeadTenantFirstName  Head Tenant 'First Name'
 TenancyHeadTenantFullName  Head Tenant 'Full Name'
 TenancyHeadTenantInitials  Head Tenant 'Initials'
 TenancyHeadTenantLastName  Head Tenant 'Last Name'
 TenancyHeadTenantNotes  Head Tenant 'Notes / Comments'
 TenancyHeadTenantPassportNo  Head Tenant 'Passport No.'
 TenancyHeadTenantPhoneEmail  Head Tenant 'Email'
 TenancyHeadTenantPhoneFax  Head Tenant 'Fax'
 TenancyHeadTenantPhoneHome  Head Tenant 'Home Phone'
 TenancyHeadTenantPhoneMobile  Head Tenant 'Mobile Phone'
 TenancyHeadTenantPhoneWork  Head Tenant 'Work Phone'
 TenancyHeadTenantTitle  Head Tenant 'Title' (e.g. Mr, Mrs etc...)
 TenancyLeaseEnded  Tenancy Lease End Date
 TenancyLettingFeeRequired  Tenancy Letting Fee required
 TenancyName  Tenancy Name
 TenancyNotes  Tenancy Notes / Comments
 TenancyOurCode  Tenancy 'User' code
 TenancyPhone1  Tenancy 'Phone 1'
 TenancyPhone2  Tenancy 'Phone 2'
 TenancyRentReviewAmount  Rent review amount
 TenancyRentReviewDate  Rent review date
 TenancySortCode  Tenancy 'Sort Code'

 


POST (Service Name 'v2InsertTenancySubTenant') (Array)

NZ: https://serviceapi.realbaselive.com/Service.svc/RestService/v2InsertTenancySubTenant
Aus: https://serviceapia.realbaselive.com/Service.svc/RestService/v2InsertTenancySubTenant

XSD Definition

(NOTE: Non-Mandatory elements may be missing, but existing elements must be  in the correct order as listed below)

Blue = Date Formats (Must be yyyy-MM-dd)
Red = Mandatory 

<xs:element name="ArrayOfv2InsertTenancySubTenant" nillable="true" type="tns:ArrayOfv2InsertTenancySubTenant"/>

<xs:complexType name="v2InsertTenancySubTenant">
<xs:sequence>
<xs:element minOccurs="0" name="TenancyCode" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancySubDateEnded" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancySubDateStarted" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancySubDirectNextPaymentDate" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancySubDirectOtherAmount" nillable="true" type="xs:double"/>
<xs:element minOccurs="0" name="TenancySubDirectPaymentMethod" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancySubDirectPeriod" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancySubDirectRentAmount" nillable="true" type="xs:double"/>
<xs:element minOccurs="0" name="TenancySubRentAmountPortion" nillable="true" type="xs:double"/>
<xs:element minOccurs="0" name="TenancySubTenantAddressPostal" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancySubTenantAddressService" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancySubTenantDOB" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancySubTenantDear" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancySubTenantDriverLicenceNo" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancySubTenantFirstName" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancySubTenantFullName" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancySubTenantInitials" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancySubTenantLastName" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancySubTenantNotes" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancySubTenantPassportNo" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancySubTenantPhoneEmail" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancySubTenantPhoneFax" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancySubTenantPhoneHome" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancySubTenantPhoneMobile" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancySubTenantPhoneWork" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="TenancySubTenantTitle" nillable="true" type="xs:string"/>
</xs:sequence>
</xs:complexType>

<xs:element name="v2InsertTenancySubTenant" nillable="true" type="tns:v2InsertTenancySubTenant"/>

Definitions

 Field Name Definition
 TenancyCode Code can be obtained from GET (Following contract):

 NZ
 https://serviceapi.realbaselive.com/Service.svc/RestService/ViewAllDetailedTenancy

 AUS
 https://serviceapia.realbaselive.com/Service.svc/RestService/ViewAllDetailedTenancy

 TenancySubDateEnded  Sub-Tenant 'Date Ended'
 TenancySubDateStarted  Sub-Tenant 'Date Started'
 TenancySubDirectNextPaymentDate  Sub-Tenant 'Next Payment Expected Date'
 TenancySubDirectOtherAmount  Sub-Tenant 'Amounts other than rent'
 TenancySubDirectPaymentMethod  Sub-Tenant 'Method of Payment'
 TenancySubDirectPeriod  Sub-Tenant 'Period of Payment' (M = Month or No. of Days)
 TenancySubDirectRentAmount  Sub-Tenant 'Direct Rent Amount'
 TenancySubRentAmountPortion  Sub-Tenant 'Rent Amount Portion'
 TenancySubTenantAddressPostal  Sub-Tenant 'Postal Address'
 TenancySubTenantAddressService  Sub-Tenant 'Service Address'
 TenancySubTenantDOB  Sub-Tenant 'Date of Birth'
 TenancySubTenantDear  Sub-Tenant 'Dear' field for mail merge
 TenancySubTenantDriverLicenceNo  Sub-Tenant 'License No.' field for mail merge
 TenancySubTenantFirstName  Sub-Tenant 'First Name'
 TenancySubTenantFullName  Sub-Tenant 'Full Name'
 TenancySubTenantInitials  Sub-Tenant 'Initials'
 TenancySubTenantLastName  Sub-Tenant 'Last Name'
 TenancySubTenantNotes  Sub-Tenant 'Notes / Comments'
 TenancySubTenantPassportNo  Sub-Tenant 'Passport No.'
 TenancySubTenantPhoneEmail  Sub-Tenant 'Email'
 TenancySubTenantPhoneFax  Sub-Tenant 'Fax'
 TenancySubTenantPhoneHome  Sub-Tenant 'Home Phone'
 TenancySubTenantPhoneMobile  Sub-Tenant 'Mobile Phone'
 TenancySubTenantPhoneWork  Sub-Tenant 'Work Phone'
 TenancySubTenantTitle  Sub-Tenant 'Title' (e.g. Mr, Mrs etc...)

 

 

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.