POST api/Investor/v1/GetInvestmentSummaryReport

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
customerId	Unique identifier of customer.	globally unique identifier	None.
reportingDate	Reporting Date	date	None.
OrganizationCode		string	None.
UserName		string	None.
Password		string	None.

Request Formats

application/json, text/json

Sample:

{
  "customerId": "ed612706-a874-4d98-8516-f7461934728c",
  "reportingDate": "2025-05-01T21:47:48.1477082+00:00",
  "OrganizationCode": "sample string 2",
  "UserName": "sample string 3",
  "Password": "sample string 4"
}

application/xml, text/xml

Sample:

<GetInvestmentSummaryReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers.Investor">
  <OrganizationCode xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 2</OrganizationCode>
  <Password xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 4</Password>
  <UserName xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 3</UserName>
  <customerId>ed612706-a874-4d98-8516-f7461934728c</customerId>
  <reportingDate>2025-05-01T21:47:48.1477082+00:00</reportingDate>
</GetInvestmentSummaryReportRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'GetInvestmentSummaryReportRequest'.

Response Information

Resource Description

GetInvestmentSummaryReportReply

Name	Type	Additional information
Reply	InvestorSummaryReport	None.
Ok	boolean	None.
ErrorMessage	string	None.
ErrorCode	string	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Reply": {
    "ReportingDate": "2025-05-01T21:47:48.1477082+00:00",
    "CustomerId": "06b72a0f-700a-4fad-b15c-4957d41b0a79",
    "Deposits": 3.0,
    "Withdrawals": 4.0,
    "Bonuses": 5.0,
    "Fees": 6.0,
    "RealizedInterest": 7.0,
    "RealizedCreditLoss": 8.0,
    "RealizedSellProfit": 9.0,
    "Sells": 10.0,
    "Purchases": 11.0,
    "CapitalOpen": 12.0,
    "AccountBalance": 13.0
  },
  "Ok": true,
  "ErrorMessage": "sample string 2",
  "ErrorCode": "sample string 3",
  "Message": "sample string 4"
}

application/xml, text/xml

Sample:

<GetInvestmentSummaryReportReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers.Investor">
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 3</ErrorCode>
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 2</ErrorMessage>
  <Message xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 4</Message>
  <Ok xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">true</Ok>
  <Reply>
    <AccountBalance>13</AccountBalance>
    <Bonuses>5</Bonuses>
    <CapitalOpen>12</CapitalOpen>
    <CustomerId>06b72a0f-700a-4fad-b15c-4957d41b0a79</CustomerId>
    <Deposits>3</Deposits>
    <Fees>6</Fees>
    <Purchases>11</Purchases>
    <RealizedCreditLoss>8</RealizedCreditLoss>
    <RealizedInterest>7</RealizedInterest>
    <RealizedSellProfit>9</RealizedSellProfit>
    <ReportingDate>2025-05-01T21:47:48.1477082+00:00</ReportingDate>
    <Sells>10</Sells>
    <Withdrawals>4</Withdrawals>
  </Reply>
</GetInvestmentSummaryReportReply>