Get all valid relationship record
get
/service/v1/buyerseller/relationshipmaster
This endpoint is used to get all valid relationship record based on given set of parameters.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
buyerId: string
buyerId need to be set to fetch summary record
-
isFromServiceCall: boolean
flag to check if request is from service api or notDefault Value:
false -
sellerId: string
buyerId need to be set to fetch summary record
Response
Supported Media Types
- application/json
- application/xml
201 Response
Returns message of succes or failure
Headers
Root Schema : ObcmTmRelationshipMasterCollection
Type:
objectCollection of obcmtmrelationshipmaster.
Show Source
Nested Schema : GenericDto
Match All
Show Source
-
object
GenericDto-allOf[0]
Discriminator:
resource_type
Nested Schema : GenericDto-allOf[0]
Type:
objectDiscriminator:
resource_typeNested Schema : ObcmTmRelationshipMasterDTO-allOf[1]
Type:
Show Source
object-
action:
string
Action
-
allowOverdueRcv:
string
Allow Overdue Receivables
-
autoAcceptance:
string
Auto Acceptance
-
autoAuth:
string
Auto Auth
-
autoDebitApplicable:
string
Auto Debit Applicable
-
checkerRemarks:
string
checkerRemarks
-
corporateId:
string
Pattern:
[a-zA-Z0-9]*Corporate Id -
corporateName:
string
Corporate Name
-
datasegmentCode:
string
Datasegment Code
-
effFromDate:
string
Pattern:
([0-9]{4})-([0-9]{2})-([0-9]{2})Effective From Date -
excessHandling:
string
Excess Handling
-
excessRefundParty:
string
Excess Refund Party
-
excessRefundPaymentMode:
string
Excess Refund Payment Mode
-
expiresOn:
string
Pattern:
([0-9]{4})-([0-9]{2})-([0-9]{2})Expires On -
holidayTreatment:
string
Holiday Treatment
-
id:
string
Id
-
makerRemarks:
string
makerRemarks
-
maxDate:
string
Maximum Date
-
maxDaysOverdue:
integer
Maximum Days Overdue
-
modificationStatus:
string
Modification Status
-
noOfDays:
integer
Number of Days
-
ObcmTmRelationshipDetailsDTO:
array ObcmTmRelationshipDetailsDTO
-
payAllowOverdueRcv:
string
pay Allow Overdue Receivables
-
payAutoAcceptance:
string
pay Auto Acceptance
-
payAutoDebitApplicable:
string
pay Auto Debit Applicable
-
payExcessHandling:
string
pay Excess Handling
-
payExcessRefundParty:
string
pay Excess Refund Party
-
payExcessRefundPaymentMode:
string
pay Excess Refund Payment Mode
-
payHolidayTreatment:
string
pay Holiday Treatment
-
payMaxDaysOverdue:
integer
pay MAXIMUM Days Overdue
-
payNoOfDays:
integer
pay Number Of Days
-
payValidateLinkedPo:
string
pay Validate Linked Po
-
product:
string
Product
-
relationshipCode:
string
Minimum Length:
1Maximum Length:20Pattern:[a-zA-Z0-9]*Relationship Code -
relationshipName:
string
Pattern:
[a-zA-Z0-9_,.&@ ]*Relationship Name -
txnControllerRefNo:
string
Transaction Controller Reference Number
-
validateLinkedPO:
string
Nested Schema : ObcmTmRelationshipDetailsDTO
Type:
Show Source
object-
allowOverdueRcv:
string
Allow Overdue Receivables
-
autoAcceptance:
string
Auto Acceptance
-
autoDebitApplicable:
string
Auto Debit Applicable
-
counterpartyid:
string
Counterparty Id
-
counterpartyname:
string
Counterparty Name
-
excessHandling:
string
Excess Handling
-
excessRefundParty:
string
Excess Refund Party
-
excessRefundPaymentMode:
string
Excess Refund Payment Mode
-
expiresOn:
string
Expires On
-
externalCodes:
array externalCodes
External Codes
-
holidayTreatment:
string
Holiday Treatment
-
id:
string
Id
-
maxDaysOverdue:
integer
Maximum Days Overdue
-
modNo:
integer
-
nonCust:
object ScfTmNonCustomerMasterDTO
-
noOfDays:
integer
Number of Days
-
partyType:
string
Party Type
-
programCode:
string
Program Code
-
registrationNumber:
string
registrationNumber
-
relationsMasterId:
string
Relations Master Id
-
status:
string
Status
-
validateLinkedPO:
string
Nested Schema : ScfTmNonCustomerMasterDTO
Type:
objectNested Schema : ObcmTmRelationshipDetailsExternalCodeDTO
Type:
Show Source
object-
corporateDivisionCode:
string
Corporate Division Code
-
divisionCode:
string
Division Code
-
externalCode:
string
External Code
-
id:
string
Id
-
modNo:
integer
-
relationshipDetailId:
string
Relationship Detail Id
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