Account Location Related Objects Account Object

This object contains specific details about an account and are managed by the Account REST API.

An account has one or more account locations associated with it. Account locations are managed by the Account Locations REST API.

Account Object Formats

JSON Format
{
    "AccountNum": "", 
	"AccountsReceivable": "",
    "AccountType": "", 
    "Addresses": [
       {
          "AddrLine1": "", 
          "AddrLine2": "", 
          "AddrLine3": "", 
          "AddrLine4": "", 
          "AddrType": "", 
          "City": "", 
          "Country": "", 
          "Intersection" : "",
          "Lat" : "",
          "Lon" : "",
          "Region": "", 
          "Zip": ""
       }   
    ], 
    "Contacts": [
        {
            "Email": "", 
            "FirstName": "", 
            "IsPrimary": true, 
            "LastName": "", 
            "Phones": [
                {
                    "PhoneNum": "", 
                    "PhoneType": ""
                }
            ]
        }
    ],
	"FlexAttrs": {
      "${FlexFormID}": {
        "${FlexAttrID}": [
          "",
          ""
        ]
      }
    }, 
	"FlexForms": [
        "${FlexFormID}"
    ],
	"Integrations": {
		"Financial": {
			"ID": "",
			"Extensions": {
				"": ""
			}
		}
	},
	"IsActive": true,
    "Name": "", 
    "Notes" : "",
	"PaymentSystemID": "",
	"TaxExempt": false,
    "TierPricingID": "",
    "Website": ""
}

Account Object Properties

(info) Required properties are in Bold.

PropertyTypeDescription
AccountNumstringContains a value that uniquely identifies the account record. This must be a unique value across all account objects.
AccountsReceivablestring

Contains a Account Receivable Ledger Types System Category value identifying the type of accounts receivable account to track invoice payments.

3.19.0

AccountTypestring

Identifies the type of account.

Valid values are:

  • 1001 - Business
  • 1002 - Residential
Addressescollection

Contains zero or more address details for the account.

Contactscollection

Contains zero or more contact details for the account.

FlexFormscollection

An optional collection of FlexForm IDs. Each form specified in the collection will be available for the identified task.

See: FlexForm Object

4.2.0

FlexAttrsobject

This property contains the Flex-Field values that were entered.

  • Flex-Fields are always associated with a Flex-Form

Flex-Field values can be pre-populated from the backend

PropertyTypeDescription
${FlexFormID}object

Identifies the Flex-Form

PropertyTypeDescription
${FlexAttrID}collectionContains an collection of values entered for the Flex-Input field identified by ${FlexAttrID}.



4.2.0

Integrationsobject

ServiceMobility integrates with many external systems. This optional object contains external system's unique identifier and/or sync token for Account object.

See: Integrations

4.5.0

IsActiveboolean

Default value is true

Identifies if the account is active and can be used in mobile application.

Valid values are:

  • false = The account is inactive.
  • true = The account is active. This is the default value if this property is not specified.

4.3.0

NamestringIdentifies the name of the account
NotesstringContains optional account notes.
PaymentSystemIDstring

Contains payment processing system identifier for the account. This must be a unique value across all account objects.

3.49.0

TaxExempt


boolean

Indicates whether the account is exempt from collecting taxes

3.19.0

TierPricingID


string

Contains tier pricing identifier for the account.

3.18.0

WebsitestringSpecifies the URL of the account's website.