REST Object Definitions 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.

On this page:

Related pages:

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

Required properties are in Bold.

Property	Type	Description
AccountNum	string	Contains a value that uniquely identifies the account record. This must be a unique value across all account objects.
AccountsReceivable	string	Contains a Account Receivable Ledger Types System Category value identifying the type of accounts receivable account to track invoice payments. 3.19.0
AccountType	string	Identifies the type of account. Valid values are: 1001 - Business 1002 - Residential
Addresses	collection	Contains zero or more address details for the account.
Contacts	collection	Contains zero or more contact details for the account.
Name	string	Identifies the name of the account
Notes	string	Contains optional account notes.
PaymentSystemID	string	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
Website	string	Specifies the URL of the account's website.