Propertyware · Schema

Document

JSON Schema for Document

Property ManagementReal EstateRental PropertiesSingle-Family RentalsLeasesTenantsMaintenanceWork OrdersFinancial TransactionsOwner Reports

Properties

Name Type Description
createdBy string User who created the record.
createdDateTime string Date and time the record was created. (Timezone: UTC)
description string Description of a document.
entityId integer Unique identifier of an entity document is attached to.
entityType string Type of an entity document is attached to.
fileName string File name.
fileType string File type.
id integer Unique identifier.
lastModifiedBy string User who last modified the record.
lastModifiedDateTime string Date and time the record was last modified. (Timezone: UTC)
publishToOwnerPortal boolean Indicates if the document is published to the owner portal.
publishToTenantPortal boolean Indicates if the document is published to the tenant portal.
View JSON Schema on GitHub

JSON Schema

document.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Document",
  "description": "JSON Schema for Document",
  "type": "object",
  "properties": {
    "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)"
    },
    "description": {
      "type": "string",
      "description": "Description of a document."
    },
    "entityId": {
      "type": "integer",
      "format": "int64",
      "description": "Unique identifier of an entity document is attached to."
    },
    "entityType": {
      "type": "string",
      "description": "Type of an entity document is attached to.",
      "enum": [
        "APPOINTMENT",
        "ASSET",
        "BILL",
        "BANK_DEPOSIT",
        "BILL_PAYMENT",
        "BUILDING",
        "CONTACT",
        "FLOOR_PLAN",
        "DESKTOP",
        "EMAIL_TEMPLATE",
        "INSPECTION",
        "LEASE",
        "OTHER",
        "PORTFOLIO",
        "PROSPECT",
        "RECONCILIATION",
        "TASK",
        "TRANSACTION",
        "UNIT",
        "VENDOR",
        "WORK_ORDER"
      ]
    },
    "fileName": {
      "type": "string",
      "description": "File name."
    },
    "fileType": {
      "type": "string",
      "description": "File type."
    },
    "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)"
    },
    "publishToOwnerPortal": {
      "type": "boolean",
      "example": false,
      "description": "Indicates if the document is published to the owner portal."
    },
    "publishToTenantPortal": {
      "type": "boolean",
      "example": false,
      "description": "Indicates if the document is published to the tenant portal."
    }
  }
}