Optional Fields |
| minRequiredOpeningBalance, lockinPeriodFrequency, lockinPeriodFrequencyType, withdrawalFeeForTransfers, paymentChannelToFundSourceMappings, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, allowOverdraft, overdraftLimit, minBalanceForInterestCalculation |
| minRequiredOpeningBalance, lockinPeriodFrequency, lockinPeriodFrequencyType, withdrawalFeeForTransfers, paymentChannelToFundSourceMappings, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, allowOverdraft, overdraftLimit, minBalanceForInterestCalculation,withHoldTax,taxGroupId |
Optional Fields |
| lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, charts |
| lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, charts, , withHoldTax, taxGroupId |
Optional Fields |
| lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, charts, minDepositAmount, maxDepositAmount |
| lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, charts, minDepositAmount, maxDepositAmount, withHoldTax, taxGroupId |
Inherited from Product (if not provided) |
| nominalAnnualInterestRate, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minRequiredOpeningBalance, lockinPeriodFrequency, lockinPeriodFrequencyType, withdrawalFeeForTransfers, allowOverdraft, overdraftLimit | +
| nominalAnnualInterestRate, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minRequiredOpeningBalance, lockinPeriodFrequency, lockinPeriodFrequencyType, withdrawalFeeForTransfers, allowOverdraft, overdraftLimit, withHoldTax |
Savings application's withhold tax can be modified when in 'Active' state. Once the application is activated, can modify the account withhold tax to post tax or vice-versa
+PUT https://Domain Name/api/v1/savingsaccounts/{accountsId}?command=updateWithHoldTax
+ PUT savingsaccounts/1?command=updateWithHoldTax
+Content-Type: application/json
+No Request Body:
+ {
+ "withHoldTax": false
+ }
+
+
+ {
+ "savingsId": 138,
+ "resourceId": 138,
+ "changes": {
+ "withHoldTax": false
+ }
+ }
+
+ Inherited from Product (if not provided) |
| interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, lockinPeriodFrequency, lockinPeriodFrequencyType, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, charts | +
| interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, lockinPeriodFrequency, lockinPeriodFrequencyType, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, charts, withHoldTax |
Inherited from Product (if not provided) |
| interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, lockinPeriodFrequency, lockinPeriodFrequencyType, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, charts | +
| interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, lockinPeriodFrequency, lockinPeriodFrequencyType, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, charts, withHoldTax |
This defines the Tax Components
+Field Descriptions |
+
| name | +
| Name of the Tax component + | +
| percentage | +
| + Percentage that should be applied on a amount as tax. + | +
| debitAccountType | +
| + Debit Account type that should be applicable only for particular cases depending on requirement ex with hold tax doesn't require debit account for the accounting operation. . + | +
| debitAcountId | +
| + GL Account that should debited when tax applied. used only for particular cases depending on requirement ex with hold tax doesn't require debit account for the accounting operation. . + | +
| + Credit Account type that should be applicable only for particular cases depending on requirement ex with hold tax require credit account for the accounting operation. . + | +
| debitAcountId | +
| + GL Account that should credited when tax applied. used only for particular cases depending on requirement ex with hold tax require only credit account for the accounting operation. . + | +
| startDate | +
| + Start date from which this tax component is applicable. + | +
Creates a new Tax Component
+Mandatory Fields |
+
| name | +
| percentage | +
Optional Fields |
+
| debitAccountType | +
| debitAcountId | +
| creditAccountType | +
| creditAcountId | +
| startDate | +
+ POST https://DomainName/api/v1/taxes/component
+
+
+ POST taxes/component
+ Content-Type: application/json
+ Request Body:
+ {
+ "name": "tax component 1",
+ "percentage": "10",
+ "creditAccountType": 2,
+ "creditAcountId": 4,
+ "locale": "en",
+ "dateFormat": "dd MMMM yyyy",
+ "startDate": "11 April 2016"
+ }
+
+
+ {
+ "resourceId": 1
+ }
+
+ List Tax Components/p> +
+ GET https://DomainName/api/v1/taxes/component
+
+
+ GET taxes/component
+ Content-Type: application/json
+
+
+ [{
+ "id": 1,
+ "name": "tax component 1",
+ "percentage": 10.000000,
+ "creditAccountType": {
+ "id": 2,
+ "code": "accountType.liability",
+ "value": "LIABILITY"
+ },
+ "creditAccount": {
+ "id": 4,
+ "name": "ACCOUNT_NAME_7BR9C",
+ "glCode": "LIABILITY_PA1460364665046"
+ },
+ "startDate": [2016,
+ 4,
+ 11],
+ "taxComponentHistories": [{
+
+ }]
+ },
+ {
+ "id": 2,
+ "name": "tax component 2",
+ "percentage": 10.000000,
+ "creditAccountType": {
+ "id": 2,
+ "code": "accountType.liability",
+ "value": "LIABILITY"
+ },
+ "creditAccount": {
+ "id": 4,
+ "name": "ACCOUNT_NAME_7BR9C",
+ "glCode": "LIABILITY_PA1460364665046"
+ },
+ "startDate": [2016,
+ 4,
+ 11],
+ "taxComponentHistories": [{
+
+ }]
+ }]
+
+ Retrieve Tax Component
+
+ GET https://DomainName/api/v1/taxes/component/1
+
+
+ GET taxes/component/1
+ Content-Type: application/json
+
+
+ {
+ "id": 1,
+ "name": "tax component 1",
+ "percentage": 10.000000,
+ "creditAccountType": {
+ "id": 2,
+ "code": "accountType.liability",
+ "value": "LIABILITY"
+ },
+ "creditAccount": {
+ "id": 4,
+ "name": "ACCOUNT_NAME_7BR9C",
+ "glCode": "LIABILITY_PA1460364665046"
+ },
+ "startDate": [2016,
+ 4,
+ 11],
+ "taxComponentHistories": [{
+
+ }]
+ }
+
+ Updates Tax component. Debit and credit account details cannot be modified. + All the future tax components would be replaced with the new percentage.
+
+ PUT https://DomainName/api/v1/taxes/component/1
+
+
+ PUT taxes/component/1
+ Content-Type: application/json
+ Request Body:
+ {
+ "name": "tax component 2",
+ "percentage": "15",
+ "locale": "en",
+ "dateFormat": "dd MMMM yyyy",
+ "startDate": "15 April 2016"
+ }
+
+
+ {
+ "resourceId": 1,
+ "changes": {
+ "percentage": 15,
+ "name": "tax component 2",
+ "startDate": [2016,
+ 4,
+ 15]
+ }
+ }
+
+ This defines the Tax Group
+Field Descriptions |
+
| name | +
| Name of the Tax Group + | +
| taxComponents | +
| + Array of tax components to be added part of tax group. + | +
| id | +
| + Tax group and tax component mapping id. + | +
| taxComponentId | +
| + Tax component id. + | +
| startDate | +
| + Start date from which this tax component is applicable. + | +
| endDate | +
| + End date from which this tax component is applicable. + | +
Creates a new Tax Group
+Mandatory Fields |
+
| name | +
| taxComponents | +
Mandatory Fields in taxComponents |
+
| taxComponentId | +
Optional Fields in taxComponents |
+
| id | +
| startDate | +
| endDate | +
+ POST https://DomainName/api/v1/taxes/group
+
+
+ POST taxes/component
+ Content-Type: application/json
+ Request Body:
+ {
+ "name": "tax group 1",
+ "locale": "en",
+ "taxComponents": [{
+ "taxComponentId": 7,
+ "startDate": "11 April 2016"
+ }],
+ "dateFormat": "dd MMMM yyyy"
+ }
+
+
+ {
+ "resourceId": 1
+ }
+
+ List Tax Group/p> +
+ GET https://DomainName/api/v1/taxes/group
+
+
+ GET taxes/group
+ Content-Type: application/json
+
+
+ [{
+ "id": 6,
+ "name": "Tax_component_Name_PAX65",
+ "taxAssociations": [{
+ "id": 6,
+ "taxComponent": {
+ "id": 6,
+ "name": "Tax_component_Name_FPNXE"
+ },
+ "startDate": [2013,
+ 1,
+ 1]
+ }]
+ },
+ {
+ "id": 7,
+ "name": "tax group 1",
+ "taxAssociations": [{
+ "id": 7,
+ "taxComponent": {
+ "id": 7,
+ "name": "tax component 2"
+ },
+ "startDate": [2016,
+ 4,
+ 11]
+ }]
+ }]
+
+ Retrieve Tax Group
+
+ GET https://DomainName/api/v1/taxes/group/1
+
+
+ GET taxes/group/1
+ Content-Type: application/json
+
+
+ {
+ "id": 7,
+ "name": "tax group 1",
+ "taxAssociations": [{
+ "id": 7,
+ "taxComponent": {
+ "id": 7,
+ "name": "tax component 2"
+ },
+ "startDate": [2016,
+ 4,
+ 11]
+ }]
+ }
+
+ Updates Tax Group. Only end date can be up-datable and can insert new tax components.
+
+ PUT https://DomainName/api/v1/taxes/group/1
+
+
+ PUT taxes/group/1
+ Content-Type: application/json
+ Request Body:
+ {
+ "name": "tax group 2",
+ "locale": "en",
+ "taxComponents": [{
+ "id": 7,
+ "taxComponentId": 7,
+ "endDate": "22 April 2016"
+ },
+ {
+ "taxComponentId": 6,
+ "startDate": "14 April 2016"
+ }],
+ "dateFormat": "dd MMMM yyyy"
+ }
+
+
+ {
+ "resourceId": 7,
+ "changes": {
+ "addComponents": [6],
+ "modifiedComponents": [{
+ "endDate": "Apr 22, 2016 12:00:00 AM",
+ "taxComponentId": 7
+ }],
+ "name": "tax group 2"
+ }
+ }
+
+