Global

Overview of end of year process for the prior years

get/sites/{site-identifier}/overview/end-of-year/summary

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/overview/end-of-year/summary
  • 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-typestring

The fund type of Fund

include-week-ago-amountboolean
Example:true
use-milestonesboolean
Example:true

Allow return summary EOY statuses as Workflow Milestone

Response

Success

CompletedTotal7Daysnumber

Example response

{
  "CompletedTotal7Days": 10,
  "EOYSummary": [
    {
      "FinancialYear": 2022,
      "Count": 1000,
      "Status": "Completed",
      "StatusGroup": "Completed"
    }
  ]
}

Changes

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