---
title: "Create Settlement Details Report"
method: POST
path: "/reports/settlementDetails"
tags: ["Settlement Reports"]
---

# Create Settlement Details Report

`POST /reports/settlementDetails`

## Request

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

Schedules the creation of a Settlement Details Report.

Requires the `reports:Create` permission.

Please check our detailed guide on the report content and other considerations [here](https://docs.silverflow.com/guides/settlement-details-report).

## Request body

- CreateSettlementDetailsReportRequest: Create SettlementDetails Report
  - `parameters` union, required
    - SettlementDetailsReportByCreatedTimeParameters: The query parameters used for a report.
      - `createdFrom` string, date-time, required: Include only items that have a created date greater than or equal to the specified date
      - `createdTo` string, date-time: Include only items that have a created date less than or equal to the specified date
    - SettlementDetailsReportByNftKeyParameters: The query parameters used for a report.
      - `networkFundsTransferKey` string, required: Uniquely identifies a Networks Funds Transfer
  - `mimeType` 'text/csv' | 'application/x-ndjson', required: The mime-type in which the SettlementDetails report is available.
  - `reference` string: Unique ID used to identify a report.
  - `distributions` DistributionKey[]: The distribution objects' keys. If passed, the report will be distributed when generation is completed.

## Response `201`

The scheduled Settlement Details Report

- CreateSettlementDetailsReportResponse
  - `reportName` 'SettlementDetails', required: The name of the report.
  - `parameters` union, required
    - SettlementDetailsReportByCreatedTimeParameters: The query parameters used for a report.
      - `createdFrom` string, date-time, required: Include only items that have a created date greater than or equal to the specified date
      - `createdTo` string, date-time: Include only items that have a created date less than or equal to the specified date
    - SettlementDetailsReportByNftKeyParameters: The query parameters used for a report.
      - `networkFundsTransferKey` string, required: Uniquely identifies a Networks Funds Transfer
  - `mimeType` 'text/csv' | 'application/x-ndjson', required: The mime-type in which the SettlementDetails 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)