Retrieves the Enrich Params based on party IDs and party types
get
/service/v1/getStructureEnrichParams
This API retrieves the Enrich Params based on party IDs and party types.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
associatedParty1: string
Associated Party1
-
associatedParty1Type: string
Associated Party1 Type
-
associatedParty2: string
Associated Party2
-
associatedParty2Type: string
Associated Party2 Type
-
authStat(optional): boolean
Fetch authorized record if true and unauthorized record if falseDefault Value:
true
-
recordStat(optional): string
Record type of the structure
-
relationshipCode: string
Relationship Code to fetch the Relationship
-
structureId(optional): string
Structure Id to fetch the Relationship
Header Parameters
-
appId: string
Source Application Id
-
branchCode: string
Branch Code
-
userId: 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:
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
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error