Jump to

• Request
• Response

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 not

  Default Value: false
• sellerId: string
  buyerId need to be set to fetch summary record

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string

Body ()

Root Schema : ObcmTmRelationshipMasterCollection

Type: object

Collection of relationship.

Show Source

• data: array data
• paging: object PagingDto
  Paging Dto

{
    "description":"Collection of relationship.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ObcmTmRelationshipMasterDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object ObcmTmRelationshipMasterDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ObcmTmRelationshipMasterDTO"
    }
}

Nested Schema : PagingDto

Type: object

Paging Dto

Show Source

• totalResults: integer
  Total Results

{
    "type":"object",
    "description":"Paging Dto",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"Total Results"
        }
    }
}

Nested Schema : ObcmTmRelationshipMasterDTO

Type: object

Show Source

• autoAcceptance: string
  Auto Acceptance
• autoDebitApplicable: string
• corporateId: string
  Corporate Id
• corporateName: string
  Corporate Name
• effFromDate: string
  Effective From Date
• expiresOn: string
  Expires On
• maxDate: string
  Maximum Date
• noOfDays: integer
  Number of Days
• ObcmTmRelationshipDetailsDTO: array ObcmTmRelationshipDetailsDTO
• product: string
  Product
• relationshipCode: string
  Relationship Code
• relationshipName: string
  Relationship Name
• txnControllerRefNo: string
  Transaction Controller Reference Number

{
    "type":"object",
    "properties":{
        "autoAcceptance":{
            "type":"string",
            "description":"Auto Acceptance"
        },
        "corporateId":{
            "type":"string",
            "description":"Corporate Id"
        },
        "corporateName":{
            "type":"string",
            "description":"Corporate Name"
        },
        "effFromDate":{
            "type":"string",
            "description":"Effective From Date"
        },
        "relationshipCode":{
            "type":"string",
            "description":"Relationship Code"
        },
        "relationshipName":{
            "type":"string",
            "description":"Relationship Name"
        },
        "expiresOn":{
            "type":"string",
            "description":"Expires On"
        },
        "product":{
            "type":"string",
            "description":"Product"
        },
        "noOfDays":{
            "type":"integer",
            "description":"Number of Days"
        },
        "maxDate":{
            "type":"string",
            "description":"Maximum Date"
        },
        "txnControllerRefNo":{
            "type":"string",
            "description":"Transaction Controller Reference Number"
        },
        "autoDebitApplicable":{
            "type":"string"
        },
        "ObcmTmRelationshipDetailsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ObcmTmRelationshipDetailsDTO"
            }
        }
    }
}

Nested Schema : ObcmTmRelationshipDetailsDTO

Type: array

Show Source

• Array of: object ObcmTmRelationshipDetailsDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ObcmTmRelationshipDetailsDTO"
    }
}

Nested Schema : ObcmTmRelationshipDetailsDTO

Type: object

Show Source

• autoAcceptance: string
  Auto Acceptance
• autoDebitApplicable: string
• counterpartyid: string
  Counterparty id
• counterpartyname: string
  Counterparty name
• expiresOn: string
  Expires On
• externalCodes: array externalCodes
  External Codes
• id: string
  Id
• nonCust: object ScfTmNonCustomerMasterDTO
• noOfDays: integer
  Number of Days
• partyType: string
  Party Type
• relationsMasterId: string
  Relations Master Id
• status: string
  Status

{
    "type":"object",
    "properties":{
        "autoAcceptance":{
            "type":"string",
            "description":"Auto Acceptance"
        },
        "counterpartyid":{
            "type":"string",
            "description":"Counterparty id"
        },
        "counterpartyname":{
            "type":"string",
            "description":"Counterparty name"
        },
        "id":{
            "type":"string",
            "description":"Id"
        },
        "partyType":{
            "type":"string",
            "description":"Party Type"
        },
        "relationsMasterId":{
            "type":"string",
            "description":"Relations Master Id"
        },
        "expiresOn":{
            "type":"string",
            "description":"Expires On"
        },
        "noOfDays":{
            "type":"integer",
            "description":"Number of Days"
        },
        "status":{
            "type":"string",
            "description":"Status"
        },
        "autoDebitApplicable":{
            "type":"string"
        },
        "externalCodes":{
            "type":"array",
            "description":"External Codes",
            "items":{
                "$ref":"#/definitions/ObcmTmRelationshipDetailsExternalCodeDTO"
            }
        },
        "nonCust":{
            "$ref":"#/definitions/ScfTmNonCustomerMasterDTO"
        }
    }
}

Nested Schema : externalCodes

Type: array

External Codes

Show Source

• Array of: object ObcmTmRelationshipDetailsExternalCodeDTO

{
    "type":"array",
    "description":"External Codes",
    "items":{
        "$ref":"#/definitions/ObcmTmRelationshipDetailsExternalCodeDTO"
    }
}

Nested Schema : ScfTmNonCustomerMasterDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object ScfTmNonCustomerMasterDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "category":{
                    "type":"string",
                    "description":"Category"
                },
                "cif":{
                    "type":"string",
                    "description":"Cif"
                },
                "countryCode":{
                    "type":"string",
                    "description":"Country Code"
                },
                "email":{
                    "type":"string",
                    "description":"Email"
                },
                "faxNumber":{
                    "type":"string",
                    "description":"Fax Number"
                },
                "giin":{
                    "type":"string",
                    "description":"Giin"
                },
                "industry":{
                    "type":"string",
                    "description":"Industry"
                },
                "mobileNumber":{
                    "type":"string",
                    "description":"Mobile Number"
                },
                "name":{
                    "type":"string",
                    "description":"Name"
                },
                "nonCustomerId":{
                    "type":"string",
                    "description":"Non Customer Id"
                },
                "phoneNumber":{
                    "type":"string",
                    "description":"Phone Number"
                },
                "prefferedCommMode":{
                    "type":"string",
                    "description":"Preffered Comm Mode"
                },
                "registrationNumber":{
                    "type":"string",
                    "description":"Registration Number"
                },
                "shortName":{
                    "type":"string",
                    "description":"Short Name"
                },
                "taxRefNo1":{
                    "type":"string",
                    "description":"Tax Reference Number1"
                },
                "taxRefNo2":{
                    "type":"string",
                    "description":"Tax Reference Number2"
                },
                "fatca":{
                    "type":"string",
                    "description":"Fatca"
                },
                "relationshipRefNo":{
                    "type":"string",
                    "description":"Relationship Reference Number"
                },
                "channel":{
                    "type":"string",
                    "description":"Channel"
                },
                "docMgmtSystemId":{
                    "type":"string",
                    "description":"Doc Management System Id"
                },
                "action":{
                    "type":"string",
                    "description":"Action"
                },
                "ScfTmNcAddressMasterDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ScfTmNcAddressMasterDTO"
                    }
                },
                "ScfTmNcRequestMasterDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ScfTmNcRequestMasterDTO"
                    }
                },
                "ScfDivisionDetailsDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ScfDivisionDetailsDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : ObcmTmRelationshipDetailsExternalCodeDTO

Type: object

Show Source

• corporateDivisionCode: string
  Corporate Division Code
• divisionCode: string
  Division Code
• externalCode: string
  External Code
• id: string
  Id
• relationshipDetailId: string
  Relationship Detail Id

{
    "type":"object",
    "properties":{
        "externalCode":{
            "type":"string",
            "description":"External Code"
        },
        "divisionCode":{
            "type":"string",
            "description":"Division Code"
        },
        "corporateDivisionCode":{
            "type":"string",
            "description":"Corporate Division Code"
        },
        "id":{
            "type":"string",
            "description":"Id"
        },
        "relationshipDetailId":{
            "type":"string",
            "description":"Relationship Detail Id"
        }
    }
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : ScfTmNonCustomerMasterDTO-allOf[1]

Type: object

Show Source

• action: string
  Action
• category: string
  Category
• channel: string
  Channel
• cif: string
  Cif
• countryCode: string
  Country Code
• docMgmtSystemId: string
  Doc Management System Id
• email: string
  Email
• fatca: string
  Fatca
• faxNumber: string
  Fax Number
• giin: string
  Giin
• industry: string
  Industry
• mobileNumber: string
  Mobile Number
• name: string
  Name
• nonCustomerId: string
  Non Customer Id
• phoneNumber: string
  Phone Number
• prefferedCommMode: string
  Preffered Comm Mode
• registrationNumber: string
  Registration Number
• relationshipRefNo: string
  Relationship Reference Number
• ScfDivisionDetailsDTO: array ScfDivisionDetailsDTO
• ScfTmNcAddressMasterDTO: array ScfTmNcAddressMasterDTO
• ScfTmNcRequestMasterDTO: array ScfTmNcRequestMasterDTO
• shortName: string
  Short Name
• taxRefNo1: string
  Tax Reference Number1
• taxRefNo2: string
  Tax Reference Number2

{
    "type":"object",
    "properties":{
        "category":{
            "type":"string",
            "description":"Category"
        },
        "cif":{
            "type":"string",
            "description":"Cif"
        },
        "countryCode":{
            "type":"string",
            "description":"Country Code"
        },
        "email":{
            "type":"string",
            "description":"Email"
        },
        "faxNumber":{
            "type":"string",
            "description":"Fax Number"
        },
        "giin":{
            "type":"string",
            "description":"Giin"
        },
        "industry":{
            "type":"string",
            "description":"Industry"
        },
        "mobileNumber":{
            "type":"string",
            "description":"Mobile Number"
        },
        "name":{
            "type":"string",
            "description":"Name"
        },
        "nonCustomerId":{
            "type":"string",
            "description":"Non Customer Id"
        },
        "phoneNumber":{
            "type":"string",
            "description":"Phone Number"
        },
        "prefferedCommMode":{
            "type":"string",
            "description":"Preffered Comm Mode"
        },
        "registrationNumber":{
            "type":"string",
            "description":"Registration Number"
        },
        "shortName":{
            "type":"string",
            "description":"Short Name"
        },
        "taxRefNo1":{
            "type":"string",
            "description":"Tax Reference Number1"
        },
        "taxRefNo2":{
            "type":"string",
            "description":"Tax Reference Number2"
        },
        "fatca":{
            "type":"string",
            "description":"Fatca"
        },
        "relationshipRefNo":{
            "type":"string",
            "description":"Relationship Reference Number"
        },
        "channel":{
            "type":"string",
            "description":"Channel"
        },
        "docMgmtSystemId":{
            "type":"string",
            "description":"Doc Management System Id"
        },
        "action":{
            "type":"string",
            "description":"Action"
        },
        "ScfTmNcAddressMasterDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfTmNcAddressMasterDTO"
            }
        },
        "ScfTmNcRequestMasterDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfTmNcRequestMasterDTO"
            }
        },
        "ScfDivisionDetailsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfDivisionDetailsDTO"
            }
        }
    }
}

Nested Schema : ScfDivisionDetailsDTO

Type: array

Show Source

• Array of: object ScfDivisionDetailsDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ScfDivisionDetailsDTO"
    }
}

Nested Schema : ScfTmNcAddressMasterDTO

Type: array

Show Source

• Array of: object ScfTmNcAddressMasterDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ScfTmNcAddressMasterDTO"
    }
}

Nested Schema : ScfTmNcRequestMasterDTO

Type: array

Show Source

• Array of: object ScfTmNcRequestMasterDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ScfTmNcRequestMasterDTO"
    }
}

Nested Schema : ScfDivisionDetailsDTO

Type: object

Show Source

• buyerCode: string
  Buyer Code
• buyerDivision: string
  Buyer Division
• externalCode: string
  External Code
• sellerCode: string
  Seller Code
• sellerDivision: string
  Seller Division

{
    "type":"object",
    "properties":{
        "externalCode":{
            "type":"string",
            "description":"External Code"
        },
        "buyerCode":{
            "type":"string",
            "description":"Buyer Code"
        },
        "buyerDivision":{
            "type":"string",
            "description":"Buyer Division"
        },
        "sellerCode":{
            "type":"string",
            "description":"Seller Code"
        },
        "sellerDivision":{
            "type":"string",
            "description":"Seller Division"
        }
    }
}

Nested Schema : ScfTmNcAddressMasterDTO

Type: object

Show Source

• addressLine1: string
  Address Line1
• addressLine2: string
  Address Line2
• addressLine3: string
  Address Line3
• addressLine4: string
  Address Line4
• addressType: string
  Address Type
• country: string
  Country
• countryName: string
  Country Name
• id: string
  Id
• nonCustMasterId: string
  Non Customer Master Id
• nonCustomerId: string
  Non Customer Id
• pin: string
  Pin
• street: string
  Street

{
    "type":"object",
    "properties":{
        "addressLine1":{
            "type":"string",
            "description":"Address Line1"
        },
        "addressLine2":{
            "type":"string",
            "description":"Address Line2"
        },
        "addressLine3":{
            "type":"string",
            "description":"Address Line3"
        },
        "addressLine4":{
            "type":"string",
            "description":"Address Line4"
        },
        "addressType":{
            "type":"string",
            "description":"Address Type"
        },
        "country":{
            "type":"string",
            "description":"Country"
        },
        "countryName":{
            "type":"string",
            "description":"Country Name"
        },
        "id":{
            "type":"string",
            "description":"Id"
        },
        "nonCustMasterId":{
            "type":"string",
            "description":"Non Customer Master Id"
        },
        "pin":{
            "type":"string",
            "description":"Pin"
        },
        "street":{
            "type":"string",
            "description":"Street"
        },
        "nonCustomerId":{
            "type":"string",
            "description":"Non Customer Id"
        }
    }
}

Nested Schema : ScfTmNcRequestMasterDTO

Type: object

Show Source

• anchorId(required): string
  Anchor Id
• anchorName: string
  Anchor Name
• id: string
  Id
• nonCustMasterId: string
  Non Customer Master Id
• nonCustomerCode: string
  Non Customer Code
• nonCustomerId: string
  Non Customer Id
• status: string
  Status

{
    "type":"object",
    "properties":{
        "anchorId":{
            "type":"string",
            "description":"Anchor Id"
        },
        "anchorName":{
            "type":"string",
            "description":"Anchor Name"
        },
        "id":{
            "type":"string",
            "description":"Id"
        },
        "nonCustomerCode":{
            "type":"string",
            "description":"Non Customer Code"
        },
        "nonCustMasterId":{
            "type":"string",
            "description":"Non Customer Master Id"
        },
        "status":{
            "type":"string",
            "description":"Status"
        },
        "nonCustomerId":{
            "type":"string",
            "description":"Non Customer Id"
        }
    },
    "required":[
        "anchorId"
    ]
}

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

Back to Top