Rest API for Oracle Banking Cash Management

Add a new relationship record

post

/service/v1/relationshipmaster/noncustomer

This endpoint is used to add onboard a new Customer/Non-Customer.

Request

Supported Media Types

application/json
application/xml

Header Parameters

appId(required): string

appId
branchCode(required): string

branchCode
userId(required): string

userId

Request Body that contains data required for creating a new relationshipmaster

Root Schema : ObcmTmRelationshipMasterNonCustDTO

Type: object

Match All

Show Source

allOf GenericDto
object ObcmTmRelationshipMasterNonCustDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "autoAcceptance":{
                    "type":"string",
                    "description":"Auto Acceptance"
                },
                "corporateId":{
                    "type":"string",
                    "description":"Corporate Id"
                },
                "counterPartyCategory":{
                    "type":"string",
                    "description":"Counter Party Category"
                },
                "noOfDays":{
                    "type":"integer",
                    "description":"Number Of Days"
                },
                "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"
                },
                "payAutoDebitApplicable":{
                    "type":"string",
                    "description":"pay Auto Debit Applicable"
                },
                "payHolidayTreatment":{
                    "type":"string",
                    "description":"pay Holiday Treatment"
                },
                "payAutoAcceptance":{
                    "type":"string",
                    "description":"pay Auto Acceptance"
                },
                "payNoOfDays":{
                    "type":"integer",
                    "description":"pay Number Of Days"
                },
                "payAllowOverdueRcv":{
                    "type":"string",
                    "description":"pay Allow Overdue Receivables"
                },
                "payMaxDaysOverdue":{
                    "type":"integer",
                    "description":"pay MAXIMUM Days Overdue"
                },
                "payValidateLinkedPo":{
                    "type":"string",
                    "description":"pay Validate Linked Po"
                },
                "payExcessHandling":{
                    "type":"string",
                    "description":"pay Excess Handling"
                },
                "payExcessRefundParty":{
                    "type":"string",
                    "description":"pay Excess Refund Party"
                },
                "payExcessRefundPaymentMode":{
                    "type":"string",
                    "description":"pay Excess Refund Payment Mode"
                },
                "validateLinkedPO":{
                    "type":"string",
                    "description":"Validate Linked PO"
                },
                "salesContractReferenceNumber":{
                    "type":"string"
                },
                "paySalesContractReferenceNumber":{
                    "type":"string",
                    "description":"pay Sales Contract Reference Number"
                },
                "autoDebitBasis":{
                    "type":"string"
                },
                "payAutoDebitBasis":{
                    "type":"string",
                    "description":"pay auto debit basis"
                },
                "nonCustomer":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ScfTmNonCustomerMasterDTO"
                    }
                }
            }
        }
    ]
}

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 : ObcmTmRelationshipMasterNonCustDTO-allOf[1]

Type: object

Show Source

allowOverdueRcv: string

Allow Overdue Receivables
autoAcceptance: string

Auto Acceptance
autoDebitBasis: string
corporateId: string

Corporate Id
counterPartyCategory: string

Counter Party Category
excessHandling: string

Excess Handling
excessRefundParty: string

Excess Refund Party
excessRefundPaymentMode: string

Excess Refund Payment Mode
maxDaysOverdue: integer

Maximum Days Overdue
nonCustomer: array nonCustomer
noOfDays: integer

Number Of Days
payAllowOverdueRcv: string

pay Allow Overdue Receivables
payAutoAcceptance: string

pay Auto Acceptance
payAutoDebitApplicable: string

pay Auto Debit Applicable
payAutoDebitBasis: string

pay auto debit basis
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
paySalesContractReferenceNumber: string

pay Sales Contract Reference Number
payValidateLinkedPo: string

pay Validate Linked Po
salesContractReferenceNumber: string
validateLinkedPO: string

Validate Linked PO

{
    "type":"object",
    "properties":{
        "autoAcceptance":{
            "type":"string",
            "description":"Auto Acceptance"
        },
        "corporateId":{
            "type":"string",
            "description":"Corporate Id"
        },
        "counterPartyCategory":{
            "type":"string",
            "description":"Counter Party Category"
        },
        "noOfDays":{
            "type":"integer",
            "description":"Number Of Days"
        },
        "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"
        },
        "payAutoDebitApplicable":{
            "type":"string",
            "description":"pay Auto Debit Applicable"
        },
        "payHolidayTreatment":{
            "type":"string",
            "description":"pay Holiday Treatment"
        },
        "payAutoAcceptance":{
            "type":"string",
            "description":"pay Auto Acceptance"
        },
        "payNoOfDays":{
            "type":"integer",
            "description":"pay Number Of Days"
        },
        "payAllowOverdueRcv":{
            "type":"string",
            "description":"pay Allow Overdue Receivables"
        },
        "payMaxDaysOverdue":{
            "type":"integer",
            "description":"pay MAXIMUM Days Overdue"
        },
        "payValidateLinkedPo":{
            "type":"string",
            "description":"pay Validate Linked Po"
        },
        "payExcessHandling":{
            "type":"string",
            "description":"pay Excess Handling"
        },
        "payExcessRefundParty":{
            "type":"string",
            "description":"pay Excess Refund Party"
        },
        "payExcessRefundPaymentMode":{
            "type":"string",
            "description":"pay Excess Refund Payment Mode"
        },
        "validateLinkedPO":{
            "type":"string",
            "description":"Validate Linked PO"
        },
        "salesContractReferenceNumber":{
            "type":"string"
        },
        "paySalesContractReferenceNumber":{
            "type":"string",
            "description":"pay Sales Contract Reference Number"
        },
        "autoDebitBasis":{
            "type":"string"
        },
        "payAutoDebitBasis":{
            "type":"string",
            "description":"pay auto debit basis"
        },
        "nonCustomer":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfTmNonCustomerMasterDTO"
            }
        }
    }
}

Nested Schema : nonCustomer

Type: array

Show Source

Array of: object ScfTmNonCustomerMasterDTO

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

Nested Schema : ScfTmNonCustomerMasterDTO

Type: object

Response

Supported Media Types

application/json
application/xml

201 Response

Returns message of succes or failure

Headers

Location: string

URL of newly created relationshipmaster

Root Schema : ObcmTmRelationshipMasterSaveResponseDTO

Type: object

Match All

Show Source

allOf GenericDto
object ObcmTmRelationshipMasterSaveResponseDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "relationshipCode":{
                    "type":"string",
                    "description":"Relationship Code"
                },
                "existingRelationshipCode":{
                    "type":"string",
                    "description":"Existing Relationship Code"
                },
                "cifStatus":{
                    "type":"string",
                    "description":"Cif Status"
                },
                "existingCounterParty":{
                    "type":"string",
                    "description":"Existing Counter Party"
                },
                "partyId":{
                    "type":"string",
                    "description":"Party Id"
                },
                "authStatus":{
                    "type":"string",
                    "description":"Authorization status"
                },
                "errorCode":{
                    "type":"string",
                    "description":"Error Code"
                },
                "errorDesc":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ResponseCode"
                    }
                }
            }
        }
    ]
}

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 : ObcmTmRelationshipMasterSaveResponseDTO-allOf[1]

Type: object

Show Source

authStatus: string

Authorization status
cifStatus: string

Cif Status
errorCode: string

Error Code
errorDesc: array errorDesc
existingCounterParty: string

Existing Counter Party
existingRelationshipCode: string

Existing Relationship Code
partyId: string

Party Id
relationshipCode: string

Relationship Code

{
    "type":"object",
    "properties":{
        "relationshipCode":{
            "type":"string",
            "description":"Relationship Code"
        },
        "existingRelationshipCode":{
            "type":"string",
            "description":"Existing Relationship Code"
        },
        "cifStatus":{
            "type":"string",
            "description":"Cif Status"
        },
        "existingCounterParty":{
            "type":"string",
            "description":"Existing Counter Party"
        },
        "partyId":{
            "type":"string",
            "description":"Party Id"
        },
        "authStatus":{
            "type":"string",
            "description":"Authorization status"
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDesc":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        }
    }
}

Nested Schema : errorDesc

Type: array

Show Source

Array of: object ResponseCode

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

Nested Schema : ResponseCode

Type: object

Show Source

arg: string
args: array args
Code: string
Desc: string
Language: string
Type: string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

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