Global

Prefill a letter token query template

post/sites/{site-identifier}/query-templates/{query-template-guid}/prefill

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/query-templates/{query-template-guid}/prefill
  • 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-template-guidstring required
Example:e3c76443-8126-05b6-9914-c88c1ce84725

The GUID that identifies a specified query template

Request body

FundIdentifierstring required
FinYearnumber required
EffectiveDatestring date
MemberIdentifierstring
AccountNumberstring
MemberAccountGUIDstring guid

Example request

{
  "FundIdentifier": "FUNDCODE001",
  "FinYear": 2024,
  "EffectiveDate": "2023-06-30",
  "MemberIdentifier": "00003|GUID",
  "AccountNumber": "2900001",
  "MemberAccountGUID": "df7f1068-e0c3-709d-8a14-ac2af4b632f8"
}

Response

Success

TemplateNamestring
TemplateMessageTextstring
Entitystring
Subjectstring
HighPriorityboolean
DueDatestring
FirstReminderstring
ReminderFrequencystring

Example response

{
  "Entity": "Fund|Member|Pension|Account",
  "Subject": "string",
  "HighPriority": true,
  "DueDate": "2025-01-09",
  "FirstReminder": "2025-01-01",
  "ReminderFrequency": "FORTNIGHTLY"
}

Changes

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