Funds

Default

Where this endpoint is requested without any parameters the default response will provide the list of funds that are available to the audit user for the financial year preceding the current date. For example: if current date is 30/6/2019 this would return funds available to the audit user for the 2018 year. If the request was made 1/7/2019 it would return funds for the 2019 year.

Financial-year (yyyy)

To identify funds that the audit user is associated to use the financial-year parameter.

Example: /sites/{site-identifier}/funds?financial-year=2017

This will provide the list of funds for the nominated year.

Audit-Status (list)

By default, this endpoint provides the audit status of all funds accessible to the audit user. In order to identify a list of funds with particular status use the audit-status parameter.

Validate statuses to request are:

Value, Description <br> NOT_READY, Not ready for Audit <br> READY_FOR_AUDIT, Ready for Audit <br> AT_AUDIT, At Audit <br> WAITING, Audit Waiting <br> COMPLETE_QUALIFIED, Completed - Qualified <br> COMPLETE_NOT_QUALIFIED, Completed - Not Qualified

Example: /sites/{site-identifier}/funds?audit-status= READY_FOR_AUDIT

These parameters can be used in conjunction if you are looking the audit status of a particular year and status:

Example: /sites/{site-identifier}/funds?audit-status= READY_FOR_AUDIT& financial-year=2017 <BR><BR> Status (string) <BR> active (default)<br>deactivated<br>all<BR><BR> Passing a status will allow you to filter on a fund based on the fund status. <BR><BR> Example: /sites/{site-identifier}/funds?status=deactivated

get/sites/{site-identifier}/funds

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/funds
  • 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: default, fund_read)

Path parameters

site-identifierstring required

The GUID that identifies a site

Query parameters

financial-yearnumber

Financial year of a fund

audit-statusstring

Audit status of a fund

statusstring
Example:active

Status of fund

flatstring

Change the Tags and CustomTags objects to a pipe delimited field of these values.

Response

Success

FundGUIDstring guid
FundCodestring
FundNamestring
FundTypestring
FundValuenumber
ABNstring
CurrentPeriodEndDatestring date
AuditStatus'NOT_READY' | 'READY_FOR_AUDIT' | 'AT_AUDIT' | 'WAITING' | 'INITIAL_AUDIT_COMPLETED' | 'COMPLETED' | 'COMPLETE_QUALIFIED' | 'COMPLETE_NOT_QUALIFIED'
FinancialYearinteger
CurrentFinancialYearinteger
Activeboolean
Statusstring
StatusCodestring
ActivateDateTimestring date-time
DeactivatedDateTimestring date-time
ServiceCategorystring
AdviserGUIDstring guid
ComplyingStatusCode'REGISTERED' | 'COMPLYING' | 'NON-COMPLYING' | 'REGULATION-DETAILS-WITHHELD' | 'REGULATION-DETAILS-REMOVED' | 'PENDING'
Div296ElectionMethod'ADJUST' | 'DO-NOT-ADJUST'

Example response

[
  {
    "FundValue": 230076.43,
    "Status": "Current Administration",
    "StatusCode": "CURRENT",
    "Tags": [
      "Pension"
    ],
    "CustomTags": [
      "Foo"
    ],
    "ServiceCategory": "ANNUAL",
    "AdviserGUID": "9a6ce773-5011-308e-7914-73d18ced3493"
  }
]

Changes

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