REST API for Oracle Banking Corporate Lending Process Management

Update the Loan Schedule details of the loan origination/restructuring application

post

/loanapplication-services/service/api/v1/loanschedules/{applicationNumber}

This operation updates the loan schedule details of the loan origination/restructuring application of the given application number using LoanOriginationApplication Service.

Request

Supported Media Types

application/json
application/xml

Path Parameters

applicationNumber: string

application number of the Loan origination/restructuring application

Request Body containing the Loan Schedule details of the application number

Root Schema : LoanScheduleModel

Type: object

LoanSchedule model

Match All

Show Source

allOf GenericDatasegmentModel
object LoanScheduleModel-allOf[1]

{
    "description":"LoanSchedule model",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDatasegmentModel"
        },
        {
            "type":"object",
            "properties":{
                "productCode":{
                    "description":"productCode of the LoanSchedule",
                    "type":"string"
                },
                "componentCurrency":{
                    "description":"Component Currency",
                    "type":"string",
                    "maxLength":3
                },
                "loanScheduleDetails":{
                    "description":"Details of the LoanSchedule",
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LoanScheduleDetailsModel"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericDatasegmentModel

Match All

Show Source

object GenericDatasegmentModel-allOf[0]

Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDatasegmentModel-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : LoanScheduleModel-allOf[1]

Type: object

Show Source

componentCurrency(optional): string

Maximum Length: 3

Component Currency
loanScheduleDetails(optional): array loanScheduleDetails

Details of the LoanSchedule
productCode(optional): string

productCode of the LoanSchedule

{
    "type":"object",
    "properties":{
        "productCode":{
            "description":"productCode of the LoanSchedule",
            "type":"string"
        },
        "componentCurrency":{
            "description":"Component Currency",
            "type":"string",
            "maxLength":3
        },
        "loanScheduleDetails":{
            "description":"Details of the LoanSchedule",
            "type":"array",
            "items":{
                "$ref":"#/definitions/LoanScheduleDetailsModel"
            }
        }
    }
}

Nested Schema : loanScheduleDetails

Type: array

Details of the LoanSchedule

Show Source

Array of: object LoanScheduleDetailsModel

Loan Schedule Details model

{
    "description":"Details of the LoanSchedule",
    "type":"array",
    "items":{
        "$ref":"#/definitions/LoanScheduleDetailsModel"
    }
}

Nested Schema : LoanScheduleDetailsModel

Type: object

Loan Schedule Details model

Show Source

amount(optional): number

Minimum Value: 0

amount of the Details model
amountDue(optional): number

Minimum Value: 0

amountDue
amountToSettle(optional): number

Minimum Value: 0

amountToSettle
componentCurrencyCode: string

Maximum Length: 3

componentCurrency of the Details model
componentName: string

Maximum Length: 35

componentName of the Details model
frequency: string

Maximum Length: 22

frequency of the Details model
id(optional): string

Maximum Length: 36

Id of the schedule details model
loanScheduleDetailsDocument(optional): array loanScheduleDetailsDocument

loanScheduleDocument of the loanSchedule
loanScheduleId(optional): string

Maximum Length: 36

loanScheduleId of the Details model
noOfSchedules: integer

noOfSchedules of the Details model
principalLiquidation: string

Maximum Length: 20

principalLiquidation of the Details model
rate(optional): number(int64)

rate of the Details model
rateCode(optional): string

Maximum Length: 20

rateCode of the Details model
rateType(optional): string

Maximum Length: 20

rateType of the Details model
scheduleDate(optional): string

scheduleDate
scheduleNo(optional): integer

scheduleNo
scheduleType: string

Maximum Length: 20

scheduleType of the Details model
settlementCurrencyCode(optional): string

Maximum Length: 3

settlementCurrencyCode
spread(optional): string(int64)

spread of the schedule details model
startDate: string

Maximum Length: 10

startDate of the schedule details model
unit: integer

unit of the Details model

{
    "description":"Loan Schedule Details model",
    "type":"object",
    "required":[
        "scheduleType",
        "componentName",
        "componentCurrencyCode",
        "frequency",
        "unit",
        "noOfSchedules",
        "startDate",
        "principalLiquidation"
    ],
    "properties":{
        "id":{
            "description":"Id of the schedule details model",
            "type":"string",
            "maxLength":36
        },
        "loanScheduleId":{
            "description":"loanScheduleId of the Details model",
            "type":"string",
            "maxLength":36
        },
        "scheduleType":{
            "description":"scheduleType of the Details model",
            "type":"string",
            "maxLength":20
        },
        "componentName":{
            "description":"componentName of the Details model",
            "type":"string",
            "maxLength":35
        },
        "componentCurrencyCode":{
            "description":"componentCurrency of the Details model",
            "type":"string",
            "maxLength":3
        },
        "rateType":{
            "description":"rateType of the Details model",
            "type":"string",
            "maxLength":20
        },
        "spread":{
            "description":"spread of the schedule details model",
            "type":"string",
            "format":"int64"
        },
        "rate":{
            "description":"rate of the Details model",
            "type":"number",
            "format":"int64"
        },
        "rateCode":{
            "description":"rateCode of the Details model",
            "type":"string",
            "maxLength":20
        },
        "amount":{
            "description":"amount of the Details model",
            "type":"number",
            "minimum":0
        },
        "noOfSchedules":{
            "description":"noOfSchedules of the Details model",
            "type":"integer"
        },
        "unit":{
            "description":"unit of the Details model",
            "type":"integer"
        },
        "frequency":{
            "description":"frequency of the Details model",
            "type":"string",
            "maxLength":22
        },
        "startDate":{
            "description":"startDate of the schedule details model",
            "type":"string",
            "maxLength":10
        },
        "principalLiquidation":{
            "description":"principalLiquidation of the Details model",
            "type":"string",
            "maxLength":20
        },
        "scheduleNo":{
            "description":"scheduleNo",
            "type":"integer"
        },
        "scheduleDate":{
            "description":"scheduleDate",
            "type":"string"
        },
        "settlementCurrencyCode":{
            "description":"settlementCurrencyCode",
            "type":"string",
            "maxLength":3
        },
        "amountToSettle":{
            "description":"amountToSettle",
            "type":"number",
            "minimum":0
        },
        "amountDue":{
            "description":"amountDue",
            "type":"number",
            "minimum":0
        },
        "loanScheduleDetailsDocument":{
            "description":"loanScheduleDocument of the loanSchedule",
            "type":"array",
            "items":{
                "$ref":"#/definitions/DocumentLinkageModel"
            }
        }
    }
}

Nested Schema : loanScheduleDetailsDocument

Type: array

loanScheduleDocument of the loanSchedule

Show Source

Array of: object DocumentLinkageModel

DocumentLinkageModel

{
    "description":"loanScheduleDocument of the loanSchedule",
    "type":"array",
    "items":{
        "$ref":"#/definitions/DocumentLinkageModel"
    }
}

Nested Schema : DocumentLinkageModel

Type: object

DocumentLinkageModel

Show Source

documentLinkageId(optional): string

Maximum Length: 36

documentLinkageId
documentName(optional): string

Maximum Length: 105

documentName
documentType(optional): string

Maximum Length: 50

documentType
id(optional): string

Maximum Length: 36

Id
parentDatasegmentId(optional): string

Maximum Length: 36

parentDatasegmentId

{
    "description":"DocumentLinkageModel",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id",
            "type":"string",
            "maxLength":36
        },
        "parentDatasegmentId":{
            "description":"parentDatasegmentId",
            "type":"string",
            "maxLength":36
        },
        "documentLinkageId":{
            "description":"documentLinkageId",
            "type":"string",
            "maxLength":36
        },
        "documentName":{
            "description":"documentName",
            "type":"string",
            "maxLength":105
        },
        "documentType":{
            "description":"documentType",
            "type":"string",
            "maxLength":50
        }
    }
}

Response

Supported Media Types

application/json
application/xml

200 Response

Returns updated Loan Schedule Details

Root Schema : ResponseDtoWrapper

Type: object

Show Source

data(optional): ResponseResourceSupport
messages(optional): object ResponseDto

ResponseDto model

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Match All

Show Source

object ResponseResourceSupport-allOf[0]

Discriminator: resouce_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resouce_type"
        }
    ]
}

Nested Schema : ResponseDto

Type: object

ResponseDto model

Show Source

codes(optional): string

Codes
httpStatusCode(optional): array httpStatusCode

Schedule Details
keyId(optional): string

KeyId
overrideAuthLevelsReqd(optional): string

OverrideAuthLevelsReqd
requestId(optional): string

RequestId
status(optional): string

Status

{
    "description":"ResponseDto model",
    "properties":{
        "keyId":{
            "description":"KeyId",
            "type":"string"
        },
        "status":{
            "description":"Status",
            "type":"string"
        },
        "codes":{
            "description":"Codes",
            "type":"string"
        },
        "httpStatusCode":{
            "type":"array",
            "description":"Schedule Details",
            "items":{
                "$ref":"#/definitions/responseCodes"
            }
        },
        "overrideAuthLevelsReqd":{
            "description":"OverrideAuthLevelsReqd",
            "type":"string"
        },
        "requestId":{
            "description":"RequestId",
            "type":"string"
        }
    }
}

Nested Schema : ResponseResourceSupport-allOf[0]

Type: object

Discriminator: resouce_type

Nested Schema : httpStatusCode

Type: array

Schedule Details

Show Source

Array of: object responseCodes

ResponseCodes

{
    "type":"array",
    "description":"Schedule Details",
    "items":{
        "$ref":"#/definitions/responseCodes"
    }
}

Nested Schema : responseCodes

Type: object

ResponseCodes

Show Source

code(optional): string

Code
desc(optional): string

Description
error(optional): string

Error
info(optional): string

Info
language(optional): string

Language
override(optional): string

Override
type(optional): string

Type

{
    "description":"ResponseCodes",
    "type":"object",
    "properties":{
        "code":{
            "description":"Code",
            "type":"string"
        },
        "desc":{
            "description":"Description",
            "type":"string"
        },
        "type":{
            "description":"Type",
            "type":"string"
        },
        "language":{
            "description":"Language",
            "type":"string"
        },
        "error":{
            "description":"Error",
            "type":"string"
        },
        "override":{
            "description":"Override",
            "type":"string"
        },
        "info":{
            "description":"Info",
            "type":"string"
        }
    }
}

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