From 59ec8a566922339bf9a81c1cad51a78f2c1f1404 Mon Sep 17 00:00:00 2001 From: Keith Woodlock Date: Fri, 22 Mar 2013 01:14:10 +0000 Subject: [PATCH] MIFOSX-247: update api document for savings account transactions api. --- api-docs/apiLive.htm | 142 +++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 138 insertions(+), 4 deletions(-) diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index 063433ffb..8de48084e 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -7473,6 +7473,120 @@ No Request Body: "officeId": 1, "clientId": 1, "resourceId": 1 +} + + + + +   +
+
+

Savings Account Transactions:

+

Transactions possible on a savings account.

+ + + + + + + + +
Field Descriptions
transactionDate
The date of the transaction.
transactionAmount
The amount of the transaction.
+
+
+ + savingsaccounts_transactions_template +   +
+
+

Retrieve Savings Account Transaction Template:

+

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: +

    +
  • Field Defaults
    • +
  • Allowed Value Lists
    • +
+

+

Example Requests:

+
savingsaccounts/1/transactions/template
+
+
+
+ GET https://Domain Name/api/v1/savingsaccounts/{accountId}/transactions/template + + +{ + "accountId": 2, + "accountNo": "000000002", + "date": [ + 2013, + 3, + 22 + ], + "currency": { + "code": "USD", + "name": "US Dollar", + "decimalPlaces": 2, + "displaySymbol": "$", + "nameCode": "currency.USD", + "displayLabel": "US Dollar ($)" + } +} + +
+
+ + +   +
+
+

Deposit Transaction

+
+
+ POST https://Domain Name/api/v1/savingsaccounts/{accountsId}/transactions?command=deposit + POST savingsaccounts/1/transactions?command=deposit +Content-Type: application/json +No Request Body: +{ + "dateFormat": "dd MMMM yyyy", + "locale": "en", + "transactionDate": "02 March 2011", + "transactionAmount": "256.67" +} + + +{ + "officeId": 1, + "clientId": 1, + "savingsId": 1, + "resourceId": 1 +} + +
+
+ +   +
+
+

Withdrawal Transaction

+
+
+ POST https://Domain Name/api/v1/savingsaccounts/{accountsId}/transactions?command=withdrawal + POST savingsaccounts/1/transactions?command=withdrawal +Content-Type: application/json +No Request Body: +{ + "dateFormat": "dd MMMM yyyy", + "locale": "en", + "transactionDate": "02 March 2011", + "transactionAmount": "99.50" +} + + +{ + "officeId": 1, + "clientId": 1, + "savingsId": 1, + "resourceId": 2 }
@@ -11316,6 +11430,22 @@ Content-Type: application/json Update a Savings Account Delete a Savings Account + + Savings Transactions + savingsaccounts/{accountId}/transactions?command=deposit + Make a Deposit + + + + + + + savingsaccounts/{accountId}/transactions?command=withdrawal + Make a Withdrawal + + + + Office offices @@ -11677,15 +11807,15 @@ Content-Type: application/json clients/template Retrieve Client Template - + loanproducts/template Retrieve Loan Product Template - + loans/template?clientId={clientId} Retrieve Loan Template - + loans/{loanId}/transactions/template Retrieve Tranaction Template @@ -11693,10 +11823,14 @@ Content-Type: application/json savingproducts/template Retrieve Savings Product Template - + savingsaccounts/template?clientId={clientId} Retrieve Savings Account Template + + savingsaccounts/{accountId}/transactions/template + Retrieve Savings Account Transaction Template + offices/template Retrieve Office Template