Skip to main content
POST
Create Companies

Path Parameters

workspaceId
string
required

Body

application/json
name
string
required
Required string length: 1 - 255
primaryContact
object
globalCompanyId
string
Pattern: ^[1-9]\d{0,18}$
categoryIds
string[]
Maximum array length: 100
Pattern: ^\d+$
domain
string | null
Maximum string length: 2048
tags
enum<string>[]
Available options:
client,
manufacturer,
vendor,
consultants_contractors,
warehouse,
facility_management
status
enum<string>
Available options:
preferred,
approved,
pending_approval,
inactive
notes
string | null
Required string length: 1 - 2000
ratingQuality
integer | null
Required range: 1 <= x <= 5
ratingLeadTime
integer | null
Required range: 1 <= x <= 5
ratingPricing
integer | null
Required range: 1 <= x <= 5
website
string | null
Required string length: 1 - 2048
accountNumber
string | null
Required string length: 1 - 255
vatTaxId
string | null
Required string length: 1 - 255
registrationNumber
string | null
Required string length: 1 - 255
portalUrl
string | null
Required string length: 1 - 2048
portalLogin
string | null
Required string length: 1 - 255
paymentTerms
enum<string> | null
Available options:
net_30,
net_60,
due_on_receipt,
deposit_50
creditLimit
string | null
Pattern: ^\d{1,10}(\.\d{1,2})?$
minOrderAmount
string | null
Pattern: ^\d{1,10}(\.\d{1,2})?$
standardDiscountPct
string | null
Pattern: ^\d{1,3}(\.\d{1,4})?$
defaultLeadTimeDays
integer | null
Required range: 0 <= x <= 3650

Response

201 - application/json
categories
object[]
required
id
string
required
name
string
required
domain
string | null
required
tags
string[]
required
status
enum<string>
required
Available options:
preferred,
approved,
pending_approval,
inactive
notes
string | null
required
ratingQuality
number | null
required
ratingLeadTime
number | null
required
ratingPricing
number | null
required
website
string | null
required
accountNumber
string | null
required
vatTaxId
string | null
required
registrationNumber
string | null
required
portalUrl
string | null
required
portalLogin
string | null
required
portalPasswordSet
boolean
required
paymentTerms
enum<string> | null
required
Available options:
net_30,
net_60,
due_on_receipt,
deposit_50
creditLimit
string | null
required
minOrderAmount
string | null
required
standardDiscountPct
string | null
required
defaultLeadTimeDays
number | null
required
primaryPerson
object | null
required
createdAt
string
required
updatedAt
string
required
identity
object