InternalLocations

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 InternalLocations with CompanySiteConfigurations, the entity that holds site configuration information for a specified Company entity.

NOTE  You can refer to the Online Help to find root and child access URLs of the entity you wish to query. Refer to Finding resource and child access URLs of REST API entities for more information.

Entity details

Entity Name: InternalLocations

Entity Path:

/atservicesrest/v1.0/InternalLocations
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 Companies.

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.

Notes

  • For string datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.
  • If this entity has child collections, they will appear in a Child collection access URLs or an Entity URLs and relationships drop-down in the Entity details section of this article.
  • You can call the /query/count/ endpoint of a resource to determine how many records a collection holds.
Field Name Datatype Read-Only Is Required Reference Name Picklist
additionalAddressInfo string (100)      
address1 string (100)      
address2 string (100)      
city string (50)      
country string (100)      
holidaySetId long    
id long    
isDefault boolean      
name string (100)    
postalCode string (20)      
state string (25)      
timeZone string (100)      

Additional resources