Jump to

• Request
• Response

Get all accounting details

post

/service/v1/accountinggeneric

This endpoint is used to get all accounting Details

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• limit(optional): integer
  limit is maximum no of records to be fetched
• offset(optional): integer
  offset is starting no of records to be fetched

Header Parameters

• appId: string
  Application Id
• branchCode: string
  Branch Code
• userId: string
  User Id

Body ()

Request Body that contains data required for creating a new accentrycode

Root Schema : GenericObscfCmAccountDTO

Type: object

Show Source

• applicationName(optional): string
  Application Name
• otherDetails(optional): object otherDetails
  Additional Properties Allowed: additionalProperties
• recordStat(optional): string
  Record Status
• refNo(optional): string
  Reference Number
• seqNo(optional): 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"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure

Body ()

Root Schema : AccountingTransactionCollection

Type: object

Collection of Accounting Transaction Models.

Show Source

• data(optional): array data
• paging(optional): object PagingDto

{
    "description":"Collection of Accounting Transaction Models.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AccountingTransactionModel"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object AccountingTransactionModel
  Accounting Transaction Model

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : AccountingTransactionModel

Type: object

Accounting Transaction Model

Show Source

• accEntryDesc(optional): string
  Account Entry Description
• accEntrySeq(optional): integer(int64)
  Account Entry Sequence
• accountCcy(optional): string
  Account Currency
• accountingEntryCode(optional): string
  Accounting Entry Code
• accountNo(optional): string
  Account Number
• accPartyId(optional): string
  Account Party Id
• accPartyType(optional): string
  Account Party Type
• accRoleCode(optional): string
  Account Role Code
• accRoleDesc(optional): string
  Account Role Description
• accSettMethod(optional): string
  Account Settlement Method
• accType(optional): string
  Account Type
• amount(optional): number
  Amount
• amountAccCcy(optional): number
  Amount Account Currency
• amountCcy(optional): string
  Amount Currency
• amountType(optional): string
  Amount Type
• drCrIndicator(optional): string
  Debit Credit Indicator
• ecaRefNo(optional): string
  Eca Reference Number
• errorCode(optional): string
  Error Code
• errorDesc(optional): string
  Error Description
• eventCode(optional): string
  Event Code
• eventSrNo(optional): number
  Event Serial Number
• exchangeRate(optional): number
  Exchange Rate
• externalAccount(optional): string
  External Account
• externalAccountCcy(optional): string
  External Account Currency
• externalBankId(optional): string
  External Bank Id
• externalBankName(optional): string
  External Bank Name
• externalBranchCode(optional): string
  External Branch Code
• externalBranchName(optional): string
  External Branch Name
• financeRefNo(optional): string
  Finance Reference Number
• id(optional): string
  Id
• paymentMode(optional): string
  Payment Mode
• routingCode(optional): number
  Routing Code
• seqNo(optional): integer(int64)
  Sequence Number
• status(optional): string
  Status

{
    "description":"Accounting Transaction Model",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "financeRefNo":{
            "type":"string",
            "description":"Finance Reference Number"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64",
            "description":"Sequence Number"
        },
        "accountingEntryCode":{
            "type":"string",
            "description":"Accounting Entry Code"
        },
        "drCrIndicator":{
            "type":"string",
            "description":"Debit Credit Indicator"
        },
        "amountCcy":{
            "type":"string",
            "description":"Amount Currency"
        },
        "amount":{
            "type":"number",
            "description":"Amount"
        },
        "amountType":{
            "type":"string",
            "description":"Amount Type"
        },
        "accountCcy":{
            "type":"string",
            "description":"Account Currency"
        },
        "amountAccCcy":{
            "type":"number",
            "description":"Amount Account Currency"
        },
        "accountNo":{
            "type":"string",
            "description":"Account Number"
        },
        "exchangeRate":{
            "type":"number",
            "description":"Exchange Rate"
        },
        "status":{
            "type":"string",
            "description":"Status"
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Description"
        },
        "accRoleCode":{
            "type":"string",
            "description":"Account Role Code"
        },
        "accPartyType":{
            "type":"string",
            "description":"Account Party Type"
        },
        "accPartyId":{
            "type":"string",
            "description":"Account Party Id"
        },
        "accSettMethod":{
            "type":"string",
            "description":"Account Settlement Method"
        },
        "accEntrySeq":{
            "type":"integer",
            "format":"int64",
            "description":"Account Entry Sequence"
        },
        "accRoleDesc":{
            "type":"string",
            "description":"Account Role Description"
        },
        "accEntryDesc":{
            "type":"string",
            "description":"Account Entry Description"
        },
        "accType":{
            "type":"string",
            "description":"Account Type"
        },
        "eventSrNo":{
            "type":"number",
            "description":"Event Serial Number"
        },
        "ecaRefNo":{
            "type":"string",
            "description":"Eca Reference Number"
        },
        "eventCode":{
            "type":"string",
            "description":"Event Code"
        },
        "externalAccount":{
            "type":"string",
            "description":"External Account"
        },
        "paymentMode":{
            "type":"string",
            "description":"Payment Mode"
        },
        "externalAccountCcy":{
            "type":"string",
            "description":"External Account Currency"
        },
        "externalBankId":{
            "type":"string",
            "description":"External Bank Id"
        },
        "externalBankName":{
            "type":"string",
            "description":"External Bank Name"
        },
        "externalBranchCode":{
            "type":"string",
            "description":"External Branch Code"
        },
        "externalBranchName":{
            "type":"string",
            "description":"External Branch Name"
        },
        "routingCode":{
            "type":"number",
            "description":"Routing Code"
        }
    }
}

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

Back to Top