Rest API for Oracle Banking Cash Management Cloud Service

Get all accounting entries

post

/service/v1/accounting

This endpoint is used to get all accounting entries with their details based on filter(query param) criterias.

Request

Supported Media Types

application/json
application/xml

Query Parameters

limit: integer

limit is maximum no of records to be fetched
offset: integer

offset is starting no of records to be fetched

Header Parameters

appId(required): string

Application Id
branchCode(required): string

Branch Code
userId(required): string

User Id

Request Body that contains data required for creating a new accentrycode

Root Schema : GenericObscfCmAccountDTO

Type: object

Show Source

applicationName: string

Application Name
otherDetails: object otherDetails

Additional Properties Allowed: additionalProperties
recordStat: string

Record Status
refNo: string

Reference Number
seqNo: integer(int64)

Sequence Number

{
    "type":"object",
    "required":[
        "applicationType"
    ],
    "properties":{
        "refNo":{
            "type":"string",
            "description":"Reference Number"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64",
            "description":"Sequence Number"
        },
        "applicationName":{
            "type":"string",
            "description":"Application Name"
        },
        "recordStat":{
            "type":"string",
            "description":"Record Status"
        },
        "otherDetails":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : otherDetails

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json
application/xml

201 Response

Returns message of success or failure

Root Schema : AccountingCollection

Type: object

Collection of AccountingModel

Show Source

accountingModelList: array accountingModelList
paging: object PagingDto

{
    "description":"Collection of AccountingModel",
    "type":"object",
    "properties":{
        "accountingModelList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AccountingModel"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : accountingModelList

Type: array

Show Source

Array of: object AccountingModel

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

Nested Schema : PagingDto

Type: object

Show Source

totalResults: integer

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

Nested Schema : AccountingModel

Type: object

Show Source

accEntryAttributeList: array accEntryAttributeList
accEntryCode: string
accEntryDescription: string
creditAccountCurrency: string
creditAccountNumber: string
creditAccRoleCode: string
creditAccRoleDescription: string
creditAccType: string
creditAmount: number
creditAmountInAccCcy: number
creditAmountType: string
creditAmtCcy: string
creditDivisionCode: string
creditExchangeRate: number
creditExtAcntList: array creditExtAcntList
creditExternalAttributeList: array creditExternalAttributeList
creditIntAcntList: array creditIntAcntList
creditInternalAttributeList: array creditInternalAttributeList
creditPartyId: string
creditPartyName: string
creditPartyType: string
creditSettlementMethod: string
debitAccountCurrency: string
debitAccountNumber: string
debitAccRoleCode: string
debitAccRoleDescription: string
debitAccType: string
debitAmount: number
debitAmountInAccCcy: number
debitAmountType: string
debitAmtCcy: string
debitDivisionCode: string
debitExchangeRate: number
debitExtAcntList: array debitExtAcntList
debitExternalAttributeList: array debitExternalAttributeList
debitIntAcntList: array debitIntAcntList
debitInternalAttributeList: array debitInternalAttributeList
debitPartyId: string
debitPartyName: string
debitPartyType: string
debitSettlementMethod: string
eventCode: string
eventSrNo: number
processingDate: string
productCode: string
sequence: number
txnBranchCode: string
valueDate: string

{
    "type":"object",
    "properties":{
        "accEntryCode":{
            "type":"string"
        },
        "creditAmountType":{
            "type":"string"
        },
        "debitAmountType":{
            "type":"string"
        },
        "creditAccRoleCode":{
            "type":"string"
        },
        "debitAccRoleCode":{
            "type":"string"
        },
        "debitAccRoleDescription":{
            "type":"string"
        },
        "creditAccRoleDescription":{
            "type":"string"
        },
        "sequence":{
            "type":"number"
        },
        "eventCode":{
            "type":"string"
        },
        "accEntryDescription":{
            "type":"string"
        },
        "creditAmount":{
            "type":"number"
        },
        "creditAmtCcy":{
            "type":"string"
        },
        "debitAmount":{
            "type":"number"
        },
        "debitAmtCcy":{
            "type":"string"
        },
        "creditPartyId":{
            "type":"string"
        },
        "creditPartyName":{
            "type":"string"
        },
        "debitPartyId":{
            "type":"string"
        },
        "debitPartyName":{
            "type":"string"
        },
        "creditPartyType":{
            "type":"string"
        },
        "debitPartyType":{
            "type":"string"
        },
        "creditAccountNumber":{
            "type":"string"
        },
        "creditAccountCurrency":{
            "type":"string"
        },
        "debitAccountNumber":{
            "type":"string"
        },
        "debitAccountCurrency":{
            "type":"string"
        },
        "debitAmountInAccCcy":{
            "type":"number"
        },
        "creditAmountInAccCcy":{
            "type":"number"
        },
        "creditSettlementMethod":{
            "type":"string"
        },
        "debitSettlementMethod":{
            "type":"string"
        },
        "creditDivisionCode":{
            "type":"string"
        },
        "debitDivisionCode":{
            "type":"string"
        },
        "creditExchangeRate":{
            "type":"number"
        },
        "debitExchangeRate":{
            "type":"number"
        },
        "creditAccType":{
            "type":"string"
        },
        "debitAccType":{
            "type":"string"
        },
        "eventSrNo":{
            "type":"number"
        },
        "valueDate":{
            "type":"string"
        },
        "processingDate":{
            "type":"string"
        },
        "txnBranchCode":{
            "type":"string"
        },
        "productCode":{
            "type":"string"
        },
        "creditIntAcntList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "debitIntAcntList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "creditExtAcntList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfTmExtAccMapMasterModelDTO"
            }
        },
        "debitExtAcntList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfTmExtAccMapMasterModelDTO"
            }
        },
        "accEntryAttributeList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Attribute"
            }
        },
        "creditInternalAttributeList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Attribute"
            }
        },
        "debitInternalAttributeList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Attribute"
            }
        },
        "creditExternalAttributeList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Attribute"
            }
        },
        "debitExternalAttributeList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Attribute"
            }
        }
    }
}

Nested Schema : accEntryAttributeList

Type: array

Show Source

Array of: object Attribute

Represents each attribute of the records filtered in calling service using filter query

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

Nested Schema : creditExtAcntList

Type: array

Show Source

Array of: object ScfTmExtAccMapMasterModelDTO

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

Nested Schema : creditExternalAttributeList

Type: array

Show Source

Array of: object Attribute

Represents each attribute of the records filtered in calling service using filter query

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

Nested Schema : creditIntAcntList

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : creditInternalAttributeList

Type: array

Show Source

Array of: object Attribute

Represents each attribute of the records filtered in calling service using filter query

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

Nested Schema : debitExtAcntList

Type: array

Show Source

Array of: object ScfTmExtAccMapMasterModelDTO

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

Nested Schema : debitExternalAttributeList

Type: array

Show Source

Array of: object Attribute

Represents each attribute of the records filtered in calling service using filter query

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

Nested Schema : debitIntAcntList

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : debitInternalAttributeList

Type: array

Show Source

Array of: object Attribute

Represents each attribute of the records filtered in calling service using filter query

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

Nested Schema : Attribute

Type: object

Represents each attribute of the records filtered in calling service using filter query

Show Source

attributeName: string

Name of the attribute representing DB column name
attributeValue: string

Value of the corresponding column in DB

{
    "description":"Represents each attribute of the records filtered in calling service using filter query",
    "type":"object",
    "properties":{
        "attributeName":{
            "description":"Name of the attribute representing DB column name",
            "type":"string"
        },
        "attributeValue":{
            "description":"Value of the corresponding column in DB",
            "type":"string"
        }
    }
}

Nested Schema : ScfTmExtAccMapMasterModelDTO

Type: object

Match All

Show Source

allOf GenericDto
object ScfTmExtAccMapMasterModelDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "accountNumber":{
                    "type":"string",
                    "description":"Account Number"
                },
                "bankName":{
                    "type":"string",
                    "description":"Bank Name"
                },
                "branchCode":{
                    "type":"string",
                    "description":"Branch Code"
                },
                "branchName":{
                    "type":"string",
                    "description":"Branch Name"
                },
                "defaultAccount":{
                    "type":"string",
                    "description":"Default Account"
                },
                "eventCode":{
                    "type":"string",
                    "description":"Event Code"
                },
                "ifscCode":{
                    "type":"string",
                    "description":"Ifsc Code"
                },
                "partyId":{
                    "type":"string",
                    "description":"Party Id"
                },
                "productCode":{
                    "type":"string",
                    "description":"Product Code"
                },
                "filterAttr1":{
                    "type":"string",
                    "description":"Filter Attribute1"
                },
                "filterAttr2":{
                    "type":"string",
                    "description":"Filter Attribute2"
                },
                "filterAttr3":{
                    "type":"string",
                    "description":"Filter Attribute3"
                },
                "filterAttr4":{
                    "type":"string",
                    "description":"Filter Attribute4"
                },
                "filterAttr5":{
                    "type":"string",
                    "description":"Filter Attribute5"
                },
                "accountCcy":{
                    "type":"string",
                    "description":"Account Currency"
                },
                "paymentMode":{
                    "type":"string",
                    "description":"Payment Mode"
                },
                "bankId":{
                    "type":"string",
                    "description":"Bank Id"
                }
            }
        }
    ]
}

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

Type: object

Show Source

accountCcy: string

Account Currency
accountNumber: string

Account Number
bankId: string

Bank Id
bankName: string

Bank Name
branchCode: string

Branch Code
branchName: string

Branch Name
defaultAccount: string

Default Account
eventCode: string

Event Code
filterAttr1: string

Filter Attribute1
filterAttr2: string

Filter Attribute2
filterAttr3: string

Filter Attribute3
filterAttr4: string

Filter Attribute4
filterAttr5: string

Filter Attribute5
ifscCode: string

Ifsc Code
partyId: string

Party Id
paymentMode: string

Payment Mode
productCode: string

Product Code

{
    "type":"object",
    "properties":{
        "accountNumber":{
            "type":"string",
            "description":"Account Number"
        },
        "bankName":{
            "type":"string",
            "description":"Bank Name"
        },
        "branchCode":{
            "type":"string",
            "description":"Branch Code"
        },
        "branchName":{
            "type":"string",
            "description":"Branch Name"
        },
        "defaultAccount":{
            "type":"string",
            "description":"Default Account"
        },
        "eventCode":{
            "type":"string",
            "description":"Event Code"
        },
        "ifscCode":{
            "type":"string",
            "description":"Ifsc Code"
        },
        "partyId":{
            "type":"string",
            "description":"Party Id"
        },
        "productCode":{
            "type":"string",
            "description":"Product Code"
        },
        "filterAttr1":{
            "type":"string",
            "description":"Filter Attribute1"
        },
        "filterAttr2":{
            "type":"string",
            "description":"Filter Attribute2"
        },
        "filterAttr3":{
            "type":"string",
            "description":"Filter Attribute3"
        },
        "filterAttr4":{
            "type":"string",
            "description":"Filter Attribute4"
        },
        "filterAttr5":{
            "type":"string",
            "description":"Filter Attribute5"
        },
        "accountCcy":{
            "type":"string",
            "description":"Account Currency"
        },
        "paymentMode":{
            "type":"string",
            "description":"Payment Mode"
        },
        "bankId":{
            "type":"string",
            "description":"Bank Id"
        }
    }
}

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