Companies

About this entity

The Companies entity describes an organization with which you do business. It is the pivotal entity in Autotask: all other entities such as contacts, tickets, or projects are directly or indirectly associated with an organization.

  • Each organization has at least one location. Each organization can have up to 5,000 locations.
  • Organizations can be set up as the sub-organization of another independent organization, the parent organization, by referencing a parentCompanyID. This has implications for billing and invoicing, since billing can optionally be directed to a parent organization.

Entity info

Can Create Can Delete Can Query Can Update Can have UDFs Supports webhooks

true

false

 true true true (max. 200)

true

IMPORTANT  In the English Autotask UI, customers can select the term they want to use for the Companies entity. The default term is Organization or, in the Client Portal, Client. It may also appear in the UI as Company, Account, Business Unit, Client, or Site. Refer to Terminology differences between the Autotask UI and the API.

Admins of English language instances of Autotask have the option to select one of the following terms for the Companies entity:

  • Account
  • Business Unit
  • Client
  • Company
  • Customer
  • Organization (default for new instances)
  • Site
Parent Children
None

CompanyAlerts

CompanyAttachments

Contacts

CompanyLocations

CompanyNotes

CompanySiteConfigurations

CompanyTeams

CompanyToDos

Field definitions

The following table describes the standard Autotask fields for this entity. Refer to the following articles for more information about working with these fields:

To learn how to query picklist endpoints, refer to Understanding picklists.

In the UI, most of these fields appear on the New Organization or Edit Organization pages. The fields that are displayed are determined by the organization category selected for the organization. For field descriptions, refer to Adding an organization.

Field Name UI Label / Description Datatype
 Is Required Read-Only Reference Name Picklist Webhook field
additionalAddressInformation Additional Address Information on the Details panel string (100)        
address1

Address 1 on the Details panel

 string (150)        
address2

Address 2 on the Details panel

 string (150)        
alternatePhone1 Alternate Phone 1 on the Details panel string (25)        
alternatePhone2 Alternate Phone 2 on the Details panel string (25)        
apiVendorID

If the organization is of the type Vendor and has created an integration with Autotask that is listed on the Integration Center page, this field will show the API Tracking Identifier that must be used for integrations by this vendor.

integer      
assetValue

Asset Value on the Details panel

The total asset value of a publicly traded company. This field cannot be queried.

 decimal

 

      

billToAddressToUse

The Billing Address on the Invoice Settings accessory tab.

In the UI, Invoice Settings are created separately from the Company entity and the Company entity must exist before they can be added.

  • When using create() in the API, the organization doesn't exist yet and there are no additional locations, so the billToAddressToUse field will always default to the selection Use Organization Address. Any values provided for the related fields on create() are ignored.
  • The billing address can only be changed in the UI. Users can choose the Organization Address or another Location Address, and if the organization is a sub-organization, the Parent Organization Address or the Parent Organization Billing Address.
integer    

 
billingAddress1

These fields are populated by the organization or location address fields selected in billToAddressToUse.

 string (150)        
billingAddress2 string (150)        
billToAdditionalAddressInformation
 string (100 )        
billToCity string (50)        
billToCountryID integer   Countries    
billToState string (128)        
billToZipCode string (50)        

billToCompanyLocationID

References the location selected in billToAddressToUse.

 integer     CompanyLocations

 

 
billToAttention

Attention on the Invoice Settings accessory tab.

string (50)          
city

City on the Details panel

 string (50)        

classification

Classification on the Details panel

integer

 

 

 

 

companyCategoryID

References the Organization Category on the Main panel. The category must be active.

While it is not possible to do so in the UI, you can use the API to create organizations with a companyCategory of API.

 integer

 

 

CompanyCategories

 

 
companyName Organization Name on the Main panel string (100)      
companyNumber Organization Number on the Details panel string (50)        
companyType

Organization Type on the Main panel

  • companyType cannot be updated when isTaskFireActive is True.
  • companyType cannot be changed from vendor if the organization is associated with any existing services.
 short    
competitorID

References the Competitor on the Details panel

 integer        
countryID

References the Country on the Details panel

 integer     Countries  

createDate

This system field tracks the date the organization was added to the database instance.

datetime

 

 

 

 
createdByResourceID

The resource ID of the user who added the organization to the Autotask instance.

 integer   Resources    
currencyID

Currency on the Details panel

In multi-currency databases, the billing currency associated with the organization. currencyID can be set at organization creation but then becomes read-only. This field is not required.

  • If no currencyID is specified, the organization will use the organization's country's currencyID.
  • If no currency is specified for the organization or the organization's country, the organization will use the internal currency.
 integer     Currencies  
fax

Fax Number on the Details panel

 string (25)        
id

The unique identifier of this entity.

 long      
impersonatorCreatorResourceID

The ID of the API user who is impersonating the creator of the organization.

 integer   Resources    
invoiceEmailMessageID

The ID of the Invoice Email Message on the Invoice Settings accessory tab.

 integer        
invoiceMethod

Transmission Method on the Invoice Settings accessory tab.Options are:

  • Print (2) - default
  • Email (3)
  • PrintAndEmail (4)

When the QuickBooks extension is enabled, the default value is controlled by the Contracts System Setting QuickBooks Transmission Method ( > Features & Settings > Application-Wide > System Settings > Contracts).

 integer        
invoiceNonContractItemsToParentCompany

Invoice non-contract items to Parent Organization check box on the Invoice Settings accessory tab.

Enabled for sub-organizations. Requires a value for billToAddressToUse.

 boolean          
invoiceTemplateID

The ID of the Invoice Template on the Invoice Settings accessory tab.

 integer     InvoiceTemplates    
isActive

Status on the Details panel. True if the status of the organization is active.

 boolean        
isClientPortalActive

Enabled for Client Portal on the Client Portal Organization Details page. True if the Client Portal for the organization is active.

 boolean    
isEnabledForComanaged

Select Enable/Disable Co-Management from the Tools menu.

When changed from True to False during an update, we will delete any existing co-managed associations for the organization.

boolean          
isTaskFireActive

Enabled for Taskfire on the Client Portal Organization Details page. True if Taskfire has been enabled for the organization.

 boolean      
isTaxExempt

Tax Exempt on the Invoice Settings accessory tab.

 boolean        
lastActivityDate

Tracked on the Tools > Organization History page and in the Last Activity field on the Main panel.

A change to a linked dependent entity is considered an activity on the entity. The initiating resource is usually tracked, as well, but no additional details are available.

 datetime

 

 

 

lastTrackedModifiedDateTime

Tracked on the Tools > Organization History page and in the Last Activity field on the Main panel. Any change to a field on the entity itself is considered a modification, and in addition to the date and time, the old and new values will be tracked.

Changes to the following organization fields will update this field:

  • Company Manager (ownerResourceID)
  • isActive
  • Additional Address Info
  • Additional Info - Stock Symbol
  • Address 1
  • Address 2
  • Alternate Phone 1
  • Alternate Phone 2
  • Asset Value
  • City
  • Classification
  • isClientPortalActive
  • Company Alert
  • Company Name
  • Company Number
  • Company Type
  • Company UDF's
  • Competitor
  • Country
  • startDate
  • currencyID
  • Fax
  • ID
  • Market Segment
  • New Ticket Alert
  • Opted Out from Surveys
  • Parent Company Name (ID)
  • Phone & Extension
  • Round-Trip Distance (Miles)
  • SIC Code
  • Site Configuration UDF's
  • State
  • Stock Market
  • isTaskFireActive
  • Tax Exempt
  • Tax ID
  • Tax Region
  • Territory Name
  • Ticket Detail Alert
  • Web Site
  • Zip

datetime

 

 

 

marketSegmentID

Market Segment on the Details panel

 integer

 

 

 
ownerResourceID

References the Account Manager on the Details panel.

Resource Type for Owner resourceThe ownerResourceID must reference an active, standard Autotask resource with security level access to the CRM module. A resource with a non-standard security level, for example, API user (API only), is not a valid selection for ownerResourceID.

 integer

 

 Resources

 
parentCompanyID

References the Parent Organization on the Details panel.

If the organization has a parentCompanyID specified and the parentCompanyID is removed (the Parent/Sub-Organization relationship is terminated), then all parentCompany Contacts associated with the Company's items will be cleared.

 integer

 

 

 Companies

 
phone

Phone on the Details panel

 string (25)

 

 

 
postalCode

Zip Code on the Details panel

 string (30)

 

 

 

 

purchaseOrderTemplateID

The ID of the Purchase Order Template on the Purchase Order Settings accessory tab.

  • If purchaseOrderTemplateID is null in the database, during query, the field will return the associated country's purchaseOrderTemplateID if it exists.
  • If no country is associated, or if the country is not associated with a purchaseOrderTemplateID, then the query will return the system default purchase order template ID.

integer

 

 

 

 
quoteEmailMessageID
 The ID of the Quote Email Message on the Quote Settings accessory tab. integer        
quoteTemplateID

The ID of the Quote Template on the Quote Settings accessory tab.

integer   QuoteTemplates    
sicCode

SIC Code on the Details panel. This field cannot be queried.

 string (32)

 

 

 

 
state

State on the Details panel

 string (50)

 

 

 

 
stockMarket

Stock Market on the Details panel. This field cannot be queried.

 string (10)

 

 

 

 
stockSymbol

Stock Symbol on the Details panel. This field cannot be queried.

 string (10)

 

 

 

 
surveyCompanyRating

Organization Survey Score on the Search Organizations table. The average survey rating of all feedback by this organization.

 decimal        
taxID The Tax ID of the organization on the Invoice Settings accessory tab. string (50)        
taxRegionID

The Tax Region of the organization on the Invoice Settings accessory tab.

Can be null only when isTaxExempt is True.

 integer     TaxRegions  
territoryID Territory on the Details panel integer

 

 

 
webAddress Web on the Details panel string (255)

 

 

 

 

Additional resources