REST Object Definitions Account Location Related Objects Account Location Query Object

Account locations are associated with accounts and an account can have one or more account locations. The account location is the location where actual work is to be preformed and typically the account represents the billing entity. For residential customers the account and account location are typically the same.

On this page:

Related pages:

Account Location Query Object Formats

JSON Format

{
    "AccountName": "",
	"AccountNum": "",
	"AccountType": "",
	"Address": {
        "AddrLine1": "", 
        "AddrLine2": "", 
        "AddrLine3": "", 
        "AddrLine4": "",
        "AddrType": "", 
        "City": "", 
        "Country": "", 
        "Intersection" : "",
        "Lat" : "",
        "Lon" : "",
        "Region": "", 
        "Zip": ""
    }, 
    "Contacts": [
        {
            "Email": "", 
            "FirstName": "", 
            "IsPrimary": true, 
            "LastName": "", 
            "Phones": [
                {
                    "PhoneNum": "", 
                    "PhoneType": ""
                }
            ]
        }
    ], 
    "Email": "", 
    "LanguageID": "", 
    "LocationNum": "", 
    "Name": "", 
    "Notes" : "",
    "POReq": false, 
    "ServiceAreaID": "",
    "SigReq": true, 
    "StorageLocationID": ""
}

Account Location Query Object Properties

Required properties are in bold.

Property	Type	Description
AccountName	string	Identifies the name of the account
AccountNum	string	Contains a value that uniquely identifies the account record. This must be a unique value across all account objects.
AccountType	string	Identifies the type of account. Valid values are: 1001 - Business 1002 - Residential
Address	object	The address details for the account location.
Contacts	collection	An optional collection of contacts at the account location.
Email	string	The primary email address for the account location.
LanguageID	string	The language code identifier associated with the account location.
LocationNum	string	The unique account location number. This number must be globally unique.
Name	string	A simple name of the account location.
Notes	string	General notes about the account location.
POReq	boolean	Identifies if a purchase order number is required at the time of the visit. If this field is not present, it will default to false.
ServiceAreaID	string	The service area the account location is associated with. 3.20.0
SigReq	boolean	Identifies if a signature is required to complete the work order process. The application has a default global setting related to signature capture. If this property is specified, then its value will override the system default. Valid values are: `false` = Signature capture is not required for the account location. `true` = Signature capture is required for the account location.
StorageLocationID	string	The inventory storage location identifier for the account location.