Account
Api methods performing on account data.
| API | Name | Description |
|---|---|---|
| GET api/account |
SearchAccounts |
Search accounts based on input parameters. |
| GET api/customeraccount/search |
SearchCustomerAccounts |
Get Customer Accounts. |
AccountLoan
Api methods performed on loan account data.
| API | Name | Description |
|---|---|---|
| GET api/Guarantor/{id} |
GetGuarantorInfo |
Get guarantor info by account id. |
| GET api/loan/{id} |
GetLoanAccount |
Get a loan account by id. |
| GET api/loan/{id}/createoption?ByLoanID={ByLoanID}&OnlyGuarantor={OnlyGuarantor}&AddAutoSurvey={AddAutoSurvey}&IsTopUp={IsTopUp} |
FetchLoanAccount |
Fetch loan account by parameters. |
| GET api/loan/paymentallocation?CustomerID={CustomerID} |
GetPaymentAllocation |
Get loan payment schedule information. |
| GET api/loan/payments/{id} |
GetPaymentInformation |
Get payment information of a specified loan account on a session date. |
| POST api/loan |
CreateLoanAccount |
Add a loan account. |
| POST api/loan/calculate |
CalculateSchedule |
Calculates a schedule for a new loan application. |
| POST api/loan/calculateeffectiveinterestrate |
CalculateEffectiveInterestRate |
Calculates Effective Interest Rate. |
| POST api/loan/guarantor/{id} |
AddLoanGuarantor |
Add details of Loan Guarantor. Using this method guarantor details are added for a loan. |
| POST api/loan/scheduleedit |
LoanScheduleEdit |
Calculates a schedule for a new loan application. |
| PUT api/loan/{id}/details |
UpdateLoanDetails |
Change loan details. Using this method, analysis and survey values can be added and edited.Loan Options and Classification fields also can be edited.No calculation will be happened and so any other fields such as loan amount , term etc which are required recalculation will be ignored using this API method.Analysis Fields: Analysis fields can be added or removed by this API. If the user want to remove all the analysis fields of a loan account, then empty data should be given. For example in JSON, "AnalysisLinks":[]. When this data is not passed by API, then nothing will be happened the existing settings will remain.Survey values can be added or edited. The survey values can't be deleted by this API. |
| PUT api/loan/{id}/processes |
UpdateLoanProcesses |
Manage loan processes. |
| PUT api/loan/{id}/schedule |
UpdateLoanSchedule |
Edit the loan schedule. User can shift only the repayment dates. Repayment amounts will not be changed as loan will not be recalculated.Loans/Repayments which are satisfying the following constraints only can be edited using this method. 1.Use schedule interest enabled loans. 2.Issued loans. 3.Unpaid repayments. |
| PUT api/loan/cancel/{id} |
CancelLoan |
Cancel loan application which has not been issued. |
| PUT api/loan/paymentanddisbursementaccount/{id} |
UpdateLoanPaymentAndDisbursementAccount |
Update payment account and disbursement account for a loan. |
| PUT api/loan/refinance/{id} |
TopupLoanAccount |
Topup/refinance an existing loan account. |
AccountPortfolio
| API | Name | Description |
|---|---|---|
| POST api/accountportfolio/savetransferportfolioletter |
SaveTransferAccountPortfolioLetter |
Save handover letters. |
| POST api/accountportfolio/transferportfolio |
TransferAccountPortfolio |
Transfers portfolio for selected accounts. |
| POST api/accountportfolio/transferportfoliolist |
FetchTransferAccountPortfolioList |
Fetch the records whose portfolios are to be transfered. |
AccountSavings
API methods performing on savings account data.
| API | Name | Description |
|---|---|---|
| GET api/savings/{id} |
GetSavingsAccount |
Fetch Savings Account Details using account id. |
| GET api/savings/{id}/balance/{valueDate} |
GetSavingsAccountBalance |
Get savings account balance. |
| GET api/savings/balance |
GetSavingsBalance |
Get savings account balance. |
| GET api/savings/InterestRate?productID={productID}&termPeriodID={termPeriodID}&termPeriodNumber={termPeriodNumber}&agreedAmount={agreedAmount} |
GetInterestRate |
Fetch interest rate for the changed agreed amount. |
| GET api/savings/numberoftransaction/{id}/{periodnum} |
GetSavingsAccountTransactionNumber |
|
| POST api/savings |
CreateSavingsAccount |
Create a savings account. |
| POST api/savings/calculate |
SavingsScheduleCalculate |
Calculate schedule for term deposit savings. |
| PUT api/savings/close |
CloseSavingsAccount |
Close Savings account. |
AddressIDType
Api methods performing on Address Types.
| API | Name | Description |
|---|---|---|
| GET api/addressidtype |
GetAddressIDTypes |
Get address types. |
AnalysisGroup
Api methods performing on analysis group data.
Bank
Api methods performing on Bank data.
| API | Name | Description |
|---|---|---|
| GET api/bank |
GetBanks |
Get Bank Details. |
BankBranch
Api methods performing on Bank Branch data.
| API | Name | Description |
|---|---|---|
| GET api/bankbranch |
GetBankBranches |
Get Bank Branch Details. |
Batch
Api methods performing on batch data.
| API | Name | Description |
|---|---|---|
| GET api/batch |
GetBatches |
Get all Batch List. |
Branch
Api methods performing on Branch data.
| API | Name | Description |
|---|---|---|
| GET api/branch |
GetBranches |
Get all branches. |
| GET api/branch/{id} |
GetBranch |
Get branch by id. |
| GET api/branch/search?AllowCustomers={AllowCustomers}&Active={Active}&Menu={Menu}&ResultsLimit={ResultsLimit} |
SearchBranches |
Search branch based on input parameters. |
CashManager
Api controller for Cash Manager.
| API | Name | Description |
|---|---|---|
| GET api/cashmanager/listaccounts?BranchID={BranchID}&CurrencyID={CurrencyID}&AccountTypesOptions={AccountTypesOptions}&CategoryTypes5Options={CategoryTypes5Options}&MainSubAccountsOptions={MainSubAccountsOptions}&AccountName={AccountName}&AccountNumber={AccountNumber}&Active={Active}&TellerAccountsOnly={TellerAccountsOnly}&ResultsLimit={ResultsLimit} |
GetAccountLists |
Search GL Account Details based on search parameters. |
| POST api/cashmanager/save |
SaveCashManager |
Save Cash Manager. |
Cheque
Api methods performing on cheque data.
| API | Name | Description |
|---|---|---|
| GET api/cheque/{id} |
GetCheque |
Get Cheque by unique ID. |
| PUT api/cheque/{id} |
UpdateCheque |
Update a Cheque. |
CollectionSheetProcess
Represents Collection Sheet Process Data.
CreditControlProcess
Api methods performed on credit control process data.
| API | Name | Description |
|---|---|---|
| DELETE api/creditcontrolprocess/{id} |
DeleteCreditControlProcess |
Delete a credit control process. |
| GET api/creditcontrolprocess/search?StartDate={StartDate}&CalculationDate={CalculationDate}&LiveLoans={LiveLoans}&ResultsLimit={ResultsLimit} |
SearchCreditControlProcessAccounts |
Search credit control processes based on search parameters. |
| POST api/creditcontrolprocess/add |
AddCreditControlProcess |
Create a new credit control process. |
| PUT api/creditcontrolprocess/{id} |
UpdateCreditControlProcess |
Update a credit control process. |
CreditRating
API methods performing on credit rating data.
| API | Name | Description |
|---|---|---|
| GET api/creditrating |
GetCreditRatings |
Get all the credit ratings. |
CUAccountLoanIndustryCode
Api methods for Account Loan Industry Information.
| API | Name | Description |
|---|---|---|
| GET api/accountloanindustrycode |
GetAccountLoanIndustryCodes |
Get Account Loan Industry Codes. |
CUAccountPortfolio
API methods performing on CUAccountPortfolio Data.
| API | Name | Description |
|---|---|---|
| GET api/cuaccountportfolio |
GetCUAccountPortfolios |
Get list of Account portfolios that are set in Abacus. |
| POST api/cuaccountportfolio/change/{id}/{cuAccountID}/{productTypeID} |
ChangeAccountPortfolio |
Change account portfolio of a account. |
CUAccountRating
API methods performing on account rating data.
| API | Name | Description |
|---|---|---|
| GET api/accountrating/search?ProductType={ProductType}&ResultsLimit={ResultsLimit} |
SearchAccountRatings |
Get all account ratings matching the input parameters. |
CUAppointment
Api controller for calendar
| API | Name | Description |
|---|---|---|
| DELETE api/appointment/{id} |
DeleteAppointment |
Delete an appointment from the CRM calendar |
| GET api/appointment/search?StartDate={StartDate}&EndDate={EndDate}&UserID={UserID}&CustomerID={CustomerID}&IsIncompleteAppointment={IsIncompleteAppointment}&ResultsLimit={ResultsLimit} |
SearchAppointments |
Search Appointment Details based on search parameters. |
| POST api/appointment |
AddAppointment |
Create an appointment. |
| PUT api/appointment/{id} |
UpdateAppointment |
Edit an appointment. |
CUEmail
Api methods performed on Email data.
| API | Name | Description |
|---|---|---|
| GET api/customeremail/{id} |
GetEmail |
Get email by email sent id. |
| GET api/customeremail/search?CustomerID={CustomerID}&EmailSentID={EmailSentID}&ResultsLimit={ResultsLimit} |
SearchEmails |
Search emails based on search parameters. |
| POST api/customeremail/send |
SendEmail |
Create and send an email. |
CULetter
Api controller for Customer Letters and Account Letters.
| API | Name | Description |
|---|---|---|
| GET api/letter/search?CustomerId={CustomerId}&CUAccountId={CUAccountId}&CustomerOnly={CustomerOnly}&UserId={UserId}&ResultsLimit={ResultsLimit} |
SearchLetters |
Search letters based on search parameters. |
| POST api/letter |
AddLetters |
Add Letter Details. |
CULoanCollateral
Api methods performing on collateral data of the loan.
| API | Name | Description |
|---|---|---|
| DELETE api/culoancollateral/{id} |
DeleteLoanCollateral |
Delete a CULoanCollateral. |
| GET api/culoancollateral/calculate |
CalculateLoanCollateral |
Calculate loan collateral values. |
| GET api/culoancollateral/requiredcollateraltotal/{id} |
RequiredLoanCollateralTotal |
Get required collateral total for a given loan account. |
| GET api/culoancollateral/search?CULoanID={CULoanID}&ResultsLimit={ResultsLimit} |
SearchLoanCollaterals |
Search loan collaterals based on input parameters. |
| POST api/culoancollateral |
CreateLoanCollateral |
Create a new CULoanCollateral. |
| PUT api/culoancollateral |
CreateUpdateLoanCollaterals |
Create/Update loan collaterals. |
| PUT api/culoancollateral/{id} |
UpdateLoanCollateral |
Update a CULoanCollateral. |
CULoanCollateralType
Api methods performing on loan collateral types.
| API | Name | Description |
|---|---|---|
| GET api/culoancollateraltype |
GetLoanCollateralTypes |
Get all LoanCollateralTypes. |
| GET api/culoancollateraltype/search?ProductID={ProductID}&ActiveState={ActiveState}&ResultsLimit={ResultsLimit} |
SearchLoanCollateralTypes |
Search LoanCollateralTypes based on input parameters. Input parameters are ProductID and ActiveState. |
CULoanDistrictCode
API methods performing on culoandistrictcode data.
| API | Name | Description |
|---|---|---|
| GET api/culoandistrictcode |
GetLoanDistrictCodes |
Get culoandistrictcodes. |
Currency
Api methods performing on currency data.
| API | Name | Description |
|---|---|---|
| GET api/currency |
GetCurrencies |
List all the currencies. |
CUSms
Api methods performed on SMS data.
| API | Name | Description |
|---|---|---|
| GET api/customersms/{id} |
GetTextMessage |
Get text message by sms sent id. |
| GET api/customersms/search?CustomerID={CustomerID}&SMSMessageOutID={SMSMessageOutID}&ResultsLimit={ResultsLimit} |
SearchTextMessages |
Search text messages based on search parameters. |
| POST api/customersms |
SendTextMessage |
Create and send an text message. |
Customer
API methods performing on Customer data.
| API | Name | Description |
|---|---|---|
| GET api/customer/{id} |
GetCustomer |
Get customer by id. |
| GET api/customer/createoption/{id}?CustomerCreate={CustomerCreate}&PersonCreate={PersonCreate}&AddAutoSurvey={AddAutoSurvey} |
GetCustomerWithOption |
Get customer by id and using create options. |
| GET api/customer/fingerprint/{customerId} |
FingerPrintbyCustomerId |
Get fingerprint for the given customerid. |
| GET api/customer/loanamountlimits/{customerId} |
LoanAmountLimitsbyCustomerId |
Get loan amount limits for the given customerid. |
| GET api/customer/roles |
ListCustomerRoles |
Get all customer roles list. |
| GET api/customer/search |
SearchCustomers |
Search customer based on input parameters. |
| GET api/customer/searchdetails |
SearchCustomerDetails |
Search customer based on input parameters, returning full customer, address and person details. |
| POST api/customer |
CreateCustomer |
Create a customer. |
| PUT api/customer/{id} |
UpdateCustomer |
Update a customer. |
| PUT api/customer/closereopen |
CloseReopenCustomer |
Close or Reopen the active or closed customer respectively. |
| PUT api/customer/freeze/{id}?doFreeze={doFreeze} |
FreezeCustomer |
Freeze/unfreeze the customer. |
CustomerBlacklisting
Api methods performing on customer blacklisting data.
| API | Name | Description |
|---|---|---|
| POST api/customerblacklisting |
AddCustomerBlacklisting |
Create a new Customer blacklisting. |
CustomerDocument
Api methods performing on customer document data.
| API | Name | Description |
|---|---|---|
| DELETE api/customerdocument/{id} |
DeleteCustomerDocument |
Delete a customer document. |
| POST api/customerdocument |
AddCustomerDocument |
Create a customer document. |
CustomerInteraction
Api methods performed on customer interaction data.
| API | Name | Description |
|---|---|---|
| POST api/interaction |
CreateInteraction |
Create/update a interaction. |
CustomerMessage
API methods performing on customer message data.
| API | Name | Description |
|---|---|---|
| GET api/customermessage/{id} |
GetCustomerMessage |
Get a customer message. |
| POST api/customermessage |
CreateCustomerMessage |
Create a customer message. |
| PUT api/customermessage/{id} |
UpdateCustomerMessage |
Update a customer message. |
CustomerNote
Api methods performing on customer note data.
| API | Name | Description |
|---|---|---|
| DELETE api/note/{id} |
DeleteNote |
Delete a customer note. |
| GET api/customernotes?CustomerID={CustomerID}&Number={Number}&ResultsLimit={ResultsLimit} |
GetNotesByCustomerId |
Notes of a given CustomerId. |
| GET api/note/{id} |
GetNote |
Note of a given noteId. |
| POST api/note |
CreateNote |
Create a new customer note. |
| PUT api/note/{id} |
UpdateNote |
Update a customer note. |
Employer
Api methods performing on employer data.
| API | Name | Description |
|---|---|---|
| GET api/employer |
GetEmployers |
Get all Employers. |
Fee
API methods performing on fee data.
| API | Name | Description |
|---|---|---|
| GET api/fee |
GetFees |
Get a list of fees. |
| GET api/fee/feeband |
GetFeeBands |
Get all fee bands. |
Fingerprint
API controller for fingerprint operations, mainly for Android app.
| API | Name | Description |
|---|---|---|
| POST api/fingerprint |
CreatePendingFingerprint |
Create a new PendingFingerprint. |
GlobalSettings
API methods performing on Global System Settings.
| API | Name | Description |
|---|---|---|
| GET api/setting |
GetAllSystemSettings |
Get system settings. |
| GET api/setting/search?SystemSettingsType={SystemSettingsType} |
SearchSystemSettingsByOption |
Get system settings by options. |
Industry
Api methods performing on industry data.
| API | Name | Description |
|---|---|---|
| GET api/industry |
GetIndustryCodes |
Get industries. |
InteractionType
Api methods performed on interaction type data.
| API | Name | Description |
|---|---|---|
| DELETE api/interactiontype/{id} |
DeleteInteractionType |
Delete an interaction type. |
| POST api/interactiontype |
AddInteractionType |
Create a new interaction type. |
| PUT api/interactiontype/{id} |
UpdateInteractionType |
Update an interaction type. |
Journal
| API | Name | Description |
|---|---|---|
| GET api/account/search?BranchID={BranchID}&CurrencyID={CurrencyID}&AccountTypesOptions={AccountTypesOptions}&CategoryTypes5Options={CategoryTypes5Options}&MainSubAccountsOptions={MainSubAccountsOptions}&AccountName={AccountName}&AccountNumber={AccountNumber}&Active={Active}&TellerAccountsOnly={TellerAccountsOnly}&ResultsLimit={ResultsLimit} |
SearchGLAccounts |
Search accounts based on input parameters. |
| GET api/journal/{id} |
GetJournalById |
Get Journal page by id. |
| GET api/journal/{id}/{branchid} |
GetJournalByJournalAndBranchId |
Get Journal page by branchid and id. |
| GET api/journal/branch/{id} |
GetJournalByBranchId |
No documentation available. |
| POST api/importjournal |
ImportJournal |
Import Journal Entries. |
| POST api/journalentries |
CreateJournalEntries |
Create Journal Entries. |
JournalPage
| API | Name | Description |
|---|---|---|
| GET api/journalpage/{id} |
GetJournalPage |
Get Journal page by id. |
| POST api/journalpage |
PostJournalPage |
Post a Journal page. |
LetterProcessing
Letter Processing API.
| API | Name | Description |
|---|---|---|
| GET api/letterprocessing/history |
GetHistory |
Returns a list of letter batches. |
| GET api/letterprocessing/schedules |
GetAllActiveSchedules |
Fetch all active letter schedules. |
| GET api/letterprocessing/search |
SearchLetterBatchAccounts |
Returns a list of customer. |
LoanGuarantorSource
Api methods for Loan Guarantor Source Information.
| API | Name | Description |
|---|---|---|
| GET api/loanguarantorsource |
GetLoanGuarantorSources |
Get Loan Guarantor Sources. |
LoanProduct
Api methods performing on loan product data.
LoanReason
Api methods performing on loan reason data.
| API | Name | Description |
|---|---|---|
| GET api/loanreason |
GetLoanReasons |
Get loan reasons. |
LoanRefinanceReason
Api methods performing on loan refinance reason data.
| API | Name | Description |
|---|---|---|
| GET api/loanrefinancereason |
GetLoanRefinanceReasons |
Get loan refinance reasons. |
LoanReview
Api methods performed on Loan Review data.
| API | Name | Description |
|---|---|---|
| PUT api/loanreview |
CreateLoanReview |
Create/update a loan review. |
LoanSourceOfFunds
Api methods performing on LoanSource Of Funds data.
| API | Name | Description |
|---|---|---|
| GET api/loansourceoffunds |
GetAllLoanSourceOfFunds |
Get LoanSourceOfFunds. |
| GET api/loansourceoffunds/{id} |
GetLoanSourceOfFunds |
Get LoanSourceOfFunds by id. |
Login
Api methods to login to Abacus REST API.
| API | Name | Description |
|---|---|---|
| POST api/login |
CreateLogin |
Login to Abacus REST API. A user can login to api from different devices at the same time, for each device the user will be given different token. |
| PUT api/login/{userName}/password |
PasswordExpired |
Update given user's password. |
Logout
Api methods to logout from Abacus REST API.
| API | Name | Description |
|---|---|---|
| DELETE api/logout |
Logout |
Logout from Abacus REST API. The api request discards the token supplied 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”. |
Miscellaneous
Represents Miscellaneous items.
| API | Name | Description |
|---|---|---|
| GET api/miscellaneous/search?Code={Code}&AllItems={AllItems}&ResultsLimit={ResultsLimit} |
SearchMiscItems |
Get miscellaneous values based on search parameters. |
PaymentPeriod
Api methods performing on paymentperiod data.
| API | Name | Description |
|---|---|---|
| GET api/paymentperiod |
GetPaymentPeriods |
Get Payment Periods. |
PersonalIDType
Api methods performing on personal id type data.
| API | Name | Description |
|---|---|---|
| GET api/personalidtype |
GetPersonalIDTypes |
Get all person id type data. |
Picture
Api methods performing on Picture data.
| API | Name | Description |
|---|---|---|
| GET api/picture/{id} |
GetPicture |
Get picture by id. |
| POST api/picture |
CreatePicture |
Create a picture. |
| PUT api/picture/{id} |
UpdatePicture |
Update a picture. |
Receipt
API methods perform transactions.
Relationship
Api methods performing on relationship data.
| API | Name | Description |
|---|---|---|
| GET api/relationship |
GetRelationships |
Get list of relationships. |
SCVAccountStatus
Api methods performing on SCV Account Status data.
| API | Name | Description |
|---|---|---|
| GET api/scvaccountstatuscode |
GetSCVStatusCodes |
Get SCV Status Code. |
SettingsAddress
Api methods performing on address settings.
| API | Name | Description |
|---|---|---|
| GET api/settingsaddress |
GetSettingsAddress |
Get address settings defined in Abacus. |
| GET api/settingsaddress/listvalues/{addresslistid} |
GetAddressListValues |
Get addressfield list values defined in Abacus. |
ShareProduct
Api methods performing on Share Product data.
| API | Name | Description |
|---|---|---|
| GET api/shareproduct |
GetShareProducts |
Get Share Products. |
| GET api/shareproduct/{id} |
GetShareProduct |
Get shareProduct by id. |
| GET api/shareproduct/search?Active={Active}&Default={Default}&ProductID={ProductID}&ProductTypeID={ProductTypeID}&CurrencyID={CurrencyID}&BranchID={BranchID}&ResultsLimit={ResultsLimit} |
SearchShareProduct |
Get share products based on input parameters. |
Signature
Api methods performing on Signature data.
| API | Name | Description |
|---|---|---|
| GET api/signature/{id} |
GetSignature |
Get Signature by id. |
| POST api/Signature |
CreateSignature |
Create a Signature. |
| PUT api/signature/{id} |
UpdateSignature |
Update a Signature. |
User
API methods performing on user data.
| API | Name | Description |
|---|---|---|
| GET api/user/{id}/branchid |
GetUserByBranchID |
Fetch user by branchId. |
| GET api/user/{id}/contraaccountsbalance |
GetUserContraAccountsBalance |
Get user's contra accounts balance for a given user id. |
| GET api/user/{id}/settings |
GetUserSettings |
Get user's settings configured for a given user id. |
| PUT api/user/password |
UpdatePassword |
Update current user's password. |
UserDefinedFieldGroup
Api methods performing on user defined field group data.
VillageBank
Api methods performing on VillageBank data.
| API | Name | Description |
|---|---|---|
| GET api/villagebank |
GetVillageBanks |
Get all village banks with associated portfolio group. |
| GET api/villagebankwithaccountportfolio |
GetVillageBanksWithAccountPortfolio |
Get all village banks with associated account portfolio and portfolio group. |