OBJECT
Property
Property
link GraphQL Schema definition
- type Property {
- # property's account
- Account :
- # When the property was active
- 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]
- # pinned: [Not documented]
- # scopes: [Not documented]
- (
- String, :
- String, :
- Int, :
- Int, :
- ActivityFeedItemEnum!], : [
- NoteTypeEnum!], : [
- ActivityTypeEnum!], : [
- Boolean, :
- ActivityFeedScopesEnum!] : [
- ): ActivityFeedConnection
- # address of the property
- Address :
- # Address display
- AddressDisplayEnum! :
- # Advertised price of the property
- String :
- # Advertising budget (excluding gst)
- Float :
- # Advertising cost incurred by the client (including gst)
- Float :
- # Agency reference
- String :
- # the agents for the property
- Agent!] : [
- # Alarm code of the property
- 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
- (
- String, :
- String, :
- Int, :
- Int, :
- Int, :
- Int, :
- AllBuyerOrTenantOrderEnum, :
- ISO8601DateTime, :
- ISO8601DateTime, :
- FilterSetAttributes, :
- String, :
- OrderByCustomFieldAttributes, :
- ID!] : [
- ): ContactConnection
- # the alt to price of the property
- String :
- # appraisal of the property
- Appraisal :
- # Date and time of the auction if present
- ISO8601DateTime :
- # The authority of the property
- 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
- (
- String, :
- String, :
- Int, :
- Int, :
- AutomationTrackerScopesEnum!], : [
- AutomationTrackerOrderEnum :
- ): AutomationTrackerConnection!
- # book inspection form link
- String :
- # Brochure Title of the property
- 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.
- (
- String, :
- String, :
- Int, :
- 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.
- (
- String, :
- String, :
- Int, :
- Int :
- ): ContactConnection
- # Commercial ROI
- 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]
- (
- String, :
- String, :
- Int, :
- Int, :
- Int, :
- Int, :
- OrderByEnum, :
- ISO8601DateTime, :
- ISO8601DateTime, :
- ContractScopesEnum!] : [
- ): ContractConnection
- # country of the Property
- String :
- # When the property was created
- ISO8601DateTime! :
- # customFields of the Property
- CustomField!] : [
- # Days on market for the property
- Int :
- # date of the deadline/treaty (new zealand)
- 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.
- String, : String, : Int, : Int): DealConnection ( :
- # Description of the property
- String :
- # Whether the property is set to display on website
- Boolean :
- # documents of the Property
- #
- # Arguments
- # sharedWith: scopes documents by who it is shared with
- 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.
- String, : String, : Int, : Int): EnquiryConnection ( :
- # External property tree
- String :
- # to check if the property is featured or not
- Boolean :
- # floorplans of the Property
- Floorplan!] : [
- # Formatted address
- String! :
- # Headline of the property
- String :
- # the id of the Property
- ID! :
- # images of the Property
- 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]
- (
- String, :
- String, :
- Int, :
- Int, :
- InspectionTypeEnum, :
- ISO8601DateTime, :
- ISO8601DateTime, :
- ISO8601DateTime, :
- ISO8601DateTime :
- ): InspectionConnection
- # Internal notes of the property
- String :
- # Key location of the property
- String :
- # Key number of the property
- String :
- # Land size of the Property
- String :
- # The units of the land size
- String :
- # latitude of the Property
- Float :
- # leased duration in weeks of the property
- Int :
- # leased price of the property
- Money :
- # ledger on the property
- Ledger :
- # if the property has a trust ledger linked
- Boolean :
- # When the property was let
- String :
- # When the property was listed
- ISO8601DateTime @deprecated( reason: "use activeAt field instead" ) :
- # listing type of the Property
- ListingDetails :
- # Listing expiry date
- 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.
- String, : String, : Int, : Int): ContactConnection ( :
- # listing type of the property
- ListingTypeEnum :
- # longitude of the Property
- Float :
- # lotNo of the Property
- String :
- # municipality of the property
- String :
- # Number of enquiries on the property
- Int :
- # Number of inspection attendees on the property
- Int :
- # Number of offers on the property
- Int :
- # The property interests num of a property
- #
- # Arguments
- # interested: [Not documented]
- PropertyInterestEnum!]): Int ( : [
- # Number of website views
- Int :
- # price type of the property (new zealand)
- NzPriceTypeEnum :
- # When the property was off_market
- 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.
- String, : String, : Int, : Int): OfferConnection! ( :
- # The office that is managing the listing
- Office :
- # Online tour url
- String :
- # Online tour url 2
- 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.
- String, : String, : Int, : Int): PaymentRequestConnection ( :
- # postcode of the Property
- Postcode :
- # potential inspection times of the Property
- 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.
- (
- String, :
- String, :
- Int, :
- Int :
- ): PotentialTenancyConnection
- # Price of the property
- Float :
- # project associated with the property
- Project :
- # project stage associated with the property
- 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]
- (
- String, :
- String, :
- Int, :
- Int, :
- 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.
- (
- String, :
- String, :
- Int, :
- Int :
- ): PropertyPriceChangeLogConnection!
- # property tags of the Property
- PropertyTag!] : [
- # property type of the property
- PropertyTypeEnum :
- # propps permalink
- String :
- # The UniqueID of the property which is used for portal pushing and external IDs
- String :
- # audit logs of the proeprty
- Audit!] : [
- # RealEstate.co.nz postcode
- ReconzPostcode :
- # the rental date available of the property
- String :
- # saleOrLease of the CommercialType
- SaleOrLeaseEnum :
- # the show price type of the property
- ShowPriceEnum :
- # the code word for the property
- String :
- # When the property was sold
- String :
- # to display sold or leased price of property
- Boolean :
- # sold price of the property
- Money :
- # The status of the property
- PropertyStatusEnum! :
- # street of the Property
- String :
- # streetNo of the Property
- String :
- # Current tenants of the address of this property
- Contact!] : [
- # Link to website
- String :
- # Thumbnail square 300x300
- String :
- # Unit no of the property
- String :
- # When the property was last updated
- ISO8601DateTime! :
- # The legal name of the vendor
- String :
- # The vendor solicitor
- Contact :
- # vendors of the Property
- Vendor!] : [
- # Video url of the property
- 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.
- (
- String, :
- String, :
- Int, :
- Int :
- ): ContactConnection
- # When the property was withdrawn
- ISO8601DateTime :
- }
link Require by
- Activitynull
- AppraisalAppraisal
- CampaignEmailLogCampaign Email Log
- ContactContact
- ContractContract
- CreatePropertyPayloadAutogenerated return type of CreateProperty
- DealAssociationnull
- DestroyPropertyPayloadAutogenerated return type of DestroyProperty
- Enquirynull
- EventEvent record
- InspectionInspection
- InspectionAttendanceAttendance of inspection
- InspectionRegistrationInspection Registration
- Notenull
- Offernull
- PaymentRequestPayment request record
- PotentialInspectionTimePotentialInspectionTime
- PotentialTenancyPotential tenancy
- PropertyConnectionThe connection type for Property.
- PropertyEdgeAn edge in a connection.
- PropertyInterestPropertyInterest record
- PropertyPriceChangeLogProperty price change record
- PropertySubscriptionProperty Subscription Type
- QueryThe query root of this schema
- Recordnull
- TaskTask record
- UpdatePropertyPayloadAutogenerated return type of UpdateProperty
- VendorVendor Type