POST api/Investor/v1/GetInvestmentReport
Request Information
URI Parameters
None.
Body Parameters
GetInvestmentReportRequestName | Description | Type | Additional information |
---|---|---|---|
customerId |
Unique identifier of customer. |
globally unique identifier |
None. |
transactionCount |
Transaction Count. |
integer |
None. |
investementStartDateBegin |
Starting date for report filtering. |
date |
None. |
investmentStartDateEnd |
End date for report filtering. |
date |
None. |
OrganizationCode | string |
None. |
|
UserName | string |
None. |
|
Password | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "customerId": "0318138c-b037-4572-9bf3-fc25341bee0d", "transactionCount": 1, "investementStartDateBegin": "2025-09-02T16:13:19.2504001+00:00", "investmentStartDateEnd": "2025-09-02T16:13:19.2504001+00:00", "OrganizationCode": "sample string 2", "UserName": "sample string 3", "Password": "sample string 4" }
application/xml, text/xml
Sample:
<GetInvestmentReportRequest 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>0318138c-b037-4572-9bf3-fc25341bee0d</customerId> <investementStartDateBegin>2025-09-02T16:13:19.2504001+00:00</investementStartDateBegin> <investmentStartDateEnd>2025-09-02T16:13:19.2504001+00:00</investmentStartDateEnd> <transactionCount>1</transactionCount> </GetInvestmentReportRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
GetInvestmentReportReplyName | Description | Type | Additional information |
---|---|---|---|
Reply |
None. |
Response Formats
application/json, text/json
Sample:
{ "Reply": { "LoanAllocations": [ { "Id": "128a0f60-1bf6-4c8b-b033-0a9198ea3a22", "BorrowerId": "f824d64a-dd14-4661-9e0a-b17b99a32ba5", "CreditApplicationId": "cb938eaf-4d9a-4583-85df-7b6690c83b38", "LoanId": "34a9c91e-f01c-4713-b184-530355e60991", "LoanCurrencyCode": "sample string 4", "InvestmentCurrencyCode": "sample string 5", "MarketCode": "sample string 6", "LoanAmount": 1.0, "LoanNumber": "sample string 7", "InstallmentCount": 1, "LoanOpeningDate": "2025-09-02T16:13:19.2504001+00:00", "RiskClass": 8, "InterestRate": 9.0, "LoanInterestRate": 10.0, "AllocationTime": "2025-09-02T16:13:19.2504001+00:00", "PurchaseDate": "2025-09-02T16:13:19.2504001+00:00", "PurchasePrice": 1.0, "SellDate": "2025-09-02T16:13:19.2504001+00:00", "SellPrice": 1.0, "SellFee": 1.0, "LoanInstallmentAmount": 1.0, "LoanEndDate": "2025-09-02T16:13:19.2504001+00:00", "LastLoanPaymentDate": "2025-09-02T16:13:19.2504001+00:00", "TerminationDate": "2025-09-02T16:13:19.2504001+00:00", "RealizationDate": "2025-09-02T16:13:19.2504001+00:00", "CapitalInReportingCurrency": 12.0, "CapitalReceivableInReportingCurrency": 13.0, "CapitalReceivedInReportingCurrency": 14.0, "CapitalDueInReportingCurrency": 15.0, "InterestReceivableInReportingCurrency": 16.0, "InterestReceivedInReportingCurrency": 17.0, "InterestDueInReportingCurrency": 18.0, "PaidInstallmentCount": 19, "PaymentDelayInDays": 20, "CreditLossProvisionRate": 21.0, "RealizedCreditLossInReportingCurrency": 22.0, "CreditLossProvisionInReportingCurrency": 23.0, "InvestmentInReportingCurrency": 24.0, "RevenueInReportingCurrency": 25.0, "FeeInReportingCurrency": 26.0, "RealizedProfitInReportingCurrency": 27.0, "SellCapitalInReportingCurrency": 28.0, "SellTotalInReportingCurrency": 29.0, "PurchaseCapitalInReportingCurrency": 30.0, "PurchaseTotalInReportingCurrency": 31.0, "InvestmentStartDate": "2025-09-02T16:13:19.2504001+00:00", "InvestmentEndDate": "2025-09-02T16:13:19.2504001+00:00", "CapitalUnsettledInReportingCurrency": 33.0, "CapitalUnsettledInInvestmentCurrency": 34.0, "OriginalInstallmentCount": 35, "CompanySectorCode": "sample string 36", "CompanySectorName": "sample string 37", "CompanyCountryCode": "sample string 38", "NextDueDate": "2025-09-02T16:13:19.2504001+00:00", "FirstUnpaidDueDate": "2025-09-02T16:13:19.2504001+00:00", "FirstUnpaidInstallmentOrder": 1, "DueInstallmentCount": 1, "LoanInstallmentAmountInReportingCurrency": 1.0, "BorrowerName": "sample string 39", "BorrowerSsnBic": "sample string 40", "BorrowerNumber": "sample string 41", "CompanyLoanPurposeEnum": 0, "EducationLevelEnum": 0, "MaritalStatusEnum": 0, "PurposeEnum": 0, "NumberOfChildrenInHousehold": 42, "NumberOfAdultsInHousehold": 43, "BusinessTypeEnum": 0, "EmploymentStatusEnum": 0, "BorrowerAge": 44, "EmploymentStartDate": "2025-09-02T16:13:19.2504001+00:00", "VerifiedGrossIncomePerMonth": 45.0, "GenderEnum": 0, "NativeLanguageEnum": 0, "CreditTypeEnum": 0, "CollectionStateEnum": 0, "CollectionStatePublicDescription": "sample string 46", "LastSettlementDate": "2025-09-02T16:13:19.2504001+00:00" }, { "Id": "128a0f60-1bf6-4c8b-b033-0a9198ea3a22", "BorrowerId": "f824d64a-dd14-4661-9e0a-b17b99a32ba5", "CreditApplicationId": "cb938eaf-4d9a-4583-85df-7b6690c83b38", "LoanId": "34a9c91e-f01c-4713-b184-530355e60991", "LoanCurrencyCode": "sample string 4", "InvestmentCurrencyCode": "sample string 5", "MarketCode": "sample string 6", "LoanAmount": 1.0, "LoanNumber": "sample string 7", "InstallmentCount": 1, "LoanOpeningDate": "2025-09-02T16:13:19.2504001+00:00", "RiskClass": 8, "InterestRate": 9.0, "LoanInterestRate": 10.0, "AllocationTime": "2025-09-02T16:13:19.2504001+00:00", "PurchaseDate": "2025-09-02T16:13:19.2504001+00:00", "PurchasePrice": 1.0, "SellDate": "2025-09-02T16:13:19.2504001+00:00", "SellPrice": 1.0, "SellFee": 1.0, "LoanInstallmentAmount": 1.0, "LoanEndDate": "2025-09-02T16:13:19.2504001+00:00", "LastLoanPaymentDate": "2025-09-02T16:13:19.2504001+00:00", "TerminationDate": "2025-09-02T16:13:19.2504001+00:00", "RealizationDate": "2025-09-02T16:13:19.2504001+00:00", "CapitalInReportingCurrency": 12.0, "CapitalReceivableInReportingCurrency": 13.0, "CapitalReceivedInReportingCurrency": 14.0, "CapitalDueInReportingCurrency": 15.0, "InterestReceivableInReportingCurrency": 16.0, "InterestReceivedInReportingCurrency": 17.0, "InterestDueInReportingCurrency": 18.0, "PaidInstallmentCount": 19, "PaymentDelayInDays": 20, "CreditLossProvisionRate": 21.0, "RealizedCreditLossInReportingCurrency": 22.0, "CreditLossProvisionInReportingCurrency": 23.0, "InvestmentInReportingCurrency": 24.0, "RevenueInReportingCurrency": 25.0, "FeeInReportingCurrency": 26.0, "RealizedProfitInReportingCurrency": 27.0, "SellCapitalInReportingCurrency": 28.0, "SellTotalInReportingCurrency": 29.0, "PurchaseCapitalInReportingCurrency": 30.0, "PurchaseTotalInReportingCurrency": 31.0, "InvestmentStartDate": "2025-09-02T16:13:19.2504001+00:00", "InvestmentEndDate": "2025-09-02T16:13:19.2504001+00:00", "CapitalUnsettledInReportingCurrency": 33.0, "CapitalUnsettledInInvestmentCurrency": 34.0, "OriginalInstallmentCount": 35, "CompanySectorCode": "sample string 36", "CompanySectorName": "sample string 37", "CompanyCountryCode": "sample string 38", "NextDueDate": "2025-09-02T16:13:19.2504001+00:00", "FirstUnpaidDueDate": "2025-09-02T16:13:19.2504001+00:00", "FirstUnpaidInstallmentOrder": 1, "DueInstallmentCount": 1, "LoanInstallmentAmountInReportingCurrency": 1.0, "BorrowerName": "sample string 39", "BorrowerSsnBic": "sample string 40", "BorrowerNumber": "sample string 41", "CompanyLoanPurposeEnum": 0, "EducationLevelEnum": 0, "MaritalStatusEnum": 0, "PurposeEnum": 0, "NumberOfChildrenInHousehold": 42, "NumberOfAdultsInHousehold": 43, "BusinessTypeEnum": 0, "EmploymentStatusEnum": 0, "BorrowerAge": 44, "EmploymentStartDate": "2025-09-02T16:13:19.2504001+00:00", "VerifiedGrossIncomePerMonth": 45.0, "GenderEnum": 0, "NativeLanguageEnum": 0, "CreditTypeEnum": 0, "CollectionStateEnum": 0, "CollectionStatePublicDescription": "sample string 46", "LastSettlementDate": "2025-09-02T16:13:19.2504001+00:00" } ] }, "Ok": true, "ErrorMessage": "sample string 2", "ErrorCode": "sample string 3", "Message": "sample string 4" }
application/xml, text/xml
Sample:
<GetInvestmentReportReply 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> <LoanAllocations> <LoanAllocation> <AllocationTime>2025-09-02T16:13:19.2504001+00:00</AllocationTime> <BorrowerAge>44</BorrowerAge> <BorrowerId>f824d64a-dd14-4661-9e0a-b17b99a32ba5</BorrowerId> <BorrowerName>sample string 39</BorrowerName> <BorrowerNumber>sample string 41</BorrowerNumber> <BorrowerSsnBic>sample string 40</BorrowerSsnBic> <BusinessTypeEnum>NULL</BusinessTypeEnum> <CapitalDueInReportingCurrency>15</CapitalDueInReportingCurrency> <CapitalInReportingCurrency>12</CapitalInReportingCurrency> <CapitalReceivableInReportingCurrency>13</CapitalReceivableInReportingCurrency> <CapitalReceivedInReportingCurrency>14</CapitalReceivedInReportingCurrency> <CapitalUnsettledInInvestmentCurrency>34</CapitalUnsettledInInvestmentCurrency> <CapitalUnsettledInReportingCurrency>33</CapitalUnsettledInReportingCurrency> <CollectionStateEnum>NULL</CollectionStateEnum> <CollectionStatePublicDescription>sample string 46</CollectionStatePublicDescription> <CompanyCountryCode>sample string 38</CompanyCountryCode> <CompanyLoanPurposeEnum>NULL</CompanyLoanPurposeEnum> <CompanySectorCode>sample string 36</CompanySectorCode> <CompanySectorName>sample string 37</CompanySectorName> <CreditApplicationId>cb938eaf-4d9a-4583-85df-7b6690c83b38</CreditApplicationId> <CreditLossProvisionInReportingCurrency>23</CreditLossProvisionInReportingCurrency> <CreditLossProvisionRate>21</CreditLossProvisionRate> <CreditTypeEnum>NULL</CreditTypeEnum> <DueInstallmentCount>1</DueInstallmentCount> <EducationLevelEnum>NULL</EducationLevelEnum> <EmploymentStartDate>2025-09-02T16:13:19.2504001+00:00</EmploymentStartDate> <EmploymentStatusEnum>NULL</EmploymentStatusEnum> <FeeInReportingCurrency>26</FeeInReportingCurrency> <FirstUnpaidDueDate>2025-09-02T16:13:19.2504001+00:00</FirstUnpaidDueDate> <FirstUnpaidInstallmentOrder>1</FirstUnpaidInstallmentOrder> <GenderEnum>NULL</GenderEnum> <Id>128a0f60-1bf6-4c8b-b033-0a9198ea3a22</Id> <InstallmentCount>1</InstallmentCount> <InterestDueInReportingCurrency>18</InterestDueInReportingCurrency> <InterestRate>9</InterestRate> <InterestReceivableInReportingCurrency>16</InterestReceivableInReportingCurrency> <InterestReceivedInReportingCurrency>17</InterestReceivedInReportingCurrency> <InvestmentCurrencyCode>sample string 5</InvestmentCurrencyCode> <InvestmentEndDate>2025-09-02T16:13:19.2504001+00:00</InvestmentEndDate> <InvestmentInReportingCurrency>24</InvestmentInReportingCurrency> <InvestmentStartDate>2025-09-02T16:13:19.2504001+00:00</InvestmentStartDate> <LastLoanPaymentDate>2025-09-02T16:13:19.2504001+00:00</LastLoanPaymentDate> <LastSettlementDate>2025-09-02T16:13:19.2504001+00:00</LastSettlementDate> <LoanAmount>1</LoanAmount> <LoanCurrencyCode>sample string 4</LoanCurrencyCode> <LoanEndDate>2025-09-02T16:13:19.2504001+00:00</LoanEndDate> <LoanId>34a9c91e-f01c-4713-b184-530355e60991</LoanId> <LoanInstallmentAmount>1</LoanInstallmentAmount> <LoanInstallmentAmountInReportingCurrency>1</LoanInstallmentAmountInReportingCurrency> <LoanInterestRate>10</LoanInterestRate> <LoanNumber>sample string 7</LoanNumber> <LoanOpeningDate>2025-09-02T16:13:19.2504001+00:00</LoanOpeningDate> <MaritalStatusEnum>NULL</MaritalStatusEnum> <MarketCode>sample string 6</MarketCode> <NativeLanguageEnum>NULL</NativeLanguageEnum> <NextDueDate>2025-09-02T16:13:19.2504001+00:00</NextDueDate> <NumberOfAdultsInHousehold>43</NumberOfAdultsInHousehold> <NumberOfChildrenInHousehold>42</NumberOfChildrenInHousehold> <OriginalInstallmentCount>35</OriginalInstallmentCount> <PaidInstallmentCount>19</PaidInstallmentCount> <PaymentDelayInDays>20</PaymentDelayInDays> <PurchaseCapitalInReportingCurrency>30</PurchaseCapitalInReportingCurrency> <PurchaseDate>2025-09-02T16:13:19.2504001+00:00</PurchaseDate> <PurchasePrice>1</PurchasePrice> <PurchaseTotalInReportingCurrency>31</PurchaseTotalInReportingCurrency> <PurposeEnum>NULL</PurposeEnum> <RealizationDate>2025-09-02T16:13:19.2504001+00:00</RealizationDate> <RealizedCreditLossInReportingCurrency>22</RealizedCreditLossInReportingCurrency> <RealizedProfitInReportingCurrency>27</RealizedProfitInReportingCurrency> <RevenueInReportingCurrency>25</RevenueInReportingCurrency> <RiskClass>8</RiskClass> <SellCapitalInReportingCurrency>28</SellCapitalInReportingCurrency> <SellDate>2025-09-02T16:13:19.2504001+00:00</SellDate> <SellFee>1</SellFee> <SellPrice>1</SellPrice> <SellTotalInReportingCurrency>29</SellTotalInReportingCurrency> <TerminationDate>2025-09-02T16:13:19.2504001+00:00</TerminationDate> <VerifiedGrossIncomePerMonth>45</VerifiedGrossIncomePerMonth> </LoanAllocation> <LoanAllocation> <AllocationTime>2025-09-02T16:13:19.2504001+00:00</AllocationTime> <BorrowerAge>44</BorrowerAge> <BorrowerId>f824d64a-dd14-4661-9e0a-b17b99a32ba5</BorrowerId> <BorrowerName>sample string 39</BorrowerName> <BorrowerNumber>sample string 41</BorrowerNumber> <BorrowerSsnBic>sample string 40</BorrowerSsnBic> <BusinessTypeEnum>NULL</BusinessTypeEnum> <CapitalDueInReportingCurrency>15</CapitalDueInReportingCurrency> <CapitalInReportingCurrency>12</CapitalInReportingCurrency> <CapitalReceivableInReportingCurrency>13</CapitalReceivableInReportingCurrency> <CapitalReceivedInReportingCurrency>14</CapitalReceivedInReportingCurrency> <CapitalUnsettledInInvestmentCurrency>34</CapitalUnsettledInInvestmentCurrency> <CapitalUnsettledInReportingCurrency>33</CapitalUnsettledInReportingCurrency> <CollectionStateEnum>NULL</CollectionStateEnum> <CollectionStatePublicDescription>sample string 46</CollectionStatePublicDescription> <CompanyCountryCode>sample string 38</CompanyCountryCode> <CompanyLoanPurposeEnum>NULL</CompanyLoanPurposeEnum> <CompanySectorCode>sample string 36</CompanySectorCode> <CompanySectorName>sample string 37</CompanySectorName> <CreditApplicationId>cb938eaf-4d9a-4583-85df-7b6690c83b38</CreditApplicationId> <CreditLossProvisionInReportingCurrency>23</CreditLossProvisionInReportingCurrency> <CreditLossProvisionRate>21</CreditLossProvisionRate> <CreditTypeEnum>NULL</CreditTypeEnum> <DueInstallmentCount>1</DueInstallmentCount> <EducationLevelEnum>NULL</EducationLevelEnum> <EmploymentStartDate>2025-09-02T16:13:19.2504001+00:00</EmploymentStartDate> <EmploymentStatusEnum>NULL</EmploymentStatusEnum> <FeeInReportingCurrency>26</FeeInReportingCurrency> <FirstUnpaidDueDate>2025-09-02T16:13:19.2504001+00:00</FirstUnpaidDueDate> <FirstUnpaidInstallmentOrder>1</FirstUnpaidInstallmentOrder> <GenderEnum>NULL</GenderEnum> <Id>128a0f60-1bf6-4c8b-b033-0a9198ea3a22</Id> <InstallmentCount>1</InstallmentCount> <InterestDueInReportingCurrency>18</InterestDueInReportingCurrency> <InterestRate>9</InterestRate> <InterestReceivableInReportingCurrency>16</InterestReceivableInReportingCurrency> <InterestReceivedInReportingCurrency>17</InterestReceivedInReportingCurrency> <InvestmentCurrencyCode>sample string 5</InvestmentCurrencyCode> <InvestmentEndDate>2025-09-02T16:13:19.2504001+00:00</InvestmentEndDate> <InvestmentInReportingCurrency>24</InvestmentInReportingCurrency> <InvestmentStartDate>2025-09-02T16:13:19.2504001+00:00</InvestmentStartDate> <LastLoanPaymentDate>2025-09-02T16:13:19.2504001+00:00</LastLoanPaymentDate> <LastSettlementDate>2025-09-02T16:13:19.2504001+00:00</LastSettlementDate> <LoanAmount>1</LoanAmount> <LoanCurrencyCode>sample string 4</LoanCurrencyCode> <LoanEndDate>2025-09-02T16:13:19.2504001+00:00</LoanEndDate> <LoanId>34a9c91e-f01c-4713-b184-530355e60991</LoanId> <LoanInstallmentAmount>1</LoanInstallmentAmount> <LoanInstallmentAmountInReportingCurrency>1</LoanInstallmentAmountInReportingCurrency> <LoanInterestRate>10</LoanInterestRate> <LoanNumber>sample string 7</LoanNumber> <LoanOpeningDate>2025-09-02T16:13:19.2504001+00:00</LoanOpeningDate> <MaritalStatusEnum>NULL</MaritalStatusEnum> <MarketCode>sample string 6</MarketCode> <NativeLanguageEnum>NULL</NativeLanguageEnum> <NextDueDate>2025-09-02T16:13:19.2504001+00:00</NextDueDate> <NumberOfAdultsInHousehold>43</NumberOfAdultsInHousehold> <NumberOfChildrenInHousehold>42</NumberOfChildrenInHousehold> <OriginalInstallmentCount>35</OriginalInstallmentCount> <PaidInstallmentCount>19</PaidInstallmentCount> <PaymentDelayInDays>20</PaymentDelayInDays> <PurchaseCapitalInReportingCurrency>30</PurchaseCapitalInReportingCurrency> <PurchaseDate>2025-09-02T16:13:19.2504001+00:00</PurchaseDate> <PurchasePrice>1</PurchasePrice> <PurchaseTotalInReportingCurrency>31</PurchaseTotalInReportingCurrency> <PurposeEnum>NULL</PurposeEnum> <RealizationDate>2025-09-02T16:13:19.2504001+00:00</RealizationDate> <RealizedCreditLossInReportingCurrency>22</RealizedCreditLossInReportingCurrency> <RealizedProfitInReportingCurrency>27</RealizedProfitInReportingCurrency> <RevenueInReportingCurrency>25</RevenueInReportingCurrency> <RiskClass>8</RiskClass> <SellCapitalInReportingCurrency>28</SellCapitalInReportingCurrency> <SellDate>2025-09-02T16:13:19.2504001+00:00</SellDate> <SellFee>1</SellFee> <SellPrice>1</SellPrice> <SellTotalInReportingCurrency>29</SellTotalInReportingCurrency> <TerminationDate>2025-09-02T16:13:19.2504001+00:00</TerminationDate> <VerifiedGrossIncomePerMonth>45</VerifiedGrossIncomePerMonth> </LoanAllocation> </LoanAllocations> </Reply> </GetInvestmentReportReply>