Chart

<b>BETA:</b> Get accounts from the master chart

get/sites/{site-identifier}/chart

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/chart
  • Auth: OAuth 2 (authorization code, authorization URL https://api.supermate.com.au/oauth/v1/authorize, token URL https://api.supermate.com.au/oauth/v1/token, scopes: actuarial_write, audit_read, audit_write, client_access_grant, contactevents_read, contactevents_write, default, documents_read, documents_write, fund:investments_read, fund:members_read, fund:members_write, fund:transactions_read, fund:transactions_write, fund_read, fund_write, security:domains_write, security:policies_write, security:users_invite, site:accounting-notes_write, site:asset-categories_write, site:auditor_write, site:branding_write, site:datafeed-config_write, site:identity_write, site:letters_write, site:policies_write, site:reporting_write, sites_read, superstream:config_write)

Path parameters

site-identifierstring required

The GUID that identifies a site

Query parameters

asset-structure'ACCUMULATED-DEPRECIATION' | 'CASH' | 'DEPRECIATING-ASSET' | 'DIRECT-PROPERTY' | 'FMIS' | 'LISTED-EQUITY' | 'LISTED-TRUST' | 'OTHER' | 'OTHER-ASSET' | 'OTHER-PROPERTY' | 'PLATFORM' | 'STAPLED-SECURITY' | 'TERM-DEPOSIT' | 'TRADITIONAL-SECURITY' | 'UNLISTED-EQUITY' | 'UNLISTED-TRUST' | 'WARRANT'

The asset structure.

searchstring

Search for account number and name of chart account.

AccountTypestring
Example:sundry-liability,other-asset

The account type represents the asset,revenue,sundry-liability,forfeited-revenue,forfeited-liabilities or other-asset class list to retrieve.

member-accountboolean
Example:true

The member account

simpleboolean
Example:true

When simple = true then do not return the Settings object.

RevenueTypestring
Example:Dividend/Interest/Distrubution/Collectable/Rent/Foreign Income/Foreign Dividend

The revenue type for chart of accounts

allow-transactionsboolean
Example:true

When true, the response will exclude following accounts:

  • Master Clearing
  • Member opening balance
  • Current Period Surplus
  • 300 xxxx - * Settlement Pending
  • Property accounts that link to both Completed Purchase and Sale Settlement Worksheet
parent-accounts-onlyboolean
Example:true

When parent-accounts-only = true then only return parent accounts in the reponse

account-numberstring
Example:210,2100001

These will allow the caller to filter on a specific account number.

include-childrenboolean
Example:true

These will allow the caller to filter on a specific account number. E.g. GET /chart?account-number=209, and optionally all children accounts:

  • GET /chart?account-number=290 => return account 290
  • GET /chart?account-number=290&include-children=true => return all accounts starting with 290 (including The include-children option will only be honored if the account number provided is >= 3 digits long. No error will be raised if used with a shorter value (ie GET /chart?account-number=2&include-children=true will return an empty collection, as there are no accounts with that account number).
account-GUIDstring

The account with the specified GUID will be returned.

security-codestring

which will return accounts where the security-code matches the provided value exactly.

currencystring
Example:USD,AUD

Which will return accounts where the currency value matches the provided value. If this value is blank/not provided, the filter will not be applied

  • GET /sites/{site-identifier}/chart => error
  • GET /sites/{site-identifier}/chart?currency=AUD => error
  • GET /sites/{site-identifier}/chart?currency=USD => error
  • GET /sites/{site-identifier}/chart?currency=AUD&security-code=BHP => works
  • GET /sites/{site-identifier}/chart?currency=AUD&search=FOO => works

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.