Company object representation

The company object representation and fields are described below.

company was introduced in API version V1

company has not been marked for deprecation

Usages

Company

Description

Representation of a company object which may have a parent company (in structured companies), an owner, if this company represents some CRM company owned by a customer company and an organisation for which this company and associated accounts are provisioned.

Example create representation

{
  "name" : "Example company name",
  "owner" : {
    "urn" : "7f8a5363-3a24-4ca1-a9a8-986bbbe7ee56",
    "url" : "/n/v1/company/7f8a5363-3a24-4ca1-a9a8-986bbbe7ee56"
  }
}

Example response representation

{
  "urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
  "url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
  "name" : "Example company name",
  "parentCompany" : {
    "urn" : "fe7f2716-3541-45d5-833d-b8a14ad386d0",
    "url" : "/n/v1/company/fe7f2716-3541-45d5-833d-b8a14ad386d0"
  },
  "owner" : {
    "urn" : "7f8a5363-3a24-4ca1-a9a8-986bbbe7ee56",
    "url" : "/n/v1/company/7f8a5363-3a24-4ca1-a9a8-986bbbe7ee56"
  },
  "organisation" : {
    "urn" : "0225cc24-77fc-40fe-88dd-66f358a17d56",
    "url" : "/n/v1/organisation/0225cc24-77fc-40fe-88dd-66f358a17d56"
  }
}

Fields

Name	Type	Description	Constraints
urn	String representation of a Unique Resource Name. Typically a UUID with 36 characters.	URN of the company
url	URL represented as a string	API URL for company
name	String literal	Descriptive name for the company. Note company names may be in associated company content.
parentCompany	company	Parent company if set for describing company / sub company structures as in CRM.
owner	company	Owning company where the data regarding this company is owned by by a the owning company e.g. in CRM where a company data is owned by the account owning company and organisation
organisation	organisation	The organisation this company belongs to. Typically set for owning companies with associated account and billing setup with your account
entity	entity	The content entity associated with this company. The company content entity will be created automatically when a company is created and can't be updated	Ignored on update.