Investments

Return funds and portfolios that hold a particular asset.

get/sites/{site-identifier}/investments/securities/balances

Request

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

Query parameters

securityidstring required
effective-datestring date

The effective date with format (yyyy-MM-dd). Default is the current date if not entered.

IncludeSoldInYearboolean

Include the asset hold at any point during the financial year of effective-date, i.e. not sold out before the start date of that financial year.

Response

Success

FundGUIDstring guid
FundCodestring
FundNamestring
InvestorReferenceGUIDstring guid
InvestorReferenceNumberstring
InvestorReferenceProductNamestring
AccountNumberstring
AccountNamestring
SecurityIDstring
Balancenumber
MarketValuenumber

Example response

[
  {
    "FundGUID": "e7eec8e2-87c2-04bb-8014-6934608e73f8",
    "FundCode": "SN_SMSF",
    "FundName": "Selena Fund",
    "InvestorReferenceGUID": "e7eec8e2-58sh-04bb-8014-uh5t608eoip0",
    "InvestorReferenceNumber": "X12345",
    "InvestorReferenceProductName": "ANZ Grow Wra",
    "AccountNumber": "2050001",
    "AccountName": "1300 Smiles Limited",
    "SecurityID": "ONT",
    "Balance": 100,
    "MarketValue": 360
  }
]

Changes

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