GET api/savings/balance
Get savings account balance.
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/savings/balance. 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 |
|---|---|---|---|
| SavingsAccountID |
Unique identifier of a savings account. |
integer | Required, if account number is null. |
| ValueDate |
Current Session Date. |
string | Required. |
| Address |
Represents Address Parameters. |
AddressSearch | |
| BranchID |
Unique identifier of a branch. |
integer | |
| CUAccountPortfolioID |
Unique identifier of a portfolio. |
integer | |
| VillageBankID |
Unique identifier of a village bank. |
integer | |
| AccountType |
Account's type (loan or savings or both). |
ProductTypes | |
| ProductID |
Unique identifier of a product. |
integer | |
| CustomerNumbers |
Collection of numbers. |
Collection of string | |
| CustomerID |
Unique Identifier of a customer. |
integer | |
| AccountStatus |
Represents the status of an account. |
AccountStatus | |
| AccountNumber |
Unique Number of an account. |
string | Required, if account/customer id is null. |
| ActiveState |
Indicates Account status, e.g true = active, false = inactive or null = both |
boolean | |
| CurrencyFilter |
Account currencyId. |
integer | |
| IncludeAllInfo |
Represents whether to include custoemr , loan and product information or not. |
boolean | |
| IsShowCancelledLoanAccounts |
Show Cancelled loan accounts. |
boolean | |
| 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 savings account balance for the given search parameter.
decimal numberResponse Formats
application/json, text/json
1.0
application/xml, text/xml
<decimal xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</decimal>