Rest API for Oracle Banking Cash Management

Updates invoices

put

/service/v3/instrument

This service is used to updates invoices in TW table.

Request

Supported Media Types

application/json
application/xml

Header Parameters

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

user id for SMS

Request Body that contains data required for editing a new Invoice.

Root Schema : EditInvoiceModel

Type: object

Show Source

action: string

action
branchCode: string

branchCode
checkerId: string

checkerId
editinvoices: array editinvoices

editinvoices
makerId: string

makerId
processingBranchCode: string

processingDate
processingDate: string

processingDate
srcAppCd: string

srcAppCd
srcAppRefNo: string

srcAppRefNo

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "description":"action"
        },
        "processingDate":{
            "type":"string",
            "description":"processingDate "
        },
        "processingBranchCode":{
            "type":"string",
            "description":"processingDate "
        },
        "branchCode":{
            "type":"string",
            "description":"branchCode"
        },
        "srcAppCd":{
            "type":"string",
            "description":"srcAppCd"
        },
        "srcAppRefNo":{
            "type":"string",
            "description":"srcAppRefNo"
        },
        "makerId":{
            "type":"string",
            "description":"makerId"
        },
        "checkerId":{
            "type":"string",
            "description":"checkerId"
        },
        "editinvoices":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EditInvoice"
            },
            "description":"editinvoices"
        }
    }
}

Nested Schema : editinvoices

Type: array

editinvoices

Show Source

Array of: object EditInvoice

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/EditInvoice"
    },
    "description":"editinvoices"
}

Nested Schema : EditInvoice

Type: object

Show Source

edit_fields: array edit_fields

editinvoices
indicator: string

indicator
invoiceNumber: string

invoiceNumber
invoiceRefNo: string

invoiceRefNo
supplierId: string

supplierId

{
    "type":"object",
    "properties":{
        "invoiceNumber":{
            "type":"string",
            "description":"invoiceNumber"
        },
        "invoiceRefNo":{
            "type":"string",
            "description":"invoiceRefNo"
        },
        "supplierId":{
            "type":"string",
            "description":"supplierId "
        },
        "indicator":{
            "type":"string",
            "description":"indicator"
        },
        "edit_fields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EditFields"
            },
            "description":"editinvoices"
        }
    }
}

Nested Schema : edit_fields

Type: array

editinvoices

Show Source

Array of: object EditFields

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/EditFields"
    },
    "description":"editinvoices"
}

Nested Schema : EditFields

Type: object

Show Source

columnName: string

columnName
columnValue: string

columnValue

{
    "type":"object",
    "properties":{
        "columnName":{
            "type":"string",
            "description":"columnName"
        },
        "columnValue":{
            "type":"string",
            "description":"columnValue"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

201 Response

Returns the Id of the newly created invoice

Root Schema : UpdateInvoiceResponseV3

Type: object

Discrepancy Response model

Show Source

errorCode: string

Error Code
errorDesc: string

Error Description
processingDate: string

Processing Date
refNoList: array refNoList
srcAppRefNo: string

Src App Reference Number
trnStatus: string

Transaction Status

{
    "description":"Discrepancy Response model",
    "type":"object",
    "properties":{
        "srcAppRefNo":{
            "type":"string",
            "description":"Src App Reference Number"
        },
        "trnStatus":{
            "type":"string",
            "description":"Transaction Status"
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Description"
        },
        "processingDate":{
            "type":"string",
            "description":"Processing Date"
        },
        "refNoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TransactionRefNoResponse"
            }
        }
    }
}

Nested Schema : refNoList

Type: array

Show Source

Array of: object TransactionRefNoResponse

List of Internal Reference Numbers

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

Nested Schema : TransactionRefNoResponse

Type: object

List of Internal Reference Numbers

Show Source

errorCode: string

Error Code
errorDesc: string

Error Description
invoiceRefNoList: array invoiceRefNoList
trnRefNo: string

Transaction Reference Number
trnStatus: string

Transaction Status

{
    "description":"List of Internal Reference Numbers",
    "type":"object",
    "properties":{
        "trnRefNo":{
            "type":"string",
            "description":"Transaction Reference Number"
        },
        "trnStatus":{
            "type":"string",
            "description":"Transaction Status"
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Description"
        },
        "invoiceRefNoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/InvoiceRefNoResponse"
            }
        }
    }
}

Nested Schema : invoiceRefNoList

Type: array

Show Source

Array of: object InvoiceRefNoResponse

List of Internal Reference Numbers

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

Nested Schema : InvoiceRefNoResponse

Type: object

List of Internal Reference Numbers

Show Source

errorCode: string

Error Code
errorDesc: string

Error Description
invoiceRefNo: string

Invoice Reference Number
trnStatus: string

Transaction Status

{
    "description":"List of Internal Reference Numbers",
    "type":"object",
    "properties":{
        "invoiceRefNo":{
            "type":"string",
            "description":"Invoice Reference Number"
        },
        "trnStatus":{
            "type":"string",
            "description":"Transaction Status"
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Description"
        }
    }
}

400 Response

Bad Request

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error