Rest API for Oracle Banking Cash Management

Update the netting structure

put

/service/v1/updateStructureTree

This API is used to update the netting structure.

Request

Supported Media Types

application/json
application/xml

Query Parameters

autoAuth: boolean

Edited record will get authorized if auto auth is true
channel: string

Channel Name
channelBranch(optional): string

Branch name of the Channel
externalRefNo: string

External Reference Number from the Channel
loginEntityType: string

Login Entity Type
partyId: string

Party Id of the logged in user

Header Parameters

appId: string

Source Application Id
branchCode: string

Branch Code
userId: string

Source User id

Request body contains structure tree which needs to be edited.

Root Schema : ObcmTmStructureMasterServiceModel

Type: object

ObcmTmStructureMasterServiceModel

Show Source

approverRemarks(optional): string

approver remarks
authStatus(optional): string

auth status flag
checkerDateStamp(optional): string

checker date stamp
checkerId(optional): string

check id
doerRemarks(optional): string

doer remarks
makerDateStamp(optional): string

make date stamp
makerId(optional): string

maker id
modNo(optional): integer

mod no
obcmTmStructureEnrichParamDetails(optional): array obcmTmStructureEnrichParamDetails
obcmTmStructureMaster(optional): object ObcmTmStructureMasterModel
obcmTmStructureNode(optional): array obcmTmStructureNode
onceAuth(optional): string

once auth flag
operationType(optional): string

operation type
recordStatus(optional): string

record status flag
resourceId(optional): string

resource id
resourceName(optional): string

resource name

{
    "description":"ObcmTmStructureMasterServiceModel",
    "type":"object",
    "properties":{
        "resourceId":{
            "description":"resource id",
            "type":"string"
        },
        "resourceName":{
            "description":"resource name",
            "type":"string"
        },
        "operationType":{
            "description":"operation type",
            "type":"string"
        },
        "makerId":{
            "description":"maker id",
            "type":"string"
        },
        "makerDateStamp":{
            "description":"make date stamp",
            "type":"string"
        },
        "checkerId":{
            "description":"check id",
            "type":"string"
        },
        "checkerDateStamp":{
            "description":"checker date stamp",
            "type":"string"
        },
        "modNo":{
            "description":"mod no",
            "type":"integer"
        },
        "recordStatus":{
            "description":"record status flag",
            "type":"string"
        },
        "authStatus":{
            "description":"auth status flag",
            "type":"string"
        },
        "onceAuth":{
            "description":"once auth flag",
            "type":"string"
        },
        "doerRemarks":{
            "description":"doer remarks",
            "type":"string"
        },
        "approverRemarks":{
            "description":"approver  remarks",
            "type":"string"
        },
        "obcmTmStructureMaster":{
            "$ref":"#/definitions/ObcmTmStructureMasterModel"
        },
        "obcmTmStructureNode":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ObcmTmStructureNodeModel"
            }
        },
        "obcmTmStructureEnrichParamDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ObcmTmStructureEnrichParamDetailsModel"
            }
        }
    }
}

Nested Schema : obcmTmStructureEnrichParamDetails

Type: array

Show Source

Array of: object ObcmTmStructureEnrichParamDetailsModel

ObcmTmStructureEnrichParamDetails model

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

Nested Schema : ObcmTmStructureMasterModel

Type: object

Match All

Show Source

allOf GenericDto
object ObcmTmStructureMasterModel-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"Id"
                },
                "action":{
                    "type":"string",
                    "description":"action"
                },
                "autoAuth":{
                    "type":"string",
                    "description":"auth status"
                },
                "modificationStatus":{
                    "type":"string",
                    "description":"modification status"
                },
                "datasegmentCode":{
                    "type":"string",
                    "description":"data segment code"
                },
                "checkerRemarks":{
                    "type":"string",
                    "description":"checker remarks"
                },
                "makerRemarks":{
                    "type":"string",
                    "description":"maker remarks"
                },
                "structureCode":{
                    "type":"string",
                    "description":"Structure Code",
                    "pattern":"[^*%]{0,50}",
                    "x-pattern-message":"ML-CTSTR-001"
                },
                "structureDescription":{
                    "type":"string",
                    "description":"Structure Description",
                    "pattern":"[^*%]{0,50}",
                    "x-pattern-message":"ML-CTSTR-002"
                },
                "structureStartDate":{
                    "type":"string",
                    "description":"Structure Start Date"
                },
                "structureEndDate":{
                    "type":"string",
                    "description":"Structure End Date"
                },
                "globalCentreId":{
                    "type":"string",
                    "description":""
                },
                "globalCentreName":{
                    "type":"string",
                    "description":""
                },
                "settlementDays":{
                    "type":"integer",
                    "description":"",
                    "pattern":"[^*%]{0,50}",
                    "x-pattern-message":"ML-CTSTR-006"
                },
                "payoutDays":{
                    "type":"integer",
                    "description":"",
                    "pattern":"[^*%]{0,50}",
                    "x-pattern-message":"ML-CTSTR-007"
                },
                "frequency":{
                    "type":"string",
                    "description":""
                },
                "dayOfTheWeek":{
                    "type":"string",
                    "description":""
                },
                "dayOfTheMonth":{
                    "type":"string",
                    "description":""
                },
                "holidayTreatment":{
                    "type":"string",
                    "description":""
                },
                "nettingCycle":{
                    "type":"integer",
                    "description":""
                },
                "previousCycle":{
                    "type":"integer",
                    "description":""
                },
                "previousCycleType":{
                    "type":"string",
                    "description":""
                },
                "createdDate":{
                    "type":"string",
                    "description":"Created Date"
                },
                "lastUpdatedTimestamp":{
                    "type":"string",
                    "description":"Last Updated Timestamp"
                }
            }
        }
    ]
}

Nested Schema : obcmTmStructureNode

Type: array

Show Source

Array of: object ObcmTmStructureNodeModel

ObcmTmStructureNode model

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

Nested Schema : ObcmTmStructureEnrichParamDetailsModel

Type: object

ObcmTmStructureEnrichParamDetails model

Show Source

actionOnNode(optional): string

Action Performed On Node
allowOverduePay(optional): string

allowOverduePay
allowOverdueRcv(optional): string

allowOverdueRcv
autoAcceptancePay(optional): string

autoAcceptancePay
autoAcceptanceRcv(optional): string

autoAcceptanceRcv
autoApproval(optional): string

autoApproval
autoDrApplicablePay(optional): string

autoDrApplicablePay
autoDrApplicableRcv(optional): string

autoDrApplicableRcv
autoDrPayin(optional): string

autoDrPayin
autoDrPayout(optional): string

autoDrPayout
depth(optional): number

Depth of the node
enrichParamMasterId(optional): string

Enrich Param master Id
entityRole(optional): string

entityRole
entityType(optional): string

entityType
existingRelationFlag(optional): string

existingRelationFlag
expiresOn(optional): string

expiresOn
globalCentreId(optional): string

globalCentreId
holidayTreatmentPay(optional): string

holidayTreatmentPay
holidayTreatmentRcv(optional): string

holidayTreatmentRcv
id(optional): string

Id of the ObcmTmStructureEnrichParamDetails
isExistingCounterparty(optional): string

Is Existing Counterparty
isFlipped(optional): string

Is Flipped Node
isNonAcceptedPayChild(optional): string

Is Non Accepted Payable Child
isNonAcceptedRcvChild(optional): string

Is Non Accepted Receivable Child
isNonAcceptedReceivable(optional): string

isNonAcceptedReceivable
isPastDuePayChild(optional): string

Is Past Due Payable Child
isPastDueRcvChild(optional): string

Is Past Due Receivable Child
isPastDueReceivable(optional): string

isPastDueReceivable
maxDaysOverduePay(optional): integer

maxDaysOverduePay
maxDaysOverdueRcv(optional): integer

maxDaysOverdueRcv
nodeAction(optional): string

Node Action- CREATE or Null
nodeIdentifier(optional): string

Node Identifier
nodeUniqueId(optional): string

Node Unique Id
noOfDays(optional): integer

No Of Days
noOfDaysPay(optional): integer

noOfDaysPay
noOfDaysPayChild(optional): integer

No Of Days Payable Child
noOfDaysRcv(optional): integer

noOfDaysRcv
noOfDaysRcvChild(optional): integer

No Of Days Receivable Child
parentId(optional): string

parent Id
parentName(optional): string

parent Name
parentNodeIdentifier(optional): string

Parent Node Identifier
participationFlag(optional): string

participationFlag
relationshipCode(optional): string

relationshipCode
relationshipModNo(optional): integer

relationshipModNo
relationshipName(optional): string

relationshipName
relationshipOwnerId(optional): string

Relationship Owner Id
relationshipOwnerName(optional): string

Relationship Owner Name
settlementCcy(optional): string

settlementCcy
status(optional): string

status
structureCode(optional): string

Structure Code
structureDescription(optional): string

Structure Description
subCentreId(optional): string

subCentreId
subsidiaryId(optional): string

subsidiaryId
subsidiaryName(optional): string

subsidiaryName
validateLinkedPoPay(optional): string

validateLinkedPoPay
validateLinkedPoRcv(optional): string

validateLinkedPoRcv

{
    "description":"ObcmTmStructureEnrichParamDetails model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id of the ObcmTmStructureEnrichParamDetails",
            "type":"string"
        },
        "nodeIdentifier":{
            "description":"Node Identifier",
            "type":"string"
        },
        "parentNodeIdentifier":{
            "description":"Parent Node Identifier",
            "type":"string"
        },
        "subsidiaryId":{
            "description":"subsidiaryId",
            "type":"string"
        },
        "globalCentreId":{
            "description":"globalCentreId",
            "type":"string"
        },
        "subCentreId":{
            "description":"subCentreId",
            "type":"string"
        },
        "subsidiaryName":{
            "description":"subsidiaryName",
            "type":"string"
        },
        "entityType":{
            "description":"entityType",
            "type":"string"
        },
        "entityRole":{
            "description":"entityRole",
            "type":"string"
        },
        "autoApproval":{
            "description":"autoApproval",
            "type":"string"
        },
        "settlementCcy":{
            "description":"settlementCcy",
            "type":"string"
        },
        "autoDrPayout":{
            "description":"autoDrPayout",
            "type":"string"
        },
        "autoDrPayin":{
            "description":"autoDrPayin",
            "type":"string"
        },
        "participationFlag":{
            "description":"participationFlag",
            "type":"string"
        },
        "isPastDueReceivable":{
            "description":"isPastDueReceivable",
            "type":"string"
        },
        "isNonAcceptedReceivable":{
            "description":"isNonAcceptedReceivable",
            "type":"string"
        },
        "relationshipCode":{
            "description":"relationshipCode",
            "type":"string"
        },
        "relationshipName":{
            "description":"relationshipName",
            "type":"string"
        },
        "autoDrApplicableRcv":{
            "description":"autoDrApplicableRcv",
            "type":"string"
        },
        "holidayTreatmentRcv":{
            "description":"holidayTreatmentRcv",
            "type":"string"
        },
        "autoAcceptanceRcv":{
            "description":"autoAcceptanceRcv",
            "type":"string"
        },
        "noOfDaysRcv":{
            "description":"noOfDaysRcv",
            "type":"integer"
        },
        "allowOverdueRcv":{
            "description":"allowOverdueRcv",
            "type":"string"
        },
        "maxDaysOverdueRcv":{
            "description":"maxDaysOverdueRcv",
            "type":"integer"
        },
        "validateLinkedPoRcv":{
            "description":"validateLinkedPoRcv",
            "type":"string"
        },
        "autoDrApplicablePay":{
            "description":"autoDrApplicablePay",
            "type":"string"
        },
        "holidayTreatmentPay":{
            "description":"holidayTreatmentPay",
            "type":"string"
        },
        "autoAcceptancePay":{
            "description":"autoAcceptancePay",
            "type":"string"
        },
        "noOfDaysPay":{
            "description":"noOfDaysPay",
            "type":"integer"
        },
        "allowOverduePay":{
            "description":"allowOverduePay",
            "type":"string"
        },
        "maxDaysOverduePay":{
            "description":"maxDaysOverduePay",
            "type":"integer"
        },
        "validateLinkedPoPay":{
            "description":"validateLinkedPoPay",
            "type":"string"
        },
        "relationshipModNo":{
            "description":"relationshipModNo",
            "type":"integer"
        },
        "existingRelationFlag":{
            "description":"existingRelationFlag",
            "type":"string"
        },
        "isExistingCounterparty":{
            "description":"Is Existing Counterparty",
            "type":"string"
        },
        "expiresOn":{
            "description":"expiresOn",
            "type":"string"
        },
        "status":{
            "description":"status",
            "type":"string"
        },
        "depth":{
            "description":"Depth of the node",
            "type":"number"
        },
        "enrichParamMasterId":{
            "description":"Enrich Param master Id",
            "type":"string"
        },
        "parentId":{
            "description":"parent Id",
            "type":"string"
        },
        "relationshipOwnerId":{
            "description":"Relationship Owner Id",
            "type":"string"
        },
        "relationshipOwnerName":{
            "description":"Relationship Owner Name",
            "type":"string"
        },
        "actionOnNode":{
            "description":"Action Performed On Node",
            "type":"string"
        },
        "parentName":{
            "description":"parent Name",
            "type":"string"
        },
        "structureCode":{
            "description":"Structure Code",
            "type":"string"
        },
        "structureDescription":{
            "description":"Structure Description",
            "type":"string"
        },
        "isFlipped":{
            "description":"Is Flipped Node",
            "type":"string"
        },
        "nodeUniqueId":{
            "description":"Node Unique Id",
            "type":"string"
        },
        "isPastDueRcvChild":{
            "description":"Is Past Due Receivable Child",
            "type":"string"
        },
        "isPastDuePayChild":{
            "description":"Is Past Due Payable Child",
            "type":"string"
        },
        "isNonAcceptedRcvChild":{
            "description":"Is Non Accepted Receivable Child",
            "type":"string"
        },
        "isNonAcceptedPayChild":{
            "description":"Is Non Accepted Payable Child",
            "type":"string"
        },
        "noOfDays":{
            "description":"No Of Days",
            "type":"integer"
        },
        "noOfDaysRcvChild":{
            "description":"No Of Days Receivable Child",
            "type":"integer"
        },
        "noOfDaysPayChild":{
            "description":"No Of Days Payable Child",
            "type":"integer"
        },
        "nodeAction":{
            "description":"Node Action- CREATE or Null",
            "type":"string"
        }
    }
}

Nested Schema : GenericDto

Match All

Show Source

object GenericDto-allOf[0]

Discriminator: resource_type

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

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : ObcmTmStructureMasterModel-allOf[1]

Type: object

Show Source

action(optional): string

action
autoAuth(optional): string

auth status
checkerRemarks(optional): string

checker remarks
createdDate(optional): string

Created Date
datasegmentCode(optional): string

data segment code
dayOfTheMonth(optional): string
dayOfTheWeek(optional): string
frequency(optional): string
globalCentreId(optional): string
globalCentreName(optional): string
holidayTreatment(optional): string
id(optional): string

Id
lastUpdatedTimestamp(optional): string

Last Updated Timestamp
makerRemarks(optional): string

maker remarks
modificationStatus(optional): string

modification status
nettingCycle(optional): integer
payoutDays(optional): integer

Pattern: [^*%]{0,50}
previousCycle(optional): integer
previousCycleType(optional): string
settlementDays(optional): integer

Pattern: [^*%]{0,50}
structureCode(optional): string

Pattern: [^*%]{0,50}

Structure Code
structureDescription(optional): string

Pattern: [^*%]{0,50}

Structure Description
structureEndDate(optional): string

Structure End Date
structureStartDate(optional): string

Structure Start Date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "action":{
            "type":"string",
            "description":"action"
        },
        "autoAuth":{
            "type":"string",
            "description":"auth status"
        },
        "modificationStatus":{
            "type":"string",
            "description":"modification status"
        },
        "datasegmentCode":{
            "type":"string",
            "description":"data segment code"
        },
        "checkerRemarks":{
            "type":"string",
            "description":"checker remarks"
        },
        "makerRemarks":{
            "type":"string",
            "description":"maker remarks"
        },
        "structureCode":{
            "type":"string",
            "description":"Structure Code",
            "pattern":"[^*%]{0,50}",
            "x-pattern-message":"ML-CTSTR-001"
        },
        "structureDescription":{
            "type":"string",
            "description":"Structure Description",
            "pattern":"[^*%]{0,50}",
            "x-pattern-message":"ML-CTSTR-002"
        },
        "structureStartDate":{
            "type":"string",
            "description":"Structure Start Date"
        },
        "structureEndDate":{
            "type":"string",
            "description":"Structure End Date"
        },
        "globalCentreId":{
            "type":"string",
            "description":""
        },
        "globalCentreName":{
            "type":"string",
            "description":""
        },
        "settlementDays":{
            "type":"integer",
            "description":"",
            "pattern":"[^*%]{0,50}",
            "x-pattern-message":"ML-CTSTR-006"
        },
        "payoutDays":{
            "type":"integer",
            "description":"",
            "pattern":"[^*%]{0,50}",
            "x-pattern-message":"ML-CTSTR-007"
        },
        "frequency":{
            "type":"string",
            "description":""
        },
        "dayOfTheWeek":{
            "type":"string",
            "description":""
        },
        "dayOfTheMonth":{
            "type":"string",
            "description":""
        },
        "holidayTreatment":{
            "type":"string",
            "description":""
        },
        "nettingCycle":{
            "type":"integer",
            "description":""
        },
        "previousCycle":{
            "type":"integer",
            "description":""
        },
        "previousCycleType":{
            "type":"string",
            "description":""
        },
        "createdDate":{
            "type":"string",
            "description":"Created Date"
        },
        "lastUpdatedTimestamp":{
            "type":"string",
            "description":"Last Updated Timestamp"
        }
    }
}

Nested Schema : ObcmTmStructureNodeModel

Type: object

ObcmTmStructureNode model

Show Source

actionOnNode(optional): string

Action Performed On Node
childCount(optional): number

Child Count
depth(optional): number

Depth of the node
entityRole(optional): string

entityRole
entityType(optional): string

entityType
globalCentreId(optional): string

globalCentreId
globalCentreName(optional): string

globalCentreName
id(optional): string

Id of the ObcmTmStructureNode
isFlipped(optional): string

Is Flipped Node
linkageMasterId(optional): string

Linkage Master Id
nodeAction(optional): string

Node Action- CREATE or Null
nodeIdentifier(optional): string

Node Identifier
nodeUniqueId(optional): string

Node Unique Id
parentId(optional): string

parent Id
parentName(optional): string

parent Name
parentNodeIdentifier(optional): string

Parent Node Identifier
settlementCcy(optional): string

settlementCcy
structureCode(optional): string

Structure Code
structureDescription(optional): string

Structure Description
subCentreId(optional): string

subCentreId
subCentreName(optional): string

subCentreName
subsidiaryId(optional): string

subsidiaryId
subsidiaryName(optional): string

subsidiaryName

{
    "description":"ObcmTmStructureNode model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id of the ObcmTmStructureNode",
            "type":"string"
        },
        "nodeIdentifier":{
            "description":"Node Identifier",
            "type":"string"
        },
        "parentNodeIdentifier":{
            "description":"Parent Node Identifier",
            "type":"string"
        },
        "subCentreId":{
            "description":"subCentreId",
            "type":"string"
        },
        "globalCentreId":{
            "description":"globalCentreId",
            "type":"string"
        },
        "subCentreName":{
            "description":"subCentreName",
            "type":"string"
        },
        "globalCentreName":{
            "description":"globalCentreName",
            "type":"string"
        },
        "settlementCcy":{
            "description":"settlementCcy",
            "type":"string"
        },
        "subsidiaryId":{
            "description":"subsidiaryId",
            "type":"string"
        },
        "subsidiaryName":{
            "description":"subsidiaryName",
            "type":"string"
        },
        "entityType":{
            "description":"entityType",
            "type":"string"
        },
        "entityRole":{
            "description":"entityRole",
            "type":"string"
        },
        "depth":{
            "description":"Depth of the node",
            "type":"number"
        },
        "childCount":{
            "description":"Child Count",
            "type":"number"
        },
        "parentId":{
            "description":"parent Id",
            "type":"string"
        },
        "actionOnNode":{
            "description":"Action Performed On Node",
            "type":"string"
        },
        "linkageMasterId":{
            "description":"Linkage Master Id",
            "type":"string"
        },
        "parentName":{
            "description":"parent Name",
            "type":"string"
        },
        "structureCode":{
            "description":"Structure Code",
            "type":"string"
        },
        "structureDescription":{
            "description":"Structure Description",
            "type":"string"
        },
        "isFlipped":{
            "description":"Is Flipped Node",
            "type":"string"
        },
        "nodeUniqueId":{
            "description":"Node Unique Id",
            "type":"string"
        },
        "nodeAction":{
            "description":"Node Action- CREATE or Null",
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

200 Response

Returns the success

Root Schema : UpdateStructureTreeResponse

Type: object

Update Structure Tree Response

Show Source

errorCode(optional): string

Error Code
errorDesc(optional): string

Error Desc
externalRefNo(optional): string

External Reference Number for the update request
status(optional): string

Status - SUCCESS OR FAILED

{
    "description":"Update Structure Tree Response",
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"Error Code",
            "type":"string"
        },
        "errorDesc":{
            "description":"Error Desc",
            "type":"string"
        },
        "externalRefNo":{
            "description":"External Reference Number for the update request",
            "type":"string"
        },
        "status":{
            "description":"Status - SUCCESS OR FAILED",
            "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