Fetches the list of cashflow transactions
get
/obcm-cashflow-projection-services/service/v1/cashflow-maint/search
This endpoint is used to fetch the list of cashflow transactions based on given set of parameters.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
authStatus: string
Authentication Status
-
bankAccountNumber: string
Bank Account No
-
cashFlowCode: string
CashFlow Code Required
-
cashFlowType: string
Inflow or Outflow
-
ccy: string
Settlement Curency
-
channel: string
Channel
-
counterPartyId: string
Counter Party Id
-
customerRefNo: string
Customer Reference No
-
externalTransactionRefNo: string
External Reference No
-
forInquiry: string
For Inquiry Flag- Y/N
-
fromActualAmount: number
From Actual Amount
-
fromAmount: number
From Amount
-
fromDate: string
Start Date for Cashflow Details in yyyy-MM-dd format
-
limit: integer
Limit is maximum no of records to be fetched
-
mlBase: string
Base on which search needs to be performed, P-Predicted, A-Actual(Default)
-
offset: integer
Offset is starting no of records to be fetched
-
partyId(required): string
Id of the Corporate / Party for which Cashflow Details are required
-
reconStatus: string
Recon Status
-
toActualAmount: number
To Actual Amount
-
toAmount: number
To Amount
-
toDate: string
End Date for Cashflow Details in yyyy-MM-dd format
-
transactionId: string
Transaction Id
-
udfTxt4: string
User Defined Text 4 .OBDX sends RefNo in this field
-
virtualAcctNo: string
Virtual Account No
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 : CashflowResponseWrapper
Type:
objectCashflow response model
Show Source
-
cashflows:
array cashflows
List of Cashflow Reponse
-
errorCodes:
array errorCodes
List of Error Model
-
paging:
object PagingDto
-
status:
string
Status
Nested Schema : cashflows
Type:
arrayList of Cashflow Reponse
Show Source
-
Array of:
object CashflowResponse
Cashflow Response Model
Nested Schema : errorCodes
Type:
arrayList of Error Model
Show Source
-
Array of:
object ErrorModel
Error model
Nested Schema : CashflowResponse
Type:
objectCashflow Response Model
Show Source
-
actualCashflowAmt:
number
Actual Cashflow Amount
-
actualDate:
string
Actual Cashflow Date in yyyy-MM-dd format
-
amount:
number
Cashflow Amount
-
applicationName:
string
Application Name
-
authStatus:
string
Authentication Status
-
bankAccountNumber:
string
Bank Accont No
-
cashFlowCode:
string
Cashflow Code
-
cashflowDescription:
string
Cashflow Description
-
cashFlowType:
string
Cashflow Type - Inflow / Outflow
-
ccy:
string
Settlement Curency
-
channel:
string
Channel
-
checkerDateTime:
string
Checker dateTime
-
checkerId:
string
Checker Id
-
corporateName:
string
Corporate Name
-
corporateRefNo:
string
Corporate Ref No
-
counterpartyId:
string
Counterparty Id
-
counterpartyName:
string
Counterparty Name
-
customerRefNo:
string
Customer Reference No
-
endOfWeek:
string
End Of Week
-
excludeRecon:
string
Exclude Recon
-
expecDate:
string
Expected Cashflow Date in yyyy-MM-dd format
-
externalTransactionRefNo:
string
External Transaction Ref No
-
fileReferenceNo:
string
File Reference No
-
lastActionPerformed:
string
Last Action Performed
-
makerDateTime:
string
Maker dateTime
-
makerId:
string
Maker Id
-
modNo:
string
Modification No
-
narration:
string
Narration
-
onceAuth:
string
Once Authentication Flag
-
parentId:
string
Parent Id
-
partyId:
string
Party Id / Corporate Id
-
predictedCashflows:
array predictedCashflows
List of Predicted Cashflows
-
reconStatus:
string
Recon Status
-
recordStatus:
string
Record Status
-
recurringFlag:
string
Recurring Flag
-
revisedExpectedDate:
string
Revised Expected Cashflow Date in yyyy-MM-dd format
-
source:
string
Source
-
startOfWeek:
string
Start Of Week
-
summaryProcessed:
string
Summary Processed
-
transactionId:
string
Transaction Id
-
transactionStatus:
string
Transaction Status
-
txnBranchCode:
string
Branch Code
-
udfTxt1:
string
User Defined Text 1
-
udfTxt10:
string
User Defined Text 10
-
udfTxt2:
string
User Defined Text 2
-
udfTxt3:
string
User Defined Text 3
-
udfTxt4:
string
User Defined Text 4
-
udfTxt5:
string
User Defined Text 5
-
udfTxt6:
string
User Defined Text 6
-
udfTxt7:
string
User Defined Text 7
-
udfTxt8:
string
User Defined Text 8
-
udfTxt9:
string
User Defined Text 9
-
unpaidAmount:
number
Unpaid Amount
-
varianceAmount:
number
Variance Amount
-
virtualAcctNo:
string
Virtual Account No
Nested Schema : predictedCashflows
Type:
arrayList of Predicted Cashflows
Show Source
-
Array of:
object PredictedCashflow
Predicted Cashflow
Nested Schema : PredictedCashflow
Type:
objectPredicted Cashflow
Show Source
-
actAmount:
number
Actual Amount
-
actDate:
string
Actual Cashflow Date in yyyy-MM-dd format
-
amount:
number
Predicted Cashflow Amount
-
cashFlowCode:
string
Cashflow Code
-
cashFlowType:
string
Cashflow Type - Inflow / Outflow
-
ccy:
string
Settlement Curency
-
corporateName:
string
Corporate Name
-
customerRefNo:
string
Customer Reference No
-
date:
string
Predicted Cashflow Date in yyyy-MM-dd format
-
externalTransactionRefNo:
string
External Transaction Ref No
-
partyId:
string
Party Id / Corporate Id
Nested Schema : ErrorModel
Type:
objectError model
Show Source
-
ErrorCode:
string
Error Code
-
ErrorDescrtiption:
string
Error Description
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