SIsilverflow
Scheme Fee Reports

Create Scheme Fee Details Report

Schedules the creation of a Scheme Fee Details Report.

When using book dates, take into account the following:

  • In case no bookDateTo is specified, we use the current date-time.
  • The book date range cannot exceed one week.

Requires the reports:CreateSchemeFeeDetails permission.

Please check our detailed guide on the report content and other considerations here.

post/reports/schemeFeeDetails

Request

Request body

referencestring

Unique ID used to identify a report.

mimeType'application/json' | 'application/x-ndjson' | 'text/csv' required

The mime-type in which the scheme fee details report is available.

distributionsDistributionKey[]

The distribution objects' keys.

If passed, the report will be distributed when generation is completed.

Example request

{
  "distributions": [
    "dst-1e1dAHhgstYTUhlphPzZ"
  ]
}

Response

The scheduled Scheme Fee Details Report

reportName'SchemeFeeDetails' required

The name of the report.

mimeType'application/json' | 'application/x-ndjson' | 'text/csv' required

The mime-type in which the scheme fee details report is available.

keystring required

Uniquely identifies a report object

agentKeystring required

Uniquely identifies an Agent

referencestring

Unique ID used to identify a report.

status'scheduled' required

The status of the report.

createdstring date-time required

The date and time this object was created

distributionsDistributionKey[]

The distribution objects' keys.

If passed, the report will be distributed when generation is completed.

Example response

{
  "key": "rep-1e1dAHhgstYTUhlphPzZ",
  "agentKey": "cgt-1UF2NafdfrdPMf2XrS2",
  "distributions": [
    "dst-1e1dAHhgstYTUhlphPzZ"
  ]
}

Changes

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