Retrieves cashflow transaction data
get
/service/v1/nested/cashflowForecasting
This endpoint is used to retrieve the cashflow grouped / individual data for given set of parameters.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
aggregationLevel: string
Aggregation Level
-
bankAccount: string
Bank Account
-
ccy: string
Currency
-
code(required): string
Code
-
corporateId: string
CorporateId
-
counterParty: string
Counter Party
-
frequency: string
Frequency
-
fromDate: string
From Date for Cashflow Details in dd-MM-yyyy format
-
limit: integer
Limit is maximum no of records to be fetched
-
offset: integer
Offset is starting no of records to be fetched
-
toDate: string
To Date for Cashflow Details in dd-MM-yyyy format
-
virtualAccount: string
Virtual Account
Header Parameters
-
appId(required): string
Application Id
-
branchCode(required): string
Branch Code
-
userId(required): string
User Id
Response
Supported Media Types
- application/json
- application/xml
200 Response
Successful performs the operation
Root Schema : CashflowForecastingResponseWrapper
Type:
object
Cashflow Forecasting response wrapper
Show Source
-
agrregationCategory:
string
Agrregation Category
-
branchCcy:
string
Branch ccy
-
cashflows:
array cashflows
-
code:
string
Code
-
errorCode:
string
Error Code
-
errorDesc:
string
Error Desc
-
frequency:
string
frequency
-
paging:
object PagingDto
-
partyId:
string
Party Id
-
responseStatus:
string
Response Status
-
summaryRequired:
string
Summary Required
Nested Schema : cashflows
Type:
Show Source
array
-
Array of:
object CashflowForecastingResponse
Cashflow Forecasting Response model
Nested Schema : CashflowForecastingResponse
Type:
object
Cashflow Forecasting Response model
Show Source
-
actualCashflowAmt:
string
Actual cashflow Amount
-
aggCategory:
string
Agg Category
-
cashflowAmount:
string
Cashflow Amount
-
cashflowDate:
string
CashflowDate
-
cashflowDescription:
string
Cashflow Code Description
-
category:
string
Category
-
countOfInflows:
number
Count of Inflows
-
countOfOutflows:
number
Count of Outflows
-
endOfWeek:
string
End Of Week
-
inflowAmount:
string
Inflow Amount
-
month:
string
Month
-
netUnpaidAmount:
string
Net Unpaid Amount
-
outflowAmount:
string
Outflow Amount
-
predCountOfInflows:
number
Predicted Count of Inflows
-
predCountOfOutflows:
number
Predicted Count of Outflows
-
predInflowAmount:
string
Predicted Inflow Amount
-
predNetCashflowAmount:
string
Net Predicted Cashflow Amount
-
predNetCountOfCashflows:
number
Predicted Net Count of Cashflows
-
predOutflowAmount:
string
Predicted Outflow Amount
-
qtrMonth:
string
Quarter Month
-
quarter:
string
Quarter
-
reconciledInflowAmount:
string
Reconciled Inflow Amount
-
reconciledOutflowAmount:
string
Reconciled Outflow Amount
-
remark:
string
Remark
-
startOfWeek:
string
Start Of Week
-
totalActualInflow:
string
Total Actual Inflow Amount
-
totalActualOutflow:
string
Total Actual Outflow Amount
-
unpaidCount:
number
Unpaid Count
-
unPaidInflowAmount:
string
Unpaid Inflow Amount
-
unPaidInflowCount:
string
Unpaid Inflow Count
-
unPaidOutflowAmount:
string
Unpaid Outflow Amount
-
unPaidOutflowCount:
string
Unpaid Outflow Count
-
weekNo:
string
Week
-
year:
string
Year
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
406 Response
File is not configured.
500 Response
Internal error