Rest API for Oracle Banking Cash Management

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

Account Entry Code
accEntryDescription: string

Account Entry Description
additionalField1: string

Additional Field 1
additionalField10: string

Additional Field 10
additionalField2: string

Additional Field 2
additionalField3: string

Additional Field 3
additionalField4: string

Additional Field 4
additionalField5: string

Additional Field 5
additionalField6: string

Additional Field 6
additionalField7: string

Additional Field 7
additionalField8: string

Additional Field 8
additionalField9: string

Additional Field 9
creditAccountCurrency: string

Credit Account Currency
creditAccountNumber: string

Credit Account Number
creditAccRoleCode: string

Credit Account Role Code
creditAccRoleDescription: string

Credit Account Role Description
creditAccType: string

Credit Account Type
creditAmount: number

Credit Amount
creditAmountInAccCcy: number

Credit Amount In Account Currency
creditAmountType: string

Credit Amount Type
creditAmtCcy: string

Credit Amount Currency
creditDivisionCode: string

Credit Division Code
creditExchangeRate: number

Credit Exchange Rate
creditExtAcntList: array creditExtAcntList
creditExternalAttributeList: array creditExternalAttributeList
creditIntAcntList: array creditIntAcntList
creditInternalAttributeList: array creditInternalAttributeList
creditPartyId: string

Credit Party Id
creditPartyName: string

Credit Party Name
creditPartyType: string

Credit Party Type
creditSettlementMethod: string

Credit Settlement Method
creditVaFlagYN: string

Credit Virtual Account flag as Y or N
debitAccountCurrency: string

Debit Account Currency
debitAccountNumber: string

Debit Account Number
debitAccRoleCode: string

Debit Account Role Code
debitAccRoleDescription: string

Debit Account Role Description
debitAccType: string

Debit Account Type
debitAmount: number

Debit Amount
debitAmountInAccCcy: number

Debit Amount In Account Currency
debitAmountType: string

Debit Amount Type
debitAmtCcy: string

Debit Amount Currency
debitDivisionCode: string

Debit Division Code
debitExchangeRate: number

Debit Exchange Rate
debitExtAcntList: array debitExtAcntList
debitExternalAttributeList: array debitExternalAttributeList
debitIntAcntList: array debitIntAcntList
debitInternalAttributeList: array debitInternalAttributeList
debitPartyId: string

Debit Party Id
debitPartyName: string

Debit Party Name
debitPartyType: string

Debit Party Type
debitSettlementMethod: string

Debit Settlement Method
debitVaFlagYN: string

Debit Virtual Account flag as Y or N
eventCode: string

Event Code
eventSrNo: number

Event Serial Number
processingDate: string

Processing Date
productCode: string

Product Code
refNo: string

Reference Number
seqNo: integer(int64)
sequence: number

Sequence
txnBranchCode: string

Transaction Branch Code
valueDate: string

Value Date

{
    "type":"object",
    "properties":{
        "refNo":{
            "type":"string",
            "description":"Reference Number"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64"
        },
        "accEntryCode":{
            "type":"string",
            "description":"Account Entry Code"
        },
        "creditAmountType":{
            "type":"string",
            "description":"Credit Amount Type"
        },
        "debitAmountType":{
            "type":"string",
            "description":"Debit Amount Type"
        },
        "creditAccRoleCode":{
            "type":"string",
            "description":"Credit Account Role Code"
        },
        "debitAccRoleCode":{
            "type":"string",
            "description":"Debit Account Role Code"
        },
        "debitAccRoleDescription":{
            "type":"string",
            "description":"Debit Account Role Description"
        },
        "creditAccRoleDescription":{
            "type":"string",
            "description":"Credit Account Role Description"
        },
        "sequence":{
            "type":"number",
            "description":"Sequence"
        },
        "eventCode":{
            "type":"string",
            "description":"Event Code"
        },
        "accEntryDescription":{
            "type":"string",
            "description":"Account Entry Description"
        },
        "creditAmount":{
            "type":"number",
            "description":"Credit Amount"
        },
        "creditAmtCcy":{
            "type":"string",
            "description":"Credit Amount Currency"
        },
        "debitAmount":{
            "type":"number",
            "description":"Debit Amount"
        },
        "debitAmtCcy":{
            "type":"string",
            "description":"Debit Amount Currency"
        },
        "creditPartyId":{
            "type":"string",
            "description":"Credit Party Id"
        },
        "creditPartyName":{
            "type":"string",
            "description":"Credit Party Name"
        },
        "debitPartyId":{
            "type":"string",
            "description":"Debit Party Id"
        },
        "debitPartyName":{
            "type":"string",
            "description":"Debit Party Name"
        },
        "creditPartyType":{
            "type":"string",
            "description":"Credit Party Type"
        },
        "debitPartyType":{
            "type":"string",
            "description":"Debit Party Type"
        },
        "creditAccountNumber":{
            "type":"string",
            "description":"Credit Account Number"
        },
        "creditAccountCurrency":{
            "type":"string",
            "description":"Credit Account Currency"
        },
        "debitAccountNumber":{
            "type":"string",
            "description":"Debit Account Number"
        },
        "debitAccountCurrency":{
            "type":"string",
            "description":"Debit Account Currency"
        },
        "debitAmountInAccCcy":{
            "type":"number",
            "description":"Debit Amount In Account Currency"
        },
        "creditAmountInAccCcy":{
            "type":"number",
            "description":"Credit Amount In Account Currency"
        },
        "creditSettlementMethod":{
            "type":"string",
            "description":"Credit Settlement Method"
        },
        "debitSettlementMethod":{
            "type":"string",
            "description":"Debit Settlement Method"
        },
        "creditDivisionCode":{
            "type":"string",
            "description":"Credit Division Code"
        },
        "debitDivisionCode":{
            "type":"string",
            "description":"Debit Division Code"
        },
        "creditExchangeRate":{
            "type":"number",
            "description":"Credit Exchange Rate"
        },
        "debitExchangeRate":{
            "type":"number",
            "description":"Debit Exchange Rate"
        },
        "creditAccType":{
            "type":"string",
            "description":"Credit Account Type"
        },
        "debitAccType":{
            "type":"string",
            "description":"Debit Account Type"
        },
        "eventSrNo":{
            "type":"number",
            "description":"Event Serial Number"
        },
        "valueDate":{
            "type":"string",
            "description":"Value Date"
        },
        "processingDate":{
            "type":"string",
            "description":"Processing Date"
        },
        "txnBranchCode":{
            "type":"string",
            "description":"Transaction Branch Code"
        },
        "productCode":{
            "type":"string",
            "description":"Product Code"
        },
        "additionalField1":{
            "type":"string",
            "description":"Additional Field 1"
        },
        "additionalField2":{
            "type":"string",
            "description":"Additional Field 2"
        },
        "additionalField3":{
            "type":"string",
            "description":"Additional Field 3"
        },
        "additionalField4":{
            "type":"string",
            "description":"Additional Field 4"
        },
        "additionalField5":{
            "type":"string",
            "description":"Additional Field 5"
        },
        "additionalField6":{
            "type":"string",
            "description":"Additional Field 6"
        },
        "additionalField7":{
            "type":"string",
            "description":"Additional Field 7"
        },
        "additionalField8":{
            "type":"string",
            "description":"Additional Field 8"
        },
        "additionalField9":{
            "type":"string",
            "description":"Additional Field 9"
        },
        "additionalField10":{
            "type":"string",
            "description":"Additional Field 10"
        },
        "creditVaFlagYN":{
            "type":"string",
            "description":"Credit Virtual Account flag as Y or N"
        },
        "debitVaFlagYN":{
            "type":"string",
            "description":"Debit Virtual Account flag as Y or N"
        },
        "creditIntAcntList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "debitIntAcntList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "creditExtAcntList":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "debitExtAcntList":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "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 items

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

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 items

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

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 : 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.

405 Response

Invalid input

500 Response

Internal error