Reports

<b>BETA:</b> Return the report suite instance detail that were selected as part of “Generate for Later” from the EOY Close

get/sites/{site-identifier}/funds/{fund-identifier}/report-suites/instances/{report-suite-instance-GUID}

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}/report-suites/instances/{report-suite-instance-GUID}
  • 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

report-suite-instance-GUIDstring required

The GUID that identifies a report suite instance

Response

Success

ReportSuiteGUIDstring
ReportSuiteInstanceGUIDstring
ReportSuiteCodestring
CreatedDateTimestring date-time
Status'CREATED' | 'SUBMITTED' | 'GENERATING' | 'COMPLETE' | 'ERROR'

Example response

{
  "ReportSuiteGUID": "ef1f02ff-738e-4bbd-8214-fbe4742d70e0",
  "ReportSuiteInstanceGUID": "ef1f02ff-738e-4bbd-8214-fbe4742d70e1",
  "ReportSuiteCode": "RRCODE",
  "CreatedDateTime": "2020-03-24T15:55:52.679+07:00",
  "Contents": [
    {
      "ReportSuiteInstanceContentGUID": "ff1f02ff-738e-4bbd-8214-fbe4742d70e1",
      "ContentOrder": 1,
      "ContentCode": "ACTUARIAL-CERTIFICATE",
      "ContentName": "Actuarial Certificates",
      "Permissions": [
        "clear"
      ]
    }
  ]
}

Changes

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