GET api/loanproduct/{id}
Get a Loan product by id.
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/loanproduct/{id}. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
LoanProduct's id. |
integer |
Required |
Body Parameters
None.
Response Information
Response Codes
Success Status:
- OK (200), please see resource description below.
Failed Status(es):
Resource Description
Returns a LoanProduct for a given id.
LoanProductDto| Name | Description | Type | Additional information |
|---|---|---|---|
| ProductId |
Primary key of Product table. |
integer | Read-Only. |
| Code |
Unique Code for each Loan Product. |
string | Required. |
| Description |
Description of Loan Product. |
string | Required. |
| Default |
Is it default product. |
boolean | |
| CUAccountPortfolioRequired |
CUAccountportfolio required for product. |
boolean | |
| MaxAccounts | integer | ||
| Active |
Active State of the Loan Product. |
boolean | |
| CurrencyId |
Currency Id related with each Loan Product. |
integer | Required. |
| RegularStatements | boolean | ||
| StatementFrequencyID | byte | ||
| StatementFrequencyNum | integer | ||
| MinDenomination | decimal number | ||
| PassbookPrinterID | integer | ||
| AllowLockAccountRating | boolean | ||
| LockAccountRatingPeriodID | byte | ||
| LockAccountRatingPeriodNum | integer | ||
| MinimumBalance | decimal number | ||
| LevelPayments | boolean | ||
| MaximumBalance | decimal number | ||
| MinimumCheque |
Minimum cheque amount allowed for this product. |
decimal number | |
| MaximumCheque |
Minimum cheque amount allowed for this product. |
decimal number | |
| DefaultCheque |
DefaultCheque amount for the Loan Product associated. |
decimal number | |
| MinimumTerm | integer | ||
| DefaultTerm |
Default Term associated with the Loan Product. |
integer | Required. |
| DefaultTermPeriodID | byte | ||
| MaximumTerm | integer | ||
| MaximumMemberAge |
Allowed maximum member age for loanproduct. |
integer | |
| MinimumMemberAge |
Allowed minimum member age for loanproduct. |
integer | |
| InterestChargeDate | date | ||
| ChargeOff | boolean | ||
| RecoverInterest | boolean | ||
| KeepCollectingInterest | boolean | ||
| UseDefaultRate | boolean | ||
| PenaltyInterestAmountType | PIAmountTypes | ||
| PenaltyInterestRate | decimal number | ||
| PenaltyInterestFlatAmount | decimal number | ||
| PenaltyInterestFeeID | integer | ||
| PenaltyIntGracePeriod | integer | ||
| MultiplyPenaltyInterestByNumberOfGroupMembers | boolean | ||
| FlatInterestMethod |
Indicates the Flat Interest Method of a loan product. |
FlatInterestMethods | |
| PrePayInterest | boolean | ||
| RebateRate | decimal number | ||
| RebateTrnMessage | string | ||
| RebateNextPaymentDate | date | ||
| RebatePayMethod | RebatePaymentMethods | ||
| RebateTrnStartDate | date | ||
| RebateTrnEndDate | date | ||
| RebateLimits | string | ||
| AnnuitiesORD | boolean | ||
| Compounding | boolean | ||
| CompoundPeriodNum | integer | ||
| CompoundPeriodID | byte | ||
| AllowTopUp | boolean | ||
| AllowParts | boolean | ||
| AllowRedraw | boolean | ||
| AllowBalloonPayments | boolean | ||
| AllowSingleBalloonPaymentOnly | boolean | ||
| AllowDeferredPayments | boolean | ||
| AllowTransferFromSavings | boolean | ||
| DefaultToSingleScheduledPayment | boolean | ||
| IssueFeeID | integer | ||
| ChargeIssueFee | boolean | ||
| IssueFeeID1 | integer | ||
| ChargeIssueFee1 | boolean | ||
| IssueFeeID2 | integer | ||
| ChargeIssueFee2 | boolean | ||
| IssueFeeID3 | integer | ||
| ChargeIssueFee3 | boolean | ||
| IsIssueFeeCalculatedFirstTimeOnly | boolean | ||
| IsIssueFeeCalculatedOnApprovalAmount | boolean | ||
| IssueFeeAgeLimitsApplyToID | IssueFeeAgeLimitsApplyTo | ||
| IssueFeeAgeMinimum | integer | ||
| IssueFeeAgeMaximum | integer | ||
| DischargeFeeID | integer | ||
| AdditionalAmountChargedInDischargeFee | decimal number | ||
| EarlyDischargeFeeThresholdInMonths | integer | ||
| EarlyDischargeFeeNumberOfDaysToCharge | integer | ||
| DevaluateLoans | boolean | ||
| DevaluationGlobal | boolean | ||
| DevaluationMethod | DevaluationMethods | ||
| DevalueFeeID | integer | ||
| DevalueRate | decimal number | ||
| MaximumDeferredPeriod | integer | ||
| MinimumDeferredPeriod | integer | ||
| RepaymentFrequencyPeriods | integer | ||
| ExcludeDueFromArrears | boolean | ||
| UDSFeeID | integer | ||
| ServiceFeeID | integer | ||
| ServiceFeePeriodNum | integer | ||
| ServiceFeePeriodID | byte | ||
| UsePeakDebt | boolean | ||
| PeakDebtMethod | SavingsCalculationModes | ||
| ServiceFeesDate | date | ||
| RequiresReview | boolean | ||
| ReviewPeriodNum | integer | ||
| ReviewPeriodID | byte | ||
| MinSavings | integer | ||
| MinCollateral | integer | ||
| MaxCollateralAmount | decimal number | ||
| CalculateInitialPaymentDate | boolean | ||
| UseScheduleInterest |
UseScheduleInterest option for the Loan Product associated. |
boolean | This value is an optional. |
| GroupLoansOnly | boolean | ||
| MinGroupSize | integer | ||
| CapitaliseInterestWhenRefinancing | boolean | ||
| RoundDown | RoundDirections | ||
| IncrementDays | boolean | ||
| ClosedDays | byte | ||
| AccrueInterestDaily | boolean | ||
| RepaymentMethod | byte | ||
| DueTodayFormat | string | ||
| ArrearsFormat | string | ||
| PrePaidFormat | string | ||
| ComplimentaryInterest | boolean | ||
| ComplimentaryInterestRate | decimal number | ||
| DayCountDefault |
Daycount method type. |
DayCounts | |
| GeneralProvisionPercentage | decimal number | ||
| GeneralProvisionPercentageRestructured | decimal number | ||
| GeneralProvisionCutoff | integer | ||
| GeneralProvisionCutoffPeriodID | byte | ||
| IncludeSavingsInProvision | boolean | ||
| IncludeCollateralInProvision | boolean | ||
| IncludeGuaranteesInProvision | boolean | ||
| IncludeInterestDueInProvision | boolean | ||
| IgnoreArrearsBelow | decimal number | ||
| BankOfIndonesiaBrackets | boolean | ||
| SpecificProvisionPeriod | ReportPeriods | ||
| SpecificProvisionMaturePeriod | ReportPeriods | ||
| UseDefaultProvisionSettings | boolean | ||
| UseDefaultDoubtfulDebtsSettings | boolean | ||
| DefaultChargeOffProductID | integer | ||
| DoubtfulDebtsPeriod | ReportPeriods | ||
| GeneralProvisionDate | date | ||
| SpecificProvisionDate | date | ||
| DoubtfulDebtsDate | date | ||
| LineOfCredit | boolean | ||
| LOCMinRepayment | decimal number | ||
| LOCDefaultRepayPercent | decimal number | ||
| LOCRescheduleOnIssue | boolean | ||
| EmergencyLoan | boolean | ||
| AllowSettlementAccounts | boolean | ||
| SettlementNumberOfAttempts | integer | ||
| SettlementAttemptFeeID | integer | ||
| SettlementAttemptFeeAmount | decimal number | ||
| SettlementAttemptFeePay | boolean | ||
| SettlementFailFeeID | integer | ||
| SettlementFailFeeAmount | decimal number | ||
| SettlementFailFeePay | boolean | ||
| SettlementFeePerFail | boolean | ||
| FirstPaymentLimitInDays | integer | ||
| AllowStandingInstructions | boolean | ||
| NumberOfAttempts | integer | ||
| AttemptFeeID | integer | ||
| AttemptFeeAmount | decimal number | ||
| AttemptFeePay | boolean | ||
| FailFeeID | integer | ||
| FailFeeAmount | decimal number | ||
| FailFeePay | boolean | ||
| FeePerFail | boolean | ||
| DormancyFeeID | integer | ||
| DormancyFeePeriodNum | integer | ||
| DormancyFeePeriodID | byte | ||
| DormancyFeeLastRun | date | ||
| DormancyPeriodNum | integer | ||
| DormancyPeriodID | byte | ||
| DormancyTransactionSources | integer | ||
| DormancyTransactionTypes | integer | ||
| AllowDormancy | boolean | ||
| UseOverdrawnDate | boolean | ||
| RestructuredLoanExpiryPeriodNum | integer | ||
| RestructuredLoanExpiryPeriodID | byte | ||
| InterestMethod | InterestMethods | ||
| DefaultInterestMethod | InterestMethods | ||
| LinkedSavingsPaymentsRequired | boolean | ||
| LinkedSavingsPaymentAmount | decimal number | ||
| LinkedSavingsPaymentPercentage | decimal number | ||
| LinkedSavingsPaymentAllowUnderpaid | boolean | ||
| LinkedSavingsPaymentRequireOverrideForUnderpaid | boolean | ||
| LinkedSavingsPaymentWithholding | boolean | ||
| LinkedSavingsPaymentType | LinkedSavingsPaymentType | ||
| UseLoanApprovalGroups | boolean | ||
| ChequeBookEnabled | boolean | ||
| ChequeStopFeeID | integer | ||
| ChequeStopFeeAmount | decimal number | ||
| ChequeStopFeePay | boolean | ||
| ChequeUnStopFeeID | integer | ||
| ChequeUnstopFeeAmount | decimal number | ||
| ChequeUnStopFeePay | boolean | ||
| ChequePayerVoidFeeID | integer | ||
| ChequePayerVoidFeeAmount | decimal number | ||
| ChequePayerVoidFeePay | boolean | ||
| ChequePayeeVoidFeeID | integer | ||
| ChequePayeeVoidFeeAmount | decimal number | ||
| ChequePayeeVoidFeePay | boolean | ||
| ChequePayerDishonourFeeID | integer | ||
| ChequePayerDishonourFeeAmount | decimal number | ||
| ChequePayerDishonourFeePay | boolean | ||
| ChequePayeeDishonourFeeID | integer | ||
| ChequePayeeDishonourFeeAmount | decimal number | ||
| ChequePayeeDishonourFeePay | boolean | ||
| ChequePrintFeeID | integer | ||
| ChequePrintFeeAmount | decimal number | ||
| ChequePrintFeePay | boolean | ||
| EarlyPayoutFeeID | integer | ||
| EarlyPayoutFeeAmount | decimal number | ||
| ATMEnabled | boolean | ||
| ATMCardLimit | decimal number | ||
| ATMDailyLimit | decimal number | ||
| ATMWithdrawalFeeID | integer | ||
| ATMServiceFeeID | integer | ||
| ATMServiceFeePeriodNum | integer | ||
| ATMServiceFeePeriodID | byte | ||
| ATMServiceFeeLastRun | date | ||
| ATMMinBalance | decimal number | ||
| ServiceFeeID2 | integer | ||
| ServiceFeePeriodNum2 | integer | ||
| ServiceFeePeriodID2 | byte | ||
| CloseLOCAutomatically | boolean | ||
| LockProvisioningBand | boolean | ||
| LockProvisioningBandPeriodNum | integer | ||
| LockProvisioningBandPeriodID | byte | ||
| InterestCapMethod | InterestCapMethods | ||
| ServiceOldestDebtFirst | boolean | ||
| IncludeInterestDueInArrears | boolean | ||
| IncludeDevaluationFeeInArrears | boolean | ||
| OffsetPrepaidBalanceAgainstInterestDueInArrears | boolean | ||
| IncludeOverdrawnDateInArrears | boolean | ||
| IgnoreScheduleInArrears | boolean | ||
| CollectSavingsDuringWriteOff | boolean | ||
| IsRPIInsuranceRequired | boolean | ||
| CUAccountIndustryCodeRequired | boolean | ||
| AllowLoanIssueOverride | boolean | ||
| Used | boolean | ||
| IncludeDueInScheduleRecalc | boolean | ||
| AttemptFeeExternal | boolean | ||
| InterestRefundMinimumPeriodNum | integer | ||
| InterestRatePeriod | byte | ||
| InterestRatePeriodNum | integer | ||
| FlatRateInterestPeriod | byte | ||
| FlatRateInterestPeriodNum | integer | ||
| FlatRateInterestRate | decimal number | ||
| UseSingleLoanAgreement | boolean | ||
| LoanAgreementId | integer | ||
| UseLoanRepaymentDateLimits | boolean | ||
| AllowPayoutWithInterestDue | boolean | ||
| AllowPayoutWithFeesDue | boolean | ||
| IsSeasonalLoan | boolean | ||
| UseHolidaysAndClosedDaysInPenaltyInterestCalculations | boolean | ||
| DeferredPeriodValue | integer | ||
| DeferredPeriodOptionID | integer | ||
| RenewPrincipalAndInterest | boolean | ||
| CalInterestAccrualDaily | boolean | ||
| SeparateonSchedule1 |
Separateonsechedule option for the Loan Product associated. |
boolean | This value is an optional. |
| SeparateonSchedule2 |
Separateonsechedule option for the Loan Product associated. |
boolean | This value is an optional. |
| FeeType1 | FeeTypes | ||
| FeeType2 | FeeTypes | ||
| IsUseDefaultInterestRateByLoanCount |
Indicates whether interest rate should be based on loan count |
boolean | This value is an optional |
| IsAllowToOverrideIntRateAtApplicationLevel |
Indicates whether interest rate should be editable in loan application even when loan count is used |
boolean | This value is an optional |
| ScheduleRounding | boolean | ||
| ScheduleRoundingID | integer | ||
| PenaltyInterestPerPayment | boolean | ||
| AllowBankChequePrinting | boolean | ||
| AllowChangeBankAccount | boolean | ||
| IsUseDefaultInterestRateByTieredSettings | boolean | ||
| WithholdDueAmount | boolean | ||
| PrepayNextDueOnly | boolean | ||
| RescheduleonOverpayment | boolean | ||
| PenaltyPerPeriodicArrears | boolean | ||
| TransferAccrueInterestOnly | boolean | ||
| TransferAccrueInterestOnlyOnScheduleDates | boolean | ||
| InsuranceProductID | integer | ||
| IsInsuranceMandatory | boolean | ||
| UseTieredLinkedSavingsPayment | boolean | ||
| NumberOfReviews | integer | ||
| LoanDistrictCodeRequired | boolean | ||
| UseFixedPenalty | boolean | ||
| UseCreditScoringLimits | boolean | ||
| InterestRoundingAdjustmentType | InterestRoundingAdjustmentType | ||
| DeclinedInterest | boolean | ||
| HalfBalloonPayments | boolean | ||
| PreventChangeAccountPortfolioOnAccounts | boolean | ||
| CreditControlID | integer | ||
| CreditControlWoffID | integer | ||
| IgnoreTermAndIssueDuringRestructure | boolean | ||
| CollectLinkedSavingsPaymentFor | CollectLinkSavPaymentFor | ||
| CheckPercentageOfLoanAmountInLinkedSavings | boolean | ||
| LinkedSavingsPercentageOfLoan | decimal number | ||
| MandatoryAccountActivity | boolean | ||
| MandatoryAccountActivityPeriodID | byte | ||
| MandatoryAccountActivityPeriodNum | integer | ||
| NumberOfTransactions | integer | ||
| MandatorySavingsRequired | boolean | ||
| MandatorySavingsAmount | decimal number | ||
| ISSeparateInstallmentsInSchedule | boolean | ||
| TransferFrmMandatoryToLinkedSavings | boolean | ||
| CalculatePaymentPercentageBasedOnOriginalLoanAmount | boolean | ||
| AllowMandatoryOverride | boolean | ||
| NthInstallmentPeriod | integer | ||
| AllowTopUpInArrears | boolean | ||
| NotSetSameAccountForLinkedAndMandatorySavings | boolean | ||
| FixedPenaltyGracePeriods | integer | ||
| BalloonPaymentMethod |
Balloon payment method for this product. |
BalloonPaymentMethodType | |
| EffectiveInterestRateMethodID |
Indicates whether issue fee should be calculated only once for the accounts under the selected product. |
byte | This value is an optional |
| APRCalculationMethodID | APRCalculationMethod | ||
| AllowIssueMoreThanApprovedAmount | AllowWithOverrideOptions | ||
| AllowIssueLessThanApprovedAmount | AllowWithOverrideOptions | ||
| NotTocollectFutureInterestInPayoutAndTransfer | boolean | ||
| ProductLimitsByCustomersBranch | boolean | ||
| CollectPenaltyByOutstandingPeriod | boolean | ||
| UseRestructeredProductControlAccount | boolean | ||
| LinkedSavingsProductID | integer | ||
| LoanReasonRequried | boolean | ||
| SplitOutstandingInterest | boolean | ||
| UseDefaultDayCountFractionByLoanTerm | boolean | ||
| EarlyPayoutFeeType | byte | ||
| EarlyPayoutFeeGracePeriodID | byte | ||
| EarlyPayoutFeeGracePeriodNum | integer | ||
| ProvisionMethod | byte | ||
| IsSourceOfFundMandatory | boolean | ||
| AllowCoolingPeriod | boolean | ||
| NthCoolingPeriod | integer | ||
| CoolingPeriod | CoolingPeriod | ||
| IgnoreClosedHolidaysForFlatLoans | boolean | ||
| UseGuarantorTypeRestriction | boolean | ||
| DeductUnpostedDeferredFeesInProvision | boolean | ||
| IncludeInterestDueTillTheRunDateForTheScheduledInterestLoansInProvision | boolean | ||
| ExcludePaymentAccountBalanceInProvision | boolean | ||
| AllowOverridePayoutFee | integer | ||
| IntRate |
Current Interest Rate of the product. |
decimal number | Required |
| MaxRate |
Maximum Interest allowed for this product. |
decimal number | |
| MinRate |
Minimum Interest allowed for this product. |
decimal number | |
| Rate |
Rate required for this product. |
decimal number |
Response Formats
application/json, text/json
Sample:
Sample not available.