InternalLocation

IMPORTANT  The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will eventually be deactivated. At this time, there is no end-of-lifecycle date.

This entity describes a Location defined in Company Setup in the Autotask Admin module. Locations represent the various sites where the Autotask user's company has a physical presence. Every resource is associated with a location. The time zone and holiday set of the associated location are applied to the resource's time entries and schedules.

Do not confuse InternalLocation with AccountLocation, the entity that holds site configuration information for a specified Account entity.

Entity details

You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.

Entity Name: InternalLocation
Can Create:  
Can Update:  
Can Query:
Can Delete:  
Can Have UDFs:  

NOTE  TimeZone returns the Microsoft Time Zone Index value associated with the internal Location.

Conditions and requirements

An internal location's country is mapped to either a country from the Autotask Countries list or to "Other." This impacts API queries as follows:

  • On query():

If the Country field is mapped to a country in Autotask, then the country display value will be returned.

If the Country value is mapped to "Other" in Autotask, the stored text value is returned.

  • On query() by Country:

The system searches only the Country display name.

If the entity’s Country value is not mapped to an Autotask country, then you must query for Country = "Other"; that is, the string "Other", not the stored text value. This will return all entities where the country value is non-standard.

For details on how the Country value is mapped in Autotask, refer to Account.

Field definitions

The following table describes the standard Autotask field objects for this entity.

  • To retrieve more detailed information specific to a particular Autotask implementation, use the Web Services API call The getFieldInfo() SOAP API call.
  • For information on entity UDFs, use getUDFInfo().
  • For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.

For more information about fields marked as picklists, review our Understanding picklists article.

Field Name Label Datatype Read Only Is Required Reference Name Picklist
AdditionalAddressInfo Additional Address Info string (100)      
Address1 Address 1 string (100)      
Address2 Address 2 string (100)      
City City string (50)      
Country Country string (100)      
HolidaySetId Holiday Set long    
id id long    
IsDefault Is Default boolean      
Name Name string (100)    
PostalCode {LT:ZipCode} string (20)      
State {LT:State} string (25)      
TimeZone Time Zone Code string (100)