Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

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.

Contactsobject

Contains zero or more contact details for the account.

NamestringIdentifies the name of the account
NotesstringContains optional account notes.

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.
  • No labels