Retrieve the enrichment parameters
get
/service/v1/getStructureEnrichParams
This API is used to retrieve the enrichment parameters based on party IDs and party types.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
associatedParty1(required): string
Associated Party1
-
associatedParty1Type(required): string
Associated Party1 Type
-
associatedParty2(required): string
Associated Party2
-
associatedParty2Type(required): string
Associated Party2 Type
-
authStat: boolean
Fetch authorized record if true and unauthorized record if falseDefault Value:
true -
recordStat: string
Record type of the structure
-
relationshipCode(required): string
Relationship Code to fetch the Relationship
-
structureId: string
Structure Id to fetch the Relationship
Header Parameters
-
appId(required): string
Source Application Id
-
branchCode(required): string
Branch Code
-
userId(required): string
Source User id
Response
Supported Media Types
- application/json
- application/xml
200 Response
Returns the details of the existing Relationship between Associated parties
Root Schema : ObcmTmStructureEnrichParamDetailsModel
Type:
objectObcmTmStructureEnrichParamDetails model
Show Source
-
actionOnNode:
string
Action Performed On Node
-
allowOverduePay:
string
allowOverduePay
-
allowOverdueRcv:
string
allowOverdueRcv
-
autoAcceptancePay:
string
autoAcceptancePay
-
autoAcceptanceRcv:
string
autoAcceptanceRcv
-
autoApproval:
string
autoApproval
-
autoDrApplicablePay:
string
autoDrApplicablePay
-
autoDrApplicableRcv:
string
autoDrApplicableRcv
-
autoDrPayin:
string
autoDrPayin
-
autoDrPayout:
string
autoDrPayout
-
depth:
number
Depth of the node
-
enrichParamMasterId:
string
Enrich Param master Id
-
entityRole:
string
entityRole
-
entityType:
string
entityType
-
existingRelationFlag:
string
existingRelationFlag
-
expiresOn:
string
expiresOn
-
globalCentreId:
string
globalCentreId
-
holidayTreatmentPay:
string
holidayTreatmentPay
-
holidayTreatmentRcv:
string
holidayTreatmentRcv
-
id:
string
Id of the ObcmTmStructureEnrichParamDetails
-
isExistingCounterparty:
string
Is Existing Counterparty
-
isFlipped:
string
Is Flipped Node
-
isNonAcceptedPayChild:
string
Is Non Accepted Payable Child
-
isNonAcceptedRcvChild:
string
Is Non Accepted Receivable Child
-
isNonAcceptedReceivable:
string
isNonAcceptedReceivable
-
isPastDuePayChild:
string
Is Past Due Payable Child
-
isPastDueRcvChild:
string
Is Past Due Receivable Child
-
isPastDueReceivable:
string
isPastDueReceivable
-
maxDaysOverduePay:
integer
maxDaysOverduePay
-
maxDaysOverdueRcv:
integer
maxDaysOverdueRcv
-
nodeAction:
string
Node Action- CREATE or Null
-
nodeIdentifier:
string
Node Identifier
-
nodeUniqueId:
string
Node Unique Id
-
noOfDays:
integer
No Of Days
-
noOfDaysPay:
integer
noOfDaysPay
-
noOfDaysPayChild:
integer
No Of Days Payable Child
-
noOfDaysRcv:
integer
noOfDaysRcv
-
noOfDaysRcvChild:
integer
No Of Days Receivable Child
-
parentId:
string
parent Id
-
parentName:
string
parent Name
-
parentNodeIdentifier:
string
Parent Node Identifier
-
participationFlag:
string
participationFlag
-
payInMode:
string
PayIn Mode
-
payOutMode:
string
PayOut Mode
-
previousEntityRole:
string
Previous Entity Role of the Subsidiary
-
relationshipCode:
string
relationshipCode
-
relationshipModNo:
integer
relationshipModNo
-
relationshipName:
string
relationshipName
-
relationshipOwnerId:
string
Relationship Owner Id
-
relationshipOwnerName:
string
Relationship Owner Name
-
settlementCcy:
string
settlementCcy
-
status:
string
status
-
structureCode:
string
Structure Code
-
structureDescription:
string
Structure Description
-
subCentreId:
string
subCentreId
-
subsidiaryId:
string
subsidiaryId
-
subsidiaryName:
string
subsidiaryName
-
validateLinkedPoPay:
string
validateLinkedPoPay
-
validateLinkedPoRcv:
string
validateLinkedPoRcv
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error