Rest API for Oracle Banking Cash Management

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

buyerDivCode
buyerDivName: string
buyerId: string

buyerId
buyerName: string

buyerName
divisionCode: string
id: string
invoiceDate: string

invoiceDate
invoiceDueDate: string

invoiceDueDate
invoiceId: string

Id of the Invoice
invoiceNumber: string

invoiceNumber
invoiceRefNo: string

invoiceRefNo
paymentDate: string
paymentTerms: string
programCode: string

programCode
programName: string
reasonCode: string

reasonCode
relationCode: string

relationCode
seqNo: integer(int64)
shipmentDate: string
supplierCode: string
supplierDivCode: string

supplierDivCode
supplierDivName: string

supplierDivName
supplierId: string

supplierId
supplierName: string

supplierName
transactionRefNo: string

{
    "description":"Invoice model",
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64"
        },
        "invoiceId":{
            "description":"Id of the Invoice ",
            "type":"string"
        },
        "buyerId":{
            "type":"string",
            "description":"buyerId"
        },
        "buyerName":{
            "type":"string",
            "description":"buyerName"
        },
        "invoiceDate":{
            "type":"string",
            "description":"invoiceDate"
        },
        "invoiceDueDate":{
            "type":"string",
            "description":"invoiceDueDate"
        },
        "invoiceNumber":{
            "type":"string",
            "description":"invoiceNumber"
        },
        "invoiceRefNo":{
            "type":"string",
            "description":"invoiceRefNo"
        },
        "programCode":{
            "type":"string",
            "description":"programCode"
        },
        "programName":{
            "type":"string"
        },
        "reasonCode":{
            "type":"string",
            "description":"reasonCode"
        },
        "supplierId":{
            "type":"string",
            "description":"supplierId"
        },
        "supplierName":{
            "type":"string",
            "description":"supplierName"
        },
        "supplierDivCode":{
            "type":"string",
            "description":"supplierDivCode"
        },
        "supplierDivName":{
            "type":"string",
            "description":"supplierDivName"
        },
        "paymentTerms":{
            "type":"string"
        },
        "shipmentDate":{
            "type":"string"
        },
        "divisionCode":{
            "type":"string"
        },
        "transactionRefNo":{
            "type":"string"
        },
        "relationCode":{
            "type":"string",
            "description":"relationCode"
        },
        "supplierCode":{
            "type":"string"
        },
        "buyerCode":{
            "type":"string"
        },
        "paymentDate":{
            "type":"string"
        },
        "buyerDivCode":{
            "type":"string",
            "description":"buyerDivCode"
        },
        "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":"daysOfTheMonth"
                },
                "daysOfTheWeek":{
                    "type":"string",
                    "description":"daysOfTheWeek"
                },
                "filterAttr1":{
                    "description":"filterAttr1",
                    "type":"string"
                },
                "filterAttr1Name":{
                    "type":"string",
                    "description":"filterAttr1Name"
                },
                "filterAttr2":{
                    "description":"filterAttr2",
                    "type":"string"
                },
                "filterAttr2Name":{
                    "type":"string",
                    "description":"filterAttr2Name"
                },
                "filterAttr3":{
                    "description":"filterAttr3",
                    "type":"string"
                },
                "filterAttr3Name":{
                    "type":"string",
                    "description":"filterAttr3Name"
                },
                "filterAttr4":{
                    "description":"filterAttr4",
                    "type":"string"
                },
                "filterAttr4Name":{
                    "type":"string",
                    "description":"filterAttr4Name"
                },
                "filterAttr5":{
                    "description":"filterAttr5",
                    "type":"string"
                },
                "filterAttr5Name":{
                    "type":"string",
                    "description":"filterAttr5Name"
                },
                "filterAttr6":{
                    "description":"filterAttr6",
                    "type":"string"
                },
                "filterAttr6Name":{
                    "type":"string",
                    "description":"filterAttr6Name"
                },
                "filterAttr7":{
                    "description":"filterAttr7",
                    "type":"string"
                },
                "filterAttr7Name":{
                    "type":"string",
                    "description":"filterAttr7Name"
                },
                "filterAttr8":{
                    "description":"filterAttr8",
                    "type":"string"
                },
                "filterAttr8Name":{
                    "type":"string",
                    "description":"filterAttr8Name"
                },
                "filterAttr9":{
                    "description":"filterAttr9",
                    "type":"string"
                },
                "filterAttr9Name":{
                    "type":"string",
                    "description":"filterAttr9Name"
                },
                "filterAttr10":{
                    "description":"filterAttr10",
                    "type":"string"
                },
                "filterAttr10Name":{
                    "type":"string",
                    "description":"filterAttr10Name"
                },
                "filterCriteria":{
                    "type":"string",
                    "description":"filterCriteria"
                },
                "frequencyOfPayments":{
                    "type":"string",
                    "description":"frequencyOfPayments"
                },
                "holidayTreatment":{
                    "type":"string",
                    "description":"holidayTreatment"
                },
                "minimumCreditPeriod":{
                    "type":"number",
                    "description":"minimumCreditPeriod"
                },
                "paymentDateCalculationBasis":{
                    "type":"string",
                    "description":"paymentDateCalculationBasis"
                },
                "txnControllerRefNo":{
                    "type":"string",
                    "description":"txnControllerRefNo"
                },
                "applicationCode":{
                    "type":"string",
                    "description":"applicationCode"
                },
                "ObPaymentCustomTermsDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ObPaymentCustomTermsDTO"
                    }
                }
            }
        }
    ]
}

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

Type: object

Show Source

applicationCode: string

applicationCode
daysOfTheMonth: string

daysOfTheMonth
daysOfTheWeek: string

daysOfTheWeek
filterAttr1: string

filterAttr1
filterAttr10: string

filterAttr10
filterAttr10Name: string

filterAttr10Name
filterAttr1Name: string

filterAttr1Name
filterAttr2: string

filterAttr2
filterAttr2Name: string

filterAttr2Name
filterAttr3: string

filterAttr3
filterAttr3Name: string

filterAttr3Name
filterAttr4: string

filterAttr4
filterAttr4Name: string

filterAttr4Name
filterAttr5: string

filterAttr5
filterAttr5Name: string

filterAttr5Name
filterAttr6: string

filterAttr6
filterAttr6Name: string

filterAttr6Name
filterAttr7: string

filterAttr7
filterAttr7Name: string

filterAttr7Name
filterAttr8: string

filterAttr8
filterAttr8Name: string

filterAttr8Name
filterAttr9: string

filterAttr9
filterAttr9Name: string

filterAttr9Name
filterCriteria: string

filterCriteria
frequencyOfPayments: string

frequencyOfPayments
holidayTreatment: string

holidayTreatment
id: string

id
minimumCreditPeriod: number

minimumCreditPeriod
ObPaymentCustomTermsDTO: array ObPaymentCustomTermsDTO
paymentDateCalculationBasis: string

paymentDateCalculationBasis
txnControllerRefNo: string

txnControllerRefNo

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id"
        },
        "daysOfTheMonth":{
            "type":"string",
            "description":"daysOfTheMonth"
        },
        "daysOfTheWeek":{
            "type":"string",
            "description":"daysOfTheWeek"
        },
        "filterAttr1":{
            "description":"filterAttr1",
            "type":"string"
        },
        "filterAttr1Name":{
            "type":"string",
            "description":"filterAttr1Name"
        },
        "filterAttr2":{
            "description":"filterAttr2",
            "type":"string"
        },
        "filterAttr2Name":{
            "type":"string",
            "description":"filterAttr2Name"
        },
        "filterAttr3":{
            "description":"filterAttr3",
            "type":"string"
        },
        "filterAttr3Name":{
            "type":"string",
            "description":"filterAttr3Name"
        },
        "filterAttr4":{
            "description":"filterAttr4",
            "type":"string"
        },
        "filterAttr4Name":{
            "type":"string",
            "description":"filterAttr4Name"
        },
        "filterAttr5":{
            "description":"filterAttr5",
            "type":"string"
        },
        "filterAttr5Name":{
            "type":"string",
            "description":"filterAttr5Name"
        },
        "filterAttr6":{
            "description":"filterAttr6",
            "type":"string"
        },
        "filterAttr6Name":{
            "type":"string",
            "description":"filterAttr6Name"
        },
        "filterAttr7":{
            "description":"filterAttr7",
            "type":"string"
        },
        "filterAttr7Name":{
            "type":"string",
            "description":"filterAttr7Name"
        },
        "filterAttr8":{
            "description":"filterAttr8",
            "type":"string"
        },
        "filterAttr8Name":{
            "type":"string",
            "description":"filterAttr8Name"
        },
        "filterAttr9":{
            "description":"filterAttr9",
            "type":"string"
        },
        "filterAttr9Name":{
            "type":"string",
            "description":"filterAttr9Name"
        },
        "filterAttr10":{
            "description":"filterAttr10",
            "type":"string"
        },
        "filterAttr10Name":{
            "type":"string",
            "description":"filterAttr10Name"
        },
        "filterCriteria":{
            "type":"string",
            "description":"filterCriteria"
        },
        "frequencyOfPayments":{
            "type":"string",
            "description":"frequencyOfPayments"
        },
        "holidayTreatment":{
            "type":"string",
            "description":"holidayTreatment"
        },
        "minimumCreditPeriod":{
            "type":"number",
            "description":"minimumCreditPeriod"
        },
        "paymentDateCalculationBasis":{
            "type":"string",
            "description":"paymentDateCalculationBasis"
        },
        "txnControllerRefNo":{
            "type":"string",
            "description":"txnControllerRefNo"
        },
        "applicationCode":{
            "type":"string",
            "description":"applicationCode"
        },
        "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

FromDay for Custom payment Terms
id: string

Id for Custom payment Terms
paymentDay: string

PaymentDay for Custom payment Terms
paymentTermsId: string

PaymentTermsId for Custom payment Terms
toDay: string

Today for Custom payment Terms

{
    "type":"object",
    "properties":{
        "fromDay":{
            "type":"string",
            "description":"FromDay for Custom payment Terms"
        },
        "id":{
            "type":"string",
            "description":"Id for Custom payment Terms"
        },
        "paymentDay":{
            "type":"string",
            "description":"PaymentDay for Custom payment Terms"
        },
        "paymentTermsId":{
            "type":"string",
            "description":"PaymentTermsId for Custom payment Terms"
        },
        "toDay":{
            "type":"string",
            "description":"Today for Custom payment Terms"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error