---
title: "Create Scheme Fee Details Report"
method: POST
path: "/reports/schemeFeeDetails"
tags: ["Scheme Fee Reports"]
---

# Create Scheme Fee Details Report

`POST /reports/schemeFeeDetails`

## Request

- Base URL: `https://eu-west-1.api.silverflow.com/v1`
- URL: `https://eu-west-1.api.silverflow.com/v1/reports/schemeFeeDetails`
- Auth: one of:
  - HTTP basic
  - HTTP bearer
- TypeScript: <https://skmtc.dev/silverflow/apis/silverflow-api/docs/reports/schemeFeeDetails/post.ts> (a function with typed inputs; its response is checked against the schema)

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](https://docs.silverflow.com/guides/scheme-fee-details-report).

## Request body

- CreateSchemeFeeDetailsReportRequest: Create Scheme Fee Details Report
  - `parameters` SchemeFeeDetailsReportParameters, required: The query parameters used for a report.
    - `bookDateFrom` string, date-time, required: Include all scheme fees that have been created later than and including from the date specified. Required when querying with book dates.
    - `bookDateTo` string, date-time: Include all scheme fees that have been created earlier than and including from the date specified.
  - `reference` string: 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.
  - `distributions` DistributionKey[]: The distribution objects' keys. If passed, the report will be distributed when generation is completed.

## Response `201`

The scheduled Scheme Fee Details Report

- CreateSchemeFeeDetailsReportResponse
  - `reportName` 'SchemeFeeDetails', required: The name of the report.
  - `parameters` SchemeFeeDetailsReportParameters, required: The query parameters used for a report.
    - `bookDateFrom` string, date-time, required: Include all scheme fees that have been created later than and including from the date specified. Required when querying with book dates.
    - `bookDateTo` string, date-time: Include all scheme fees that have been created earlier than and including from the date specified.
  - `mimeType` 'application/json' | 'application/x-ndjson' | 'text/csv', required: The mime-type in which the scheme fee details report is available.
  - `key` string, required: Uniquely identifies a report object
  - `agentKey` string, required: Uniquely identifies an Agent
  - `reference` string: Unique ID used to identify a report.
  - `status` 'scheduled', required: The status of the report.
  - `created` string, date-time, required: The date and time this object was created
  - `distributions` DistributionKey[]: The distribution objects' keys. If passed, the report will be distributed when generation is completed.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: The authenticated client is forbidden to make the request for the resource identified.
- `429`: The number of requests (per minute) has exceeded the configured maximum

---

[API](https://skmtc.dev/silverflow/apis/silverflow-api.md) - [All operations](https://skmtc.dev/silverflow/apis/silverflow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/silverflow/apis/silverflow-api/revisions/43ecbe4fd6ea?raw)