Loans

LIST: GET /api/sacco_loan/applications

Returns collection of loan applications in JSON format.

Resource URL 

/api/sacco_loan/applications?companyId={companyId}

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
accountId number optional saving account id
memberId number optional membership Id
productId number optional saving product id
start number optional Specify beginning of paging
limit number optional Specify end of paging

Example <base_url>/api/sacco_loan/applications?companyId=36765664

Response

{
    "count": 19,
    "list": [
        {
            "id": 37962099,
            "loanNumber": "L000098",
            "product": "NORMAL LOAN",
            "productId": 36886798,
            "dateOfApplication": 1588280400000,
            "payFrom": 1588280400000,
            "amountAppliedFor": 20000.00,
            "loanAmount": 20000.00,
            "interestRate": 12.00,
            "numberOfInstallments": 5.00,
            "repaymentFreq": "MONTHLY",
            "loanType": "REDUCING_INTEREST_EMI",
            "installmentAmount": 4120.80,
            "interestPaid": 603.98,
            "principalPaid": 20000.02,
            "loanBalance": -0.02,
            "totalLoanFee": 0.00,
            "status": "APPROVED",
            "gracePeriodMonths": 1,
            "payOffDate": 1598907600000,
            "memberNo": "M00007",
            "member": "ALYSA HARTFORD ",
            "ledgerId": 37962299,
            "interestPayment": 603.98,
            "disbursed": "NO",
            "disbursedAmt": 0.00,
            "existing": "YES",
            "takeOnJnlId": 37962598,
            "principalBal": -0.02,
            "interestBal": 0,
            "amountPaid": 20604.00,
            "submittedForAppraisal": "YES",
            "loanAmountOk": "YES",
            "sharesAtLoanOk": "YES",
            "savingAtLoanOk": "YES",
            "loanGuarantorsOk": "YES",
            "loanCollateralOk": "YES",
            "loanFeesOk": "YES",
            "loanFilesOk": "YES"
        },
        {
            "id": 37962100,
            "loanNumber": "L000099",
            "product": "SUPER LOAN",
            "productId": 36886799,
            "dateOfApplication": 1596315600000,
            "payFrom": 1596315600000,
            "amountAppliedFor": 50000.00,
            "loanAmount": 50000.00,
            "interestRate": 12.00,
            "numberOfInstallments": 10.00,
            "repaymentFreq": "MONTHLY",
            "loanType": "REDUCING_INTEREST_EMI",
            "installmentAmount": 5279.10,
            "interestPaid": 0.00,
            "principalPaid": 0.00,
            "loanBalance": 51711.34,
            "totalLoanFee": 0.00,
            "status": "APPROVED",
            "gracePeriodMonths": 1,
            "payOffDate": 1619902800000,
            "memberNo": "M00008",
            "member": "MARILEE BRANDT ",
            "ledgerId": 37962300,
            "interestPayment": 2791.05,
            "disbursed": "NO",
            "disbursedAmt": 0.00,
            "existing": "YES",
            "takeOnJnlId": 37962601,
            "principalBal": 50000.00,
            "interestBal": 0,
            "amountPaid": 0.00
            "submittedForAppraisal": "YES",
            "loanAmountOk": "YES",
            "sharesAtLoanOk": "YES",
            "savingAtLoanOk": "YES",
            "loanGuarantorsOk": "YES",
            "loanCollateralOk": "YES",
            "loanFeesOk": "YES",
            "loanFilesOk": "YES"
        }
    ]
}

LIST: GET /api/sacco_loan/repaymentschedule

Returns collection loan repayment schedule in JSON format.

Resource URL 

/api/sacco_loan/repaymentschedule?loanId={loanId}

Resource Properties

PROPERTY DESCRIPTION
Method GET
Response formats JSON
Requires authentication? Yes

URL Params

PARAM TYPE REQUIRED/OPTIONAL DESCRIPTION
loanId number required specify sacco company

Example <base_url>/api/sacco_loan/repaymentschedule?loanId=37962105

Response

{
    "count": 3,
    "list": [
        {
            "installmentNo": 1,
            "interestPayment": 12000.00,
            "principalPayment": 74548.54,
            "interestPmtReduction": 0.00,
            "principalPmtReduction": 0.00,
            "totalPayment": 86548.54,
            "cumulativeInterest": 12000.00,
            "principalApplied": 1200000.00,
            "principalAppReduction": 0.00,
            "repMonth": null,
            "repYear": 0,
            "repSeqnce": 1,
            "dueDate": 1588280400000,
            "dueDateFrom": null,
            "dueDateTo": null,
            "periodDate": null,
            "loan": null,
            "loanId": 37962105,
            "loanNumber": "L000104",
            "loanProduct": "NORMAL LOAN",
            "loanRepayments": [],
            "repaidPrincipal": 74548.54,
            "repaidInterest": null,
            "prepayment": null,
            "repaidAmount": 86548.54,
            "scheduleBal": 0.00,
            "membershipId": null,
            "membershipName": "SHANA REIFSTECK ",
            "loanLedgerId": 37962305,
            "interestAcId": 36767983,
            "interestIncome": null,
            "interestIncomeId": null,
            "interestPosted": "YES",
            "interestRate": 12.00,
            "creditReductionApplied": "NO",
            "withBalance": null,
            "withPrepayment": null,
            "currentMonth": null,
            "companyId": 36765664,
            "installmentFrom": 0,
            "exception": null,
            "batchId": null,
            "id": 37962263
        },
        {
            "installmentNo": 2,
            "interestPayment": 11254.51,
            "principalPayment": 75294.02,
            "interestPmtReduction": 0.00,
            "principalPmtReduction": 0.00,
            "totalPayment": 86548.54,
            "cumulativeInterest": 23254.51,
            "principalApplied": 1125451.46,
            "principalAppReduction": 0.00,
            "repMonth": null,
            "repYear": 0,
            "repSeqnce": 2,
            "dueDate": 1590958800000,
            "dueDateFrom": null,
            "dueDateTo": null,
            "periodDate": null,
            "loan": null,
            "loanId": 37962105,
            "loanNumber": "L000104",
            "loanProduct": "NORMAL LOAN",
            "loanRepayments": [],
            "repaidPrincipal": 75294.03,
            "repaidInterest": null,
            "prepayment": null,
            "repaidAmount": 86548.54,
            "scheduleBal": 0.00,
            "membershipId": null,
            "membershipName": "SHANA REIFSTECK ",
            "loanLedgerId": 37962305,
            "interestAcId": 36767983,
            "interestIncome": null,
            "interestIncomeId": null,
            "interestPosted": "YES",
            "interestRate": 12.00,
            "creditReductionApplied": "NO",
            "withBalance": null,
            "withPrepayment": null,
            "currentMonth": null,
            "companyId": 36765664,
            "installmentFrom": 0,
            "exception": null,
            "batchId": null,
            "id": 37962264
        },
        {
            "installmentNo": 3,
            "interestPayment": 10501.57,
            "principalPayment": 76046.96,
            "interestPmtReduction": 0.00,
            "principalPmtReduction": 0.00,
            "totalPayment": 86548.54,
            "cumulativeInterest": 33756.08,
            "principalApplied": 1050157.44,
            "principalAppReduction": 0.00,
            "repMonth": null,
            "repYear": 0,
            "repSeqnce": 3,
            "dueDate": 1593550800000,
            "dueDateFrom": null,
            "dueDateTo": null,
            "periodDate": null,
            "loan": null,
            "loanId": 37962105,
            "loanNumber": "L000104",
            "loanProduct": "NORMAL LOAN",
            "loanRepayments": [],
            "repaidPrincipal": 76046.97,
            "repaidInterest": null,
            "prepayment": null,
            "repaidAmount": 86548.54,
            "scheduleBal": 0.00,
            "membershipId": null,
            "membershipName": "SHANA REIFSTECK ",
            "loanLedgerId": 37962305,
            "interestAcId": 36767983,
            "interestIncome": null,
            "interestIncomeId": null,
            "interestPosted": "YES",
            "interestRate": 12.00,
            "creditReductionApplied": "NO",
            "withBalance": null,
            "withPrepayment": null,
            "currentMonth": null,
            "companyId": 36765664,
            "installmentFrom": 0,
            "exception": null,
            "batchId": null,
            "id": 37962265
        }
    ]
}

LOAD: GET /api/sacco_loan/ledger?ledgerId={ledgerId}&companyId={companyId}

Returns loan ledger transactions in JSON format. ledgerId and companyId must be provided as path parameter.

Resource URL 

/api/sacco_loan/ledger?ledgerId={ledgerId}&companyId={companyId}

Resource Properties

PROPERTY DESCRIPTION
Method GET
Response formats JSON
Requires authentication? Yes

URL Params

Always specify companyId param

PARAM TYPE REQUIRED/OPTIONAL DESCRIPTION
ledgerId number required The ID for loan account ledger
companyId number required The ID for company

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_loan/ledger?ledgerId=37962305&companyId=36765664

Response

{
    "count": 16,
    "list": [
        {
            "txnDate": 1577826000000,
            "descr": "Opening Balance",
            "debit": 0,
            "credit": 0,
            "balance": 0,
            "accountName": "REIFSTECK SHANA",
            "txnType": "BAL",
            "refNo": "-",
            "txnNo": "-"
        },
        {
            "id": 37962616,
            "txnDate": 1588280400000,
            "descr": "Loan balance l000104, Normal loan, Shana reifsteck ",
            "debit": 1200000.00,
            "credit": 0.00,
            "balance": 1200000.00,
            "accountName": "REIFSTECK SHANA",
            "accountId": 37962305,
            "accountCode": "LN#L000104",
            "journalId": 37962616,
            "txnId": 37962616,
            "posted": "YES",
            "txnType": "JNL",
            "user": "  "
        },
        {
            "id": 37962664,
            "txnDate": 1588280400000,
            "descr": "Interest for loan #l000104, Normal loan, Shana reifsteck ",
            "debit": 12000.00,
            "credit": 0.00,
            "balance": 1212000.00,
            "accountName": "REIFSTECK SHANA",
            "accountId": 37962305,
            "accountCode": "LN#L000104",
            "journalId": 37962664,
            "txnId": 37962664,
            "posted": "YES",
            "txnType": "JNL",
            "user": "  "
        },
        {
            "id": 37973195,
            "txnDate": 1588885200000,
            "descr": "Loan #l000104 - due on: 01/05/2020, Reifsteck shana",
            "debit": 0.00,
            "credit": 86548.54,
            "balance": 1125451.46,
            "accountName": "REIFSTECK SHANA",
            "accountId": 37962305,
            "accountCode": "LN#L000104",
            "journalId": 37973195,
            "txnId": 37973503,
            "posted": "YES",
            "txnType": "RCPT",
            "refNo": "wertyvcsfrev3",
            "txnNo": "RC00023",
            "user": "JOHN  SNOW"
        },
        {
            "id": 37962712,
            "txnDate": 1590958800000,
            "descr": "Interest for loan #l000104, Normal loan, Shana reifsteck ",
            "debit": 11254.51,
            "credit": 0.00,
            "balance": 1136705.97,
            "accountName": "REIFSTECK SHANA",
            "accountId": 37962305,
            "accountCode": "LN#L000104",
            "journalId": 37962712,
            "txnId": 37962712,
            "posted": "YES",
            "txnType": "JNL",
            "user": "  "
        }
   ]
}

LOAD: GET /api/sacco_loan/disbursement?membershipId={membershipId}&companyId={companyId}

Returns loan disbursement in JSON format. membershipId and companyId must be provided as path parameter.

Resource URL 

/api/sacco_loan/disbursement?membershipId={membershipId}&companyId={companyId}

Resource Properties

PROPERTY DESCRIPTION
Method GET
Response formats JSON
Requires authentication? Yes

URL Params

Always specify companyId param

PARAM TYPE REQUIRED/OPTIONAL DESCRIPTION
membershipId number required The ID for member
companyId number required The ID for company
loanId number optional The ID for loan

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_loan/disbursement?companyId=36765664

Response

{
    "count": 2,
    "list": [
        {
            "member": "WES LUMLEY ",
            "membershipId": 36768779,
            "amount": 950000.00,
            "loanId": 37962113,
            "loanName": "MWANGAZA LOANS",
            "loanNo": "L000112",
            "loanAmount": 950000.00,
            "loanType": "REDUCING_INTEREST_EMI",
            "status": "APPROVED",
            "dateOfApplication": 1583701200000,
            "disbursementDate": 1605387600000,
            "paymentMethod": "CHECK",
            "comments": "",
            "paymentId": 38996370,
            "paidAccountNo": null,
            "paidAccountName": null,
            "paidBank": null,
            "refNo": "3444444",
            "bankId": null,
            "branchId": null,
            "cashbookId": 37962315,
            "interestIncomeId": null,
            "companyId": 36765664,
            "id": 38996570
        },
        {
            "member": "NICKI REESER ",
            "membershipId": 36768766,
            "amount": 100000.00,
            "loanId": 38987804,
            "loanName": "TEST PRODUCT",
            "loanNo": "23330000004",
            "loanAmount": 400000.00,
            "loanType": "REDUCING_INTEREST",
            "status": "APPROVED",
            "dateOfApplication": 1605214800000,
            "disbursementDate": 1605214800000,
            "paymentMethod": "CHECK",
            "comments": "ok",
            "paymentId": 38986767,
            "paidAccountNo": null,
            "paidAccountName": null,
            "paidBank": null,
            "refNo": "232323",
            "bankId": null,
            "branchId": null,
            "cashbookId": 37962315,
            "interestIncomeId": null,
            "companyId": 36765664,
            "id": 38988104
        }
    ]
}

LOAD: GET /api/sacco_loan/guarantors?membershipId={membershipId}&companyId={companyId}

Returns loan guarantors in JSON format. membershipId and companyId must be provided as path parameter.

Resource URL 

/api/sacco_loan/guarantors?membershipId={membershipId}&companyId={companyId}

Resource Properties

PROPERTY DESCRIPTION
Method GET
Response formats JSON
Requires authentication? Yes

URL Params

Always specify companyId param

PARAM TYPE REQUIRED/OPTIONAL DESCRIPTION
membershipId number optional The ID for guarantor member
loanMembershipId number optional The ID for member being guaranteed
companyId number required The ID for company
loanId number optional The ID for loan

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_loan/guarantors?companyId=36765664

Response

{
    "count": 4,
    "list": [
        {
            "memberName": "ABRIL JEANE ",
            "memberNo": "M00045",
            "loanNo": "L0030000003",
            "loanBalance": 0.00,
            "loanMembershipId": 36768769,
            "loanMemberName": "JERROD WILHOIT ",
            "loanMemberNo": "M00006",
            "shareAt": 25000.00,
            "savingAt": 0.00,
            "loanBalAt": 0.00,
            "shareSavingAt": 25000.00,
            "percentageGuaranteed": null,
            "companyId": 36765664,
            "id": 37995668
        },
        {
            "memberName": "JOANNE PRETTY ",
            "memberNo": "M00002",
            "loanNo": "L0030000001",
            "loanBalance": 0.00,
            "loanMembershipId": 36768782,
            "loanMemberName": "SAUL BURNER ",
            "loanMemberNo": "M00019",
            "shareAt": 25000.00,
            "savingAt": 166000.00,
            "loanBalAt": 0.00,
            "shareSavingAt": 191000.00,
            "percentageGuaranteed": null,
            "companyId": 36765664,
            "id": 37995665
        },
        {
            "memberName": "KASSIE JEFFERY ",
            "memberNo": "M00027",
            "loanNo": "L0030000003",
            "loanBalance": 0.00,
            "loanMembershipId": 36768769,
            "loanMemberName": "JERROD WILHOIT ",
            "loanMemberNo": "M00006",
            "shareAt": 25000.00,
            "savingAt": 10000.00,
            "loanBalAt": 0.00,
            "shareSavingAt": 35000.00,
            "percentageGuaranteed": null,
            "companyId": 36765664,
            "id": 37995667
        },
        {
            "memberName": "ROSSIE KAGAN ",
            "memberNo": "M00044",
            "loanNo": "L0030000003",
            "loanBalance": 0.00,
            "loanMembershipId": 36768769,
            "loanMemberName": "JERROD WILHOIT ",
            "loanMemberNo": "M00006",
            "shareAt": 25000.00,
            "savingAt": 6000.00,
            "loanBalAt": 0.00,
            "shareSavingAt": 31000.00,
            "percentageGuaranteed": null,
            "companyId": 36765664,
            "id": 37995666
        }
    ]
}

LOAD: GET /api/sacco_loan/loandefaults?membershipId={membershipId}&loanProductId={loanProductId}

Returns loan defaults in JSON format. membershipId and loanProductId must be provided as path parameter.

Resource URL 

/api/sacco_loan/loandefaults?membershipId={membershipId}&loanProductId={loanProductId}

Resource Properties

PROPERTY DESCRIPTION
Method GET
Response formats JSON
Requires authentication? Yes

URL Params

Always specify companyId param

PARAM TYPE REQUIRED/OPTIONAL DESCRIPTION
membershipId number optional The ID for member applying for loan
loanProductId number optional The ID for loan product being applied for

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_loan/loandefaults?membershipId=40422&loanProductId=25855

Response

{
    "membershipId": 40422,
    "loanProductId": 25855,
    "amountAppliedFor": 1053591.540,
    "numberOfInstallments": 24,
    "interestRate": 12.00,
    "loanType": "REDUCING_INTEREST",
    "interestFrequency": "ANNUALLY",
    "repaymentFreq": "MONTHLY",
    "gracePeriodMonths": 0,
    "assignableShareAtLoan": 0,
    "assignableSavingAtLoan": 351197.18,
    "assignableShareAndSavingAtLoan": 351197.18,
    "maxAllowedLoanAt": 1053591.540,
    "requiredGuarantors": 0,
    "mandatoryGuarantee": 100.0,
    "mandatoryGuaranteeVal": 1053591.5400,
    "minOwnGuarantee": 34.0,
    "minOwnGuaranteeVal": 358221.12360,
    "minGuarantorsGuarantee": 66.0,
    "minGuarantorsGuaranteeVal": 695370.41640,
    "totalInterest": 131698.94,
    "totalLoanPayment": 1185290.49,
    "loanMonthlyPayment": 43899.64,
    "dueDate": 0,
    "projection": {
        "totalInterest": 131698.94,
        "totalPrincipal": 1053591.55,
        "totalPayment": 1185290.49,
        "monthlyPayment": 43899.64,
        "numberOfInstallments": 24,
        "schedules": [
            {
                "installmentNo": 1,
                "initInstallmentNo": 0,
                "interestPayment": 10535.91,
                "principalPayment": 43899.64,
                "totalPayment": 54435.56,
                "cumulativeInterest": 10535.91,
                "principalApplied": 1053591.54,
                "repYear": 0,
                "repSeqnce": 1,
                "installmentFrom": 0,
                "todayScheduleMarker": 0
            },
            {
                "installmentNo": 2,
                "initInstallmentNo": 0,
                "interestPayment": 10096.91,
                "principalPayment": 43899.64,
                "totalPayment": 53996.56,
                "cumulativeInterest": 20632.83,
                "principalApplied": 1009691.89,
                "repYear": 0,
                "repSeqnce": 2,
                "installmentFrom": 0,
                "todayScheduleMarker": 0
            }
        ]
    }
}

SAVE LOAN APPLICATION: POST /api/sacco_loan/save

Save loan application.

Resource URL 

/api/sacco_loan/save

Resource Properties

PROPERTY DESCRIPTION
Method POST
Request representations application/json
Requires authentication? Yes

Data Params/Body payload

{
    "membershipId": number [required] membership ID,
    "loanProductId": number [required] loan product/type ID,
    "amountAppliedFor": number [required] amount applied for,
    "numberOfInstallments": number [required] number of repayment installments,
    "assignableShareAtLoan": number [optional] Assignable Shares amount,
    "assignableSavingAtLoan": number [optional] Assignable Savings amount,
    "assignableShareAndSavingAtLoan": number [optional] Assignable Shares + Saving Amount
}

Response status

HTTP Status Code Reason
200 Successfully saved
405 Invalid input
500 Internal server error

Example <base_url>/api/sacco_loan/projection

Payload

{
    "membershipId": 132323,
    "loanProductId": 2323,
    "amountAppliedFor": 50000,
    "numberOfInstallments": 12,
    "assignableShareAtLoan": 0,
    "assignableSavingAtLoan": 20000,
    "assignableShareAndSavingAtLoan": 20000
}

Response

{
    "success": "true",
    "message": "successful"
}

LOAD LOAN PROJECTION: POST /api/sacco_loan/projection

Loads loan projection - calculation and schedules.

Resource URL 

/api/sacco_loan/projection

Resource Properties

PROPERTY DESCRIPTION
Method POST
Request representations application/json
Requires authentication? Yes

Data Params/Body payload

{
    "loanAmount": number [required] amount applied for,
    "feeAsPrincipal": number [optional] fees charged as principal,
    "interestRate": number [required] interest rate to be applied,
    "numberOfInstallments": number [required] number of repayment installments,
    "installmentAmount": number [required] installment amount,
    "interestType": enum [required]  ['FLAT_INTEREST','FLAT_INTEREST_EMI','FLAT_INTEREST_ON_PRINCIPAL_AMOUNT','REDUCING_INTEREST','REDUCING_INTEREST_EMI'],
    "interestFrequency": enum [required]  ['DAILY','WEEKLY','MONTHLY','ANNUALLY'],
    "repaymentFrequency": enum [required]  ['DAILY','WEEKLY','MONTHLY','ANNUALLY']
}

Response status

HTTP Status Code Reason
200 Successfully saved
405 Invalid input
500 Internal server error

Example <base_url>/api/sacco_loan/projection

Payload

{
    "loanAmount": 10000,
    "feeAsPrincipal": 0,
    "interestRate": 10,
    "numberOfInstallments" : 10,
    "installmentAmount" : 0,
    "interestType" : "REDUCING_INTEREST",
    "interestFrequency" : "MONTHLY",
    "repaymentFrequency" : "ANNUALLY"
}

Response

{
    "totalInterest": 5500,
    "totalPrincipal": 10000,
    "totalPayment": 15500,
    "monthlyPayment": 1000,
    "numberOfInstallments": 10,
    "schedules": [
        {
            "installmentNo": 1,
            "initInstallmentNo": 0,
            "interestPayment": 1000,
            "principalPayment": 1000,
            "totalPayment": 2000,
            "cumulativeInterest": 1000,
            "principalApplied": 10000,
            "repYear": 0,
            "repSeqnce": 1,
            "installmentFrom": 0,
            "todayScheduleMarker": 0
        },
        {
            "installmentNo": 2,
            "initInstallmentNo": 0,
            "interestPayment": 900,
            "principalPayment": 1000,
            "totalPayment": 1900,
            "cumulativeInterest": 1900,
            "principalApplied": 9000,
            "repYear": 0,
            "repSeqnce": 2,
            "installmentFrom": 0,
            "todayScheduleMarker": 0
        }
    ]
}

SAVE LOAN APPLICATION: POST /api/sacco_loan/saveguarantor

Save Guarantor nomination.

Resource URL 

/api/sacco_loan/saveguarantor

Resource Properties

PROPERTY DESCRIPTION
Method POST
Request representations application/json
Requires authentication? Yes

Data Params/Body payload

{
    "membershipId": number [required] membership ID,
    "loanId": number [required] loan ID,
}

Response status

HTTP Status Code Reason
200 Successfully saved
405 Invalid input
500 Internal server error

Example <base_url>/api/sacco_loan/saveguarantor

Payload

{
    "membershipId": 132323,
    "loanId": 2323
}

Response

{
    "success": "true",
    "message": "successful"
}

SAVE LOAN FILE: POST /api/sacco_loan/file_upload

Upload loan file

Resource URL 

/api/sacco_loan/file_upload

Resource Properties

PROPERTY DESCRIPTION
Method POST
Request representations application/json
Requires authentication? Yes

Data Params/Body payload

{
    "loanId": number [required] Loan ID,
    "fileName": text [required] Name of file,
    "fileBaseSixFour": text base64 encoded [required] file,
}

Response status

HTTP Status Code Reason
200 Successfully saved
405 Invalid input
500 Internal server error

Example <base_url>/api/sacco_loan/file_upload

Payload

{
    "loanId": 0000,
    "fileName": "2323",
    "fileBaseSixFour": "iVBORw0KGgoAAAANSUhEUgAAAPsAAABSCAYAAACSYaKAAAAABHNCSVQICAgIfAhkiAAAABl0RVh0U29mdHdhcmUAZ25vbWUtc2NyZWVuc2hvdO8Dvz4AABNYSURBVHic7V17kFTVmf91z7One6bnCQTXTWQgjyoWfNSaFQRUItlEkywx6pYuYoFliC5ERVSIOJPlZcA14m6Bm0WsBV3FVRKziYm4koiBRLPKQ62UGRh3yw0w70d3T8+ru/ePnunpnr7n3PO+t3vmVzUFfc853/fd0+d3v+9859zTnv9ZeFkCAODxwAoewnVS/ZFCrsu28ohlNIF0mcT7YhTNUMGmjyTqqpKZSKjXySOTqa5NHbtimg5b/YRyUZnEIn55xPui6C8EoHigCcgSIrq4TFcRXbbvZdrT2oo+CEZlsrT3eBjqeUAlg12xx0MmBpN+znZCMm1ugksUWb+X3k7Eq5OE8TcRih5s2mknusfD1j+s9WhtdUQDqnQo7Qe574z6nWsYYyLiePXYjmMLUMnOD8VeXcgEGU8nWUGnNzdBcB26lfWJ7ENaRrcJefq/V6/KJwcRJr06VSTtSW3b2k44iwH883inCE6CiE08Xp5eQbhYfDy7wLsT1fNF3vyeXelDQPETUDR8N0V0VriN4CSIkF66jibCq3YujvMkGwrDeNJTRkSU2oEuF6UYJLpKknsY/5To4rDbBOGpol0QshOb6H1AWJJdaWKOwxiGRorl0UVKE91Iso7wZ6p9hiyF9ytDeBn7VQo1wBeeh5ciz+7wQ0BL+K6A6CwQ9QwqPbNqHaruXRPhxcN5hW3IwhTKyoTibPw4kOx2Q7ZSKrJXFNpzzXehn+AqdatKymldXTEgkBgly1kiojuL7EZCeBJMenW6UCF9TOWsddJNcYLgJIiQXraO8ZUZp707nw7Wca7As5t4cvEL0xK+myS620g+Hjz2OUl40XBeRKAyUXq+eL1hvBUcT/JRBUo0VUR0JSQnZd1UZuPGqbKtpzjisTREIVw9TsV0ezOv84bwJjrEpFenChUrGy1nJTo3VJBXgQxWwst4cA0rLkq9u4lEnUQor8ezK03MKZSlI3xXEtrT1ZMb6PQYAjpUeXkdm1+EOG1gvBp0+ubDeCso7FRXbJrgaStEctMQIL1tHc39yiUuT0J2G6TI7mgWngiFNol6dWozyZCTWa1bsnUcdsgSXstKiog4A1NYXvCG8iPXJTw7Z1hi4KGhPLuqZTDaq82s5AaSjwejXbKm6wjnieIM9DN3KK/WpkKl0kSg+cnpu3IRACB69E0l8gDIz9OZic4P0UFLPdGFrA22hy7YVfF46Ic92JXzgsFkaWGqbVYER+fshVOnIXj7nXyNOAdzQUUQ/mv/miRMmR7mdrZi+b25x+NJ/YlCXAaDvXYitfT1xJiH88ALiMzX1YTwvisXIXjr7Sic+imKiWwg34OQMPVlTLawG6uC4GplayS88t1uJFE5FMoLzNsd9ey+KxYAAKruumdciYknqeGsvSKi6yK4Gn0OeXhhhRp1uDAacIzs3rIylF58GQDAN28BSi+73L6R5N5gJhje1MFYwTjJxfWryFdYGiBWxq0md8jLC8fIXrb4yxmfq9esA7ymjsQTCf1Ew0xbwQyq3TPQtBNeOakVTu9yHF6n5uuBr34j43Ph9AtQ/s2bKYIMQGj+p4/oQt58dEsq7x+XCha7NBFeZRtl4OSQQ/N2Rzx78Wc/j+JZn8u6XnnbHSioqrZuxJ2QELWOXbekUBuVHDoFSSsrQ5rwIlA6ZSOpyM9Q3pF19vKlN1le9/h8CHxtKXr2Pa1Ru5ovrGTOxZjy6BNKZLFg4IOTaFt/X+ZFyuCr2/o4SmbP0WxVNj65/ppxVzwgLWxf+PNfabdnFAPvn0DrutVMdX3zFqC2YatlWfToEbQ1rpe2p3TupZjy+C7Lstb77kL/ifekdYyHcc/uDVbCf+1XiOWDH/3BoDVpyKWnuawXN45cshWIHnsLkdd/YVnmm79wZLqZe1BDdo75esUNf0sUE+vqRPTtY0xykpedTL44NIBziuQ5AEJ3dj/1JIZbzluWBZetQHH9LDZBLnIi1mTXtIXVG6wkhvAAEP75K1Ly7eGejudHrnnz8cgt2+PhMNoJ4bo3EED1uu8Ztkh+7BoN4ytuuhUen49YHvrJS6n/127cbMIkOlz0VGaGwyE+PWnn4n6zwOCZJvTs32tZVlw/C1V3fdewReyw+h6MJegKamqpXj304/9AvKcbAFB29bUoW3g1yuYvQp/KF1jyGeO+3KGPz2hW6L4XPXSgZ/9e+OYvRPGMmVll5UtvQvToEfSfPO6AZfwwRvaq1WvhKS62LEsMDqL3+X2pz8Fbbkv+u/Lb6Dt2xLIN/3xd7Zxq4P0T+OS6q+V0w8YTsnhoQp3uPdaZXmawvLVFqEP9meS07Pwn14/rP1ITkd9Dt7xOWBkgXR65j/aG9Zj21DPw+gNZdWobH8XZZTcgHg6TBbkE+sL4tEHo++J8lF15FbFq6OXnEevqTNb9q/ko+swMAEDRhZ9G2aLF2kwUgomtmax6dIbrkvrz6fSX4ZZz6Nr9pGWZNxBAzf0283eXTPvkyW63UarUh+p7HiCWxzo70JPu1ZffkVEeXL5SyjxjEPDqcvoMDCBtOty7hbWofha8gWwPHjn0KqLH3rJskyvLcRxkF/smqlevRUHdFGJ594/+GYloFABQduUiFM/8bEZ50Z/9OeV99NyFsFc3nYCz02fKuxuC1x8gbqjpeGwL53KcakiuhmXLU/cFlV31Jfi/fB2xfODDU4i88Vrqc3DFty3r+S6/gk2h7vl6zm7NFUPhlKkomT2H+Fc0oz5Z0cAWVmXfFUNUUTLnEstkcjwcRudjWyybO7McNwLG/teWoCucNh01azdQ63RsH1teC3zlayi68NOW9fqPv5vxOXc8BudmIFtx5u676KJ61G15zDIpNYqWe6wfzukgJ+vcncyqXLUa/aeOY+hMU4b9/SePo2f/XgSXrchqk1yOuwddu8xto6ZhfN9rS9DVbtxMXVPv/OGjGD77f0kjAuWoXPkdy3qJaBSRw4e02Og6GHpn2w5efwA1G75PJXrXzh0Yak5b3suZBzA7atZab6rp2b8Xg82nLcvKl96E0rmX6jRLGFrIXnX3vSj+3BeI5f3vvoPwqz8dq//398EbDFrWDf/yZ0j09yu3MadgmEh1Wx5D4ZSpxPLwfx7MmH7lK4rqZ6Fy1RrLsvaG9YhHwpZltY2PWib5nIZysvsuv4KamYx1dqB9W2NGff+4gyzSEXrlJWKZUSha13f7FKRqzToUXVRPLB/44BS6/5VvDZ98z5x96kDflS+9EaVzL8m6PtxyDj37rHfXJZfjHs686ILvXemc3VsRRM2DDdQ67ZseTu2U85aVoZoyr48cfh3DZ/+k0sQxSG6FLZw6LXnaDi/ZOe3pfWE/kz1EkO7HYh7tX7wE/sVLiKKGPm5Gx9aGpEyreTjpOgEVtywHcd7OO50n6O199hlOQdmobdiGs7d9a2TjzBhCBw+gdO4l8M1bkNVmdDkudPCAtH5VUEr2iluWw1tZSSzvfno3Bj44mfpceedqFFTXWFdOxBW9167niVowZRqCt96uRXY6hMlu99AaLR8hScnsuahas45YPd4XQefO7cTQVQTBW5Yrk0WCNdn5koNJT70BbY3Zjqljx2ZMf/Zly/xGcNlKDJx8D4Nnmjgs1gdlYbw3WInyr99ALO//77czBm7p3EsRuO4bxPqR/3otlcCbBCc4T7kpuqgeNRsaqdW6du4wsN/evfDNW2gZzsfDYbQ3PGTZJrkc97BlmROQI3vamCpfeiM8JSWW1WJdnWjfOhbeF1RWoWZ9I1FsYmgI3Xt2C9syocE5N/T6A6j+7jpq5r376d2I/u4omx7eswfcBEET+08eR+jHL1qWjS7HmbKFBmWenebV2//he4j39qQ+1zZsRUFNLbF+7/P7EOvsUGXaxIEAoWrWN1ATcn2HDyH804MyVk0IdO3a6frlOCVkL1u0GN6g9Vy959m9GHj/ROpz1d33omT2XKKs4bN/Qu+Lz6kwaxI2qFpzP/W7GPq4mT/CmsDo3L7Z1ctxShJ0vvkLLa8PNZ/OePm/7KovofxvbiQLSsTRvnkjEgMDxCpuCQeHmk+jdf29hFJSKEuqrudkIKL8RAL+a5bAfw058x7vi6Bj6yNKE3Lj0Zo6QJMnI8/zSqtZDJ5pQs++vaj6TvbavDcQQM26jWhreNABy5JQQvaSL8y2vN616wkgFgMAFM2YiRqbZEXvC89hsOkjFSZpRzwSzohYMsE5b1VxIg6HjKIZM1G15n6quLYNazHc2sKuXwBj/cdBdq73180jdPAAyuYvQMmc7GSeb/5ClN9wM0IvO7McJx3Ge4qLUTj9gqzrg00fof/E2J722o2biYdXAMDg6T+ie+9TsuZMwgaFU6aibtN2ap2uJyd25l0WbQ0PEiOi4LI7DLwdZw1pshfU1lleTz95pnLFKuJLLgAQD4eIh/tNQh28/gBqHmqgZt77Dh9C5I0J8i6CJsTDYXTssD5D0RsIoPqBjYYtGtEtK8BTmD0TGD5/Dn1HDgMACuqmjuyUIqN900bie8KTkERaeFu1ei19K+yHp9C5c4cJq/Ie0aNHqMtxlSLLcZKQJns8Esm61pf2ltroeXIkdO/Zhf73fi9rxiRszmmrXLkKvi/OI1aJtbWgYwt9q/Mk+NCzbw9xOc6JUF6e7KHerGv9776TFF7mh3/JV4lto+/8Fr0HnuXSRz7I0AG4yBQa/NcsQeD6pcTyeF8E7VsbtWbeuZEjfUtDPBxG5/ZNTpuRgjTZE4ODGD5/buxCLIb+kf3vZYuXwFNSatku1tmBjm2TnkQpLB6ERRfVI7hyFbVZ8t10aw80CTkMnmlC1+6dTpsBQJbsI2Mr/eWWgT98mFpuo63jdmxrzHqLKH9g7ZZMRyVefwB1m3dQE3K9L+y3/sktxSDfex64cBuEDh7AwCnOs+U1dIuSHXTR3/w69f/hs58AADwlJSj5i4st64deeSljWU4JcnnMqFw7HmnDQvTo28eSLydJ6GG+ngvQaHoHZXedKSjZVNP31q8RD/XCW16BeCgEILlxwwrxSBg9z/xIhVpG6PkGi2bMRNWddwu05NwVN1I9uXWV8dCIRALBFauomXcAiLWcR8XNf8dnjw16//3fmOtO2fY4vwLurzPZYLD5DLqfejLjmkkMt5xDx/ZNqPv+D4zrHoWy99l7n9+PyjvvBrwFQCKBwk9Nt6534DnHn3AAkh5IYuut1x8gRi56wG5r4OvfpB5CkV5PNXjIbrT/XLDNOnr0CCKHXqUmrXVC2VtvoZ+8iFhbK7wjh0x6Coss64Vf1f1LrZLIg/CUFro7AVetoDiMrl0/dGxPiTKyJwYG0PGPY6+uxsOhrDp9b76ROpJqEpOYUBh54MXDYbQ/Qv6FJJ1QeuBk/+9/lzogMt7dlVXe96vXCS0nn/yTyBfYj+Xk23Eqjlzjg/LTZaO//Q0AWB4U2X/yPT5hk+FfziNvQ3jJ++rZt4d/OY4T4/s+O0EnmbgaRay7C4NnmlLbAofPn01m6hXITiQS1q+LJkDIY6kfcEPNp9H6UNr77NxHSlOEWxTGI2Hm76bvjdcw8P5J23p8EPjZZBt5lucBUEVx5lPSLo8lhel1h5qb0LpuTXYBoPzgyLZHHkDxjOxts9x6GPtf6++zR4++mUb2cza1HQCJPAzXs95nV/nb7DRCMxB+uLVF7bvodoOJUG7n1S3PA+D9jXbFCdV4OJzhcXVGJvFwmD/alQBHGM9/vnf4Z6+kOj0xMFF/1UXhhhXWcpXQYkuehvaqQOweuX7T9ltvSCQQ62xP/U6bp5T8u295ASFOS4TGJggvYYOQR5xozwDT26d1K+j+l39CvK8PBeUVyQu8e6R1d4iR8FDwHljIpqN/WOQK6zWwNdepMePi8/EAA2SPdXag64kfoPCCCwGPOnVEz6EpBGKCau+erMAiRM2AYpVjU8e9Xp1vzOTbSoLWBN0oIocPoaC2DsX1MzF4+o8mVOqF0IoFcamAvLrAqy99cLLaxzugpYiuIX8xCWZYk13R8ls6el98Dt7ycqUyWRFrb6dX4M3KU2VB6ARoZYRPr68aOjw6IObV82BbsxJwrIR4/veqv7SurfNndrlliyxfEVvw6aARjFu3baH9ufhOvdAhTXRaMlJAJzfZFYbwKubsqqahHGTXPme3RC4lOJTPPyXvRVdSTqs+AaJTxblxPLhw7I6DM2R3I1Qe4GDfkCIywRYO6yY9o3x7ezWtRKhqM4GQv2RXmZV3ILvMPP9VTXoOedLZamNenTdkzk94yUtYubFWqXR5RLU3kQznue5tlKS85Bdsx2abYN847NX5OeEuDpHsF1h6I6SbSVloDZl9eQikzEXvg6rK3g7bLD25IX8bZtEaiU5XLNJIUJlGOLRHJC/CeP4NNlRhZtqMNWYQzziP1wx2OyRsNdX/Iln4HIdLyW4iLFIdsst4MvY5shODkU+vTT3R8N1pr84bwrsQgmTn9KROboBwy9IOE+HdRXp+kksQXRRu3ZrLO+Y1h/DACNkdS9IphNjgN+jdmdXxJclUE19MJstSoa1isTJhhVZqcme8cyesEwkze+PFQEoECiTKBPJxVD2iZcy28BtsuT3Spp/UDG4HiW7Kq+dBCA8A/w88SawjYN5OvgAAAABJRU5ErkJggg=="
}

Response

{
    "success": "true",
    "message": "successful"
}

LOAD: GET /api/sacco_loan/files?loanId={loanId}

Returns loan files in JSON format. loanId must be provided as path parameter.

Resource URL 

/api/sacco_loan/files?loanId={loanId}

Resource Properties

PROPERTY DESCRIPTION
Method GET
Response formats JSON
Requires authentication? Yes

URL Params

Always specify loanId param

PARAM TYPE REQUIRED/OPTIONAL DESCRIPTION
loanId number optional The ID of the loan

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_loan/files?loanId=40422

Response

{
    "count": 0,
    "list": [
        {
            "docName": "FVsF1682848332186",
            "notes": "File 1",
            "docType": "PDF",
            "numOfPages": 0,
            "rootFilePath": "/home/majoris/Servers/wildfly-13.0.0.Final/appfiles//uploads/fms/sacco/loan/",
            "rootFileName": "FVsF1682848332186",
            "viewPath": "/appfiles/uploads/fms/sacco/loan/FVsF1682848332186.pdf",
            "resize": false,
            "resizeWidth": 0,
            "resizeHeight": 0,
            "saccoLoanId": 9758213,
            "id": 13467381
        },
        {
            "docName": "NaEa1682849029037",
            "notes": "File 2",
            "docType": "PDF",
            "numOfPages": 0,
            "rootFilePath": "/home/majoris/Servers/wildfly-13.0.0.Final/appfiles//uploads/fms/sacco/loan/",
            "rootFileName": "NaEa1682849029037",
            "viewPath": "/appfiles/uploads/fms/sacco/loan/NaEa1682849029037.pdf",
            "resize": false,
            "resizeWidth": 0,
            "resizeHeight": 0,
            "saccoLoanId": 9758213,
            "id": 13467382
        }
    ]
}