Jump to

• Request
• Response

Get all valid relationship master

get

/service/v1/buyerseller/relationshipmaster

This endpoints will be used to Get all valid relationship master maintenance records.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• buyerId(optional): string
  buyerId need to be set to fetch summary record
• sellerId(optional): 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 obcmtmrelationshipmaster.

Show Source

• data(optional): array data
• paging(optional): object PagingDto

{
    "description":"Collection of obcmtmrelationshipmaster.",
    "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

Show Source

• totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : ObcmTmRelationshipMasterDTO

Type: object

Show Source

• action(optional): string
  action
• allowOverdueRcv(optional): string
  Allow Overdue Receivables
• approverRemarks(optional): string
  approverRemarks
• authStatus(optional): string
  Authorization Status
• autoAcceptance(optional): string
  Auto Acceptance
• autoDebitApplicable(optional): string
  autoDebitApplicable
• checkerDateStamp(optional): string
  Checker Date Stamp
• checkerId(optional): string
  Checker Id
• corporateId(optional): string
  Corporate Id
• corporateName(optional): string
  Corporate Name
• doerRemarks(optional): string
  doerRemarks
• 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
  holidayTreatment
• id(optional): string
  Id
• keyId(optional): string
  keyId
• makerDateStamp(optional): string
  Maker Date Stamp
• makerId(optional): string
  Maker Id
• maxDate(optional): string
  Maximum Date
• maxDaysOverdue(optional): integer
  Maximum Days Overdue
• modNo(optional): string
  Mod Number
• noOfDays(optional): integer
  Number Of Days
• ObcmTmRelationshipDetailsDTO(optional): array ObcmTmRelationshipDetailsDTO
• onceAuth(optional): string
  Once Authorized
• product(optional): string
  Product
• recordStatus(optional): string
  Record Status
• relationshipCode(optional): string
  Relationship Code
• relationshipName(optional): string
  Relationship Name
• txnControllerRefNo(optional): string
  Transaction Controller Reference Number

{
    "type":"object",
    "properties":{
        "checkerDateStamp":{
            "type":"string",
            "description":"Checker Date Stamp"
        },
        "makerDateStamp":{
            "type":"string",
            "description":"Maker Date Stamp"
        },
        "onceAuth":{
            "type":"string",
            "description":"Once Authorized"
        },
        "checkerId":{
            "type":"string",
            "description":"Checker Id"
        },
        "authStatus":{
            "type":"string",
            "description":"Authorization Status"
        },
        "recordStatus":{
            "type":"string",
            "description":"Record Status"
        },
        "makerId":{
            "type":"string",
            "description":"Maker Id"
        },
        "modNo":{
            "type":"string",
            "description":"Mod Number"
        },
        "id":{
            "type":"string",
            "description":"Id"
        },
        "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"
        },
        "allowOverdueRcv":{
            "type":"string",
            "description":"Allow Overdue Receivables"
        },
        "maxDaysOverdue":{
            "type":"integer",
            "description":"Maximum Days Overdue"
        },
        "excessHandling":{
            "type":"string",
            "description":"Excess Handling"
        },
        "excessRefundParty":{
            "type":"string",
            "description":"Excess Refund Party"
        },
        "excessRefundPaymentMode":{
            "type":"string",
            "description":"Excess Refund Payment Mode"
        },
        "txnControllerRefNo":{
            "type":"string",
            "description":"Transaction Controller Reference Number"
        },
        "holidayTreatment":{
            "type":"string",
            "description":"holidayTreatment"
        },
        "autoDebitApplicable":{
            "type":"string",
            "description":"autoDebitApplicable"
        },
        "doerRemarks":{
            "type":"string",
            "description":"doerRemarks"
        },
        "action":{
            "type":"string",
            "description":"action"
        },
        "approverRemarks":{
            "type":"string",
            "description":"approverRemarks"
        },
        "keyId":{
            "type":"string",
            "description":"keyId"
        },
        "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

• allowOverdueRcv(optional): string
  Allow Overdue Receivables
• autoAcceptance(optional): string
  Auto Acceptance
• autoDebitApplicable(optional): string
  autoDebitApplicable
• 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
  holidayTreatment
• id(optional): string
  Id
• maxDaysOverdue(optional): integer
  Maximum Days Overdue
• modNo(optional): integer
  modNo
• noOfDays(optional): integer
  Number Of Days
• partyType(optional): string
  Party Type
• relationsMasterId(optional): string
  Relations Master Id
• status(optional): 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"
        },
        "allowOverdueRcv":{
            "type":"string",
            "description":"Allow Overdue Receivables"
        },
        "maxDaysOverdue":{
            "type":"integer",
            "description":"Maximum Days Overdue"
        },
        "excessHandling":{
            "type":"string",
            "description":"Excess Handling"
        },
        "excessRefundParty":{
            "type":"string",
            "description":"Excess Refund Party"
        },
        "excessRefundPaymentMode":{
            "type":"string",
            "description":"Excess Refund Payment Mode"
        },
        "holidayTreatment":{
            "type":"string",
            "description":"holidayTreatment"
        },
        "autoDebitApplicable":{
            "type":"string",
            "description":"autoDebitApplicable"
        },
        "modNo":{
            "type":"integer",
            "description":"modNo"
        },
        "externalCodes":{
            "type":"array",
            "description":"External Codes",
            "items":{
                "$ref":"#/definitions/ObcmTmRelationshipDetailsExternalCodeDTO"
            }
        }
    }
}

Nested Schema : externalCodes

Type: array

External Codes

Show Source

• Array of: object ObcmTmRelationshipDetailsExternalCodeDTO

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

Nested Schema : ObcmTmRelationshipDetailsExternalCodeDTO

Type: object

Show Source

• 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

{
    "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"
        },
        "modNo":{
            "type":"integer"
        },
        "relationshipDetailId":{
            "type":"string",
            "description":"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

Back to Top