Versions Compared

Version Old Version 15 New Version 16
Changes made by

Mickey Bushman

Mickey Bushman

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space MOBUD and version 3

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.

Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel2

Related pages:

Account Object Formats

Include Page
_Account Object Formats
_Account Object Formats

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.

Status
title3.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

Include Page
_def_FlexForms
_def_FlexForms

Status
title4.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}.



Status
title4.2.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.

Status
title4.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.

Status
title3.49.0

TaxExempt


boolean

Indicates whether the account is exempt from collecting taxes

Status
title3.19.0

TierPricingID


string

Contains tier pricing identifier for the account.

Status
title3.18.0

WebsitestringSpecifies the URL of the account's website.