GET api/fee

Get a list of fees.

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/fee. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Response Codes

Success Status:

OK (200), please see resource description below.

Failed Status(es):

Resource Description

Returns list of fee.

Collection of FeeDto

Name	Description	Type
CUFeeID	Unique identifier of the fee linked to any account.	integer
Description	Fee's description.	string
Code	Fee's code.	string
FeeType	Type of the fee.	FeeTypes
CurrencyID	Unique identifier of the currency.	integer
ProductType	Product type of the fee.	ProductTypes
Amount	Fee's amount.	decimal number
ProRate	Fee's Rate.	boolean
UseAccountRatings	Indicates true if it is applicable for Account Rating.	boolean
Active	Indicates whether the fee is active or not.	boolean
NumScheduledPayments	Number of Scheduled Payments.	integer
ScheduledPaymentType	Scheduled Payment type.	ScheduledPaymentTypes
DeferIncome	Deferred Income.	integer
AccrueFeeOnCharge	Indictes whether Accrual Fee on Charge.	boolean
SeparateOnSchedule	Indicated whetehr Fee is applicable on Separate on Schedule.	boolean
IsVATApplied	Indicates whether Fee is VAT applied.	boolean
VATRate	Rate of VAT of a fee.	decimal number
PeriodForFinalScheduleDateFee	Indicates the period of Final Schedule Date.	byte
IgnoreFeeOnLoanWriteOff	Indicates whether to ignore fee pn Loan Written Off.	boolean

Response Formats

application/json, text/json

Sample:

[
  {
    "cuFeeID": 1,
    "description": "sample string 1",
    "code": "sample string 2",
    "feeType": 1,
    "currencyID": 1,
    "productType": 1,
    "amount": 1.0,
    "proRate": true,
    "useAccountRatings": true,
    "active": true,
    "numScheduledPayments": 1,
    "scheduledPaymentType": 0,
    "deferIncome": 1,
    "accrueFeeOnCharge": true,
    "separateOnSchedule": true,
    "isVATApplied": true,
    "vatRate": 1.1,
    "periodForFinalScheduleDateFee": 64,
    "ignoreFeeOnLoanWriteOff": true
  },
  {
    "cuFeeID": 1,
    "description": "sample string 1",
    "code": "sample string 2",
    "feeType": 1,
    "currencyID": 1,
    "productType": 1,
    "amount": 1.0,
    "proRate": true,
    "useAccountRatings": true,
    "active": true,
    "numScheduledPayments": 1,
    "scheduledPaymentType": 0,
    "deferIncome": 1,
    "accrueFeeOnCharge": true,
    "separateOnSchedule": true,
    "isVATApplied": true,
    "vatRate": 1.1,
    "periodForFinalScheduleDateFee": 64,
    "ignoreFeeOnLoanWriteOff": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfFeeDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto">
  <FeeDto>
    <AccrueFeeOnCharge>true</AccrueFeeOnCharge>
    <Active>true</Active>
    <Amount>1</Amount>
    <CUFeeID>1</CUFeeID>
    <Code>sample string 2</Code>
    <CurrencyID>1</CurrencyID>
    <DeferIncome>1</DeferIncome>
    <Description>sample string 1</Description>
    <FeeType>Fixed</FeeType>
    <IgnoreFeeOnLoanWriteOff>true</IgnoreFeeOnLoanWriteOff>
    <IsVATApplied>true</IsVATApplied>
    <NumScheduledPayments>1</NumScheduledPayments>
    <PeriodForFinalScheduleDateFee>64</PeriodForFinalScheduleDateFee>
    <ProRate>true</ProRate>
    <ProductType>ShareSavings</ProductType>
    <ScheduledPaymentType>PrincipalAndInterest</ScheduledPaymentType>
    <SeparateOnSchedule>true</SeparateOnSchedule>
    <UseAccountRatings>true</UseAccountRatings>
    <VATRate>1.1</VATRate>
  </FeeDto>
  <FeeDto>
    <AccrueFeeOnCharge>true</AccrueFeeOnCharge>
    <Active>true</Active>
    <Amount>1</Amount>
    <CUFeeID>1</CUFeeID>
    <Code>sample string 2</Code>
    <CurrencyID>1</CurrencyID>
    <DeferIncome>1</DeferIncome>
    <Description>sample string 1</Description>
    <FeeType>Fixed</FeeType>
    <IgnoreFeeOnLoanWriteOff>true</IgnoreFeeOnLoanWriteOff>
    <IsVATApplied>true</IsVATApplied>
    <NumScheduledPayments>1</NumScheduledPayments>
    <PeriodForFinalScheduleDateFee>64</PeriodForFinalScheduleDateFee>
    <ProRate>true</ProRate>
    <ProductType>ShareSavings</ProductType>
    <ScheduledPaymentType>PrincipalAndInterest</ScheduledPaymentType>
    <SeparateOnSchedule>true</SeparateOnSchedule>
    <UseAccountRatings>true</UseAccountRatings>
    <VATRate>1.1</VATRate>
  </FeeDto>
</ArrayOfFeeDto>