Propertyware · Schema

Vendor

Property ManagementReal EstateRental PropertiesSingle-Family RentalsLeasesTenantsMaintenanceWork OrdersFinancial TransactionsOwner Reports

Properties

Name	Type	Description
accountNumber	string	Account number.
active	boolean	Indicates if the vendor is active.
address	string	Address.
address2	string	Address line 2.
alertEmail	string	Alert Email
city	string	City.
comments	string	Comments.
companyName	string	Name of the vendor's company.
country	string	Country.
createdBy	string	User who created the record.
createdDateTime	string	Date and time the record was created. (Timezone: UTC)
creditLimit	number	Credit limit.
customFields	array	Custom fields.
defaultBillSplitAccountId	integer	Default bill split id
defaultMarkupDiscountPercentage	number	Default markup discount
description	string	Description.
eligible1099	boolean	Indicates if the vendor is eligible for a 1099 form.
email	string	Email address.
fax	string	Fax number.
id	integer	Unique identifier.
includeCompanyNameOn1099	boolean	Include company name on 1099
lastModifiedBy	string	User who last modified the record.
lastModifiedDateTime	string	Date and time the record was last modified. (Timezone: UTC)
markupAccountId	integer	Markup account id
name	string	Name.
nameOnCheck	string	Name to be used on checks.
otherPhone	string	Other phone number.
paymentTermDaysToPay	integer	The number of days within payments are due.
paymentTerms	string	Payment terms.
phone	string	Phone number.
searchTag	string	Search Tag
state	string	State.
syncToVMM	boolean	Vendor Sync To Maintenance.
taxId	string	Tax identification number.
taxPayerName	string	Tax Payer Name
timeTracking	string	Time Tracking, is enabled or disabled
type	string	The type of vendor.
website	string	Website URL.
zip	string	ZIP or postal code.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Vendor",
  "description": "Vendor",
  "type": "object",
  "properties": {
    "accountNumber": {
      "type": "string",
      "description": "Account number."
    },
    "active": {
      "type": "boolean",
      "example": false,
      "description": "Indicates if the vendor is active."
    },
    "address": {
      "type": "string",
      "description": "Address."
    },
    "address2": {
      "type": "string",
      "description": "Address line 2."
    },
    "alertEmail": {
      "type": "string",
      "description": "Alert Email"
    },
    "city": {
      "type": "string",
      "description": "City."
    },
    "comments": {
      "type": "string",
      "description": "Comments."
    },
    "companyName": {
      "type": "string",
      "description": "Name of the vendor's company."
    },
    "country": {
      "type": "string",
      "description": "Country."
    },
    "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)"
    },
    "creditLimit": {
      "type": "number",
      "format": "double",
      "description": "Credit limit."
    },
    "customFields": {
      "type": "array",
      "description": "Custom fields.",
      "items": {
        "$ref": "#/components/schemas/CustomField"
      }
    },
    "defaultBillSplitAccountId": {
      "type": "integer",
      "format": "int64",
      "description": "Default bill split id"
    },
    "defaultMarkupDiscountPercentage": {
      "type": "number",
      "format": "double",
      "description": "Default markup discount"
    },
    "description": {
      "type": "string",
      "description": "Description."
    },
    "eligible1099": {
      "type": "boolean",
      "example": false,
      "description": "Indicates if the vendor is eligible for a 1099 form."
    },
    "email": {
      "type": "string",
      "description": "Email address."
    },
    "fax": {
      "type": "string",
      "description": "Fax number."
    },
    "id": {
      "type": "integer",
      "format": "int64",
      "description": "Unique identifier."
    },
    "includeCompanyNameOn1099": {
      "type": "boolean",
      "example": false,
      "description": "Include company name on 1099"
    },
    "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)"
    },
    "markupAccountId": {
      "type": "integer",
      "format": "int64",
      "description": "Markup account id"
    },
    "name": {
      "type": "string",
      "description": "Name."
    },
    "nameOnCheck": {
      "type": "string",
      "description": "Name to be used on checks."
    },
    "otherPhone": {
      "type": "string",
      "description": "Other phone number."
    },
    "paymentTermDaysToPay": {
      "type": "integer",
      "format": "int32",
      "description": "The number of days within payments are due."
    },
    "paymentTerms": {
      "type": "string",
      "description": "Payment terms."
    },
    "phone": {
      "type": "string",
      "description": "Phone number."
    },
    "searchTag": {
      "type": "string",
      "description": "Search Tag"
    },
    "state": {
      "type": "string",
      "description": "State."
    },
    "syncToVMM": {
      "type": "boolean",
      "example": false,
      "description": "Vendor Sync To Maintenance."
    },
    "taxId": {
      "type": "string",
      "description": "Tax identification number."
    },
    "taxPayerName": {
      "type": "string",
      "description": "Tax Payer Name"
    },
    "timeTracking": {
      "type": "string",
      "description": "Time Tracking, is enabled or disabled"
    },
    "type": {
      "type": "string",
      "description": "The type of vendor."
    },
    "website": {
      "type": "string",
      "description": "Website URL."
    },
    "zip": {
      "type": "string",
      "description": "ZIP or postal code."
    }
  }
}