Rest API for Oracle Banking Cash Management

Adds a new supplier commodity code

post

/service/v1/scommodity

This endpoint is used to add a new supplier Commodity Code.

Request

Supported Media Types

application/json
application/xml

Header Parameters

appId(required): string
branchCode(required): string

branchCode
userId(required): string

userId

Request Body that contains data required for creating a new scommoditycode

Root Schema : CreateComServiceCollection

Type: object

Show Source

action: string

Action
authRequire: string

Auth Status Y/N
obscfcmTmSupplierCommodityMasterDTO: object ObscfcmTmSupplierCommodityMasterDTO

{
    "type":"object",
    "properties":{
        "authRequire":{
            "type":"string",
            "description":"Auth Status Y/N"
        },
        "action":{
            "type":"string",
            "description":"Action"
        },
        "obscfcmTmSupplierCommodityMasterDTO":{
            "$ref":"#/definitions/ObscfcmTmSupplierCommodityMasterDTO"
        }
    }
}

Nested Schema : ObscfcmTmSupplierCommodityMasterDTO

Type: object

Match All

Show Source

allOf GenericDto
object ObscfcmTmSupplierCommodityMasterDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":""
                },
                "action":{
                    "type":"string",
                    "description":""
                },
                "autoAuth":{
                    "type":"string",
                    "description":""
                },
                "modificationStatus":{
                    "type":"string",
                    "description":""
                },
                "datasegmentCode":{
                    "type":"string",
                    "description":""
                },
                "checkerRemarks":{
                    "type":"string",
                    "description":""
                },
                "makerRemarks":{
                    "type":"string",
                    "description":""
                },
                "supplierId":{
                    "type":"string",
                    "description":""
                },
                "supplierName":{
                    "type":"string",
                    "description":""
                },
                "ObscfcmTmSupplierCommodityDetailsDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ObscfcmTmSupplierCommodityDetailsDTO"
                    }
                }
            }
        }
    ]
}

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

Type: object

Show Source

action: string
autoAuth: string
checkerRemarks: string
datasegmentCode: string
id: string
makerRemarks: string
modificationStatus: string
ObscfcmTmSupplierCommodityDetailsDTO: array ObscfcmTmSupplierCommodityDetailsDTO
supplierId: string
supplierName: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":""
        },
        "action":{
            "type":"string",
            "description":""
        },
        "autoAuth":{
            "type":"string",
            "description":""
        },
        "modificationStatus":{
            "type":"string",
            "description":""
        },
        "datasegmentCode":{
            "type":"string",
            "description":""
        },
        "checkerRemarks":{
            "type":"string",
            "description":""
        },
        "makerRemarks":{
            "type":"string",
            "description":""
        },
        "supplierId":{
            "type":"string",
            "description":""
        },
        "supplierName":{
            "type":"string",
            "description":""
        },
        "ObscfcmTmSupplierCommodityDetailsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ObscfcmTmSupplierCommodityDetailsDTO"
            }
        }
    }
}

Nested Schema : ObscfcmTmSupplierCommodityDetailsDTO

Type: array

Show Source

Array of: object ObscfcmTmSupplierCommodityDetailsDTO

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

Nested Schema : ObscfcmTmSupplierCommodityDetailsDTO

Type: object

Show Source

commodityCode: string

Commodity Code
commodityName: string

Commodity Name
countryOfOrigin: string

Country of origin
description: string

Description
discount: number

Discount
id: string

ID
ObscfcmTmCommodityUnitsDTO: array ObscfcmTmCommodityUnitsDTO
supplierCommodityMasterId: string

Supplier Commodity Master Id
tax: number

Tax
year: number

Year

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID"
        },
        "commodityCode":{
            "type":"string",
            "description":"Commodity Code"
        },
        "commodityName":{
            "type":"string",
            "description":"Commodity Name"
        },
        "countryOfOrigin":{
            "type":"string",
            "description":"Country of origin"
        },
        "description":{
            "type":"string",
            "description":"Description"
        },
        "discount":{
            "type":"number",
            "description":"Discount"
        },
        "supplierCommodityMasterId":{
            "type":"string",
            "description":"Supplier Commodity Master Id"
        },
        "tax":{
            "type":"number",
            "description":"Tax"
        },
        "year":{
            "type":"number",
            "description":"Year"
        },
        "ObscfcmTmCommodityUnitsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ObscfcmTmCommodityUnitsDTO"
            }
        }
    }
}

Nested Schema : ObscfcmTmCommodityUnitsDTO

Type: array

Show Source

Array of: object ObscfcmTmCommodityUnitsDTO

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

Nested Schema : ObscfcmTmCommodityUnitsDTO

Type: object

Show Source

id: string

Id
maximumUnit: number

Maximum Unit
minimumUnit: number

Minimum Unit
supplierCommodityDetailsId: string

Supplier Commodity Details Id
unit: string

Unit
unitPrice: number

Unit Price

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "supplierCommodityDetailsId":{
            "type":"string",
            "description":"Supplier Commodity Details Id"
        },
        "maximumUnit":{
            "type":"number",
            "description":"Maximum Unit"
        },
        "minimumUnit":{
            "type":"number",
            "description":"Minimum Unit"
        },
        "unit":{
            "type":"string",
            "description":"Unit"
        },
        "unitPrice":{
            "type":"number",
            "description":"Unit Price"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

201 Response

Returns message of succes or failure

Headers

Location: string

URL of newly created supplierCommodityCode

Root Schema : CreateComCode

Type: object

Show Source

authStatus: string

Authorization Status
commodityCodeResponseDTO: array commodityCodeResponseDTO

com code
errorList: array errorList

Error List
id: string

Id
modNo: string

Mod Number
responseCode: string

Response Code
supplierId: string

Supplier id

{
    "type":"object",
    "properties":{
        "supplierId":{
            "type":"string",
            "description":"Supplier id"
        },
        "commodityCodeResponseDTO":{
            "type":"array",
            "description":"com code",
            "items":{
                "$ref":"#/definitions/commodityCodeResponseDTOColl"
            }
        },
        "id":{
            "type":"string",
            "description":"Id"
        },
        "authStatus":{
            "type":"string",
            "description":"Authorization Status"
        },
        "responseCode":{
            "type":"string",
            "description":"Response Code"
        },
        "modNo":{
            "type":"string",
            "description":"Mod Number"
        },
        "errorList":{
            "type":"array",
            "description":"Error List",
            "items":{
                "$ref":"#/definitions/ErrorsDto"
            }
        }
    }
}

Nested Schema : commodityCodeResponseDTO

Type: array

com code

Show Source

Array of: object commodityCodeResponseDTOColl

{
    "type":"array",
    "description":"com code",
    "items":{
        "$ref":"#/definitions/commodityCodeResponseDTOColl"
    }
}

Nested Schema : errorList

Type: array

Error List

Show Source

Array of: object ErrorsDto

{
    "type":"array",
    "description":"Error List",
    "items":{
        "$ref":"#/definitions/ErrorsDto"
    }
}

Nested Schema : commodityCodeResponseDTOColl

Type: object

Show Source

commodityCode: string

Commodity Code
commodityName: string

Commodity Name

{
    "type":"object",
    "properties":{
        "commodityCode":{
            "type":"string",
            "description":"Commodity Code"
        },
        "commodityName":{
            "type":"string",
            "description":"Commodity Name"
        }
    }
}

Nested Schema : ErrorsDto

Type: object

Show Source

errorCode: string

Error Code
errorDesc: string

Error Description

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Description"
        }
    }
}

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