Global

Get site total super balances

get/sites/{site-identifier}/total-super-balances

Request

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

fund-codestring
Example:FundCode

Fund code to filter on

balance-type'CURRENT-BALANCE' | 'PRIOR-30JUNE-TSB'

The balance type

balance-minnumber
Example:1000000

The balance min

balance-maxnumber
Example:5000000

The balance max

list-identifierstring
Example:f40ed4cc-00dd-c798-d314-7893a8a948e6

The GUID or code of the fund list.

The json object representing the fund list definition.

Response

Success

FundCodestring
FundNamestring
MemberGUIDstring guid
MemberNamestring
DOBstring date
AccumulationBalancenumber double
PensionBalancenumber double
CurrentBalancenumber double
Prior30JuneTSBnumber double
IsPrior30JuneTsbIncompleteboolean

Example response

[
  {
    "FundCode": "VN_SMSF_WEB",
    "FundName": "VN Fund",
    "MemberGUID": "d4c47341-a13b-bcb8-8c14-f13fc0ded111",
    "MemberName": "Mai, Me (76)",
    "DOB": "2024-07-01",
    "AccumulationBalance": 500,
    "PensionBalance": 500,
    "CurrentBalance": 500,
    "Prior30JuneTSB": 500,
    "IsPrior30JuneTsbIncomplete": true
  }
]

Changes

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