Please enable JavaScript to view this site.

Autotask API Data Model Autotask Forums

Navigation: Schema: Companies > Tables

CompaniesById

Catalog: Autotask

Schema: Companies

This is a read-only table function. The Autotask API may not support changing the data or the Invantive UniversalSQL driver for Autotask does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Autotask API.

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function CompaniesById. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name

Data Type

Required

Default Value

Documentation

id

int64

☑

 

 

 

Columns of Table Function

The columns of the table function CompaniesById are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

additionalAddressInformation

string

Additional Address Information

☐

 

address1

string

Address 1

☐

 

address2

string

Address 2

☐

 

alternatePhone1

string

Alternate Phone 1

☐

 

alternatePhone2

string

Alternate Phone 2

☐

 

apiVendorID

int32

API Vendor ID

☐

 

assetValue

double

Asset Value

☐

 

billingAddress1

string

Billing Address 1

☐

 

billingAddress2

string

Billing Address 2

☐

 

billToAdditionalAddressInformation

string

Bill-to Additional Address Information

☐

 

billToAddressToUse

int32

Bill-to Address to Use

☐

 

billToAttention

string

Bill-to Attention

☐

 

billToCity

string

Bill-to City

☐

 

billToCompanyLocationID

int32

Bill-to Company Location ID

☐

 

billToCountryID

int32

Bill-to Country ID

☐

 

billToState

string

Bill-to State

☐

 

billToZipCode

string

Bill-to ZIP Code

☐

 

city

string

City

☐

 

classification

int32

Classification

☐

 

companyCategoryID

int32

Company Category ID

☐

 

companyName

string

Company Name

☐

 

companyNumber

string

Company Number

☐

 

companyType

int32

Company Type

☐

 

competitorID

int32

Competitor ID

☐

 

countryID

int32

Country ID

☐

 

createDate

datetime

Created

☐

 

createdByResourceID

int32

Created by Resource ID

☐

 

currencyID

int32

Currency ID

☐

 

fax

string

Fax

☐

 

id

int64

ID

☐

 

impersonatorCreatorResourceID

int32

Imperonsator Creator Resource ID

☐

 

invoiceEmailMessageID

int32

Invoice Email Message ID

☐

 

invoiceMethod

int32

Invoice Method

☐

 

invoiceNonContractItemsToParentCompany

boolean

Invoice Non-contract Items to Parent Company

☐

 

invoiceTemplateID

int32

Invoice Template ID

☐

 

isActive

boolean

Is Active

☐

 

isClientPortalActive

boolean

Is Client Portal Active

☐

 

isEnabledForComanaged

boolean

Is Enabled for Co-managed

☐

 

isSample

boolean

Is Sample

☐

 

isTaskFireActive

boolean

Is Task Fire Active

☐

 

isTaxExempt

boolean

Is Tax Exempt

☐

 

lastActivityDate

datetime

Last Activity Date

☐

 

lastTrackedModifiedDateTime

datetime

Last Tracked Modified Date/Time

☐

 

marketSegmentID

int32

Market Segment ID

☐

 

ownerResourceID

int32

Owner Resource ID

☐

 

parentCompanyID

int32

Parent Company ID

☐

 

phone

string

Phone

☐

 

postalCode

string

Postal Code

☐

 

purchaseOrderTemplateID

int32

Purchase Order Template ID

☐

 

quoteEmailMessageID

int32

Quote Email Message ID

☐

 

quoteTemplateID

int32

Quote Template ID

☐

 

sicCode

string

SIC Code

☐

 

state

string

State

☐

 

stockMarket

string

Stock Market

☐

 

stockSymbol

string

Stock Symbol

☐

 

surveyCompanyRating

double

Survey Company Rating

☐

 

taxID

string

Tax ID

☐

 

taxRegionID

int32

Tax Region ID

☐

 

territoryID

int32

Territory ID

☐

 

webAddress

string

Web Address

☐

 

 

10-06-2024 18:39 Version 24.1.3-BETA+4689

X

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

  • Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
  • Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
  • Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
  • Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
  • Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
  • Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
  • Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
  • Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.
  
Disclaimer