Retrieve Ad-Hoc Search Query Template

get https://api.cloud.mbanq.com/v1/search/template

Use this API to retrieve a template for performing ad-hoc searches on loan products.
This template provides a comprehensive structure, listing various loan product attributes and configurations.
It includes specific details such as the loan product ID, name, interest rate settings, borrower cycle parameters, installment options, and other configurations related to loan management.
This API enables efficient search and filtering of loan products based on a variety of customizable criteria, facilitating targeted queries within the system.

Response

Response body

object

loanProducts

array of objects

A list of loan products with various attributes related to borrower cycles, interest rates, and other configurations.

loanProducts

object

integer

The unique identifier of the loan product.
Example: 117

name

string

The name of the loan product.
Example: Loan Product

includeInBorrowerCycle

boolean

Indicates if the loan product is included in the borrower cycle.
Example: false

useBorrowerCycle

boolean

Specifies if the borrower cycle is utilized for this loan product.
Example: false

isLinkedToFloatingInterestRates

boolean

Indicates if the loan product is linked to floating interest rates.
Example: false

isFloatingInterestRateCalculationAllowed

boolean

Specifies if floating interest rate calculation is permitted for the loan product.
Example: false

allowVariableInstallments

boolean

Specifies if variable installments are allowed for the loan product.
Example: false

isInterestRecalculationEnabled

boolean

Indicates if interest recalculation is enabled for the loan product.
Example: false

canDefineInstallmentAmount

boolean

Indicates if the installment amount can be defined for the loan product.
Example: false

principalVariationsForBorrowerCycle

array

A list of principal variations for different borrower cycles.
Example: []

principalVariationsForBorrowerCycle

interestRateVariationsForBorrowerCycle

array

A list of interest rate variations for different borrower cycles.
Example: []

interestRateVariationsForBorrowerCycle

numberOfRepaymentVariationsForBorrowerCycle

array

A list of repayment variations for different borrower cycles.
Example: []

numberOfRepaymentVariationsForBorrowerCycle

canUseForTopup

boolean

Indicates if the loan product can be used for a top-up loan.
Example: false

multiDisburseLoan

boolean

Specifies if the loan product allows multiple disbursements.
Example: false

holdGuaranteeFunds

boolean

Indicates if guarantee funds are held for the loan product.
Example: false

accountMovesOutOfNPAOnlyOnArrearsCompletion

boolean

Indicates if the account moves out of Non-Performing Asset (NPA) status only upon completion of arrears.
Example: false

syncExpectedWithDisbursementDate

boolean

Specifies if synchronization with the disbursement date is expected for the loan product.
Example: false

isEqualAmortization

boolean

Indicates if equal amortization is applied to the loan product.
Example: false

isGenerateRepaymentSchedule

boolean

Specifies if the repayment schedule is generated for the loan product.
Example: false

isRevolvingLoanProduct

boolean

Indicates if the loan product is a revolving loan.
Example: false

isLinkedWithFundSourceAccount

boolean

Specifies if the loan product is linked with a fund source account.
Example: false

isIgnoreUndisbursedTranches

boolean

Indicates if undisbursed tranches should be ignored for the loan product.
Example: false

interestRateVariesMonthly

boolean

Specifies if the interest rate varies on a monthly basis for the loan product.
Example: false

offices

array of objects

A list of office locations with their identifiers and names.

offices

object

integer

The unique identifier of the office.
Example: 1

name

string

The name of the office.
Example: Head Office

nameDecorated

string

The decorated name of the office, often used for display purposes.
Example: ....Head Office

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.cloud.mbanq.com/v1/search/template \
3
     --header 'accept: application/json' \
4
     --header 'tenantId: z01j3e71zd6zkq908vyf5861a8'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Retrieve Ad-Hoc Search Query Template successfully.