• [0]: object ApiEntityCompany

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApiEntityCompany"
    }
}

• addressLine1(optional): string
  The first line of the address of a location.
  This might be the building number and street address.
• addressLine2(optional): string
  The second line of the address of a location.
  This might be a neighborhood or town.
• cityName(optional): string
  The city name for a location.
• companyConfiguredFields(optional): object ApiEntityCompanyConfiguredFields
• companyId(optional): integer(int64)
  The system-generated identifier of a company. This value should not be provided in create operation request data, however, it is required for update requests.
• companyName: string
  Allowed Values: [ "Length[1-255]" ]

  The name of the company.
• countryCode: string
  The country for a location.
• description(optional): string
  Allowed Values: [ "Length[1-4000]" ]

  Additional information about the company.
• fax(optional): string
  Allowed Values: [ "Length[1-32]" ]

  The fax number for the company.
• isTenantOwned(optional): boolean
  Does the company belong to the tenant.
• latitude(optional): number(double)
  The latitude of a company.
• link(optional): string(url)
  Read Only: true
• locationName(optional): string
  A name for the location that your users will understand and recognize.
• longitude(optional): number(double)
  The geographical coordinate for the longitude of the location.
  The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service.
• offices(optional): array offices
  Read Only: true

  Unique Items Required: true

  Offices associated with the company.
• organizationId(optional): integer(int64)
  The unique identifier for the organisation.
• otherPhone(optional): string
  Allowed Values: [ "Length[1-32]" ]

  An alternate phone number for a company.
• performanceRating(optional): string
  Allowed Values: [ "PERFORMANCE_LEVEL_ONE", "PERFORMANCE_LEVEL_TWO", "PERFORMANCE_LEVEL_THREE", "PERFORMANCE_LEVEL_FOUR", "PERFORMANCE_LEVEL_FIVE", "NO_PERFORMANCE_RATING" ]

  Performance Rating of a Company determined by the tenant.
• phone(optional): string
  Allowed Values: [ "Length[1-32]" ]

  The phone number for the company.
• postalCode: string
  The postal code, post code, or zip code of a location.
• pushDownType(optional): string
  Allowed Values: [ "MANUAL", "AUTOMATIC" ]

  The push down type of the workspace company.
• qualificationStatus(optional): string
  Allowed Values: [ "QUALIFIED", "CONDITIONALLY_QUALIFIED", "NOT_QUALIFIED", "NO_STATUS" ]

  Qualification status of a Company according to the tenant
• sourceId(optional): string
  The unique identifer of company data in an external source.

  Example: coarse
• sourceSiteId(optional): string
  The unique identifier of a company site in an external source.
• stateCode(optional): string
  A unique identifier for the state or province.
• stateName(optional): string
  The state, region, or province of a location.
• status(optional): string
  Allowed Values: [ "ACTIVE", "INACTIVE" ]

  The status of the company. Valid values are Active and Inactive.
• type(optional): string
  Allowed Values: [ "OWNER", "VENDOR", "RESELLER", "DESIGN_CONSULTANT", "SUB_CONTRACTOR", "SUPPLIER", "OTHER", "ARCHITECT", "OWNER_REP", "GC", "CONSULTANT", "ARCHITECT_ENGINEER", "CONTRACTOR", "CONSTRUCTION_MANAGER", "ENGINEER", "CUSTOMER" ]

  The type of company. Valid values are Owner, Vendor, Reseller, Design Consultant, Sub Contractor, and Supplier.
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
• url(optional): string
  Allowed Values: [ "Length[1-255]" ]

  The website of the company.
• workspaceCode(optional): string
• workspaceId(optional): integer(int64)
  The workspace that the company was created in. All changes to the company must be made in the owning workspace.

{
    "type":"object",
    "required":[
        "companyName",
        "countryCode",
        "postalCode"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "type":{
            "type":"string",
            "description":"The type of company. Valid values are Owner, Vendor, Reseller, Design Consultant, Sub Contractor, and Supplier.",
            "enum":[
                "OWNER",
                "VENDOR",
                "RESELLER",
                "DESIGN_CONSULTANT",
                "SUB_CONTRACTOR",
                "SUPPLIER",
                "OTHER",
                "ARCHITECT",
                "OWNER_REP",
                "GC",
                "CONSULTANT",
                "ARCHITECT_ENGINEER",
                "CONTRACTOR",
                "CONSTRUCTION_MANAGER",
                "ENGINEER",
                "CUSTOMER"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "format":"int64",
            "description":"The workspace that the company was created in. All changes to the company must be made in the owning workspace."
        },
        "description":{
            "type":"string",
            "description":"Additional information about the company.",
            "enum":[
                "Length[1-4000]"
            ]
        },
        "status":{
            "type":"string",
            "description":"The status of the company. Valid values are Active and Inactive.",
            "enum":[
                "ACTIVE",
                "INACTIVE"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"The push down type of the workspace company.",
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "workspaceCode":{
            "type":"string"
        },
        "url":{
            "type":"string",
            "description":"The website of the company.",
            "enum":[
                "Length[1-255]"
            ]
        },
        "countryCode":{
            "type":"string",
            "description":"The country for a location."
        },
        "addressLine1":{
            "type":"string",
            "description":"The first line of the address of a location. <br />This might be the building number and street address."
        },
        "stateName":{
            "type":"string",
            "description":"The state, region, or province of a location."
        },
        "addressLine2":{
            "type":"string",
            "description":"The second line of the address of a location. <br />This might be a neighborhood or town."
        },
        "postalCode":{
            "type":"string",
            "description":"The postal code, post code, or zip code of a location."
        },
        "latitude":{
            "type":"number",
            "format":"double",
            "description":"The latitude of a company."
        },
        "locationName":{
            "type":"string",
            "description":"A name for the location that your users will understand and recognize."
        },
        "cityName":{
            "type":"string",
            "description":"The city name for a location."
        },
        "stateCode":{
            "type":"string",
            "description":"A unique identifier for the state or province."
        },
        "longitude":{
            "type":"number",
            "format":"double",
            "description":"The geographical coordinate for the longitude of the location. <br />The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service."
        },
        "sourceId":{
            "type":"string",
            "example":"coarse",
            "description":"The unique identifer of company data in an external source."
        },
        "phone":{
            "type":"string",
            "description":"The phone number for the company.",
            "enum":[
                "Length[1-32]"
            ]
        },
        "organizationId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the organisation."
        },
        "performanceRating":{
            "type":"string",
            "description":"Performance Rating of a Company determined by the tenant.",
            "enum":[
                "PERFORMANCE_LEVEL_ONE",
                "PERFORMANCE_LEVEL_TWO",
                "PERFORMANCE_LEVEL_THREE",
                "PERFORMANCE_LEVEL_FOUR",
                "PERFORMANCE_LEVEL_FIVE",
                "NO_PERFORMANCE_RATING"
            ]
        },
        "qualificationStatus":{
            "type":"string",
            "description":"Qualification status of a Company according to the tenant",
            "enum":[
                "QUALIFIED",
                "CONDITIONALLY_QUALIFIED",
                "NOT_QUALIFIED",
                "NO_STATUS"
            ]
        },
        "companyConfiguredFields":{
            "description":"An object containing configured fields in the form of key-value pairs.",
            "$ref":"#/definitions/ApiEntityCompanyConfiguredFields"
        },
        "isTenantOwned":{
            "type":"boolean",
            "description":"Does the company belong to the tenant."
        },
        "companyName":{
            "type":"string",
            "description":"The name of the company.",
            "enum":[
                "Length[1-255]"
            ]
        },
        "fax":{
            "type":"string",
            "description":"The fax number for the company.",
            "enum":[
                "Length[1-32]"
            ]
        },
        "otherPhone":{
            "type":"string",
            "description":"An alternate phone number for a company.",
            "enum":[
                "Length[1-32]"
            ]
        },
        "offices":{
            "type":"array",
            "description":"Offices associated with the company.",
            "readOnly":true,
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityOffice"
            }
        },
        "sourceSiteId":{
            "type":"string",
            "description":"The unique identifier of a company site in an external source."
        },
        "companyId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a company. This value should not be provided in create operation request data, however, it is required for update requests."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

• companyId(optional): integer(int64)
• costFlexMap(optional): object costFlexMap
  Additional Properties Allowed: additionalProperties

  The cost fields associated with a company.
• link(optional): string(url)
  Read Only: true
• otherFlexMap(optional): object otherFlexMap
  Additional Properties Allowed: additionalProperties

  The cost fields associated with a company.
• textFlexMap(optional): object textFlexMap
  Additional Properties Allowed: additionalProperties

  The cost fields associated with a company.
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "costFlexMap":{
            "type":"object",
            "description":"The cost fields associated with a company.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "otherFlexMap":{
            "type":"object",
            "description":"The cost fields associated with a company.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "textFlexMap":{
            "type":"object",
            "description":"The cost fields associated with a company.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "companyId":{
            "type":"integer",
            "format":"int64",
            "description":""
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

• [0]: object ApiEntityOffice

{
    "type":"array",
    "description":"Offices associated with the company.",
    "readOnly":true,
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityOffice"
    }
}

• object additionalProperties

{
    "type":"object",
    "description":"The cost fields associated with a company.",
    "additionalProperties":{
        "type":"object"
    }
}

• object additionalProperties

{
    "type":"object",
    "description":"The cost fields associated with a company.",
    "additionalProperties":{
        "type":"object"
    }
}

• object additionalProperties

{
    "type":"object",
    "description":"The cost fields associated with a company.",
    "additionalProperties":{
        "type":"object"
    }
}

• addressLine1(optional): string
  The first line of the address of a location.
  This might be the building number and street address.
• addressLine2(optional): string
  The second line of the address of a location.
  This might be a neighborhood or town.
• cityName(optional): string
  The city name for a location.
• companyId: integer(int64)
  The unique identifier of a company of an office.
• companyName(optional): string
  Allowed Values: [ "Length[1-255]" ]

  The name of the company.
• countryCode(optional): string
  The country for a location.
• fax(optional): string
  The fax number for the office.
• isCorporateOffice(optional): boolean
  If the office is the Head office of the company.
• latitude(optional): number(double)
  The geographical coordinate for the latitude of the location.
  The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service.
• link(optional): string(url)
  Read Only: true
• longitude(optional): number(double)
  The geographical coordinate for the longitude of the location.
  The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service.
• officeCountryCode: string
  The country for a location.
• officeId(optional): integer(int64)
  The unique identifier of an office.
• officeName: string
  Allowed Values: [ "Length[1-255]" ]

  The name of the office.
• officePostalCode: string
  The postal code, post code, or zip code of a location.
• orgOfficeId(optional): integer(int64)
  The unique identifier of the organization of the office.
• phone(optional): string
  The phone number for the office.
• postalCode(optional): string
  The postal code, post code, or zip code of a location.
• stateName(optional): string
  The state, region, or province of a location.
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "required":[
        "companyId",
        "officeCountryCode",
        "officeName",
        "officePostalCode"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "officeName":{
            "type":"string",
            "description":"The name of the office.",
            "enum":[
                "Length[1-255]"
            ]
        },
        "isCorporateOffice":{
            "type":"boolean",
            "description":"If the office is the Head office of the company."
        },
        "orgOfficeId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the organization of the office."
        },
        "longitude":{
            "type":"number",
            "format":"double",
            "description":"The geographical coordinate for the longitude of the location. <br />The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service."
        },
        "latitude":{
            "type":"number",
            "format":"double",
            "description":"The geographical coordinate for the latitude of the location. <br />The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service."
        },
        "companyName":{
            "type":"string",
            "description":"The name of the company.",
            "enum":[
                "Length[1-255]"
            ]
        },
        "postalCode":{
            "type":"string",
            "description":"The postal code, post code, or zip code of a location."
        },
        "countryCode":{
            "type":"string",
            "description":"The country for a location."
        },
        "addressLine1":{
            "type":"string",
            "description":"The first line of the address of a location. <br />This might be the building number and street address."
        },
        "stateName":{
            "type":"string",
            "description":"The state, region, or province of a location."
        },
        "addressLine2":{
            "type":"string",
            "description":"The second line of the address of a location. <br />This might be a neighborhood or town."
        },
        "cityName":{
            "type":"string",
            "description":"The city name for a location."
        },
        "phone":{
            "type":"string",
            "description":"The phone number for the office."
        },
        "officePostalCode":{
            "type":"string",
            "description":"The postal code, post code, or zip code of a location."
        },
        "officeCountryCode":{
            "type":"string",
            "description":"The country for a location."
        },
        "fax":{
            "type":"string",
            "description":"The fax number for the office."
        },
        "companyId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a company of an office."
        },
        "officeId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of an office."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}