Jump to

• Request
• Response

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(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 : AccountingCollection

Type: object

Collection of AccountingModel

Show Source

• accountingModelList(optional): array accountingModelList
• paging(optional): object PagingDto
  Paging DTO

{
    "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

Paging DTO

Show Source

• totalResults(optional): integer
  Total Results

{
    "description":"Paging DTO",
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"Total Results"
        }
    }
}

Nested Schema : AccountingModel

Type: object

Show Source

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

Back to Top