Procurify · Schema

VendorDetail

Spend ManagementProcurementPurchase OrdersAccounts PayableVendor ManagementBudget TrackingProcure-to-PayERP Integration

Properties

Name	Type	Description
id	integer
name	string	Name of the vendor
active	boolean
addressLineOne	string	First line of address
addressLineTwo	string	Second line of address
postalCode	string	Postal or Zip code of the vendor
city	string	City of the vendor
state_province	string	State or Province of the vendor
country	string	Country of the vendor
phoneOne	string	Primary phone no. of the vendor
phoneTwo	string	Secondary phone no. of the vendor
fax	string	Fax no. of the vendor
email	array	Added to address a bug where vendors imported from Quickbooks (or at least that is the only known source) could have an invalid empty string as an email that frontend doesn't process nicely. Should pr
comments	string	Notes about the vendor
contact	string	Contact person of the vendor
url	string	Website of the vendor
external_id	string	External id of the vendor
dateModified	string
currency	integer
payment_term_ref	object
shipping_term_ref	object
payment_method_ref	object
shipping_method_ref	object
payment_methods	array
tax	integer
type	object
default_payment_method	integer
creditcards	array
is_1099_eligible	boolean
overall_score	number
is_auto_email_po_enabled	boolean
po_pdf_labels	string	Placeholder for a KVStore value
email_configurations	object
performance	object
vendor_request	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "VendorDetail",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "description": "Name of the vendor",
      "maxLength": 150
    },
    "active": {
      "type": "boolean"
    },
    "addressLineOne": {
      "type": "string",
      "nullable": true,
      "title": "Address line 1",
      "description": "First line of address",
      "maxLength": 300
    },
    "addressLineTwo": {
      "type": "string",
      "nullable": true,
      "title": "Address line 2",
      "description": "Second line of address",
      "maxLength": 300
    },
    "postalCode": {
      "type": "string",
      "nullable": true,
      "title": "Postal Code",
      "description": "Postal or Zip code of the vendor",
      "maxLength": 20
    },
    "city": {
      "type": "string",
      "nullable": true,
      "description": "City of the vendor",
      "maxLength": 50
    },
    "state_province": {
      "type": "string",
      "nullable": true,
      "title": "State/Province",
      "description": "State or Province of the vendor",
      "maxLength": 40
    },
    "country": {
      "type": "string",
      "nullable": true,
      "description": "Country of the vendor",
      "maxLength": 80
    },
    "phoneOne": {
      "type": "string",
      "nullable": true,
      "description": "Primary phone no. of the vendor",
      "maxLength": 20
    },
    "phoneTwo": {
      "type": "string",
      "nullable": true,
      "description": "Secondary phone no. of the vendor",
      "maxLength": 20
    },
    "fax": {
      "type": "string",
      "nullable": true,
      "description": "Fax no. of the vendor",
      "maxLength": 20
    },
    "email": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Added to address a bug where vendors imported from Quickbooks (or at\nleast that is the only known source) could have an invalid empty\nstring as an email that frontend doesn't process nicely. Should\nprobably be removed at some point in the future.",
      "readOnly": true
    },
    "comments": {
      "type": "string",
      "nullable": true,
      "description": "Notes about the vendor"
    },
    "contact": {
      "type": "string",
      "nullable": true,
      "description": "Contact person of the vendor",
      "maxLength": 50
    },
    "url": {
      "type": "string",
      "nullable": true,
      "description": "Website of the vendor",
      "maxLength": 200
    },
    "external_id": {
      "type": "string",
      "nullable": true,
      "description": "External id of the vendor",
      "maxLength": 100
    },
    "dateModified": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "currency": {
      "type": "integer",
      "nullable": true
    },
    "payment_term_ref": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PaymentTerm"
        }
      ],
      "nullable": true,
      "type": "object"
    },
    "shipping_term_ref": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ShippingTerm"
        }
      ],
      "nullable": true,
      "type": "object"
    },
    "payment_method_ref": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PaymentMethod"
        }
      ],
      "nullable": true,
      "type": "object"
    },
    "shipping_method_ref": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ShippingMethod"
        }
      ],
      "nullable": true,
      "type": "object"
    },
    "payment_methods": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PaymentMethodRead"
      },
      "readOnly": true
    },
    "tax": {
      "type": "integer",
      "nullable": true
    },
    "type": {
      "$ref": "#/components/schemas/VendorTypeEnum"
    },
    "default_payment_method": {
      "type": "integer",
      "nullable": true
    },
    "creditcards": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CreditCard"
      },
      "readOnly": true
    },
    "is_1099_eligible": {
      "type": "boolean",
      "nullable": true,
      "title": "1099 Eligible?"
    },
    "overall_score": {
      "type": "number",
      "format": "double",
      "nullable": true,
      "readOnly": true
    },
    "is_auto_email_po_enabled": {
      "type": "boolean"
    },
    "po_pdf_labels": {
      "type": "string",
      "description": "Placeholder for a KVStore value",
      "maxLength": 200
    },
    "email_configurations": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/EmailConfiguration"
      }
    },
    "performance": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VendorPerformance"
        }
      ],
      "nullable": true,
      "readOnly": true,
      "type": "object"
    },
    "vendor_request": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NestedVendorRequest"
        }
      ],
      "readOnly": true
    }
  },
  "required": [
    "name",
    "type"
  ]
}