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: string
Associated Party1
-
associatedParty1Type: string
Associated Party1 Type
-
associatedParty2: string
Associated Party2
-
associatedParty2Type: string
Associated Party2 Type
-
relationshipCode: string
Relationship Code to fetch the Relationship
Header Parameters
-
appId: string
Source App Id
-
branchCode: string
Branch Code
-
userId: 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(optional):
string
Corporate Id
-
obcmTmRelationshipRecOrPayDTO(optional):
object ObcmTmRelationshipRecOrPayDTO
-
relationshipCode(optional):
string
Relationship Code
-
relationshipName(optional):
string
Relationship Name
Nested Schema : ObcmTmRelationshipRecOrPayDTO
Type:
Show Source
object
-
allowOverdueRcv(optional):
string
Allow Overdue Receivables
-
autoAcceptance(optional):
string
Auto Acceptance
-
autoDebitApplicable(optional):
string
Auto Debit Applicable
-
effFromDate(optional):
string
Effective date of the Relationship
-
excessHandling(optional):
string
Excess Handling
-
excessRefundParty(optional):
string
Excess Refund Party
-
excessRefundPaymentMode(optional):
string
Excess Refund Payment Mode
-
expiresOn(optional):
string
Expiry date of the Relationship
-
holidayTreatment(optional):
string
Holiday Treatment
-
maxDaysOverdue(optional):
integer
Max Days Overdue
-
modNo(optional):
integer
Mod number of the Relationship
-
noOfDays(optional):
integer
Number of Days
-
status(optional):
string
Status of the Relationship
-
validateLinkedPO(optional):
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