v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Companies

Get New Company Requirements

Returns a list of fields required to create a new company record.

get/v1/company-requirements

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

The list of fields required to create a new company record.

companyNameboolean

A flag indicating name may be required when creating a new company.

companyRepboolean

A flag indicating at least one representativeUser may be required when creating a new company.

countryboolean

A flag indicating mainAddress/country may be required when creating a new company.

address1boolean

A flag indicating mainAddress/street1 may be required when creating a new company.

address2boolean

A flag indicating mainAddress/street2 may be required when creating a new company.

cityboolean

A flag indicating mainAddress/city may be required when creating a new company.

stateboolean

A flag indicating mainAddress/state_Province may be required when creating a new company.

zipboolean

A flag indicating mainAddress/postalCode may be required when creating a new company.

statusboolean

A flag indicating status may be required when creating a new company.

websiteboolean

A flag indicating link may be required when creating a new company.

mainPhoneboolean

Not implemented.

industryboolean

A flag indicating industry may be required when creating a new company.

categoryboolean

Not implemented.

tagboolean

Not implemented.

Example response

{
  "companyName": true,
  "companyRep": true,
  "country": true,
  "address1": true,
  "address2": true,
  "city": true,
  "state": true,
  "zip": true,
  "status": true,
  "website": true,
  "industry": true
}