AccountLocation

IMPORTANT  The SOAP API entered a limited enhancement phase in Q4 2020. Access deactivation for version 1.5 began in Q1 2022 and will enter its concluding phases in October 2022. Access to version 1.6 will be deactivated in Q4 2024. Visit our SOAP API lifecycle FAQ article to learn more.

The AccountLocation entity takes on the UDFs that hold the site setup information for the account represented by AccountId.

Do not confuse AccountLocation with InternalLocation, the entity that describes the locations associated with Autotask resources.

Entity details

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

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

Conditions and requirements

General

NOTE  Site Configuration UDFs are associated with the AccountLocation entity. In Autotask, required Site Configuration UDFs are required for Customer type accounts only. The Web Services API, however, will show all Site Configuration UDFs for all Account Locations as not required until an Update is performed. When you perform an Update, the Web Service API will perform a check and, for Account Locations where Account.Type = Customer, any required Site Configuration UDF will be required. If no data is provided for a required UDF, Web Services cannot complete the update.

IMPORTANT  The API respects Data Protection Permissions (DPP's) for AccountLocation Site Configuration user-defined fields. See details below.

  • The AccountLocation entity can have no more than 500 UDFs. Refer to UserDefinedFieldDefinition.
  • Administrators assign Protected Data Permissions from > Admin > Features & Settings > Resources/Users (HR) > Security > Protected Data Permission.
  • If the user has no Protected Data Permission, then no UDFs will display. Otherwise all UDFs are displayed, but their values are masked based on the user's PDPs.
    User sees a "*****" mask when the user does not have the PDPs to see the actual UDF value, whether the UDF has a value or not.
  • Users without PDP's cannot Query or Update this entity. An error is thrown if user attempts to update a UDF outside their permissions.
  • AccountID, id, and LocationName are Read Only; therefore, update() is allowed only when the entity has user-defined fields that allow update and the correct PDP's to access UDF data.

  • Upon creation of an AccountLocation entity, a default primary AccountLocation entity is also created.

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
AccountID {LT:Account} ID integer Account  
id id long    
LocationName {LT:Account} Name string (100)