Fetch the existing relationships between associated parties
get
/service/v1/getRelationships
This endpoint is used to fetch the existing relationships between associated parties.
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
-
relationshipCode(required): string
Relationship Code to fetch the relationship
Header Parameters
-
appId(required): string
Source App Id
-
branchCode(required): string
Branch Code
-
userId(required): string
Source User Id
Response
Supported Media Types
- application/json
- application/xml
201 Response
Returns the details of the existing Relationship between Associated parties
Headers
Root Schema : RelationshipResponseDTO
Type:
Show Source
object
-
corporateId:
string
Corporate Id
-
obcmTmRelationshipRecOrPayDTO:
object ObcmTmRelationshipRecOrPayDTO
-
relationshipCode:
string
Relationship Code
-
relationshipName:
string
Relationship Name
Nested Schema : ObcmTmRelationshipRecOrPayDTO
Type:
Show Source
object
-
allowOverdueRcv:
string
Allow Overdue Receivables
-
autoAcceptance:
string
Auto Acceptance
-
autoDebitApplicable:
string
Auto Debit Applicable
-
autoDebitBasis:
string
-
counterpartyId:
string
Counterparty Id of the relationship fetched
-
effFromDate:
string
Effective date of the Relationship
-
excessHandling:
string
Excess Handling
-
excessRefundParty:
string
Excess Refund Party
-
excessRefundPaymentMode:
string
Excess Refund Payment Mode
-
expiresOn:
string
Expiry date of the Relationship
-
holidayTreatment:
string
Holiday Treatment
-
maxDaysOverdue:
integer
Max Days Overdue
-
modNo:
integer
Mod number of the Relationship
-
noOfDays:
integer
Number of Days
-
partyType:
string
Partytype of the counterparty of the relationship fetched
-
salesContractReferenceNumber:
string
-
status:
string
Status of the Relationship
-
validateLinkedPO:
string
Validate Linked PO
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