Rest API for Oracle Banking Cash Management

Retrieves the actual and predicted Cashflows Data

get

/service/v1/cashflowSummary

This endpoint is used to retrieve the Actual and Predicted Cashflows Data based on given set of parameters.

Request

Supported Media Types

application/json
application/xml

Query Parameters

aggregationLevel: string

Aggregation Level
bankAccount: string

Bank Account
cashflowCode: string

CashFlow Code
cashflowType: string

CashFlow Type Either I or O
ccy: string

Currency
corporateId: string

Corporate Id
counterParty: string

Counter Party
frequency: string

Frequency
fromDate: string

From Date for Cashflow Details in dd-MM-yyyy format
limit(optional): integer

Limit is maximum no of records to be fetched
mlCashflowPredictedBase: string

Base on which search needs to be performed, P-Predicted, A-Actual(Default), B-Both
offset(optional): integer

Offset is starting no of records to be fetched
parentAggStatus: string

Parent Aggregate Status
summaryRequired: string

Summary Required
toDate: string

To Date for Cashflow Details in dd-MM-yyyy format
virtualAccount: string

Virtual Account

Header Parameters

appId: string

Application Id
branchCode: string

Branch Code
userId: 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(optional): string

Agrregation Category
branchCcy(optional): string

Branch ccy
cashflows(optional): array cashflows
code(optional): string

Code
errorCode(optional): string

Error Code
errorDesc(optional): string

Error Desc
frequency(optional): string

frequency
paging(optional): object PagingDto

Paging Dto
partyId(optional): string

Party Id
responseStatus(optional): string

Response Status
summaryRequired(optional): string

Summary Required

{
    "description":"Cashflow Forecasting response wrapper",
    "type":"object",
    "properties":{
        "responseStatus":{
            "description":"Response Status",
            "type":"string"
        },
        "partyId":{
            "description":"Party Id",
            "type":"string"
        },
        "branchCcy":{
            "description":"Branch ccy",
            "type":"string"
        },
        "agrregationCategory":{
            "description":"Agrregation Category",
            "type":"string"
        },
        "frequency":{
            "description":"frequency",
            "type":"string"
        },
        "code":{
            "description":"Code",
            "type":"string"
        },
        "errorCode":{
            "description":"Error Code",
            "type":"string"
        },
        "errorDesc":{
            "description":"Error Desc",
            "type":"string"
        },
        "summaryRequired":{
            "description":"Summary Required",
            "type":"string"
        },
        "cashflows":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CashflowForecastingResponse"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : cashflows

Type: array

Show Source

Array of: object CashflowForecastingResponse

Cashflow Forecasting Response model

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CashflowForecastingResponse"
    }
}

Nested Schema : PagingDto

Type: object

Paging Dto

Show Source

totalResults(optional): integer

Total Results

{
    "type":"object",
    "description":"Paging Dto",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"Total Results"
        }
    }
}

Nested Schema : CashflowForecastingResponse

Type: object

Cashflow Forecasting Response model

Show Source

actualCashflowAmt(optional): string

Actual cashflow Amount
aggCategory(optional): string

Agg Category
cashflowAmount(optional): string

Cashflow Amount
cashflowDate(optional): string

CashflowDate
cashflowDescription(optional): string

Cashflow Code Description
category(optional): string

Category
countOfInflows(optional): number

Count of Inflows
countOfOutflows(optional): number

Count of Outflows
endOfWeek(optional): string

End Of Week
inflowAmount(optional): string

Inflow Amount
month(optional): string

Month
netUnpaidAmount(optional): string

Net Unpaid Amount
outflowAmount(optional): string

Outflow Amount
predCountOfInflows(optional): number

Predicted Count of Inflows
predCountOfOutflows(optional): number

Predicted Count of Outflows
predInflowAmount(optional): string

Predicted Inflow Amount
predNetCashflowAmount(optional): string

Net Predicted Cashflow Amount
predNetCountOfCashflows(optional): number

Predicted Net Count of Cashflows
predOutflowAmount(optional): string

Predicted Outflow Amount
qtrMonth(optional): string

Quarter Month
quarter(optional): string

Quarter
reconciledInflowAmount(optional): string

Reconciled Inflow Amount
reconciledOutflowAmount(optional): string

Reconciled Outflow Amount
remark(optional): string

Remark
startOfWeek(optional): string

Start Of Week
totalActualInflow(optional): string

Total Actual Inflow Amount
totalActualOutflow(optional): string

Total Actual Outflow Amount
unpaidCount(optional): number

Unpaid Count
unPaidInflowAmount(optional): string

Unpaid Inflow Amount
unPaidInflowCount(optional): string

Unpaid Inflow Count
unPaidOutflowAmount(optional): string

Unpaid Outflow Amount
unPaidOutflowCount(optional): string

Unpaid Outflow Count
weekNo(optional): string

Week
year(optional): string

Year

{
    "description":"Cashflow Forecasting Response model",
    "type":"object",
    "properties":{
        "cashflowDate":{
            "description":"CashflowDate",
            "type":"string"
        },
        "month":{
            "description":"Month",
            "type":"string"
        },
        "quarter":{
            "description":"Quarter",
            "type":"string"
        },
        "year":{
            "description":"Year",
            "type":"string"
        },
        "weekNo":{
            "description":"Week",
            "type":"string"
        },
        "inflowAmount":{
            "description":"Inflow Amount",
            "type":"string"
        },
        "outflowAmount":{
            "description":"Outflow Amount",
            "type":"string"
        },
        "cashflowAmount":{
            "description":"Cashflow Amount",
            "type":"string"
        },
        "actualCashflowAmt":{
            "description":"Actual cashflow Amount",
            "type":"string"
        },
        "category":{
            "description":"Category",
            "type":"string"
        },
        "aggCategory":{
            "description":"Agg Category",
            "type":"string"
        },
        "cashflowDescription":{
            "description":"Cashflow Code Description",
            "type":"string"
        },
        "countOfInflows":{
            "description":"Count of Inflows",
            "type":"number"
        },
        "countOfOutflows":{
            "description":"Count of Outflows",
            "type":"number"
        },
        "netUnpaidAmount":{
            "description":"Net Unpaid Amount",
            "type":"string"
        },
        "unpaidCount":{
            "description":"Unpaid Count",
            "type":"number"
        },
        "totalActualInflow":{
            "description":"Total Actual Inflow Amount",
            "type":"string"
        },
        "totalActualOutflow":{
            "description":"Total Actual Outflow Amount",
            "type":"string"
        },
        "unPaidInflowAmount":{
            "description":"Unpaid Inflow Amount",
            "type":"string"
        },
        "unPaidOutflowAmount":{
            "description":"Unpaid Outflow Amount",
            "type":"string"
        },
        "unPaidInflowCount":{
            "description":"Unpaid Inflow Count",
            "type":"string"
        },
        "unPaidOutflowCount":{
            "description":"Unpaid Outflow Count",
            "type":"string"
        },
        "reconciledInflowAmount":{
            "description":"Reconciled Inflow Amount",
            "type":"string"
        },
        "reconciledOutflowAmount":{
            "description":"Reconciled Outflow Amount",
            "type":"string"
        },
        "qtrMonth":{
            "description":"Quarter Month",
            "type":"string"
        },
        "predInflowAmount":{
            "description":"Predicted Inflow Amount",
            "type":"string"
        },
        "predOutflowAmount":{
            "description":"Predicted Outflow Amount",
            "type":"string"
        },
        "predNetCashflowAmount":{
            "description":"Net Predicted Cashflow Amount",
            "type":"string"
        },
        "predCountOfInflows":{
            "description":"Predicted Count of Inflows",
            "type":"number"
        },
        "predCountOfOutflows":{
            "description":"Predicted Count of Outflows",
            "type":"number"
        },
        "predNetCountOfCashflows":{
            "description":"Predicted Net Count of Cashflows",
            "type":"number"
        },
        "remark":{
            "description":"Remark",
            "type":"string"
        },
        "startOfWeek":{
            "type":"string",
            "description":"Start Of Week"
        },
        "endOfWeek":{
            "type":"string",
            "description":"End Of Week"
        }
    }
}

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