Jump to

• Request
• Response

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful performs the operation

Body ()

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
• status(optional): string
  Status

{
    "description":"Cashflow response model",
    "type":"object",
    "properties":{
        "status":{
            "description":"Status",
            "type":"string"
        },
        "cashflows":{
            "type":"array",
            "description":"List of Cashflow Reponse",
            "items":{
                "$ref":"#/definitions/CashflowResponse"
            }
        },
        "errorCodes":{
            "type":"array",
            "description":"List of Error Model",
            "items":{
                "$ref":"#/definitions/ErrorModel"
            }
        },
        "paging":{
            "description":"Paging DTO Model",
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : cashflows

Type: array

List of Cashflow Reponse

Show Source

• Array of: object CashflowResponse
  Cashflow Response Model

{
    "type":"array",
    "description":"List of Cashflow Reponse",
    "items":{
        "$ref":"#/definitions/CashflowResponse"
    }
}

Nested Schema : errorCodes

Type: array

List of Error Model

Show Source

• Array of: object ErrorModel
  Error model

{
    "type":"array",
    "description":"List of Error Model",
    "items":{
        "$ref":"#/definitions/ErrorModel"
    }
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

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

{
    "description":"Cashflow Response Model",
    "type":"object",
    "properties":{
        "partyId":{
            "description":"Party Id / Corporate Id",
            "type":"string"
        },
        "corporateName":{
            "description":"Corporate Name",
            "type":"string"
        },
        "actualDate":{
            "description":"Actual Cashflow Date in yyyy-MM-dd format",
            "type":"string"
        },
        "cashFlowType":{
            "description":"Cashflow Type - Inflow / Outflow",
            "type":"string"
        },
        "cashFlowCode":{
            "description":"Cashflow Code",
            "type":"string"
        },
        "ccy":{
            "description":"Settlement Curency",
            "type":"string"
        },
        "amount":{
            "description":"Cashflow Amount",
            "type":"number"
        },
        "expecDate":{
            "description":"Expected Cashflow Date in yyyy-MM-dd format",
            "type":"string"
        },
        "revisedExpectedDate":{
            "description":"Revised Expected Cashflow Date in yyyy-MM-dd format",
            "type":"string"
        },
        "counterpartyId":{
            "description":"Counterparty Id",
            "type":"string"
        },
        "cashflowDescription":{
            "description":"Cashflow Description",
            "type":"string"
        },
        "counterpartyName":{
            "description":"Counterparty Name",
            "type":"string"
        },
        "externalTransactionRefNo":{
            "description":"External Transaction Ref No",
            "type":"string"
        },
        "bankAccountNumber":{
            "type":"string",
            "description":"Bank Accont No"
        },
        "virtualAcctNo":{
            "type":"string",
            "description":"Virtual Account No"
        },
        "actualCashflowAmt":{
            "type":"number",
            "description":"Actual Cashflow Amount"
        },
        "narration":{
            "type":"string",
            "description":"Narration"
        },
        "reconStatus":{
            "type":"string",
            "description":"Recon Status"
        },
        "applicationName":{
            "type":"string",
            "description":"Application Name"
        },
        "channel":{
            "type":"string",
            "description":"Channel"
        },
        "transactionId":{
            "type":"string",
            "description":"Transaction Id"
        },
        "udfTxt1":{
            "type":"string",
            "description":"User Defined Text 1"
        },
        "udfTxt2":{
            "type":"string",
            "description":"User Defined Text 2"
        },
        "udfTxt3":{
            "type":"string",
            "description":"User Defined Text 3"
        },
        "udfTxt4":{
            "type":"string",
            "description":"User Defined Text 4"
        },
        "udfTxt5":{
            "type":"string",
            "description":"User Defined Text 5"
        },
        "udfTxt6":{
            "type":"string",
            "description":"User Defined Text 6"
        },
        "udfTxt7":{
            "type":"string",
            "description":"User Defined Text 7"
        },
        "udfTxt8":{
            "type":"string",
            "description":"User Defined Text 8"
        },
        "udfTxt9":{
            "type":"string",
            "description":"User Defined Text 9"
        },
        "udfTxt10":{
            "type":"string",
            "description":"User Defined Text 10"
        },
        "summaryProcessed":{
            "type":"string",
            "description":"Summary Processed"
        },
        "parentId":{
            "type":"string",
            "description":"Parent Id"
        },
        "fileReferenceNo":{
            "type":"string",
            "description":"File Reference No"
        },
        "makerId":{
            "type":"string",
            "description":"Maker Id"
        },
        "makerDateTime":{
            "type":"string",
            "description":"Maker dateTime"
        },
        "checkerId":{
            "type":"string",
            "description":"Checker Id"
        },
        "checkerDateTime":{
            "type":"string",
            "description":"Checker dateTime"
        },
        "modNo":{
            "type":"string",
            "description":"Modification No"
        },
        "authStatus":{
            "type":"string",
            "description":"Authentication Status"
        },
        "recordStatus":{
            "type":"string",
            "description":"Record Status"
        },
        "onceAuth":{
            "type":"string",
            "description":"Once Authentication Flag"
        },
        "customerRefNo":{
            "type":"string",
            "description":"Customer Reference No"
        },
        "varianceAmount":{
            "type":"number",
            "description":"Variance Amount"
        },
        "action":{
            "type":"string",
            "description":"action"
        },
        "keyId":{
            "type":"string",
            "description":"keyId"
        },
        "checkerRemarks":{
            "type":"string",
            "description":"checkerRemarks"
        },
        "makerRemarks":{
            "type":"string",
            "description":"makerRemarks"
        },
        "description":{
            "type":"string",
            "description":"description"
        },
        "reconAmount":{
            "type":"number",
            "description":"reconAmount"
        },
        "id":{
            "type":"string",
            "description":"id"
        },
        "excludeRecon":{
            "type":"string",
            "description":"Exclude Recon"
        },
        "transactionStatus":{
            "type":"string",
            "description":"Transaction Status"
        },
        "lastActionPerformed":{
            "type":"string",
            "description":"Last Action Performed"
        }
    }
}

Nested Schema : ErrorModel

Type: object

Error model

Show Source

• ErrorCode(optional): string
  Error Code
• ErrorDescrtiption(optional): string
  Error Description

{
    "description":"Error model",
    "type":"object",
    "properties":{
        "ErrorCode":{
            "description":"Error Code",
            "type":"string"
        },
        "ErrorDescrtiption":{
            "description":"Error Description",
            "type":"string"
        }
    }
}

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

Back to Top