Rest API for Oracle Banking Liquidity Management

Generate pool report

post

/simulation/generatePoolReport

This endpoint is used to generate pool benefit report along with log summary.

Request

Supported Media Types

application/json
application/xml

Request Body that contains data required for creating pool simulation report

Root Schema : LmrSimulationPoolReportDTO

Type: object

Show Source

benefitReportBody(optional): array benefitReportBody
benefitReportHeader(optional): object PoolBenefitReportHeaderDTO
benefitSummary(optional): object PoolBenefitSummaryDTO
currencyRate(optional): array currencyRate
currencyThreshold(optional): array currencyThreshold

{
    "type":"object",
    "properties":{
        "benefitReportHeader":{
            "type":"object",
            "$ref":"#/definitions/PoolBenefitReportHeaderDTO"
        },
        "benefitReportBody":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PoolBenefitReportBodyDTO"
            }
        },
        "benefitSummary":{
            "type":"object",
            "$ref":"#/definitions/PoolBenefitSummaryDTO"
        },
        "currencyRate":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CurrencyRateDTO"
            }
        },
        "currencyThreshold":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CurrencyThresholdDTO"
            }
        }
    }
}

Nested Schema : benefitReportBody

Type: array

Show Source

Array of: object PoolBenefitReportBodyDTO

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

Nested Schema : PoolBenefitReportHeaderDTO

Type: object

Show Source

customerId(optional): string

Pattern: [a-zA-Z0-9]{1,20}
customerName(optional): string
fromDt(optional): string
generatedBy(optional): string
generatedOn(optional): string
headerAccount(optional): string
headerCcy(optional): string
interestMethod(optional): string
reallocationMethod(optional): string
simulationId(optional): string
structureDesc(optional): string
structureId(optional): string

Pattern: [A-Z0-9]{1,30}
structureType(optional): string
thresholdAmount(optional): number
thresholdCurrency(optional): string
toDt(optional): string

{
    "type":"object",
    "properties":{
        "customerId":{
            "type":"string",
            "description":"",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "customerName":{
            "type":"string",
            "description":""
        },
        "structureId":{
            "type":"string",
            "description":"",
            "pattern":"[A-Z0-9]{1,30}"
        },
        "structureDesc":{
            "type":"string",
            "description":""
        },
        "structureType":{
            "type":"string",
            "description":""
        },
        "simulationId":{
            "type":"string",
            "description":""
        },
        "fromDt":{
            "type":"string",
            "description":""
        },
        "toDt":{
            "type":"string",
            "description":""
        },
        "headerAccount":{
            "type":"string",
            "description":""
        },
        "headerCcy":{
            "type":"string",
            "description":""
        },
        "interestMethod":{
            "type":"string",
            "description":""
        },
        "reallocationMethod":{
            "type":"string",
            "description":""
        },
        "generatedOn":{
            "type":"string",
            "description":""
        },
        "generatedBy":{
            "type":"string",
            "description":""
        },
        "thresholdAmount":{
            "type":"number",
            "description":""
        },
        "thresholdCurrency":{
            "type":"string",
            "description":""
        }
    }
}

Nested Schema : PoolBenefitSummaryDTO

Type: object

Show Source

simulationBenefit(optional): number
totalPostPoolIntHdrCcy(optional): number
totalPrePoolIntHdrCcy(optional): number

{
    "type":"object",
    "properties":{
        "totalPostPoolIntHdrCcy":{
            "type":"number",
            "description":""
        },
        "totalPrePoolIntHdrCcy":{
            "type":"number",
            "description":""
        },
        "simulationBenefit":{
            "type":"number",
            "description":""
        }
    }
}

Nested Schema : currencyRate

Type: array

Show Source

Array of: object CurrencyRateDTO

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

Nested Schema : currencyThreshold

Type: array

Show Source

Array of: object CurrencyThresholdDTO

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

Nested Schema : PoolBenefitReportBodyDTO

Type: object

Show Source

accountDesc(optional): string
accountNo(optional): string
baseInterestRate(optional): number
branch(optional): string
branchDesc(optional): string
ccy(optional): string
enhancementInterestRate(optional): number
headerCcy(optional): string
nominatedInterestRate(optional): number
postPoolIntAccCcy(optional): number
postPoolIntHeaderCcy(optional): number
premiumInterestRate(optional): number
prePoolIntAccCcy(optional): number
prePoolIntHeaderCcy(optional): number

{
    "type":"object",
    "properties":{
        "accountNo":{
            "type":"string",
            "description":""
        },
        "accountDesc":{
            "type":"string",
            "description":""
        },
        "ccy":{
            "type":"string",
            "description":""
        },
        "headerCcy":{
            "type":"string",
            "description":""
        },
        "branch":{
            "type":"string",
            "description":""
        },
        "branchDesc":{
            "type":"string",
            "description":""
        },
        "prePoolIntAccCcy":{
            "type":"number",
            "description":""
        },
        "prePoolIntHeaderCcy":{
            "type":"number",
            "description":""
        },
        "postPoolIntAccCcy":{
            "type":"number",
            "description":""
        },
        "postPoolIntHeaderCcy":{
            "type":"number",
            "description":""
        },
        "baseInterestRate":{
            "type":"number",
            "description":""
        },
        "premiumInterestRate":{
            "type":"number",
            "description":""
        },
        "enhancementInterestRate":{
            "type":"number",
            "description":""
        },
        "nominatedInterestRate":{
            "type":"number",
            "description":""
        }
    }
}

Nested Schema : CurrencyRateDTO

Type: object

Show Source

currency(optional): string

Maximum Length: 3
enhancementRate(optional): number
fromAmount(optional): number
id(optional): string

Maximum Length: 36
rateType(optional): string

Maximum Length: 50
structureMasterId(optional): string

Maximum Length: 36
toAmount(optional): number

{
    "type":"object",
    "properties":{
        "currency":{
            "type":"string",
            "description":"",
            "maxLength":3
        },
        "enhancementRate":{
            "type":"number",
            "description":""
        },
        "fromAmount":{
            "type":"number",
            "description":""
        },
        "id":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "structureMasterId":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "rateType":{
            "type":"string",
            "description":"",
            "maxLength":50
        },
        "toAmount":{
            "type":"number",
            "description":""
        }
    }
}

Nested Schema : CurrencyThresholdDTO

Type: object

Show Source

currency(optional): string

Maximum Length: 3
threshold(optional): number

{
    "type":"object",
    "properties":{
        "currency":{
            "type":"string",
            "description":"",
            "maxLength":3
        },
        "threshold":{
            "type":"number",
            "description":""
        }
    }
}

Response

Supported Media Types

application/json
application/xml

201 Response

Returns message of success or failure

Headers

Location: string

Root Schema : PoolSimulateReportDTOCollection

Type: object

Collection of report output.

Show Source

data(optional): object ReportResponse

Report Response
messages(optional): object ResponseDto

{
    "description":"Collection of report output.",
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/ReportResponse"
        },
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        }
    }
}

Nested Schema : ReportResponse

Type: object

Report Response

Show Source

documentId(optional): string

Document Id for the document
documentInbase64(optional): string

Document in Base64
reportContentType(optional): string

Report Content Type for the document

{
    "description":"Report Response",
    "type":"object",
    "properties":{
        "documentId":{
            "description":"Document Id for the document",
            "type":"string"
        },
        "documentInbase64":{
            "description":"Document in Base64",
            "type":"string"
        },
        "reportContentType":{
            "description":"Report Content Type for the document",
            "type":"string"
        }
    }
}

Nested Schema : ResponseDto

Type: object

Show Source

codes(optional): array codes
id(optional): string
requestId(optional): string
status(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

Array of: object ResponseCode

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

Nested Schema : ResponseCode

Type: object

Show Source

arg(optional): string
args(optional): array args
Code(optional): string
Desc(optional): string
Language(optional): string
Type(optional): string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error