Corrected all Swagger documents found in the Accounting module by adding API description in anappropriate manner and the response.json file found in the swagger UI has been updated with the latest changes.

This commit is contained in:
Kang Breder
2019-11-24 23:08:59 -08:00
committed by Michael Vorburger ⛑️
parent 5ce86eaced
commit 2770f78cc4
9 changed files with 51784 additions and 8 deletions
Binary file not shown.
@@ -38,7 +38,11 @@ import org.springframework.stereotype.Component;
@Path("/runaccruals")
@Component
@Scope("singleton")
@Api(value = "Periodic Accrual Accounting", description = "Periodic Accrual is to accrue the loan income till the specific date or till batch job scheduled time.\n\n ")
@Api(tags = {"Periodic Accrual Accounting"})
@SwaggerDefinition(tags = {
@Tag(name = "Periodic Accrual Accounting", description = "Periodic Accrual is to accrue the loan income till the specific date or till batch job scheduled time.\n\n")
})
public class AccrualAccountingApiResource {
private final PortfolioCommandSourceWritePlatformService commandsSourceWritePlatformService;
@@ -55,7 +55,11 @@ import org.springframework.stereotype.Component;
@Path("/glclosures")
@Component
@Scope("singleton")
@Api(value = "Accounting Closure", description = "An accounting closure indicates that no more journal entries may be logged (or reversed) in the system, either manually or via the portfolio with an entry date prior to the defined closure date\n" + "\n" + "Field Descriptions\n" + "closingDate\n" + "The date for which the accounting closure is defined\n" + "officeId\n" + "The identifer of the branch for which accounting has been closed\n" + "comments\n" + "Description associated with an Accounting closure")
@Api(tags = {"Accounting Closure"})
@SwaggerDefinition(tags = {
@Tag(name = "Accounting Closure", description = "An accounting closure indicates that no more journal entries may be logged (or reversed) in the system, either manually or via the portfolio with an entry date prior to the defined closure date\\n\" + \"\\n\" + \"Field Descriptions\\n\" + \"closingDate\\n\" + \"The date for which the accounting closure is defined\\n\" + \"officeId\\n\" + \"The identifer of the branch for which accounting has been closed\\n\" + \"comments\\n\" + \"Description associated with an Accounting closure")
})
public class GLClosuresApiResource {
private static final Set<String> RESPONSE_DATA_PARAMETERS = new HashSet<>(Arrays.asList("id", "officeId", "officeName",
@@ -51,7 +51,11 @@ import org.springframework.stereotype.Component;
@Path("/financialactivityaccounts")
@Component
@Scope("singleton")
@Api(value = "Mapping Financial Activities to Accounts", description = "Organization Level Financial Activities like Asset and Liability Transfer can be mapped to GL Account. Integrated accounting takes these accounts into consideration when an Account transfer is made between a savings to loan/savings account and vice-versa\n" + "\n" +"\nField Descriptions\n" +"financialActivityId\n" +"The identifier of the Financial Activity\n" +"glAccountId\n" +"The identifier of a GL Account ( Ledger Account) which shall be used as the default account for the selected Financial Activity")
@Api(tags = {"Mapping Financial Activities to Accounts"})
@SwaggerDefinition(tags = {
@Tag(name = "Mapping Financial Activities to Accounts", description = "Organization Level Financial Activities like Asset and Liability Transfer can be mapped to GL Account. Integrated accounting takes these accounts into consideration when an Account transfer is made between a savings to loan/savings account and vice-versa\\n\" + \"\\n\" +\"\\nField Descriptions\\n\" +\"financialActivityId\\n\" +\"The identifier of the Financial Activity\\n\" +\"glAccountId\\n\" +\"The identifier of a GL Account ( Ledger Account) which shall be used as the default account for the selected Financial Activity")
})
public class FinancialActivityAccountsApiResource {
private final FinancialActivityAccountReadPlatformService financialActivityAccountReadPlatformService;
@@ -70,7 +70,11 @@ import org.springframework.stereotype.Component;
@Path("/glaccounts")
@Component
@Scope("singleton")
@Api(value = "General Ledger Account", description = "Ledger accounts represent an Individual account within an Organizations Chart Of Accounts(COA) and are assigned a name and unique number by which they can be identified. \n" + "All transactions relating to a company's assets, liabilities, owners' equity, revenue and expenses are recorded against these accounts")
@Api(tags = {"General Ledger Account"})
@SwaggerDefinition(tags = {
@Tag(name = "General Ledger Account", description = "Ledger accounts represent an Individual account within an Organizations Chart Of Accounts(COA) and are assigned a name and unique number by which they can be identified. \\n\" + \"All transactions relating to a company's assets, liabilities, owners' equity, revenue and expenses are recorded against these accounts")
})
public class GLAccountsApiResource {
private static final Set<String> RESPONSE_DATA_PARAMETERS = new HashSet<>(Arrays.asList("id", "name", "parentId", "glCode",
@@ -68,7 +68,11 @@ import org.springframework.stereotype.Component;
@Path("/journalentries")
@Component
@Scope("singleton")
@Api(value = "Journal Entries", description = "A journal entry refers to the logging of transactions against general ledger accounts. A journal entry may consist of several line items, each of which is either a \"debit\" or a \"credit\". The total amount of the debits must equal the total amount of the credits or the journal entry is said to be \"unbalanced\" \n" + "\n" + "A journal entry directly changes the account balances on the general ledger")
@Api(tags = {"Journal Entries"})
@SwaggerDefinition(tags = {
@Tag(name = "Journal Entries", description = "A journal entry refers to the logging of transactions against general ledger accounts. A journal entry may consist of several line items, each of which is either a \\\"debit\\\" or a \\\"credit\\\". The total amount of the debits must equal the total amount of the credits or the journal entry is said to be \\\"unbalanced\\\" \\n\" + \"\\n\" + \"A journal entry directly changes the account balances on the general ledger")
})
public class JournalEntriesApiResource {
private static final Set<String> RESPONSE_DATA_PARAMETERS = new HashSet<>(Arrays.asList("id", "officeId", "officeName",
@@ -56,7 +56,11 @@ import java.util.Set;
@Path("/provisioningentries")
@Component
@Scope("singleton")
@Api(value = "Provisioning Entries", description = "This defines the Provisioning Entries for all active loan products\n" + "\n" + "Field Descriptions\n" + "date\n" + "Date on which day provisioning entries should be created\n" + "createjournalentries\n" + "Boolean variable whether to add journal entries for generated provisioning entries\n")
@Api(tags = {"Provisioning Entries"})
@SwaggerDefinition(tags = {
@Tag(name = "Provisioning Entries", description = "This defines the Provisioning Entries for all active loan products\\n\" + \"\\n\" + \"Field Descriptions\\n\" + \"date\\n\" + \"Date on which day provisioning entries should be created\\n\" + \"createjournalentries\\n\" + \"Boolean variable whether to add journal entries for generated provisioning entries\\n")
})
public class ProvisioningEntriesApiResource {
private final PlatformSecurityContext platformSecurityContext;
@@ -67,7 +67,11 @@ import org.springframework.stereotype.Component;
@Path("/accountingrules")
@Component
@Scope("singleton")
@Api(value = "Accounting Rules", description = "It is typical scenario in MFI's that non accountants pass journal entries on a regular basis. For Ex: A branch office might deposit their entire cash at hand to their Bank account at the end of a working day. The branch office users might not understand enough of accounting to figure out which account needs to get credited and which account needs to be debited to represent this transaction.\n" + "\n" + "Enter accounting rules, an abstraction on top of manual Journal entires for enabling simpler data entry. An accounting rule can define any of the following abstractions\n" + "\n" + "A Simple journal entry where both the credit and debit account have been preselected\n" + "A Simple journal entry where either credit or debit accounts have been limited to a pre-selected list of accounts (Ex: Debit account should be one of \"Bank of America\" of \"JP Morgan\" and credit account should be \"Cash\")\n" + "A Compound journal entry where multiple debits and / or multiple credits may be made amongst a set of preselected list of accounts (Ex: Credit account should be either \"Bank Of America\" or \"Cash\" and debit account can be \"Employee Salary\" and/or \"Miscellenous Expenses\")\n" + "An accounting rule can also be optionally associated with a branch, so that only a particular Branch's users have access to the rule")
@Api(tags = {"Accounting Rules"})
@SwaggerDefinition(tags = {
@Tag(name = "Accounting Rules", description = "It is typical scenario in MFI's that non accountants pass journal entries on a regular basis. For Ex: A branch office might deposit their entire cash at hand to their Bank account at the end of a working day. The branch office users might not understand enough of accounting to figure out which account needs to get credited and which account needs to be debited to represent this transaction.\\n\" + \"\\n\" + \"Enter accounting rules, an abstraction on top of manual Journal entires for enabling simpler data entry. An accounting rule can define any of the following abstractions\\n\" + \"\\n\" + \"A Simple journal entry where both the credit and debit account have been preselected\\n\" + \"A Simple journal entry where either credit or debit accounts have been limited to a pre-selected list of accounts (Ex: Debit account should be one of \\\"Bank of America\\\" of \\\"JP Morgan\\\" and credit account should be \\\"Cash\\\")\\n\" + \"A Compound journal entry where multiple debits and / or multiple credits may be made amongst a set of preselected list of accounts (Ex: Credit account should be either \\\"Bank Of America\\\" or \\\"Cash\\\" and debit account can be \\\"Employee Salary\\\" and/or \\\"Miscellenous Expenses\\\")\\n\" + \"An accounting rule can also be optionally associated with a branch, so that only a particular Branch's users have access to the rule")
})
public class AccountingRuleApiResource {
private static final Set<String> RESPONSE_DATA_PARAMETERS = new HashSet<>(Arrays.asList("id", "officeId", "officeName",
File diff suppressed because one or more lines are too long