Propertyware · Schema

WorkOrder

Work Order

Property ManagementReal EstateRental PropertiesSingle-Family RentalsLeasesTenantsMaintenanceWork OrdersFinancial TransactionsOwner Reports

Properties

Name Type Description
age integer Number of days that have passed since the work order was created.
approved boolean Indicates if work order is approved.
approvedDate string Work order approved Date.
assignedVendors array List of vendors attached to the work order.
authorizeEnter string Indicates if the tenant has granted your management staff access to enter his or her buildings and/or units.
buildingID integer Id of the building associated with this work order.
category string This classifies the work order into a category.
completedDate string Date on which the work was completed.
contractNumber string Contract number.
costEstimate number This indicates the estimated cost as entered by a person, the actual cost as determined by the work order bills, and the invoiced amount is the amount the owner will see on his or her statement based
createdBy string User who created the record.
createdDateTime string Date and time the record was created. (Timezone: UTC)
customFields array Custom fields.
dateToEnter string Authorized date to enter unit.
description string This is a detailed description of the problem.
hourEstimate number Expected number of hours to complete the work order.
id integer Unique identifier.
lastModifiedBy string User who last modified the record.
lastModifiedDateTime string Date and time the record was last modified. (Timezone: UTC)
lease string If the work order is attached to an occupied building or unit, this is the lease name of that lease.
location string Buildings and/or units associated with this work order.
maintenanceNotice string Maintenance notice defined for the building that the work order is attached to.
managedBy string Name of the person who is responsible for managing the work order.
number integer Number assigned to this work order.
portfolioID integer Id of the portfolio associated with this work order.
priority string This identifies the priority of the work order as low, medium, or high.
publishToOwnerPortal boolean Publish To Owner Portal.
publishToTenantPortal boolean Publish To Tenant Portal.
requestedBy string This identifies the person that reported the problem, typically the tenant or owner associated with the buildings or units.
requiredMaterials string List of materials required to complete the work order.
scheduledEndDate string Date on which the work is scheduled to be completed.
searchTag string Search tag name.
source string This identifies how the problem was reported, such as telephone, in person, email, etc.
specificLocation string This describes the location in the buildings or units where the work is needed.
startDate string Date on which the work was started.
status string Current status of the work order.
type string This classifies the work order into one of the following types: general, service request, turnover, inspection, estimate etc.
unitID integer Id of the unit associated with this work order.
unitIDs object
View JSON Schema on GitHub

JSON Schema

work-order.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WorkOrder",
  "description": "Work Order",
  "type": "object",
  "properties": {
    "age": {
      "type": "integer",
      "format": "int64",
      "description": "Number of days that have passed since the work order was created."
    },
    "approved": {
      "type": "boolean",
      "example": false,
      "description": "Indicates if work order is approved."
    },
    "approvedDate": {
      "type": "string",
      "format": "date",
      "description": "Work order approved Date."
    },
    "assignedVendors": {
      "type": "array",
      "description": "List of vendors attached to the work order.",
      "items": {
        "$ref": "#/components/schemas/BasicVendor"
      }
    },
    "authorizeEnter": {
      "type": "string",
      "description": "Indicates if the tenant has granted your management staff access to enter his or her buildings and/or units.",
      "enum": [
        "NO",
        "ANYTIME",
        "SPECIFIEDTIME"
      ]
    },
    "buildingID": {
      "type": "integer",
      "format": "int64",
      "description": "Id of the building associated with this work order."
    },
    "category": {
      "type": "string",
      "description": "This classifies the work order into a category."
    },
    "completedDate": {
      "type": "string",
      "format": "date",
      "description": "Date on which the work was completed."
    },
    "contractNumber": {
      "type": "string",
      "description": "Contract number."
    },
    "costEstimate": {
      "type": "number",
      "format": "double",
      "description": "This indicates the estimated cost as entered by a person, the actual cost as determined by the work order bills, and the invoiced amount is the amount the owner will see on his or her statement based on the bill and markup/discount amount."
    },
    "createdBy": {
      "type": "string",
      "description": "User who created the record."
    },
    "createdDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time the record was created. (Timezone: UTC)"
    },
    "customFields": {
      "type": "array",
      "description": "Custom fields.",
      "items": {
        "$ref": "#/components/schemas/CustomField"
      }
    },
    "dateToEnter": {
      "type": "string",
      "format": "date-time",
      "description": "Authorized date to enter unit."
    },
    "description": {
      "type": "string",
      "description": "This is a detailed description of the problem."
    },
    "hourEstimate": {
      "type": "number",
      "format": "double",
      "description": "Expected number of hours to complete the work order."
    },
    "id": {
      "type": "integer",
      "format": "int64",
      "description": "Unique identifier."
    },
    "lastModifiedBy": {
      "type": "string",
      "description": "User who last modified the record."
    },
    "lastModifiedDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time the record was last modified. (Timezone: UTC)"
    },
    "lease": {
      "type": "string",
      "description": "If the work order is attached to an occupied building or unit, this is the lease name of that lease."
    },
    "location": {
      "type": "string",
      "description": "Buildings and/or units associated with this work order."
    },
    "maintenanceNotice": {
      "type": "string",
      "description": "Maintenance notice defined for the building that the work order is attached to."
    },
    "managedBy": {
      "type": "string",
      "description": "Name of the person who is responsible for managing the work order."
    },
    "number": {
      "type": "integer",
      "format": "int32",
      "description": "Number assigned to this work order."
    },
    "portfolioID": {
      "type": "integer",
      "format": "int64",
      "description": "Id of the portfolio associated with this work order."
    },
    "priority": {
      "type": "string",
      "description": "This identifies the priority of the work order as low, medium, or high.",
      "enum": [
        "HIGH",
        "MEDIUM",
        "LOW"
      ]
    },
    "publishToOwnerPortal": {
      "type": "boolean",
      "example": false,
      "description": "Publish To Owner Portal."
    },
    "publishToTenantPortal": {
      "type": "boolean",
      "example": false,
      "description": "Publish To Tenant Portal."
    },
    "requestedBy": {
      "type": "string",
      "description": "This identifies the person that reported the problem, typically the tenant or owner associated with the buildings or units."
    },
    "requiredMaterials": {
      "type": "string",
      "description": "List of materials required to complete the work order."
    },
    "scheduledEndDate": {
      "type": "string",
      "format": "date",
      "description": "Date on which the work is scheduled to be completed."
    },
    "searchTag": {
      "type": "string",
      "description": "Search tag name."
    },
    "source": {
      "type": "string",
      "description": "This identifies how the problem was reported, such as telephone, in person, email, etc."
    },
    "specificLocation": {
      "type": "string",
      "description": "This describes the location in the buildings or units where the work is needed."
    },
    "startDate": {
      "type": "string",
      "format": "date",
      "description": "Date on which the work was started."
    },
    "status": {
      "type": "string",
      "description": "Current status of the work order."
    },
    "type": {
      "type": "string",
      "description": "This classifies the work order into one of the following types: general, service request, turnover, inspection, estimate etc."
    },
    "unitID": {
      "type": "integer",
      "format": "int64",
      "description": "Id of the unit associated with this work order."
    },
    "unitIDs": {
      "$ref": "#/components/schemas/Collection_long_"
    }
  }
}