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

{
    "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(optional): integer

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

Nested Schema : AccountingModel

Type: object

Show Source

• accEntryAttributeList(optional): array accEntryAttributeList
• accEntryCode(optional): string
• accEntryDescription(optional): string
• creditAccountCurrency(optional): string
• creditAccountNumber(optional): string
• creditAccRoleCode(optional): string
• creditAccRoleDescription(optional): string
• creditAccType(optional): string
• creditAmount(optional): number
• creditAmountInAccCcy(optional): number
• creditAmountType(optional): string
• creditAmtCcy(optional): string
• creditDivisionCode(optional): string
• creditExchangeRate(optional): number
• creditExtAcntList(optional): array creditExtAcntList
• creditExternalAttributeList(optional): array creditExternalAttributeList
• creditIntAcntList(optional): array creditIntAcntList
• creditInternalAttributeList(optional): array creditInternalAttributeList
• creditPartyId(optional): string
• creditPartyName(optional): string
• creditPartyType(optional): string
• creditSettlementMethod(optional): string
• debitAccountCurrency(optional): string
• debitAccountNumber(optional): string
• debitAccRoleCode(optional): string
• debitAccRoleDescription(optional): string
• debitAccType(optional): string
• debitAmount(optional): number
• debitAmountInAccCcy(optional): number
• debitAmountType(optional): string
• debitAmtCcy(optional): string
• debitDivisionCode(optional): string
• debitExchangeRate(optional): number
• debitExtAcntList(optional): array debitExtAcntList
• debitExternalAttributeList(optional): array debitExternalAttributeList
• debitIntAcntList(optional): array debitIntAcntList
• debitInternalAttributeList(optional): array debitInternalAttributeList
• debitPartyId(optional): string
• debitPartyName(optional): string
• debitPartyType(optional): string
• debitSettlementMethod(optional): string
• eventCode(optional): string
• eventSrNo(optional): number
• processingDate(optional): string
• productCode(optional): string
• sequence(optional): number
• txnBranchCode(optional): string
• valueDate(optional): 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(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 : 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(optional): string
  Account Currency
• accountNumber(optional): string
  Account Number
• bankId(optional): string
  Bank Id
• bankName(optional): string
  Bank Name
• branchCode(optional): string
  Branch Code
• branchName(optional): string
  Branch Name
• defaultAccount(optional): string
  Default Account
• eventCode(optional): string
  Event Code
• filterAttr1(optional): string
  Filter Attribute1
• filterAttr2(optional): string
  Filter Attribute2
• filterAttr3(optional): string
  Filter Attribute3
• filterAttr4(optional): string
  Filter Attribute4
• filterAttr5(optional): string
  Filter Attribute5
• ifscCode(optional): string
  Ifsc Code
• partyId(optional): string
  Party Id
• paymentMode(optional): string
  Payment Mode
• productCode(optional): 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

Back to Top