SIsilverflow
Settlement Reports

Create Settlement Details Report

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.

post/reports/settlementDetails

Request

Request body

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

The mime-type in which the SettlementDetails report is available.

referencestring

Unique ID used to identify a report.

distributionsDistributionKey[]

The distribution objects' keys.

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

Example request

{
  "parameters": {
    "networkFundsTransferKey": "nft-1e1dAHhgstYTUhlphPzZ"
  },
  "distributions": [
    "dst-1e1dAHhgstYTUhlphPzZ"
  ]
}

Response

The scheduled Settlement Details Report

reportName'SettlementDetails' required

The name of the report.

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

The mime-type in which the SettlementDetails 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

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

Changes

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