GET api/accountrating/search?ProductType={ProductType}&ResultsLimit={ResultsLimit}

Get all account ratings matching the input parameters.

Requires Authorisation

The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.

Requires Api License and User Access

The api requires license and user permission for API ID, GETapi/accountrating/search. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ProductType

Product types of the account.

ProductTypes
ResultsLimit

Limit the number of results found.

integer If no value is passed then it will return all the results. If 0 is passed, then no results will be returned.

Body Parameters

None.

Response Information

Response Codes

Success Status:

  • OK (200), please see resource description below.

Failed Status(es):

Resource Description

Returns account ratings for the given search parameter.

Collection of CUAccountRatingDto
NameDescriptionTypeAdditional information
CUAccountRatingID

Unique identifier of the account rating.

integer
Code

Code given for the account rating.

string
Description

Description of the account rating.

string
DefaultItem

Indicates whether this account rating is a default one.

boolean
ProductTypeID

Product Type of the account rating.

integer
InterestInSuspense

Indicates whether this account rating is applicable for InterestInSuspense account.

boolean
AllowAccrueInterest

Allows accrual of loan interest for accounts in this rating.

boolean
AllowCapitaliseInterest

Allows capitalising of loan interest for accounts in this rating.

boolean
ProcessOnDueDatesOnly

Indicates whether this account rating is applicable for account processed on DueDates only.

boolean
WriteOff

Indicates whether this account rating is applicable for WriteOff Loans.

boolean

Response Formats

application/json, text/json

Sample:
[
  {
    "cuAccountRatingID": 1,
    "code": "sample string 1",
    "description": "sample string 2",
    "defaultItem": true,
    "productTypeID": 1,
    "interestInSuspense": true,
    "allowAccrueInterest": true,
    "allowCapitaliseInterest": true,
    "processOnDueDatesOnly": true,
    "writeOff": true
  },
  {
    "cuAccountRatingID": 1,
    "code": "sample string 1",
    "description": "sample string 2",
    "defaultItem": true,
    "productTypeID": 1,
    "interestInSuspense": true,
    "allowAccrueInterest": true,
    "allowCapitaliseInterest": true,
    "processOnDueDatesOnly": true,
    "writeOff": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfCUAccountRatingDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CU.Accounts">
  <CUAccountRatingDto>
    <AllowAccrueInterest>true</AllowAccrueInterest>
    <AllowCapitaliseInterest>true</AllowCapitaliseInterest>
    <CUAccountRatingID>1</CUAccountRatingID>
    <Code>sample string 1</Code>
    <DefaultItem>true</DefaultItem>
    <Description>sample string 2</Description>
    <InterestInSuspense>true</InterestInSuspense>
    <ProcessOnDueDatesOnly>true</ProcessOnDueDatesOnly>
    <ProductTypeID>1</ProductTypeID>
    <WriteOff>true</WriteOff>
  </CUAccountRatingDto>
  <CUAccountRatingDto>
    <AllowAccrueInterest>true</AllowAccrueInterest>
    <AllowCapitaliseInterest>true</AllowCapitaliseInterest>
    <CUAccountRatingID>1</CUAccountRatingID>
    <Code>sample string 1</Code>
    <DefaultItem>true</DefaultItem>
    <Description>sample string 2</Description>
    <InterestInSuspense>true</InterestInSuspense>
    <ProcessOnDueDatesOnly>true</ProcessOnDueDatesOnly>
    <ProductTypeID>1</ProductTypeID>
    <WriteOff>true</WriteOff>
  </CUAccountRatingDto>
</ArrayOfCUAccountRatingDto>