Rest API for Oracle Banking Cash Management

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

Response

Supported Media Types

application/json
application/xml

201 Response

Returns message of succes or failure

Headers

Location: string

Root Schema : ObcmTmRelationshipMasterCollection

Type: object

Collection of obcmtmrelationshipmaster.

Show Source

data: array data
paging: 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: integer

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

Nested Schema : ObcmTmRelationshipMasterDTO

Type: object

Match All

Show Source

allOf GenericDto
object ObcmTmRelationshipMasterDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"Id"
                },
                "action":{
                    "type":"string",
                    "description":"Action"
                },
                "autoAuth":{
                    "type":"string",
                    "description":"Auto Auth"
                },
                "modificationStatus":{
                    "type":"string",
                    "description":"Modification Status"
                },
                "datasegmentCode":{
                    "type":"string",
                    "description":"Datasegment Code"
                },
                "checkerRemarks":{
                    "type":"string",
                    "description":"checkerRemarks"
                },
                "makerRemarks":{
                    "type":"string",
                    "description":"makerRemarks"
                },
                "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"
                },
                "holidayTreatment":{
                    "type":"string",
                    "description":"Holiday Treatment"
                },
                "autoDebitApplicable":{
                    "type":"string",
                    "description":"Auto Debit Applicable"
                },
                "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"
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

object GenericDto-allOf[0]
Generic Response.

{
    "allOf":[
        {
            "type":"object"
        },
        {
            "description":"Generic Response.",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Nested Schema : ObcmTmRelationshipMasterDTO-allOf[1]

Type: object

Show Source

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

Corporate Id
corporateName: string

Corporate Name
datasegmentCode: string

Datasegment Code
effFromDate: string

Effective From Date
excessHandling: string

Excess Handling
excessRefundParty: string

Excess Refund Party
excessRefundPaymentMode: string

Excess Refund Payment Mode
expiresOn: string

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
product: string

Product
relationshipCode: string

Relationship Code
relationshipName: string

Relationship Name
txnControllerRefNo: string

Transaction Controller Reference Number

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "action":{
            "type":"string",
            "description":"Action"
        },
        "autoAuth":{
            "type":"string",
            "description":"Auto Auth"
        },
        "modificationStatus":{
            "type":"string",
            "description":"Modification Status"
        },
        "datasegmentCode":{
            "type":"string",
            "description":"Datasegment Code"
        },
        "checkerRemarks":{
            "type":"string",
            "description":"checkerRemarks"
        },
        "makerRemarks":{
            "type":"string",
            "description":"makerRemarks"
        },
        "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"
        },
        "holidayTreatment":{
            "type":"string",
            "description":"Holiday Treatment"
        },
        "autoDebitApplicable":{
            "type":"string",
            "description":"Auto Debit Applicable"
        },
        "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"
        }
    }
}

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