Savings Products

LIST: GET /api/sacco_savingproducts/list

Returns collection of saving products in JSON format.

Resource URL 

/api/sacco_savingproducts/list or /api/sacco_savingproducts/list?start={start}&limit={limit}

Resource Properties

PROPERTY DESCRIPTION
Method GET
Response formats JSON
Requires authentication? Yes

URL Params

PARAM TYPE REQUIRED/OPTIONAL DESCRIPTION
companyId number required specify sacco company
start number optional Specify beginning of paging
limit number optional Specify end of paging

Example <base_url>/api/sacco_savingproducts/list?companyId=36765664

Response

{
    "count": 1,
    "list": [
        {
            "compulsory": null,
            "memberClassId": null,
            "memberClassName": null,
            "companyId": 36765664,
            "minActivePeriod": 0,
            "interestDeclAccId": null,
            "interestWhtAccId": null,
            "withdrawPayableAccId": null,
            "id": 36768364,
            "effectiveDate": 1577826000000,
            "name": "DEPOSIT/CONTRIBUTION",
            "code": "SA001",
            "descr": "",
            "initialMinAmount": null,
            "initialMaxAmount": null,
            "accountMinBal": 0.00,
            "accountMaxBal": null,
            "interestEarnMinBal": 0.00,
            "interestEarnMaxBal": null,
            "interestFreq": "ANNUALLY",
            "guaranteeRate": null,
            "status": null,
            "depositFreq": "MONTHLY",
            "depositMode": null,
            "depositMinAmount": 2000.00,
            "depositMaxAmount": null,
            "accountTransferable": null,
            "memberTransferable": null,
            "collateralAssignable": null,
            "guaranteeAssignable": null,
            "withdrawable": null,
            "interestPostingFreq": null,
            "allowRegularTxn": null,
            "atmCardEligible": null
        }
    ]
}

LOAD: GET /api/sacco_savingproducts/load/{id}

Returns saving product details in JSON format. ID must be provided as path parameter.

Resource URL 

/api/sacco_savingproducts/load/{id}

Resource Properties

PROPERTY DESCRIPTION
Method GET
Response formats JSON
Requires authentication? Yes

URL Params

Always specify companyId param

PARAM TYPE REQUIRED/OPTIONAL DESCRIPTION
id number required The ID of the bank to load details.

Response status

HTTP Status Code Reason
200 Found Record
404 Record not found
405 Invalid input
500 Internal server error

Example <base_url>/api/sacco_savingproducts/load/36768364

Response

{
    "compulsory": null,
    "memberClassId": null,
    "memberClassName": null,
    "companyId": 36765664,
    "minActivePeriod": 0,
    "interestDeclAccId": null,
    "interestWhtAccId": null,
    "withdrawPayableAccId": null,
    "id": 36768364,
    "effectiveDate": 1577826000000,
    "name": "DEPOSIT/CONTRIBUTION",
    "code": "SA001",
    "descr": "",
    "initialMinAmount": null,
    "initialMaxAmount": null,
    "accountMinBal": 0.00,
    "accountMaxBal": null,
    "interestEarnMinBal": 0.00,
    "interestEarnMaxBal": null,
    "interestFreq": "ANNUALLY",
    "guaranteeRate": null,
    "status": null,
    "depositFreq": "MONTHLY",
    "depositMode": null,
    "depositMinAmount": 2000.00,
    "depositMaxAmount": null,
    "accountTransferable": null,
    "memberTransferable": null,
    "collateralAssignable": null,
    "guaranteeAssignable": null,
    "withdrawable": null,
    "interestPostingFreq": null,
    "allowRegularTxn": null,
    "atmCardEligible": null
}