Jump to

• Request
• Response

Retrieves cashflow codes

get

/service/v1/cashflowCodes

This endpoint is used to retrieve the cashflow codes for the given set of parameters.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• ccy: string
  Currency
• corporateId: string
  Id of the Corporate / Party for which Cashflow Codes are required
• fromDate: string
  Start Date for Cashflow Details in yyyy-MM-dd format
• realAccount: string
  Real Account
• toDate: string
  End Date for Cashflow Details in yyyy-MM-dd format
• virtualAccount: string
  Virtual Account

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 : CashflowCodeResponseWrapper

Type: object

Cashflow Code Response Data Model

Show Source

• inflow(optional): array inflow
  Collection of Inflow Code Response
• outflow(optional): array outflow
  Collection of Outflow Code Response

{
    "description":"Cashflow Code Response Data Model",
    "type":"object",
    "properties":{
        "inflow":{
            "description":"Collection of Inflow Code Response",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CashflowCodeRespDTO"
            }
        },
        "outflow":{
            "description":"Collection of Outflow Code Response",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CashflowCodeRespDTO"
            }
        }
    }
}

Nested Schema : inflow

Type: array

Collection of Inflow Code Response

Show Source

• Array of: object CashflowCodeRespDTO
  Cashfow Code Response DTO model

{
    "description":"Collection of Inflow Code Response",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CashflowCodeRespDTO"
    }
}

Nested Schema : outflow

Type: array

Collection of Outflow Code Response

Show Source

• Array of: object CashflowCodeRespDTO
  Cashfow Code Response DTO model

{
    "description":"Collection of Outflow Code Response",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CashflowCodeRespDTO"
    }
}

Nested Schema : CashflowCodeRespDTO

Type: object

Cashfow Code Response DTO model

Show Source

• code(optional): string
  Code
• description(optional): string
  Description

{
    "description":"Cashfow Code Response DTO model",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Code"
        },
        "description":{
            "type":"string",
            "description":"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

Back to Top