diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index f03c3b2ef..8c30e26c5 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -730,20 +730,60 @@
Transactions possible on a recurring deposit account.
+Field Descriptions |
| transactionDate |
| The date of the transaction. |
| transactionAmount |
| The amount of the transaction. |
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: +
Example Requests:
+GET https://Domain Name/api/v1/recurringdepositaccounts/{accountId}/transactions/template?command=deposit
+
+
+{
+ "id": 1,
+ "transactionType": {
+ "id": 1,
+ "code": "savingsAccountTransactionType.deposit",
+ "value": "Deposit",
+ "deposit": true,
+ "withdrawal": false,
+ "interestPosting": false,
+ "feeDeduction": false,
+ "initiateTransfer": false,
+ "approveTransfer": false,
+ "withdrawTransfer": false,
+ "rejectTransfer": false,
+ "overdraftInterest": false,
+ "writtenoff": false,
+ "overdraftFee": true
+ },
+ "accountId": 1,
+ "accountNo": "000000001",
+ "date": [
+ 2014,
+ 6,
+ 25
+ ],
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 4,
+ "inMultiplesOf": 100,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "amount": 100000.000000,
+ "reversed": false,
+ "paymentTypeOptions": []
+}
+
+ Example Requests:
+GET https://Domain Name/api/v1/recurringdepositaccounts/{accountId}/transactions/{transactionId}
+
+
+{
+ "id": 1,
+ "transactionType": {
+ "id": 2,
+ "code": "savingsAccountTransactionType.withdrawal",
+ "value": "Withdrawal",
+ "deposit": false,
+ "withdrawal": true,
+ "interestPosting": false,
+ "feeDeduction": false
+ },
+ "accountId": 1,
+ "accountNo": "000000001",
+ "date": [
+ 2013,
+ 8,
+ 7
+ ],
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "inMultiplesOf": 0,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "paymentDetailData": {
+ "id": 62,
+ "paymentType": {
+ "id": 11,
+ "name": "cash"
+ },
+ "accountNumber": "",
+ "checkNumber": "",
+ "routingCode": "",
+ "receiptNumber": "",
+ "bankNumber": ""
+ },
+ "amount": 5000,
+ "runningBalance": 0,
+ "reversed": true
+}
+
+ POST https://Domain Name/api/v1/recurringdepositaccounts/{accountsId}/transactions?command=deposit
+ POST recurringdepositaccounts/1/transactions?command=deposit
+Content-Type: application/json
+No Request Body:
+{
+ "locale": "en",
+ "dateFormat": "dd MMMM yyyy",
+ "transactionDate": "27 May 2013",
+ "transactionAmount": "500",
+ "paymentTypeId": "14",
+ "accountNumber": "acc123",
+ "checkNumber": "che123",
+ "routingCode": "rou123",
+ "receiptNumber": "rec123",
+ "bankNumber": "ban123"
+}
+
+
+{
+ "officeId": 1,
+ "clientId": 2,
+ "savingsId": 1,
+ "resourceId": 47,
+ "changes": {
+ "accountNumber": "acc123",
+ "checkNumber": "che123",
+ "routingCode": "rou123",
+ "receiptNumber": "rec123",
+ "bankNumber": "ban123"
+ }
+}
+
+ POST https://Domain Name/api/v1/recurringdepositaccounts/{accountsId}/transactions?command=withdrawal
+ POST recurringdepositaccounts/1/transactions?command=withdrawal
+Content-Type: application/json
+No Request Body:
+{
+ "locale": "en",
+ "dateFormat": "dd MMMM yyyy",
+ "transactionDate": "27 May 2013",
+ "transactionAmount": "500",
+ "paymentTypeId": "14",
+ "accountNumber": "acc123",
+ "checkNumber": "che123",
+ "routingCode": "rou123",
+ "receiptNumber": "rec123",
+ "bankNumber": "ban123"
+}
+
+
+{
+ "officeId": 1,
+ "clientId": 2,
+ "savingsId": 1,
+ "resourceId": 48,
+ "changes": {
+ "accountNumber": "acc123",
+ "checkNumber": "che123",
+ "routingCode": "rou123",
+ "receiptNumber": "rec123",
+ "bankNumber": "ban123"
+ }
+}
+
+ This command modifies the given transaction.
+POST https://Domain Name/api/v1/recurringdepositaccounts/{accountsId}/transactions/{transactionId}?command=modify
+ POST recurringdepositaccounts/1/transactions/1?command=modify
+Content-Type: application/json
+No Request Body:
+{
+ "locale": "en",
+ "dateFormat": "dd MMMM yyyy",
+ "transactionDate": "27 May 2013",
+ "transactionAmount": "500",
+ "paymentTypeId": "14",
+ "accountNumber": "acc123",
+ "checkNumber": "che123",
+ "routingCode": "rou123",
+ "receiptNumber": "rec123",
+ "bankNumber": "ban123"
+}
+
+
+{
+ "officeId": 1,
+ "clientId": 2,
+ "savingsId": 1,
+ "resourceId": 48,
+ "changes": {
+ "accountNumber": "acc123",
+ "checkNumber": "che123",
+ "routingCode": "rou123",
+ "receiptNumber": "rec123",
+ "bankNumber": "ban123"
+ }
+}
+
+ This command reverses the given transaction.
+POST https://Domain Name/api/v1/recurringdepositaccounts/{accountsId}/transactions/{transactionId}?command=undo
+ POST recurringdepositaccounts/1/transactions/1?command=undo
+Content-Type: application/json
+No Request Body:
+{
+}
+
+
+{
+ "officeId": 1,
+ "clientId": 2,
+ "savingsId": 1,
+ "resourceId": 1
}
| + | |||||
| Fixed Deposit Product | +fixeddepositproducts | +Create a Fixed Deposit product | +List Fixed Deposit products | ++ | + |
| + | fixeddepositproducts/{productId} | ++ | Retrieve a Fixed Deposit product | +Update a Fixed Deposit product | +Delete a Fixed Deposit product | +
| Fixed Deposit Accounts | +fixeddepositaccounts | +Submit new fixed deposit application | +List fixed deposit application/accounts | ++ | + |
| + | fixeddepositaccounts/{accountId} | ++ | Retrieve a fixed deposit application/account | +Modify a fixed deposit application | +Delete a fixed deposit application | +
| + | fixeddepositaccounts/{accountId}?command=approve | +Approve a fixed deposit application | ++ | + | + |
| + | fixeddepositaccounts/{accountId}?command=undoApproval | +Undo fixed deposit application approval | ++ | + | + |
| + | fixeddepositaccounts/{accountId}?command=reject | +Reject a fixed deposit application | ++ | + | + |
| + | fixeddepositaccounts/{accountId}?command=withdraw | +Withdraw fixed deposit application | ++ | + | + |
| + | fixeddepositaccounts/{accountId}?command=activate | +Activate a fixed deposit account | ++ | + | + |
| + | fixeddepositaccounts/{accountId}?command=close | +Close a fixed deposit account | ++ | + | + |
| + | fixeddepositaccounts/{accountId}?command=prematureClose | +Premature Close a fixed deposit account | ++ | + | + |
| + | fixeddepositaccounts/{accountId}?command=calculatePrematureAmount | +Calculate Premature amount on a fixed deposit account | ++ | + | + |
| + | fixeddepositaccounts/{accountId}?command=calculateInterest | +Calculate interest on a fixed deposit account | ++ | + | + |
| + | fixeddepositaccounts/{accountId}?command=postInterest | +Post interest on a fixed deposit account | ++ | + | + |
| Recurring Deposit Product | +recurringdepositproducts | +Create a Recurring Deposit product | +List Recurring Deposit products | ++ | + |
| + | recurringdepositproducts/{productId} | ++ | Retrieve a Recurring Deposit product | +Update a Recurring Deposit product | +Delete a Recurring Deposit product | +
| Recurring Deposit Accounts | +recurringdepositaccounts | +Submit new recurring deposit application | +List recurring deposit application/accounts | ++ | + |
| + | recurringdepositaccounts/{accountId} | ++ | Retrieve a recurring deposit application/account | +Modify a recurring deposit application | +Delete a recurring deposit application | +
| + | recurringdepositaccounts/{accountId}?command=approve | +Approve a recurring deposit application | ++ | + | + |
| + | recurringdepositaccounts/{accountId}?command=undoApproval | +Undo recurring deposit application approval | ++ | + | + |
| + | recurringdepositaccounts/{accountId}?command=reject | +Reject a recurring deposit application | ++ | + | + |
| + | recurringdepositaccounts/{accountId}?command=withdraw | +Withdraw recurring deposit application | ++ | + | + |
| + | recurringdepositaccounts/{accountId}?command=activate | +Activate a recurring deposit account | ++ | + | + |
| + | recurringdepositaccounts/{accountId}?command=close | +Close a recurring deposit account | ++ | + | + |
| + | recurringdepositaccounts/{accountId}?command=prematureClose | +Premature Close a recurring deposit account | ++ | + | + |
| + | recurringdepositaccounts/{accountId}?command=calculatePrematureAmount | +Calculate Premature amount on a recurring deposit account | ++ | + | + |
| + | recurringdepositaccounts/{accountId}?command=calculateInterest | +Calculate interest on a recurring deposit account | ++ | + | + |
| + | recurringdepositaccounts/{accountId}?command=postInterest | +Post interest on a recurring deposit account | ++ | + | + |
| Recurring Deposit Transactions | +recurringdepositaccounts/{accountId}/transactions?command=deposit | +Make a deposit | ++ | + | + |
| + | recurringdepositaccounts/{accountId}/transactions?command=withdrawal | +Make a withdrawal | ++ | + | + |
| + | recurringdepositaccounts/{accountId}/transactions/{transactionId}?command=undo | +Undo transaction | ++ | + | + |
| + | recurringdepositaccounts/{accountId}/transactions/{transactionId}?command=modify | +Adjust transaction | ++ | + | + |
| + | recurringdepositaccounts/{accountId}/transactions/template | ++ | Retrieve Deposit account transaction template | ++ | + |
| + | recurringdepositaccounts/{accountId}/transactions/{transactionId} | ++ | Retrieve Deposit account transaction | ++ |