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 AUS |
| 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):
|
| TenancySortCode | Tenancy 'Sort Code' |
| TenancyTenants (ARRAY) |
DetailedTenant
|
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
Definitions
| Field Name | Definition |
|---|---|
| PropertyCode | Code can be obtained from GET (Following contract):
NZ AUS |
| SystemBankCode | Code can be obtained from GET (Following contract):
NZ AUS |
| 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):
|
| 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"/>
Definitions
| Field Name | Definition |
|---|---|
| TenancyCode | Code can be obtained from GET (Following contract):
NZ AUS |
| 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...) |
Comments
Please sign in to leave a comment.