Reports

<b>BETA:</b> Returns the list of reports and their parameters.

get/sites/{site-identifier}/reports

Request

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

Response

Success

ReportDefinitionGUIDstring guid
Codestring
Descriptionstring
DateTypestring
AvailableOnWebboolean
CategoryCode'TAX' | 'INVESTMENT' | 'MEMBER' | 'FINANCIAL'
HelpTextstring

Example response

[
  {
    "ReportDefinitionGUID": "f23b36b4-7ae7-e8ac-7b14-8e7a64700926",
    "Code": "ACGT01",
    "Description": "Accrued Capital Gains",
    "DateType": "Year",
    "HelpText": "Lists all unrealised assets attracting capital gains tax and calculates the gain or loss if they were sold at the recorded market value.",
    "Parameters": [
      {
        "Name": "start-date",
        "Label": "Start Date",
        "Type": "DATE"
      }
    ]
  }
]

Changes

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