ZRM Docs
Domain Model

Vendor

Fields

FieldTypeRequiredDefaultDescription
idstring.uuidYes—Id
createdAtstring.date-timeYes—Created at
updatedAtstring.date-timeYes—Updated at
legalNamestringYes—Legal name
displayNamestringYes—Display name
vendorTypeenum(distributor, manufacturer, subcontractor, consultant)Yes—Vendor type
statusenum(active, inactive, suspended)Yes—Status
paymentTermsenum(net_15, net_30, net_45, net_60, net_90, due_on_receipt, custom)No—Payment terms
supplierCodestringNo—Supplier code
creditLimitstringNo—Credit limit
insuranceCertExpirystring.date-timeNo—Insurance cert expiry
w9OnFilebooleanYes—W9on file
licenseNumberstringNo—License number
licenseExpirystring.date-timeNo—License expiry
productLinesstring[]No—Product lines
defaultLeadTimeDaysintegerNo—Default lead time days
ratingintegerNo—Rating
billingPreferencesobjectNo—Billing preferences
taxProfileobjectNo—Tax profile
ownerUserIdstringNo—ID of the associated owner user
notesSummarystringNo—Notes summary
websiteunknownNo—Website
primaryContactEmailunknownNo—Primary contact email
primaryContactPhoneunknownNo—Primary contact phone
physicalAddressunknownNo—Physical address
mailingAddressunknownNo—Mailing address
billingAddressunknownNo—Billing address
accountNumberunknownNo—Account number
workspaceIdstringYes—ID of the associated workspace
visibilityModeenum(global, workspace_local, shared)Yes—Visibility mode

Create Schema

Fields accepted when creating a new record:

FieldTypeRequiredDefaultDescription
legalNamestringYes—Legal name
displayNamestringYes—Display name
vendorTypeenum(distributor, manufacturer, subcontractor, consultant)Yes—Vendor type
statusenum(active, inactive, suspended)Yes"active"Status
paymentTermsenum(net_15, net_30, net_45, net_60, net_90, due_on_receipt, custom)No—Payment terms
supplierCodestringNo—Supplier code
creditLimitstringNo—Credit limit
insuranceCertExpirystring.date-timeNo—Insurance cert expiry
w9OnFilebooleanYesfalseW9on file
licenseNumberstringNo—License number
licenseExpirystring.date-timeNo—License expiry
productLinesstring[]No—Product lines
defaultLeadTimeDaysintegerNo—Default lead time days
ratingintegerNo—Rating
billingPreferencesobjectNo—Billing preferences
taxProfileobjectNo—Tax profile
ownerUserIdstringNo—ID of the associated owner user
notesSummarystringNo—Notes summary
websiteunknownNo—Website
primaryContactEmailunknownNo—Primary contact email
primaryContactPhoneunknownNo—Primary contact phone
physicalAddressunknownNo—Physical address
mailingAddressunknownNo—Mailing address
billingAddressunknownNo—Billing address
accountNumberunknownNo—Account number
workspaceIdstringNo—ID of the associated workspace
visibilityModeenum(global, workspace_local, shared)Yes"workspace_local"Visibility mode

Update Schema

All fields are optional when updating:

FieldTypeRequiredDefaultDescription
legalNamestringNo—Legal name
displayNamestringNo—Display name
vendorTypeenum(distributor, manufacturer, subcontractor, consultant)No—Vendor type
statusenum(active, inactive, suspended)No"active"Status
paymentTermsenum(net_15, net_30, net_45, net_60, net_90, due_on_receipt, custom)No—Payment terms
supplierCodestringNo—Supplier code
creditLimitstringNo—Credit limit
insuranceCertExpirystring.date-timeNo—Insurance cert expiry
w9OnFilebooleanNofalseW9on file
licenseNumberstringNo—License number
licenseExpirystring.date-timeNo—License expiry
productLinesstring[]No—Product lines
defaultLeadTimeDaysintegerNo—Default lead time days
ratingintegerNo—Rating
billingPreferencesobjectNo—Billing preferences
taxProfileobjectNo—Tax profile
ownerUserIdstringNo—ID of the associated owner user
notesSummarystringNo—Notes summary
websiteunknownNo—Website
primaryContactEmailunknownNo—Primary contact email
primaryContactPhoneunknownNo—Primary contact phone
physicalAddressunknownNo—Physical address
mailingAddressunknownNo—Mailing address
billingAddressunknownNo—Billing address
accountNumberunknownNo—Account number

User

User entity reference

Vendor Product

Vendor Product entity reference

On this page

VendorFieldsCreate SchemaUpdate Schema