Get all valid master datasegment details
get
/web/v1/relationshipmaster
This endpoints will be used to Get all valid master datasegment maintenance records.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
authStat(optional): string
auth status of the records to be fetched
-
corporateId(optional): string
corporateId need to be set to fetch summary record
-
includecloseandunauth(optional): boolean
includecloseandunauth need to be set to fetch summary record, defult value is false
-
limit(optional): integer
limit is maximum no of records to be fetched
-
offset(optional): integer
offset is starting no of records to be fetched
-
product(optional): string
product need to be set to fetch summary record
-
recordStat(optional): string
records status of the records to be fetched
-
relationshipCode(optional): string
relationshipCode need to be set to fetch summary record
-
relationshipName(optional): string
relationshipName need to be set to fetch summary record
Response
Supported Media Types
- application/json
- application/xml
200 Response
Returns message of succes or failure
Headers
-
Location: string
Location
Root Schema : ObcmTmRelationshipMasterCollection
Type:
object
Collection of obcmtmrelationshipmaster.
Show Source
-
data(optional):
array data
-
paging(optional):
object PagingDto
Contains the paging data like Total Results and Next/Prev Links
Nested Schema : PagingDto
Type:
object
Contains the paging data like Total Results and Next/Prev Links
Show Source
Nested Schema : ObcmTmRelationshipMasterDTO
Type:
object
Match All
Show Source
-
allOf
GenericDto
GenericDto contains the generic transactional data and which extends RepresentationModel of Spring HATEOAS
-
object
ObcmTmRelationshipMasterDTO-allOf[1]
Nested Schema : GenericDto
GenericDto contains the generic transactional data and which extends RepresentationModel of Spring HATEOAS
Match All
Show Source
-
object
GenericDto-allOf[0]
Discriminator:
resource_type
Nested Schema : GenericDto-allOf[0]
Type:
object
Discriminator:
resource_type
Nested Schema : ObcmTmRelationshipMasterDTO-allOf[1]
Type:
Show Source
object
-
action(optional):
string
Action
-
allowOverdueRcv(optional):
string
Allow Overdue Receivables
-
autoAcceptance(optional):
string
Auto Acceptance
-
autoAuth(optional):
string
Auto Auth
-
autoDebitApplicable(optional):
string
Auto Debit Applicable
-
checkerRemarks(optional):
string
checkerRemarks
-
corporateId(optional):
string
Corporate Id
-
corporateName(optional):
string
Corporate Name
-
datasegmentCode(optional):
string
Datasegment Code
-
effFromDate(optional):
string
Effective From Date
-
excessHandling(optional):
string
Excess Handling
-
excessRefundParty(optional):
string
Excess Refund Party
-
excessRefundPaymentMode(optional):
string
Excess Refund Payment Mode
-
expiresOn(optional):
string
Expires On
-
holidayTreatment(optional):
string
Holiday Treatment
-
id(optional):
string
Id
-
makerRemarks(optional):
string
makerRemarks
-
maxDate(optional):
string
Maximum Date
-
maxDaysOverdue(optional):
integer
Maximum Days Overdue
-
modificationStatus(optional):
string
Modification Status
-
noOfDays(optional):
integer
Number of Days
-
ObcmTmRelationshipDetailsDTO(optional):
array ObcmTmRelationshipDetailsDTO
-
product(optional):
string
Product
-
relationshipCode(optional):
string
Relationship Code
-
relationshipName(optional):
string
Relationship Name
-
txnControllerRefNo(optional):
string
Transaction Controller Reference Number
Nested Schema : ObcmTmRelationshipDetailsDTO
Type:
Show Source
object
-
allowOverdueRcv(optional):
string
Allow Overdue Receivables
-
autoAcceptance(optional):
string
Auto Acceptance
-
autoDebitApplicable(optional):
string
Auto Debit Applicable
-
counterpartyid(optional):
string
Counterparty Id
-
counterpartyname(optional):
string
Counterparty Name
-
excessHandling(optional):
string
Excess Handling
-
excessRefundParty(optional):
string
Excess Refund Party
-
excessRefundPaymentMode(optional):
string
Excess Refund Payment Mode
-
expiresOn(optional):
string
Expires On
-
externalCodes(optional):
array externalCodes
External Codes
-
holidayTreatment(optional):
string
Holiday Treatment
-
id(optional):
string
Id
-
maxDaysOverdue(optional):
integer
Maximum Days Overdue
-
nonCust(optional):
object ScfTmNonCustomerMasterDTO
-
noOfDays(optional):
integer
Number of Days
-
partyType(optional):
string
Party Type
-
programCode(optional):
string
Program Code
-
registrationNumber(optional):
string
registrationNumber
-
relationsMasterId(optional):
string
Relations Master Id
-
status(optional):
string
Status
Nested Schema : ScfTmNonCustomerMasterDTO
Type:
object
Match All
Show Source
-
allOf
GenericDto
GenericDto contains the generic transactional data and which extends RepresentationModel of Spring HATEOAS
-
object
ScfTmNonCustomerMasterDTO-allOf[1]
Nested Schema : ObcmTmRelationshipDetailsExternalCodeDTO
Type:
Show Source
object
-
corporateDivisionCode(optional):
string
Corporate Division Code
-
divisionCode(optional):
string
Division Code
-
externalCode(optional):
string
External Code
-
id(optional):
string
Id
-
modNo(optional):
integer
-
relationshipDetailId(optional):
string
Relationship Detail Id
Nested Schema : ScfTmNonCustomerMasterDTO-allOf[1]
Type:
Show Source
object
-
action(optional):
string
Action
-
category(optional):
string
Category
-
channel(optional):
string
Channel
-
cif(optional):
string
Cif
-
countryCode(optional):
string
Country Code
-
docMgmtSystemId(optional):
string
Doc Management System Id
-
email(optional):
string
Email
-
fatca(optional):
string
Fatca
-
faxNumber(optional):
string
Fax Number
-
giin(optional):
string
Giin
-
industry(optional):
string
Industry
-
mobileNumber(optional):
string
Mobile Number
-
name(optional):
string
Name
-
nonCustomerId(optional):
string
Non Customer Id
-
phoneNumber(optional):
string
Phone Number
-
prefferedCommMode(optional):
string
Preffered Comm Mode
-
registrationNumber(optional):
string
Registration Number
-
relationshipRefNo(optional):
string
Relationship Reference Number
-
ScfDivisionDetailsDTO(optional):
array ScfDivisionDetailsDTO
-
ScfTmNcAddressMasterDTO(optional):
array ScfTmNcAddressMasterDTO
-
ScfTmNcRequestMasterDTO(optional):
array ScfTmNcRequestMasterDTO
-
shortName(optional):
string
Short Name
-
taxRefNo1(optional):
string
Tax Reference Number1
-
taxRefNo2(optional):
string
Tax Reference Number2
Nested Schema : ScfDivisionDetailsDTO
Type:
Show Source
object
-
buyerCode(optional):
string
Buyer Code
-
buyerDivision(optional):
string
Buyer Division
-
externalCode(optional):
string
External Code
-
sellerCode(optional):
string
Seller Code
-
sellerDivision(optional):
string
Seller Division
Nested Schema : ScfTmNcAddressMasterDTO
Type:
Show Source
object
-
addressLine1(optional):
string
Address Line1
-
addressLine2(optional):
string
Address Line2
-
addressLine3(optional):
string
Address Line3
-
addressLine4(optional):
string
Address Line4
-
addressType(optional):
string
Address Type
-
country(optional):
string
Country
-
countryName(optional):
string
Country Name
-
id(optional):
string
Id
-
nonCustMasterId(optional):
string
Non Customer Master Id
-
nonCustomerId(optional):
string
Non Customer Id
-
pin(optional):
string
Pin
-
street(optional):
string
Street
Nested Schema : ScfTmNcRequestMasterDTO
Type:
Show Source
object
-
anchorId:
string
Anchor Id
-
anchorName(optional):
string
Anchor Name
-
id(optional):
string
Id
-
nonCustMasterId(optional):
string
Non Customer Master Id
-
nonCustomerCode(optional):
string
Non Customer Code
-
nonCustomerId(optional):
string
Non Customer Id
-
status(optional):
string
Status
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
404 Response
Not found
405 Response
Invalid input
500 Response
Internal error