Rest API for Oracle Banking Cash Management

Update the netting transaction received from channel

put

/service/v1/netTxnsDetForNettMgmt

This API is used for updating netting transaction received from channel.

Request

Supported Media Types

application/json
application/xml

Header Parameters

appId: string

Source Application Id
branchCode: string

Branch Code
userId: string

Source User id

Request Body that contains data required for updating table

Root Schema : NettingManagementTxnCollection

Type: object

Netting Management Tranaction Collection

Show Source

nettingInvoiceDetails(optional): object NettingInvoiceDetails

Netting Invoice Details Model
nettingTransactionDetails(optional): object NettingTransactionDetails

Service Get API Netting Transactions model

{
    "description":"Netting Management Tranaction Collection",
    "type":"object",
    "properties":{
        "nettingTransactionDetails":{
            "description":"Netting Subsidiary Transaction",
            "$ref":"#/definitions/NettingTransactionDetails"
        },
        "nettingInvoiceDetails":{
            "description":"Netting Filtered Invoice Transaction",
            "$ref":"#/definitions/NettingInvoiceDetails"
        }
    }
}

Nested Schema : NettingInvoiceDetails

Type: object

Netting Invoice Details Model

Show Source

errors(optional): array errors
message(optional): string
netPayOutOrPayIn(optional): number

Net Pay Out
nettingPayInvModel(optional): array nettingPayInvModel
nettingRecInvModel(optional): array nettingRecInvModel
paging(optional): object PagingDto
responseStatus(optional): string
totalPayables(optional): number

Total Payables
totalPayablesCount(optional): number

Total Payables
totalReceivables(optional): number

Total Receivables
totalReceivablesCount(optional): number

Total Receivables

{
    "description":"Netting Invoice Details Model",
    "type":"object",
    "properties":{
        "nettingRecInvModel":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/NettingInvoicesModel"
            }
        },
        "nettingPayInvModel":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/NettingInvoicesModel"
            }
        },
        "totalReceivables":{
            "type":"number",
            "description":"Total Receivables"
        },
        "totalPayables":{
            "type":"number",
            "description":"Total Payables"
        },
        "totalReceivablesCount":{
            "type":"number",
            "description":"Total Receivables"
        },
        "totalPayablesCount":{
            "type":"number",
            "description":"Total Payables"
        },
        "netPayOutOrPayIn":{
            "type":"number",
            "description":"Net Pay Out"
        },
        "paging":{
            "description":"Paging DTO Model",
            "$ref":"#/definitions/PagingDto"
        },
        "responseStatus":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "errors":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ErrorDTO"
            }
        }
    }
}

Nested Schema : NettingTransactionDetails

Type: object

Service Get API Netting Transactions model

Show Source

errors(optional): array errors
message(optional): string
nettingPayFxDetailsModel(optional): array nettingPayFxDetailsModel
nettingRecFxDetailsModel(optional): array nettingRecFxDetailsModel
nettingTransactionModel(optional): object NettingSubsidiaryModel

Service Get API Netting Transactions model
responseStatus(optional): string

{
    "description":"Service Get API Netting Transactions model",
    "type":"object",
    "properties":{
        "nettingTransactionModel":{
            "$ref":"#/definitions/NettingSubsidiaryModel"
        },
        "nettingRecFxDetailsModel":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/NettingFxDetailsModel"
            }
        },
        "nettingPayFxDetailsModel":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/NettingFxDetailsModel"
            }
        },
        "responseStatus":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "errors":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ErrorDTO"
            }
        }
    }
}

Nested Schema : errors

Type: array

Show Source

Array of: object ErrorDTO

Netting Transactions Status Update Errors

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

Nested Schema : nettingPayInvModel

Type: array

Show Source

Array of: object NettingInvoicesModel

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

Nested Schema : nettingRecInvModel

Type: array

Show Source

Array of: object NettingInvoicesModel

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

Nested Schema : PagingDto

Type: object

Show Source

totalResults(optional): integer

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

Nested Schema : ErrorDTO

Type: object

Netting Transactions Status Update Errors

Show Source

errorCode(optional): string

Error Code
errorDesc(optional): string

Error Description

{
    "description":"Netting Transactions Status Update Errors",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Description"
        }
    }
}

Nested Schema : NettingInvoicesModel

Type: object

Show Source

id(optional): string

Id
identifier(optional): string

Identifier For Receivable or Payable
invoiceAmount(optional): number

Invoice Amount
invoiceCcy(optional): string

Invoice Currency
invoiceRefNo(optional): string

Invoice Ref No
invoiceStatus(optional): string

Invoice Status
nettedInvAmount(optional): number

Netted Inv Amount
nettingStatus(optional): string

Invoice Netting Status
nettingTxnNo(optional): string

Netting Transaction Number
outStandingAmount(optional): number

Invoice OutStanding Amount
paymentDueDate(optional): string

Invoice Payment Due Date
paymentStatus(optional): string

Invoice Payment Status
remainingOutStandingAmount(optional): number

Remaining Out Standing Amount
sourceRefNo(optional): string

Source Ref No

{
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "nettingTxnNo":{
            "type":"string",
            "description":"Netting Transaction Number"
        },
        "sourceRefNo":{
            "type":"string",
            "description":"Source Ref No"
        },
        "identifier":{
            "type":"string",
            "description":"Identifier For Receivable or Payable"
        },
        "invoiceRefNo":{
            "type":"string",
            "description":"Invoice Ref No"
        },
        "invoiceStatus":{
            "type":"string",
            "description":"Invoice Status"
        },
        "paymentStatus":{
            "type":"string",
            "description":"Invoice Payment Status"
        },
        "nettingStatus":{
            "type":"string",
            "description":"Invoice Netting Status"
        },
        "outStandingAmount":{
            "type":"number",
            "description":"Invoice OutStanding Amount"
        },
        "invoiceAmount":{
            "type":"number",
            "description":"Invoice Amount"
        },
        "paymentDueDate":{
            "type":"string",
            "description":"Invoice Payment Due Date"
        },
        "nettedInvAmount":{
            "type":"number",
            "description":"Netted Inv Amount"
        },
        "remainingOutStandingAmount":{
            "type":"number",
            "description":"Remaining Out Standing Amount"
        },
        "invoiceCcy":{
            "type":"string",
            "description":"Invoice Currency"
        }
    }
}

Nested Schema : errors

Type: array

Show Source

Array of: object ErrorDTO

Netting Transactions Status Update Errors

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

Nested Schema : nettingPayFxDetailsModel

Type: array

Show Source

Array of: object NettingFxDetailsModel

Netting Fx Details Model

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

Nested Schema : nettingRecFxDetailsModel

Type: array

Show Source

Array of: object NettingFxDetailsModel

Netting Fx Details Model

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

Nested Schema : NettingSubsidiaryModel

Type: object

Service Get API Netting Transactions model

Show Source

acceptRejectSuspendDate(optional): string

Accept Reject Suspend Date
channel(optional): string

Channel
channelBranch(optional): string

Channel Branch
channelRefNo(optional): string

Channel Ref No
checkerDtStamp(optional): string

Checker Date Stamp
checkerId(optional): string

Checker Id
createdDateTimeStamp(optional): string

Created Date Timestamp
depth(optional): number

Depth
frequency(optional): string

Frequency
fromIdentifier(optional): string

Pay Out Identifier
globalCentreId(optional): string

Global Centre Id
globalCentreName(optional): string

Global Centre Name
globalCentreNettingTxnNo(optional): string

GlobalCentre Netting Txn No
id(optional): string

Id
lastUpdatedTimestamp(optional): string

Last Updated Timestamp
makerDtStamp(optional): string

Maker Date Stamp
makerId(optional): string

Maker Id
modNo(optional): integer

Mod No
netPayIn(optional): number

Net Pay In
netPayOut(optional): number

Net Pay Out
nettingCycle(optional): integer

Netting Cycle
nettingEndDate(optional): string

Netting End Date
nettingStartDate(optional): string

Netting Start Date
nettingTxnDate(optional): string

Netting Txn Date
nettingTxnNo(optional): string

Netting Txn No
nettingTxnStatus(optional): string

Netting Txn Status
nettingTxnStatusAction(optional): string

Netting Txn Status Action
payInEntityName(optional): string

Pay In Entity Name
payInOutDate(optional): string

Pay In Out Date
payInStatus(optional): string

Pay In Status
payOutEntityName(optional): string

Pay Out Entity Name
payOutStatus(optional): string

Pay Out Status
previousCycle(optional): integer

Previous Cycle
remarks(optional): string

Remarks
settlementDate(optional): string

Settlement Date
settTotalPayables(optional): number

Settlement Total Payables
settTotalReceivables(optional): number

Settlement Total Receivables
stage(optional): string

Stage
structureCode(optional): string

Structure Code
structureDescription(optional): string

Structure Description
subCentreCcy(optional): string

Sub Centre Ccy
subCentreId(optional): string

Sub Centre Id
subCentreName(optional): string

Sub Centre Name
subCentreNettingTxnNo(optional): string

Subcentre Netting Txn No
subsidiaryCcy(optional): string

Subsidiary Ccy
subsidiaryId(optional): string

Subsidiary Id
subsidiaryName(optional): string

Subsidiary Name
toIdentifier(optional): string

Pay In Identifier
totalPayables(optional): number

Total Payables
totalReceivables(optional): number

Total Receivables
version(optional): integer

Version

{
    "description":"Service Get API Netting Transactions model",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "modNo":{
            "type":"integer",
            "description":"Mod No"
        },
        "nettingTxnNo":{
            "type":"string",
            "description":"Netting Txn No"
        },
        "nettingTxnStatus":{
            "type":"string",
            "description":"Netting Txn Status"
        },
        "subsidiaryId":{
            "type":"string",
            "description":"Subsidiary Id"
        },
        "subsidiaryName":{
            "type":"string",
            "description":"Subsidiary Name"
        },
        "structureDescription":{
            "type":"string",
            "description":"Structure Description"
        },
        "nettingStartDate":{
            "type":"string",
            "description":"Netting Start Date"
        },
        "nettingEndDate":{
            "type":"string",
            "description":"Netting End Date"
        },
        "globalCentreId":{
            "type":"string",
            "description":"Global Centre Id"
        },
        "globalCentreName":{
            "type":"string",
            "description":"Global Centre Name"
        },
        "frequency":{
            "type":"string",
            "description":"Frequency"
        },
        "nettingCycle":{
            "type":"integer",
            "description":"Netting Cycle"
        },
        "previousCycle":{
            "type":"integer",
            "description":"Previous Cycle"
        },
        "subCentreName":{
            "type":"string",
            "description":"Sub Centre Name"
        },
        "subCentreId":{
            "type":"string",
            "description":"Sub Centre Id"
        },
        "structureCode":{
            "type":"string",
            "description":"Structure Code"
        },
        "acceptRejectSuspendDate":{
            "type":"string",
            "description":"Accept Reject Suspend Date"
        },
        "settlementDate":{
            "type":"string",
            "description":"Settlement Date"
        },
        "subCentreNettingTxnNo":{
            "type":"string",
            "description":"Subcentre Netting Txn No"
        },
        "globalCentreNettingTxnNo":{
            "type":"string",
            "description":"GlobalCentre Netting Txn No"
        },
        "subCentreCcy":{
            "type":"string",
            "description":"Sub Centre Ccy"
        },
        "settTotalReceivables":{
            "type":"number",
            "description":"Settlement Total Receivables"
        },
        "settTotalPayables":{
            "type":"number",
            "description":"Settlement Total Payables"
        },
        "subsidiaryCcy":{
            "type":"string",
            "description":"Subsidiary Ccy"
        },
        "totalReceivables":{
            "type":"number",
            "description":"Total Receivables"
        },
        "totalPayables":{
            "type":"number",
            "description":"Total Payables"
        },
        "netPayIn":{
            "type":"number",
            "description":"Net Pay In"
        },
        "netPayOut":{
            "type":"number",
            "description":"Net Pay Out"
        },
        "nettingTxnDate":{
            "type":"string",
            "description":"Netting Txn Date"
        },
        "version":{
            "type":"integer",
            "description":"Version"
        },
        "depth":{
            "type":"number",
            "description":"Depth"
        },
        "createdDateTimeStamp":{
            "type":"string",
            "description":"Created Date Timestamp"
        },
        "lastUpdatedTimestamp":{
            "type":"string",
            "description":"Last Updated Timestamp"
        },
        "makerId":{
            "type":"string",
            "description":"Maker Id"
        },
        "checkerId":{
            "type":"string",
            "description":"Checker Id"
        },
        "makerDtStamp":{
            "type":"string",
            "description":"Maker Date Stamp"
        },
        "checkerDtStamp":{
            "type":"string",
            "description":"Checker Date Stamp"
        },
        "remarks":{
            "type":"string",
            "description":"Remarks"
        },
        "channel":{
            "type":"string",
            "description":"Channel"
        },
        "channelBranch":{
            "type":"string",
            "description":"Channel Branch"
        },
        "channelRefNo":{
            "type":"string",
            "description":"Channel Ref No"
        },
        "stage":{
            "type":"string",
            "description":"Stage"
        },
        "payInOutDate":{
            "type":"string",
            "description":"Pay In Out Date"
        },
        "payInStatus":{
            "type":"string",
            "description":"Pay In Status"
        },
        "payOutStatus":{
            "type":"string",
            "description":"Pay Out Status"
        },
        "nettingTxnStatusAction":{
            "type":"string",
            "description":"Netting Txn Status Action"
        },
        "payInEntityName":{
            "type":"string",
            "description":"Pay In Entity Name"
        },
        "payOutEntityName":{
            "type":"string",
            "description":"Pay Out Entity Name"
        },
        "fromIdentifier":{
            "type":"string",
            "description":"Pay Out Identifier"
        },
        "toIdentifier":{
            "type":"string",
            "description":"Pay In Identifier"
        }
    }
}

Nested Schema : NettingFxDetailsModel

Type: object

Netting Fx Details Model

Show Source

amountUtilized(optional): number

Amount Utilized
exchangeRate(optional): number

Structure Code
fxContract(optional): string

Sub Centre Id
fxRateDate(optional): string

Global Centre Id
fxRateType(optional): string

Subsidiary Id
globalCentreId(optional): string

Global Centre Id
globalCentreName(optional): string

Global Centre Name
id(optional): string

Id
identifier(optional): string

Structure Code
invoiceCcy(optional): string

Netting Txn No
modNo(optional): integer

Mod No
nettingCcy(optional): string

Netting Txn Status
nettingTxnNo(optional): string

Mod No
totalPayables(optional): number

Total Payables
totalPayablesAmt(optional): number

Total Receivables
totalReceivables(optional): number

Total Receivables
totalReceivablesAmt(optional): number

Total Receivables

{
    "description":"Netting Fx Details Model",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "modNo":{
            "type":"integer",
            "description":"Mod No"
        },
        "nettingTxnNo":{
            "type":"string",
            "description":"Mod No"
        },
        "invoiceCcy":{
            "type":"string",
            "description":"Netting Txn No"
        },
        "nettingCcy":{
            "type":"string",
            "description":"Netting Txn Status"
        },
        "fxRateType":{
            "type":"string",
            "description":"Subsidiary Id"
        },
        "fxRateDate":{
            "type":"string",
            "description":"Global Centre Id"
        },
        "fxContract":{
            "type":"string",
            "description":"Sub Centre Id"
        },
        "exchangeRate":{
            "type":"number",
            "description":"Structure Code"
        },
        "identifier":{
            "type":"string",
            "description":"Structure Code"
        },
        "totalReceivables":{
            "type":"number",
            "description":"Total Receivables"
        },
        "totalReceivablesAmt":{
            "type":"number",
            "description":"Total Receivables"
        },
        "totalPayables":{
            "type":"number",
            "description":"Total Payables"
        },
        "totalPayablesAmt":{
            "type":"number",
            "description":"Total Receivables"
        },
        "amountUtilized":{
            "type":"number",
            "description":"Amount Utilized"
        },
        "globalCentreId":{
            "type":"string",
            "description":"Global Centre Id"
        },
        "globalCentreName":{
            "type":"string",
            "description":"Global Centre Name"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

200 Response

Successfully performs the operation

Root Schema : ResponseDtoWrapper

Type: object

Collection of ResponseDto and ResponseResourceSupport

Show Source

data(optional): object ResponseResourceSupport

Response DTO which extends RepresentationModel of Spring HATEOAS
messages(optional): object ResponseDto

ResponseDto stores the response status and code.

{
    "description":"Collection of ResponseDto and ResponseResourceSupport",
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Response DTO which extends RepresentationModel of Spring HATEOAS

Nested Schema : ResponseDto

Type: object

ResponseDto stores the response status and code.

Show Source

codes(optional): array codes
id(optional): string
requestId(optional): string
status(optional): string

{
    "description":"ResponseDto stores the response status and code.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

Array of: object ResponseCode

ResponseCode stores the response details.

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

Nested Schema : ResponseCode

Type: object

ResponseCode stores the response details.

Show Source

arg(optional): string
args(optional): array args
Code(optional): string
Desc(optional): string
Language(optional): string
Type(optional): string

{
    "description":"ResponseCode stores the response details.",
    "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.

500 Response

Internal error