Rest API for Oracle Banking Cash Management

Creates a new reconciliation rule

post

/service/v1/autoRecon

This endpoint is used to create a new reconciliation rule.

Request

Supported Media Types

application/json
application/xml

Header Parameters

appId(required): string
branchCode(required): string

branchCode
userId(required): string

userId

Request Body that contains data required for creating a new autoRecon

Root Schema : ScfTmReconMasterWrapperDTO

Type: object

Show Source

action: string

Action
isAutoAuth: string

Is Auto Authorization
modNo: integer

Mod Number
partyId: string

Party Id
partyName: string

Party Name
ReconRuleMasterList: array ReconRuleMasterList

{
    "type":"object",
    "properties":{
        "partyId":{
            "type":"string",
            "description":"Party Id"
        },
        "partyName":{
            "type":"string",
            "description":"Party Name"
        },
        "isAutoAuth":{
            "type":"string",
            "description":"Is Auto Authorization"
        },
        "action":{
            "type":"string",
            "description":"Action"
        },
        "modNo":{
            "type":"integer",
            "description":"Mod Number"
        },
        "ReconRuleMasterList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReconRuleDefMasterDTO"
            }
        }
    }
}

Nested Schema : ReconRuleMasterList

Type: array

Show Source

Array of: object ReconRuleDefMasterDTO

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

Nested Schema : ReconRuleDefMasterDTO

Type: object

Match All

Show Source

allOf GenericDto
object ReconRuleDefMasterDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "ruleAction":{
                    "type":"string",
                    "description":"Rule action"
                },
                "id":{
                    "type":"string",
                    "description":"Id"
                },
                "priority":{
                    "type":"number",
                    "description":"Priority"
                },
                "baseEntity":{
                    "type":"string",
                    "description":"Base Entity"
                },
                "baseOnAttr":{
                    "type":"string",
                    "description":"Base on attribute"
                },
                "genericCriteria":{
                    "type":"string",
                    "description":"Generic Criteria"
                },
                "reconCategory":{
                    "type":"string",
                    "description":"Recon Category"
                },
                "reconType":{
                    "type":"string",
                    "description":"Recon Type"
                },
                "executeGeneric":{
                    "type":"string",
                    "description":"Execute Generic"
                },
                "ruleDescription":{
                    "type":"string",
                    "description":"Rule description"
                },
                "ruleId":{
                    "type":"string",
                    "description":"Rule Id"
                },
                "allocationBasis":{
                    "type":"string",
                    "description":"Allocation Basis"
                },
                "GroupsAndConditions":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/GroupsAndConditions"
                    }
                },
                "AllocationList":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/AllocationDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

object GenericDto-allOf[0]
Generic Response.

{
    "allOf":[
        {
            "type":"object"
        },
        {
            "description":"Generic Response.",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Nested Schema : ReconRuleDefMasterDTO-allOf[1]

Type: object

Show Source

allocationBasis: string

Allocation Basis
AllocationList: array AllocationList
baseEntity: string

Base Entity
baseOnAttr: string

Base on attribute
executeGeneric: string

Execute Generic
genericCriteria: string

Generic Criteria
GroupsAndConditions: array GroupsAndConditions
id: string

Id
priority: number

Priority
reconCategory: string

Recon Category
reconType: string

Recon Type
ruleAction: string

Rule action
ruleDescription: string

Rule description
ruleId: string

Rule Id

{
    "type":"object",
    "properties":{
        "ruleAction":{
            "type":"string",
            "description":"Rule action"
        },
        "id":{
            "type":"string",
            "description":"Id"
        },
        "priority":{
            "type":"number",
            "description":"Priority"
        },
        "baseEntity":{
            "type":"string",
            "description":"Base Entity"
        },
        "baseOnAttr":{
            "type":"string",
            "description":"Base on attribute"
        },
        "genericCriteria":{
            "type":"string",
            "description":"Generic Criteria"
        },
        "reconCategory":{
            "type":"string",
            "description":"Recon Category"
        },
        "reconType":{
            "type":"string",
            "description":"Recon Type"
        },
        "executeGeneric":{
            "type":"string",
            "description":"Execute Generic"
        },
        "ruleDescription":{
            "type":"string",
            "description":"Rule description"
        },
        "ruleId":{
            "type":"string",
            "description":"Rule Id"
        },
        "allocationBasis":{
            "type":"string",
            "description":"Allocation Basis"
        },
        "GroupsAndConditions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GroupsAndConditions"
            }
        },
        "AllocationList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AllocationDTO"
            }
        }
    }
}

Nested Schema : AllocationList

Type: array

Show Source

Array of: object AllocationDTO

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

Nested Schema : GroupsAndConditions

Type: array

Show Source

Array of: object GroupsAndConditions

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

Nested Schema : AllocationDTO

Type: object

Show Source

allocationParameter: string

Allocation Parameter
id: string

Id
percentage: number

Percentage

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "allocationParameter":{
            "type":"string",
            "description":"Allocation Parameter"
        },
        "percentage":{
            "type":"number",
            "description":"Percentage"
        }
    }
}

Nested Schema : GroupsAndConditions

Type: object

Show Source

caseSensitive: boolean

Default Value: false

Boolean value to identify whether this condition is case sensitive
connectingOperator: string

Logical Operator applied between all groups, this is the connecting operator
groupsAndConditions: array groupsAndConditions
id: string

Unique identifier for a group or condition
isGroup: boolean

Boolean value to identify whether this child is a group or condition
level: number

This helps to identify the nesting level.
matchingCriteria: string

Matching Criteria
patternTypeLHS: object PatternTypeDTO
patternTypeRHS: object PatternTypeDTO
reconEntityAttribLHS: string

Will be provided if Single entity is LHS entity or if single entity is N. Attribute which user wants to use for recon
reconEntityAttribRHS: string

Will be provided if Single entity is RHS entity or if single entity is N. Attribute which user wants to use for recon
reconEntityLHS: string

Should be null or not present if isGroup is true
reconEntityRHS: string

Should be null or not present if isGroup is true

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a group or condition"
        },
        "caseSensitive":{
            "type":"boolean",
            "description":"Boolean value to identify whether this condition is case sensitive",
            "default":false
        },
        "isGroup":{
            "type":"boolean",
            "description":"Boolean value to identify whether this child is a group or condition"
        },
        "connectingOperator":{
            "type":"string",
            "description":"Logical Operator applied between all groups, this is the connecting operator"
        },
        "level":{
            "type":"number",
            "description":"This helps to identify the nesting level."
        },
        "matchingCriteria":{
            "type":"string",
            "description":"Matching Criteria"
        },
        "reconEntityLHS":{
            "type":"string",
            "description":"Should be null or not present if isGroup is true"
        },
        "reconEntityAttribLHS":{
            "type":"string",
            "description":"Will be provided if Single entity is LHS entity or if single entity is N. Attribute which user wants to use for recon"
        },
        "reconEntityRHS":{
            "type":"string",
            "description":"Should be null or not present if isGroup is true"
        },
        "reconEntityAttribRHS":{
            "type":"string",
            "description":"Will be provided if Single entity is RHS entity or if single entity is N. Attribute which user wants to use for recon"
        },
        "patternTypeLHS":{
            "$ref":"#/definitions/PatternTypeDTO"
        },
        "patternTypeRHS":{
            "$ref":"#/definitions/PatternTypeDTO"
        },
        "groupsAndConditions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GroupsAndConditions"
            }
        }
    }
}

Nested Schema : groupsAndConditions

Type: array

Show Source

Array of: object GroupsAndConditions

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

Nested Schema : PatternTypeDTO

Type: object

Show Source

inputValue1: string

Input Value1
inputValue2: string

Input Value2
type: string

Type

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Type"
        },
        "inputValue1":{
            "type":"string",
            "description":"Input Value1"
        },
        "inputValue2":{
            "type":"string",
            "description":"Input Value2"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

201 Response

Successfully saves a new reconcilation record

Headers

Location: string

URL of newly created autoReconRuleDef

Root Schema : ResponseModel

Type: object

Response Model

Show Source

data: object data
errors: object errors

{
    "description":"Response Model",
    "type":"object",
    "properties":{
        "data":{
            "type":"object"
        },
        "errors":{
            "type":"object"
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : errors

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