Fetches the list of cashflows
get
/obcm-cashflow-forecasting-services/service/v1/cashflow-maint/search
This endpoint is used to fetch the list of cashflows based on given set of parameters.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
action: string
action
-
applicationName: string
applicationName
-
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
-
checkerDtStamp: string
checkerDtStamp
-
checkerId: string
checkerId
-
checkerRemarks: string
checkerRemarks
-
corporateName: string
corporateName
-
counterPartyId: string
Counter Party Id
-
customerRefNo: string
Customer Reference No
-
description: string
description
-
excludeRecon: string
Exclude Recon
-
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
-
id: string
id
-
keyId: string
keyId
-
lastActionPerformed: string
Last Action Performed
-
limit(optional): integer
Limit is maximum no of records to be fetched
-
makerDtStamp: string
makerDtStamp
-
makerId: string
makerId
-
makerRemarks: string
makerRemarks
-
offset(optional): integer
Offset is starting no of records to be fetched
-
onceAuth: string
onceAuth
-
parentId: string
parentId
-
partyId: string
Id of the Corporate / Party for which Cashflow Details are required
-
reconAmount: integer
reconAmount
-
reconStatus: string
Recon Status
-
recordStat: string
recordStat
-
revisedExpectedDate: string
revisedExpectedDate
-
summaryProcessed: string
summaryProcessed
-
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
-
transactionStatus: string
Transaction Status
-
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
-
varianceAmount: integer
varianceAmount
-
virtualAcctNo: string
Virtual Account No
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 : CashflowResponseWrapper
Type:
object
Cashflow response model
Show Source
-
cashflows(optional):
array cashflows
List of Cashflow Reponse
-
errorCodes(optional):
array errorCodes
List of Error Model
-
paging(optional):
object PagingDto
Paging Dto
-
status(optional):
string
Status
Nested Schema : cashflows
Type:
array
List of Cashflow Reponse
Show Source
-
Array of:
object CashflowResponse
Cashflow Response Model
Nested Schema : errorCodes
Type:
array
List of Error Model
Show Source
-
Array of:
object ErrorModel
Error model
Nested Schema : PagingDto
Type:
object
Paging Dto
Show Source
-
totalResults(optional):
integer
Total Results
Nested Schema : CashflowResponse
Type:
object
Cashflow Response Model
Show Source
-
action(optional):
string
action
-
actualCashflowAmt(optional):
number
Actual Cashflow Amount
-
actualDate(optional):
string
Actual Cashflow Date in yyyy-MM-dd format
-
amount(optional):
number
Cashflow Amount
-
applicationName(optional):
string
Application Name
-
authStatus(optional):
string
Authentication Status
-
bankAccountNumber(optional):
string
Bank Accont No
-
cashFlowCode(optional):
string
Cashflow Code
-
cashflowDescription(optional):
string
Cashflow Description
-
cashFlowType(optional):
string
Cashflow Type - Inflow / Outflow
-
ccy(optional):
string
Settlement Curency
-
channel(optional):
string
Channel
-
checkerDateTime(optional):
string
Checker dateTime
-
checkerId(optional):
string
Checker Id
-
checkerRemarks(optional):
string
checkerRemarks
-
corporateName(optional):
string
Corporate Name
-
counterpartyId(optional):
string
Counterparty Id
-
counterpartyName(optional):
string
Counterparty Name
-
customerRefNo(optional):
string
Customer Reference No
-
description(optional):
string
description
-
excludeRecon(optional):
string
Exclude Recon
-
expecDate(optional):
string
Expected Cashflow Date in yyyy-MM-dd format
-
externalTransactionRefNo(optional):
string
External Transaction Ref No
-
fileReferenceNo(optional):
string
File Reference No
-
id(optional):
string
id
-
keyId(optional):
string
keyId
-
lastActionPerformed(optional):
string
Last Action Performed
-
makerDateTime(optional):
string
Maker dateTime
-
makerId(optional):
string
Maker Id
-
makerRemarks(optional):
string
makerRemarks
-
modNo(optional):
string
Modification No
-
narration(optional):
string
Narration
-
onceAuth(optional):
string
Once Authentication Flag
-
parentId(optional):
string
Parent Id
-
partyId(optional):
string
Party Id / Corporate Id
-
reconAmount(optional):
number
reconAmount
-
reconStatus(optional):
string
Recon Status
-
recordStatus(optional):
string
Record Status
-
revisedExpectedDate(optional):
string
Revised Expected Cashflow Date in yyyy-MM-dd format
-
summaryProcessed(optional):
string
Summary Processed
-
transactionId(optional):
string
Transaction Id
-
transactionStatus(optional):
string
Transaction Status
-
udfTxt1(optional):
string
User Defined Text 1
-
udfTxt10(optional):
string
User Defined Text 10
-
udfTxt2(optional):
string
User Defined Text 2
-
udfTxt3(optional):
string
User Defined Text 3
-
udfTxt4(optional):
string
User Defined Text 4
-
udfTxt5(optional):
string
User Defined Text 5
-
udfTxt6(optional):
string
User Defined Text 6
-
udfTxt7(optional):
string
User Defined Text 7
-
udfTxt8(optional):
string
User Defined Text 8
-
udfTxt9(optional):
string
User Defined Text 9
-
varianceAmount(optional):
number
Variance Amount
-
virtualAcctNo(optional):
string
Virtual Account No
Nested Schema : ErrorModel
Type:
object
Error model
Show Source
-
ErrorCode(optional):
string
Error Code
-
ErrorDescrtiption(optional):
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