Rest API for Oracle Banking Cash Management Cloud Service

Maintain the specific payment frequencies and dates for buyers

post

/service/v1/filter

This endpoint is used to maintain specific payment frequencies and dates for buyers making bulk payments on repetitive fixed dates..

Request

Supported Media Types

application/json
application/xml

Query Parameters

isFromServiceCall: boolean

flag to check if request is from service api or not

Default Value: false

Header Parameters

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

branchCode
userId(required): string

userId

Request body of invoice type

Root Schema : InvoiceFilterModel

Type: object

Invoice model

Show Source

buyerCode: string
buyerDivCode: string

Buyer Division Code
buyerDivName: string
buyerId: string

Buyer Id
buyerName: string

Buyer Name
divisionCode: string
id: string
invoiceDate: string

Invoice Date
invoiceDueDate: string

Invoice Due Date
invoiceId: string

Id of the Invoice
invoiceNumber: string

Invoice Number
invoiceRefNo: string

Invoice Reference Number
paymentDate: string
paymentTerms: string
programCode: string

Program Code
programName: string
reasonCode: string

Reason Code
relationCode: string

Relation Code
seqNo: integer(int64)
shipmentDate: string
supplierCode: string
supplierDivCode: string

Supplier Division Code
supplierDivName: string

Supplier Division Name
supplierId: string

Supplier Id
supplierName: string

Supplier Name
transactionRefNo: string

{
    "description":"Invoice model",
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64"
        },
        "invoiceId":{
            "type":"string",
            "description":"Id of the Invoice"
        },
        "buyerId":{
            "type":"string",
            "description":"Buyer Id"
        },
        "buyerName":{
            "type":"string",
            "description":"Buyer Name"
        },
        "invoiceDate":{
            "type":"string",
            "description":"Invoice Date"
        },
        "invoiceDueDate":{
            "type":"string",
            "description":"Invoice Due Date"
        },
        "invoiceNumber":{
            "type":"string",
            "description":"Invoice Number"
        },
        "invoiceRefNo":{
            "type":"string",
            "description":"Invoice Reference Number"
        },
        "programCode":{
            "type":"string",
            "description":"Program Code"
        },
        "programName":{
            "type":"string"
        },
        "reasonCode":{
            "type":"string",
            "description":"Reason Code"
        },
        "supplierId":{
            "type":"string",
            "description":"Supplier Id"
        },
        "supplierName":{
            "type":"string",
            "description":"Supplier Name"
        },
        "supplierDivCode":{
            "type":"string",
            "description":"Supplier Division Code"
        },
        "supplierDivName":{
            "type":"string",
            "description":"Supplier Division Name"
        },
        "paymentTerms":{
            "type":"string"
        },
        "shipmentDate":{
            "type":"string"
        },
        "divisionCode":{
            "type":"string"
        },
        "transactionRefNo":{
            "type":"string"
        },
        "relationCode":{
            "type":"string",
            "description":"Relation Code"
        },
        "supplierCode":{
            "type":"string"
        },
        "buyerCode":{
            "type":"string"
        },
        "paymentDate":{
            "type":"string"
        },
        "buyerDivCode":{
            "type":"string",
            "description":"Buyer Division Code"
        },
        "buyerDivName":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

200 Response

Returns the paymentTerms based on given id.

Root Schema : ObPaymentTermsCollection

Type: object

Collection of termstm.

Show Source

data: array data
paging: object PagingDto

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

Nested Schema : data

Type: array

Show Source

Array of: object ObPaymentTermsDTO

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

Nested Schema : PagingDto

Type: object

Show Source

totalResults: integer

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

Nested Schema : ObPaymentTermsDTO

Type: object

Match All

Show Source

allOf GenericDto
object ObPaymentTermsDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"Id"
                },
                "daysOfTheMonth":{
                    "type":"string",
                    "description":"Days Of The Month"
                },
                "daysOfTheWeek":{
                    "type":"string",
                    "description":"Days Of The Week"
                },
                "filterAttr1":{
                    "description":"Filter Attribute1",
                    "type":"string"
                },
                "filterAttr2":{
                    "description":"Filter Attribute2",
                    "type":"string"
                },
                "filterAttr3":{
                    "description":"Filter Attribute3",
                    "type":"string"
                },
                "filterAttr4":{
                    "description":"Filter Attribute4",
                    "type":"string"
                },
                "filterAttr5":{
                    "description":"Filter Attribute5",
                    "type":"string"
                },
                "filterAttr6":{
                    "description":"Filter Attribute6",
                    "type":"string"
                },
                "filterAttr7":{
                    "description":"Filter Attribute7",
                    "type":"string"
                },
                "filterAttr8":{
                    "description":"Filter Attribute8",
                    "type":"string"
                },
                "filterAttr9":{
                    "description":"Filter Attribute9",
                    "type":"string"
                },
                "filterAttr10":{
                    "description":"Filter Attribute10",
                    "type":"string"
                },
                "filterCriteria":{
                    "type":"string",
                    "description":"Filter Criteria"
                },
                "frequencyOfPayments":{
                    "type":"string",
                    "description":"Frequency Of Payments"
                },
                "holidayTreatment":{
                    "type":"string",
                    "description":"Holiday Treatment"
                },
                "minimumCreditPeriod":{
                    "type":"number",
                    "description":"Minimum Credit Period"
                },
                "paymentDateCalculationBasis":{
                    "type":"string",
                    "description":"Payment Date Calculation Basis"
                },
                "txnControllerRefNo":{
                    "type":"string",
                    "description":"Transaction Controller Reference Number"
                },
                "ObPaymentCustomTermsDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ObPaymentCustomTermsDTO"
                    }
                }
            }
        }
    ]
}

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

Type: object

Show Source

daysOfTheMonth: string

Days Of The Month
daysOfTheWeek: string

Days Of The Week
filterAttr1: string

Filter Attribute1
filterAttr10: string

Filter Attribute10
filterAttr2: string

Filter Attribute2
filterAttr3: string

Filter Attribute3
filterAttr4: string

Filter Attribute4
filterAttr5: string

Filter Attribute5
filterAttr6: string

Filter Attribute6
filterAttr7: string

Filter Attribute7
filterAttr8: string

Filter Attribute8
filterAttr9: string

Filter Attribute9
filterCriteria: string

Filter Criteria
frequencyOfPayments: string

Frequency Of Payments
holidayTreatment: string

Holiday Treatment
id: string

Id
minimumCreditPeriod: number

Minimum Credit Period
ObPaymentCustomTermsDTO: array ObPaymentCustomTermsDTO
paymentDateCalculationBasis: string

Payment Date Calculation Basis
txnControllerRefNo: string

Transaction Controller Reference Number

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "daysOfTheMonth":{
            "type":"string",
            "description":"Days Of The Month"
        },
        "daysOfTheWeek":{
            "type":"string",
            "description":"Days Of The Week"
        },
        "filterAttr1":{
            "description":"Filter Attribute1",
            "type":"string"
        },
        "filterAttr2":{
            "description":"Filter Attribute2",
            "type":"string"
        },
        "filterAttr3":{
            "description":"Filter Attribute3",
            "type":"string"
        },
        "filterAttr4":{
            "description":"Filter Attribute4",
            "type":"string"
        },
        "filterAttr5":{
            "description":"Filter Attribute5",
            "type":"string"
        },
        "filterAttr6":{
            "description":"Filter Attribute6",
            "type":"string"
        },
        "filterAttr7":{
            "description":"Filter Attribute7",
            "type":"string"
        },
        "filterAttr8":{
            "description":"Filter Attribute8",
            "type":"string"
        },
        "filterAttr9":{
            "description":"Filter Attribute9",
            "type":"string"
        },
        "filterAttr10":{
            "description":"Filter Attribute10",
            "type":"string"
        },
        "filterCriteria":{
            "type":"string",
            "description":"Filter Criteria"
        },
        "frequencyOfPayments":{
            "type":"string",
            "description":"Frequency Of Payments"
        },
        "holidayTreatment":{
            "type":"string",
            "description":"Holiday Treatment"
        },
        "minimumCreditPeriod":{
            "type":"number",
            "description":"Minimum Credit Period"
        },
        "paymentDateCalculationBasis":{
            "type":"string",
            "description":"Payment Date Calculation Basis"
        },
        "txnControllerRefNo":{
            "type":"string",
            "description":"Transaction Controller Reference Number"
        },
        "ObPaymentCustomTermsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ObPaymentCustomTermsDTO"
            }
        }
    }
}

Nested Schema : ObPaymentCustomTermsDTO

Type: array

Show Source

Array of: object ObPaymentCustomTermsDTO

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

Nested Schema : ObPaymentCustomTermsDTO

Type: object

Show Source

fromDay: string

From Day
id: string

Id
paymentDay: string

Payment Day
paymentTermsId: string

Payment Terms Id
toDay: string

To Day

{
    "type":"object",
    "properties":{
        "fromDay":{
            "type":"string",
            "description":"From Day"
        },
        "id":{
            "type":"string",
            "description":"Id"
        },
        "paymentDay":{
            "type":"string",
            "description":"Payment Day"
        },
        "paymentTermsId":{
            "type":"string",
            "description":"Payment Terms Id"
        },
        "toDay":{
            "type":"string",
            "description":"To Day"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error