Account

Return, update, create and delete accounts.

Date Released: Aug 2013 Date Updated: Jan 2022
URLSupports
/{cf_uri}/GeneralLedger/Account GET |  PUT |  POST |  DELETE
Please note: While accessibility via the API is available to both AccountRight and new Essentials files. Not all features will be displayed in Product for new Essentials

Each account is identified by a unique five-digit number. The first digit indicates the account’s classification (for example, accounts starting with 1 are asset accounts). The remaining four digits determine its location within the classification.

The accounts list groups accounts into eight classifications—Asset, Liability, Equity, Income, Cost of Sales, Expense, Other Income and Other Expense.

The elements list below details information for Account. To view the descriptions for the elements you can either hover any attribute to reveal details or click here to show all details inline.

Items shown with are required when posting or puting data
Items shown with are read-only elements

Attribute Details

  • UIDGuid (36)
  • Unique account identifier in the form of a guid.
    ONLY required for updating an existing account
    NOT required when creating a new account.
  • NameString (60)
  • Name of the account.
  • DisplayIDString (6) or (10)
  • (6) IF ‘UseAlphaAccountIdentifier’ Boolean property is FALSE - Parent account code format includes separator i.e. 1-1000
    (10) IF ‘UseAlphaAccountIdentifier’ Boolean property is TRUE - Account code format in Alpha-numeric value
    See here for more information on account types.
  • ClassificationClassification
  • The account classification can be one of the following:
    Asset, Liability, Equity, Income, CostOfSales, Expense, OtherIncome, OtherExpense
  • TypeAccountType
  • Depending on the classification of the account (e.g. asset), you can define the account's type, see here for more information on account types.
  • NumberInteger
  • Account number for example 1150. Must be a unique four-digit number that does not include the account type classification number and account separator.
  • DescriptionString (255)
  • A description of the account.
  • ParentAccount
  • Pulls through information relating to parent accounts.
    • UIDGuid (36)
    • Foreign Key: Unique identifier for the parent account in the form of a guid.
    • NameString (6)
    • Name of the parent account.
    • DisplayIDString (6)
    • Parent account code format includes separator ie 1-1000
    • URIString
    • Uniform resource identifier associated with the parent account object.
  • IsActiveBoolean
  • True indicates the account is active.
    False indicates the account is inactive.

    A user marks an account as inactive when they no longer need to record transactions to it. An inactive account doesn't appear in selection lists, but it can still be assigned to a transaction, and be included in reports.

  • TaxCode
  • Pulls through information relating to tax codes.
    • UIDGuid (36)
    • Foreign Key: Unique guid identifier belonging to the assigned tax code.
    • CodeString (3)
    • 3 didgit tax code.
    • URIString
    • Uniform resource identifier associated with the tax code object.
  • LevelInteger
  • The hierarchial level of the account in the Accounts List. Possible values are 1234. The highest level accounts are level 1, the lowest 4. You can only assign levels 2 to 4 to a new account. This is an example showing account hierarchy:

    Assets - Level 1
      Current Assets - Level 2
        Bank Accounts - Level 3
          National Bank Account 1 - Level 4
          National Bank Account 2 - Level 4

  • OpeningBalanceDecimal (13.3)
  • Balance of the account as at the conversion date set for the company file.
  • CurrentBalanceDecimal (13.3)
  • Current balance of the account. Note that this balance will include all future-dated activity.
  • BankingDetails
  • Pulls through information relating to banking details.
    • BSBNumberString (9)
    • ONLY APPLICABLE FOR AU REGION
      BSB as provided by the financial institution.
    • BankAccountNumberString (20)
    • Account number as provided by the financial institution.
    • BankAccountNameString (32)
    • Bank account name setup.
    • CompanyTradingNameString (50)
    • ONLY APPLICABLE FOR AU REGION
      Company trading name if applicable for bank account
    • BankCodeString (3)
    • ONLY APPLICABLE FOR AU REGION
      Bank code as provided by the financial institution.
    • CreateBankFilesBoolean
    • True indicates the bank account will be used to create bank files (ABA).
      False indicates the bank account will not be used to create bank files.
    • DirectEntryUserIdString (6)
    • ONLY APPLICABLE FOR AU REGION
      Direct entry user id as provided by the financial institution.
    • IncludeSelfBalancingTransactionBoolean
    • ONLY APPLICABLE FOR AU REGION
      True indicates the bank account requires a self balancing transaction.
      False indicates the bank account does not require a self balancing transaction.
    • StatementParticularsString (12)
    • Statement particulars assigned to the bank account.
    • StatementCodeString
    • ONLY APPLICABLE FOR NZ REGION.
      Code attached to electronic payment.
    • StatementReferenceString
    • ONLY APPLICABLE FOR NZ REGION.
      Reference attached to electronic payment.
  • IsHeaderBoolean
  • True indicates the account is a header account.Header accounts are used to organise, group and subtotal accounts in the Accounts List and reports.
    False indicates the account is a detail account. Only detail accounts can be assigned to transactions.
  • LastReconciledDateDateTime
  • Shows the date that the Account was last reconciled. This will return as null if the Account has never been reconciled.
  • ForeignCurrency
  • Null if no foreign currency is set.
    • UIDGuid (36)
    • Foreign Key: Unique identifier for the currency in the form of a guid.
    • CodeString (3)
    • The currency code.
    • CurrencyNameString
    • The full name of the currency
    • URIString
    • Uniform resource identifier associated with the currency object.
  • LastModifiedDateTime
  • DateTime of the last time this resource was modified through a direct action to the object. eg a field was updated.
  • URIString
  • Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
  • RowVersionString
  • Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
    ONLY required for updating an existing account.
    NOT required when creating a new account.


Paging: default page size is set to 400 with a maximum of 1000 results.

Example json GET response

  • {
    • "UID" : "eb043b43-1d66-472b-a6ee-ad48def81b96",
    • "Name" : "Business Bank Account #2",
    • "DisplayID" : "1-1120",
    • "Classification" : "Asset",
    • "Type" : "Bank",
    • "Number" : 1120,
    • "Description" : "Bank account clearwtr",
    • "ParentAccount" : {
      • "UID" : "f5cc9506-3472-4227-8c45-7a95c322c38b",
      • "Name" : "Bank Accounts",
      • "DisplayID" : "1-1100",
      • "URI" : "{cf_uri}/GeneralLedger/Account/f5cc9506-3472-4227-8c45-7a95c322c38b"
      • },
    • "IsActive" : true,
    • "TaxCode" : {
      • "UID" : "94966872-b140-4da2-bc43-5dcd74f33a09",
      • "Code" : "N-T",
      • "URI" : "{cf_uri}/GeneralLedger/TaxCode/94966872-b140-4da2-bc43-5dcd74f33a09"
      • },
    • "Level" : 4,
    • "OpeningBalance" : 100000.00,
    • "CurrentBalance" : 5000.00,
    • "BankingDetails" : {
      • "BSBNumber" : "062-001",
      • "BankAccountNumber" : 123456789,
      • "BankAccountName" : "CLEARWATER PTY LTD",
      • "CompanyTradingName" : "CLEARWATER PTY LTD",
      • "BankCode" : "BNH",
      • "CreateBankFiles" : true,
      • "DirectEntryUserId" : "087176",
      • "IncludeSelfBalancingTransaction" : false,
      • "StatementParticulars" : ""
      • },
    • "IsHeader" : false,
    • "LastReconciledDate": "2018-11-30T00:00:00",
    • "ForeignCurrency" : {
      • "UID" : "9a925e0c-0a9c-4995-8e7e-d5d170231806",
      • "Code" : "CAD",
      • "CurrencyName" : "Canadian Dollars",
      • "URI" : "{cf_uri}/GeneralLedger/Currency/9a925e0c-0a9c-4995-8e7e-d5d170231806"
      • },
    • "LastModified" : "1753-01-01T00:00:00",
    • "URI" : "{cf_uri}/GeneralLedger/Account/eb043b43-1d66-472b-a6ee-ad48def81b96",
    • "RowVersion" : "5548997690873872384"
    • }
Hypermedia in the MYOB Business API

The {cf_uri} is provided by the Company File endpoint.

Read more about Hypermedia in the MYOB Business API in our best practice guide.