openapi: 3.2.0
info:
  title: Vaultre Properties API
  contact:
    name: VaultRE
    url: https://www.vaultre.com.au
    email: api@vaultre.com.au
  version: '1.0'
  description: 'Operations tagged properties across 4 of this provider''s published API definitions: vaultre-aggregator-api-v1-0-openapi.yml, vaultre-api-v1-1-openapi.yml, vaultre-api-v1-2-openapi.yml, vaultre-api-v1-3-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://aggregator.api.vaultre.com.au/api/v1.0
- url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
- url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
- url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
tags:
- name: properties
  description: Operations related to properties
paths:
  /appraisal:
    post:
      tags:
      - properties
      summary: Add/Update an appraisal
      description: Add/Update an appraisal
      operationId: addUpdateAppraisal
      requestBody:
        description: Appraisal object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Appraisal'
        required: true
      responses:
        202:
          description: Data received successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
        400:
          description: Invalid data payload
          content: {}
      x-codegen-request-body-name: body
      security:
      - ApiKey: []
      - Bearer: []
    servers:
    - url: https://aggregator.api.vaultre.com.au/api/v1.0
  /listing:
    post:
      tags:
      - properties
      summary: Add/Update a listing
      description: Add/Update a listing
      operationId: addUpdateListing
      requestBody:
        description: Listing object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Listing'
        required: true
      responses:
        202:
          description: Data received successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
        400:
          description: Invalid data payload
          content: {}
      x-codegen-request-body-name: body
      security:
      - ApiKey: []
      - Bearer: []
    servers:
    - url: https://aggregator.api.vaultre.com.au/api/v1.0
  /unconditional:
    post:
      tags:
      - properties
      summary: Add/Update an unconditional sale
      description: Add/Update an unconditional sale
      operationId: addUpdateUnconditional
      requestBody:
        description: Unconditional object.<br />The sum of commissionSplits[].amountExGST must equal grossCommissionExGST.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Unconditional'
        required: true
      responses:
        202:
          description: Data received successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
        400:
          description: Invalid data payload
          content: {}
      x-codegen-request-body-name: body
      security:
      - ApiKey: []
      - Bearer: []
    servers:
    - url: https://aggregator.api.vaultre.com.au/api/v1.0
  /settlement:
    post:
      tags:
      - properties
      summary: Add/Update a settlement
      description: Add/Update a settlement
      operationId: addUpdateSettlement
      requestBody:
        description: Settlement object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Settlement'
        required: true
      responses:
        202:
          description: Data received successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
        400:
          description: Invalid data payload
          content: {}
      x-codegen-request-body-name: body
      security:
      - ApiKey: []
      - Bearer: []
    servers:
    - url: https://aggregator.api.vaultre.com.au/api/v1.0
  /withdrawn:
    post:
      tags:
      - properties
      summary: Add/Update a withdrawn listing
      description: Add/Update a withdrawn listing
      operationId: addUpdateWithdrawn
      requestBody:
        description: Withdrawn object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Withdrawn'
        required: true
      responses:
        202:
          description: Data received successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError'
        400:
          description: Invalid data payload
          content: {}
      x-codegen-request-body-name: body
      security:
      - ApiKey: []
      - Bearer: []
    servers:
    - url: https://aggregator.api.vaultre.com.au/api/v1.0
  /properties:
    get:
      tags:
      - properties
      summary: Retrieve a list of properties
      description: Retrieve a list of properties
      operationId: getProperties
      parameters:
      - $ref: '#/components/parameters/modifiedSince'
      - $ref: '#/components/parameters/modifiedBefore'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - inserted
          - modified
      - $ref: '#/components/parameters/sortOrder'
      responses:
        200:
          description: Properties retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{id}:
    get:
      tags:
      - properties
      summary: Retrieve a single property
      description: Retrieve a single property
      operationId: getProperty
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Property retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyExtended'
      security:
      - Api-Key: []
        Bearer: []
    delete:
      tags:
      - properties
      summary: Delete a property
      description: Delete a property
      operationId: deleteProperty
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      responses:
        204:
          description: Property deleted
          content: {}
        400:
          description: Invalid data
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{id}/notes:
    get:
      tags:
      - properties
      summary: Retrieve a list of notes attached to this property
      description: Retrieve a list of notes attached to this property
      operationId: getPropertyNotes
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: types
        in: query
        description: Filter notes with type IDs
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
            format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - inserted
      - $ref: '#/components/parameters/sortOrder'
      responses:
        200:
          description: Property notes retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    post:
      tags:
      - properties
      summary: Add a note to this property
      description: Add a note to this property
      operationId: addPropertyNote
      requestBody:
        description: Property note object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddPropertyNote'
        required: true
      responses:
        201:
          description: Property note created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyNote'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{propertyid}/notes/{id}:
    get:
      tags:
      - properties
      summary: Retrieve a single property note
      description: Retrieve a single property note
      operationId: getPropertyNote
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the note
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Property note retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyNote'
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - properties
      summary: Update a property note
      description: Update a property note
      operationId: updatePropertyNote
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the note
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Property Note object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePropertyNote'
        required: true
      responses:
        200:
          description: Note updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactNote'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
        403:
          description: User does not have permission to modify property notes or note is read-only
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    delete:
      tags:
      - properties
      summary: Delete a property note
      description: Delete a property note
      operationId: deletePropertyNote
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the note
        required: true
        schema:
          type: integer
          format: int64
      responses:
        204:
          description: Property Note deleted
          content: {}
        400:
          description: Invalid data
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
        403:
          description: User does not have permission to delete property notes or note is read-only
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{id}/photos:
    get:
      tags:
      - properties
      summary: Retrieve a list of photos for this property
      description: Retrieve a list of photos for this property
      operationId: getPropertyPhotos
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Property photos retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    post:
      tags:
      - properties
      summary: Upload a new photo to this property
      description: Upload a new photo to this property
      operationId: addPropertyPhoto
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
              - photo
              - published
              - type
              properties:
                photo:
                  type: string
                  description: The photo to be uploaded (GIF/PNG/JPG only)
                  format: binary
                caption:
                  type: string
                  description: The caption for the photo
                published:
                  type: boolean
                  description: Is the photo published or unpublished
                type:
                  type: string
                  description: The type of photo
                  enum:
                  - Photograph
                  - Floorplan
        required: true
      responses:
        201:
          description: Photo uploaded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyPhoto'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
      security:
      - Api-Key: []
        Bearer: []
    delete:
      tags:
      - properties
      summary: Delete multiple photos from this property
      description: Delete multiple photos from this property in a single operation. This endpoint allows bulk deletion of up to 50 photos at once.
      operationId: deletePropertyPhotos
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Bulk delete request containing list of photo IDs
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PropertyPhotoBulkDeleteRequest'
        required: true
      responses:
        200:
          description: Bulk delete completed (some photos may have failed)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyPhotoBulkDeleteResponse'
        400:
          description: Some or all photos could not be deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyPhotoBulkDeleteResponse'
        403:
          description: User does not have permission to delete photos from this property
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_4'
        404:
          description: Property not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_4'
        422:
          description: Invalid input data (e.g., empty items list, too many items)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_4'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{propertyid}/photos/{id}:
    get:
      tags:
      - properties
      summary: Retrieve a single photo for this property
      description: Retrieve a single photo for this property
      operationId: getPropertyPhoto
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the photo
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Property photo retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyPhoto'
      security:
      - Api-Key: []
        Bearer: []
    delete:
      tags:
      - properties
      summary: Delete a photo attached to this property
      description: Delete a photo attached to this property
      operationId: deletePropertyPhoto
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the photo
        required: true
        schema:
          type: integer
          format: int64
      responses:
        204:
          description: Property photo deleted
          content: {}
        400:
          description: Invalid data
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - properties
      summary: Update photo metadata
      description: Update a property photo's caption, published status, or photo type (Photograph/Floorplan)
      operationId: updatePropertyPhoto
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the photo
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Photo metadata to update
        content:
          application/json:
            schema:
              type: object
              properties:
                caption:
                  type: string
                  description: Updated caption for the photo
                published:
                  type: boolean
                  description: Whether the photo should be published to web
                type:
                  type: string
                  description: Photo type
                  enum:
                  - Photograph
                  - Floorplan
            examples:
              setAsFloorplan:
                summary: Mark photo as floorplan
                value:
                  type: Floorplan
                  caption: Ground floor plan
              setAsPhoto:
                summary: Mark as standard photo
                value:
                  type: Photograph
              updateCaption:
                summary: Update caption only
                value:
                  caption: Updated living room photo
      responses:
        200:
          description: Property photo updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyPhoto'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_4'
        403:
          description: User does not have permission to update this property
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_4'
        404:
          description: Property or photo not found
          content: {}
        422:
          description: Validation error - empty or malformed request body
          content:
            application/json:
              schema:
                type: object
                properties:
                  messages:
                    type: object
        500:
          description: Unexpected server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_4'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{propertyid}/photos/{id}/tags:
    get:
      tags:
      - properties
      summary: Retrieve a list of tags for this property photo
      description: Retrieve a list of tags for this property photo, derived from Machine Learning analysis of property photos
      operationId: getPropertyPhotoTags
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the photo
        required: true
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - name
          - confidence
      - $ref: '#/components/parameters/sortOrder'
      - name: minimumConfidence
        in: query
        description: Only return tags with a confidence greater than or equal to this number
        schema:
          type: number
          format: float
      - name: maximumConfidence
        in: query
        description: Only return tags with a confidence less than or equal to this number
        schema:
          type: number
          format: float
      responses:
        200:
          description: Photo tags retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{id}/tags:
    get:
      tags:
      - properties
      summary: Retrieve a list of tags for this property
      description: Retrieve a list of tags for this property, derived from Machine Learning analysis of property photos
      operationId: getPropertyTags
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - name
          - confidence
      - $ref: '#/components/parameters/sortOrder'
      - name: minimumConfidence
        in: query
        description: Only return tags with a confidence greater than or equal to this number
        schema:
          type: number
          format: float
      - name: maximumConfidence
        in: query
        description: Only return tags with a confidence less than or equal to this number
        schema:
          type: number
          format: float
      responses:
        200:
          description: Property tags retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{id}/categories:
    get:
      tags:
      - properties
      summary: Retrieve a list of categories to which this property belongs
      description: Retrieve a list of categories to which this property belongs
      operationId: getPropertyCategories
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - name
      - $ref: '#/components/parameters/sortOrder'
      responses:
        200:
          description: Property categories retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{id}/activityLog:
    get:
      tags:
      - properties
      summary: Retrieve the activity log for a property
      description: Retrieve the activity log for a property
      operationId: getPropertyActivityLog
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Activity Log retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    post:
      tags:
      - properties
      summary: Add a property activity note
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      description: Add a property activity note
      operationId: addPropertyActivityNote
      requestBody:
        description: Activity Note Details
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddPropertyActivityNote'
        required: true
      responses:
        201:
          description: Activity Note Added
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_4'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{id}/files:
    get:
      tags:
      - properties
      summary: Retrieve a list of files attached to this property
      description: Retrieve a list of files attached to this property
      operationId: getPropertyFiles
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - inserted
          - modified
      - $ref: '#/components/parameters/sortOrder'
      responses:
        200:
          description: Property files retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{id}/{salelease}/{lifeid}/files:
    get:
      tags:
      - properties
      summary: Retrieve a list of files attached to this property life
      description: Retrieve a list of files attached to this property life
      operationId: getPropertyFilesLife
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - inserted
          - modified
      - $ref: '#/components/parameters/sortOrder'
      responses:
        200:
          description: Property files retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    post:
      tags:
      - properties
      summary: Attach a file to this property life
      description: Attach a file to this property life
      operationId: addPropertyFileLife
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
              - file
              properties:
                file:
                  type: string
                  description: The file to be uploaded
                  format: binary
        required: true
      responses:
        201:
          description: File attached successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyFile'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{propertyid}/{salelease}/{lifeid}/files/{id}:
    get:
      tags:
      - properties
      summary: Retrieve a single file attached to this property life
      description: Retrieve a single file attached to this property life
      operationId: getPropertyFileLife
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - name: id
        in: path
        description: ID of the file
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Property file retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyFile'
      security:
      - Api-Key: []
        Bearer: []
    delete:
      tags:
      - properties
      summary: Delete a single file attached to this property life
      description: Delete a single file attached to this property life
      operationId: deletePropertyFileLife
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - name: id
        in: path
        description: ID of the file
        required: true
        schema:
          type: integer
          format: int64
      responses:
        204:
          description: Property file deleted
          content: {}
        400:
          description: Invalid data
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{id}/{salelease}/{lifeid}/feedback:
    get:
      tags:
      - properties
      summary: Retrieve a list of property feedback attached to this life
      description: Retrieve a list of property feedback attached to this life
      operationId: getPropertyFeedbackLife
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: feedbackAfter
        in: query
        description: Filter feedback occurring on or after this date
        schema:
          type: string
          format: date
      - name: feedbackBefore
        in: query
        description: Filter feedback occurring before this date
        schema:
          type: string
          format: date
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - inserted
          - feedbackDate
      - $ref: '#/components/parameters/sortOrder'
      responses:
        200:
          description: Property feedback retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    post:
      tags:
      - properties
      summary: Attach feedback to this property life
      description: Attach feedback to this property life
      operationId: attachFeedbackToPropertyLife
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Property Feedback object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddPropertyFeedback'
        required: true
      responses:
        201:
          description: Feedback attached
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyFeedback'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{propertyid}/{salelease}/{lifeid}/feedback/{id}:
    get:
      tags:
      - properties
      summary: Retrieve a property feedback item attached to this life
      description: Retrieve a property feedback item attached to this life
      operationId: getSinglePropertyFeedbackLife
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the feedback
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Property feedback retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyFeedback'
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - properties
      summary: Update a feedback item
      description: Update a feedback item
      operationId: updateFeedback
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the feedback
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Property Feedback object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePropertyFeedback'
        required: true
      responses:
        200:
          description: Feedback updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyFeedback'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    delete:
      tags:
      - properties
      summary: Delete a property feedback item
      description: Delete a property feedback item
      operationId: deletePropertyFeedback
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the feedback
        required: true
        schema:
          type: integer
          format: int64
      responses:
        204:
          description: Feedback deleted
          content: {}
        400:
          description: Invalid data
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{id}/{salelease}/{lifeid}/openHomes:
    get:
      tags:
      - properties
      summary: Retrieve a list of open homes attached to this life
      description: Retrieve a list of open homes attached to this life
      operationId: getPropertyOpenHomes
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: startingAfter
        in: query
        description: Filter open homes occurring on or after this date
        schema:
          type: string
          format: date
      - name: startingBefore
        in: query
        description: Filter open homes occurring before this date
        schema:
          type: string
          format: date
      - name: userid
        in: path
        description: Filter open homes attached to this user
        required: true
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - start
      - $ref: '#/components/parameters/sortOrder'
      responses:
        200:
          description: Open Homes retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    post:
      tags:
      - properties
      summary: Create a new open home for this property life
      description: Create a new open home for this property life
      operationId: addOpenHome
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Open Home object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddUpdateOpenHome'
        required: true
      responses:
        201:
          description: Open Home created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenHome'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{propertyid}/{salelease}/{lifeid}/openHomes/{id}:
    get:
      tags:
      - properties
      summary: Retrieve a single open home attached to this life
      description: Retrieve a single open home attached to this life
      operationId: getPropertyOpenHome
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the open home
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Open Home retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenHome'
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - properties
      summary: Update an open home for this property life
      description: Update an open home for this property life
      operationId: updateOpenHome
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the open home
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Open Home object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddUpdateOpenHome'
        required: true
      responses:
        200:
          description: Open Home updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenHome'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    delete:
      tags:
      - properties
      summary: Delete an open home
      description: Delete an open home
      operationId: deleteOpenHome
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the open home
        required: true
        schema:
          type: integer
          format: int64
      responses:
        204:
          description: Open Home deleted
          content: {}
        400:
          description: Invalid data
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{id}/sale/{lifeid}/owners:
    get:
      tags:
      - properties
      summary: Retrieve a list of owners attached to this property life
      description: Retrieve a list of owners attached to this property life
      operationId: getPropertyLifeOwners
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Owners retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - properties
      summary: Update owners for this property life
      description: Update owners for this property life
      operationId: updateOwnersForProperty
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Items object containing array of contact IDs
        content:
          application/json: {}
        required: true
      responses:
        200:
          description: Owners updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    post:
      tags:
      - properties
      summary: Attach an owner to this property life
      description: Attach an owner to this property life
      operationId: attachOwnerToProperty
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Contact ID object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ID'
        required: true
      responses:
        200:
          description: Owner attached
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{id}/lease/{lifeid}/landlords:
    get:
      tags:
      - properties
      summary: Retrieve a list of landlords attached to this property life
      description: Retrieve a list of landlords attached to this property life
      operationId: getPropertyLifeLandlords
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Landlords retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - properties
      summary: Update landlords for this property life
      description: Update landlords for this property life
      operationId: updateLandlordsForProperty
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Items object containing array of contact IDs
        content:
          application/json: {}
        required: true
      responses:
        200:
          description: Landlords updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    post:
      tags:
      - properties
      summary: Attach a landlord to this property life
      description: Attach a landlord to this property life
      operationId: attachLandlordToProperty
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Contact ID object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ID'
        required: true
      responses:
        200:
          description: Landlord attached
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{id}/sale/{lifeid}/purchasers:
    get:
      tags:
      - properties
      summary: Retrieve a list of purchasers attached to this property life
      description: Retrieve a list of purchasers attached to this property life
      operationId: getPropertyLifePurchasers
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Purchasers retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - properties
      summary: Update purchasers for this property life
      description: Update purchasers for this property life
      operationId: updatePurchasersForProperty
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Items object containing array of contact IDs
        content:
          application/json: {}
        required: true
      responses:
        200:
          description: Purchasers updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    post:
      tags:
      - properties
      summary: Attach a purchaser to this property life
      description: Attach a purchaser to this property life
      operationId: attachPurchaserToProperty
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Contact ID object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ID'
        required: true
      responses:
        200:
          description: Purchaser attached
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{id}/lease/{lifeid}/tenancy/{tenancyid}/tenants:
    get:
      tags:
      - properties
      summary: Retrieve a list of tenants attached to this tenancy
      description: Retrieve a list of tenants attached to this tenancy
      operationId: getPropertyLifeTenancyTenants
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: tenancyid
        in: path
        description: ID of the tenancy
        required: true
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Tenants retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - properties
      summary: Update tenants for this tenancy
      description: Update tenants for this tenancy
      operationId: updateTenantsForProperty
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: tenancyid
        in: path
        description: ID of the tenancy
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Items object containing array of contact IDs
        content:
          application/json: {}
        required: true
      responses:
        200:
          description: Tenants updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    post:
      tags:
      - properties
      summary: Attach a tenant to this tenancy
      description: Attach a tenant to this tenancy
      operationId: attachTenantToTenancy
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: tenancyid
        in: path
        description: ID of the tenancy
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Contact ID object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ID'
        required: true
      responses:
        200:
          description: Tenant attached
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{id}/features:
    get:
      tags:
      - properties
      summary: Retrieve features for this property
      description: Retrieve features for this property
      operationId: getPropertyFeatures
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Features retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - properties
      summary: Update features for this property
      description: Update features for this property
      operationId: updatePropertyFeatures
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Items object containing array of feature groups
        content:
          application/json: {}
        required: true
      responses:
        200:
          description: Features retrieved
          content: {}
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{class}/{salelease}/{id}/custom:
    get:
      tags:
      - properties
      summary: Retrieve a list of custom fields for a given property
      description: Retrieve a list of custom fields for a given property
      operationId: getPropertyCustomFields
      parameters:
      - name: class
        in: path
        description: Class of property
        required: true
        schema:
          type: string
      - name: salelease
        in: path
        description: Filter by sale or lease properties
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Custom fields retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - properties
      summary: Update the custom fields for this property
      description: Update the custom fields for this property
      operationId: updatePropertyCustomFields
      parameters:
      - name: class
        in: path
        description: Class of property
        required: true
        schema:
          type: string
      - name: salelease
        in: path
        description: Filter by sale or lease properties
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Items object containing array of custom fields
        content:
          application/json: {}
        required: true
      responses:
        200:
          description: Custom fields updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_2'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{class}/{salelease}/upcomingOpenHomes:
    get:
      tags:
      - properties
      summary: Retrieve a list of upcoming open homes
      description: Retrieve a list of upcoming open homes
      operationId: getUpcomingOpenHomes
      parameters:
      - name: class
        in: path
        description: Class of property
        required: true
        schema:
          type: string
          enum:
          - residential
          - rural
          - holidayRental
      - name: salelease
        in: path
        description: Filter by sale or lease properties
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - name: days
        in: query
        description: Number of days to look ahead (default 7)
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Open Homes retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.1
  /properties/{salelease}:
    get:
      tags:
      - properties
      summary: Retrieve a list of sale or lease properties
      description: Retrieve a list of sale or lease properties
      operationId: getPropertiesLife
      parameters:
      - name: salelease
        in: path
        description: sale/lease
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - $ref: '#/components/parameters/modifiedSince'
      - $ref: '#/components/parameters/modifiedBefore'
      - $ref: '#/components/parameters/priceReducedSince'
      - $ref: '#/components/parameters/priceReducedBefore'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - inserted
          - modified
          - suburb
          - searchPrice
      - $ref: '#/components/parameters/sortOrder'
      - $ref: '#/components/parameters/suburbs'
      - $ref: '#/components/parameters/branches'
      - $ref: '#/components/parameters/types'
      - name: contactStaff
        in: query
        description: Filter properties with contactStaff containing this user ID
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
            format: int64
      - name: status
        in: query
        description: Filter by a list of statuses
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - prospect
            - appraisal
            - listing
            - conditional
            - listingOrConditional
            - unconditional
      - name: propertyClass
        in: query
        description: Filter by a list of property classes
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - residential
            - commercial
            - business
            - rural
            - holidayRental
            - land
      - name: availableOnly
        in: query
        description: Only used to if propertyClass equals 'commercial'
        schema:
          type: boolean
      - name: tenantedInvestmentOnly
        in: query
        description: Only used to if propertyClass equals 'commercial'
        schema:
          type: boolean
      - name: minBed
        in: query
        description: Filter properties greater than or equal to min beds
        schema:
          type: integer
          format: int64
      - name: minBath
        in: query
        description: Filter properties greater than or equal to min baths
        schema:
          type: integer
          format: int64
      - name: minCar
        in: query
        description: Filter properties greater than or equal to min car spaces
        schema:
          type: integer
          format: int64
      - name: minPricePerSqm
        in: query
        description: Filter properties greater than or equal to min price per sqm
        schema:
          type: number
          format: float
      - name: maxPricePerSqm
        in: query
        description: Filter properties less than or equal to max price per sqm
        schema:
          type: number
          format: float
      - name: minPrice
        in: query
        description: Filter properties greater than or equal to min price
        schema:
          type: number
          format: float
      - name: maxPrice
        in: query
        description: Filter properties less than or equal to max price
        schema:
          type: number
          format: float
      - name: minLand
        in: query
        description: Filter properties greater than or equal to min land. Must supply an area type.
        schema:
          type: number
          format: float
      - name: maxLand
        in: query
        description: Filter properties less than or equal to max land. Must supply an area type.
        schema:
          type: number
          format: float
      - name: areaType
        in: query
        description: Specify the units for minLand, maxLand filters
        schema:
          type: string
          enum:
          - sqm
          - acre
          - hectare
      - name: minFloor
        in: query
        description: Filter properties greater than or equal to min floor.
        schema:
          type: number
          format: float
      - name: maxFloor
        in: query
        description: Filter properties less than or equal to max floor.
        schema:
          type: number
          format: float
      responses:
        200:
          description: Properties retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{id}/photos/upload:
    post:
      tags:
      - properties
      summary: Upload a new photo to this property
      description: Upload a new photo to this property. This endpoint returns an upload_url where the file data can be PUT. Can be used for large files.
      operationId: addPropertyPhotoUpload
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Photo upload object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PropertyPhotoUpload'
        required: true
      responses:
        201:
          description: Photo record created. Photo data can now be posted to the returned URL.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileToBeUploaded'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{id}/{salelease}/{lifeid}/matchingContacts:
    get:
      tags:
      - properties
      summary: Retrieve a list of contacts with requirements matching this property
      description: Retrieve a list of contacts with requirements matching this property
      operationId: getPropertyMatchingContacts
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - inserted
          - modified
          - firstName
          - lastName
          - touched
      - $ref: '#/components/parameters/sortOrder'
      responses:
        200:
          description: Matching contacts retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{id}/{salelease}/{lifeid}/files/upload:
    post:
      tags:
      - properties
      summary: Attach a file to this property life
      description: Attach a file to this property life. This endpoint returns an upload_url where the file data can be PUT. Can be used for large files.
      operationId: addPropertyFileLifeUpload
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      requestBody:
        description: File upload object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PropertyFileWithFoldersUpload'
        required: true
      responses:
        201:
          description: File record created. File data can now be posted to the returned URL.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileToBeUploaded'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{id}/{salelease}/{lifeid}/feedback/summary:
    get:
      tags:
      - properties
      summary: Retrieve a summary of property feedback feedback attached to this life
      description: Retrieve a summary showing how many times each contact has provided feedback/interacted with this property life
      operationId: getPropertyFeedbackLifeSummary
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: feedbackAfter
        in: query
        description: Filter feedback occurring on or after this date
        schema:
          type: string
          format: date
      - name: feedbackBefore
        in: query
        description: Filter feedback occurring before this date
        schema:
          type: string
          format: date
      - $ref: '#/components/parameters/modifiedSince'
      - $ref: '#/components/parameters/modifiedBefore'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - count
      - $ref: '#/components/parameters/sortOrder'
      responses:
        200:
          description: Property feedback summary retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{propertyid}/lease/{lifeid}/landlords/{id}:
    delete:
      tags:
      - properties
      summary: Remove a landlord from this property life
      description: Remove a landlord from this property life
      operationId: deleteLandlordForProperty
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the landlord
        required: true
        schema:
          type: integer
          format: int64
      responses:
        204:
          description: Landlord removed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{propertyid}/lease/{lifeid}/tenancy/{tenancyid}/tenants/{id}:
    delete:
      tags:
      - properties
      summary: Remove a tenant from this property life
      description: Remove a tenant from this property life
      operationId: deleteTenantForProperty
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: tenancyid
        in: path
        description: ID of the tenancy
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the tenant
        required: true
        schema:
          type: integer
          format: int64
      responses:
        204:
          description: Tenant removed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{propertyid}/sale/{lifeid}/owners/{id}:
    delete:
      tags:
      - properties
      summary: Remove an owner from this property life
      description: Remove an owner from this property life
      operationId: deleteOwnerForProperty
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the owner
        required: true
        schema:
          type: integer
          format: int64
      responses:
        204:
          description: Owner removed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{propertyid}/sale/{lifeid}/purchasers/{id}:
    delete:
      tags:
      - properties
      summary: Remove a purchaser from this property life
      description: Remove a purchaser from this property life
      operationId: deletePurchaserForProperty
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the purchaser
        required: true
        schema:
          type: integer
          format: int64
      responses:
        204:
          description: Purchaser removed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{id}/sale/{lifeid}/offerConditions:
    get:
      tags:
      - properties
      summary: Retrieve a list of offer conditions for this property life
      description: Retrieve a list of offer conditions for this property life
      operationId: getPropertyLifeOfferConditions
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: userid
        in: query
        description: Items related to this user ID
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: sort
        in: query
        description: Sort items by field
        schema:
          type: string
          enum:
          - due
      - $ref: '#/components/parameters/sortOrder'
      responses:
        200:
          description: Offer Conditions retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{propertyid}/sale/{lifeid}/offerConditions/{id}:
    get:
      tags:
      - properties
      summary: Retrieve an offer condition for this property life
      description: Retrieve an offer condition for this property life
      operationId: getPropertyLifeOfferCondition
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the offer condition
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Offer Condition retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyOfferCondition'
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - properties
      summary: Update a property's offer condition
      description: Update a property's offer condition
      operationId: updatePropertyOfferCondition
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the offer condition
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: PropertyOfferCondition object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePropertyOfferCondition'
        required: true
      responses:
        200:
          description: Offer Condition updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyOfferCondition'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{propertyid}/sale/{lifeid}/offerConditions/{id}/complete:
    put:
      tags:
      - properties
      summary: Complete a property's offer condition
      description: Complete a property's offer condition
      operationId: completePropertyOfferCondition
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the offer condition
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Offer Condition updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{propertyid}/sale/{lifeid}/offerConditions/{id}/uncomplete:
    put:
      tags:
      - properties
      summary: Uncomplete a property's offer condition
      description: Uncomplete a property's offer condition
      operationId: uncompletePropertyOfferCondition
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the offer condition
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Offer Condition updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/lookup/{propertyReference}:
    get:
      tags:
      - properties
      summary: Look up property information based on property reference
      description: Look up property information based on the property reference sent to portal sites (e.g. &lt;uniqueID&gt;)
      operationId: lookupPropertyByPortalReference
      parameters:
      - name: propertyReference
        in: path
        description: Property reference to look up
        required: true
        schema:
          type: string
      responses:
        200:
          description: Property retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyExtended'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{id}/sale/statusChange/listing:
    put:
      tags:
      - properties
      summary: Convert a prospect or appraisal sale property to listing status
      description: Convert a prospect or appraisal sale property to listing status
      operationId: convertToListing
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Status changed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
        400:
          description: Status could not be changed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{id}/lease/statusChange/management:
    put:
      tags:
      - properties
      summary: Convert a prospect or appraisal lease property to management status
      description: Convert a prospect or appraisal lease property to management status
      operationId: convertToManagement
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Status changed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
        400:
          description: Status could not be changed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{id}/{salelease}/{lifeid}/interest:
    get:
      tags:
      - properties
      summary: Retrieve a list of contacts and their interest related this property life
      description: Retrieve a list of contacts and their interest related this property life
      operationId: getPropertyLifeInterest
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Property life interest retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{id}/{salelease}/{lifeid}/interest/{contactid}:
    get:
      tags:
      - properties
      summary: Retrieve a single contact's interest in this property life
      description: Retrieve a single contact's interest in this property life
      operationId: getPropertyLifeInterestItem
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - name: contactid
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Property life interest retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyLifeInterest'
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - properties
      summary: Update a contact's interest in this property life
      description: Update a contact's interest in this property life
      operationId: updatePropertyLifeInterest
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - name: contactid
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Interest object
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/UpdatePropertyLifeInterest'
        required: true
      responses:
        200:
          description: Property life interest updated
          content: {}
        201:
          description: Property life interest added
          content: {}
        400:
          description: Invalid data
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{id}/{salelease}/{lifeid}/enquirySources:
    get:
      tags:
      - properties
      summary: Retrieve a list of contacts and their source of enquiry related this property life
      description: Retrieve a list of contacts and their source of enquiry related this property life
      operationId: getPropertyLifeEnquirySources
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Property life enquiry sources retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{id}/{salelease}/{lifeid}/enquirySources/{contactid}:
    get:
      tags:
      - properties
      summary: Retrieve a single contact's source of enquiry for this property life
      description: Retrieve a single contact's source of enquiry for this property life
      operationId: getPropertyLifeEnquirySourcesItem
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - name: contactid
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Property life enquiry source retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyLifeEnquirySource'
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - properties
      summary: Update a contact's source of enquiry for this property life
      description: Update a contact's source of enquiry for this property life
      operationId: updatePropertyLifeEnquirySource
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - name: contactid
        in: path
        description: ID of the contact
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Enquiry Source object
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/UpdatePropertyLifeEnquirySource'
        required: true
      responses:
        200:
          description: Property life enquiry source updated
          content: {}
        201:
          description: Property life enquiry source added
          content: {}
        400:
          description: Invalid data
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /contacts/currentTenants:
    get:
      tags:
      - properties
      summary: Retrieve a list of current tenants across all properties
      description: Retrieve a list of current tenants across all properties
      operationId: getCurrentTenants
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Tenants retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /contacts/currentLandlords:
    get:
      tags:
      - properties
      summary: Retrieve a list of current landlords across all properties
      description: Retrieve a list of current landlords across all properties
      operationId: getCurrentLandlords
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Landlords retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /contacts/currentOwners:
    get:
      tags:
      - properties
      summary: Retrieve a list of current owners/vendors across all sale properties
      description: Retrieve a list of current owners/vendors across all sale properties
      operationId: getCurrentOwners
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Owners retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /contacts/currentPurchasers:
    get:
      tags:
      - properties
      summary: Retrieve a list of current purchasers across all sale properties
      description: Retrieve a list of current purchasers across all sale properties
      operationId: getCurrentPurchasers
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Purchasers retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{propertyid}/lease/{lifeid}/maintenance:
    get:
      tags:
      - properties
      summary: Retrieve a list of maintenance jobs for this property life
      description: Retrieve a list of maintenance jobs for this property life
      operationId: getMaintenance
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the lease life
        required: true
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: tenancy
        in: query
        description: Filter maintenance jobs for this tenancy id
        schema:
          type: integer
          format: int64
      - name: completed
        in: query
        description: Filter maintenance jobs by their completed status
        schema:
          type: boolean
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - inserted
          - modified
      - $ref: '#/components/parameters/sortOrder'
      responses:
        200:
          description: Maintenance jobs retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    post:
      tags:
      - properties
      summary: Create a maintenance job
      description: Create a maintenance job
      operationId: addMaintenance
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the lease life
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Maintenance job object
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/AddMaintenance'
        required: true
      responses:
        201:
          description: Maintenance job created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Maintenance'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{propertyid}/lease/{lifeid}/maintenance/{jobid}:
    get:
      tags:
      - properties
      summary: Retrieve a single maintenance job
      description: Retrieve a single maintenance job
      operationId: getMaintenanceJob
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the lease life
        required: true
        schema:
          type: integer
          format: int64
      - name: jobid
        in: path
        description: ID of the maintenance job
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Maintenance job retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Maintenance'
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - properties
      summary: Update a single maintenance job
      description: Update a single maintenance job
      operationId: updateMaintenance
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the lease life
        required: true
        schema:
          type: integer
          format: int64
      - name: jobid
        in: path
        description: ID of the maintenance job
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Maintenance job object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMaintenance'
        required: true
      responses:
        200:
          description: Maintenance job updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Maintenance'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    delete:
      tags:
      - properties
      summary: Delete a maintenance job
      description: Delete a maintenance job
      operationId: deleteMaintenance
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the lease life
        required: true
        schema:
          type: integer
          format: int64
      - name: jobid
        in: path
        description: ID of the maintenance job
        required: true
        schema:
          type: integer
          format: int64
      responses:
        204:
          description: Maintenance job deleted
          content: {}
        400:
          description: Invalid data
          content: {}
        403:
          description: User does not have permission to delete maintenance jobs
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{propertyid}/lease/{lifeid}/maintenance/{jobid}/photos:
    post:
      tags:
      - properties
      summary: Add a maintenance job photo
      description: Add a maintenance job photo
      operationId: addMaintenancePhoto
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the lease life
        required: true
        schema:
          type: integer
          format: int64
      - name: jobid
        in: path
        description: ID of the maintenance job
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
              - photo
              properties:
                description:
                  type: string
                  description: The description of the maintenance photo
                photo:
                  type: string
                  description: The photo to be uploaded
                  format: binary
        required: true
      responses:
        201:
          description: Maintenance job photo created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaintenancePhoto'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{propertyid}/lease/{lifeid}/maintenance/{jobid}/photos/{id}:
    get:
      tags:
      - properties
      summary: Retrieve a single maintenance job photo
      description: Retrieve a single maintenance job photo
      operationId: getMaintenanceJob
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the lease life
        required: true
        schema:
          type: integer
          format: int64
      - name: jobid
        in: path
        description: ID of the maintenance job
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the maintenance job photo
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Maintenance job photo retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaintenancePhoto'
      security:
      - Api-Key: []
        Bearer: []
    delete:
      tags:
      - properties
      summary: Delete a maintenance job photo
      description: Delete a maintenance job photo
      operationId: deleteMaintenancePhoto
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the lease life
        required: true
        schema:
          type: integer
          format: int64
      - name: jobid
        in: path
        description: ID of the maintenance job
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the maintenance job photo
        required: true
        schema:
          type: integer
          format: int64
      responses:
        204:
          description: Maintenance job photo deleted
          content: {}
        400:
          description: Invalid data
          content: {}
        403:
          description: User does not have permission to delete maintenance job photos
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{propertyid}/lease/{lifeid}/maintenance/{jobid}/requests:
    get:
      tags:
      - properties
      summary: Retrieve a list of requests for a maintenance job
      description: Retrieve a list of requests for a maintenance job
      operationId: getMaintenanceRequests
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the lease life
        required: true
        schema:
          type: integer
          format: int64
      - name: jobid
        in: path
        description: ID of the maintenance job
        required: true
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: workOrders
        in: query
        description: Filter maintenance job requests by work order status
        schema:
          type: boolean
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - inserted
      - $ref: '#/components/parameters/sortOrder'
      responses:
        200:
          description: Maintenance requests retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    post:
      tags:
      - properties
      summary: Create a maintenance job request
      description: Create a maintenance request
      operationId: addMaintenanceRequest
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the lease life
        required: true
        schema:
          type: integer
          format: int64
      - name: jobid
        in: path
        description: ID of the maintenance job
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Maintenance request object
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/AddMaintenanceRequest'
        required: true
      responses:
        201:
          description: Maintenance request created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaintenanceRequest'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{propertyid}/lease/{lifeid}/maintenance/{jobid}/requests/{id}/initiateWorkOrder:
    put:
      tags:
      - properties
      summary: Initiate a maintenance work order
      description: Initiate a maintenance work order
      operationId: initiateMaintenceWorkOrder
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the lease life
        required: true
        schema:
          type: integer
          format: int64
      - name: jobid
        in: path
        description: ID of the maintenance job
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the maintenance request
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Work order object
        content:
          application/json:
            schema:
              type: object
              properties:
                subject:
                  type: string
                bodyHTML:
                  type: string
                sender:
                  $ref: '#/components/schemas/ID'
        required: true
      responses:
        200:
          description: Work order initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{propertyid}/lease/{lifeid}/maintenance/{jobid}/requests/{id}/complete:
    put:
      tags:
      - properties
      summary: Complete a maintenance work order
      description: Complete a maintenance work order
      operationId: completeMaintenceWorkOrder
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the lease life
        required: true
        schema:
          type: integer
          format: int64
      - name: jobid
        in: path
        description: ID of the maintenance job
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the maintenance request
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Work order completed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Maintenance'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{propertyid}/lease/{lifeid}/maintenance/{jobid}/notes:
    get:
      tags:
      - properties
      summary: Retrieve a list of notes for a maintenance job
      description: Retrieve a list of notes for a maintenance job
      operationId: getMaintenanceNotes
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the lease life
        required: true
        schema:
          type: integer
          format: int64
      - name: jobid
        in: path
        description: ID of the maintenance job
        required: true
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - inserted
      - $ref: '#/components/parameters/sortOrder'
      responses:
        200:
          description: Maintenance notes retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{propertyid}/lease/{lifeid}/tenancy/{id}/inspections:
    get:
      tags:
      - properties
      summary: Retrieve a list of inspections for a tenancy
      description: Retrieve a list of inspections for a tenancy
      operationId: getInspections
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the lease life
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the tenancy
        required: true
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - inserted
      - $ref: '#/components/parameters/sortOrder'
      - name: completed
        in: query
        description: Filter inspections by their completed status
        schema:
          type: boolean
      responses:
        200:
          description: Inspections retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    post:
      tags:
      - properties
      summary: Create an inspection
      description: Create an inspection
      operationId: addInspection
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the lease life
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the tenancy
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Inspection object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddInspection'
        required: true
      responses:
        201:
          description: Inspection created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Inspection'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{propertyid}/lease/{lifeid}/tenancy/{tenancyid}/inspections/{id}:
    get:
      tags:
      - properties
      summary: Retrieve a single inspection for a tenancy
      description: Retrieve a single inspection for a tenancy
      operationId: getInspection
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the lease life
        required: true
        schema:
          type: integer
          format: int64
      - name: tenancyid
        in: path
        description: ID of the tenancy
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the inspection
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Inspection retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Inspection'
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - properties
      summary: Update an inspection
      description: Update an inspection
      operationId: updateInspection
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the lease life
        required: true
        schema:
          type: integer
          format: int64
      - name: tenancyid
        in: path
        description: ID of the tenancy
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the inspection
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Inspection object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateInspection'
        required: true
      responses:
        200:
          description: Inspection Updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Inspection'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    delete:
      tags:
      - properties
      summary: Delete an inspection
      description: Delete an inspection
      operationId: deleteInspection
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the lease life
        required: true
        schema:
          type: integer
          format: int64
      - name: tenancyid
        in: path
        description: ID of the tenancy
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the inspection
        required: true
        schema:
          type: integer
          format: int64
      responses:
        204:
          description: Inspection deleted
          content: {}
        400:
          description: Invalid data
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /property/flush:
    put:
      tags:
      - properties
      summary: Trigger a property to be re-sent to certain portal sites
      description: Trigger a property to be re-sent to certain portal sites. Note that this endpoint only sends properties that are already selected to feed to the given sites. Please contact VaultRE for valid values of 'portals'
      operationId: flushProperty
      requestBody:
        description: Property Flush object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FlushProperty'
        required: true
      responses:
        200:
          description: Property flushed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{propertyid}/saleHistory:
    get:
      tags:
      - properties
      summary: Retrieve the full sale history for a property
      description: Retrieve the full sale history for a property including commission splits
      operationId: getPropertySaleHistory
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Sale History retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/{propertyid}/{salelease}/{lifeid}/scheduledViewing:
    post:
      tags:
      - properties
      summary: Add a Scheduled Viewing
      description: Add a Scheduled Viewing
      operationId: addScheduledViewing
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease
        required: true
        schema:
          type: string
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Scheduled Viewing details
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InsertScheduledViewing'
        required: true
      responses:
        201:
          description: Scheduled Viewing added
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_3'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    get:
      tags:
      - properties
      summary: Retrieve a list of scheduled viewings for this life
      description: Retrieve a list of scheduled viewings for this life
      operationId: getPropertyLifeScheduledViewings
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: feedbackAfter
        in: query
        description: Filter scheduled viewings occurring on or after this date
        schema:
          type: string
          format: date
      - name: feedbackBefore
        in: query
        description: Filter scheduled viewings occurring before this date
        schema:
          type: string
          format: date
      - $ref: '#/components/parameters/modifiedSince'
      - $ref: '#/components/parameters/modifiedBefore'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - inserted
          - feedbackDate
      - $ref: '#/components/parameters/sortOrder'
      responses:
        200:
          description: Scheduled viewings retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/ContactNoteAndContact'
                  totalItems:
                    type: integer
                    format: int64
                  totalPages:
                    type: integer
                    format: int64
                  urls:
                    $ref: '#/components/schemas/Urls'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/categories:
    get:
      tags:
      - properties
      summary: Retrieve a list of property category mappings across all properties
      description: Retrieve a list of property category mappings across all properties
      operationId: getCategoriesPropertyBulk
      parameters:
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - modified
      - $ref: '#/components/parameters/sortOrder'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - $ref: '#/components/parameters/modifiedSince'
      - $ref: '#/components/parameters/modifiedBefore'
      responses:
        200:
          description: Categories retrieved
          content: {}
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.2
  /properties/sale:
    get:
      tags:
      - properties
      summary: Retrieve a list of sale properties
      description: Retrieve a list of sale properties
      operationId: getPropertiesLifeSale
      parameters:
      - $ref: '#/components/parameters/modifiedSince'
      - $ref: '#/components/parameters/modifiedBefore'
      - $ref: '#/components/parameters/priceReducedSince'
      - $ref: '#/components/parameters/priceReducedBefore'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - $ref: '#/components/parameters/published'
      - $ref: '#/components/parameters/publishedOnPortals'
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - inserted
          - modified
          - suburb
          - searchPrice
          - landArea
          - floorArea
          - publishedToWeb
      - $ref: '#/components/parameters/sortOrder'
      - $ref: '#/components/parameters/accessBy'
      - $ref: '#/components/parameters/suburbs'
      - $ref: '#/components/parameters/precincts'
      - $ref: '#/components/parameters/customRegions'
      - $ref: '#/components/parameters/branches'
      - $ref: '#/components/parameters/types_2'
      - name: contactStaff
        in: query
        description: Filter properties with contactStaff containing this user ID
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
            format: int64
      - name: status
        in: query
        description: Filter by a list of statuses
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - prospect
            - appraisal
            - listing
            - conditional
            - listingOrConditional
            - unconditional
            - management
      - name: portalStatus
        in: query
        description: Filter by a list of portal statuses
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - prospect
            - appraisal
            - listing
            - conditional
            - listingOrConditional
            - unconditional
            - management
      - name: propertyClass
        in: query
        description: Filter by a list of property classes
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - residential
            - commercial
            - business
            - rural
            - holidayRental
            - land
      - name: availableOnly
        in: query
        description: Only used to if propertyClass equals 'commercial'
        schema:
          type: boolean
      - name: tenantedInvestmentOnly
        in: query
        description: Only used to if propertyClass equals 'commercial'
        schema:
          type: boolean
      - name: minBed
        in: query
        description: Filter properties greater than or equal to min beds
        schema:
          type: integer
          format: int64
      - name: minBath
        in: query
        description: Filter properties greater than or equal to min baths
        schema:
          type: integer
          format: int64
      - name: minCar
        in: query
        description: Filter properties greater than or equal to min car spaces
        schema:
          type: integer
          format: int64
      - name: minPricePerSqm
        in: query
        description: Filter properties greater than or equal to min price per sqm
        schema:
          type: number
          format: float
      - name: maxPricePerSqm
        in: query
        description: Filter properties less than or equal to max price per sqm
        schema:
          type: number
          format: float
      - name: minPrice
        in: query
        description: Filter properties greater than or equal to min price
        schema:
          type: number
          format: float
      - name: maxPrice
        in: query
        description: Filter properties less than or equal to max price
        schema:
          type: number
          format: float
      - name: minLand
        in: query
        description: Filter properties greater than or equal to min land. Must supply an area type.
        schema:
          type: number
          format: float
      - name: maxLand
        in: query
        description: Filter properties less than or equal to max land. Must supply an area type.
        schema:
          type: number
          format: float
      - name: areaType
        in: query
        description: Specify the units for minLand, maxLand filters
        schema:
          type: string
          enum:
          - sqm
          - acre
          - hectare
      - name: minFloor
        in: query
        description: Filter properties greater than or equal to min floor.
        schema:
          type: number
          format: float
      - name: maxFloor
        in: query
        description: Filter properties less than or equal to max floor.
        schema:
          type: number
          format: float
      responses:
        200:
          description: Properties retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PropertyLife'
                  totalItems:
                    type: integer
                    format: int64
                  totalPages:
                    type: integer
                    format: int64
                  urls:
                    $ref: '#/components/schemas/Urls'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
  /properties/sale/fallenSaleWithdrawn:
    get:
      tags:
      - properties
      summary: Retrieve a list of fallen or withdrawn property sales
      description: Retrieve a list of fallen or withdrawn property sales
      operationId: getFallenWithdrawnSales
      parameters:
      - $ref: '#/components/parameters/fallenBefore'
      - $ref: '#/components/parameters/fallenSince'
      - $ref: '#/components/parameters/withdrawnBefore'
      - $ref: '#/components/parameters/withdrawnSince'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Properties retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PropertyLife'
                  totalItems:
                    type: integer
                    format: int64
                  totalPages:
                    type: integer
                    format: int64
                  urls:
                    $ref: '#/components/schemas/Urls'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
  /properties/lease:
    get:
      tags:
      - properties
      summary: Retrieve a list of lease properties
      description: Retrieve a list of lease properties
      operationId: getPropertiesLifeLease
      parameters:
      - $ref: '#/components/parameters/modifiedSince'
      - $ref: '#/components/parameters/modifiedBefore'
      - $ref: '#/components/parameters/priceReducedSince'
      - $ref: '#/components/parameters/priceReducedBefore'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - $ref: '#/components/parameters/published'
      - $ref: '#/components/parameters/publishedOnPortals'
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - inserted
          - modified
          - suburb
          - searchPrice
          - landArea
          - floorArea
      - $ref: '#/components/parameters/sortOrder'
      - $ref: '#/components/parameters/suburbs'
      - $ref: '#/components/parameters/accessBy'
      - $ref: '#/components/parameters/precincts'
      - $ref: '#/components/parameters/customRegions'
      - $ref: '#/components/parameters/branches'
      - $ref: '#/components/parameters/types_2'
      - name: contactStaff
        in: query
        description: Filter properties with contactStaff containing this user ID
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
            format: int64
      - name: status
        in: query
        description: Filter by a list of statuses
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - prospect
            - appraisal
            - listing
            - conditional
            - listingOrConditional
            - unconditional
            - management
      - name: portalStatus
        in: query
        description: Filter by a list of portal statuses
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - prospect
            - appraisal
            - listing
            - conditional
            - listingOrConditional
            - unconditional
            - management
      - name: propertyClass
        in: query
        description: Filter by a list of property classes
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - residential
            - commercial
            - business
            - rural
            - holidayRental
            - land
      - name: availableOnly
        in: query
        description: Only used to if propertyClass equals 'commercial'
        schema:
          type: boolean
      - name: tenantedInvestmentOnly
        in: query
        description: Only used to if propertyClass equals 'commercial'
        schema:
          type: boolean
      - name: minBed
        in: query
        description: Filter properties greater than or equal to min beds
        schema:
          type: integer
          format: int64
      - name: minBath
        in: query
        description: Filter properties greater than or equal to min baths
        schema:
          type: integer
          format: int64
      - name: minCar
        in: query
        description: Filter properties greater than or equal to min car spaces
        schema:
          type: integer
          format: int64
      - name: minPricePerSqm
        in: query
        description: Filter properties greater than or equal to min price per sqm
        schema:
          type: number
          format: float
      - name: maxPricePerSqm
        in: query
        description: Filter properties less than or equal to max price per sqm
        schema:
          type: number
          format: float
      - name: minPrice
        in: query
        description: Filter properties greater than or equal to min price
        schema:
          type: number
          format: float
      - name: maxPrice
        in: query
        description: Filter properties less than or equal to max price
        schema:
          type: number
          format: float
      - name: minLand
        in: query
        description: Filter properties greater than or equal to min land. Must supply an area type.
        schema:
          type: number
          format: float
      - name: maxLand
        in: query
        description: Filter properties less than or equal to max land. Must supply an area type.
        schema:
          type: number
          format: float
      - name: areaType
        in: query
        description: Specify the units for minLand, maxLand filters
        schema:
          type: string
          enum:
          - sqm
          - acre
          - hectare
      - name: minFloor
        in: query
        description: Filter properties greater than or equal to min floor.
        schema:
          type: number
          format: float
      - name: maxFloor
        in: query
        description: Filter properties less than or equal to max floor.
        schema:
          type: number
          format: float
      responses:
        200:
          description: Properties retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PropertyLife'
                  totalItems:
                    type: integer
                    format: int64
                  totalPages:
                    type: integer
                    format: int64
                  urls:
                    $ref: '#/components/schemas/Urls'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
  /properties/{id}/photos/order:
    put:
      tags:
      - properties
      summary: Reorder property photos
      description: Reorder the photos for a property by providing a new sequence of photo IDs. This endpoint is designed for mobile applications to allow drag-and-drop photo reordering. All photo IDs for the property must be included in the request.
      operationId: updatePropertyPhotoOrder
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Array of photo IDs in the desired order
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PropertyPhotoOrderRequest'
        required: true
      responses:
        200:
          description: Photo order updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyPhotoOrderResponse'
        400:
          description: Invalid request data
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  msg:
                    type: string
                    description: Error message describing the validation failure
                    example: 'INVALID_PHOTO_IDS: [99999]'
                  code:
                    type: string
                    example: 'INVALID_PHOTO_IDS: [99999]'
        403:
          description: User does not have permission to edit this property
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_4'
        404:
          description: Property not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_4'
        422:
          description: Validation error - empty photo array or malformed request
          content:
            application/json:
              schema:
                type: object
                properties:
                  messages:
                    type: object
                    properties:
                      photoIds:
                        type: array
                        items:
                          type: string
                        example:
                        - Shorter than minimum length 1.
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
  /properties/{propertyid}/sale/{lifeid}/trustledger/transactions:
    get:
      tags:
      - properties
      summary: Retrieve a list of trust ledger transactions for this property sale life
      description: Retrieve a list of trust ledger transactions on a given property sale life
      operationId: getPropertyLifeTrustLedgerTransactions
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property sale life
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Trust ledger transactions retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/TrustLedgerTransaction'
                  totalItems:
                    type: integer
                    format: int64
                  totalPages:
                    type: integer
                    format: int64
                  urls:
                    $ref: '#/components/schemas/Urls'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_4'
        403:
          description: User does not have access to property financials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_4'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
  /properties/{propertyid}/keys:
    get:
      tags:
      - properties
      summary: Retrieve a list of keys for this property
      description: Retrieve a list of keys for this property
      operationId: getPropertyKeys
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      - name: sort
        in: query
        description: Field by which to sort the results.
        schema:
          type: string
          enum:
          - keyname
          - iskeyout
          - propertyid
      - $ref: '#/components/parameters/sortOrder'
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Keys retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PropertyKey'
                  totalItems:
                    type: integer
                    format: int64
                  totalPages:
                    type: integer
                    format: int64
                  urls:
                    $ref: '#/components/schemas/Urls'
      security:
      - Api-Key: []
        Bearer: []
    post:
      tags:
      - properties
      summary: Add a new key to this property
      description: Add a new key to this property
      operationId: addPropertyKey
      parameters:
      - name: propertyid
        in: path
        description: ID of the property to add this key to
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: AddUpdatePropertyKey object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddUpdatePropertyKey'
        required: true
      responses:
        201:
          description: Add Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyKey'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_4'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
  /properties/{propertyid}/keys/{id}:
    get:
      tags:
      - properties
      summary: Retrieve a key from this property
      description: Retrieve a key from this property
      operationId: getPropertyKey
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the property key
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Key retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyKey'
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - properties
      summary: Update a property key
      description: Update a property key
      operationId: updatePropertyKey
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the property key
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: AddUpdatePropertyKey object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddUpdatePropertyKey'
        required: true
      responses:
        200:
          description: Key update
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyKey'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_4'
      security:
      - Api-Key: []
        Bearer: []
      x-codegen-request-body-name: body
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
  /properties/{id}/{salelease}/{lifeid}/portals:
    get:
      tags:
      - properties
      summary: Retrieve a list of portal sites to which this listing is published
      description: Retrieve a list of portal sites to which this listing is published
      operationId: getPropertyLifePortals
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Portals retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PortalAccess'
                  totalItems:
                    type: integer
                    format: int64
                  totalPages:
                    type: integer
                    format: int64
                  urls:
                    $ref: '#/components/schemas/Urls'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
  /properties/{id}/{salelease}/{lifeid}/portalIds:
    get:
      tags:
      - properties
      summary: Retrieve a list of property portal IDs
      description: Retrieve a list of known IDs of properties on published portal sites
      operationId: getPropertyLifePortalIds
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Portals retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PropertyPortalId'
                  totalItems:
                    type: integer
                    format: int64
                  totalPages:
                    type: integer
                    format: int64
                  urls:
                    $ref: '#/components/schemas/Urls'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
  /properties/{propertyid}/alarmDetails:
    get:
      tags:
      - properties
      summary: Retrieve a list of alarm details for a property
      description: Retrieve a list of alarm details for a property
      operationId: getPropertyAlarmDetails
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        '200':
          description: Alarm details retrieved
          content:
            application/json:
              schema:
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PropertyAlarmDetails'
                  totalItems:
                    type: integer
                    format: int64
                  totalPages:
                    type: integer
                    format: int64
                  urls:
                    $ref: '#/components/schemas/Urls'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
  /properties/{propertyid}/{salelease}/alarmDetails:
    get:
      tags:
      - properties
      summary: Retrieve a list of alarm details for a property life
      description: Retrieve a list of alarm details for a property life
      operationId: getPropertyLifeAlarmDetails
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        '200':
          description: Alarm details retrieved
          content:
            application/json:
              schema:
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PropertyAlarmDetails'
                  totalItems:
                    type: integer
                    format: int64
                  totalPages:
                    type: integer
                    format: int64
                  urls:
                    $ref: '#/components/schemas/Urls'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
  /properties/{id}/{salelease}/{lifeid}/rooms:
    get:
      tags:
      - properties
      summary: Retrieve a list of rooms defined for this property life
      description: Retrieve a list of rooms defined for this property life
      operationId: getPropertyLifeRooms
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease life record
        required: true
        schema:
          type: string
          enum:
          - sale
          - lease
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pagesize'
      responses:
        200:
          description: Property rooms retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PropertyRoom'
                  totalItems:
                    type: integer
                    format: int64
                  totalPages:
                    type: integer
                    format: int64
                  urls:
                    $ref: '#/components/schemas/Urls'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
  /properties/{id}/sale/{lifeid}/solicitors:
    get:
      tags:
      - properties
      summary: Retrieve purchaser and vendor solicitors defined for this property life
      description: Retrieve purchaser and vendor solicitors defined for this property life
      operationId: getPropertySolicitors
      parameters:
      - name: id
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Property solicitors retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  purchaser:
                    type: object
                    $ref: '#/components/schemas/ContactExtended_2'
                  vendor:
                    type: object
                    $ref: '#/components/schemas/ContactExtended_2'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
  /properties/externalRefs/lookup:
    get:
      tags:
      - properties
      summary: Retrieve properties from an external reference
      description: Retrieve properties from an external reference
      operationId: getPropertiesFromExternalReference
      parameters:
      - name: externalReference
        in: query
        description: External ID to use for lookup
        required: true
        schema:
          type: string
      responses:
        200:
          description: Property external reference retrieved
          content:
            application/json:
              schema:
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Property_3'
                  totalItems:
                    type: integer
                    format: int64
                  totalPages:
                    type: integer
                    format: int64
                  urls:
                    $ref: '#/components/schemas/Urls'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
  /properties/{propertyid}/listingConfigurations:
    get:
      tags:
      - properties
      summary: Retrieve a list of listing configurations for the given property
      description: Retrieve a list of listing configurations for the given property
      operationId: getPropertyListingConfigurations
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Listing Configurations retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PropertyListingConfiguration'
                  totalItems:
                    type: integer
                    format: int64
                  totalPages:
                    type: integer
                    format: int64
                  urls:
                    $ref: '#/components/schemas/Urls'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
  /properties/{propertyid}/strataProperties:
    get:
      tags:
      - properties
      summary: Retrieve a list of strata properties for the given property
      description: Retrieve a list of strata properties for the given strata building
      operationId: getPropertyStrataProperties
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Strata Properties retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PropertyStrataProperty'
                  totalItems:
                    type: integer
                    format: int64
                  totalPages:
                    type: integer
                    format: int64
                  urls:
                    $ref: '#/components/schemas/Urls'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
  /properties/{propertyid}/projectProperties:
    get:
      tags:
      - properties
      summary: Retrieve a list of project properties for the given property
      description: Retrieve a list of project properties for the given project
      operationId: getPropertyProjectProperties
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Project Properties retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PropertyProjectProperty'
                  totalItems:
                    type: integer
                    format: int64
                  totalPages:
                    type: integer
                    format: int64
                  urls:
                    $ref: '#/components/schemas/Urls'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
  /properties/{propertyid}/{salelease}/{lifeid}/qrcode:
    get:
      tags:
      - properties
      summary: Retrieve a check-in QR code for the given property life
      description: Retrieve a check-in QR code for the given property life
      operationId: getPropertyLifeQrCode
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: QR code retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  qrCode:
                    type: string
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
  /properties/{propertyid}/{salelease}/{lifeid}/hazards:
    get:
      tags:
      - properties
      summary: Retrieve a list of hazards for a given property life
      description: Retrieve a list of hazards for a given property life
      operationId: getPropertyLifeHazards
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Hazards retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/HazardsAndRisks'
                  totalItems:
                    type: integer
                    format: int64
                  totalPages:
                    type: integer
                    format: int64
                  urls:
                    $ref: '#/components/schemas/Urls'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
  /properties/{propertyid}/{salelease}/{lifeid}/externalFeedback/{id}:
    get:
      tags:
      - properties
      summary: Retrieve a single external feedback for a given property life
      description: Retrieve a single external feedback for a given property life
      operationId: getPropertyLifeExternalFeedbackById
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the external feedback
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: External Feedback retrieved
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ExternalFeedback'
      security:
      - Api-Key: []
        Bearer: []
    put:
      tags:
      - properties
      summary: Update an external feedback for a given property life
      description: Update an existing external feedback entry. You can update fields such as source, comments, feedbackDate, and priceOpinion.
      operationId: updatePropertyLifeExternalFeedback
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease
        required: true
        schema:
          type: string
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: ID of the external feedback to update
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: Fields to update on the external feedback
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateExternalFeedback'
        required: true
      responses:
        200:
          description: External Feedback updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalFeedback'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_4'
      security:
      - Api-Key: []
        Bearer: []
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
  /properties/{propertyid}/{salelease}/{lifeid}/externalFeedback:
    get:
      tags:
      - properties
      summary: Retrieve a list of external feedback for a given property life
      description: Retrieve a list of external feedback for a given property life
      operationId: getPropertyLifeExternalFeedback
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease
        required: true
        schema:
          type: integer
          format: int64
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: External Feedback retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExternalFeedback'
                  totalItems:
                    type: integer
                    format: int64
                  totalPages:
                    type: integer
                    format: int64
                  urls:
                    $ref: '#/components/schemas/Urls'
      security:
      - Api-Key: []
        Bearer: []
    post:
      tags:
      - properties
      summary: Add an External Feedback
      description: Add an External Feedback
      operationId: addPropertyLifeExternalFeedback
      parameters:
      - name: propertyid
        in: path
        description: ID of the property
        required: true
        schema:
          type: integer
          format: int64
      - name: salelease
        in: path
        description: Sale or lease
        required: true
        schema:
          type: string
      - name: lifeid
        in: path
        description: ID of the property life
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: External Feedback details
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InsertExternalFeedback'
        required: true
      responses:
        201:
          description: External Feedback added
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalFeedback'
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessOrError_4'
    servers:
    - url: https://ap-southeast-2.api.vaultre.com.au/api/v1.3
components:
  schemas:
    Unconditional:
      type: object
      properties:
        transactionId:
          type: string
          format: uuid
        transactionDate:
          type: string
          format: date-time
        unconditionalId:
          type: string
        listingId:
          type: string
        propertyId:
          type: string
        officeId:
          type: string
        commissionSplits:
          type: array
          items:
            $ref: '#/components/schemas/CommissionSplit'
        unconditionalDate:
          type: string
          format: date-time
        proposedSettlementDate:
          type: string
          format: date-time
        salePrice:
          type: number
          format: float
        grossCommissionExGST:
          type: number
          format: float
        address:
          $ref: '#/components/schemas/Address'
        classification:
          type: string
          enum:
          - residential
          - commercial
          - business
          - rural
          - land
        active:
          type: boolean
        soldType:
          type: string
          enum:
          - privateTreaty
          - auction
          - priorToAuction
          - postAuction
          - tender
    Address:
      type: object
      properties:
        level:
          type: string
        unitNumber:
          type: string
        streetNumber:
          type: string
        street:
          type: string
        suburb:
          type: string
        postcode:
          type: string
        state:
          type: string
          enum:
          - WA
          - NSW
          - SA
          - QLD
          - ACT
          - NT
          - TAS
          - VIC
    Appraisal:
      type: object
      properties:
        transactionId:
          type: string
          format: uuid
        transactionDate:
          type: string
          format: date-time
        appraisalId:
          type: string
        propertyId:
          type: string
        officeId:
          type: string
        staff:
          type: array
          items:
            $ref: '#/components/schemas/PropertyStaff'
        appraisalDate:
          type: string
          format: date-time
        appraisalPrice:
          type: number
          format: float
        address:
          $ref: '#/components/schemas/Address'
        classification:
          type: string
          enum:
          - residential
          - commercial
          - business
          - rural
          - land
        active:
          type: boolean
    Settlement:
      type: object
      properties:
        transactionId:
          type: string
          format: uuid
        transactionDate:
          type: string
          format: date-time
        unconditionalId:
          type: string
        settlementId:
          type: string
        listingId:
          type: string
        propertyId:
          type: string
        officeId:
          type: string
        commissionSplits:
          type: array
          items:
            $ref: '#/components/schemas/CommissionSplit'
        unconditionalDate:
          type: string
          format: date-time
        settlementDate:
          type: string
          format: date-time
        salePrice:
          type: number
          format: float
        grossCommissionExGST:
          type: number
          format: float
        address:
          $ref: '#/components/schemas/Address'
        classification:
          type: string
          enum:
          - residential
          - commercial
          - business
          - rural
          - land
        active:
          type: boolean
        soldType:
          type: string
          enum:
          - privateTreaty
          - auction
          - priorToAuction
          - postAuction
          - tender
        vendorPaidAdvertising:
          type: number
          format: float
        agentPaidAdvertising:
          type: number
          format: float
    Listing:
      type: object
      properties:
        transactionId:
          type: string
          format: uuid
        transactionDate:
          type: string
          format: date-time
        listingId:
          type: string
        appraisalId:
          type: string
        propertyId:
          type: string
        officeId:
          type: string
        staff:
          type: array
          items:
            $ref: '#/components/schemas/PropertyStaff'
        auctionDate:
          type: string
          format: date-time
        auctionVenue:
          type: string
        tenderDate:
          type: string
          format: date-time
        listingAuthorityDate:
          type: string
          format: date-time
        listingPrice:
          type: number
          format: float
        address:
          $ref: '#/components/schemas/Address'
        classification:
          type: string
          enum:
          - residential
          - commercial
          - business
          - rural
          - land
        active:
          type: boolean
        listingAuthorityType:
          type: string
          enum:
          - exclusive
          - open
          - conjunctional
        methodOfSale:
          type: string
          enum:
          - privateTreaty
          - auction
          - tender
          - setSaleDate
          - saleByNegotiation
          - formalTender
          - expressionOfInterest
    SuccessOrError:
      type: object
      properties:
        success:
          type: boolean
        msg:
          type: string
    CommissionSplit:
      type: object
      properties:
        staffId:
          type: string
        conjunctingAgentName:
          type: string
        type:
          type: string
          enum:
          - lister
          - seller
          - listerAndSeller
          - conjunctionalAgent
        amountExGST:
          type: number
          format: float
    PropertyStaff:
      type: object
      properties:
        staffId:
          type: string
    Withdrawn:
      type: object
      properties:
        transactionId:
          type: string
          format: uuid
        transactionDate:
          type: string
          format: date-time
        listingId:
          type: string
        appraisalId:
          type: string
        propertyId:
          type: string
        officeId:
          type: string
        withdrawnId:
          type: string
        staff:
          type: array
          items:
            $ref: '#/components/schemas/PropertyStaff'
        withdrawnDate:
          type: string
          format: date-time
        address:
          $ref: '#/components/schemas/Address'
        classification:
          type: string
          enum:
          - residential
          - commercial
          - business
          - rural
          - land
        active:
          type: boolean
        vendorPaidAdvertising:
          type: number
          format: float
        agentPaidAdvertising:
          type: number
          format: float
    ContactNoteTypePurpose:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    LeaseHistory:
      type: object
      properties:
        lifeId:
          type: number
          format: int64
        status:
          type: string
          enum:
          - prospect
          - appraisal
          - listing
          - conditional
          - unconditional
          - settled
          - management
          - withdrawn
    ID:
      type: object
      properties:
        id:
          type: integer
          format: int64
    SaleHistory:
      type: object
      properties:
        lifeId:
          type: number
          format: int64
        appraisal:
          type: string
          format: date-time
        listingAuthority:
          type: string
          format: date-time
        conditional:
          type: string
          format: date-time
        unconditional:
          type: string
          format: date-time
        settlement:
          type: string
          format: date-time
        status:
          type: string
          enum:
          - prospect
          - appraisal
          - listing
          - conditional
          - unconditional
          - settled
          - withdrawn
    State:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        abbreviation:
          type: string
    Country:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        isocode:
          type: string
        gstRate:
          type: number
          format: float
    UpdatePropertyFeedback:
      type: object
      properties:
        note:
          $ref: '#/components/schemas/UpdateContactNote'
        contact:
          $ref: '#/components/schemas/ID'
        feedbackDate:
          type: string
          format: date-time
        priceOpinion:
          type: number
          format: float
    Geolocation:
      type: object
      properties:
        latitude:
          type: number
          format: float
        longitude:
          type: number
          format: float
        accuracy:
          type: string
          enum:
          - USERDEFINED
          - ROOFTOP
          - RANGE_INTERPOLATED
          - GEOMETRIC_CENTER
          - APPROXIMATE
    Area:
      type: object
      properties:
        value:
          type: integer
          format: int64
        units:
          type: string
          enum:
          - sqm
          - acre
          - hectare
    OpenHome:
      type: object
      properties:
        id:
          type: number
          format: int64
        start:
          type: string
          format: date-time
        end:
          type: string
          format: date-time
        user:
          $ref: '#/components/schemas/User'
        isRental:
          type: boolean
    UpdateContactNote:
      type: object
      properties:
        body:
          type: string
        readOnly:
          type: boolean
        type:
          $ref: '#/components/schemas/ID'
        reminder:
          $ref: '#/components/schemas/AddContactNoteReminder'
    PropertyNote:
      type: object
      properties:
        id:
          type: integer
          format: int64
        inserted:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
        body:
          type: string
        readOnly:
          type: boolean
        insertedBy:
          $ref: '#/components/schemas/User'
        type:
          $ref: '#/components/schemas/PropertyNoteType'
    Property:
      type: object
      properties:
        id:
          type: integer
          format: int64
        building:
          $ref: '#/components/schemas/Building'
        class:
          $ref: '#/components/schemas/PropertyClass'
        type:
          $ref: '#/components/schemas/PropertyType'
        address:
          $ref: '#/components/schemas/Address_2'
        displayAddress:
          type: string
        referenceID:
          type: string
        keyID:
          type: string
        photos:
          type: array
          items:
            $ref: '#/components/schemas/PropertyPhoto'
        searchPrice:
          type: number
          format: float
        displayPrice:
          type: string
        heading:
          type: string
        description:
          type: string
        brochureDescription:
          type: string
        landArea:
          $ref: '#/components/schemas/Area'
        volumeNumber:
          type: string
        folioNumber:
          type: string
        corelogicId:
          type: integer
          format: int64
        yearBuilt:
          type: integer
          format: int64
        inserted:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
        saleLifeId:
          type: integer
          format: int64
        leaseLifeId:
          type: integer
          format: int64
        geolocation:
          $ref: '#/components/schemas/Geolocation'
        contactStaff:
          type: array
          items:
            $ref: '#/components/schemas/User'
      discriminator:
        propertyName: class
    ContactNoteType:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        colour:
          type: string
        defaultReadOnly:
          type: boolean
        purpose:
          $ref: '#/components/schemas/ContactNoteTypePurpose'
    AddPropertyFeedback:
      type: object
      properties:
        note:
          $ref: '#/components/schemas/AddContactNote'
        contact:
          $ref: '#/components/schemas/ID'
        feedbackDate:
          type: string
          format: date-time
        priceOpinion:
          type: number
          format: float
    PropertyNoteTypePurpose:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    AddContactNote:
      type: object
      properties:
        body:
          type: string
        readOnly:
          type: boolean
        type:
          $ref: '#/components/schemas/ID'
        reminder:
          $ref: '#/components/schemas/AddContactNoteReminder'
        inserted:
          type: string
          format: date-time
    ContactNoteReminder:
      type: object
      properties:
        date:
          type: string
          format: date-time
        user:
          $ref: '#/components/schemas/User'
    User:
      type: object
      properties:
        id:
          type: integer
          format: int64
        firstName:
          type: string
        lastName:
          type: string
        username:
          type: string
        email:
          type: string
          format: email
        adminAccess:
          type: boolean
        position:
          type: string
        role:
          type: string
          enum:
          - commercialSalesAndLeasing
          - residentialSales
          - propertyManagement
        photo:
          $ref: '#/components/schemas/UserPhoto'
        lastLogin:
          type: string
          format: date-time
        phoneNumbers:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumber'
        profile:
          type: string
        permissions:
          type: object
          properties:
            settings:
              type: boolean
            canLogin:
              type: boolean
            deleteContacts:
              type: boolean
            globalActionListsReadWrite:
              type: boolean
            globalContactsReadWrite:
              type: boolean
            globalNotesRead:
              type: boolean
            globalNotesReadWrite:
              type: boolean
            globalPropertiesRead:
              type: boolean
            globalPropertiesReadWrite:
              type: boolean
            globalTasksReadWrite:
              type: boolean
            sendSMS:
              type: boolean
    ContactNote:
      type: object
      properties:
        id:
          type: integer
          format: int64
        inserted:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
        body:
          type: string
        readOnly:
          type: boolean
        insertedBy:
          $ref: '#/components/schemas/User'
        type:
          $ref: '#/components/schemas/ContactNoteType'
        reminder:
          $ref: '#/components/schemas/ContactNoteReminder'
    UpdatePropertyNote:
      type: object
      properties:
        body:
          type: string
        readOnly:
          type: boolean
        type:
          $ref: '#/components/schemas/ID'
    PhoneNumber:
      type: object
      properties:
        number:
          type: string
        typeCode:
          type: string
          enum:
          - H
          - W
          - M
          - F
          - D
        type:
          type: string
          enum:
          - Home
          - Work
          - Mobile
          - Facsimile
          - Direct
    PropertyPhoto:
      type: object
      properties:
        id:
          type: integer
          format: int64
        inserted:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
        filesize:
          type: integer
          format: int64
        width:
          type: integer
          format: int64
        height:
          type: integer
          format: int64
        caption:
          type: string
        type:
          type: string
          enum:
          - Photograph
          - Floorplan
        url:
          type: string
        filename:
          type: string
        userFilename:
          type: string
        thumbnails:
          $ref: '#/components/schemas/PropertyPhotoThumbnails'
        published:
          type: boolean
    PropertyFile:
      type: object
      properties:
        id:
          type: integer
          format: int64
        inserted:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
        filename:
          type: string
        filesize:
          type: integer
          format: int64
        contentType:
          type: string
        url:
          type: string
    PropertyNoteType:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        colour:
          type: string
        purpose:
          $ref: '#/components/schemas/PropertyNoteTypePurpose'
    PropertyClass:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    Address_2:
      type: object
      properties:
        level:
          type: string
        unitNumber:
          type: string
        streetNumber:
          type: string
        street:
          type: string
        suburb:
          $ref: '#/components/schemas/Suburb'
        state:
          $ref: '#/components/schemas/State'
        country:
          $ref: '#/components/schemas/Country'
    PropertyFeedback:
      type: object
      properties:
        id:
          type: integer
          format: int64
        note:
          $ref: '#/components/schemas/ContactNote'
        contact:
          $ref: '#/components/schemas/Contact'
        feedbackDate:
          type: string
          format: date-time
        priceOpinion:
          type: number
          format: float
    Suburb:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        postcode:
          type: string
        state:
          $ref: '#/components/schemas/State'
    AddUpdateOpenHome:
      type: object
      properties:
        start:
          type: string
          format: date-time
        end:
          type: string
          format: date-time
        user:
          $ref: '#/components/schemas/ID'
    Contact:
      type: object
      properties:
        id:
          type: integer
          format: int64
        title:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        greeting:
          type: string
        displayName:
          type: string
        partnerTitle:
          type: string
        partnerFirstName:
          type: string
        partnerLastName:
          type: string
        company:
          type: string
        position:
          type: string
        address:
          $ref: '#/components/schemas/Address_2'
        postalAddress:
          $ref: '#/components/schemas/Address_2'
        onDoNotCallList:
          type: boolean
        inserted:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
        touched:
          type: string
          format: date-time
        remoteId:
          type: string
        unsubscribe:
          $ref: '#/components/schemas/Unsubscribe'
        emails:
          type: array
          items:
            type: string
            format: email
        phoneNumbers:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumber'
        legalDescription:
          type: string
    AddPropertyNote:
      type: object
      properties:
        body:
          type: string
        readOnly:
          type: boolean
        type:
          $ref: '#/components/schemas/ID'
        inserted:
          type: string
          format: date-time
    Unsubscribe:
      type: object
      properties:
        email:
          type: boolean
        sms:
          type: boolean
        letters:
          type: boolean
    PropertyExtended:
      allOf:
      - $ref: '#/components/schemas/Property'
      - type: object
        properties:
          accessBy:
            type: array
            items:
              $ref: '#/components/schemas/Access'
          leaseHistory:
            type: array
            items:
              $ref: '#/components/schemas/LeaseHistory'
          saleHistory:
            type: array
            items:
              $ref: '#/components/schemas/SaleHistory'
    PropertyType:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        country:
          $ref: '#/components/schemas/Country'
        propertyClass:
          $ref: '#/components/schemas/PropertyClass'
    UserPhoto:
      type: object
      properties:
        original:
          type: string
        thumb_360:
          type: string
    SuccessOrError_2:
      type: object
      properties:
        success:
          type: boolean
        msg:
          type: string
        code:
          type: string
    PropertyPhotoThumbnails:
      type: object
      properties:
        thumb_180:
          type: string
        thumb_1024:
          type: string
    Building:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    Access:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        photo:
          $ref: '#/components/schemas/UserPhoto'
    AddContactNoteReminder:
      type: object
      properties:
        date:
          type: string
          format: date-time
        user:
          $ref: '#/components/schemas/ID'
    UpdateMaintenance:
      type: object
      properties:
        summary:
          type: string
        description:
          type: string
        requestedBy:
          $ref: '#/components/schemas/ID'
        notifications:
          type: array
          items:
            $ref: '#/components/schemas/ID'
    PropertyFileFolder:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        display:
          type: string
          enum:
          - sale
          - lease
          - saleAndLease
    EntityType:
      type: object
      properties:
        id:
          type: number
          format: int64
        name:
          type: string
    UpdatePropertyLifeInterest:
      type: object
      properties:
        interest:
          type: object
          properties:
            id:
              type: integer
              format: int64
    UpdatePropertyOfferCondition:
      type: object
      properties:
        condition:
          $ref: '#/components/schemas/ID'
        user:
          $ref: '#/components/schemas/ID'
        due:
          type: string
          format: date-time
        completed:
          type: boolean
    Tenancy:
      type: object
      properties:
        id:
          type: integer
          format: int64
        inserted:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
        rent:
          type: number
          format: float
        rentFrequency:
          $ref: '#/components/schemas/RentFrequency'
        archived:
          type: boolean
        letAgreed:
          type: boolean
        start:
          type: string
          format: date-time
        end:
          type: string
          format: date-time
        rentPaidUntil:
          type: string
          format: date-time
        arrearsAmount:
          type: number
          format: float
    PropertyFeedback_2:
      type: object
      properties:
        id:
          type: integer
          format: int64
        property:
          type: object
          properties:
            id:
              type: number
              format: int64
            displayAddress:
              type: string
            saleLifeId:
              type: number
              format: int64
            leaseLifeId:
              type: number
              format: int64
            class:
              $ref: '#/components/schemas/PropertyClass_2'
        feedbackDate:
          type: string
          format: date-time
        priceOpinion:
          type: number
          format: float
        saleLifeId:
          type: number
          format: int64
        leaseLifeId:
          type: number
          format: int64
        contractRequested:
          type: boolean
        contractSent:
          type: string
          format: date-time
    ContactExtended:
      allOf:
      - $ref: '#/components/schemas/Contact_2'
      - type: object
        properties:
          accessBy:
            type: array
            items:
              $ref: '#/components/schemas/Access'
          sourceOfEnquiry:
            $ref: '#/components/schemas/EnquirySource'
    RentFrequency:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    FlushProperty:
      type: object
      properties:
        saleLifeId:
          type: number
          format: int64
        leaseLifeId:
          type: number
          format: int64
        propertyReference:
          type: string
        portals:
          type: array
          items:
            type: string
    AddContactNoteWithFeedback:
      allOf:
      - $ref: '#/components/schemas/AddContactNote_2'
      - type: object
        properties:
          propertyFeedback:
            $ref: '#/components/schemas/AddUpdatePropertyFeedback'
    PropertyLifeInterest:
      type: object
      properties:
        contact:
          $ref: '#/components/schemas/ContactMinimal'
        interest:
          $ref: '#/components/schemas/ContactInterest'
    UpdateContactNoteWithFeedback:
      allOf:
      - $ref: '#/components/schemas/UpdateContactNote_2'
      - type: object
        properties:
          propertyFeedback:
            $ref: '#/components/schemas/AddUpdatePropertyFeedback'
    AddMaintenanceRequest:
      type: object
      properties:
        supplier:
          $ref: '#/components/schemas/ID'
        subject:
          type: string
        bodyHTML:
          type: string
        isWorkOrder:
          type: boolean
        sender:
          $ref: '#/components/schemas/ID'
    InsertScheduledViewing:
      type: object
      properties:
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/ID'
        accessBy:
          type: array
          items:
            $ref: '#/components/schemas/Access'
        insertedBy:
          $ref: '#/components/schemas/Access'
        start:
          type: string
          format: date-time
        end:
          type: string
          format: date-time
    SaleHistory_2:
      type: object
      properties:
        lifeId:
          type: number
          format: int64
        appraisal:
          type: string
          format: date-time
        appraisalPriceLower:
          type: number
          format: float
        appraisalPriceUpper:
          type: number
          format: float
        listingAuthority:
          type: string
          format: date-time
        conditional:
          type: string
          format: date-time
        unconditional:
          type: string
          format: date-time
        settlement:
          type: string
          format: date-time
        status:
          type: string
          enum:
          - prospect
          - appraisal
          - listing
          - conditional
          - unconditional
          - settled
          - withdrawn
          - withdrawnAppraisal
        salePrice:
          type: number
          format: float
        showSalePrice:
          type: boolean
        grossCommissionExcGST:
          type: number
          format: float
    Property_2:
      type: object
      properties:
        id:
          type: integer
          format: int64
        building:
          $ref: '#/components/schemas/Building'
        class:
          $ref: '#/components/schemas/PropertyClass_2'
        type:
          $ref: '#/components/schemas/PropertyType_2'
        address:
          $ref: '#/components/schemas/Address_3'
        displayAddress:
          type: string
        addressVisibility:
          type: string
          enum:
          - streetAndSuburb
          - suburb
          - fullAddress
        referenceID:
          type: string
        keyID:
          type: string
        photos:
          type: array
          items:
            $ref: '#/components/schemas/PropertyPhoto'
        searchPrice:
          type: number
          format: float
        displayPrice:
          type: string
        heading:
          type: string
        description:
          type: string
        brochureDescription:
          type: string
        landArea:
          $ref: '#/components/schemas/Area'
        frontage:
          type: number
          format: float
        volumeNumber:
          type: string
        folioNumber:
          type: string
        corelogicId:
          type: integer
          format: int64
        yearBuilt:
          type: integer
          format: int64
        inserted:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
        saleLifeId:
          type: integer
          format: int64
        leaseLifeId:
          type: integer
          format: int64
        geolocation:
          $ref: '#/components/schemas/Geolocation'
        lotNumber:
          type: string
        certificateOfTitle:
          type: string
        legalDescription:
          type: string
        rpdp:
          type: string
      discriminator:
        propertyName: class
    AddPropertyFeedback_2:
      type: object
      properties:
        contact:
          $ref: '#/components/schemas/ID'
        note:
          $ref: '#/components/schemas/AddContactNoteWithFeedback'
    AddUpdatePropertyFeedback:
      type: object
      properties:
        priceOpinion:
          type: number
          format: float
        feedbackDate:
          type: string
          format: date-time
        contractRequested:
          type: boolean
        contractSent:
          type: string
          format: date-time
    AddContactNote_2:
      type: object
      properties:
        body:
          type: string
        readOnly:
          type: boolean
        type:
          $ref: '#/components/schemas/ID'
        reminder:
          $ref: '#/components/schemas/AddContactNoteReminder'
        inserted:
          type: string
          format: date-time
        accessBy:
          type: array
          items:
            $ref: '#/components/schemas/ID'
    ContactNote_2:
      type: object
      properties:
        id:
          type: integer
          format: int64
        inserted:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
        body:
          type: string
        readOnly:
          type: boolean
        contact:
          $ref: '#/components/schemas/ID'
        insertedBy:
          $ref: '#/components/schemas/User_2'
        type:
          $ref: '#/components/schemas/ContactNoteType_2'
        reminder:
          $ref: '#/components/schemas/ContactNoteReminder'
        propertyFeedback:
          $ref: '#/components/schemas/PropertyFeedback_2'
    PropertyFileWithFoldersUpload:
      type: object
      properties:
        filename:
          type: string
        filesize:
          type: integer
          format: int64
        contentType:
          type: string
        folders:
          type: array
          items:
            $ref: '#/components/schemas/ID'
    PropertyOfferCondition:
      type: object
      properties:
        id:
          type: number
          format: int64
        condition:
          $ref: '#/components/schemas/OfferCondition'
        user:
          $ref: '#/components/schemas/User_2'
        due:
          type: string
          format: date-time
        completed:
          type: boolean
    Contact_2:
      type: object
      properties:
        id:
          type: integer
          format: int64
        title:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        greeting:
          type: string
        displayName:
          type: string
        partnerTitle:
          type: string
        partnerFirstName:
          type: string
        partnerLastName:
          type: string
        company:
          type: string
        position:
          type: string
        address:
          $ref: '#/components/schemas/Address_3'
        postalAddress:
          $ref: '#/components/schemas/Address_3'
        onDoNotCallList:
          type: boolean
        archived:
          type: boolean
        inserted:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
        touched:
          type: string
          format: date-time
        remoteId:
          type: string
        unsubscribe:
          $ref: '#/components/schemas/Unsubscribe'
        entityType:
          $ref: '#/components/schemas/EntityType'
        emails:
          type: array
          items:
            type: string
            format: email
        phoneNumbers:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumber_2'
        legalDescription:
          type: string
        marketingUsers:
          type: array
          items:
            $ref: '#/components/schemas/MarketingUser'
    MarketingUser:
      type: object
      properties:
        id:
          type: integer
          format: int64
        user:
          $ref: '#/components/schemas/Access'
    ContactNoteExtended:
      allOf:
      - $ref: '#/components/schemas/ContactNote_2'
      - type: object
        properties:
          accessBy:
            type: array
            items:
              $ref: '#/components/schemas/Access'
    PropertyType_2:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        propertyClass:
          $ref: '#/components/schemas/PropertyClass_2'
    AddInspection:
      type: object
      properties:
        inserted:
          type: string
          format: date-time
        start:
          type: string
          format: date-time
        end:
          type: string
          format: date-time
        status:
          type: string
          enum:
          - proposed
          - scheduled
          - confirmed
        type:
          type: string
          enum:
          - routine
          - ingoing
          - outgoing
        insertedBy:
          $ref: '#/components/schemas/#definitions/ID'
    PropertyLifeEnquirySource:
      type: object
      properties:
        contact:
          $ref: '#/components/schemas/ContactMinimal'
        source:
          $ref: '#/components/schemas/EnquirySource'
    SuccessOrError_3:
      type: object
      properties:
        success:
          type: boolean
        msg:
          type: string
        code:
          type: string
    Maintenance:
      type: object
      properties:
        id:
          type: integer
          format: int64
        summary:
          type: string
        description:
          type: string
        status:
          type: string
          enum:
          - open
          - requested
          - sent
          - completed
        inserted:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
        insertedBy:
          $ref: '#/components/schemas/Access'
        requestedBy:
          $ref: '#/components/schemas/ContactMinimal'
        tenancy:
          $ref: '#/components/schemas/Tenancy'
        leaseLifeId:
          type: integer
          format: int64
        photos:
          type: array
          items:
            $ref: '#/components/schemas/MaintenancePhoto'
        notifications:
          type: array
          items:
            $ref: '#/components/schemas/Access'
    ContactInterest:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    UpdateContactNote_2:
      type: object
      properties:
        body:
          type: string
        readOnly:
          type: boolean
        type:
          $ref: '#/components/schemas/ID'
        reminder:
          $ref: '#/components/schemas/AddContactNoteReminder'
        accessBy:
          type: array
          items:
            $ref: '#/components/schemas/ID'
    ContactMinimal:
      type: object
      properties:
        id:
          type: integer
          format: int64
        displayName:
          type: string
        inserted:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
        emails:
          type: array
          items:
            type: string
            format: email
        phoneNumbers:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumber_2'
    ContactNoteType_2:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        colour:
          type: string
        defaultReadOnly:
          type: boolean
        pinned:
          type: boolean
        purpose:
          $ref: '#/components/schemas/ContactNoteTypePurpose'
    PhoneNumber_2:
      type: object
      properties:
        number:
          type: string
        typeCode:
          type: string
          enum:
          - H
          - W
          - M
          - F
          - D
        type:
          type: string
          enum:
          - Home
          - Work
          - Mobile
          - Facsimile
          - Direct
        comment:
          type: string
    AddMaintenance:
      type: object
      properties:
        summary:
          type: string
        description:
          type: string
        inserted:
          type: string
          format: date-time
        requestedBy:
          $ref: '#/components/schemas/ID'
        notifications:
          type: array
          items:
            $ref: '#/components/schemas/ID'
        tenancy:
          $ref: '#/components/schemas/ID'
    PropertyFileWithFolders:
      allOf:
      - $ref: '#/components/schemas/PropertyFile'
      - type: object
        properties:
          folders:
            type: array
            items:
              $ref: '#/components/schemas/PropertyFileFolder'
    Address_3:
      type: object
      properties:
        level:
          type: string
        unitNumber:
          type: string
        streetNumber:
          type: string
        street:
          type: string
        suburb:
          $ref: '#/components/schemas/Suburb'
        state:
          $ref: '#/components/schemas/State'
        country:
          $ref: '#/components/schemas/Country'
    UpdateInspection:
      type: object
      properties:
        start:
          type: string
          format: date-time
        end:
          type: string
          format: date-time
        status:
          type: string
          enum:
          - proposed
          - scheduled
          - confirmed
        type:
          type: string
          enum:
          - routine
          - ingoing
          - outgoing
    UpdatePropertyLifeEnquirySource:
      type: object
      properties:
        source:
          type: object
          properties:
            id:
              type: integer
              format: int64
    PropertyPhotoUpload:
      type: object
      properties:
        filesize:
          type: integer
          format: int64
        width:
          type: integer
          format: int64
        height:
          type: integer
          format: int64
        caption:
          type: string
        type:
          type: string
          enum:
          - Photograph
          - Floorplan
        contentType:
          type: string
          enum:
          - image/jpeg
          - image/jpg
          - image/png
          - image/gif
        userFilename:
          type: string
        published:
          type: boolean
    ContactNoteAndContactExtended:
      type: object
      properties:
        note:
          $ref: '#/components/schemas/ContactNoteExtended'
        contact:
          $ref: '#/components/schemas/ContactExtended'
    LeaseHistory_2:
      type: object
      properties:
        lifeId:
          type: number
          format: int64
        appraisal:
          type: string
          format: date-time
        appraisalPriceLower:
          type: number
          format: float
        appraisalPriceUpper:
          type: number
          format: float
        status:
          type: string
          enum:
          - prospect
          - appraisal
          - listing
          - conditional
          - unconditional
          - settled
          - management
          - withdrawn
          - withdrawnAppraisal
    UpdatePropertyFeedback_2:
      type: object
      properties:
        note:
          $ref: '#/components/schemas/UpdateContactNoteWithFeedback'
    FileToBeUploaded:
      type: object
      properties:
        id:
          type: integer
          format: int64
        upload_url:
          type: string
    EnquirySource:
      type: object
      properties:
        id:
          type: number
          format: int64
        name:
          type: string
    User_2:
      type: object
      properties:
        id:
          type: integer
          format: int64
        firstName:
          type: string
        lastName:
          type: string
        username:
          type: string
        email:
          type: string
          format: email
        adminAccess:
          type: boolean
        position:
          type: string
        role:
          type: string
          enum:
          - commercialSalesAndLeasing
          - residentialSales
          - propertyManagement
        photo:
          $ref: '#/components/schemas/UserPhoto'
        lastLogin:
          type: string
          format: date-time
        phoneNumbers:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumber_2'
        profile:
          type: string
        permissions:
          type: object
          properties:
            settings:
              type: boolean
            accessPropertyManagement:
              type: boolean
            accessSales:
              type: boolean
            canLogin:
              type: boolean
            deleteContacts:
              type: boolean
            globalActionListsReadWrite:
              type: boolean
            globalContactsReadWrite:
              type: boolean
            globalNotesRead:
              type: boolean
            globalNotesReadWrite:
              type: boolean
            globalPropertiesRead:
              type: boolean
            globalPropertiesReadWrite:
              type: boolean
            globalTasksReadWrite:
              type: boolean
            sendSMS:
              type: boolean
        websiteUrl:
          type: string
    PropertyClass_2:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        internalName:
          type: string
    MaintenancePhoto:
      type: object
      properties:
        id:
          type: integer
          format: int64
        url:
          type: string
        description:
          type: string
        userFileName:
          type: string
    Inspection:
      type: object
      properties:
        id:
          type: integer
          format: int64
        insertedBy:
          $ref: '#/components/schemas/#definitions/Access'
        inserted:
          type: string
          format: date-time
        start:
          type: string
          format: date-time
        end:
          type: string
          format: date-time
        status:
          type: string
          enum:
          - proposed
          - scheduled
          - confirmed
        type:
          type: string
          enum:
          - routine
          - ingoing
          - outgoing
        timeOfDay:
          type: string
          enum:
          - morning
          - afternoon
        tenancy:
          $ref: '#/components/schemas/#definitions/ID'
    MaintenanceRequest:
      type: object
      properties:
        id:
          type: integer
          format: int64
        inserted:
          type: string
          format: date-time
        supplier:
          $ref: '#/components/schemas/ContactMinimal'
        status:
          type: string
          enum:
          - requested
          - viewed
          - notInterested
          - received
        jobId:
          type: integer
          format: int64
        quote:
          $ref: '#/components/schemas/PropertyFile'
        invoice:
          $ref: '#/components/schemas/PropertyFile'
        isWorkOrder:
          type: boolean
    OfferCondition:
      type: object
      properties:
        id:
          type: number
          format: int64
        name:
          type: string
    CalendarEvent:
      type: object
      properties:
        id:
          type: integer
          format: int64
        modified:
          type: string
          format: date-time
        recurring:
          type: boolean
        allDay:
          type: boolean
        start:
          type: string
          format: date-time
        end:
          type: string
          format: date-time
        summary:
          type: string
        description:
          type: string
        reminderMinutes:
          type: integer
          format: int64
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/CalendarContact'
        user:
          $ref: '#/components/schemas/Access_2'
        isConfirmed:
          type: boolean
        isCancelled:
          type: boolean
    Portal:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    AddPropertyActivityNote:
      type: object
      properties:
        note:
          type: string
        leaseLifeId:
          type: integer
          format: int64
        saleLifeId:
          type: integer
          format: int64
    Urls:
      type: object
      properties:
        previous:
          type: string
        next:
          type: string
        self:
          type: string
    OfficeReferral:
      allOf:
      - $ref: '#/components/schemas/OfficeDeduction'
      type: object
      properties:
        paidBy:
          type: string
          enum:
          - listers
          - sellers
          - totalShare
    PropertyAlarmDetails:
      type: object
      properties:
        alarmCode:
          type: string
        details:
          type: string
        modified:
          type: string
          format: date-time
    CommercialProperty:
      allOf:
      - $ref: '#/components/schemas/Property_3'
      - type: object
        properties:
          zoning:
            type: string
          carSpaces:
            type: integer
            format: int64
          floorArea:
            $ref: '#/components/schemas/Area'
          mezzanineArea:
            $ref: '#/components/schemas/Area'
          warehouseArea:
            $ref: '#/components/schemas/Area'
          retailArea:
            $ref: '#/components/schemas/Area'
          officeArea:
            $ref: '#/components/schemas/Area'
          otherArea:
            $ref: '#/components/schemas/Area'
          status:
            type: string
            enum:
            - prospect
            - appraisal
            - listing
            - conditional
            - unconditional
            - settled
            - management
            - withdrawn
            - withdrawnAppraisal
          portalStatus:
            type: string
            enum:
            - prospect
            - appraisal
            - listing
            - conditional
            - unconditional
            - settled
            - management
            - withdrawn
            - withdrawnAppraisal
          contactStaff:
            type: array
            items:
              $ref: '#/components/schemas/ID'
          eTableUrl:
            type: string
          commercialListingType:
            type: string
            enum:
            - sale
            - lease
            - both
          externalLinks:
            type: array
            items:
              $ref: '#/components/schemas/ExternalLink'
          energyRating:
            type: number
            format: float
          commercialLeasePrice:
            type: number
            format: float
          outgoingsPerAnnum:
            type: number
            format: float
          outgoingsText:
            type: string
          includesOutgoings:
            type: boolean
          commercialLeasePriceIncludesGst:
            type: boolean
          isNewHome:
            type: boolean
    PropertyRoom:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        description:
          type: string
        length:
          type: number
          format: float
        width:
          type: number
          format: float
        units:
          type: string
          enum:
          - feet
          - metres
        dimensionClarification:
          type: string
    Tenancy_2:
      type: object
      properties:
        id:
          type: integer
          format: int64
        inserted:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
        rent:
          type: number
          format: float
        rentFrequency:
          $ref: '#/components/schemas/RentFrequency'
        archived:
          type: boolean
        letAgreed:
          type: boolean
        start:
          type: string
          format: date-time
        end:
          type: string
          format: date-time
        rentPaidUntil:
          type: string
          format: date-time
        arrearsAmount:
          type: number
          format: float
        vacateDate:
          type: string
          format: date-time
    PropertyFile_2:
      type: object
      properties:
        id:
          type: integer
          format: int64
        inserted:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
        filename:
          type: string
        filesize:
          type: integer
          format: int64
        contentType:
          type: string
        url:
          type: string
        electronicTable:
          type: boolean
        isPublic:
          type: boolean
    PropertyFeedback_3:
      type: object
      properties:
        id:
          type: integer
          format: int64
        property:
          type: object
          properties:
            id:
              type: number
              format: int64
            displayAddress:
              type: string
            saleLifeId:
              type: number
              format: int64
            leaseLifeId:
              type: number
              format: int64
            class:
              $ref: '#/components/schemas/PropertyClass_3'
        feedbackDate:
          type: string
          format: date-time
        priceOpinion:
          type: number
          format: float
        saleLifeId:
          type: number
          format: int64
        leaseLifeId:
          type: number
          format: int64
        contractRequested:
          type: boolean
        contractSent:
          type: string
          format: date-time
    ContactExtended_2:
      allOf:
      - $ref: '#/components/schemas/Contact_3'
      - type: object
        properties:
          accessBy:
            type: array
            items:
              $ref: '#/components/schemas/Access_2'
          sourceOfEnquiry:
            $ref: '#/components/schemas/EnquirySource'
    Category:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    AccountBranch:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        shortName:
          type: string
        websiteUrl:
          type: string
        address:
          $ref: '#/components/schemas/Address_4'
    AddContactNoteWithFeedback_2:
      allOf:
      - $ref: '#/components/schemas/AddContactNote_3'
      - type: object
        properties:
          propertyFeedback:
            $ref: '#/components/schemas/AddUpdatePropertyFeedback'
    PropertyPhotoBulkDeleteResult:
      type: object
      required:
      - id
      - success
      - message
      properties:
        id:
          type: integer
          format: int64
          description: Photo ID
        success:
          type: boolean
          description: Whether this photo was successfully deleted
        message:
          type: string
          description: Result message for this photo
        filename:
          type:
          - string
          - 'null'
          description: Filename of the photo (if available)
    AddUpdatePropertyKey:
      type: object
      properties:
        id:
          type: number
          format: int64
        name:
          type: string
        isKeyOut:
          type: boolean
        details:
          type: string
        hexColour:
          type: string
        keyOutUser:
          $ref: '#/components/schemas/ID'
        keyOutContact:
          $ref: '#/components/schemas/ID'
    PropertyPhotoBulkDeleteResponse:
      type: object
      required:
      - message
      - deleted_count
      - failed_count
      - results
      properties:
        message:
          type: string
          description: Overall operation message
          example: BULK_DELETE_SUCCESS
        deleted_count:
          type: integer
          format: int64
          description: Number of photos successfully deleted
          example: 2
        failed_count:
          type: integer
          format: int64
          description: Number of photos that failed to delete
          example: 0
        results:
          type: array
          items:
            $ref: '#/components/schemas/PropertyPhotoBulkDeleteResult'
          description: Detailed results for each photo deletion attempt
    MaintenanceNote:
      type: object
      properties:
        id:
          type: integer
          format: int64
        note:
          type: string
        inserted:
          type: string
          format: date-time
        insertedBy:
          $ref: '#/components/schemas/Access_2'
    UpdateContactNoteWithFeedback_2:
      allOf:
      - $ref: '#/components/schemas/UpdateContactNote_3'
      - type: object
        properties:
          propertyFeedback:
            $ref: '#/components/schemas/AddUpdatePropertyFeedback'
    CalendarContact:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    UpdateExternalFeedback:
      type: object
      properties:
        comments:
          type: string
        feedbackDate:
          type: string
          format: date
        priceOpinion:
          type: number
          format: float
        userId:
          type: integer
          format: int64
        source:
          type: object
          description: Source of enquiry (optional). Use GET /account/enquirySources to retrieve available options.
          properties:
            id:
              type: integer
              format: int64
    PreDistributionDeduction:
      type: object
      properties:
        amount:
          type: number
          format: float
        type:
          $ref: '#/components/schemas/FeesCharges'
    SaleHistory_3:
      type: object
      properties:
        lifeId:
          type: number
          format: int64
        isReleasedSale:
          type: boolean
        isAdminComplete:
          type: boolean
        isUnitTitle:
          type: boolean
        contractNumber:
          type: string
        appraisal:
          type: string
          format: date-time
        appraisalPriceLower:
          type: number
          format: float
        appraisalPriceUpper:
          type: number
          format: float
        listingAuthority:
          type: string
          format: date-time
        publishedToWeb:
          type: string
          format: date-time
        conditional:
          type: string
          format: date-time
        unconditional:
          type: string
          format: date-time
        settlement:
          type: string
          format: date-time
        releaseDate:
          type: string
          format: date-time
        adminCompletionDate:
          type: string
          format: date-time
        status:
          type: string
          enum:
          - prospect
          - appraisal
          - listing
          - conditional
          - unconditional
          - settled
          - withdrawn
          - withdrawnAppraisal
        portalStatus:
          type: string
          enum:
          - prospect
          - appraisal
          - listing
          - conditional
          - unconditional
          - settled
          - management
          - withdrawn
          - withdrawnAppraisal
        salePrice:
          type: number
          format: float
        showSalePrice:
          type: boolean
        grossCommissionExcGST:
          type: number
          format: float
        grossCommissionLessDeductionsExcGST:
          type: number
          format: float
        netIncomeIntoOfficeExcGST:
          type: number
          format: float
        netIncomeLessOfficeDeductionsExcGST:
          type: number
          format: float
        webId:
          type: string
        isNewHome:
          type: boolean
        inserted:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
        contactStaff:
          type: array
          items:
            $ref: '#/components/schemas/Access_2'
        commissionSplits:
          type: array
          items:
            $ref: '#/components/schemas/CommissionSplit_2'
        deductions:
          type: array
          items:
            $ref: '#/components/schemas/PreDistributionDeduction'
        officeReferrals:
          type: array
          items:
            $ref: '#/components/schemas/OfficeReferral'
        officeDeductions:
          type: array
          items:
            $ref: '#/components/schemas/OfficeDeduction'
        soldType:
          $ref: '#/components/schemas/SoldType'
        sharedOwnership:
          $ref: '#/components/schemas/SharedOwnership'
        isOurListing:
          type: boolean
        internalMarketingLiveDate:
          type: string
          format: date-time
        mortgageeSale:
          type: boolean
        asIsSale:
          type: boolean
        sellingFeePercent:
          type: number
          format: float
        sellingFeeFixed:
          type: number
          format: float
        vpa:
          type: number
          format: float
        annualReturnPercent:
          type: number
          format: float
        listingAuthorityFile:
          $ref: '#/components/schemas/PropertyFile_2'
        salePricePercentSplit:
          type: number
          format: float
    OpenHome_2:
      type: object
      properties:
        id:
          type: number
          format: int64
        start:
          type: string
          format: date-time
        end:
          type: string
          format: date-time
        user:
          $ref: '#/components/schemas/User_3'
        isRental:
          type: boolean
        extraAgents:
          type: array
          items:
            $ref: '#/components/schemas/Access_2'
    AddUpdateMarketingUser:
      type: object
      properties:
        id:
          type: integer
          format: int64
        user:
          $ref: '#/components/schemas/ID'
    Region:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    ContactSearchResult:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        greeting:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        emails:
          type: array
          items:
            type: string
            format: email
        phoneNumbers:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumber_3'
        marketingUsers:
          type: array
          items:
            $ref: '#/components/schemas/MarketingUser'
        editableBy:
          type: array
          items:
            $ref: '#/components/schemas/Access_2'
    Property_3:
      type: object
      properties:
        id:
          type: integer
          format: int64
        building:
          $ref: '#/components/schemas/Building'
        class:
          $ref: '#/components/schemas/PropertyClass_3'
        type:
          $ref: '#/components/schemas/PropertyType_3'
        address:
          $ref: '#/components/schemas/Address_4'
        displayAddress:
          type: string
        addressVisibility:
          type: string
          enum:
          - streetAndSuburb
          - suburb
          - fullAddress
        referenceID:
          type: string
        photos:
          type: array
          items:
            $ref: '#/components/schemas/PropertyPhoto'
        searchPrice:
          type: number
          format: float
        displayPrice:
          type: string
        heading:
          type: string
        description:
          type: string
        brochureDescription:
          type: string
        windowCardDescription:
          type: string
        landArea:
          $ref: '#/components/schemas/Area'
        frontage:
          type: number
          format: float
        volumeNumber:
          type: string
        folioNumber:
          type: string
        corelogicId:
          type: integer
          format: int64
        yearBuilt:
          type: integer
          format: int64
        inserted:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
        saleLifeId:
          type: integer
          format: int64
        leaseLifeId:
          type: integer
          format: int64
        geolocation:
          $ref: '#/components/schemas/Geolocation'
        lotNumber:
          type: string
        certificateOfTitle:
          type: string
        legalDescription:
          type: string
        rpdp:
          type: string
        commercialListingType:
          type: string
          enum:
          - sale
          - lease
          - both
        councilTaxBand:
          type: string
        isStrataBuilding:
          type: boolean
        isProjectBuilding:
          type: boolean
        epcRating:
          type: string
        zoning:
          type: string
        account:
          type: object
          properties:
            id:
              type: integer
              format: int64
            name:
              type: string
      discriminator:
        propertyName: class
    AddPropertyFeedback_3:
      type: object
      properties:
        contact:
          $ref: '#/components/schemas/ID'
        note:
          $ref: '#/components/schemas/AddContactNoteWithFeedback_2'
    UnsubscribeType:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    PropertyListingConfiguration:
      type: object
      properties:
        id:
          type: integer
          format: int64
        description:
          type: string
        heading:
          type: string
        displayAddress:
          type: string
        floorArea:
          $ref: '#/components/schemas/Area'
        ratePerSQM:
          type: number
          format: float
        tenanted:
          type: boolean
        type:
          $ref: '#/components/schemas/PropertyType_3'
        status:
          type: string
        address:
          $ref: '#/components/schemas/Address_4'
    AddContactNote_3:
      type: object
      properties:
        body:
          type: string
        readOnly:
          type: boolean
        type:
          $ref: '#/components/schemas/ID'
        reminder:
          $ref: '#/components/schemas/AddContactNoteReminder'
        inserted:
          type: string
          format: date-time
        accessBy:
          type: array
          items:
            $ref: '#/components/schemas/ID'
        insertedBy:
          $ref: '#/components/schemas/ID'
    CommissionSplitDeduction:
      type: object
      properties:
        amount:
          type: number
          format: float
        type:
          $ref: '#/components/schemas/FeesCharges'
    ContactNote_3:
      type: object
      properties:
        id:
          type: integer
          format: int64
        inserted:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
        body:
          type: string
        readOnly:
          type: boolean
        contact:
          $ref: '#/components/schemas/ID'
        insertedBy:
          $ref: '#/components/schemas/User_3'
        type:
          $ref: '#/components/schemas/ContactNoteType_3'
        reminder:
          $ref: '#/components/schemas/ContactNoteReminder'
        propertyFeedback:
          $ref: '#/components/schemas/PropertyFeedback_3'
    UpdateContact:
      type: object
      properties:
        title:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        greeting:
          type: string
        partnerTitle:
          type: string
        partnerFirstName:
          type: string
        partnerLastName:
          type: string
        company:
          type: string
        position:
          type: string
        address:
          $ref: '#/components/schemas/UpdateAddress'
        postalAddress:
          $ref: '#/components/schemas/UpdateAddress'
        onDoNotCallList:
          type: boolean
        archived:
          type: boolean
        unsubscribe:
          $ref: '#/components/schemas/Unsubscribe'
        emails:
          type: array
          items:
            type: string
            format: email
        phoneNumbers:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumber_3'
        legalDescription:
          type: string
        abn:
          type: string
          description: Australian Business Number (ABN). For New Zealand customers, this field represents the GST registration number.
        acn:
          type: string
          description: Australian Company Number (ACN).
        accessBy:
          type: array
          items:
            $ref: '#/components/schemas/ID'
        editableBy:
          type: array
          items:
            $ref: '#/components/schemas/ID'
        sourceOfEnquiry:
          $ref: '#/components/schemas/ID'
        marketingUsers:
          type: array
          items:
            $ref: '#/components/schemas/AddUpdateMarketingUser'
        customUnsubscribe:
          type: array
          items:
            $ref: '#/components/schemas/ID'
    CustomAddress:
      type: object
      properties:
        address1:
          type: string
        address2:
          type: string
        postTown:
          type: string
        postcode:
          type: string
    PropertyLife:
      allOf:
      - $ref: '#/components/schemas/ResidentialProperty'
      - $ref: '#/components/schemas/CommercialProperty'
    PropertyOfferCondition_2:
      type: object
      properties:
        id:
          type: number
          format: int64
        condition:
          $ref: '#/components/schemas/OfferCondition'
        user:
          $ref: '#/components/schemas/User_3'
        due:
          type: string
          format: date-time
        completed:
          type: boolean
    RoyalMail:
      type: object
      properties:
        buildingName:
          type: string
        buildingNumber:
          type: string
        department:
          type: string
        locality:
          type: string
        locality2:
          type: string
        organisation:
          type: string
        postTown:
          type: string
        postcode:
          type: string
        subbuildingName:
          type: string
        subbuildingNumber:
          type: string
        thoroughfare:
          type: string
        thoroughfare2:
          type: string
        udprn:
          type: integer
          format: int64
    ResidentialProperty:
      allOf:
      - $ref: '#/components/schemas/Property_3'
      - type: object
        properties:
          bed:
            type: integer
            format: int64
          bath:
            type: integer
            format: int64
          garages:
            type: integer
            format: int64
          carports:
            type: integer
            format: int64
          openSpaces:
            type: integer
            format: int64
          ensuites:
            type: integer
            format: int64
          toilets:
            type: integer
            format: int64
          receptionRooms:
            type: integer
            format: int64
          floorArea:
            $ref: '#/components/schemas/Area'
          status:
            type: string
            enum:
            - prospect
            - appraisal
            - listing
            - conditional
            - unconditional
            - settled
            - management
            - withdrawn
            - withdrawnAppraisal
          portalStatus:
            type: string
            enum:
            - prospect
            - appraisal
            - listing
            - conditional
            - unconditional
            - settled
            - management
            - withdrawn
            - withdrawnAppraisal
          contactStaff:
            type: array
            items:
              $ref: '#/components/schemas/User_3'
          eTableUrl:
            type: string
          externalLinks:
            type: array
            items:
              $ref: '#/components/schemas/ExternalLink'
          energyRating:
            type: number
            format: float
          isNewHome:
            type: boolean
          isHouseLandPackage:
            type: boolean
    Contact_3:
      type: object
      properties:
        id:
          type: integer
          format: int64
        title:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        greeting:
          type: string
        displayName:
          type: string
        partnerTitle:
          type: string
        partnerFirstName:
          type: string
        partnerLastName:
          type: string
        company:
          type: string
        position:
          type: string
        address:
          $ref: '#/components/schemas/Address_4'
        postalAddress:
          $ref: '#/components/schemas/Address_4'
        onDoNotCallList:
          type: boolean
        archived:
          type: boolean
        inserted:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
        touched:
          type: string
          format: date-time
        remoteId:
          type: string
        unsubscribe:
          $ref: '#/components/schemas/Unsubscribe'
        entityType:
          $ref: '#/components/schemas/EntityType'
        emails:
          type: array
          items:
            type: string
            format: email
        phoneNumbers:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumber_3'
        legalDescription:
          type: string
        abn:
          type: string
          description: Australian Business Number (ABN). For New Zealand customers, this field represents the GST registration number.
        acn:
          type: string
          description: Australian Company Number (ACN).
        marketingUsers:
          type: array
          items:
            $ref: '#/components/schemas/MarketingUser'
        smsUnsubscribeUrl:
          type: string
        customUnsubscribe:
          type: array
          items:
            $ref: '#/components/schemas/UnsubscribeType'
    ContactNoteExtended_2:
      allOf:
      - $ref: '#/components/schemas/ContactNote_3'
      - type: object
        properties:
          accessBy:
            type: array
            items:
              $ref: '#/components/schemas/Access_2'
    PropertyType_3:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        propertyClass:
          $ref: '#/components/schemas/PropertyClass_3'
    AddInspection_2:
      type: object
      properties:
        inserted:
          type: string
          format: date-time
        start:
          type: string
          format: date-time
        end:
          type: string
          format: date-time
        status:
          type: string
          enum:
          - proposed
          - scheduled
          - confirmed
        type:
          type: string
          enum:
          - routine
          - ingoing
          - outgoing
        insertedBy:
          $ref: '#/components/schemas/ID'
    OpenHomeWithProperty:
      allOf:
      - $ref: '#/components/schemas/OpenHome_2'
      - type: object
        properties:
          property:
            type: object
            properties:
              id:
                type: number
                format: int64
              displayAddress:
                type: string
              saleLifeId:
                type: number
                format: int64
              leaseLifeId:
                type: number
                format: int64
              class:
                $ref: '#/components/schemas/PropertyClass_3'
    TrustLedgerTransaction:
      type: object
      properties:
        id:
          type: integer
          format: int64
        saleLifeId:
          type: integer
          format: int64
        transactionType:
          $ref: '#/components/schemas/TrustLedgerTransactionType'
        trustAccount:
          $ref: '#/components/schemas/ID'
        receiptNumber:
          type:
          - string
          - 'null'
        category:
          $ref: '#/components/schemas/TrustLedgerCategory'
        transactionDate:
          type: string
          format: date
        depositReleaseDate:
          type: string
          format: date
        inserted:
          type: string
          format: date-time
        amount:
          type: number
          format: float
        internalNote:
          type: string
        internalRefId:
          type: string
        contact:
          $ref: '#/components/schemas/ID'
        receivedFromText:
          type:
          - string
          - 'null'
    OfficeDeduction:
      type: object
      properties:
        amount:
          type: number
          format: float
        type:
          $ref: '#/components/schemas/FeesCharges'
    SuccessOrError_4:
      type: object
      properties:
        success:
          type: boolean
        msg:
          type: string
        code:
          type: string
    Furnished:
      type: object
      properties:
        id:
          type: integer
          format: int64
        type:
          type: string
          enum:
          - Unfurnished
          - Furnished
          - Part Furnished
          - Optional
    PhotoTag:
      type: object
      properties:
        confidence:
          type: number
          format: float
        name:
          type: string
    UpdateContactNote_3:
      type: object
      properties:
        body:
          type: string
        readOnly:
          type: boolean
        type:
          $ref: '#/components/schemas/ID'
        reminder:
          $ref: '#/components/schemas/AddContactNoteReminder'
        accessBy:
          type: array
          items:
            $ref: '#/components/schemas/ID'
    CommissionSplit_2:
      type: object
      properties:
        id:
          type: number
          format: int64
        user:
          $ref: '#/components/schemas/Access_2'
        type:
          $ref: '#/components/schemas/CommissionSplitType'
        conjunctingAgent:
          $ref: '#/components/schemas/ContactMinimal_2'
        grossPercent:
          type: number
          format: float
        grossAmount:
          type: number
          format: float
        grossAmountLessDeductions:
          type: number
          format: float
        netPercent:
          type: number
          format: float
        netAmount:
          type: number
          format: float
        details:
          type: string
        branch:
          $ref: '#/components/schemas/AccountBranch'
        deductions:
          type: array
          items:
            $ref: '#/components/schemas/CommissionSplitDeduction'
    ContactMinimal_2:
      type: object
      properties:
        id:
          type: integer
          format: int64
        displayName:
          type: string
        inserted:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
        emails:
          type: array
          items:
            type: string
            format: email
        phoneNumbers:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumber_3'
    ContactNoteType_3:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        colour:
          type: string
        defaultReadOnly:
          type: boolean
        pinned:
          type: boolean
        purpose:
          $ref: '#/components/schemas/ContactNoteTypePurpose'
    AddContact:
      allOf:
      - $ref: '#/components/schemas/UpdateContact'
      - type: object
        properties:
          inserted:
            type: string
            format: date-time
          entityType:
            $ref: '#/components/schemas/ID'
    PhoneNumber_3:
      type: object
      properties:
        number:
          type: string
        typeCode:
          type: string
          enum:
          - H
          - W
          - M
          - F
          - D
        type:
          type: string
          enum:
          - Home
          - Work
          - Mobile
          - Facsimile
          - Direct
        comment:
          type: string
    AddUpdateCustomField:
      type: object
      properties:
        id:
          type: integer
          format: int64
        data:
          type: string
    TrustLedgerTransactionType:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    PropertyFileWithFolders_2:
      allOf:
      - $ref: '#/components/schemas/PropertyFile_2'
      - type: object
        properties:
          tenancyId:
            type: integer
            format: int64
          folders:
            type: array
            items:
              $ref: '#/components/schemas/PropertyFileFolder'
    FullSaleHistory:
      allOf:
      - $ref: '#/components/schemas/SaleHistory_3'
    Address_4:
      type: object
      properties:
        level:
          type: string
        unitNumber:
          type: string
        streetNumber:
          type: string
        street:
          type: string
        suburb:
          $ref: '#/components/schemas/Suburb_2'
        state:
          $ref: '#/components/schemas/State'
        country:
          $ref: '#/components/schemas/Country'
        royalMail:
          $ref: '#/components/schemas/RoyalMail'
        customAddress:
          $ref: '#/components/schemas/CustomAddress'
    ServiceChargeFrequency:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    Suburb_2:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        postcode:
          type: string
        state:
          $ref: '#/components/schemas/State'
        nzDistrict:
          $ref: '#/components/schemas/District'
        isPoBox:
          type: boolean
    ContactNoteAndContact:
      type: object
      properties:
        note:
          $ref: '#/components/schemas/ContactNote_3'
        contact:
          $ref: '#/components/schemas/Contact_3'
    PropertyPortalId:
      type: object
      properties:
        portalId:
          type: string
        officePortal:
          $ref: '#/components/schemas/PortalAccess'
    HazardsAndRisks:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    ExternalLink:
      type: object
      properties:
        id:
          type: number
          format: int64
        url:
          type: string
        modified:
          type: string
          format: date-time
        type:
          $ref: '#/components/schemas/ExternalLinkType'
    UpdatePropertyFeature:
      type: object
      properties:
        name:
          type: string
        data:
          type: string
    Access_2:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        photo:
          $ref: '#/components/schemas/UserPhoto'
        account:
          type: object
          properties:
            id:
              type: integer
              format: int64
            name:
              type: string
    PropertyPhotoBulkDeleteRequest:
      type: object
      required:
      - items
      properties:
        items:
          type: array
          items:
            type: integer
            format: int64
          minItems: 1
          maxItems: 50
          description: Array of photo IDs to delete (1-50 photos)
          example:
          - 151522513
          - 151522512
    LeaseHistory_3:
      type: object
      properties:
        lifeId:
          type: number
          format: int64
        appraisal:
          type: string
          format: date-time
        appraisalPriceLower:
          type: number
          format: float
        appraisalPriceUpper:
          type: number
          format: float
        status:
          type: string
          enum:
          - prospect
          - appraisal
          - listing
          - conditional
          - unconditional
          - settled
          - management
          - withdrawn
          - withdrawnAppraisal
        portalStatus:
          type: string
          enum:
          - prospect
          - appraisal
          - listing
          - conditional
          - unconditional
          - settled
          - management
          - withdrawn
          - withdrawnAppraisal
        inserted:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
        contactStaff:
          type: array
          items:
            $ref: '#/components/schemas/Access_2'
        tenancyHistory:
          type: array
          items:
            $ref: '#/components/schemas/Tenancy_2'
        isNewHome:
          type: boolean
        webId:
          type: string
        furnished:
          $ref: '#/components/schemas/Furnished'
        internalMarketingLiveDate:
          type: string
          format: date-time
    PropertyProjectProperty:
      allOf:
      - $ref: '#/components/schemas/PropertyListingConfiguration'
    InsertExternalFeedback:
      type: object
      properties:
        contactId:
          type: integer
          format: int64
          description: ID of an existing contact (mutually exclusive with contact object)
        contact:
          $ref: '#/components/schemas/AddContact'
        comments:
          type: string
        feedbackDate:
          type: string
          format: date
        priceOpinion:
          type: number
          format: float
        userId:
          type: integer
          format: int64
        source:
          type: object
          description: Source of enquiry (optional). Use GET /account/enquirySources to retrieve available options.
          properties:
            id:
              type: integer
              format: int64
      oneOf:
      - required:
        - contactId
      - required:
        - contact
    UpdatePropertyFeedback_3:
      type: object
      properties:
        note:
          $ref: '#/components/schemas/UpdateContactNoteWithFeedback_2'
    SharedOwnership:
      type: object
      properties:
        percentage:
          type: number
          format: float
        rent:
          type: number
          format: float
        rentFrequency:
          $ref: '#/components/schemas/ServiceChargeFrequency'
    PropertyStrataProperty:
      allOf:
      - $ref: '#/components/schemas/PropertyListingConfiguration'
    CommissionSplitType:
      type: object
      properties:
        id:
          type: number
          format: int64
        name:
          type: string
    CustomField:
      type: object
      properties:
        dataType:
          type: string
          enum:
          - selectBox
          - text
          - string
          - float
          - boolean
          - date
          - dayAndMonth
        id:
          type: integer
          format: int64
        name:
          type: string
        data:
          type: string
    PropertyPhotoOrderRequest:
      type: object
      required:
      - photoIds
      properties:
        photoIds:
          type: array
          items:
            type: integer
            format: int64
          minItems: 1
          description: Array of photo IDs in the desired order
          example:
          - 151522513
          - 151522512
          - 151522514
    SoldType:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    PropertyFeature:
      type: object
      properties:
        name:
          type: string
        displayName:
          type: string
        dataType:
          type: string
          enum:
          - selectBox
          - text
          - string
          - float
          - integer
          - boolean
          - date
          - dayAndMonth
        data:
          type: string
    CustomFieldGrouping:
      type: object
      properties:
        fields:
          type: array
          items:
            $ref: '#/components/schemas/CustomField'
        group:
          type: string
    PropertyKey:
      type: object
      properties:
        id:
          type: number
          format: int64
        propertyId:
          type: number
          format: int64
        name:
          type: string
        isKeyOut:
          type: boolean
        details:
          type: string
        hexColour:
          type: string
        inserted:
          type: string
          format: date-time
        modified:
          type: string
          format: date-time
        keyOutUser:
          $ref: '#/components/schemas/Access_2'
        keyOutContact:
          $ref: '#/components/schemas/ContactSearchResult'
    User_3:
      type: object
      properties:
        id:
          type: integer
          format: int64
        firstName:
          type: string
        lastName:
          type: string
        username:
          type: string
        email:
          type: string
          format: email
        adminAccess:
          type: boolean
        position:
          type: string
        role:
          type: string
          enum:
          - commercialSalesAndLeasing
          - residentialSales
          - propertyManagement
        photo:
          $ref: '#/components/schemas/UserPhoto'
        lastLogin:
          type: string
          format: date-time
        phoneNumbers:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumber_3'
        profile:
          type: string
        permissions:
          type: object
          properties:
            settings:
              type: boolean
            accessPropertyManagement:
              type: boolean
            accessSales:
              type: boolean
            canLogin:
              type: boolean
            deleteContacts:
              type: boolean
            deleteProperties:
              type: boolean
            globalActionListsReadWrite:
              type: boolean
            globalContactsReadWrite:
              type: boolean
            globalNotesRead:
              type: boolean
            globalNotesReadWrite:
              type: boolean
            globalPropertiesRead:
              type: boolean
            globalPropertiesReadWrite:
              type: boolean
            globalTasksReadWrite:
              type: boolean
            sendSMS:
              type: boolean
            accessPropertyFinancials:
              type: boolean
            accessAlarmDetails:
              type: boolean
            modifyWebsiteContent:
              type: boolean
            editMarketingContact:
              type: boolean
        websiteUrl:
          type: string
        showOnWeb:
          type: boolean
        externalReference:
          type: string
        ssoIdentifier:
          type: string
        signature:
          type: string
        account:
          type: object
          properties:
            id:
              type: integer
              format: int64
            name:
              type: string
        hideMobileFromPortal:
          type: boolean
    ExternalFeedback:
      type: object
      properties:
        id:
          type: integer
          format: int64
        comments:
          type: string
        contactiId:
          type: integer
          format: int64
        feedbackDate:
          type: string
          format: date
        insertAccountId:
          type: integer
          format: int64
        insertUserId:
          type: integer
          format: int64
        inserted:
          type: string
          format: date-time
        isDeleted:
          type: boolean
        leaseLifeId:
          type: integer
          format: int64
        modified:
          type: string
          format: date-time
        priceOpinion:
          type: number
          format: float
        propertyId:
          type: integer
          format: int64
        saleLifeId:
          type: integer
          format: int64
        userId:
          type: integer
          format: int64
        source:
          type: object
          description: Source of enquiry for this feedback
          properties:
            id:
              type: integer
              format: int64
            name:
              type: string
    UpdatePropertyFeatureGrouping:
      type: object
      properties:
        groupName:
          type: string
        features:
          type: array
          items:
            $ref: '#/components/schemas/UpdatePropertyFeature'
    PortalAccess:
      type: object
      properties:
        id:
          type: integer
          format: int64
        code:
          type: string
        description:
          type: string
        portal:
          $ref: '#/components/schemas/Portal'
    PropertyPhotoOrderResponse:
      type: object
      properties:
        message:
          type: string
          example: PHOTO_ORDER_UPDATED
          description: Success message indicating the photo order was updated
        totalPhotos:
          type: integer
          format: int64
          example: 3
          description: Total number of photos for the property
        photos:
          type: array
          items:
            $ref: '#/components/schemas/PropertyPhoto'
          description: Array of photos in their new order
    PropertyClass_3:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        internalName:
          type: string
    District:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        region:
          $ref: '#/components/schemas/Region'
    AddUpdateOpenHome_2:
      type: object
      properties:
        start:
          type: string
          format: date-time
        end:
          type: string
          format: date-time
        user:
          $ref: '#/components/schemas/ID'
        extraAgents:
          type: array
          items:
            $ref: '#/components/schemas/ID'
    UpdateAddress:
      type: object
      properties:
        level:
          type: string
        unitNumber:
          type: string
        streetNumber:
          type: string
        street:
          type: string
        suburb:
          $ref: '#/components/schemas/ID'
    PropertyExtended_2:
      allOf:
      - $ref: '#/components/schemas/Property_3'
      - type: object
        properties:
          accessBy:
            type: array
            items:
              $ref: '#/components/schemas/Access_2'
          editableBy:
            type: array
            items:
              $ref: '#/components/schemas/Access_2'
          keys:
            type: array
            items:
              $ref: '#/components/schemas/PropertyKey'
          leaseHistory:
            type: array
            items:
              $ref: '#/components/schemas/LeaseHistory_3'
          saleHistory:
            type: array
            items:
              $ref: '#/components/schemas/SaleHistory_3'
          saleLife:
            type: object
            properties:
              id:
                type: integer
                format: int64
              status:
                type: string
          leaseLife:
            type: object
            properties:
              id:
                type: integer
                format: int64
              status:
                type: string
    FeesCharges:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    TrustLedgerCategory:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    Inspection_2:
      type: object
      properties:
        id:
          type: integer
          format: int64
        insertedBy:
          $ref: '#/components/schemas/Access_2'
        inserted:
          type: string
          format: date-time
        start:
          type: string
          format: date-time
        end:
          type: string
          format: date-time
        status:
          type: string
          enum:
          - proposed
          - scheduled
          - confirmed
        type:
          type: string
          enum:
          - routine
          - ingoing
          - outgoing
        timeOfDay:
          type: string
          enum:
          - morning
          - afternoon
        tenancy:
          $ref: '#/components/schemas/ID'
    PropertyFeatureGrouping:
      type: object
      properties:
        groupName:
          type: string
        groupDisplayName:
          type: string
        features:
          type: array
          items:
            $ref: '#/components/schemas/PropertyFeature'
    ExternalLinkType:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
  parameters:
    page:
      name: page
      in: query
      description: Page number of results
      schema:
        type: integer
        format: int64
    pagesize:
      name: pagesize
      in: query
      description: Number of records to be returned in each page.
      schema:
        type: integer
        format: int64
        default: 50
    sortOrder:
      name: sortOrder
      in: query
      description: Order by which to sort the results. Used in conjunction with sort parameter.
      schema:
        type: string
        enum:
        - asc
        - desc
    modifiedSince:
      name: modifiedSince
      in: query
      description: Filter results modified since this datetime
      schema:
        type: string
        format: date-time
    modifiedBefore:
      name: modifiedBefore
      in: query
      description: Filter results modified before this datetime
      schema:
        type: string
        format: date-time
    priceReducedSince:
      name: priceReducedSince
      in: query
      description: Filter results by price reductions since this datetime
      schema:
        type: string
        format: date-time
    branches:
      name: branches
      in: query
      description: Filter properties in these account branch IDs
      style: form
      explode: false
      schema:
        type: array
        items:
          type: integer
          format: int64
    priceReducedBefore:
      name: priceReducedBefore
      in: query
      description: Filter results by price reductions before this datetime
      schema:
        type: string
        format: date-time
    suburbs:
      name: suburbs
      in: query
      description: Filter properties in these suburb IDs
      style: form
      explode: false
      schema:
        type: array
        items:
          type: integer
          format: int64
    types:
      name: types
      in: query
      description: Filter properties in these type IDs
      style: form
      explode: false
      schema:
        type: array
        items:
          type: integer
          format: int64
    published:
      name: published
      in: query
      description: Filter properties published to at least one web portal
      schema:
        type: boolean
    fallenBefore:
      name: fallenBefore
      in: query
      description: Filter results with fallen date before this date
      schema:
        type: string
        format: date
    accessBy:
      name: accessBy
      in: query
      description: Filter properties by these user IDs. NOTE - Use the ID "-1" to filter properties which are accessible by Everyone.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: integer
          format: int64
    withdrawnBefore:
      name: withdrawnBefore
      in: query
      description: Filter results with withdrawn date before this date
      schema:
        type: string
        format: date
    withdrawnSince:
      name: withdrawnSince
      in: query
      description: Filter results with withdrawn date since this date
      schema:
        type: string
        format: date
    precincts:
      name: precincts
      in: query
      description: Filter properties belonging to at least one of these precincts IDs
      style: form
      explode: false
      schema:
        type: array
        items:
          type: integer
          format: int64
    customRegions:
      name: customRegions
      in: query
      description: Filter properties belonging to at least one of these custom regions IDs
      style: form
      explode: false
      schema:
        type: array
        items:
          type: integer
          format: int64
    publishedOnPortals:
      name: publishedOnPortals
      in: query
      description: Filter properties published to at least one of these office portal IDs
      style: form
      explode: false
      schema:
        type: array
        items:
          type: integer
          format: int64
    fallenSince:
      name: fallenSince
      in: query
      description: Filter results with fallen date since this date
      schema:
        type: string
        format: date
    types_2:
      name: types
      in: query
      description: Filter properties with these property type IDs
      style: form
      explode: false
      schema:
        type: array
        items:
          type: integer
          format: int64
  securitySchemes:
    ApiKey:
      type: apiKey
      name: X-Api-Key
      in: header
      description: This value is provided to you by VaultRE and identifies you as a CRM
    Bearer:
      type: http
      scheme: bearer
      description: This value is a JWT token signed with the HS512 algorithm using your X-Api-Key value as the secret.
    Api-Key:
      type: apiKey
      name: X-Api-Key
      in: header
x-refined-from:
- vaultre-aggregator-api-v1-0-openapi.yml
- vaultre-api-v1-1-openapi.yml
- vaultre-api-v1-2-openapi.yml
- vaultre-api-v1-3-openapi.yml