Letters

Generation of a letter for a fund.

post/sites/{site-identifier}/funds/{fund-identifier}/letters/{letter-guid}/generate

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}/letters/{letter-guid}/generate
  • 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

letter-guidstring guid required

The GUID that identifies a letter template

Request body

EffectiveDatestring date
ResponseDatestring date
RunForAllMembersboolean
MemberAccountGUIDstring
AddToDMSboolean
DocumentTypeCodestring
FileFormat'PDF' | 'DOC'

Example request

{
  "MemberAccountGUID": "c64a977c-5458-bb91-8a14-ae8f1c2e0976",
  "AddToDMS": true,
  "DocumentTypeCode": "DOC-1"
}

Response

Success

Changes

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