Investments

Returns the list of holding balances for a particular chart number within the fund.

get/sites/{site-identifier}/funds/{fund-identifier}/investments/{account-number}/balances

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/funds/{fund-identifier}/investments/{account-number}/balances
  • 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

fund-identifierstring required

The GUID that identifies a fund

account-numberstring required

The account number.

Query parameters

effective-datestring

The effective date with format (yyyy-MM-dd)

Response

Success

ChartAccountGUIDstring
AccountNumberstring
SecurityIDstring
AccountDescriptionstring
AssetStructure'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'
  • ACCUMULATED-DEPRECIATION: Accumulated Depreciation - CASH: Cash - DEPRECIATING-ASSET: Depreciating Asset - DIRECT-PROPERTY: Property (Direct) - FMIS: Forestry Asset - LISTED-EQUITY: Equity (Listed) - LISTED-TRUST: Trust (Listed) - OTHER: Other - OTHER-ASSET: Other Investment Asset - OTHER-PROPERTY: Property (Other) - PLATFORM: Platform - STAPLED-SECURITY: Stapled Security - TERM-DEPOSIT: Term Deposit - TRADITIONAL-SECURITY: Traditional Security - UNLISTED-EQUITY: Equity (Unlisted) - UNLISTED-TRUST: Trust (Unlisted) - WARRANT: Warrant
AssetDescriptionstring
AccountBalancenumber float
Supplierstring
SuppliedBalancenumber float
SuppliedDatestring date
GroupCodestring

Example response

[
  {
    "ChartAccountGUID": "a900b5c6-5505-10b1-8c14-90480065dd03",
    "SecurityID": "AMP",
    "AccountDescription": "AMP Limited",
    "AssetDescription": "Accumulated Depreciation",
    "Supplier": "Computershare",
    "GroupCode": "AMP",
    "InvestorReference": {
      "InvestorReferenceGUID": "c791556a-bb05-7bae-8b14-881f289c129c",
      "InvestorReference": "HIN:X00012345678"
    },
    "SecondaryInvestorReference": {
      "InvestorReferenceGUID": "c791556a-bb05-7bae-8b14-881f289c129c",
      "InvestorReference": "HIN:X00012345678"
    }
  }
]

Changes

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