OBJECT
Property

GraphQL Schema definition

type Property {
#   property's account
account: Account 
#   When the property was active
activeAt: ISO8601DateTime 
#   Activity feed items
# 
# Arguments
#   after: Returns the elements in the list that come after the 
#   specified cursor.
#   before: Returns the elements in the list that come before the 
#   specified cursor.
#   first: Returns the first _n_ elements from the list.
#   last: Returns the last _n_ elements from the list.
#   activityFeedItemType: [Not documented]
#   noteType: [Not documented]
#   activityType: [Not documented]
#   limit: [Not documented]
#   pinned: [Not documented]
#   scopes: [Not documented]
activityFeed(
after: String,
before: String,
first: Int,
last: Int,
activityFeedItemType: [ActivityFeedItemEnum!],
noteType: [NoteTypeEnum!],
activityType: [ActivityTypeEnum!],
limit: Int,
pinned: Boolean,
scopes: [ActivityFeedScopesEnum!]
): ActivityFeedConnection 
#   address of the property
address: Address 
#   Address display
addressDisplay: AddressDisplayEnum! 
#   Advertised price of the property
advertisedPrice: String 
#   Advertising budget (excluding gst)
advertisingBudget: Float 
#   Advertising cost incurred by the client (including gst)
advertisingCost: Float 
#   Agency reference
agencyReference: String 
#   the agents for the property
agents: [Agent!] 
#   Alarm code of the property
alarmCode: String 
#   contacts who have enquired, inspected or made an offer on the Property, or who 
#   have a note attached to them that is visible to vendor
# 
# Arguments
#   after: Returns the elements in the list that come after the 
#   specified cursor.
#   before: Returns the elements in the list that come before the 
#   specified cursor.
#   first: Returns the first _n_ elements from the list.
#   last: Returns the last _n_ elements from the list.
#   offset: [Not documented]
#   limit: [Not documented]
#   orderBy: Order for the contacts (mutually exclusive with 
#   orderByCustomField)
#   updatedBefore: [Not documented]
#   updatedAfter: [Not documented]
#   filterSet: Find contacts by filters
#   query: Search query of the buyer
#   orderByCustomField: Order by the value of a Custom Field 
#   (mutually exclusive with orderBy)
#   ignoreIds: Ignore ids from queries
allBuyerOrTenantContacts(
after: String,
before: String,
first: Int,
last: Int,
offset: Int,
limit: Int,
orderBy: AllBuyerOrTenantOrderEnum,
updatedBefore: ISO8601DateTime,
updatedAfter: ISO8601DateTime,
filterSet: FilterSetAttributes,
query: String,
orderByCustomField: OrderByCustomFieldAttributes,
ignoreIds: [ID!]
): ContactConnection 
#   the alt to price of the property
altToPrice: String 
#   appraisal of the property
appraisal: Appraisal 
#   Date and time of the auction if present
auctionDatetime: ISO8601DateTime 
#   The authority of the property
authority: PropertyAuthorityEnum 
#   The automation trackers of an property
# 
# Arguments
#   after: Returns the elements in the list that come after the 
#   specified cursor.
#   before: Returns the elements in the list that come before the 
#   specified cursor.
#   first: Returns the first _n_ elements from the list.
#   last: Returns the last _n_ elements from the list.
#   scopes: scopes of the automation trackers
#   orderBy: order of the automation trackers
automationTrackers(
after: String,
before: String,
first: Int,
last: Int,
scopes: [AutomationTrackerScopesEnum!],
orderBy: AutomationTrackerOrderEnum
): AutomationTrackerConnection! 
#   book inspection form link
bookInspectionLink: String 
#   Brochure Title of the property
brochureTitle: String! 
#   buyers who have enquired on the property but not inspected
# 
# Arguments
#   after: Returns the elements in the list that come after the 
#   specified cursor.
#   before: Returns the elements in the list that come before the 
#   specified cursor.
#   first: Returns the first _n_ elements from the list.
#   last: Returns the last _n_ elements from the list.
buyersEnquiredButNotInspected(
after: String,
before: String,
first: Int,
last: Int
): ContactConnection 
#   contacts who have enquired, inspected or made an offer on the Property
# 
# Arguments
#   after: Returns the elements in the list that come after the 
#   specified cursor.
#   before: Returns the elements in the list that come before the 
#   specified cursor.
#   first: Returns the first _n_ elements from the list.
#   last: Returns the last _n_ elements from the list.
buyersEnquiriedContacts(
after: String,
before: String,
first: Int,
last: Int
): ContactConnection 
#   Commercial ROI
commercialRoi: Float 
#   Contracts for the property
# 
# Arguments
#   after: Returns the elements in the list that come after the 
#   specified cursor.
#   before: Returns the elements in the list that come before the 
#   specified cursor.
#   first: Returns the first _n_ elements from the list.
#   last: Returns the last _n_ elements from the list.
#   offset: [Not documented]
#   limit: [Not documented]
#   orderBy: [Not documented]
#   updatedBefore: [Not documented]
#   updatedAfter: [Not documented]
#   scopes: [Not documented]
contracts(
after: String,
before: String,
first: Int,
last: Int,
offset: Int,
limit: Int,
orderBy: OrderByEnum,
updatedBefore: ISO8601DateTime,
updatedAfter: ISO8601DateTime,
scopes: [ContractScopesEnum!]
): ContractConnection 
#   country of the Property
country: String 
#   When the property was created
createdAt: ISO8601DateTime! 
#   customFields of the Property
customFields: [CustomField!] 
#   Days on market for the property
daysOnMarket: Int 
#   date of the deadline/treaty (new zealand)
deadlineDate: ISO8601DateTime 
#   deals of the property
# 
# Arguments
#   after: Returns the elements in the list that come after the 
#   specified cursor.
#   before: Returns the elements in the list that come before the 
#   specified cursor.
#   first: Returns the first _n_ elements from the list.
#   last: Returns the last _n_ elements from the list.
deals(after: String, before: String, first: Int, last: Int): DealConnection 
#   Description of the property
description: String 
#   Whether the property is set to display on website
displayOnWebsite: Boolean 
#   documents of the Property
# 
# Arguments
#   sharedWith: scopes documents by who it is shared with
documents(sharedWith: SharedWithEnum): [Document!] 
#   enquiries on the property
# 
# Arguments
#   after: Returns the elements in the list that come after the 
#   specified cursor.
#   before: Returns the elements in the list that come before the 
#   specified cursor.
#   first: Returns the first _n_ elements from the list.
#   last: Returns the last _n_ elements from the list.
enquiries(after: String, before: String, first: Int, last: Int): EnquiryConnection 
#   External property tree
externalPropertyTree: String 
#   to check if the property is featured or not
featured: Boolean 
#   floorplans of the Property
floorplans: [Floorplan!] 
#   Formatted address
formattedAddress: String! 
#   When the property was sold
formattedSoldDate: String 
#   sold price of the property
formattedSoldPrice: String 
#   Headline of the property
headline: String 
#   the id of the Property
id: ID! 
#   images of the Property
images: [Image!] 
#   inspections of the Property
# 
# Arguments
#   after: Returns the elements in the list that come after the 
#   specified cursor.
#   before: Returns the elements in the list that come before the 
#   specified cursor.
#   first: Returns the first _n_ elements from the list.
#   last: Returns the last _n_ elements from the list.
#   inspectionType: scopes inspections by inspection type
#   startBefore: [Not documented]
#   startAfter: [Not documented]
#   finishBefore: [Not documented]
#   finishAfter: [Not documented]
inspections(
after: String,
before: String,
first: Int,
last: Int,
inspectionType: InspectionTypeEnum,
startBefore: ISO8601DateTime,
startAfter: ISO8601DateTime,
finishBefore: ISO8601DateTime,
finishAfter: ISO8601DateTime
): InspectionConnection 
#   Internal notes of the property
internalNotes: String 
#   Key location of the property
keyLocation: String 
#   Key number of the property
keyNumber: String 
#   Land size of the Property
landSize: String 
#   The units of the land size
landSizeUnits: String 
#   latitude of the Property
latitude: Float 
#   leased duration in weeks of the property
leasedDurationInWeeks: Int 
#   leased price of the property
leasedPrice: Money 
#   ledger on the property
ledger: Ledger 
#   if the property has a trust ledger linked
ledgerLinked: Boolean 
#   When the property was let
letDate: String 
#   When the property was listed
listedAt: ISO8601DateTime @deprecated( reason: "use activeAt field instead"  )
#   listing type of the Property
listingDetails: ListingDetails 
#   Listing expiry date
listingExpiryDate: String 
#   Tenants specific to this property
# 
# Arguments
#   after: Returns the elements in the list that come after the 
#   specified cursor.
#   before: Returns the elements in the list that come before the 
#   specified cursor.
#   first: Returns the first _n_ elements from the list.
#   last: Returns the last _n_ elements from the list.
listingTenants(after: String, before: String, first: Int, last: Int): ContactConnection 
#   listing type of the property
listingType: ListingTypeEnum 
#   longitude of the Property
longitude: Float 
#   lotNo of the Property
lotNo: String 
#   municipality of the property
municipality: String 
#   Number of enquiries on the property
numEnquiries: Int 
#   Number of inspection attendees on the property
numInspectionAttendances: Int 
#   Number of offers on the property
numOffers: Int 
#   The property interests num of a property
# 
# Arguments
#   interested: [Not documented]
numPropertyInterests(interested: [PropertyInterestEnum!]): Int 
#   Number of website views
numberOfWebsiteViews: Int 
#   price type of the property (new zealand)
nzPriceType: NzPriceTypeEnum 
#   When the property was off_market
offMarketAt: ISO8601DateTime 
#   offers on the property
# 
# Arguments
#   after: Returns the elements in the list that come after the 
#   specified cursor.
#   before: Returns the elements in the list that come before the 
#   specified cursor.
#   first: Returns the first _n_ elements from the list.
#   last: Returns the last _n_ elements from the list.
offers(after: String, before: String, first: Int, last: Int): OfferConnection! 
#   The office that is managing the listing
office: Office 
#   Online tour url
onlineTour1Url: String 
#   Online tour url 2
onlineTour2Url: String 
#   Rello payment requests for the property
# 
# Arguments
#   after: Returns the elements in the list that come after the 
#   specified cursor.
#   before: Returns the elements in the list that come before the 
#   specified cursor.
#   first: Returns the first _n_ elements from the list.
#   last: Returns the last _n_ elements from the list.
paymentRequests(after: String, before: String, first: Int, last: Int): PaymentRequestConnection 
#   postcode of the Property
postcode: Postcode 
#   potential inspection times of the Property
potentialInspectionTimes: [PotentialInspectionTime!] 
#   the potential tenancies of the property
# 
# Arguments
#   after: Returns the elements in the list that come after the 
#   specified cursor.
#   before: Returns the elements in the list that come before the 
#   specified cursor.
#   first: Returns the first _n_ elements from the list.
#   last: Returns the last _n_ elements from the list.
potentialTenancies(
after: String,
before: String,
first: Int,
last: Int
): PotentialTenancyConnection 
#   Price of the property
price: Float 
#   project associated with the property
project: Project 
#   project stage associated with the property
projectStage: ProjectStage 
#   The property interests of a property
# 
# Arguments
#   after: Returns the elements in the list that come after the 
#   specified cursor.
#   before: Returns the elements in the list that come before the 
#   specified cursor.
#   first: Returns the first _n_ elements from the list.
#   last: Returns the last _n_ elements from the list.
#   interested: [Not documented]
propertyInterests(
after: String,
before: String,
first: Int,
last: Int,
interested: [PropertyInterestEnum!]
): PropertyInterestConnection 
#   property price change logs for the property
# 
# Arguments
#   after: Returns the elements in the list that come after the 
#   specified cursor.
#   before: Returns the elements in the list that come before the 
#   specified cursor.
#   first: Returns the first _n_ elements from the list.
#   last: Returns the last _n_ elements from the list.
propertyPriceChangeLogs(
after: String,
before: String,
first: Int,
last: Int
): PropertyPriceChangeLogConnection! 
#   property tags of the Property
propertyTags: [PropertyTag!] 
#   property type of the property
propertyType: PropertyTypeEnum 
#   propps permalink
proppsOfferLink: String 
#   The UniqueID of the property which is used for portal pushing and external IDs
reaId: String 
#   audit logs of the proeprty
recentAudits: [Audit!] 
#   RealEstate.co.nz postcode
reconzPostcode: ReconzPostcode 
#   the rental date available of the property
rentalDateAvailable: String 
#   saleOrLease of the CommercialType
saleOrLease: SaleOrLeaseEnum 
#   the show price type of the property
showPrice: ShowPriceEnum 
#   the code word for the property
smsCode: String 
#   When the property was sold
soldDate: String 
#   to display sold or leased price of property
soldDisplay: Boolean 
#   sold price of the property
soldPrice: Money 
#   The status of the property
status: PropertyStatusEnum! 
#   street of the Property
street: String 
#   streetNo of the Property
streetNo: String 
#   Current tenants of the address of this property
tenants: [Contact!] 
#   Link to website
thirdPartyLinkOrEagleWebsiteLink: String 
#   Thumbnail square 300x300
thumbnailSquare: String 
#   Unit no of the property
unit: String 
#   When the property was last updated
updatedAt: ISO8601DateTime! 
#   The legal name of the vendor
vendorLegalName: String 
#   The vendor solicitor
vendorSolicitor: Contact 
#   vendors of the Property
vendors: [Vendor!] 
#   Video url of the property
videoUrl: String 
#   contacts who have enquired, inspected or made an offer on the Property, or who 
#   have a note attached to them that is visible to vendor. Used for showing on the 
#   vendor report
# 
# Arguments
#   after: Returns the elements in the list that come after the 
#   specified cursor.
#   before: Returns the elements in the list that come before the 
#   specified cursor.
#   first: Returns the first _n_ elements from the list.
#   last: Returns the last _n_ elements from the list.
visibleToVendorBuyerOrTenantContacts(
after: String,
before: String,
first: Int,
last: Int
): ContactConnection 
#   When the property was withdrawn
withdrawnAt: ISO8601DateTime 
}
Property

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
