POST api/Subcontracts/{subcontractId}/PlannedPayment/Version/{plannedPaymentListVersionId}/GenerateInitialCashflow/Preview

Generate initial cashflow preview

Request Information

URI Parameters

Name	Description	Type	Additional information
subcontractId		integer	Required
plannedPaymentListVersionId		integer	Required

Body Parameters

PlannedPaymentListGenerateInitialDto

Name	Type	Additional information
CashflowCurveTypeId	CashflowCurveTypeId	None.
AppliesAdvancePayment	boolean	None.
AdvancePaymentAmount	decimal number	None.
DownPaymentCalculationMethodId	DownPaymentCalculationMethodId	None.
RecoveryPercentage	decimal number	None.
RecoveryDurationMonths	decimal number	None.

Request Formats

application/json, text/json

Sample:

{
  "cashflowCurveTypeId": 1,
  "appliesAdvancePayment": true,
  "advancePaymentAmount": 1.0,
  "downPaymentCalculationMethodId": 1,
  "recoveryPercentage": 1.0,
  "recoveryDurationMonths": 1.0
}

text/html

Sample:

{"cashflowCurveTypeId":1,"appliesAdvancePayment":true,"advancePaymentAmount":1.0,"downPaymentCalculationMethodId":1,"recoveryPercentage":1.0,"recoveryDurationMonths":1.0}

application/xml, text/xml

Sample:

<PlannedPaymentListGenerateInitialDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.Dtos.Dtos.PlannedPaymentAgg">
  <AdvancePaymentAmount>1</AdvancePaymentAmount>
  <AppliesAdvancePayment>true</AppliesAdvancePayment>
  <CashflowCurveTypeId>Vertical</CashflowCurveTypeId>
  <DownPaymentCalculationMethodId>MonthlyProgress</DownPaymentCalculationMethodId>
  <RecoveryDurationMonths>1</RecoveryDurationMonths>
  <RecoveryPercentage>1</RecoveryPercentage>
</PlannedPaymentListGenerateInitialDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiDataResultOfGenerateInitialCashflowPreviewDto

Name	Type	Additional information
Data	GenerateInitialCashflowPreviewDto	None.
Success	boolean	None.
Message	string	None.
Errors	Collection of CustomError	None.
Warnings	Collection of string	None.

Response Formats

application/json, text/json, text/html

Sample:

Sample not available.