Reports

<b>BETA:</b> Create new report suite.

post/sites/{site-identifier}/report-suites

Request

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

Request body

Descriptionstring
FinancialYearnumber
EndOfYearDefaultboolean
ProductTypestring
EntityType'FUND' | 'CLIENT' | 'MEMBER'
EventTypeCodestring

Example request

{
  "Description": "New report suite description",
  "FinancialYear": 2020,
  "EndOfYearDefault": true,
  "ProductType": "SUPER-SAF/SUPER-SMSF/INVEST",
  "EventTypeCode": "END-YEAR-CLOSE-FINAL",
  "Contents": [
    {
      "Report": {
        "ReportCode": "ASSETALLOC"
      },
      "Order": 1,
      "Conditions": {
        "Criteria": [
          {
            "Order": 1,
            "FieldValue": "TAX-AGENT",
            "Operand": "DummyAuditor"
          }
        ]
      }
    }
  ],
  "Parameters": [
    {
      "Name": "include-all-other-assets",
      "Value": "yes"
    }
  ]
}

Response

Success

ReportSuiteGUIDstring guid

Example response

{
  "ReportSuiteGUID": "d4ff4c08-995e-d1aa-7b14-7aaab427aaf7"
}

Changes

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