Jump to

• Request
• Response

Creates a new Reconciliation Rule

post

/service/v2/autoRecon

This endpoint is used to create a new Reconciliation Rule.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId: string
• branchCode: string
  branchCode
• userId: string
  userId

Body ()

Request Body that contains data required for creating a new autoRecon

Root Schema : ScfTmReconMasterWrapperDTO

Type: object

Show Source

• action(optional): string
  Action
• isAutoAuth(optional): string
  Is Auto Authorization
• modNo(optional): integer
  Mod Number
• partyId(optional): string
  Party Id
• partyName(optional): string
  Party Name
• ReconRuleMasterList(optional): 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]
  Discriminator: resource_type

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

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : ReconRuleDefMasterDTO-allOf[1]

Type: object

Show Source

• allocationBasis(optional): string
  Allocation Basis
• AllocationList(optional): array AllocationList
• baseEntity(optional): string
  Base Entity
• baseOnAttr(optional): string
  Base on attribute
• executeGeneric(optional): string
  Execute Generic
• genericCriteria(optional): string
  Generic Criteria
• GroupsAndConditions(optional): array GroupsAndConditions
• id(optional): string
  Id
• priority(optional): number
  Priority
• reconCategory(optional): string
  Recon Category
• reconType(optional): string
  Recon Type
• ruleAction(optional): string
  Rule action
• ruleDescription(optional): string
  Rule description
• ruleId(optional): 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(optional): string
  Allocation Parameter
• id(optional): string
  Id
• percentage(optional): 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(optional): boolean
  Default Value: false

  Boolean value to identify whether this condition is case sensitive
• connectingOperator(optional): string
  Logical Operator applied between all groups, this is the connecting operator
• groupsAndConditions(optional): array groupsAndConditions
• id(optional): string
  Unique identifier for a group or condition
• isGroup(optional): boolean
  Boolean value to identify whether this child is a group or condition
• level(optional): number
  This helps to identify the nesting level.
• matchingCriteria(optional): string
  Matching Criteria
• patternTypeLHS(optional): object PatternTypeDTO
• patternTypeRHS(optional): object PatternTypeDTO
• reconEntityAttribLHS(optional): 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(optional): 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(optional): string
  Should be null or not present if isGroup is true
• reconEntityRHS(optional): 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(optional): string
  Input Value1
• inputValue2(optional): string
  Input Value2
• type(optional): string
  Type

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Successfully saves a new reconcilation record

Headers

• Location: string
  URL of newly created autoReconRuleDef

Body ()

Root Schema : ResponseModel

Type: object

Show Source

• data(optional): object ReconDecResponseData
• messages(optional): object ReconResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ReconResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ReconDecResponseData"
        }
    }
}

Nested Schema : ReconDecResponseData

Type: object

Show Source

• authStatus(optional): string
  Authorization Status
• existing(optional): string
  Existing
• partyId(optional): string
  Party Id
• reconRuleResponse(optional): array reconRuleResponse

{
    "type":"object",
    "properties":{
        "partyId":{
            "type":"string",
            "description":"Party Id"
        },
        "authStatus":{
            "type":"string",
            "description":"Authorization Status"
        },
        "existing":{
            "type":"string",
            "description":"Existing"
        },
        "reconRuleResponse":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReconRuleResponse"
            }
        }
    }
}

Nested Schema : ReconResponseDto

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

Type: array

Show Source

• Array of: object ReconRuleResponse

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

Nested Schema : ReconRuleResponse

Type: object

Show Source

• ruleAuthStat(optional): string
  Rule Authorization Status
• ruleCheckerDate(optional): object ruleCheckerDate
  Rule Checker Date
• ruleCheckerId(optional): string
  Rule Checker Id
• ruleDescription(optional): string
  Rule Description
• ruleExisting(optional): string
  Rule Existing
• ruleId(optional): string
  Rule Id
• ruleMakerDate(optional): object ruleMakerDate
  Rule Maker Date
• ruleMakerId(optional): string
  Rule Maker Id

{
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string",
            "description":"Rule Id"
        },
        "ruleDescription":{
            "type":"string",
            "description":"Rule Description"
        },
        "ruleExisting":{
            "type":"string",
            "description":"Rule Existing"
        },
        "ruleAuthStat":{
            "type":"string",
            "description":"Rule Authorization Status"
        },
        "ruleMakerId":{
            "type":"string",
            "description":"Rule Maker Id"
        },
        "ruleCheckerId":{
            "type":"string",
            "description":"Rule Checker Id"
        },
        "ruleMakerDate":{
            "type":"object",
            "description":"Rule Maker Date"
        },
        "ruleCheckerDate":{
            "type":"object",
            "description":"Rule Checker Date"
        }
    }
}

Nested Schema : ruleCheckerDate

Type: object

Rule Checker Date

Nested Schema : ruleMakerDate

Type: object

Rule Maker Date

Nested Schema : codes

Type: array

Show Source

• Array of: object ResponseCode
  ResponseCode stores the response details.

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

Nested Schema : ResponseCode

Type: object

ResponseCode stores the response details.

Show Source

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

{
    "description":"ResponseCode stores the response details.",
    "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

Back to Top