51749 lines
1.7 MiB
Plaintext
51749 lines
1.7 MiB
Plaintext
{
|
|
"swagger": "2.0",
|
|
"info": {
|
|
"description": "Apache Fineract is a secure, multi-tenanted microfinance platform. <br /> The goal of the Apache Fineract API is to empower developers to build apps on top of the Apache Fineract Platform. The reference app [ https://demo.openmf.org ] (username: mifos, password: password) works on the same demo tenant as the interactive links in this documentation. <br/>The API is organized around REST [ https://en.wikipedia.org/wiki/Representational_state_transfer ] <br/> Find out more about Apache Fineract on [ https://demo.openmf.org/api-docs/apiLive.htm#top ] <br/> You can Try The API From Your Browser itself at [ https://demo.openmf.org/api-docs/apiLive.htm#interact ] <br/> The Generic Options are available at [ https://demo.openmf.org/api-docs/apiLive.htm#genopts ] <br/> Find out more about Updating Dates and Numbers at [ https://demo.openmf.org/api-docs/apiLive.htm#dates_and_numbers ] <br/> For the Authentication and the Basic of HTTP and HTTPS refer [ https://demo.openmf.org/api-docs/apiLive.htm#authentication_overview ] <br/> Check about ERROR codes at [ https://demo.openmf.org/api-docs/apiLive.htm#errors ] <br/> <br/> Please refer to the old documentation for any documentation queries [ https://demo.openmf.org/api-docs/apiLive.htm ] <br/> ______________________________________________________________________________________________________________________________ ",
|
|
"version": "1.0.0",
|
|
"title": "Apache Fineract API Documentation",
|
|
"termsOfService": "https://demo.openmf.org/api-docs/apiLive.htm",
|
|
"contact": {
|
|
"name": "https://gitter.im/openMF/mifos"
|
|
}
|
|
},
|
|
"host": "https://demo.openmf.org",
|
|
"basePath": "/fineract-provider/api/v1",
|
|
"tags": [
|
|
{
|
|
"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"
|
|
},
|
|
{
|
|
"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"
|
|
},
|
|
{
|
|
"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"
|
|
},
|
|
{
|
|
"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"
|
|
},
|
|
{
|
|
"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"
|
|
},
|
|
{
|
|
"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"
|
|
},
|
|
{
|
|
"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"
|
|
},
|
|
{
|
|
"name": "Batch API",
|
|
"description": "The Apache Fineract Batch API enables a consumer to access significant amounts of data in a single call or to make changes to several objects at once. Batching allows a consumer to pass instructions for several operations in a single HTTP request. A consumer can also specify dependencies between related operations. Once all operations have been completed, a consolidated response will be passed back and the HTTP connection will be closed.\\n\" + \"\\n\" + \"The Batch API takes in an array of logical HTTP requests represented as JSON arrays - each request has a requestId (the id of a request used to specify the sequence and as a dependency between requests), a method (corresponding to HTTP method GET/PUT/POST/DELETE etc.), a relativeUrl (the portion of the URL after https://example.org/api/v2/), optional headers array (corresponding to HTTP headers), optional reference parameter if a request is dependent on another request and an optional body (for POST and PUT requests). The Batch API returns an array of logical HTTP responses represented as JSON arrays - each response has a requestId, a status code, an optional headers array and an optional body (which is a JSON encoded string).\\n\" + \"\\n\" + \"Batch API uses Json Path to handle dependent parameters. For example, if request '2' is referencing request '1' and in the \\\"body\\\" or in \\\"relativeUrl\\\" of request '2', there is a dependent parameter (which will look like \\\"$.parameter_name\\\"), then Batch API will internally substitute this dependent parameter from the response body of request '1'.\\n\" + \"\\n\" + \"Batch API is able to handle deeply nested dependent requests as well nested parameters. As shown in the example, requests are dependent on each other as, 1<--2<--6, i.e a nested dependency, where request '6' is not directly dependent on request '1' but still it is one of the nested child of request '1'. In the same way Batch API could handle a deeply nested dependent value, such as {..[..{..,$.parameter_name,..}..]}."
|
|
},
|
|
{
|
|
"name": "Audits"
|
|
},
|
|
{
|
|
"name": "Maker Checker (or 4-eye) functionality"
|
|
},
|
|
{
|
|
"name": "Account number format"
|
|
},
|
|
{
|
|
"name": "Cache"
|
|
},
|
|
{
|
|
"name": "SMS Campaigns"
|
|
},
|
|
{
|
|
"name": "Code Values"
|
|
},
|
|
{
|
|
"name": "Codes"
|
|
},
|
|
{
|
|
"name": "External Services"
|
|
},
|
|
{
|
|
"name": "Global Configuration"
|
|
},
|
|
{
|
|
"name": "CreditBureau Configuration"
|
|
},
|
|
{
|
|
"name": "Data Tables"
|
|
},
|
|
{
|
|
"name": "Entity-Datatable Checks"
|
|
},
|
|
{
|
|
"name": "Reports"
|
|
},
|
|
{
|
|
"name": "Run Reports"
|
|
},
|
|
{
|
|
"name": "Documents"
|
|
},
|
|
{
|
|
"name": "DomainNameapiv1{entity}{entityId}images"
|
|
},
|
|
{
|
|
"name": "DomainNameapiv1entitytoentitymapping"
|
|
},
|
|
{
|
|
"name": "Hooks"
|
|
},
|
|
{
|
|
"name": "Scheduler"
|
|
},
|
|
{
|
|
"name": "MIFOSX-BATCH JOBS"
|
|
},
|
|
{
|
|
"name": "Report Mailing Jobs"
|
|
},
|
|
{
|
|
"name": "List Report Mailing Job History"
|
|
},
|
|
{
|
|
"name": "Authentication HTTP Basic"
|
|
},
|
|
{
|
|
"name": "Fetch authenticated user details"
|
|
},
|
|
{
|
|
"name": "SMS"
|
|
},
|
|
{
|
|
"name": "Likelihood"
|
|
},
|
|
{
|
|
"name": "Poverty Line"
|
|
},
|
|
{
|
|
"name": "Survey"
|
|
},
|
|
{
|
|
"name": "Mix Report"
|
|
},
|
|
{
|
|
"name": "Mix Taxonomy"
|
|
},
|
|
{
|
|
"name": "Mix Mapping"
|
|
},
|
|
{
|
|
"name": "Holidays"
|
|
},
|
|
{
|
|
"name": "Currency"
|
|
},
|
|
{
|
|
"name": "officetransactions"
|
|
},
|
|
{
|
|
"name": "Offices"
|
|
},
|
|
{
|
|
"name": "Provisioning Category"
|
|
},
|
|
{
|
|
"name": "Provisioning Criteria"
|
|
},
|
|
{
|
|
"name": "Staff"
|
|
},
|
|
{
|
|
"name": "cashiers"
|
|
},
|
|
{
|
|
"name": "Teller Cash Management"
|
|
},
|
|
{
|
|
"name": "cashiersjournal"
|
|
},
|
|
{
|
|
"name": "Working days"
|
|
},
|
|
{
|
|
"name": "Account Transfers"
|
|
},
|
|
{
|
|
"name": "Standing Instructions"
|
|
},
|
|
{
|
|
"name": "Standing Instructions History"
|
|
},
|
|
{
|
|
"name": "Share Account"
|
|
},
|
|
{
|
|
"name": "Entity Field Configuration"
|
|
},
|
|
{
|
|
"name": "Charges"
|
|
},
|
|
{
|
|
"name": "Clients Address"
|
|
},
|
|
{
|
|
"name": "Client Charges"
|
|
},
|
|
{
|
|
"name": "Client Identifier"
|
|
},
|
|
{
|
|
"name": "Client Transaction"
|
|
},
|
|
{
|
|
"name": "Client"
|
|
},
|
|
{
|
|
"name": "Loan Collateral"
|
|
},
|
|
{
|
|
"name": "Collection Sheet"
|
|
},
|
|
{
|
|
"name": "Floating Rates"
|
|
},
|
|
{
|
|
"name": "Funds"
|
|
},
|
|
{
|
|
"name": "Centers"
|
|
},
|
|
{
|
|
"name": "Groups"
|
|
},
|
|
{
|
|
"name": "Interest Rate Slab (A.K.A interest bands)"
|
|
},
|
|
{
|
|
"name": "Interest Rate Chart"
|
|
},
|
|
{
|
|
"name": "Loan Charges"
|
|
},
|
|
{
|
|
"name": "Loan Rescheduling"
|
|
},
|
|
{
|
|
"name": "Loan Transactions"
|
|
},
|
|
{
|
|
"name": "Loans"
|
|
},
|
|
{
|
|
"name": "Loan Products"
|
|
},
|
|
{
|
|
"name": "Notes"
|
|
},
|
|
{
|
|
"name": "Payment Type"
|
|
},
|
|
{
|
|
"name": "Products"
|
|
},
|
|
{
|
|
"name": "Fixed Deposit Account"
|
|
},
|
|
{
|
|
"name": "Fixed Deposit Product"
|
|
},
|
|
{
|
|
"name": "Recurring Deposit Account Transactions"
|
|
},
|
|
{
|
|
"name": "Recurring Deposit Account"
|
|
},
|
|
{
|
|
"name": "Recurring Deposit Product"
|
|
},
|
|
{
|
|
"name": "Savings Charges"
|
|
},
|
|
{
|
|
"name": "Savings Account"
|
|
},
|
|
{
|
|
"name": "Savings Product"
|
|
},
|
|
{
|
|
"name": "Beneficiary Third Party Transfer"
|
|
},
|
|
{
|
|
"name": "Self Client"
|
|
},
|
|
{
|
|
"name": "Self Loans"
|
|
},
|
|
{
|
|
"name": "Self Savings Account"
|
|
},
|
|
{
|
|
"name": "Self Authentication"
|
|
},
|
|
{
|
|
"name": "Self User"
|
|
},
|
|
{
|
|
"name": "Self User Details"
|
|
},
|
|
{
|
|
"name": "Tax Components"
|
|
},
|
|
{
|
|
"name": "Tax Group"
|
|
},
|
|
{
|
|
"name": "SPM API - LookUp Table"
|
|
},
|
|
{
|
|
"name": "SPM - Scorecards"
|
|
},
|
|
{
|
|
"name": "SPM - Serveys"
|
|
},
|
|
{
|
|
"name": "User Generated Documents"
|
|
},
|
|
{
|
|
"name": "Password preferences"
|
|
},
|
|
{
|
|
"name": "Permissions"
|
|
},
|
|
{
|
|
"name": "Roles"
|
|
},
|
|
{
|
|
"name": "Users"
|
|
}
|
|
],
|
|
"schemes": [
|
|
"https"
|
|
],
|
|
"paths": {
|
|
"/runaccruals": {
|
|
"post": {
|
|
"tags": [
|
|
"Periodic Accrual Accounting"
|
|
],
|
|
"summary": "Executes Periodic Accrual Accounting",
|
|
"description": "Mandatory Fields\n\ntillDate\n",
|
|
"operationId": "executePeriodicAccrualAccounting",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Request Body\n\nField Descriptions: \ntillDate: \nwhich specifies periodic accruals should happen till the given Date",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/runaccrualsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/glclosures": {
|
|
"get": {
|
|
"tags": [
|
|
"Accounting Closure"
|
|
],
|
|
"summary": "List Accounting closures",
|
|
"description": "Example Requests:\n\nglclosures",
|
|
"operationId": "retrieveAllClosures",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"description": "officeId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetGLClosureResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Accounting Closure"
|
|
],
|
|
"summary": "Create an Accounting Closure",
|
|
"description": "Mandatory Fields\nofficeId,closingDate",
|
|
"operationId": "createGLClosure",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Request Body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostGLCLosuresRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostGlClosuresResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/glclosures/{glClosureId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Accounting Closure"
|
|
],
|
|
"summary": "Retrieve an Accounting Closure",
|
|
"description": "Example Requests:\n\nglclosures/1\n\n\n/glclosures/1?fields=officeName,closingDate",
|
|
"operationId": "retreiveClosure",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "glClosureId",
|
|
"in": "path",
|
|
"description": "glClosureId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetGLClosureResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Accounting Closure"
|
|
],
|
|
"summary": "Update an Accounting closure",
|
|
"description": "Once an accounting closure is created, only the comments associated with it may be edited",
|
|
"operationId": "updateGLClosure",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "glClosureId",
|
|
"in": "path",
|
|
"description": "glClosureId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Request body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutGlClosuresRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutGlClosuresResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Accounting Closure"
|
|
],
|
|
"summary": "Delete an accounting closure",
|
|
"description": "Note: Only the latest accounting closure associated with a branch may be deleted.",
|
|
"operationId": "deleteGLClosure",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "glClosureId",
|
|
"in": "path",
|
|
"description": "glclosureId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteGlClosuresResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/financialactivityaccounts/{mappingId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Mapping Financial Activities to Accounts"
|
|
],
|
|
"summary": "Retrieve a Financial Activity to Account Mapping\n",
|
|
"description": "Example Requests:\n\nfinancialactivityaccounts/1",
|
|
"operationId": "retreive",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "mappingId",
|
|
"in": "path",
|
|
"description": "mappingId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetFinancialActivityAccountsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Mapping Financial Activities to Accounts"
|
|
],
|
|
"summary": "Update a Financial Activity to Account Mapping",
|
|
"description": "the API updates the Ledger account linked to a Financial Activity \n",
|
|
"operationId": "updateGLAccount",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "mappingId",
|
|
"in": "path",
|
|
"description": "mappingId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Request body",
|
|
"required": false,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostFinancialActivityAccountsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutFinancialActivityAccountsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Mapping Financial Activities to Accounts"
|
|
],
|
|
"summary": "Delete a Financial Activity to Account Mapping",
|
|
"description": "",
|
|
"operationId": "deleteGLAccount",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "mappingId",
|
|
"in": "path",
|
|
"description": "mappingId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteFinancialActivityAccountsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/financialactivityaccounts": {
|
|
"get": {
|
|
"tags": [
|
|
"Mapping Financial Activities to Accounts"
|
|
],
|
|
"summary": "List Financial Activities to Accounts Mappings",
|
|
"description": "Example Requests:\n\nfinancialactivityaccounts",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetFinancialActivityAccountsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Mapping Financial Activities to Accounts"
|
|
],
|
|
"summary": "Create a new Financial Activity to Accounts Mapping",
|
|
"description": "Mandatory Fields\nfinancialActivityId, glAccountId",
|
|
"operationId": "createGLAccount",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Request body",
|
|
"required": false,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostFinancialActivityAccountsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostFinancialActivityAccountsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/financialactivityaccounts/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Mapping Financial Activities to Accounts"
|
|
],
|
|
"operationId": "retrieveTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/glaccounts/template": {
|
|
"get": {
|
|
"tags": [
|
|
"General Ledger Account"
|
|
],
|
|
"summary": "Retrieve GL Accounts Template",
|
|
"description": "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:\n\nField Defaults\nAllowed Value Lists\nExample Request:\n\nglaccounts/template\nglaccounts/template?type=1\n\ntype is optional and integer value from 1 to 5.\n\n1.Assets \n2.Liabilities \n3.Equity \n4.Income \n5.Expenses",
|
|
"operationId": "retrieveNewAccountDetails",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "type",
|
|
"in": "query",
|
|
"description": "type",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetGLAccountsTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/glaccounts": {
|
|
"get": {
|
|
"tags": [
|
|
"General Ledger Account"
|
|
],
|
|
"summary": "List General Ledger Accounts",
|
|
"description": "ARGUMENTS\ntype Integer optional manualEntriesAllowed boolean optional usage Integer optional disabled boolean optional parentId Long optional tagId Long optional\nExample Requests:\n\nglaccounts\n\n\nglaccounts?type=1&manualEntriesAllowed=true&usage=1&disabled=false\n\nglaccounts?fetchRunningBalance=true",
|
|
"operationId": "retrieveAllAccounts",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "type",
|
|
"in": "query",
|
|
"description": "type",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "searchParam",
|
|
"in": "query",
|
|
"description": "searchParam",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "usage",
|
|
"in": "query",
|
|
"description": "usage",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "manualEntriesAllowed",
|
|
"in": "query",
|
|
"description": "manualEntriesAllowed",
|
|
"required": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"name": "disabled",
|
|
"in": "query",
|
|
"description": "disabled",
|
|
"required": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"name": "fetchRunningBalance",
|
|
"in": "query",
|
|
"description": "fetchRunningBalance",
|
|
"required": false,
|
|
"type": "boolean"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetGLAccountsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"General Ledger Account"
|
|
],
|
|
"summary": "Create a General Ledger Account",
|
|
"description": "Note: You may optionally create Hierarchical Chart of Accounts by using the \"parentId\" property of an Account\nMandatory Fields: \nname, glCode, type, usage and manualEntriesAllowed",
|
|
"operationId": "createGLAccount",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostGLAccountsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostGLAccountsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/glaccounts/{glAccountId}": {
|
|
"get": {
|
|
"tags": [
|
|
"General Ledger Account"
|
|
],
|
|
"summary": "Retrieve a General Ledger Account",
|
|
"description": "Example Requests:\n\nglaccounts/1\n\n\nglaccounts/1?template=true\n\n\nglaccounts/1?fields=name,glCode\n\n\nglaccounts/1?fetchRunningBalance=true",
|
|
"operationId": "retreiveAccount",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "glAccountId",
|
|
"in": "path",
|
|
"description": "glAccountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "fetchRunningBalance",
|
|
"in": "query",
|
|
"description": "fetchRunningBalance",
|
|
"required": false,
|
|
"type": "boolean"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetGLAccountsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"General Ledger Account"
|
|
],
|
|
"summary": "Update an Accounting closure",
|
|
"description": "Once an accounting closure is created, only the comments associated with it may be edited\n\n",
|
|
"operationId": "updateGLAccount",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "glAccountId",
|
|
"in": "path",
|
|
"description": "glAccountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutGLAccountsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutGLAccountsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"General Ledger Account"
|
|
],
|
|
"summary": "Delete an accounting closure",
|
|
"description": "Note: Only the latest accounting closure associated with a branch may be deleted.",
|
|
"operationId": "deleteGLAccount",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "glAccountId",
|
|
"in": "path",
|
|
"description": "glAccountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteGLAccountsRequest"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/glaccounts/downloadtemplate": {
|
|
"get": {
|
|
"tags": [
|
|
"General Ledger Account"
|
|
],
|
|
"operationId": "getGlAccountsTemplate",
|
|
"produces": [
|
|
"application/vnd.ms-excel"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"default": {
|
|
"description": "successful operation"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/glaccounts/uploadtemplate": {
|
|
"post": {
|
|
"tags": [
|
|
"General Ledger Account"
|
|
],
|
|
"operationId": "postGlAccountsTemplate",
|
|
"consumes": [
|
|
"multipart/form-data"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "file",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "file"
|
|
},
|
|
{
|
|
"name": "locale",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/journalentries/{journalEntryId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Journal Entries"
|
|
],
|
|
"summary": "Retrieve a single Entry",
|
|
"description": "Example Requests:\n\njournalentries/1\n\n\n\njournalentries/1?fields=officeName,glAccountId,entryType,amount\n\njournalentries/1?runningBalance=true\n\njournalentries/1?transactionDetails=true",
|
|
"operationId": "retreiveJournalEntryById",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "journalEntryId",
|
|
"in": "path",
|
|
"description": "journalEntryId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "runningBalance",
|
|
"in": "query",
|
|
"description": "runningBalance",
|
|
"required": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"name": "transactionDetails",
|
|
"in": "query",
|
|
"description": "transactionDetails",
|
|
"required": false,
|
|
"type": "boolean"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/JournalEntryData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/journalentries": {
|
|
"get": {
|
|
"tags": [
|
|
"Journal Entries"
|
|
],
|
|
"summary": "List Journal Entries",
|
|
"description": "The list capability of journal entries can support pagination and sorting.\n\nExample Requests:\n\njournalentries\n\njournalentries?transactionId=PB37X8Y21EQUY4S\n\njournalentries?officeId=1&manualEntriesOnly=true&fromDate=1 July 2013&toDate=15 July 2013&dateFormat=dd MMMM yyyy&locale=en\n\njournalentries?fields=officeName,glAccountName,transactionDate\n\njournalentries?offset=10&limit=50\n\njournalentries?orderBy=transactionId&sortOrder=DESC\n\njournalentries?runningBalance=true\n\njournalentries?transactionDetails=true\n\njournalentries?loanId=12\n\njournalentries?savingsId=24",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"description": "officeId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "glAccountId",
|
|
"in": "query",
|
|
"description": "glAccountId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "manualEntriesOnly",
|
|
"in": "query",
|
|
"description": "manualEntriesOnly",
|
|
"required": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"name": "fromDate",
|
|
"in": "query",
|
|
"description": "fromDate",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "toDate",
|
|
"in": "query",
|
|
"description": "toDate",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "transactionId",
|
|
"in": "query",
|
|
"description": "transactionId",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "entityType",
|
|
"in": "query",
|
|
"description": "entityType",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"description": "orderBy",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "sortOrder",
|
|
"in": "query",
|
|
"description": "sortOrder",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "locale",
|
|
"in": "query",
|
|
"description": "locale",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "query",
|
|
"description": "dateFormat",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "loanId",
|
|
"in": "query",
|
|
"description": "loanId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "savingsId",
|
|
"in": "query",
|
|
"description": "savingsId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "runningBalance",
|
|
"in": "query",
|
|
"description": "runningBalance",
|
|
"required": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"name": "transactionDetails",
|
|
"in": "query",
|
|
"description": "transactionDetails",
|
|
"required": false,
|
|
"type": "boolean"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/JournalEntryData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Journal Entries"
|
|
],
|
|
"summary": "Create \"Balanced\" Journal Entries",
|
|
"description": "Note: A Balanced (simple) Journal entry would have atleast one \"Debit\" and one \"Credit\" entry whose amounts are equal \nCompound Journal entries may have \"n\" debits and \"m\" credits where both \"m\" and \"n\" are greater than 0 and the net sum or all debits and credits are equal \n\n\nMandatory Fields\nofficeId, transactionDate\n\n\ncredits- glAccountId, amount, comments\n\n \ndebits- glAccountId, amount, comments\n\n \nOptional Fields\npaymentTypeId, accountNumber, checkNumber, routingCode, receiptNumber, bankNumber",
|
|
"operationId": "createGLJournalEntry",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"$ref": "#/definitions/JournalEntryCommand"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostJournalEntriesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/journalentries/{transactionId}": {
|
|
"post": {
|
|
"tags": [
|
|
"Journal Entries"
|
|
],
|
|
"summary": "Update Running balances for Journal Entries",
|
|
"description": "This API calculates the running balances for office. If office ID not provided this API calculates running balances for all offices. \nMandatory Fields\nofficeId",
|
|
"operationId": "createReversalJournalEntry",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "transactionId",
|
|
"in": "path",
|
|
"description": "transactionId",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostJournalEntriesTransactionIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostJournalEntriesTransactionIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/journalentries/provisioning": {
|
|
"get": {
|
|
"tags": [
|
|
"Journal Entries"
|
|
],
|
|
"operationId": "retrieveJournalEntries",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "entryId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/journalentries/openingbalance": {
|
|
"get": {
|
|
"tags": [
|
|
"Journal Entries"
|
|
],
|
|
"operationId": "retrieveOpeningBalance",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "currencyCode",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/journalentries/downloadtemplate": {
|
|
"get": {
|
|
"tags": [
|
|
"Journal Entries"
|
|
],
|
|
"operationId": "getJournalEntriesTemplate",
|
|
"produces": [
|
|
"application/vnd.ms-excel"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"default": {
|
|
"description": "successful operation"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/journalentries/uploadtemplate": {
|
|
"post": {
|
|
"tags": [
|
|
"Journal Entries"
|
|
],
|
|
"operationId": "postJournalEntriesTemplate",
|
|
"consumes": [
|
|
"multipart/form-data"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "file",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "file"
|
|
},
|
|
{
|
|
"name": "locale",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/provisioningentries/entries": {
|
|
"get": {
|
|
"tags": [
|
|
"Provisioning Entries"
|
|
],
|
|
"operationId": "retrieveProviioningEntries",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "entryId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "productId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "categoryId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/LoanProductProvisioningEntryData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/provisioningentries": {
|
|
"get": {
|
|
"tags": [
|
|
"Provisioning Entries"
|
|
],
|
|
"summary": "List all Provisioning Entries",
|
|
"description": "",
|
|
"operationId": "retrieveAllProvisioningEntries",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/ProvisioningEntryData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Provisioning Entries"
|
|
],
|
|
"summary": "Create new Provisioning Entries",
|
|
"description": "Creates a new Provisioning Entries\n\nMandatory Fields\ndate\ndateFormat\nlocale\nOptional Fields\ncreatejournalentries",
|
|
"operationId": "createProvisioningEntries",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostProvisioningEntriesRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostProvisioningEntriesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/provisioningentries/{entryId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Provisioning Entries"
|
|
],
|
|
"summary": "Retrieves a Provisioning Entry",
|
|
"description": "Returns the details of a generated Provisioning Entry.",
|
|
"operationId": "retrieveProvisioningEntry",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "entryId",
|
|
"in": "path",
|
|
"description": "entryId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/ProvisioningEntryData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Provisioning Entries"
|
|
],
|
|
"summary": "Recreates Provisioning Entry",
|
|
"description": "Recreates Provisioning Entry | createjournalentry.",
|
|
"operationId": "modifyProvisioningEntry",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "entryId",
|
|
"in": "path",
|
|
"description": "entryId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command=createjournalentry\ncommand=recreateprovisioningentry",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutProvisioningEntriesRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutProvisioningEntriesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/accountingrules": {
|
|
"get": {
|
|
"tags": [
|
|
"Accounting Rules"
|
|
],
|
|
"summary": "Retrieve Accounting Rules",
|
|
"description": "Returns the list of defined accounting rules.\n\nExample Requests:\n\naccountingrules",
|
|
"operationId": "retrieveAllAccountingRules",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetAccountRulesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Accounting Rules"
|
|
],
|
|
"summary": "Create/Define a Accounting rule",
|
|
"description": "Define a new Accounting rule.\n\nMandatory Fields\nname, officeId,\naccountToDebit OR debitTags,\naccountToCredit OR creditTags.\n\nOptional Fields\ndescription",
|
|
"operationId": "createAccountingRule",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostAccountingRulesRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostAccountingRulesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/accountingrules/{accountingRuleId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Accounting Rules"
|
|
],
|
|
"summary": "Retrieve a Accounting rule",
|
|
"description": "Returns the details of a defined Accounting rule.\n\nExample Requests:\n\naccountingrules/1",
|
|
"operationId": "retreiveAccountingRule",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountingRuleId",
|
|
"in": "path",
|
|
"description": "accountingRuleId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/AccountingRuleData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Accounting Rules"
|
|
],
|
|
"summary": "Update a Accounting Rule",
|
|
"description": "Updates the details of a Accounting rule.",
|
|
"operationId": "updateAccountingRule",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountingRuleId",
|
|
"in": "path",
|
|
"description": "accountingRuleId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutAccountingRulesRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutAccountingRulesResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Accounting Rules"
|
|
],
|
|
"summary": "Delete a Accounting Rule",
|
|
"description": "Deletes a Accounting rule.",
|
|
"operationId": "deleteAccountingRule",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountingRuleId",
|
|
"in": "path",
|
|
"description": "accountingRuleId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteAccountingRulesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/accountingrules/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Accounting Rules"
|
|
],
|
|
"summary": "Retrieve Accounting Rule Details Template",
|
|
"description": "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:\n\nField Defaults\nAllowed Value Lists\nExample Request:\n\naccountingrules/template",
|
|
"operationId": "retrieveTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetAccountRulesTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/batches": {
|
|
"post": {
|
|
"tags": [
|
|
"Batch API"
|
|
],
|
|
"summary": "Batch requests in a single transaction",
|
|
"description": "The Apache Fineract Batch API is also capable of executing all the requests in a single transaction, by setting a Query Parameter, \"enclosingTransaction=true\". So, if one or more of the requests in a batch returns an erroneous response all of the Data base transactions made by other successful requests will be rolled back.\n\nIf there has been a rollback in a transaction then a single response will be provided, with a '400' status code and a body consisting of the error details of the first failed request.",
|
|
"operationId": "handleBatchRequests",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "enclosingTransaction",
|
|
"in": "query",
|
|
"description": "enclosingTransaction",
|
|
"required": false,
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "request body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostBatchesRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success",
|
|
"schema": {
|
|
"$ref": "#/definitions/BatchResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/audits": {
|
|
"get": {
|
|
"tags": [
|
|
"Audits"
|
|
],
|
|
"summary": "List Audits",
|
|
"description": "Get a 200 list of audits that match the criteria supplied and sorted by audit id in descending order, and are within the requestors' data scope. Also it supports pagination and sorting\n\nExample Requests:\n\naudits\n\naudits?fields=madeOnDate,maker,processingResult\n\naudits?makerDateTimeFrom=2013-03-25 08:00:00&makerDateTimeTo=2013-04-04 18:00:00\n\naudits?officeId=1\n\naudits?officeId=1&includeJson=true",
|
|
"operationId": "retrieveAuditEntries",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "actionName",
|
|
"in": "query",
|
|
"description": "actionName",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "entityName",
|
|
"in": "query",
|
|
"description": "entityName",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "resourceId",
|
|
"in": "query",
|
|
"description": "resourceId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "makerId",
|
|
"in": "query",
|
|
"description": "makerId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "makerDateTimeFrom",
|
|
"in": "query",
|
|
"description": "makerDateTimeFrom",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "makerDateTimeTo",
|
|
"in": "query",
|
|
"description": "makerDateTimeTo",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "checkerId",
|
|
"in": "query",
|
|
"description": "checkerId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "checkerDateTimeFrom",
|
|
"in": "query",
|
|
"description": "checkerDateTimeFrom",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "checkerDateTimeTo",
|
|
"in": "query",
|
|
"description": "checkerDateTimeTo",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "processingResult",
|
|
"in": "query",
|
|
"description": "processingResult",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"description": "officeId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "groupId",
|
|
"in": "query",
|
|
"description": "groupId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "clientId",
|
|
"in": "query",
|
|
"description": "clientId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "loanid",
|
|
"in": "query",
|
|
"description": "loanid",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "savingsAccountId",
|
|
"in": "query",
|
|
"description": "savingsAccountId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "paged",
|
|
"in": "query",
|
|
"description": "paged",
|
|
"required": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"description": "orderBy",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "sortOrder",
|
|
"in": "query",
|
|
"description": "sortOrder",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetMakerCheckerResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/audits/{auditId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Audits"
|
|
],
|
|
"summary": "Retrieve an Audit Entry",
|
|
"description": "Example Requests:\n\naudits/20\naudits/20?fields=madeOnDate,maker,processingResult",
|
|
"operationId": "retrieveAuditEntry",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "auditId",
|
|
"in": "path",
|
|
"description": "auditId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetMakerCheckerResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/audits/searchtemplate": {
|
|
"get": {
|
|
"tags": [
|
|
"Audits"
|
|
],
|
|
"summary": "Audit Search Template",
|
|
"description": "This is a convenience resource. It can be useful when building an Audit Search UI. \"appUsers\" are data scoped to the office/branch the requestor is associated with.\n\nExample Requests:\n\naudits/searchtemplate\naudits/searchtemplate?fields=actionNames",
|
|
"operationId": "retrieveAuditSearchTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetMakerCheckersSearchTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/makercheckers": {
|
|
"get": {
|
|
"tags": [
|
|
"Maker Checker (or 4-eye) functionality"
|
|
],
|
|
"summary": "List Maker Checker Entries",
|
|
"description": "Get a list of entries that can be checked by the requestor that match the criteria supplied.\n\nExample Requests:\n\nmakercheckers\n\nmakercheckers?fields=madeOnDate,maker,processingResult\n\nmakercheckers?makerDateTimeFrom=2013-03-25 08:00:00&makerDateTimeTo=2013-04-04 18:00:00\n\nmakercheckers?officeId=1\n\nmakercheckers?officeId=1&includeJson=true",
|
|
"operationId": "retrieveCommands",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "actionName",
|
|
"in": "query",
|
|
"description": "actionName",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "entityName",
|
|
"in": "query",
|
|
"description": "entityName",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "resourceId",
|
|
"in": "query",
|
|
"description": "resourceId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "makerId",
|
|
"in": "query",
|
|
"description": "makerId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "makerDateTimeFrom",
|
|
"in": "query",
|
|
"description": "makerDateTimeFrom",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "makerDateTimeTo",
|
|
"in": "query",
|
|
"description": "makerDateTimeTo",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"description": "officeId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "groupId",
|
|
"in": "query",
|
|
"description": "groupId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "clientId",
|
|
"in": "query",
|
|
"description": "clientId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "loanid",
|
|
"in": "query",
|
|
"description": "loanid",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "savingsAccountId",
|
|
"in": "query",
|
|
"description": "savingsAccountId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetMakerCheckerResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/makercheckers/{auditId}": {
|
|
"post": {
|
|
"tags": [
|
|
"Maker Checker (or 4-eye) functionality"
|
|
],
|
|
"summary": "Approve Maker Checker Entry | Reject Maker Checker Entry",
|
|
"description": "",
|
|
"operationId": "approveMakerCheckerEntry",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "auditId",
|
|
"in": "path",
|
|
"description": "auditId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostMakerCheckersResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Maker Checker (or 4-eye) functionality"
|
|
],
|
|
"summary": "Delete Maker Checker Entry",
|
|
"description": "",
|
|
"operationId": "deleteMakerCheckerEntry",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "auditId",
|
|
"in": "path",
|
|
"description": "auditId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostMakerCheckersResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/makercheckers/searchtemplate": {
|
|
"get": {
|
|
"tags": [
|
|
"Maker Checker (or 4-eye) functionality"
|
|
],
|
|
"summary": "Maker Checker Search Template",
|
|
"description": "This is a convenience resource. It can be useful when building a Checker Inbox UI. \"appUsers\" are data scoped to the office/branch the requestor is associated with. \"actionNames\" and \"entityNames\" returned are those that the requestor has Checker approval permissions for.\n\nExample Requests:\n\nmakercheckers/searchtemplate\nmakercheckers/searchtemplate?fields=entityNames",
|
|
"operationId": "retrieveAuditSearchTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetMakerCheckersSearchTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/accountnumberformats/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Account number format"
|
|
],
|
|
"summary": "Retrieve Account number format Template",
|
|
"description": "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:\n\nField Defaults\nAllowed Value Lists\n\nExample Request:\n\naccountnumberformats/template",
|
|
"operationId": "retrieveTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetAccountNumberFormatsResponseTemplate"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/accountnumberformats": {
|
|
"get": {
|
|
"tags": [
|
|
"Account number format"
|
|
],
|
|
"summary": "List Account number formats",
|
|
"description": "Example Requests:\n\naccountnumberformats\n\n\naccountnumberformats?fields=accountType,prefixType",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetAccountNumberFormatsIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Account number format"
|
|
],
|
|
"summary": "Create an Account number format",
|
|
"description": "Note: You may associate a single Account number format for a given account type\nMandatory Fields for Account number formats\naccountType",
|
|
"operationId": "create",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostAccountNumberFormatsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostAccountNumberFormatsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/accountnumberformats/{accountNumberFormatId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Account number format"
|
|
],
|
|
"summary": "Retrieve an Account number format",
|
|
"description": "Example Requests:\n\naccountnumberformats/1\n\n\naccountnumberformats/1?template=true\n\n\naccountnumberformats/1?fields=accountType,prefixType",
|
|
"operationId": "retrieveOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountNumberFormatId",
|
|
"in": "path",
|
|
"description": "accountNumberFormatId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetAccountNumberFormatsIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Account number format"
|
|
],
|
|
"summary": "Update an Account number format",
|
|
"description": "",
|
|
"operationId": "update",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountNumberFormatId",
|
|
"in": "path",
|
|
"description": "accountNumberFormatId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutAccountNumberFormatsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutAccountNumberFormatsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Account number format"
|
|
],
|
|
"summary": "Delete an Account number format",
|
|
"description": "Note: Account numbers created while this format was active would remain unchanged.",
|
|
"operationId": "delete",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountNumberFormatId",
|
|
"in": "path",
|
|
"description": "accountNumberFormatId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteAccountNumberFormatsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/caches": {
|
|
"get": {
|
|
"tags": [
|
|
"Cache"
|
|
],
|
|
"summary": "Retrieve Cache Types",
|
|
"description": "Returns the list of caches.\n\nExample Requests:\n\ncaches",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetCachesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Cache"
|
|
],
|
|
"summary": "Switch Cache",
|
|
"description": "Switches the cache to chosen one.",
|
|
"operationId": "switchCache",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutCachesRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutCachesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/smscampaigns/{resourceId}": {
|
|
"get": {
|
|
"tags": [
|
|
"SMS Campaigns"
|
|
],
|
|
"summary": "Retrieve a SMS Campaign",
|
|
"description": "Example Requests:\n\nsmscampaigns/1\n",
|
|
"operationId": "retrieveCampaign",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "resourceId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/smscampaigns": {
|
|
"get": {
|
|
"tags": [
|
|
"SMS Campaigns"
|
|
],
|
|
"summary": "List SMS Campaigns",
|
|
"description": "Example Requests:\n\nsmscampaigns",
|
|
"operationId": "retrieveAllEmails",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "sqlSearch",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "sortOrder",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"SMS Campaigns"
|
|
],
|
|
"summary": "Create a SMS Campaign",
|
|
"description": "Mandatory Fields\ncampaignName, campaignType, triggerType, providerId, runReportId, message\n\nMandatory Fields for Cash based on selected report id\nparamValue in json format",
|
|
"operationId": "createCampaign",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/CommandWrapper"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/smscampaigns/{campaignId}": {
|
|
"post": {
|
|
"tags": [
|
|
"SMS Campaigns"
|
|
],
|
|
"summary": "SMS Campaign",
|
|
"description": "Activates | Deactivates | Reactivates",
|
|
"operationId": "handleCommands",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "campaignId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"SMS Campaigns"
|
|
],
|
|
"summary": "Update a Campaign",
|
|
"description": "",
|
|
"operationId": "updateCampaign",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "campaignId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/CommandWrapper"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"SMS Campaigns"
|
|
],
|
|
"summary": "Delete a SMS Campaign",
|
|
"description": "Note: Only closed SMS Campaigns can be deleted",
|
|
"operationId": "delete",
|
|
"parameters": [
|
|
{
|
|
"name": "campaignId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/smscampaigns/template": {
|
|
"get": {
|
|
"tags": [
|
|
"SMS Campaigns"
|
|
],
|
|
"summary": "Retrieve a SMS Campaign",
|
|
"description": "Example Requests:\n\nsmscampaigns/1\n\n\nsmscampaigns/1?template=true\n\n\nsmscampaigns/template",
|
|
"operationId": "template",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/smscampaigns/preview": {
|
|
"post": {
|
|
"tags": [
|
|
"SMS Campaigns"
|
|
],
|
|
"operationId": "preview",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/codes/{codeId}/codevalues/{codeValueId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Code Values"
|
|
],
|
|
"summary": "Retrieve a Code Value",
|
|
"description": "Returns the details of a Code Value\n\nExample Requests:\n\ncodes/1/codevalues/1",
|
|
"operationId": "retrieveCodeValue",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "codeValueId",
|
|
"in": "path",
|
|
"description": "codeValueId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetCodeValuesDataResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Code Values"
|
|
],
|
|
"summary": "Update a Code Value",
|
|
"description": "Updates the details of a code value.",
|
|
"operationId": "updateCodeValue",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "codeId",
|
|
"in": "path",
|
|
"description": "codeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "codeValueId",
|
|
"in": "path",
|
|
"description": "codeValueId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutCodeValuesDataRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutCodeValueDataResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Code Values"
|
|
],
|
|
"summary": "Delete a Code Value",
|
|
"description": "Deletes a code value",
|
|
"operationId": "deleteCodeValue",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "codeId",
|
|
"in": "path",
|
|
"description": "codeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "codeValueId",
|
|
"in": "path",
|
|
"description": "codeValueId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteCodeValueDataResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/codes/{codeId}/codevalues": {
|
|
"get": {
|
|
"tags": [
|
|
"Code Values"
|
|
],
|
|
"summary": "List Code Values",
|
|
"description": "Returns the list of Code Values for a given Code\n\nExample Requests:\n\ncodes/1/codevalues",
|
|
"operationId": "retrieveAllCodeValues",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "codeId",
|
|
"in": "path",
|
|
"description": "codeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A List of Given response",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetCodeValuesDataResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Code Values"
|
|
],
|
|
"summary": "Create a Code Value",
|
|
"description": "",
|
|
"operationId": "createCodeValue",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "codeId",
|
|
"in": "path",
|
|
"description": "codeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostCodeValuesDataRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostCodeValueDataResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/codes": {
|
|
"get": {
|
|
"tags": [
|
|
"Codes"
|
|
],
|
|
"summary": "Retrieve Codes",
|
|
"description": "Returns the list of codes.\n\nExample Requests:\n\ncodes",
|
|
"operationId": "retrieveCodes",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetCodesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Codes"
|
|
],
|
|
"summary": "Create a Code",
|
|
"description": "Creates a code. Codes created through api are always 'user defined' and so system defined is marked as false.",
|
|
"operationId": "createCode",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostCodesRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostCodesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/codes/{codeId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Codes"
|
|
],
|
|
"summary": "Retrieve a Code",
|
|
"description": "Returns the details of a Code.\n\nExample Requests:\n\ncodes/1",
|
|
"operationId": "retrieveCode",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "codeId",
|
|
"in": "path",
|
|
"description": "codeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetCodesResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Codes"
|
|
],
|
|
"summary": "Update a Code",
|
|
"description": "Updates the details of a code if it is not system defined.",
|
|
"operationId": "updateCode",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "codeId",
|
|
"in": "path",
|
|
"description": "codeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutCodesRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutCodesResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Codes"
|
|
],
|
|
"summary": "Delete a Code",
|
|
"description": "Deletes a code if it is not system defined.",
|
|
"operationId": "deleteCode",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "codeId",
|
|
"in": "path",
|
|
"description": "codeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteCodesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/externalservice/{servicename}": {
|
|
"get": {
|
|
"tags": [
|
|
"External Services"
|
|
],
|
|
"summary": "Retrieve External Services Configuration",
|
|
"description": "Returns a external Service configurations based on the Service Name.\n\nService Names supported are S3 and SMTP.\n\nExample Requests:\n\nexternalservice/SMTP",
|
|
"operationId": "retrieveOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "servicename",
|
|
"in": "path",
|
|
"description": "servicename",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/ExternalServicesPropertiesData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"External Services"
|
|
],
|
|
"summary": "Update External Service",
|
|
"description": "Updates the external Service Configuration for a Service Name.\n\nExample: \n\nexternalservice/S3",
|
|
"operationId": "updateExternalServiceProperties",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "servicename",
|
|
"in": "path",
|
|
"description": "servicename",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutExternalServiceRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": ""
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/configurations/{configId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Global Configuration"
|
|
],
|
|
"summary": "Retrieve Global Configuration",
|
|
"description": "Returns a global enable/disable configurations.\n\nExample Requests:\n\nconfigurations/1",
|
|
"operationId": "retrieveOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "configId",
|
|
"in": "path",
|
|
"description": "configId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetGlobalConfigurationsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Global Configuration"
|
|
],
|
|
"summary": "Update Global Configuration",
|
|
"description": "Updates an enable/disable global configuration item.",
|
|
"operationId": "updateConfiguration",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "configId",
|
|
"in": "path",
|
|
"description": "configId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutGlobalConfigurationsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutGlobalConfigurationsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/configurations": {
|
|
"get": {
|
|
"tags": [
|
|
"Global Configuration"
|
|
],
|
|
"summary": "Retrieve Global Configuration | Retrieve Global Configuration for surveys",
|
|
"description": "Returns the list global enable/disable configurations.\n\nExample Requests:\n\nconfigurations\n\n\nReturns the list global enable/disable survey configurations.\n\nExample Requests:\n\nconfigurations/survey",
|
|
"operationId": "retrieveConfiguration",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "survey",
|
|
"in": "query",
|
|
"description": "survey",
|
|
"required": false,
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "List of example \n response \nsurveys response \ngiven below",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetGlobalConfigurationsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CreditBureauConfiguration/loanProduct": {
|
|
"get": {
|
|
"tags": [
|
|
"CreditBureau Configuration"
|
|
],
|
|
"operationId": "fetchLoanProducts",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CreditBureauConfiguration/organisationCreditBureau": {
|
|
"get": {
|
|
"tags": [
|
|
"CreditBureau Configuration"
|
|
],
|
|
"operationId": "getOrganisationCreditBureau",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"CreditBureau Configuration"
|
|
],
|
|
"operationId": "updateCreditBureau",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CreditBureauConfiguration/mappings": {
|
|
"get": {
|
|
"tags": [
|
|
"CreditBureau Configuration"
|
|
],
|
|
"operationId": "getCreditBureauLoanProductMapping",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"CreditBureau Configuration"
|
|
],
|
|
"operationId": "updateCreditBureauLoanProductMapping",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CreditBureauConfiguration/organisationCreditBureau/{organisationCreditBureauId}": {
|
|
"post": {
|
|
"tags": [
|
|
"CreditBureau Configuration"
|
|
],
|
|
"operationId": "addOrganisationCreditBureau",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "organisationCreditBureauId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CreditBureauConfiguration/mappings/{CreditBureauId}": {
|
|
"post": {
|
|
"tags": [
|
|
"CreditBureau Configuration"
|
|
],
|
|
"operationId": "createCreditBureauLoanProductMapping",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "CreditBureauId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CreditBureauConfiguration/config/{organisationCreditBureauId}": {
|
|
"get": {
|
|
"tags": [
|
|
"CreditBureau Configuration"
|
|
],
|
|
"operationId": "getConfiguration",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "organisationCreditBureauId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CreditBureauConfiguration": {
|
|
"get": {
|
|
"tags": [
|
|
"CreditBureau Configuration"
|
|
],
|
|
"operationId": "getCreditBureau",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/datatables/register/{datatable}/{apptable}": {
|
|
"post": {
|
|
"tags": [
|
|
"Data Tables"
|
|
],
|
|
"summary": "Register Data Table",
|
|
"description": "Registers a data table with the Apache Fineract Core application table. This allows the data table to be maintained through the API. In case the datatable is a PPI (survey table), a parameter category should be pass along with the request. The API currently support one category (200)",
|
|
"operationId": "registerDatatable",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "datatable",
|
|
"in": "path",
|
|
"description": "datatable",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "apptable",
|
|
"in": "path",
|
|
"description": "apptable",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostDataTablesRegisterDatatableAppTable"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutDataTablesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/datatables/deregister/{datatable}": {
|
|
"post": {
|
|
"tags": [
|
|
"Data Tables"
|
|
],
|
|
"summary": "Deregister Data Table",
|
|
"description": "Deregisters a data table. It will no longer be available through the API.",
|
|
"operationId": "deregisterDatatable",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "datatable",
|
|
"in": "path",
|
|
"description": "datatable",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutDataTablesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/datatables/{datatable}": {
|
|
"get": {
|
|
"tags": [
|
|
"Data Tables"
|
|
],
|
|
"summary": "Retrieve Data Table Details",
|
|
"description": "Lists a registered data table details and the Apache Fineract Core application table they are registered to.",
|
|
"operationId": "getDatatable",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "datatable",
|
|
"in": "path",
|
|
"description": "datatable",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetDataTablesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/datatables/{datatable}/{apptableId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Data Tables"
|
|
],
|
|
"summary": "Retrieve Entry(s) from Data Table",
|
|
"description": "Gets the entry (if it exists) for data tables that are one to one with the application table. \nGets the entries (if they exist) for data tables that are one to many with the application table.\n\nNote: The 'fields' parameter is not available for datatables.\n\nARGUMENTS\norderoptional Specifies the order in which data is returned.genericResultSetoptional, defaults to false If 'true' an optimised JSON format is returned suitable for tabular display of data. This format is used by the default data tables UI functionality.\nExample Requests:\n\ndatatables/extra_client_details/1\n\n\ndatatables/extra_family_details/1?order=`Date of Birth` desc\n\n\ndatatables/extra_client_details/1?genericResultSet=true",
|
|
"operationId": "getDatatable",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "datatable",
|
|
"in": "path",
|
|
"description": "datatable",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "apptableId",
|
|
"in": "path",
|
|
"description": "apptableId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "order",
|
|
"in": "query",
|
|
"description": "order",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetDataTablesAppTableIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Data Tables"
|
|
],
|
|
"summary": "Create Entry in Data Table",
|
|
"description": "Adds a row to the data table.\n\nNote that the default datatable UI functionality converts any field name containing spaces to underscores when using the API. This means the field name \"Business Description\" is considered the same as \"Business_Description\". So you shouldn't have both \"versions\" in any data table.",
|
|
"operationId": "createDatatableEntry",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "datatable",
|
|
"in": "path",
|
|
"description": "datatable",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "apptableId",
|
|
"in": "path",
|
|
"description": "apptableId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostDataTablesAppTableIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostDataTablesAppTableIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Data Tables"
|
|
],
|
|
"summary": "Update Entry in Data Table (One to One)",
|
|
"description": "Updates the row (if it exists) of the data table.",
|
|
"operationId": "updateDatatableEntryOnetoOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "datatable",
|
|
"in": "path",
|
|
"description": "datatable",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "apptableId",
|
|
"in": "path",
|
|
"description": "apptableId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutDataTablesAppTableIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutDataTablesAppTableIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Data Tables"
|
|
],
|
|
"summary": "Delete Entry(s) in Data Table",
|
|
"description": "Deletes the entry (if it exists) for data tables that are one-to-one with the application table. \nDeletes the entries (if they exist) for data tables that are one-to-many with the application table.",
|
|
"operationId": "deleteDatatableEntries",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "datatable",
|
|
"in": "path",
|
|
"description": "datatable",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "apptableId",
|
|
"in": "path",
|
|
"description": "apptableId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteDataTablesDatatableAppTableIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/datatables/{datatable}/{apptableId}/{datatableId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Data Tables"
|
|
],
|
|
"operationId": "getDatatableManyEntry",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "datatable",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "apptableId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "datatableId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "order",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Data Tables"
|
|
],
|
|
"summary": "Update Entry in Data Table (One to Many)",
|
|
"description": "Updates the row (if it exists) of the data table.",
|
|
"operationId": "updateDatatableEntryOneToMany",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "datatable",
|
|
"in": "path",
|
|
"description": "datatable",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "apptableId",
|
|
"in": "path",
|
|
"description": "apptableId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "datatableId",
|
|
"in": "path",
|
|
"description": "datatableId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutDataTablesAppTableIdDatatableIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutDataTablesAppTableIdDatatableIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Data Tables"
|
|
],
|
|
"summary": "Delete Entry in Datatable (One to Many)",
|
|
"description": "Deletes the entry (if it exists) for data tables that are one to many with the application table.\n\n",
|
|
"operationId": "deleteDatatableEntries",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "datatable",
|
|
"in": "path",
|
|
"description": "datatable",
|
|
"required": true,
|
|
"type": "body",
|
|
"x-example": "{}"
|
|
},
|
|
{
|
|
"name": "apptableId",
|
|
"in": "path",
|
|
"description": "apptableId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "datatableId",
|
|
"in": "path",
|
|
"description": "datatableId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteDataTablesDatatableAppTableIdDatatableIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/datatables": {
|
|
"get": {
|
|
"tags": [
|
|
"Data Tables"
|
|
],
|
|
"summary": "List Data Tables",
|
|
"description": "Lists registered data tables and the Apache Fineract Core application table they are registered to.\n\nARGUMENTS\n\napptable - optional\nThe Apache Fineract core application table.\n\nExample Requests:\n\ndatatables?apptable=m_client\n\n\ndatatables",
|
|
"operationId": "getDatatables",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "apptable",
|
|
"in": "query",
|
|
"description": "apptable",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetDataTablesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Data Tables"
|
|
],
|
|
"summary": "Create Data Table",
|
|
"description": "Create a new data table and registers it with the Apache Fineract Core application table.\n\nField Descriptions\n\nMandatory - datatableName : \n\nThe name of the Data Table.\n\nMandatory - apptableName\n\nApplication table name. Must be one of the following:\n\nm_client\n\nm_group\n\nm_loan\n\nm_office\n\nm_saving_account\n\nm_product_loan\n\nm_savings_product\n\nMandatory - columns \nAn array of columns in the new Data Table.\n\nOptional - multiRow\n\nAllows to create multiple entries in the Data Table. Optional, defaults to false. If this property is not provided Data Table will allow only one entry.\n\nField Descriptions - columns\n\nMandatory - name\n\nName of the created column. Can contain only alphanumeric characters, underscores and spaces, but cannot start with a number. Cannot start or end with an underscore or space.\n\nMandatory - type\n\nColumn type. Must be one of the following:\n\nBoolean\n\nDate\n\nDateTime\n\nDecimal\n\nDropdown\n\n\nNumber\n\nString\n\nText\n\nMandatory [type = Dropdown] - code\n\nUsed in Code Value fields. Column name becomes: code_cd_name. Mandatory if using type Dropdown, otherwise an error is returned.\n\nOptional - mandatory\n\nDetermines whether this column must have a value in every entry. Optional, defaults to false.\n\nMandatory [type = String] - length\n\nLength of the text field. Mandatory if type String is used, otherwise an error is returned.",
|
|
"operationId": "createDatatable",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostDataTablesRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostDataTablesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/datatables/{datatableName}": {
|
|
"put": {
|
|
"tags": [
|
|
"Data Tables"
|
|
],
|
|
"summary": "Update Data Table",
|
|
"description": "Modifies fields of a data table. If the apptableName parameter is passed, data table is deregistered and registered with the new application table.",
|
|
"operationId": "updateDatatable",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "datatableName",
|
|
"in": "path",
|
|
"description": "datatableName",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutDataTablesRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutDataTablesResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Data Tables"
|
|
],
|
|
"summary": "Delete Data Table",
|
|
"description": "Deletes a data table and deregisters it from the Apache Fineract Core application table.",
|
|
"operationId": "deleteDatatable",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "datatableName",
|
|
"in": "path",
|
|
"description": "datatableName",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteDataTablesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/entityDatatableChecks": {
|
|
"get": {
|
|
"tags": [
|
|
"Entity-Datatable Checks"
|
|
],
|
|
"summary": "List Entity-Datatable Checks",
|
|
"description": "The list capability of Entity-Datatable Checks can support pagination.\n\nOPTIONAL ARGUMENTS\noffset Integer optional, defaults to 0 Indicates the result from which pagination startslimit Integer optional, defaults to 200 Restricts the size of results returned. To override the default and return all entries you must explicitly pass a non-positive integer value for limit e.g. limit=0, or limit=-1\nExample Request:\n\nentityDatatableChecks?offset=0&limit=15",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "status",
|
|
"in": "query",
|
|
"description": "status",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "entity",
|
|
"in": "query",
|
|
"description": "entity",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "productId",
|
|
"in": "query",
|
|
"description": "productId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetEntityDatatableChecksResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Entity-Datatable Checks"
|
|
],
|
|
"summary": "Create Entity-Datatable Checks",
|
|
"description": "Mandatory Fields : \nentity, status, datatableName\n\nNon-Mandatory Fields : \nproductId",
|
|
"operationId": "createEntityDatatableCheck",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostEntityDatatableChecksTemplateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostEntityDatatableChecksTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/entityDatatableChecks/{entityDatatableCheckId}": {
|
|
"delete": {
|
|
"tags": [
|
|
"Entity-Datatable Checks"
|
|
],
|
|
"summary": "Delete Entity-Datatable Checks",
|
|
"description": "Deletes an existing Entity-Datatable Check",
|
|
"operationId": "deleteDatatable",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "entityDatatableCheckId",
|
|
"in": "path",
|
|
"description": "entityDatatableCheckId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteEntityDatatableChecksTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/entityDatatableChecks/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Entity-Datatable Checks"
|
|
],
|
|
"summary": "Retrieve Entity-Datatable Checks Template",
|
|
"description": "This is a convenience resource useful for building maintenance user interface screens for Entity-Datatable Checks applications. The template data returned consists of:\n\nAllowed Value Lists\nExample Request:\n\nentityDatatableChecks/template",
|
|
"operationId": "getTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetEntityDatatableChecksTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/reports": {
|
|
"get": {
|
|
"tags": [
|
|
"Reports"
|
|
],
|
|
"summary": "List Reports",
|
|
"description": "Lists all reports and their parameters.\n\nExample Request:\n\nreports",
|
|
"operationId": "retrieveReportList",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": ""
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Reports"
|
|
],
|
|
"summary": "Create a Report",
|
|
"description": "",
|
|
"operationId": "createReport",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostRepostRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostReportsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/reports/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Reports"
|
|
],
|
|
"summary": "Retrieve a Report\n",
|
|
"description": "Example Requests:\n\nreports/1\n\n\nreports/1?template=true",
|
|
"operationId": "retrieveReport",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"description": "id",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetReportsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Reports"
|
|
],
|
|
"summary": "Update a Report",
|
|
"description": "Only the useReport value can be updated for core reports.",
|
|
"operationId": "updateReport",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"description": "id",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutReportRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutReportResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Reports"
|
|
],
|
|
"summary": "Delete a Report",
|
|
"description": "Only non-core reports can be deleted.",
|
|
"operationId": "deleteReport",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"description": "id",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteReportsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/reports/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Reports"
|
|
],
|
|
"summary": "Retrieve Report Template",
|
|
"description": "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:\n\nField Defaults\nAllowed Value Lists\n\nExample Request : \n\nreports/template",
|
|
"operationId": "retrieveOfficeTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetReportsTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/runreports/{reportName}": {
|
|
"get": {
|
|
"tags": [
|
|
"Run Reports"
|
|
],
|
|
"summary": "Running a Report",
|
|
"description": "This resource allows you to run and receive output from pre-defined Apache Fineract reports.\n\nReports can also be used to provide data for searching and workflow functionality.\n\nThe default output is a JSON formatted \"Generic Resultset\". The Generic Resultset contains Column Heading as well as Data information. However, you can export to CSV format by simply adding \"&exportCSV=true\" to the end of your URL.\n\nIf Pentaho reports have been pre-defined, they can also be run through this resource. Pentaho reports can return HTML, PDF or CSV formats.\n\nThe Apache Fineract reference application uses a JQuery plugin called stretchy reporting which, itself, uses this reports resource to provide a pretty flexible reporting User Interface (UI).\n\n\n\nExample Requests:\n\nrunreports/Client%20Listing?R_officeId=1\n\n\nrunreports/Client%20Listing?R_officeId=1&exportCSV=true\n\n\nrunreports/OfficeIdSelectOne?R_officeId=1¶meterType=true\n\n\nrunreports/OfficeIdSelectOne?R_officeId=1¶meterType=true&exportCSV=true\n\n\nrunreports/Expected%20Payments%20By%20Date%20-%20Formatted?R_endDate=2013-04-30&R_loanOfficerId=-1&R_officeId=1&R_startDate=2013-04-16&output-type=HTML&R_officeId=1\n\n\nrunreports/Expected%20Payments%20By%20Date%20-%20Formatted?R_endDate=2013-04-30&R_loanOfficerId=-1&R_officeId=1&R_startDate=2013-04-16&output-type=XLS&R_officeId=1\n\n\nrunreports/Expected%20Payments%20By%20Date%20-%20Formatted?R_endDate=2013-04-30&R_loanOfficerId=-1&R_officeId=1&R_startDate=2013-04-16&output-type=CSV&R_officeId=1\n\n\nrunreports/Expected%20Payments%20By%20Date%20-%20Formatted?R_endDate=2013-04-30&R_loanOfficerId=-1&R_officeId=1&R_startDate=2013-04-16&output-type=PDF&R_officeId=1",
|
|
"operationId": "runReport",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json",
|
|
"text/csv",
|
|
"application/vnd.ms-excel",
|
|
"application/pdf",
|
|
"text/html"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "reportName",
|
|
"in": "path",
|
|
"description": "reportName",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "isSelfServiceUserReport",
|
|
"in": "query",
|
|
"description": "isSelfServiceUserReport",
|
|
"required": false,
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetReportNameResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/{entityType}/{entityId}/documents/{documentId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Documents"
|
|
],
|
|
"summary": "Retrieve a Document",
|
|
"description": "Example Requests:\n\nclients/1/documents/1\n\n\nloans/1/documents/1\n\n\nclient_identifiers/1/documents/1?fields=name,description",
|
|
"operationId": "getDocument",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "entityType",
|
|
"in": "path",
|
|
"description": "entityType",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "entityId",
|
|
"in": "path",
|
|
"description": "entityId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "documentId",
|
|
"in": "path",
|
|
"description": "documentId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetEntityTypeEntityIdDocumentsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Documents"
|
|
],
|
|
"summary": "Update a Document",
|
|
"description": "Note: A document is updated using a Multi-part form upload \nBody Parts\nname\nName or summary of the document\ndescription\nDescription of the document\nfile\nThe file to be uploaded",
|
|
"operationId": "updateDocument",
|
|
"consumes": [
|
|
"multipart/form-data"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "entityType",
|
|
"in": "path",
|
|
"description": "entityType",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "entityId",
|
|
"in": "path",
|
|
"description": "entityId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "documentId",
|
|
"in": "path",
|
|
"description": "documentId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "Content-Length",
|
|
"in": "header",
|
|
"description": "Content-Length",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "file",
|
|
"in": "formData",
|
|
"description": "file",
|
|
"required": false,
|
|
"type": "file"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"in": "formData",
|
|
"description": "name",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "description",
|
|
"in": "formData",
|
|
"description": "description",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Not Shown (multi-part form data)",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutEntityTypeEntityIdDocumentsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Documents"
|
|
],
|
|
"summary": "Remove a Document",
|
|
"description": "",
|
|
"operationId": "deleteDocument",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "entityType",
|
|
"in": "path",
|
|
"description": "entityType",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "entityId",
|
|
"in": "path",
|
|
"description": "entityId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "documentId",
|
|
"in": "path",
|
|
"description": "documentId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteEntityTypeEntityIdDocumentsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/{entityType}/{entityId}/documents/{documentId}/attachment": {
|
|
"get": {
|
|
"tags": [
|
|
"Documents"
|
|
],
|
|
"summary": "Retrieve Binary File associated with Document",
|
|
"description": "Request used to download the file associated with the document\n\nExample Requests:\n\nclients/1/documents/1/attachment\n\n\nloans/1/documents/1/attachment",
|
|
"operationId": "downloadFile",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/octet-stream"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "entityType",
|
|
"in": "path",
|
|
"description": "entityType",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "entityId",
|
|
"in": "path",
|
|
"description": "entityId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "documentId",
|
|
"in": "path",
|
|
"description": "documentId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Not Shown: The corresponding Binary file"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/{entityType}/{entityId}/documents": {
|
|
"get": {
|
|
"tags": [
|
|
"Documents"
|
|
],
|
|
"summary": "List documents",
|
|
"description": "Example Requests:\n\nclients/1/documents\n\nclient_identifiers/1/documents\n\nloans/1/documents?fields=name,description",
|
|
"operationId": "retreiveAllDocuments",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "entityType",
|
|
"in": "path",
|
|
"description": "entityType",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "entityId",
|
|
"in": "path",
|
|
"description": "entityId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetEntityTypeEntityIdDocumentsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Documents"
|
|
],
|
|
"summary": "Create a Document",
|
|
"description": "Note: A document is created using a Multi-part form upload \n\nBody Parts\n\nname : \nName or summary of the document\n\ndescription : \nDescription of the document\n\nfile : \nThe file to be uploaded\n\nMandatory Fields : \nfile and description",
|
|
"operationId": "createDocument",
|
|
"consumes": [
|
|
"multipart/form-data"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "entityType",
|
|
"in": "path",
|
|
"description": "entityType",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "entityId",
|
|
"in": "path",
|
|
"description": "entityId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "Content-Length",
|
|
"in": "header",
|
|
"description": "Content-Length",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "file",
|
|
"in": "formData",
|
|
"description": "file",
|
|
"required": false,
|
|
"type": "file"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"in": "formData",
|
|
"description": "name",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "description",
|
|
"in": "formData",
|
|
"description": "description",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Not Shown (multi-part form data)",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostEntityTypeEntityIdDocumentsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/{entity}/{entityId}/images": {
|
|
"get": {
|
|
"tags": [
|
|
"DomainNameapiv1{entity}{entityId}images"
|
|
],
|
|
"operationId": "downloadClientImage",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/octet-stream"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "entity",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "entityId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "maxWidth",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "maxHeight",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "output",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"default": {
|
|
"description": "successful operation"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"DomainNameapiv1{entity}{entityId}images"
|
|
],
|
|
"operationId": "addNewClientImage",
|
|
"consumes": [
|
|
"text/plain",
|
|
"text/html",
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "entity",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "entityId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"DomainNameapiv1{entity}{entityId}images"
|
|
],
|
|
"operationId": "updateClientImage",
|
|
"consumes": [
|
|
"multipart/form-data"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "entity",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "entityId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "Content-Length",
|
|
"in": "header",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "file",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "file"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"DomainNameapiv1{entity}{entityId}images"
|
|
],
|
|
"operationId": "deleteClientImage",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "entity",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "entityId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/entitytoentitymapping/{mapId}/{fromId}/{toId}": {
|
|
"get": {
|
|
"tags": [
|
|
"DomainNameapiv1entitytoentitymapping"
|
|
],
|
|
"operationId": "getEntityToEntityMappings",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "mapId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "fromId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "toId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/entitytoentitymapping/{mapId}": {
|
|
"get": {
|
|
"tags": [
|
|
"DomainNameapiv1entitytoentitymapping"
|
|
],
|
|
"operationId": "retrieveOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "mapId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"DomainNameapiv1entitytoentitymapping"
|
|
],
|
|
"operationId": "updateMap",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "mapId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"DomainNameapiv1entitytoentitymapping"
|
|
],
|
|
"operationId": "delete",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "mapId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/entitytoentitymapping": {
|
|
"get": {
|
|
"tags": [
|
|
"DomainNameapiv1entitytoentitymapping"
|
|
],
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/entitytoentitymapping/{relId}": {
|
|
"post": {
|
|
"tags": [
|
|
"DomainNameapiv1entitytoentitymapping"
|
|
],
|
|
"operationId": "createMap",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "relId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/hooks/{hookId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Hooks"
|
|
],
|
|
"summary": "Retrieve a Hook",
|
|
"description": "Returns the details of a Hook.\n\nExample Requests:\n\nhooks/1",
|
|
"operationId": "retrieveHook",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "hookId",
|
|
"in": "path",
|
|
"description": "hookId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetHookResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Hooks"
|
|
],
|
|
"summary": "Update a Hook",
|
|
"description": "Updates the details of a hook.",
|
|
"operationId": "updateHook",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "hookId",
|
|
"in": "path",
|
|
"description": "hookId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutHookRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutHookResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Hooks"
|
|
],
|
|
"summary": "Delete a Hook",
|
|
"description": "Deletes a hook.",
|
|
"operationId": "deleteHook",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "hookId",
|
|
"in": "path",
|
|
"description": "hookId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteHookResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/hooks": {
|
|
"get": {
|
|
"tags": [
|
|
"Hooks"
|
|
],
|
|
"summary": "Retrieve Hooks",
|
|
"description": "Returns the list of hooks.\n\nExample Requests:\n\nhooks",
|
|
"operationId": "retrieveHooks",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetHookResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Hooks"
|
|
],
|
|
"summary": "Create a Hook",
|
|
"description": "The following parameters can be passed for the creation of a hook :-\n\nname - string - Required. The name of the template that is being called. (See /hooks/template for the list of valid hook names.)\n\nisActive - boolean - Determines whether the hook is actually triggered.\n\nevents - array - Determines what events the hook is triggered for.\n\nconfig - hash - Required. Key/value pairs to provide settings for this hook. These settings vary between the templates.\n\ntemplateId - Optional. The UGD template ID associated with the same entity (client or loan).",
|
|
"operationId": "createHook",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostHookRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostHookResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/hooks/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Hooks"
|
|
],
|
|
"summary": "Retrieve Hooks Template",
|
|
"description": "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:\n\nField Defaults\nAllowed Value Lists\nExample Request:\n\nhooks/template",
|
|
"operationId": "template",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetHookTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/scheduler": {
|
|
"get": {
|
|
"tags": [
|
|
"Scheduler"
|
|
],
|
|
"summary": "Retrieve Scheduler Status",
|
|
"description": "Returns the scheduler status.\n\nExample Requests:\n\nscheduler",
|
|
"operationId": "retrieveStatus",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetSchedulerResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Scheduler"
|
|
],
|
|
"summary": "Activate Scheduler Jobs | Suspend Scheduler Jobs",
|
|
"description": "Activates the scheduler job service. | Suspends the scheduler job service.",
|
|
"operationId": "changeSchedulerStatus",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "POST : scheduler?command=start\n\n\nPOST : scheduler?command=stop"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/jobs/{jobId}": {
|
|
"get": {
|
|
"tags": [
|
|
"MIFOSX-BATCH JOBS"
|
|
],
|
|
"summary": "Retrieve a Job",
|
|
"description": "Returns the details of a Job.\n\nExample Requests:\n\njobs/5",
|
|
"operationId": "retrieveOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "jobId",
|
|
"in": "path",
|
|
"description": "jobId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetJobsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"MIFOSX-BATCH JOBS"
|
|
],
|
|
"summary": "Run a Job",
|
|
"description": "Manually Execute Specific Job.",
|
|
"operationId": "executeJob",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "jobId",
|
|
"in": "path",
|
|
"description": "jobId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "POST: jobs/1?command=executeJob"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"MIFOSX-BATCH JOBS"
|
|
],
|
|
"summary": "Update a Job",
|
|
"description": "Updates the details of a job.",
|
|
"operationId": "updateJobDetail",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "jobId",
|
|
"in": "path",
|
|
"description": "jobId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutJobsJobsIDRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": ""
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/jobs/{jobId}/runhistory": {
|
|
"get": {
|
|
"tags": [
|
|
"MIFOSX-BATCH JOBS"
|
|
],
|
|
"summary": "Retrieve Job Run History",
|
|
"description": "Example Requests:\n\njobs/5/runhistory?offset=0&limit=200",
|
|
"operationId": "retrieveHistory",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "jobId",
|
|
"in": "path",
|
|
"description": "jobId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"description": "orderBy",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "sortOrder",
|
|
"in": "query",
|
|
"description": "sortOrder",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetJobsJobIDJobRunHistoryResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/jobs": {
|
|
"get": {
|
|
"tags": [
|
|
"MIFOSX-BATCH JOBS"
|
|
],
|
|
"summary": "Retrieve Scheduler Jobs",
|
|
"description": "Returns the list of jobs.\n\nExample Requests:\n\njobs",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetJobsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/reportmailingjobs/{entityId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Report Mailing Jobs"
|
|
],
|
|
"summary": "Retrieve a Report Mailing Job",
|
|
"description": "Example Requests:\n\nreportmailingjobs/1\n\n\nreportmailingjobs/1?template=true",
|
|
"operationId": "retrieveReportMailingJob",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "entityId",
|
|
"in": "path",
|
|
"description": "entityId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetReportMailingJobsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Report Mailing Jobs"
|
|
],
|
|
"summary": "Update a Report Mailing Job\n",
|
|
"description": "",
|
|
"operationId": "updateReportMailingJob",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "entityId",
|
|
"in": "path",
|
|
"description": "entityId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutReportMailingJobsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutReportMailingJobsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Report Mailing Jobs"
|
|
],
|
|
"summary": "Delete a Report Mailing Job",
|
|
"description": "",
|
|
"operationId": "deleteReportMailingJob",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "entityId",
|
|
"in": "path",
|
|
"description": "entityId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteReportMailingJobsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteReportMailingJobsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/reportmailingjobs": {
|
|
"get": {
|
|
"tags": [
|
|
"Report Mailing Jobs"
|
|
],
|
|
"summary": "List Report Mailing Jobs",
|
|
"description": "Example Requests:\n\nreportmailingjobs",
|
|
"operationId": "retrieveAllReportMailingJobs",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"description": "orderBy",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "sortOrder",
|
|
"in": "query",
|
|
"description": "sortOrder",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetReportMailingJobsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Report Mailing Jobs"
|
|
],
|
|
"summary": "Create a Report Mailing Job",
|
|
"description": "Mandatory Fields: name, startDateTime, stretchyReportId, emailRecipients, emailSubject, emailMessage, emailAttachmentFileFormatId, recurrence, isActive\n\nOptional Fields: description, stretchyReportParamMap",
|
|
"operationId": "createReportMailingJob",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostReportMailingJobsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostReportMailingJobsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/reportmailingjobs/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Report Mailing Jobs"
|
|
],
|
|
"summary": "Retrieve Report Mailing Job Details Template",
|
|
"description": "This is a convenience resource. It can be useful when building maintenance user interface screens for report mailing job applications. The template data returned consists of any or all of:\n\nField Defaults\nAllowed Value Lists\nExample Request:\n\nreportmailingjobs/template",
|
|
"operationId": "retrieveReportMailingJobTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetReportMailingJobsTemplate"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/reportmailingjobrunhistory": {
|
|
"get": {
|
|
"tags": [
|
|
"List Report Mailing Job History"
|
|
],
|
|
"summary": "List Report Mailing Job History",
|
|
"description": "The list capability of report mailing job history can support pagination and sorting.\n\nExample Requests:\n\nreportmailingjobrunhistory/1",
|
|
"operationId": "retrieveAllByReportMailingJobId",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "reportMailingJobId",
|
|
"in": "query",
|
|
"description": "reportMailingJobId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"description": "orderBy",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "sortOrder",
|
|
"in": "query",
|
|
"description": "sortOrder",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/ReportMailingJobRunHistoryData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/authentication": {
|
|
"post": {
|
|
"tags": [
|
|
"Authentication HTTP Basic"
|
|
],
|
|
"summary": "Verify authentication",
|
|
"description": "Authenticates the credentials provided and returns the set roles and permissions allowed.",
|
|
"operationId": "authenticate",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "username",
|
|
"in": "query",
|
|
"description": "username",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "password",
|
|
"in": "query",
|
|
"description": "password",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostAuthenticationResponse"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Unauthenticated. Please login"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/userdetails": {
|
|
"get": {
|
|
"tags": [
|
|
"Fetch authenticated user details"
|
|
],
|
|
"summary": "Fetch authenticated user details\n",
|
|
"description": "checks the Authentication and returns the set roles and permissions allowed.",
|
|
"operationId": "fetchAuthenticatedUserData",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "access_token",
|
|
"in": "query",
|
|
"description": "access_token",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetUserDetailsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/sms/{campaignId}/messageByStatus": {
|
|
"get": {
|
|
"tags": [
|
|
"SMS"
|
|
],
|
|
"operationId": "retrieveAllSmsByStatus",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "campaignId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "status",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "fromDate",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "toDate",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "locale",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "sqlSearch",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "sortOrder",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/sms": {
|
|
"get": {
|
|
"tags": [
|
|
"SMS"
|
|
],
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"SMS"
|
|
],
|
|
"operationId": "create",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/sms/{resourceId}": {
|
|
"get": {
|
|
"tags": [
|
|
"SMS"
|
|
],
|
|
"operationId": "retrieveOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "resourceId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"SMS"
|
|
],
|
|
"operationId": "update",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "resourceId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"SMS"
|
|
],
|
|
"operationId": "delete",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "resourceId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/likelihood/{ppiName}/{likelihoodId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Likelihood"
|
|
],
|
|
"operationId": "retrieve",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "likelihoodId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Likelihood"
|
|
],
|
|
"operationId": "update",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "likelihoodId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/likelihood/{ppiName}": {
|
|
"get": {
|
|
"tags": [
|
|
"Likelihood"
|
|
],
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "ppiName",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/povertyLine/{ppiName}": {
|
|
"get": {
|
|
"tags": [
|
|
"Poverty Line"
|
|
],
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "ppiName",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/povertyLine/{ppiName}/{likelihoodId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Poverty Line"
|
|
],
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "ppiName",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "likelihoodId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/survey": {
|
|
"get": {
|
|
"tags": [
|
|
"Survey"
|
|
],
|
|
"summary": "Retrieve surveys",
|
|
"description": "Retrieve surveys. This allows to retrieve the list of survey tables registered .",
|
|
"operationId": "retrieveSurveys",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetSurveyResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/survey/{surveyName}": {
|
|
"get": {
|
|
"tags": [
|
|
"Survey"
|
|
],
|
|
"summary": "Retrieve survey",
|
|
"description": "Lists a registered survey table details and the Apache Fineract Core application table they are registered to.",
|
|
"operationId": "retrieveSurvey",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "surveyName",
|
|
"in": "path",
|
|
"description": "surveyName",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetSurveyResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/survey/{surveyName}/{clientId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Survey"
|
|
],
|
|
"operationId": "getClientSurveyOverview",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "surveyName",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/survey/{surveyName}/{clientId}/{entryId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Survey"
|
|
],
|
|
"operationId": "getSurveyEntry",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "surveyName",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "entryId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/survey/{surveyName}/{apptableId}": {
|
|
"post": {
|
|
"tags": [
|
|
"Survey"
|
|
],
|
|
"summary": "Create an entry in the survey table",
|
|
"description": "Insert and entry in a survey table (full fill the survey).\n\nRefer Link for sample Body: [ https://demo.openmf.org/api-docs/apiLive.htm#survey_create ] ",
|
|
"operationId": "createDatatableEntry",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "surveyName",
|
|
"in": "path",
|
|
"description": "surveyName",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "apptableId",
|
|
"in": "path",
|
|
"description": "apptableId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostSurveySurveyNameApptableIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostSurveySurveyNameApptableIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/survey/{surveyName}/{clientId}/{fulfilledId}": {
|
|
"delete": {
|
|
"tags": [
|
|
"Survey"
|
|
],
|
|
"operationId": "deleteDatatableEntries",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "surveyName",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "fulfilledId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/survey/register/{surveyName}/{apptable}": {
|
|
"put": {
|
|
"tags": [
|
|
"Survey"
|
|
],
|
|
"operationId": "register",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "surveyName",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "apptable",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/mixreport": {
|
|
"get": {
|
|
"tags": [
|
|
"Mix Report"
|
|
],
|
|
"operationId": "retrieveXBRLReport",
|
|
"produces": [
|
|
"application/xml"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "startDate",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"name": "endDate",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
{
|
|
"name": "currency",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/mixtaxonomy": {
|
|
"get": {
|
|
"tags": [
|
|
"Mix Taxonomy"
|
|
],
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/mixmapping": {
|
|
"get": {
|
|
"tags": [
|
|
"Mix Mapping"
|
|
],
|
|
"operationId": "retrieveTaxonomyMapping",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Mix Mapping"
|
|
],
|
|
"operationId": "updateTaxonomyMapping",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/holidays": {
|
|
"get": {
|
|
"tags": [
|
|
"Holidays"
|
|
],
|
|
"summary": "List Holidays",
|
|
"description": "Example Requests:\n\nholidays?officeId=1",
|
|
"operationId": "retrieveAllHolidays",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"description": "officeId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "fromDate",
|
|
"in": "query",
|
|
"description": "fromDate",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "toDate",
|
|
"in": "query",
|
|
"description": "toDate",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "locale",
|
|
"in": "query",
|
|
"description": "locale",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "query",
|
|
"description": "dateFormat",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetHolidaysResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Holidays"
|
|
],
|
|
"summary": "Create a Holiday",
|
|
"description": "Mandatory Fields: name, description, fromDate, toDate, repaymentsRescheduledTo, offices",
|
|
"operationId": "createNewHoliday",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostHolidaysRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostHolidaysResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/holidays/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Holidays"
|
|
],
|
|
"operationId": "retrieveRepaymentScheduleUpdationTyeOptions",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/holidays/{holidayId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Holidays"
|
|
],
|
|
"summary": "Retrieve a Holiday",
|
|
"description": "Example Requests:\n\nholidays/1",
|
|
"operationId": "retrieveOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "holidayId",
|
|
"in": "path",
|
|
"description": "holidayId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetHolidaysResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Holidays"
|
|
],
|
|
"summary": "Activate a Holiday",
|
|
"description": "Always Holidays are created in pending state. This API allows to activate a holiday.\n\nOnly the active holidays are considered for rescheduling the loan repayment.",
|
|
"operationId": "handleCommands",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "holidayId",
|
|
"in": "path",
|
|
"description": "holidayId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostHolidaysHolidayIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostHolidaysHolidayIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Holidays"
|
|
],
|
|
"summary": "Update a Holiday",
|
|
"description": "If a holiday is in pending state (created and not activated) then all fields are allowed to modify. Once holidays become active only name and descriptions are allowed to modify.",
|
|
"operationId": "update",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "holidayId",
|
|
"in": "path",
|
|
"description": "holidayId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutHolidaysHolidayIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutHolidaysHolidayIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Holidays"
|
|
],
|
|
"summary": "Delete a Holiday",
|
|
"description": "This API allows to delete a holiday. This is a soft delete the deleted holiday status is marked as deleted.",
|
|
"operationId": "delete",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "holidayId",
|
|
"in": "path",
|
|
"description": "holidayId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteHolidaysHolidayIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/currencies": {
|
|
"get": {
|
|
"tags": [
|
|
"Currency"
|
|
],
|
|
"summary": "Retrieve Currency Configuration",
|
|
"description": "Returns the list of currencies permitted for use AND the list of currencies not selected (but available for selection).\n\nExample Requests:\n\ncurrencies\n\n\ncurrencies?fields=selectedCurrencyOptions",
|
|
"operationId": "retrieveCurrencies",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetCurrenciesResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Currency"
|
|
],
|
|
"summary": "Update Currency Configuration",
|
|
"description": "Updates the list of currencies permitted for use.",
|
|
"operationId": "updateCurrencies",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutCurrenciesRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutCurrenciesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/officetransactions": {
|
|
"get": {
|
|
"tags": [
|
|
"officetransactions"
|
|
],
|
|
"operationId": "retrieveOfficeTransactions",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"officetransactions"
|
|
],
|
|
"operationId": "transferMoneyFrom",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/officetransactions/template": {
|
|
"get": {
|
|
"tags": [
|
|
"officetransactions"
|
|
],
|
|
"operationId": "newOfficeTransactionDetails",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/officetransactions/{transactionId}": {
|
|
"delete": {
|
|
"tags": [
|
|
"officetransactions"
|
|
],
|
|
"operationId": "delete",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "transactionId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/offices": {
|
|
"get": {
|
|
"tags": [
|
|
"Offices"
|
|
],
|
|
"summary": "List Offices",
|
|
"description": "Example Requests:\n\noffices\n\n\noffices?fields=id,name,openingDate",
|
|
"operationId": "retrieveOffices",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "includeAllOffices",
|
|
"in": "query",
|
|
"description": "includeAllOffices",
|
|
"required": false,
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"description": "orderBy",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "sortOrder",
|
|
"in": "query",
|
|
"description": "sortOrder",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetOfficesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Offices"
|
|
],
|
|
"summary": "Create an Office",
|
|
"description": "Mandatory Fields\nname, openingDate, parentId",
|
|
"operationId": "createOffice",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostOfficesRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostOfficesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/offices/{officeId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Offices"
|
|
],
|
|
"summary": "Retrieve an Office",
|
|
"description": "Example Requests:\n\noffices/1\n\n\noffices/1?template=true\n\n\noffices/1?fields=id,name,parentName",
|
|
"operationId": "retreiveOffice",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "officeId",
|
|
"in": "path",
|
|
"description": "officeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetOfficesResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Offices"
|
|
],
|
|
"summary": "Update Office",
|
|
"description": "",
|
|
"operationId": "updateOffice",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "officeId",
|
|
"in": "path",
|
|
"description": "officeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutOfficesOfficeIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutOfficesOfficeIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/offices/downloadtemplate": {
|
|
"get": {
|
|
"tags": [
|
|
"Offices"
|
|
],
|
|
"operationId": "getOfficeTemplate",
|
|
"produces": [
|
|
"application/vnd.ms-excel"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"default": {
|
|
"description": "successful operation"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/offices/uploadtemplate": {
|
|
"post": {
|
|
"tags": [
|
|
"Offices"
|
|
],
|
|
"operationId": "postOfficeTemplate",
|
|
"consumes": [
|
|
"multipart/form-data"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "file",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "file"
|
|
},
|
|
{
|
|
"name": "locale",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/offices/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Offices"
|
|
],
|
|
"summary": "Retrieve Office Details Template",
|
|
"description": "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:\n\nField Defaults\nAllowed Value Lists\nExample Request:\n\noffices/template",
|
|
"operationId": "retrieveOfficeTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetOfficesTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/provisioningcategory": {
|
|
"get": {
|
|
"tags": [
|
|
"Provisioning Category"
|
|
],
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Provisioning Category"
|
|
],
|
|
"operationId": "createProvisioningCategory",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/provisioningcategory/{categoryId}": {
|
|
"put": {
|
|
"tags": [
|
|
"Provisioning Category"
|
|
],
|
|
"operationId": "updateProvisioningCategory",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "categoryId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Provisioning Category"
|
|
],
|
|
"operationId": "deleteProvisioningCategory",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "categoryId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/provisioningcriteria/{criteriaId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Provisioning Criteria"
|
|
],
|
|
"summary": "Retrieves a Provisioning Criteria",
|
|
"description": "Retrieves a Provisioning Criteria",
|
|
"operationId": "retrieveProvisioningCriteria",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "criteriaId",
|
|
"in": "path",
|
|
"description": "criteriaId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetProvisioningCriteriaCriteriaIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Provisioning Criteria"
|
|
],
|
|
"summary": "Updates a new Provisioning Criteria",
|
|
"description": "Updates a new Provisioning Criteria\n\nOptional Fields\ncriteriaName, loanProducts, provisioningcriteria",
|
|
"operationId": "updateProvisioningCriteria",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "criteriaId",
|
|
"in": "path",
|
|
"description": "criteriaId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutProvisioningCriteriaRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutProvisioningCriteriaResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Provisioning Criteria"
|
|
],
|
|
"summary": "Deletes Provisioning Criteria",
|
|
"description": "Deletes Provisioning Criteria",
|
|
"operationId": "deleteProvisioningCriteria",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "criteriaId",
|
|
"in": "path",
|
|
"description": "criteriaId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteProvisioningCriteriaResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/provisioningcriteria": {
|
|
"get": {
|
|
"tags": [
|
|
"Provisioning Criteria"
|
|
],
|
|
"summary": "Retrieves all created Provisioning Criterias",
|
|
"description": "Retrieves all created Provisioning Criterias",
|
|
"operationId": "retrieveAllProvisioningCriterias",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetProvisioningCriteriaResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Provisioning Criteria"
|
|
],
|
|
"summary": "Create a new Provisioning Criteria",
|
|
"description": "Creates a new Provisioning Criteria\n\nMandatory Fields: \ncriteriaName\nprovisioningcriteria\n\nOptional Fields: \nloanProducts",
|
|
"operationId": "createProvisioningCriteria",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostProvisioningCriteriaRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostProvisioningCriteriaResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/provisioningcriteria/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Provisioning Criteria"
|
|
],
|
|
"operationId": "retrieveTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/staff": {
|
|
"get": {
|
|
"tags": [
|
|
"Staff"
|
|
],
|
|
"summary": "Retrieve Staff",
|
|
"description": "Returns the list of staff members.\n\nExample Requests:\n\nstaff\n\n\n\n\nRetrieve a Staff by status\n\nReturns the details of a Staff based on status.\n\nBy default it Returns all the ACTIVE Staff.\n\nIf status=INACTIVE, then it returns all INACTIVE Staff.\n\nand for status=ALL, it Returns both ACTIVE and INACTIVE Staff.\n\nExample Requests:\n\nstaff?status=active",
|
|
"operationId": "retrieveStaff",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "sqlSearch",
|
|
"in": "query",
|
|
"description": "sqlSearch",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"description": "officeId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "staffInOfficeHierarchy",
|
|
"in": "query",
|
|
"description": "staffInOfficeHierarchy",
|
|
"required": false,
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
{
|
|
"name": "loanOfficersOnly",
|
|
"in": "query",
|
|
"description": "loanOfficersOnly",
|
|
"required": false,
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
{
|
|
"name": "status",
|
|
"in": "query",
|
|
"description": "status",
|
|
"required": false,
|
|
"type": "string",
|
|
"default": "active"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "GET https://DomainName/api/v1/staff?status={ACTIVE|INACTIVE|ALL}",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetStaffResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Staff"
|
|
],
|
|
"summary": "Create a staff member",
|
|
"description": "Creates a staff member.\n\nMandatory Fields: \nofficeId, firstname, lastname\n\nOptional Fields: \nisLoanOfficer, isActive",
|
|
"operationId": "createStaff",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostStaffRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostStaffResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/staff/{staffId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Staff"
|
|
],
|
|
"summary": "Retrieve a Staff Member",
|
|
"description": "Returns the details of a Staff Member.\n\nExample Requests:\n\nstaff/1",
|
|
"operationId": "retreiveStaff",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "staffId",
|
|
"in": "path",
|
|
"description": "staffId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetStaffResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Staff"
|
|
],
|
|
"summary": "Update a Staff Member",
|
|
"description": "Updates the details of a staff member.",
|
|
"operationId": "updateStaff",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "staffId",
|
|
"in": "path",
|
|
"description": "staffId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutStaffRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutStaffResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/staff/downloadtemplate": {
|
|
"get": {
|
|
"tags": [
|
|
"Staff"
|
|
],
|
|
"operationId": "getStaffTemplate",
|
|
"produces": [
|
|
"application/vnd.ms-excel"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"default": {
|
|
"description": "successful operation"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/staff/uploadtemplate": {
|
|
"post": {
|
|
"tags": [
|
|
"Staff"
|
|
],
|
|
"operationId": "postStaffTemplate",
|
|
"consumes": [
|
|
"multipart/form-data"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "file",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "file"
|
|
},
|
|
{
|
|
"name": "locale",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/cashiers": {
|
|
"get": {
|
|
"tags": [
|
|
"cashiers"
|
|
],
|
|
"operationId": "getCashierData",
|
|
"consumes": [
|
|
"text/html",
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "tellerId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "staffId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "date",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/tellers": {
|
|
"get": {
|
|
"tags": [
|
|
"Teller Cash Management"
|
|
],
|
|
"summary": "List all tellers",
|
|
"description": "Retrieves list tellers",
|
|
"operationId": "getTellerData",
|
|
"consumes": [
|
|
"text/html",
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"description": "officeId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetTellersResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Teller Cash Management"
|
|
],
|
|
"summary": "Create teller",
|
|
"description": "Mandatory Fields\nTeller name, OfficeId, Description, Start Date, Status\nOptional Fields\nEnd Date",
|
|
"operationId": "createTeller",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostTellersRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostTellersResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/tellers/{tellerId}/cashiers": {
|
|
"get": {
|
|
"tags": [
|
|
"Teller Cash Management"
|
|
],
|
|
"summary": "List Cashiers",
|
|
"description": "",
|
|
"operationId": "getCashierData",
|
|
"consumes": [
|
|
"text/html",
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "tellerId",
|
|
"in": "path",
|
|
"description": "tellerId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "fromdate",
|
|
"in": "query",
|
|
"description": "fromdate",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "todate",
|
|
"in": "query",
|
|
"description": "todate",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetTellersTellerIdCashiersResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Teller Cash Management"
|
|
],
|
|
"summary": "Create Cashiers",
|
|
"description": "Mandatory Fields: \nCashier/staff, Fromm Date, To Date, Full Day or From time and To time\n\n\n\nOptional Fields: \nDescription/Notes",
|
|
"operationId": "createCashier",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "tellerId",
|
|
"in": "path",
|
|
"description": "tellerId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostTellersTellerIdCashiersRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostTellersTellerIdCashiersResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/tellers/{tellerId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Teller Cash Management"
|
|
],
|
|
"summary": "Retrieve tellers",
|
|
"description": "",
|
|
"operationId": "findTeller",
|
|
"consumes": [
|
|
"text/html",
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "tellerId",
|
|
"in": "path",
|
|
"description": "tellerId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetTellersResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Teller Cash Management"
|
|
],
|
|
"summary": "Update teller",
|
|
"description": "",
|
|
"operationId": "updateTeller",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "tellerId",
|
|
"in": "path",
|
|
"description": "tellerId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutTellersRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutTellersResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Teller Cash Management"
|
|
],
|
|
"operationId": "deleteTeller",
|
|
"consumes": [
|
|
"text/html",
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "tellerId",
|
|
"in": "path",
|
|
"description": "tellerId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/tellers/{tellerId}/cashiers/{cashierId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Teller Cash Management"
|
|
],
|
|
"summary": "Retrieve a cashier",
|
|
"description": "",
|
|
"operationId": "findCashierData",
|
|
"consumes": [
|
|
"text/html",
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "tellerId",
|
|
"in": "path",
|
|
"description": "tellerId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "cashierId",
|
|
"in": "path",
|
|
"description": "cashierId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetTellersTellerIdCashiersCashierIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Teller Cash Management"
|
|
],
|
|
"summary": "Update Cashier",
|
|
"description": "",
|
|
"operationId": "updateCashier",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "tellerId",
|
|
"in": "path",
|
|
"description": "tellerId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "cashierId",
|
|
"in": "path",
|
|
"description": "cashierId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutTellersTellerIdCashiersCashierIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutTellersTellerIdCashiersCashierIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Teller Cash Management"
|
|
],
|
|
"summary": "Delete Cashier",
|
|
"description": "",
|
|
"operationId": "deleteCashier",
|
|
"consumes": [
|
|
"text/html",
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "tellerId",
|
|
"in": "path",
|
|
"description": "tellerId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "cashierId",
|
|
"in": "path",
|
|
"description": "cashierId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteTellersTellerIdCashiersCashierIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/tellers/{tellerId}/cashiers/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Teller Cash Management"
|
|
],
|
|
"summary": "Find Cashiers",
|
|
"description": "",
|
|
"operationId": "getCashierTemplate",
|
|
"consumes": [
|
|
"text/html",
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "tellerId",
|
|
"in": "path",
|
|
"description": "tellerId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetTellersTellerIdCashiersTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/tellers/{tellerId}/cashiers/{cashierId}/allocate": {
|
|
"post": {
|
|
"tags": [
|
|
"Teller Cash Management"
|
|
],
|
|
"summary": "Allocate Cash To Cashier",
|
|
"description": "Mandatory Fields: \nDate, Amount, Currency, Notes/Comments",
|
|
"operationId": "allocateCashToCashier",
|
|
"consumes": [
|
|
"text/html",
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "tellerId",
|
|
"in": "path",
|
|
"description": "tellerId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "cashierId",
|
|
"in": "path",
|
|
"description": "cashierId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostTellersTellerIdCashiersCashierIdAllocateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostTellersTellerIdCashiersCashierIdAllocateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/tellers/{tellerId}/cashiers/{cashierId}/settle": {
|
|
"post": {
|
|
"tags": [
|
|
"Teller Cash Management"
|
|
],
|
|
"summary": "Settle Cash From Cashier",
|
|
"description": "Mandatory Fields\nDate, Amount, Currency, Notes/Comments",
|
|
"operationId": "settleCashFromCashier",
|
|
"consumes": [
|
|
"text/html",
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "tellerId",
|
|
"in": "path",
|
|
"description": "tellerId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "cashierId",
|
|
"in": "path",
|
|
"description": "cashierId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostTellersTellerIdCashiersCashierIdSettleRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostTellersTellerIdCashiersCashierIdSettleResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/tellers/{tellerId}/cashiers/{cashierId}/transactions": {
|
|
"get": {
|
|
"tags": [
|
|
"Teller Cash Management"
|
|
],
|
|
"summary": "Retrieve Cashier Transaction",
|
|
"description": "",
|
|
"operationId": "getTransactionsForCashier",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "tellerId",
|
|
"in": "path",
|
|
"description": "tellerId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "cashierId",
|
|
"in": "path",
|
|
"description": "cashierId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "currencyCode",
|
|
"in": "query",
|
|
"description": "currencyCode",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"description": "orderBy",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "sortOrder",
|
|
"in": "query",
|
|
"description": "sortOrder",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetTellersTellerIdCashiersCashiersIdTransactionsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/tellers/{tellerId}/cashiers/{cashierId}/summaryandtransactions": {
|
|
"get": {
|
|
"tags": [
|
|
"Teller Cash Management"
|
|
],
|
|
"summary": "Transactions Wtih Summary For Cashier",
|
|
"description": "",
|
|
"operationId": "getTransactionsWtihSummaryForCashier",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "tellerId",
|
|
"in": "path",
|
|
"description": "tellerId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "cashierId",
|
|
"in": "path",
|
|
"description": "cashierId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "currencyCode",
|
|
"in": "query",
|
|
"description": "currencyCode",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"description": "orderBy",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "sortOrder",
|
|
"in": "query",
|
|
"description": "sortOrder",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetTellersTellerIdCashiersCashiersIdSummaryAndTransactionsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/tellers/{tellerId}/cashiers/{cashierId}/transactions/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Teller Cash Management"
|
|
],
|
|
"summary": "Retrieve Cashier Transaction Template",
|
|
"description": "",
|
|
"operationId": "getCashierTxnTemplate",
|
|
"consumes": [
|
|
"text/html",
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "tellerId",
|
|
"in": "path",
|
|
"description": "tellerId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "cashierId",
|
|
"in": "path",
|
|
"description": "cashierId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetTellersTellerIdCashiersCashiersIdTransactionsTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/tellers/{tellerId}/transactions": {
|
|
"get": {
|
|
"tags": [
|
|
"Teller Cash Management"
|
|
],
|
|
"operationId": "getTransactionData",
|
|
"consumes": [
|
|
"text/html",
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "tellerId",
|
|
"in": "path",
|
|
"description": "tellerId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "dateRange",
|
|
"in": "query",
|
|
"description": "dateRange",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/tellers/{tellerId}/transactions/{transactionId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Teller Cash Management"
|
|
],
|
|
"operationId": "findTransactionData",
|
|
"consumes": [
|
|
"text/html",
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "tellerId",
|
|
"in": "path",
|
|
"description": "tellerId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "transactionId",
|
|
"in": "path",
|
|
"description": "transactionId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/tellers/{tellerId}/journals": {
|
|
"get": {
|
|
"tags": [
|
|
"Teller Cash Management"
|
|
],
|
|
"operationId": "getJournalData",
|
|
"consumes": [
|
|
"text/html",
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "tellerId",
|
|
"in": "path",
|
|
"description": "tellerId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "cashierId",
|
|
"in": "query",
|
|
"description": "cashierId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "dateRange",
|
|
"in": "query",
|
|
"description": "dateRange",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/cashiersjournal": {
|
|
"get": {
|
|
"tags": [
|
|
"cashiersjournal"
|
|
],
|
|
"operationId": "getJournalData",
|
|
"consumes": [
|
|
"text/html",
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "tellerId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "cashierId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "dateRange",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/workingdays/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Working days"
|
|
],
|
|
"summary": "Working Days Template",
|
|
"description": "This is a convenience resource. It can be useful when building maintenance user interface screens for working days.\n\nExample Request:\n\nworkingdays/template",
|
|
"operationId": "template",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetWorkingDaysTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/workingdays": {
|
|
"get": {
|
|
"tags": [
|
|
"Working days"
|
|
],
|
|
"summary": "List Working days",
|
|
"description": "Example Requests:\n\nworkingdays",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetWorkingDaysResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Working days"
|
|
],
|
|
"summary": "Update a Working Day",
|
|
"description": "Mandatory Fields\nrecurrence,repaymentRescheduleType,extendTermForDailyRepayments,locale",
|
|
"operationId": "update",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutWorkingDaysRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutWorkingDaysResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/accounttransfers/templateRefundByTransfer": {
|
|
"get": {
|
|
"tags": [
|
|
"Account Transfers"
|
|
],
|
|
"summary": "Retrieve Refund of an Active Loan by Transfer Template",
|
|
"description": "Retrieves Refund of an Active Loan by Transfer TemplateExample Requests :\n\n\n\naccounttransfers/templateRefundByTransfer?fromAccountId=2&fromAccountType=1& toAccountId=1&toAccountType=2&toClientId=1&toOfficeId=1",
|
|
"operationId": "templateRefundByTransfer",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "fromOfficeId",
|
|
"in": "query",
|
|
"description": "fromOfficeId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "fromClientId",
|
|
"in": "query",
|
|
"description": "fromClientId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "fromAccountId",
|
|
"in": "query",
|
|
"description": "fromAccountId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "fromAccountType",
|
|
"in": "query",
|
|
"description": "fromAccountType",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "toOfficeId",
|
|
"in": "query",
|
|
"description": "toOfficeId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "toClientId",
|
|
"in": "query",
|
|
"description": "toClientId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "toAccountId",
|
|
"in": "query",
|
|
"description": "toAccountId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "toAccountType",
|
|
"in": "query",
|
|
"description": "toAccountType",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetAccountTransfersTemplateRefundByTransferResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/accounttransfers/refundByTransfer": {
|
|
"post": {
|
|
"tags": [
|
|
"Account Transfers"
|
|
],
|
|
"summary": "Refund of an Active Loan by Transfer",
|
|
"description": "Ability to refund an active loan by transferring to a savings account.",
|
|
"operationId": "templateRefundByTransferPost",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostAccountTransfersRefundByTransferRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostAccountTransfersRefundByTransferResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/accounttransfers/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Account Transfers"
|
|
],
|
|
"summary": "Retrieve Account Transfer Template",
|
|
"description": "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:\n\n\n\nField Defaults\n\nAllowed Value Lists\n\nExample Requests:\n\n\n\naccounttransfers/template?fromAccountType=2&fromOfficeId=1\n\n\n\naccounttransfers/template?fromAccountType=2&fromOfficeId=1&fromClientId=1\n\n\n\naccounttransfers/template?fromClientId=1&fromAccountType=2&fromAccountId=1",
|
|
"operationId": "template",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "fromOfficeId",
|
|
"in": "query",
|
|
"description": "fromOfficeId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "fromClientId",
|
|
"in": "query",
|
|
"description": "fromClientId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "fromAccountId",
|
|
"in": "query",
|
|
"description": "fromAccountId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "fromAccountType",
|
|
"in": "query",
|
|
"description": "fromAccountType",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "toOfficeId",
|
|
"in": "query",
|
|
"description": "toOfficeId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "toClientId",
|
|
"in": "query",
|
|
"description": "toClientId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "toAccountId",
|
|
"in": "query",
|
|
"description": "toAccountId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "toAccountType",
|
|
"in": "query",
|
|
"description": "toAccountType",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetAccountTransfersTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/accounttransfers": {
|
|
"get": {
|
|
"tags": [
|
|
"Account Transfers"
|
|
],
|
|
"summary": "List account transfers",
|
|
"description": "Lists account's transfers\n\nExample Requests:\n\n\n\naccounttransfers",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "sqlSearch",
|
|
"in": "query",
|
|
"description": "sqlSearch",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "externalId",
|
|
"in": "query",
|
|
"description": "externalId",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"x-example": "limit"
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"description": "orderBy",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "sortOrder",
|
|
"in": "query",
|
|
"description": "sortOrder",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "accountDetailId",
|
|
"in": "query",
|
|
"description": "accountDetailId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetAccountTransfersResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Account Transfers"
|
|
],
|
|
"summary": "Create new Transfer",
|
|
"description": "Ability to create new transfer of monetary funds from one account to another.",
|
|
"operationId": "create",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostAccountTransfersRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostAccountTransfersResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/accounttransfers/{transferId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Account Transfers"
|
|
],
|
|
"summary": "Retrieve account transfer",
|
|
"description": "Retrieves account transfer\n\nExample Requests :\n\n\n\naccounttransfers/1",
|
|
"operationId": "retrieveOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "transferId",
|
|
"in": "path",
|
|
"description": "transferId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetAccountTransfersPageItems"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/standinginstructions/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Standing Instructions"
|
|
],
|
|
"summary": "Retrieve Standing Instruction Template",
|
|
"description": "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:\n\nField Defaults\nAllowed Value Lists\nExample Requests:\n\nstandinginstructions/template?fromAccountType=2&fromOfficeId=1\n\nstandinginstructions/template?fromAccountType=2&fromOfficeId=1&fromClientId=1&transferType=1\n\nstandinginstructions/template?fromClientId=1&fromAccountType=2&fromAccountId=1&transferType=1",
|
|
"operationId": "template",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "fromOfficeId",
|
|
"in": "query",
|
|
"description": "fromOfficeId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "fromClientId",
|
|
"in": "query",
|
|
"description": "fromClientId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "fromAccountId",
|
|
"in": "query",
|
|
"description": "fromAccountId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "fromAccountType",
|
|
"in": "query",
|
|
"description": "fromAccountType",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "toOfficeId",
|
|
"in": "query",
|
|
"description": "toOfficeId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "toClientId",
|
|
"in": "query",
|
|
"description": "toClientId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "toAccountId",
|
|
"in": "query",
|
|
"description": "toAccountId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "toAccountType",
|
|
"in": "query",
|
|
"description": "toAccountType",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "transferType",
|
|
"in": "query",
|
|
"description": "transferType",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetStandingInstructionsTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/standinginstructions": {
|
|
"get": {
|
|
"tags": [
|
|
"Standing Instructions"
|
|
],
|
|
"summary": "List Standing Instructions",
|
|
"description": "Example Requests:\n\nstandinginstructions",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "sqlSearch",
|
|
"in": "query",
|
|
"description": "sqlSearch",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "externalId",
|
|
"in": "query",
|
|
"description": "externalId",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"description": "orderBy",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "sortOrder",
|
|
"in": "query",
|
|
"description": "sortOrder",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "transferType",
|
|
"in": "query",
|
|
"description": "transferType",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "clientName",
|
|
"in": "query",
|
|
"description": "clientName",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "clientId",
|
|
"in": "query",
|
|
"description": "clientId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "fromAccountId",
|
|
"in": "query",
|
|
"description": "fromAccountId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "fromAccountType",
|
|
"in": "query",
|
|
"description": "fromAccountType",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetStandingInstructionsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Standing Instructions"
|
|
],
|
|
"summary": "Create new Standing Instruction",
|
|
"description": "Ability to create new instruction for transfer of monetary funds from one account to another",
|
|
"operationId": "create",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostStandingInstructionsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostStandingInstructionsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/standinginstructions/{standingInstructionId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Standing Instructions"
|
|
],
|
|
"summary": "Retrieve Standing Instruction",
|
|
"description": "Example Requests :\n\nstandinginstructions/1",
|
|
"operationId": "retrieveOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "standingInstructionId",
|
|
"in": "path",
|
|
"description": "standingInstructionId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "sqlSearch",
|
|
"in": "query",
|
|
"description": "sqlSearch",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "externalId",
|
|
"in": "query",
|
|
"description": "externalId",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"description": "orderBy",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "sortOrder",
|
|
"in": "query",
|
|
"description": "sortOrder",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetStandingInstructionsStandingInstructionIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Standing Instructions"
|
|
],
|
|
"summary": "Update Standing Instruction | Delete Standing Instruction",
|
|
"description": "Ability to modify existing instruction for transfer of monetary funds from one account to another.\n\nPUT https://DomainName/api/v1/standinginstructions/1?command=update\n\n\nAbility to modify existing instruction for transfer of monetary funds from one account to another.\n\nPUT https://DomainName/api/v1/standinginstructions/1?command=delete",
|
|
"operationId": "update",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "standingInstructionId",
|
|
"in": "path",
|
|
"description": "standingInstructionId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutStandingInstructionsStandingInstructionIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutStandingInstructionsStandingInstructionIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/standinginstructionrunhistory": {
|
|
"get": {
|
|
"tags": [
|
|
"Standing Instructions History"
|
|
],
|
|
"summary": "Standing Instructions Logged History",
|
|
"description": "The list capability of history can support pagination and sorting \n\nExample Requests :\n\nstandinginstructionrunhistory\n\nstandinginstructionrunhistory?orderBy=name&sortOrder=DESC\n\nstandinginstructionrunhistory?offset=10&limit=50",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "sqlSearch",
|
|
"in": "query",
|
|
"description": "sqlSearch",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "externalId",
|
|
"in": "query",
|
|
"description": "externalId",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"description": "orderBy",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "sortOrder",
|
|
"in": "query",
|
|
"description": "sortOrder",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "transferType",
|
|
"in": "query",
|
|
"description": "transferType",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "clientName",
|
|
"in": "query",
|
|
"description": "clientName",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "clientId",
|
|
"in": "query",
|
|
"description": "clientId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "fromAccountId",
|
|
"in": "query",
|
|
"description": "fromAccountId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "fromAccountType",
|
|
"in": "query",
|
|
"description": "fromAccountType",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "locale",
|
|
"in": "query",
|
|
"description": "locale",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "query",
|
|
"description": "dateFormat",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "fromDate",
|
|
"in": "query",
|
|
"description": "fromDate",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "toDate",
|
|
"in": "query",
|
|
"description": "toDate",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetStandingInstructionRunHistoryResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/accounts/{type}/{accountId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Share Account"
|
|
],
|
|
"summary": "Retrieve a share application/account",
|
|
"description": "Retrieves a share application/account\n\nExample Requests :\n\nshareaccount/1",
|
|
"operationId": "retrieveAccount",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountId",
|
|
"in": "path",
|
|
"description": "accountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "type",
|
|
"in": "path",
|
|
"description": "type",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetAccountsTypeAccountIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Share Account"
|
|
],
|
|
"summary": "Approve share application | Undo approval share application | Reject share application | Activate a share account | Close a share account | Apply additional shares on a share account | Approve additional shares request on a share account | Reject additional shares request on a share account | Redeem shares on a share account",
|
|
"description": "Approve share application:\n\nApproves share application so long as its in 'Submitted and pending approval' state.\n\nUndo approval share application:\n\nWill move 'approved' share application back to 'Submitted and pending approval' state.\n\nReject share application:\n\nRejects share application so long as its in 'Submitted and pending approval' state.\n\nActivate a share account:\n\nResults in an approved share application being converted into an 'active' share account.\n\nClose a share account:\n\nResults in an Activated share application being converted into an 'closed' share account.\n\nclosedDate is closure date of share account\n\nMandatory Fields: dateFormat,locale,closedDate\n\nApply additional shares on a share account:\n\nrequestedDate is requsted date of share purchase\n\nrequestedShares is number of shares to be purchase\n\nMandatory Fields: dateFormat,locale,requestedDate, requestedShares\n\nApprove additional shares request on a share account\n\nrequestedShares is Share purchase transaction ids\n\nMandatory Fields: requestedShares\n\nReject additional shares request on a share account:\n\nrequestedShares is Share purchase transaction ids\n\nMandatory Fields: requestedShares\n\nRedeem shares on a share account:\n\nResults redeem some/all shares from share account.\n\nrequestedDate is requsted date of shares redeem\n\nrequestedShares is number of shares to be redeemed\n\nMandatory Fields: dateFormat,locale,requestedDate,requestedShares\n\nShowing request/response for 'Reject additional shares request on a share account'\n\nFor more info visit this link - https://demo.openmf.org/api-docs/apiLive.htm#shareaccounts",
|
|
"operationId": "handleCommands",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "type",
|
|
"in": "path",
|
|
"description": "type",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "accountId",
|
|
"in": "path",
|
|
"description": "accountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostAccountsTypeAccountIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostAccountsTypeAccountIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Share Account"
|
|
],
|
|
"summary": "Modify a share application",
|
|
"description": "Share application can only be modified when in 'Submitted and pending approval' state. Once the application is approved, the details cannot be changed using this method. Specific api endpoints will be created to allow change of interest detail such as rate, compounding period, posting period etc",
|
|
"operationId": "updateAccount",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "type",
|
|
"in": "path",
|
|
"description": "type",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "accountId",
|
|
"in": "path",
|
|
"description": "accountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutAccountsTypeAccountIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutAccountsTypeAccountIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/accounts/{type}": {
|
|
"get": {
|
|
"tags": [
|
|
"Share Account"
|
|
],
|
|
"summary": "List share applications/accounts",
|
|
"description": "Lists share applications/accounts\n\nExample Requests:\n\nshareaccount",
|
|
"operationId": "retrieveAllAccounts",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "type",
|
|
"in": "path",
|
|
"description": "type",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetAccountsTypeResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Share Account"
|
|
],
|
|
"summary": "Submit new share application",
|
|
"description": "Submits new share application\n\nMandatory Fields: clientId, productId, submittedDate, savingsAccountId, requestedShares, applicationDate\n\nOptional Fields: accountNo, externalId\n\nInherited from Product (if not provided): minimumActivePeriod, minimumActivePeriodFrequencyType, lockinPeriodFrequency, lockinPeriodFrequencyType",
|
|
"operationId": "createAccount",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "type",
|
|
"in": "path",
|
|
"description": "type",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostAccountsTypeRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostAccountsTypeResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/accounts/{type}/downloadtemplate": {
|
|
"get": {
|
|
"tags": [
|
|
"Share Account"
|
|
],
|
|
"operationId": "getSharedAccountsTemplate",
|
|
"produces": [
|
|
"application/vnd.ms-excel"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"default": {
|
|
"description": "successful operation"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/accounts/{type}/uploadtemplate": {
|
|
"post": {
|
|
"tags": [
|
|
"Share Account"
|
|
],
|
|
"operationId": "postSharedAccountsTemplate",
|
|
"consumes": [
|
|
"multipart/form-data"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "file",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "file"
|
|
},
|
|
{
|
|
"name": "locale",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/accounts/{type}/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Share Account"
|
|
],
|
|
"summary": "Retrieve Share Account Template",
|
|
"description": "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:\n\nField Defaults\nAllowed Value Lists\n\nExample Requests:\n\naccounts/share/template?clientId=1\n\n\naccounts/share/template?clientId=1&productId=1",
|
|
"operationId": "template",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "type",
|
|
"in": "path",
|
|
"description": "type",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "clientId",
|
|
"in": "query",
|
|
"description": "clientId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "productId",
|
|
"in": "query",
|
|
"description": "productId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetAccountsTypeTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/fieldconfiguration/{entity}": {
|
|
"get": {
|
|
"tags": [
|
|
"Entity Field Configuration"
|
|
],
|
|
"summary": "Retrieves the Entity Field Configuration",
|
|
"description": "It retrieves all the Entity Field Configuration",
|
|
"operationId": "getAddresses",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "entity",
|
|
"in": "path",
|
|
"description": "entity",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetFieldConfigurationEntityResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/charges": {
|
|
"get": {
|
|
"tags": [
|
|
"Charges"
|
|
],
|
|
"summary": "Retrieve Charges",
|
|
"description": "Returns the list of defined charges.\n\nExample Requests:\n\ncharges",
|
|
"operationId": "retrieveAllCharges",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetChargesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Charges"
|
|
],
|
|
"summary": "Create/Define a Charge",
|
|
"description": "Define a new charge that can later be associated with loans and savings through their respective product definitions or directly on each account instance.",
|
|
"operationId": "createCharge",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostChargesRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostChargesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/charges/{chargeId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Charges"
|
|
],
|
|
"summary": "Retrieve a Charge",
|
|
"description": "Returns the details of a defined Charge.\n\nExample Requests:\n\ncharges/1",
|
|
"operationId": "retrieveCharge",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "chargeId",
|
|
"in": "path",
|
|
"description": "chargeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetChargesResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Charges"
|
|
],
|
|
"summary": "Update a Charge",
|
|
"description": "Updates the details of a Charge.",
|
|
"operationId": "updateCharge",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "chargeId",
|
|
"in": "path",
|
|
"description": "chargeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutChargesChargeIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutChargesChargeIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Charges"
|
|
],
|
|
"summary": "Delete a Charge",
|
|
"description": "Deletes a Charge.",
|
|
"operationId": "deleteCharge",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "chargeId",
|
|
"in": "path",
|
|
"description": "chargeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteChargesChargeIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/charges/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Charges"
|
|
],
|
|
"summary": "Retrieve Charge Template",
|
|
"description": "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:\n\nField Defaults\nAllowed Value Lists\nExample Request:\n\ncharges/template\n",
|
|
"operationId": "retrieveNewChargeDetails",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetChargesTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/client/{clientid}/addresses": {
|
|
"get": {
|
|
"tags": [
|
|
"Clients Address"
|
|
],
|
|
"summary": "List all addresses for a Client",
|
|
"description": "Example Requests:\n\nclient/1/addresses\n\n\nclients/1/addresses?status=false,true&&type=1,2,3",
|
|
"operationId": "getAddresses",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "status",
|
|
"in": "query",
|
|
"description": "status",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "type",
|
|
"in": "query",
|
|
"description": "type",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "clientid",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetClientClientIdAddressesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Clients Address"
|
|
],
|
|
"summary": "Create an address for a Client",
|
|
"description": "Mandatory Fields : \ntype and clientId",
|
|
"operationId": "AddClientAddress",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "type",
|
|
"in": "query",
|
|
"description": "type",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "clientid",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostClientClientIdAddressesRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostClientClientIdAddressesResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Clients Address"
|
|
],
|
|
"summary": "Update an address for a Client",
|
|
"description": "All the address fields can be updated by using update client address API\n\nMandatory Fields\ntype and addressId",
|
|
"operationId": "UpdateClientAddress",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientid",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutClientClientIdAddressesRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutClientClientIdAddressesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/client/addresses/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Clients Address"
|
|
],
|
|
"operationId": "getAddressesTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/{clientId}/charges": {
|
|
"get": {
|
|
"tags": [
|
|
"Client Charges"
|
|
],
|
|
"summary": "List Client Charges",
|
|
"description": "The list capability of client charges supports pagination.Example Requests:\nclients/1/charges\n\nclients/1/charges?offset=0&limit=5",
|
|
"operationId": "retrieveAllClientCharges",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "chargeStatus",
|
|
"in": "query",
|
|
"description": "chargeStatus",
|
|
"required": false,
|
|
"type": "string",
|
|
"default": "all"
|
|
},
|
|
{
|
|
"name": "pendingPayment",
|
|
"in": "query",
|
|
"description": "pendingPayment",
|
|
"required": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetClientsClientIdChargesResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Client Charges"
|
|
],
|
|
"summary": "Add Client Charge",
|
|
"description": " This API associates a Client charge with an implicit Client account\nMandatory Fields : \nchargeId and dueDate \nOptional Fields : \namount",
|
|
"operationId": "applyClientCharge",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostClientsClientIdChargesRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostClientsClientIdChargesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/{clientId}/charges/{chargeId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Client Charges"
|
|
],
|
|
"summary": "Retrieve a Client Charge",
|
|
"description": "Example Requests:\nclients/1/charges/1\n\n\nclients/1/charges/1?fields=name,id",
|
|
"operationId": "retrieveClientCharge",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "chargeId",
|
|
"in": "path",
|
|
"description": "chargeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetClientsChargesPageItems"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Client Charges"
|
|
],
|
|
"summary": "Pay a Client Charge | Waive a Client Charge",
|
|
"description": "Pay a Client Charge:\n\nMandatory Fields:transactionDate and amount \"Pay either a part of or the entire due amount for a charge.(command=paycharge)\n\nWaive a Client Charge:\n\n\nThis API provides the facility of waiving off the remaining amount on a client charge (command=waive)\n\nShowing request/response for 'Pay a Client Charge'",
|
|
"operationId": "payOrWaiveClientCharge",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "chargeId",
|
|
"in": "path",
|
|
"description": "chargeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostClientsClientIdChargesChargeIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostClientsClientIdChargesChargeIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Client Charges"
|
|
],
|
|
"summary": "Delete a Client Charge",
|
|
"description": "Deletes a Client Charge on which no transactions have taken place (either payments or waivers). ",
|
|
"operationId": "deleteClientCharge",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "chargeId",
|
|
"in": "path",
|
|
"description": "chargeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteClientsClientIdChargesChargeIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/{clientId}/charges/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Client Charges"
|
|
],
|
|
"operationId": "retrieveTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/{clientId}/identifiers": {
|
|
"get": {
|
|
"tags": [
|
|
"Client Identifier"
|
|
],
|
|
"summary": "List all Identifiers for a Client",
|
|
"description": "Example Requests:\nclients/1/identifiers\n\n\nclients/1/identifiers?fields=documentKey,documentType,description",
|
|
"operationId": "retrieveAllClientIdentifiers",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetClientsClientIdIdentifiersResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Client Identifier"
|
|
],
|
|
"summary": "Create an Identifier for a Client",
|
|
"description": "Mandatory Fields\ndocumentKey, documentTypeId ",
|
|
"operationId": "createClientIdentifier",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostClientsClientIdIdentifiersRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostClientsClientIdIdentifiersResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/{clientId}/identifiers/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Client Identifier"
|
|
],
|
|
"summary": "Retrieve Client Identifier Details Template",
|
|
"description": "This is a convenience resource useful for building maintenance user interface screens for client applications. The template data returned consists of any or all of:\n\n Field Defaults\n Allowed Value Lists\n\n\nExample Request:\nclients/1/identifiers/template",
|
|
"operationId": "newClientIdentifierDetails",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetClientsClientIdIdentifiersTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/{clientId}/identifiers/{identifierId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Client Identifier"
|
|
],
|
|
"summary": "Retrieve a Client Identifier",
|
|
"description": "Example Requests:\nclients/1/identifier/2\n\n\nclients/1/identifier/2?template=true\n\nclients/1/identifiers/2?fields=documentKey,documentType,description",
|
|
"operationId": "retrieveClientIdentifiers",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "identifierId",
|
|
"in": "path",
|
|
"description": "identifierId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetClientsClientIdIdentifiersResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Client Identifier"
|
|
],
|
|
"summary": "Update a Client Identifier",
|
|
"description": "Updates a Client Identifier",
|
|
"operationId": "updateClientIdentifer",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "identifierId",
|
|
"in": "path",
|
|
"description": "identifierId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutClientsClientIdIdentifiersIdentifierIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutClientsClientIdIdentifiersIdentifierIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Client Identifier"
|
|
],
|
|
"summary": "Delete a Client Identifier",
|
|
"description": "Deletes a Client Identifier",
|
|
"operationId": "deleteClientIdentifier",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "identifierId",
|
|
"in": "path",
|
|
"description": "identifierId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteClientsClientIdIdentifiersIdentifierIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/{clientId}/transactions": {
|
|
"get": {
|
|
"tags": [
|
|
"Client Transaction"
|
|
],
|
|
"summary": "List Client Transactions",
|
|
"description": "The list capability of client transaction can support pagination.\n\nExample Requests:\n\nclients/189/transactions\n\nclients/189/transactions?offset=10&limit=50",
|
|
"operationId": "retrieveAllClientTransactions",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetClientsClientIdTransactionsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/{clientId}/transactions/{transactionId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Client Transaction"
|
|
],
|
|
"summary": "Retrieve a Client Transaction",
|
|
"description": "Example Requests:\nclients/1/transactions/1\n\n\nclients/1/transactions/1?fields=id,officeName",
|
|
"operationId": "retrieveClientTransaction",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "transactionId",
|
|
"in": "path",
|
|
"description": "transactionId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetClientsClientIdTransactionsTransactionIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Client Transaction"
|
|
],
|
|
"summary": "Undo a Client Transaction",
|
|
"description": "Undoes a Client Transaction",
|
|
"operationId": "undoClientTransaction",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "transactionId",
|
|
"in": "path",
|
|
"description": "transactionId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostClientsClientIdTransactionsTransactionIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/{clientId}/accounts": {
|
|
"get": {
|
|
"tags": [
|
|
"Client"
|
|
],
|
|
"summary": "Retrieve client accounts overview",
|
|
"description": "An example of how a loan portfolio summary can be provided. This is requested in a specific use case of the community application.\nIt is quite reasonable to add resources like this to simplify User Interface development.\n\nExample Requests:\n \nclients/1/accounts\n\nclients/1/accounts?fields=loanAccounts,savingsAccounts",
|
|
"operationId": "retrieveAssociatedAccounts",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetClientsClientIdAccountsResponse"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/downloadtemplate": {
|
|
"get": {
|
|
"tags": [
|
|
"Client"
|
|
],
|
|
"operationId": "getClientTemplate",
|
|
"produces": [
|
|
"application/vnd.ms-excel"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "legalFormType",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "staffId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"default": {
|
|
"description": "successful operation"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/uploadtemplate": {
|
|
"post": {
|
|
"tags": [
|
|
"Client"
|
|
],
|
|
"operationId": "postClientTemplate",
|
|
"consumes": [
|
|
"multipart/form-data"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "legalFormType",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "file",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "file"
|
|
},
|
|
{
|
|
"name": "locale",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/{clientId}/obligeedetails": {
|
|
"get": {
|
|
"tags": [
|
|
"Client"
|
|
],
|
|
"operationId": "retrieveObligeeDetails",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/{clientId}/transferproposaldate": {
|
|
"get": {
|
|
"tags": [
|
|
"Client"
|
|
],
|
|
"operationId": "retrieveTransferTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Client"
|
|
],
|
|
"summary": "Retrieve Client Details Template",
|
|
"description": "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:\n\nField Defaults\nAllowed Value Lists\n\nExample Request:\n\nclients/template",
|
|
"operationId": "retrieveTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"description": "officeId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "commandParam",
|
|
"in": "query",
|
|
"description": "commandParam",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "staffInSelectedOfficeOnly",
|
|
"in": "query",
|
|
"description": "staffInSelectedOfficeOnly",
|
|
"required": false,
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetClientsTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients": {
|
|
"get": {
|
|
"tags": [
|
|
"Client"
|
|
],
|
|
"summary": "List Clients",
|
|
"description": "The list capability of clients can support pagination and sorting.\n\nExample Requests:\n\nclients\n\nclients?fields=displayName,officeName,timeline\n\nclients?offset=10&limit=50\n\nclients?orderBy=displayName&sortOrder=DESC",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "sqlSearch",
|
|
"in": "query",
|
|
"description": "sqlSearch",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"description": "officeId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "externalId",
|
|
"in": "query",
|
|
"description": "externalId",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "displayName",
|
|
"in": "query",
|
|
"description": "displayName",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "firstName",
|
|
"in": "query",
|
|
"description": "firstName",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "lastName",
|
|
"in": "query",
|
|
"description": "lastName",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "underHierarchy",
|
|
"in": "query",
|
|
"description": "underHierarchy",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"description": "orderBy",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "sortOrder",
|
|
"in": "query",
|
|
"description": "sortOrder",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "orphansOnly",
|
|
"in": "query",
|
|
"description": "orphansOnly",
|
|
"required": false,
|
|
"type": "boolean"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetClientsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Client"
|
|
],
|
|
"summary": "Create a Client",
|
|
"description": "Note:\n\n1. You can enter either:firstname/middlename/lastname - for a person (middlename is optional) OR fullname - for a business or organisation (or person known by one name).\n\n2.If address is enable(enable-address=true), then additional field called address has to be passed.\n\nMandatory Fields: firstname and lastname OR fullname, officeId, active=true and activationDate OR active=false, if(address enabled) address\n\nOptional Fields: groupId, externalId, accountNo, staffId, mobileNo, savingsProductId, genderId, clientTypeId, clientClassificationId",
|
|
"operationId": "create",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostClientsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostClientsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/{clientId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Client"
|
|
],
|
|
"summary": "Retrieve a Client",
|
|
"description": "Example Requests:\n\nclients/1\n\n\nclients/1?template=true\n\n\nclients/1?fields=id,displayName,officeName",
|
|
"operationId": "retrieveOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "staffInSelectedOfficeOnly",
|
|
"in": "query",
|
|
"description": "staffInSelectedOfficeOnly",
|
|
"required": false,
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetClientsClientIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Client"
|
|
],
|
|
"summary": "Activate a Client | Close a Client | Reject a Client | Withdraw a Client | Reactivate a Client | UndoReject a Client | UndoWithdraw a Client | Assign a Staff | Unassign a Staff | Update Default Savings Account | Propose a Client Transfer | Withdraw a Client Transfer | Reject a Client Transfer | Accept a Client Transfer | Propose and Accept a Client Transfer",
|
|
"description": "Activate a Client:\n\nClients can be created in a Pending state. This API exists to enable client activation (for when a client becomes an approved member of the financial Institution).\n\nIf the client happens to be already active this API will result in an error.\n\nClose a Client:\n\nClients can be closed if they do not have any non-closed loans/savingsAccount. This API exists to close a client .\n\nIf the client have any active loans/savingsAccount this API will result in an error.\n\nReject a Client:\n\nClients can be rejected when client is in pending for activation status.\n\nIf the client is any other status, this API throws an error.\n\nMandatory Fields: rejectionDate, rejectionReasonId\n\nWithdraw a Client:\n\nClient applications can be withdrawn when client is in a pending for activation status.\n\nIf the client is any other status, this API throws an error.\n\nMandatory Fields: withdrawalDate, withdrawalReasonId\n\nReactivate a Client: Clients can be reactivated after they have been closed.\n\nTrying to reactivate a client in any other state throws an error.\n\nMandatory Fields: reactivationDate\n\nUndoReject a Client:\n\nClients can be reactivated after they have been rejected.\n\nTrying to reactivate a client in any other state throws an error.\n\nMandatory Fields: reopenedDateUndoWithdraw a Client:\n\nClients can be reactivated after they have been withdrawn.\n\nTrying to reactivate a client in any other state throws an error.\n\nMandatory Fields: reopenedDate\n\nAssign a Staff:\n\nAllows you to assign a Staff for existed Client.\n\nThe selected Staff should belong to the same office (or an officer higher up in the hierarchy) as the Client he manages.\n\nUnassign a Staff:\n\nAllows you to unassign the Staff assigned to a Client.\n\nUpdate Default Savings Account:\n\nAllows you to modify or assign a default savings account for an existing Client.\n\nThe selected savings account should be one among the existing savings account for a particular customer.\n\nPropose a Client Transfer:\n\nAllows you to propose the transfer of a Client to a different Office.\n\nWithdraw a Client Transfer:\n\nAllows you to withdraw the proposed transfer of a Client to a different Office.\n\nWithdrawal can happen only if the destination Branch (to which the transfer was proposed) has not already accepted the transfer proposal\n\nReject a Client Transfer:\n\nAllows the Destination Branch to reject the proposed Client Transfer.\n\nAccept a Client Transfer:\n\nAllows the Destination Branch to accept the proposed Client Transfer.\n\nThe destination branch may also choose to link this client to a group (in which case, any existing active JLG loan of the client is rescheduled to match the meeting frequency of the group) and loan Officer at the time of accepting the transfer\n\nPropose and Accept a Client Transfer:\n\nAbstraction over the Propose and Accept Client Transfer API's which enable a user with Data Scope over both the Target and Destination Branches to directly transfer a Client to the destination Office.\n\nShowing request/response for 'Reject a Client Transfer'",
|
|
"operationId": "activate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostClientsClientIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostClientsClientIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Client"
|
|
],
|
|
"summary": "Update a Client",
|
|
"description": "Note: You can update any of the basic attributes of a client (but not its associations) using this API.\n\nChanging the relationship between a client and its office is not supported through this API. An API specific to handling transfers of clients between offices is available for the same.\n\nThe relationship between a client and a group must be removed through the Groups API.",
|
|
"operationId": "update",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutClientsClientIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutClientsClientIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Client"
|
|
],
|
|
"summary": "Delete a Client",
|
|
"description": "If a client is in Pending state, you are allowed to Delete it. The delete is a 'hard delete' and cannot be recovered from. Once clients become active or have loans or savings associated with them, you cannot delete the client but you may Close the client if they have left the program.",
|
|
"operationId": "delete",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteClientsClientIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteClientsClientIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/loans/{loanId}/collaterals/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Loan Collateral"
|
|
],
|
|
"summary": "Retrieve Collateral Details Template",
|
|
"description": "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:\n\nField Defaults\nAllowed Value Lists\nExample Request:\n\nloans/1/collaterals/template",
|
|
"operationId": "newCollateralTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetLoansLoanIdCollateralsTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/loans/{loanId}/collaterals": {
|
|
"get": {
|
|
"tags": [
|
|
"Loan Collateral"
|
|
],
|
|
"summary": "List Loan Collaterals",
|
|
"description": "Example Requests:\n\nloans/1/collaterals\n\n\nloans/1/collaterals?fields=value,description",
|
|
"operationId": "retrieveCollateralDetails",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoansLoanIdCollateralsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Loan Collateral"
|
|
],
|
|
"summary": "Create a Collateral",
|
|
"description": "Note: Currently, Collaterals may be added only before a Loan is approved",
|
|
"operationId": "createCollateral",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostLoansLoanIdCollateralsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostLoansLoanIdCollateralsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/loans/{loanId}/collaterals/{collateralId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Loan Collateral"
|
|
],
|
|
"summary": "Retrieve a Collateral",
|
|
"description": "Example Requests:\n\n/loans/1/collaterals/1\n\n\n/loans/1/collaterals/1?fields=value,description",
|
|
"operationId": "retrieveCollateralDetails",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "collateralId",
|
|
"in": "path",
|
|
"description": "collateralId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetLoansLoanIdCollateralsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Loan Collateral"
|
|
],
|
|
"summary": "Update a Collateral",
|
|
"description": "",
|
|
"operationId": "updateCollateral",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "collateralId",
|
|
"in": "path",
|
|
"description": "collateralId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutLoansLoandIdCollateralsCollateralIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutLoansLoanIdCollateralsCollateralIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Loan Collateral"
|
|
],
|
|
"summary": "Remove a Collateral",
|
|
"description": "Note: A collateral can only be removed from Loans that are not yet approved.",
|
|
"operationId": "deleteCollateral",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "collateralId",
|
|
"in": "path",
|
|
"description": "collateralId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteLoansLoanIdCollateralsCollateralIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/collectionsheet": {
|
|
"post": {
|
|
"tags": [
|
|
"Collection Sheet"
|
|
],
|
|
"summary": "Generate Individual Collection Sheet | Save Collection Sheet",
|
|
"description": "Generate Individual Collection Sheet:\n\nThis Api retrieves repayment details of all individual loans under a office as on a specified meeting date.\n\nSave Collection Sheet:\n\nThis Api allows the loan officer to perform bulk repayments of individual loans and deposit of mandatory savings on a given meeting date.",
|
|
"operationId": "generateCollectionSheet",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostCollectionSheetRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostCollectionSheetResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/floatingrates": {
|
|
"get": {
|
|
"tags": [
|
|
"Floating Rates"
|
|
],
|
|
"summary": "List Floating Rates",
|
|
"description": "Lists Floating Rates",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetFloatingRatesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Floating Rates"
|
|
],
|
|
"summary": "Create a new Floating Rate",
|
|
"description": "Creates a new Floating Rate\nMandatory Fields: name\nOptional Fields: isBaseLendingRate, isActive, ratePeriods",
|
|
"operationId": "createFloatingRate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostFloatingRatesRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostFloatingRatesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/floatingrates/{floatingRateId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Floating Rates"
|
|
],
|
|
"summary": "Retrieve Floating Rate",
|
|
"description": "Retrieves Floating Rate",
|
|
"operationId": "retrieveOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "floatingRateId",
|
|
"in": "path",
|
|
"description": "floatingRateId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetFloatingRatesFloatingRateIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Floating Rates"
|
|
],
|
|
"summary": "Update Floating Rate",
|
|
"description": "Updates new Floating Rate. Rate Periods in the past cannot be modified. All the future rateperiods would be replaced with the new ratePeriods data sent.",
|
|
"operationId": "updateFloatingRate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "floatingRateId",
|
|
"in": "path",
|
|
"description": "floatingRateId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutFloatingRatesFloatingRateIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutFloatingRatesFloatingRateIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/funds": {
|
|
"get": {
|
|
"tags": [
|
|
"Funds"
|
|
],
|
|
"summary": "Retrieve Funds",
|
|
"description": "Returns the list of funds.\n\nExample Requests:\n\nfunds",
|
|
"operationId": "retrieveFunds",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetFundsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Funds"
|
|
],
|
|
"summary": "Create a Fund",
|
|
"description": "Creates a Fund",
|
|
"operationId": "createFund",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostFundsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostFundsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/funds/{fundId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Funds"
|
|
],
|
|
"summary": "Retrieve a Fund",
|
|
"description": "Returns the details of a Fund.\n\nExample Requests:\n\nfunds/1",
|
|
"operationId": "retreiveFund",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "fundId",
|
|
"in": "path",
|
|
"description": "fundId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetFundsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Funds"
|
|
],
|
|
"summary": "Update a Fund",
|
|
"description": "Updates the details of a fund.",
|
|
"operationId": "updateFund",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "fundId",
|
|
"in": "path",
|
|
"description": "fundId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutFundsFundIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutFundsFundIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/centers/{centerId}/accounts": {
|
|
"get": {
|
|
"tags": [
|
|
"Centers"
|
|
],
|
|
"summary": "Retrieve Center accounts overview",
|
|
"description": "An example of how a savings summary for a Center can be provided. This is requested in a specific use case of the reference application.\n\nIt is quite reasonable to add resources like this to simplify User Interface development.\n\n\n\nExample Requests:\n\n\n\ncenters/9/accounts",
|
|
"operationId": "retrieveGroupAccount",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "centerId",
|
|
"in": "path",
|
|
"description": "centerId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetCentersCenterIdAccountsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/centers/downloadtemplate": {
|
|
"get": {
|
|
"tags": [
|
|
"Centers"
|
|
],
|
|
"operationId": "getCentersTemplate",
|
|
"produces": [
|
|
"application/vnd.ms-excel"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "staffId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"default": {
|
|
"description": "successful operation"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/centers/uploadtemplate": {
|
|
"post": {
|
|
"tags": [
|
|
"Centers"
|
|
],
|
|
"operationId": "postCentersTemplate",
|
|
"consumes": [
|
|
"multipart/form-data"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "file",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "file"
|
|
},
|
|
{
|
|
"name": "locale",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/centers/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Centers"
|
|
],
|
|
"summary": "Retrieve a Center Template",
|
|
"description": "Retrieves a Center Template\n\nExample Requests:\n\n\n\ncenters/template\n\n\n\ncenters/template?officeId=2",
|
|
"operationId": "retrieveTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"description": "officeId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "staffInSelectedOfficeOnly",
|
|
"in": "query",
|
|
"description": "staffInSelectedOfficeOnly",
|
|
"required": false,
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetCentersTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/centers": {
|
|
"get": {
|
|
"tags": [
|
|
"Centers"
|
|
],
|
|
"summary": "List Centers",
|
|
"description": "The default implementation supports pagination and sorting with the default pagination size set to 200 records. The parameter limit with value -1 will return all entries.\n\nExample Requests:\n\n\n\ncenters\n\n\n\ncenters?fields=name,officeName,joinedDate\n\n\n\ncenters?offset=10&limit=50\n\n\n\ncenters?orderBy=name&sortOrder=DESC",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "sqlSearch",
|
|
"in": "query",
|
|
"description": "sqlSearch",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"description": "officeId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "staffId",
|
|
"in": "query",
|
|
"description": "staffId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "externalId",
|
|
"in": "query",
|
|
"description": "externalId",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"in": "query",
|
|
"description": "name",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "underHierarchy",
|
|
"in": "query",
|
|
"description": "underHierarchy",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "paged",
|
|
"in": "query",
|
|
"description": "paged",
|
|
"required": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"description": "orderBy",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "sortOrder",
|
|
"in": "query",
|
|
"description": "sortOrder",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "meetingDate",
|
|
"in": "query",
|
|
"description": "meetingDate",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "query",
|
|
"description": "dateFormat",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "locale",
|
|
"in": "query",
|
|
"description": "locale",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetCentersResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Centers"
|
|
],
|
|
"summary": "Create a Center",
|
|
"description": "Creates a Center\n\nMandatory Fields: name, officeId, active, activationDate (if active=true)\n\nOptional Fields: externalId, staffId, groupMembers",
|
|
"operationId": "create",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostCentersRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostCentersResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/centers/{centerId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Centers"
|
|
],
|
|
"summary": "Retrieve a Center",
|
|
"description": "Retrieves a Center\n\nExample Requests:\n\n\n\ncenters/1\n\n\n\ncenters/1?associations=groupMembers",
|
|
"operationId": "retrieveOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "centerId",
|
|
"in": "path",
|
|
"description": "centerId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "staffInSelectedOfficeOnly",
|
|
"in": "query",
|
|
"description": "staffInSelectedOfficeOnly",
|
|
"required": false,
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetCentersCenterIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Centers"
|
|
],
|
|
"summary": "Activate a Center | Generate Collection Sheet | Save Collection Sheet | Close a Center | Associate Groups | Disassociate Groups",
|
|
"description": "Activate a Center:\n\nCenters can be created in a Pending state. This API exists to enable center activation. If the center happens to be already active, this API will result in an error.\n\nClose a Center:\n\nCenters can be closed if they don't have any non-closed groups or saving accounts. If the Center has any active groups or savings accounts, this API will result in an error.\n\nAssociate Groups:\n\nThis API allows associating existing groups to a center. The groups are listed from the office to which the center is associated. If group(s) is already associated with a center, this API will result in an error.\n\nDisassociate Groups:\n\nThis API allows to disassociate groups from a center.\n\nGenerate Collection Sheet:\n\nThis Api retrieves repayment details of all jlg loans under a center as on a specified meeting date.\n\nSave Collection Sheet:\n\nThis Api allows the loan officer to perform bulk repayments of JLG loans for a center on a given meeting date.\n\nShowing Request/Response for Close a Center",
|
|
"operationId": "activate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "centerId",
|
|
"in": "path",
|
|
"description": "centerId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostCentersCenterIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostCentersCenterIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Centers"
|
|
],
|
|
"summary": "Update a Center",
|
|
"description": "Updates a Center",
|
|
"operationId": "update",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "centerId",
|
|
"in": "path",
|
|
"description": "centerId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutCentersCenterIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutCentersCenterIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Centers"
|
|
],
|
|
"summary": "Delete a Center",
|
|
"description": "A Center can be deleted if it is in pending state and has no association - groups, loans or savings",
|
|
"operationId": "delete",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "centerId",
|
|
"in": "path",
|
|
"description": "centerId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteCentersCenterIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/groups/{groupId}/command/unassign_staff": {
|
|
"post": {
|
|
"tags": [
|
|
"Groups"
|
|
],
|
|
"summary": "Unassign a Staff",
|
|
"description": "Allows you to unassign the Staff.\n\nMandatory Fields: staffId",
|
|
"operationId": "unassignLoanOfficer",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "groupId",
|
|
"in": "path",
|
|
"description": "groupId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostGroupsGroupIdCommandUnassignStaffRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostGroupsGroupIdCommandUnassignStaffResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/groups/{groupId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Groups"
|
|
],
|
|
"summary": "Retrieve a Group",
|
|
"description": "Retrieve group information.\n\nExample Requests:\n\n\n\ngroups/1\n\n\n\ngroups/1?associations=clientMembers",
|
|
"operationId": "retrieveOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "groupId",
|
|
"in": "path",
|
|
"description": "groupId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "staffInSelectedOfficeOnly",
|
|
"in": "query",
|
|
"description": "staffInSelectedOfficeOnly",
|
|
"required": false,
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
{
|
|
"name": "roleId",
|
|
"in": "query",
|
|
"description": "roleId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetGroupsGroupIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Groups"
|
|
],
|
|
"summary": "Activate a Group | Associate Clients | Disassociate Clients | Transfer Clients across groups | Generate Collection Sheet | Save Collection Sheet | Unassign a Staff | Assign a Staff | Close a Group | Unassign a Role | Update a Role",
|
|
"description": "Activate a Group:\n\nGroups can be created in a Pending state. This API exists to enable group activation.\n\n\n\nIf the group happens to be already active this API will result in an error.\n\nMandatory Fields: activationDate\n\nAssociate Clients:\n\nThis API allows to associate existing clients to a group.\n\n\n\nThe clients are listed from the office to which the group is associated.\n\n\n\nIf client(s) is already associated with group then API will result in an error.\n\nMandatory Fields: clientMembers\n\nDisassociate Clients:\n\nThis API allows to disassociate clients from a group.\n\n\n\nDisassociating a client with active joint liability group loans results in an error.\n\nMandatory Fields: clientMembers\n\nTransfer Clients across groups:\n\nThis API allows to transfer clients from one group to another\n\nMandatory Fields: destinationGroupId and clients\n\nOptional Fields: inheritDestinationGroupLoanOfficer (defaults to true) and transferActiveLoans (defaults to true)\n\nGenerate Collection Sheet:\n\nThis API retrieves repayment details of all jlg loans of all members of a group on a specified meeting date.\n\nMandatory Fields: calendarId and transactionDate\n\nSave Collection Sheet:\n\nThis api allows the loan officer to perform bulk repayments of JLG loans for a group on its meeting date.\n\nMandatory Fields: calendarId, transactionDate, actualDisbursementDate\n\nOptional Fields: clientsAttendance, bulkRepaymentTransaction, bulkDisbursementTransactions\n\nUnassign a Staff:\n\nAllows you to unassign the Staff.\n\nMandatory Fields: staffId\n\nAssign a Staff:\n\nAllows you to assign Staff to an existing Group.\n\n\n\nThe selected Staff should be belong to the same office (or an office higher up in the hierarchy) as this groupMandatory Fields: staffId\n\nOptional Fields: inheritStaffForClientAccounts (Optional: Boolean if true all members of the group (i.e all clients with active loans and savings ) will inherit the staffId)\n\nClose a Group:\n\nThis API exists to close a group. Groups can be closed if they don't have any non-closed clients/loans/savingsAccounts.\n\n\n\nIf the group has any active clients/loans/savingsAccount, this API will result in an error.Assign a Role:\n\nAllows you to assign a Role to an existing member of a group.\n\n\n\nWe can define the different roles applicable to group members by adding code values to the pre-defined system code GROUPROLE. Example:Group leader etc.\n\nMandatory Fields: clientId, role\n\nUnassign a Role:\n\nAllows you to unassign Roles associated tp Group members.\n\nUpdate a Role:\n\nAllows you to update the member Role.\n\nMandatory Fields: role\n\nShowing request/response for Transfer Clients across groups",
|
|
"operationId": "activateOrGenerateCollectionSheet",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "groupId",
|
|
"in": "path",
|
|
"description": "groupId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "roleId",
|
|
"in": "query",
|
|
"description": "roleId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostGroupsGroupIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostGroupsGroupIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Groups"
|
|
],
|
|
"summary": "Update a Group",
|
|
"description": "Updates a Group",
|
|
"operationId": "update",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "groupId",
|
|
"in": "path",
|
|
"description": "groupId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutGroupsGroupIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutGroupsGroupIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Groups"
|
|
],
|
|
"summary": "Delete a Group",
|
|
"description": "A group can be deleted if it is in pending state and has no associations - clients, loans or savings",
|
|
"operationId": "delete",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "groupId",
|
|
"in": "path",
|
|
"description": "groupId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteGroupsGroupIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/groups/{groupId}/accounts": {
|
|
"get": {
|
|
"tags": [
|
|
"Groups"
|
|
],
|
|
"summary": "Retrieve Group accounts overview",
|
|
"description": "Retrieves details of all Loan and Savings accounts associated with this group.\n\n\n\nExample Requests:\n\n\n\ngroups/1/accounts\n\n\n\n\n\ngroups/1/accounts?fields=loanAccounts,savingsAccounts,memberLoanAccounts,\n\nmemberSavingsAccounts",
|
|
"operationId": "retrieveAccounts",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "groupId",
|
|
"in": "path",
|
|
"description": "groupId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetGroupsGroupIdAccountsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/groups/downloadtemplate": {
|
|
"get": {
|
|
"tags": [
|
|
"Groups"
|
|
],
|
|
"operationId": "getGroupsTemplate",
|
|
"produces": [
|
|
"application/vnd.ms-excel"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "staffId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"default": {
|
|
"description": "successful operation"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/groups/uploadtemplate": {
|
|
"post": {
|
|
"tags": [
|
|
"Groups"
|
|
],
|
|
"operationId": "postGroupTemplate",
|
|
"consumes": [
|
|
"multipart/form-data"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "file",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "file"
|
|
},
|
|
{
|
|
"name": "locale",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/groups/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Groups"
|
|
],
|
|
"summary": "Retrieve Group Template",
|
|
"description": "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:\n\n\n\nField Defaults\n\nAllowed Value Lists\n\nExample Requests:\n\n\n\ngroups/template\n\n\n\ngroups/template?officeId=2\n\n\n\ngroups/template?centerId=1\n\n\n\ngroups/template?centerId=1&staffInSelectedOfficeOnly=true",
|
|
"operationId": "retrieveTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"description": "officeId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "center",
|
|
"in": "query",
|
|
"description": "center",
|
|
"required": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"name": "centerId",
|
|
"in": "query",
|
|
"description": "centerId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "staffInSelectedOfficeOnly",
|
|
"in": "query",
|
|
"description": "staffInSelectedOfficeOnly",
|
|
"required": false,
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetGroupsTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/groups": {
|
|
"get": {
|
|
"tags": [
|
|
"Groups"
|
|
],
|
|
"summary": "List Groups",
|
|
"description": "The default implementation of listing Groups returns 200 entries with support for pagination and sorting. Using the parameter limit with value -1 returns all entries.\n\nExample Requests:\n\n\n\ngroups\n\n\n\ngroups?fields=name,officeName,joinedDate\n\n\n\ngroups?offset=10&limit=50\n\n\n\ngroups?orderBy=name&sortOrder=DESC",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "sqlSearch",
|
|
"in": "query",
|
|
"description": "sqlSearch",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"description": "officeId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "staffId",
|
|
"in": "query",
|
|
"description": "staffId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "externalId",
|
|
"in": "query",
|
|
"description": "externalId",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"in": "query",
|
|
"description": "name",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "underHierarchy",
|
|
"in": "query",
|
|
"description": "underHierarchy",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "paged",
|
|
"in": "query",
|
|
"description": "paged",
|
|
"required": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"description": "orderBy",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "sortOrder",
|
|
"in": "query",
|
|
"description": "sortOrder",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "orphansOnly",
|
|
"in": "query",
|
|
"description": "orphansOnly",
|
|
"required": false,
|
|
"type": "boolean"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetGroupsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Groups"
|
|
],
|
|
"summary": "Create a Group",
|
|
"description": "Creates a Group\n\nMandatory Fields: name, officeId, active, activationDate (if active=true)\n\nOptional Fields: externalId, staffId, clientMembers",
|
|
"operationId": "create",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostGroupsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostGroupsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/interestratecharts/{chartId}/chartslabs/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Interest Rate Slab (A.K.A interest bands)"
|
|
],
|
|
"operationId": "template",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/interestratecharts/{chartId}/chartslabs": {
|
|
"get": {
|
|
"tags": [
|
|
"Interest Rate Slab (A.K.A interest bands)"
|
|
],
|
|
"summary": "Retrieve all Slabs",
|
|
"description": "Retrieve list of slabs associated with a chart\n\nExample Requests:\n\ninterestratecharts/1/chartslabs",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "chartId",
|
|
"in": "path",
|
|
"description": "chartId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetInterestRateChartsChartIdChartSlabsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Interest Rate Slab (A.K.A interest bands)"
|
|
],
|
|
"summary": "Create a Slab",
|
|
"description": "Creates a new interest rate slab for an interest rate chart.\nMandatory Fields\nperiodType, fromPeriod, annualInterestRate\nOptional Fields\ntoPeriod and description\nExample Requests:\n\ninterestratecharts/1/chartslabs",
|
|
"operationId": "create",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "chartId",
|
|
"in": "path",
|
|
"description": "chartId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostInterestRateChartsChartIdChartSlabsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostInterestRateChartsChartIdChartSlabsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/interestratecharts/{chartId}/chartslabs/{chartSlabId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Interest Rate Slab (A.K.A interest bands)"
|
|
],
|
|
"summary": "Retrieve a Slab",
|
|
"description": "Retrieve a slab associated with an Interest rate chart\n\nExample Requests:\n\ninterestratecharts/1/chartslabs/1\n",
|
|
"operationId": "retrieveOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "chartId",
|
|
"in": "path",
|
|
"description": "chartId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "chartSlabId",
|
|
"in": "path",
|
|
"description": "chartSlabId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetInterestRateChartsChartIdChartSlabsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Interest Rate Slab (A.K.A interest bands)"
|
|
],
|
|
"summary": "Update a Slab",
|
|
"description": "It updates the Slab from chart",
|
|
"operationId": "update",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "chartId",
|
|
"in": "path",
|
|
"description": "chartId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "chartSlabId",
|
|
"in": "path",
|
|
"description": "chartSlabId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutInterestRateChartsChartIdChartSlabsChartSlabIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutInterestRateChartsChartIdChartSlabsChartSlabIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Interest Rate Slab (A.K.A interest bands)"
|
|
],
|
|
"summary": "Delete a Slab",
|
|
"description": "Delete a Slab from a chart",
|
|
"operationId": "delete",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "chartId",
|
|
"in": "path",
|
|
"description": "chartId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "chartSlabId",
|
|
"in": "path",
|
|
"description": "chartSlabId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteInterestRateChartsChartIdChartSlabsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/interestratecharts/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Interest Rate Chart"
|
|
],
|
|
"summary": "Retrieve Chart Details Template",
|
|
"description": "This is a convenience resource. It can be useful when building maintenance user interface screens for creating a chart. The template data returned consists of any or all of:\n\nField Defaults\nAllowed Value Lists\nExample Request:\n\ninterestratecharts/template",
|
|
"operationId": "template",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetInterestRateChartsTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/interestratecharts": {
|
|
"get": {
|
|
"tags": [
|
|
"Interest Rate Chart"
|
|
],
|
|
"summary": "Retrieve all Charts",
|
|
"description": "Retrieve list of charts associated with a term deposit product(FD or RD).\nExample Requests:\n\ninterestratecharts?productId=1",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "productId",
|
|
"in": "query",
|
|
"description": "productId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetInterestRateChartsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Interest Rate Chart"
|
|
],
|
|
"summary": "Create a Chart",
|
|
"description": "Creates a new chart which can be attached to a term deposit products (FD or RD).",
|
|
"operationId": "create",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostInterestRateChartsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostInterestRateChartsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/interestratecharts/{chartId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Interest Rate Chart"
|
|
],
|
|
"summary": "Retrieve a Chart",
|
|
"description": "It retrieves the Interest Rate Chart\nExample Requests:\n\ninterestratecharts/1",
|
|
"operationId": "retrieveOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "chartId",
|
|
"in": "path",
|
|
"description": "chartId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetInterestRateChartsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Interest Rate Chart"
|
|
],
|
|
"summary": "Update a Chart",
|
|
"description": "It updates the Chart.",
|
|
"operationId": "update",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "chartId",
|
|
"in": "path",
|
|
"description": "chartId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutInterestRateChartsChartIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutInterestRateChartsChartIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Interest Rate Chart"
|
|
],
|
|
"summary": "Delete a Chart",
|
|
"description": "It deletes the chart",
|
|
"operationId": "delete",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "chartId",
|
|
"in": "path",
|
|
"description": "chartId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteInterestRateChartsChartIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/loans/{loanId}/charges": {
|
|
"get": {
|
|
"tags": [
|
|
"Loan Charges"
|
|
],
|
|
"summary": "List Loan Charges",
|
|
"description": "It lists all the Loan Charges specific to a Loan \n\nExample Requests:\n\nloans/1/charges\n\n\nloans/1/charges?fields=name,amountOrPercentage",
|
|
"operationId": "retrieveAllLoanCharges",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoansLoanIdChargesChargeIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Loan Charges"
|
|
],
|
|
"summary": "Create a Loan Charge",
|
|
"description": "It Creates a Loan Charge",
|
|
"operationId": "executeLoanCharge",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostLoansLoanIdChargesRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostLoansLoanIdChargesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/loans/{loanId}/charges/{chargeId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Loan Charges"
|
|
],
|
|
"summary": "Retrieve a Loan Charge",
|
|
"description": "Retrieves Loan Charge according to the Loan ID and Charge IDExample Requests:\n\n/loans/1/charges/1\n\n\n/loans/1/charges/1?fields=name,amountOrPercentage",
|
|
"operationId": "retrieveLoanCharge",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "chargeId",
|
|
"in": "path",
|
|
"description": "chargeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetLoansLoanIdChargesChargeIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Loan Charges"
|
|
],
|
|
"summary": "Pay Loan Charge",
|
|
"description": "Loan Charge will be paid if the loan is linked with a savings account",
|
|
"operationId": "executeLoanCharge",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "chargeId",
|
|
"in": "path",
|
|
"description": "chargeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostLoansLoanIdChargesChargeIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostLoansLoanIdChargesChargeIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Loan Charges"
|
|
],
|
|
"summary": "Update a Loan Charge",
|
|
"description": "Currently Loan Charges may be updated only if the Loan is not yet approved",
|
|
"operationId": "updateLoanCharge",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "chargeId",
|
|
"in": "path",
|
|
"description": "chargeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutLoansLoanIdChargesChargeIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutLoansLoanIdChargesChargeIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Loan Charges"
|
|
],
|
|
"summary": "Delete a Loan Charge",
|
|
"description": "Note: Currently, A Loan Charge may only be removed from Loans that are not yet approved.",
|
|
"operationId": "deleteLoanCharge",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "chargeId",
|
|
"in": "path",
|
|
"description": "chargeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteLoansLoanIdChargesChargeIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/loans/{loanId}/charges/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Loan Charges"
|
|
],
|
|
"summary": "Retrieve Loan Charges Template",
|
|
"description": "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:\n\nField Defaults\nAllowed Value Lists\nExample Request:\n\nloans/1/charges/template\n\n",
|
|
"operationId": "retrieveTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetLoansLoanIdChargesTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/loans/{loanId}/schedule": {
|
|
"post": {
|
|
"tags": [
|
|
"Loan Rescheduling"
|
|
],
|
|
"summary": "Calculate loan repayment schedule based on Loan term variations | Updates loan repayment schedule based on Loan term variations | Updates loan repayment schedule by removing Loan term variations",
|
|
"description": "Calculate loan repayment schedule based on Loan term variations:\n\nMandatory Fields: exceptions,locale,dateFormat\n\nUpdates loan repayment schedule based on Loan term variations:\n\nMandatory Fields: exceptions,locale,dateFormat\n\nUpdates loan repayment schedule by removing Loan term variations:\n\nIt updates the loan repayment schedule by removing Loan term variations\n\nShowing request/response for 'Updates loan repayment schedule by removing Loan term variations'",
|
|
"operationId": "calculateLoanScheduleOrSubmitVariableSchedule",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostLoansLoanIdScheduleRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostLoansLoanIdScheduleResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/loans/{loanId}/transactions/{transactionId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Loan Transactions"
|
|
],
|
|
"summary": "Retrieve a Transaction Details",
|
|
"description": "Retrieves a Transaction Details\n\nExample Request:\n\nloans/5/transactions/3",
|
|
"operationId": "retrieveTransaction",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "transactionId",
|
|
"in": "path",
|
|
"description": "transactionId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetLoansLoanIdTransactionsTransactionIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Loan Transactions"
|
|
],
|
|
"summary": "Adjust a Transaction",
|
|
"description": "Note: there is no need to specify command={transactionType} parameter.\n\nMandatory Fields: transactionDate, transactionAmount",
|
|
"operationId": "adjustLoanTransaction",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "transactionId",
|
|
"in": "path",
|
|
"description": "transactionId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostLoansLoanIdTransactionsTransactionIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostLoansLoanIdTransactionsTransactionIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/loans/{loanId}/transactions/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Loan Transactions"
|
|
],
|
|
"summary": "Retrieve Loan Transaction Template",
|
|
"description": "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:\n\nField Defaults\nAllowed Value Lists\n\nExample Request:\n\nloans/1/transactions/template?command=repayment",
|
|
"operationId": "retrieveTransactionTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "query",
|
|
"description": "dateFormat",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "transactionDate",
|
|
"in": "query",
|
|
"description": "transactionDate",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "locale",
|
|
"in": "query",
|
|
"description": "locale",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetLoansLoanIdTransactionsTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/loans/{loanId}/transactions": {
|
|
"post": {
|
|
"tags": [
|
|
"Loan Transactions"
|
|
],
|
|
"summary": "Make a Repayment | Make a Refund of an Active Loan by Cash | Foreclosure of an Active Loan | Waive Interest | Write-off Loan | Make Recovery Payment | Undo Loan Write-off Transaction",
|
|
"description": "Make Recovery Payment:\n\nThis API allows collecting recovery payments for written-off loans",
|
|
"operationId": "executeLoanTransaction",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostLoansLoanIdTransactionsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostLoansLoanIdTransactionsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/loans/downloadtemplate": {
|
|
"get": {
|
|
"tags": [
|
|
"Loans"
|
|
],
|
|
"operationId": "getLoansTemplate",
|
|
"produces": [
|
|
"application/vnd.ms-excel"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "staffId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"default": {
|
|
"description": "successful operation"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/loans/repayments/downloadtemplate": {
|
|
"get": {
|
|
"tags": [
|
|
"Loans"
|
|
],
|
|
"operationId": "getLoanRepaymentTemplate",
|
|
"produces": [
|
|
"application/vnd.ms-excel"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"default": {
|
|
"description": "successful operation"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/loans/uploadtemplate": {
|
|
"post": {
|
|
"tags": [
|
|
"Loans"
|
|
],
|
|
"operationId": "postLoanTemplate",
|
|
"consumes": [
|
|
"multipart/form-data"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "file",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "file"
|
|
},
|
|
{
|
|
"name": "locale",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/loans/repayments/uploadtemplate": {
|
|
"post": {
|
|
"tags": [
|
|
"Loans"
|
|
],
|
|
"operationId": "postLoanRepaymentTemplate",
|
|
"consumes": [
|
|
"multipart/form-data"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "file",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "file"
|
|
},
|
|
{
|
|
"name": "locale",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/loans/{loanId}/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Loans"
|
|
],
|
|
"operationId": "retrieveApprovalTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "templateType",
|
|
"in": "query",
|
|
"description": "templateType",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/loans": {
|
|
"get": {
|
|
"tags": [
|
|
"Loans"
|
|
],
|
|
"summary": "List Loans",
|
|
"description": "The list capability of loans can support pagination and sorting.\nExample Requests:\n\nloans\n\nloans?fields=accountNo\n\nloans?offset=10&limit=50\n\nloans?orderBy=accountNo&sortOrder=DESC",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "sqlSearch",
|
|
"in": "query",
|
|
"description": "sqlSearch",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "externalId",
|
|
"in": "query",
|
|
"description": "externalId",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"description": "orderBy",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "sortOrder",
|
|
"in": "query",
|
|
"description": "sortOrder",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "accountNo",
|
|
"in": "query",
|
|
"description": "accountNo",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetLoansResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Loans"
|
|
],
|
|
"summary": "Calculate loan repayment schedule | Submit a new Loan Application",
|
|
"description": "It calculates the loan repayment Schedule\nSubmits a new loan application\nMandatory Fields: clientId, productId, principal, loanTermFrequency, loanTermFrequencyType, loanType, numberOfRepayments, repaymentEvery, repaymentFrequencyType, interestRatePerPeriod, amortizationType, interestType, interestCalculationPeriodType, transactionProcessingStrategyId, expectedDisbursementDate, submittedOnDate, loanType\nOptional Fields: graceOnPrincipalPayment, graceOnInterestPayment, graceOnInterestCharged, linkAccountId, allowPartialPeriodInterestCalcualtion, fixedEmiAmount, maxOutstandingLoanBalance, disbursementData, graceOnArrearsAgeing, createStandingInstructionAtDisbursement (requires linkedAccountId if set to true)\nAdditional Mandatory Fields if interest recalculation is enabled for product and Rest frequency not same as repayment period: recalculationRestFrequencyDate\nAdditional Mandatory Fields if interest recalculation with interest/fee compounding is enabled for product and compounding frequency not same as repayment period: recalculationCompoundingFrequencyDate\nAdditional Mandatory Field if Entity-Datatable Check is enabled for the entity of type loan: datatables",
|
|
"operationId": "calculateLoanScheduleOrSubmitLoanApplication",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostLoansRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostLoansResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/loans/{loanId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Loans"
|
|
],
|
|
"summary": "Retrieve a Loan",
|
|
"description": "Note: template=true parameter doesn't apply to this resource.Example Requests:\n\nloans/1\n\n\nloans/1?fields=id,principal,annualInterestRate\n\n\nloans/1?associations=all\n\nloans/1?associations=all&exclude=guarantors\n\n\nloans/1?fields=id,principal,annualInterestRate&associations=repaymentSchedule,transactions",
|
|
"operationId": "retrieveLoan",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "staffInSelectedOfficeOnly",
|
|
"in": "query",
|
|
"description": "staffInSelectedOfficeOnly",
|
|
"required": false,
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetLoansLoanIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Loans"
|
|
],
|
|
"summary": "Approve Loan Application | Recover Loan Guarantee | Undo Loan Application Approval | Assign a Loan Officer | Unassign a Loan Officer | Reject Loan Application | Applicant Withdraws from Loan Application | Disburse Loan Disburse Loan To Savings Account | Undo Loan Disbursal",
|
|
"description": "Approve Loan Application:\nMandatory Fields: approvedOnDate\nOptional Fields: approvedLoanAmount and expectedDisbursementDate\nApproves the loan application\n\nRecover Loan Guarantee:\nRecovers the loan guarantee\n\nUndo Loan Application Approval:\nUndoes the Loan Application Approval\n\nAssign a Loan Officer:\nAllows you to assign Loan Officer for existing Loan.\n\nUnassign a Loan Officer:\nAllows you to unassign the Loan Officer.\n\nReject Loan Application:\nMandatory Fields: rejectedOnDate\nAllows you to reject the loan application\n\nApplicant Withdraws from Loan Application:\nMandatory Fields: withdrawnOnDate\nAllows the applicant to withdraw the loan application\n\nDisburse Loan:\nMandatory Fields: actualDisbursementDate\nOptional Fields: transactionAmount and fixedEmiAmount\nDisburses the Loan\n\nDisburse Loan To Savings Account:\nMandatory Fields: actualDisbursementDate\nOptional Fields: transactionAmount and fixedEmiAmount\nDisburses the loan to Saving Account\n\nUndo Loan Disbursal:\nUndoes the Loan Disbursal\nShowing request and response for Assign a Loan Officer",
|
|
"operationId": "stateTransitions",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostLoansLoanIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostLoansLoanIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Loans"
|
|
],
|
|
"summary": "Modify a loan application",
|
|
"description": "Loan application can only be modified when in 'Submitted and pending approval' state. Once the application is approved, the details cannot be changed using this method.",
|
|
"operationId": "modifyLoanApplication",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutLoansLoanIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutLoansLoanIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Loans"
|
|
],
|
|
"summary": "Delete a Loan Application",
|
|
"description": "Note: Only loans in \"Submitted and awaiting approval\" status can be deleted.",
|
|
"operationId": "deleteLoanApplication",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteLoansLoanIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/loans/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Loans"
|
|
],
|
|
"summary": "Retrieve Loan Details Template",
|
|
"description": "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:\n\nField Defaults\nAllowed Value Lists\nExample Requests:\n\nloans/template?templateType=individual&clientId=1\n\n\nloans/template?templateType=individual&clientId=1&productId=1",
|
|
"operationId": "template",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "query",
|
|
"description": "clientId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "groupId",
|
|
"in": "query",
|
|
"description": "groupId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "productId",
|
|
"in": "query",
|
|
"description": "productId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "templateType",
|
|
"in": "query",
|
|
"description": "templateType",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "staffInSelectedOfficeOnly",
|
|
"in": "query",
|
|
"description": "staffInSelectedOfficeOnly",
|
|
"required": false,
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
{
|
|
"name": "activeOnly",
|
|
"in": "query",
|
|
"description": "activeOnly",
|
|
"required": false,
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetLoansTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/loanproducts/{productId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Loan Products"
|
|
],
|
|
"summary": "Retrieve a Loan Product",
|
|
"description": "Retrieves a Loan Product\n\nExample Requests:\n\nloanproducts/1\n\n\nloanproducts/1?template=true\n\n\nloanproducts/1?fields=name,description,numberOfRepayments",
|
|
"operationId": "retrieveLoanProductDetails",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "productId",
|
|
"in": "path",
|
|
"description": "productId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetLoanProductsProductIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Loan Products"
|
|
],
|
|
"summary": "Update a Loan Product",
|
|
"description": "Updates a Loan Product",
|
|
"operationId": "updateLoanProduct",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "productId",
|
|
"in": "path",
|
|
"description": "productId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutLoanProductsProductIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutLoanProductsProductIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/loanproducts": {
|
|
"get": {
|
|
"tags": [
|
|
"Loan Products"
|
|
],
|
|
"summary": "List Loan Products",
|
|
"description": "Lists Loan Products\n\nExample Requests:\n\nloanproducts\n\n\nloanproducts?fields=name,description,interestRateFrequencyType,amortizationType",
|
|
"operationId": "retrieveAllLoanProducts",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoanProductsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Loan Products"
|
|
],
|
|
"summary": "Create a Loan Product",
|
|
"description": "Depending of the Accounting Rule (accountingRule) selected, additional fields with details of the appropriate Ledger Account identifiers would need to be passed in.\n\nRefer MifosX Accounting Specs Draft for more details regarding the significance of the selected accounting rule\n\nMandatory Fields: name, shortName, currencyCode, digitsAfterDecimal, inMultiplesOf, principal, numberOfRepayments, repaymentEvery, repaymentFrequencyType, interestRatePerPeriod, interestRateFrequencyType, amortizationType, interestType, interestCalculationPeriodType, transactionProcessingStrategyId, accountingRule, isInterestRecalculationEnabled, daysInYearType, daysInMonthType\n\nOptional Fields: inArrearsTolerance, graceOnPrincipalPayment, graceOnInterestPayment, graceOnInterestCharged, graceOnArrearsAgeing, charges, paymentChannelToFundSourceMappings, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, includeInBorrowerCycle, useBorrowerCycle,principalVariationsForBorrowerCycle, numberOfRepaymentVariationsForBorrowerCycle, interestRateVariationsForBorrowerCycle, multiDisburseLoan,maxTrancheCount, outstandingLoanBalance,overdueDaysForNPA,holdGuaranteeFunds, principalThresholdForLastInstalment, accountMovesOutOfNPAOnlyOnArrearsCompletion, canDefineInstallmentAmount, installmentAmountInMultiplesOf, allowAttributeOverrides, allowPartialPeriodInterestCalcualtion\n\nAdditional Mandatory Fields for Cash(2) based accounting: fundSourceAccountId, loanPortfolioAccountId, interestOnLoanAccountId, incomeFromFeeAccountId, incomeFromPenaltyAccountId, writeOffAccountId, transfersInSuspenseAccountId, overpaymentLiabilityAccountId\n\nAdditional Mandatory Fields for periodic (3) and upfront (4)accrual accounting: fundSourceAccountId, loanPortfolioAccountId, interestOnLoanAccountId, incomeFromFeeAccountId, incomeFromPenaltyAccountId, writeOffAccountId, receivableInterestAccountId, receivableFeeAccountId, receivablePenaltyAccountId, transfersInSuspenseAccountId, overpaymentLiabilityAccountId\n\nAdditional Mandatory Fields if interest recalculation is enabled(true): interestRecalculationCompoundingMethod, rescheduleStrategyMethod, recalculationRestFrequencyType\n\nAdditional Optional Fields if interest recalculation is enabled(true): isArrearsBasedOnOriginalSchedule, preClosureInterestCalculationStrategy\n\nAdditional Optional Fields if interest recalculation is enabled(true) and recalculationRestFrequencyType is not same as repayment period: recalculationRestFrequencyInterval, recalculationRestFrequencyDate\n\nAdditional Optional Fields if interest recalculation is enabled(true) and interestRecalculationCompoundingMethod is enabled: recalculationCompoundingFrequencyType\n\nAdditional Optional Fields if interest recalculation is enabled(true) and interestRecalculationCompoundingMethod is enabled and recalculationCompoundingFrequencyType is not same as repayment period: recalculationCompoundingFrequencyInterval, recalculationCompoundingFrequencyDate\n\nAdditional Mandatory Fields if Hold Guarantee funds is enabled(true): mandatoryGuarantee\n\nAdditional Optional Fields if Hold Guarantee funds is enabled(true): minimumGuaranteeFromOwnFunds,minimumGuaranteeFromGuarantor",
|
|
"operationId": "createLoanProduct",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostLoanProductsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostLoanProductsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/loanproducts/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Loan Products"
|
|
],
|
|
"summary": "Retrieve Loan Product Details Template",
|
|
"description": "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:\n\nField Defaults\nAllowed Value Lists\nExample Request:\n\nloanproducts/template",
|
|
"operationId": "retrieveTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "isProductMixTemplate",
|
|
"in": "query",
|
|
"description": "isProductMixTemplate",
|
|
"required": false,
|
|
"type": "boolean"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetLoanProductsTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/{resourceType}/{resourceId}/notes/{noteId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Notes"
|
|
],
|
|
"summary": "Retrieve a Resource Note",
|
|
"description": "Retrieves a Resource Note\n\nExample Requests:\n\nclients/1/notes/76\n\n\ngroups/1/notes/20\n\n\nclients/1/notes/76?fields=note,createdOn,createdByUsername\n\n\ngroups/1/notes/20?fields=note,createdOn,createdByUsername",
|
|
"operationId": "retrieveNote",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "resourceType",
|
|
"in": "path",
|
|
"description": "resourceType",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "resourceId",
|
|
"in": "path",
|
|
"description": "resourceId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "noteId",
|
|
"in": "path",
|
|
"description": "noteId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetResourceTypeResourceIdNotesNoteIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Notes"
|
|
],
|
|
"summary": "Update a Resource Note",
|
|
"description": "Updates a Resource Note",
|
|
"operationId": "updateNote",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "resourceType",
|
|
"in": "path",
|
|
"description": "resourceType",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "resourceId",
|
|
"in": "path",
|
|
"description": "resourceId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "noteId",
|
|
"in": "path",
|
|
"description": "noteId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutResourceTypeResourceIdNotesNoteIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutResourceTypeResourceIdNotesNoteIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Notes"
|
|
],
|
|
"summary": "Delete a Resource Note",
|
|
"description": "Deletes a Resource Note",
|
|
"operationId": "deleteNote",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "resourceType",
|
|
"in": "path",
|
|
"description": "resourceType",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "resourceId",
|
|
"in": "path",
|
|
"description": "resourceId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "noteId",
|
|
"in": "path",
|
|
"description": "noteId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteResourceTypeResourceIdNotesNoteIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/{resourceType}/{resourceId}/notes": {
|
|
"get": {
|
|
"tags": [
|
|
"Notes"
|
|
],
|
|
"summary": "Retrieve a Resource's Notes",
|
|
"description": "Retrieves a Resource's Notes\n\nNote: Notes are returned in descending createOn order.\n\nExample Requests:\n\nclients/2/notes\n\n\ngroups/2/notes?fields=note,createdOn,createdByUsername",
|
|
"operationId": "retrieveNotesByResource",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "resourceType",
|
|
"in": "path",
|
|
"description": "resourceType",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "resourceId",
|
|
"in": "path",
|
|
"description": "resourceId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetResourceTypeResourceIdNotesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Notes"
|
|
],
|
|
"summary": "Add a Resource Note",
|
|
"description": "Adds a new note to a supported resource.\n\nExample Requests:\n\nclients/1/notes\n\n\ngroups/1/notes",
|
|
"operationId": "addNewNote",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "resourceType",
|
|
"in": "path",
|
|
"description": "resourceType",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "resourceId",
|
|
"in": "path",
|
|
"description": "resourceId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostResourceTypeResourceIdNotesRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostResourceTypeResourceIdNotesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/paymenttypes/{paymentTypeId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Payment Type"
|
|
],
|
|
"summary": "Retrieve a Payment Type",
|
|
"description": "Retrieves a payment type",
|
|
"operationId": "retrieveOnePaymentType",
|
|
"consumes": [
|
|
"text/html",
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "paymentTypeId",
|
|
"in": "path",
|
|
"description": "paymentTypeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetPaymentTypesPaymentTypeIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Payment Type"
|
|
],
|
|
"summary": "Update a Payment Type",
|
|
"description": "Updates a Payment Type",
|
|
"operationId": "updatePaymentType",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "paymentTypeId",
|
|
"in": "path",
|
|
"description": "paymentTypeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutPaymentTypesPaymentTypeIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutPaymentTypesPaymentTypeIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Payment Type"
|
|
],
|
|
"summary": "Delete a Payment Type",
|
|
"description": "Deletes payment type",
|
|
"operationId": "deleteCode",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "paymentTypeId",
|
|
"in": "path",
|
|
"description": "paymentTypeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeletePaymentTypesPaymentTypeIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/paymenttypes": {
|
|
"get": {
|
|
"tags": [
|
|
"Payment Type"
|
|
],
|
|
"summary": "Retrieve all Payment Types",
|
|
"description": "Retrieve list of payment types",
|
|
"operationId": "getAllPaymentTypes",
|
|
"consumes": [
|
|
"text/html",
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetPaymentTypesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Payment Type"
|
|
],
|
|
"summary": "Create a Payment Type",
|
|
"description": "Creates a new Payment type\n\nMandatory Fields: name\n\nOptional Fields: Description, isCashPayment,Position",
|
|
"operationId": "createPaymentType",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostPaymentTypesRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostPaymentTypesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/products/{type}/{productId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Products"
|
|
],
|
|
"summary": "Retrieve a Share Product",
|
|
"description": "Retrieves a Share Product\n\nExample Requests:\n\nproducts/share/1\n\n\nproducts/share/1?template=true",
|
|
"operationId": "retrieveProduct",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "productId",
|
|
"in": "path",
|
|
"description": "productId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "type",
|
|
"in": "path",
|
|
"description": "type",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetProductsTypeProductIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Products"
|
|
],
|
|
"operationId": "handleCommands",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "type",
|
|
"in": "path",
|
|
"description": "type",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "productId",
|
|
"in": "path",
|
|
"description": "productId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Products"
|
|
],
|
|
"summary": "Update a Share Product",
|
|
"description": "Updates a Share Product",
|
|
"operationId": "updateProduct",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "type",
|
|
"in": "path",
|
|
"description": "type",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "productId",
|
|
"in": "path",
|
|
"description": "productId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutProductsTypeProductIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutProductsTypeProductIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/products/{type}": {
|
|
"get": {
|
|
"tags": [
|
|
"Products"
|
|
],
|
|
"summary": "List Share Products",
|
|
"description": "Lists Share Products\n\nMandatory Fields: limit, offset\n\nExample Requests:\n\nshareproducts",
|
|
"operationId": "retrieveAllProducts",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "type",
|
|
"in": "path",
|
|
"description": "type",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetProductsTypeResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Products"
|
|
],
|
|
"summary": "Create a Share Product",
|
|
"description": "Creates a Share Product\n\nMandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, locale, totalShares, unitPrice, nominalShares,allowDividendCalculationForInactiveClients,accountingRule\n\nMandatory Fields for Cash based accounting (accountingRule = 2): shareReferenceId, shareSuspenseId, shareEquityId, incomeFromFeeAccountId\n\nOptional Fields: sharesIssued, minimumShares, maximumShares, minimumActivePeriodForDividends, minimumactiveperiodFrequencyType, lockinPeriodFrequency, lockinPeriodFrequencyType, marketPricePeriods, chargesSelected",
|
|
"operationId": "createProduct",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "type",
|
|
"in": "path",
|
|
"description": "type",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostProductsTypeRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostProductsTypeResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/products/{type}/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Products"
|
|
],
|
|
"operationId": "retrieveTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "type",
|
|
"in": "path",
|
|
"description": "type",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/fixeddepositaccounts": {
|
|
"get": {
|
|
"tags": [
|
|
"Fixed Deposit Account"
|
|
],
|
|
"summary": "List Fixed deposit applications/accounts",
|
|
"description": "Lists Fixed Deposit Accounts\n\nExample Requests:\n\n\n\nfixeddepositaccounts\n\n\n\nfixeddepositaccounts?fields=name",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "paged",
|
|
"in": "query",
|
|
"description": "paged",
|
|
"required": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"description": "orderBy",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "sortOrder",
|
|
"in": "query",
|
|
"description": "sortOrder",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Fixed Deposit Account"
|
|
],
|
|
"summary": "Submit new fixed deposit application",
|
|
"description": "Submits a new fixed deposit applicationMandatory Fields: clientId or groupId, productId, submittedOnDate, depositAmount, depositPeriod, depositPeriodFrequencyId\n\nOptional Fields: accountNo, externalId, fieldOfficerId,linkAccountId(if provided initial deposit amount will be collected from this account),transferInterestToSavings(By enabling this flag all interest postings will be transferred to linked saving account )",
|
|
"operationId": "submitApplication",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostFixedDepositAccountsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostFixedDepositAccountsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/fixeddepositaccounts/{accountId}/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Fixed Deposit Account"
|
|
],
|
|
"operationId": "accountClosureTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountId",
|
|
"in": "path",
|
|
"description": "accountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/fixeddepositaccounts/downloadtemplate": {
|
|
"get": {
|
|
"tags": [
|
|
"Fixed Deposit Account"
|
|
],
|
|
"operationId": "getFixedDepositTemplate",
|
|
"produces": [
|
|
"application/vnd.ms-excel"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "staffId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"default": {
|
|
"description": "successful operation"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/fixeddepositaccounts/uploadtemplate": {
|
|
"post": {
|
|
"tags": [
|
|
"Fixed Deposit Account"
|
|
],
|
|
"operationId": "postFixedDepositTemplate",
|
|
"consumes": [
|
|
"multipart/form-data"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "file",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "file"
|
|
},
|
|
{
|
|
"name": "locale",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/fixeddepositaccounts/transaction/downloadtemplate": {
|
|
"get": {
|
|
"tags": [
|
|
"Fixed Deposit Account"
|
|
],
|
|
"operationId": "getFixedDepositTransactionTemplate",
|
|
"produces": [
|
|
"application/vnd.ms-excel"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"default": {
|
|
"description": "successful operation"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/fixeddepositaccounts/transaction/uploadtemplate": {
|
|
"post": {
|
|
"tags": [
|
|
"Fixed Deposit Account"
|
|
],
|
|
"operationId": "postFixedDepositTransactionTemplate",
|
|
"consumes": [
|
|
"multipart/form-data"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "file",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "file"
|
|
},
|
|
{
|
|
"name": "locale",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/fixeddepositaccounts/{accountId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Fixed Deposit Account"
|
|
],
|
|
"summary": "Retrieve a fixed deposit application/account",
|
|
"description": "Retrieves a fixed deposit application/account\n\nExample Requests :\n\n\n\nfixeddepositaccounts/1\n\nfixeddepositaccounts/1?associations=all",
|
|
"operationId": "retrieveOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountId",
|
|
"in": "path",
|
|
"description": "accountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "staffInSelectedOfficeOnly",
|
|
"in": "query",
|
|
"description": "staffInSelectedOfficeOnly",
|
|
"required": false,
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
{
|
|
"name": "chargeStatus",
|
|
"in": "query",
|
|
"description": "chargeStatus",
|
|
"required": false,
|
|
"type": "string",
|
|
"default": "all"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsAccountIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Fixed Deposit Account"
|
|
],
|
|
"summary": "Approve fixed deposit application | Undo approval fixed deposit application | Reject fixed deposit application | Withdraw fixed deposit application | Activate a fixed deposit account | Close a fixed deposit account | Premature Close a fixed deposit account | Calculate Premature amount on Fixed deposit account | Calculate Interest on Fixed Deposit Account | Post Interest on Fixed Deposit Account",
|
|
"description": "Approve fixed deposit application:\n\nApproves fixed deposit application so long as its in 'Submitted and pending approval' state.\n\nUndo approval fixed deposit application:\n\nWill move 'approved' fixed deposit application back to 'Submitted and pending approval' state.\n\nReject fixed deposit application:\n\nRejects fixed deposit application so long as its in 'Submitted and pending approval' state.\n\nWithdraw fixed deposit application:\n\nUsed when an applicant withdraws from the fixed deposit application. It must be in 'Submitted and pending approval' state.\n\nClose a fixed deposit account:\n\nResults in a Matured fixed deposit account being converted into a 'closed' fixed deposit account.\n\nPremature Close a fixed deposit account:\n\nResults in an Active fixed deposit account being converted into a 'Premature Closed' fixed deposit account with options to withdraw prematured amount. (premature amount is calculated using interest rate chart applicable along with penal interest if any.)\n\nCalculate Premature amount on Fixed deposit account:\n\nCalculate premature amount on fixed deposit account till premature close date. Premature amount is calculated based on interest chart and penal interest applicable.\n\nCalculate Interest on Fixed Deposit Account:\n\nCalculates interest earned on a fixed deposit account based on todays date. It does not attempt to post or credit the interest on the account. That is responsibility of the Post Interest API that will likely be called by overnight process.\n\nPost Interest on Fixed Deposit Account:\n\nCalculates and Posts interest earned on a fixed deposit account based on today's date and whether an interest posting or crediting event is due.\n\nShowing request/response for Calculate Interest on Fixed Deposit Account",
|
|
"operationId": "handleCommands",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountId",
|
|
"in": "path",
|
|
"description": "accountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostFixedDepositAccountsAccountIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostFixedDepositAccountsAccountIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Fixed Deposit Account"
|
|
],
|
|
"summary": "Modify a fixed deposit application",
|
|
"description": "Fixed deposit application can only be modified when in 'Submitted and pending approval' state. Once the application is approved, the details cannot be changed using this method. Specific api endpoints will be created to allow change of interest detail such as rate, compounding period, posting period etc",
|
|
"operationId": "update",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountId",
|
|
"in": "path",
|
|
"description": "accountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutFixedDepositAccountsAccountIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutFixedDepositAccountsAccountIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Fixed Deposit Account"
|
|
],
|
|
"summary": "Delete a fixed deposit application",
|
|
"description": "At present we support hard delete of fixed deposit application so long as its in 'Submitted and pending approval' state. One the application is moves past this state, it is not possible to do a 'hard' delete of the application or the account. An API endpoint will be added to close/de-activate the fixed deposit account.",
|
|
"operationId": "delete",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountId",
|
|
"in": "path",
|
|
"description": "accountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteFixedDepositAccountsAccountIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/fixeddepositaccounts/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Fixed Deposit Account"
|
|
],
|
|
"summary": "Retrieve Fixed Deposit Account Template",
|
|
"description": "This is a convenience resource. It can be useful when building maintenance user interface screens for fixed deposit applications. The template data returned consists of any or all of:\n\n\n\nField Defaults\n\nAllowed Value ListsExample Requests:\n\n\n\nfixeddepositaccounts/template?clientId=1",
|
|
"operationId": "template",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "query",
|
|
"description": "clientId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "groupId",
|
|
"in": "query",
|
|
"description": "groupId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "productId",
|
|
"in": "query",
|
|
"description": "productId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "staffInSelectedOfficeOnly",
|
|
"in": "query",
|
|
"description": "staffInSelectedOfficeOnly",
|
|
"required": false,
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/fixeddepositproducts/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Fixed Deposit Product"
|
|
],
|
|
"operationId": "retrieveTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/fixeddepositproducts": {
|
|
"get": {
|
|
"tags": [
|
|
"Fixed Deposit Product"
|
|
],
|
|
"summary": "List Fixed Deposit Products",
|
|
"description": "Lists Fixed Deposit Products\n\nExample Requests:\n\nfixeddepositproducts\n\n\nfixeddepositproducts?fields=name",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Fixed Deposit Product"
|
|
],
|
|
"summary": "Create a Fixed Deposit Product",
|
|
"description": "Creates a Fixed Deposit Product\n\nMandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minDepositTerm, minDepositTermTypeId, accountingRule\n\nOptional Fields: lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, charts, , withHoldTax, taxGroupId\n\n\nMandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId",
|
|
"operationId": "create",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostFixedDepositProductsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostFixedDepositProductsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/fixeddepositproducts/{productId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Fixed Deposit Product"
|
|
],
|
|
"summary": "Retrieve a Fixed Deposit Product",
|
|
"description": "Retrieves a Fixed Deposit Product\n\nExample Requests:\n\nfixeddepositproducts/1\n\n\nfixeddepositproducts/1?template=true\n\n\nfixeddepositproducts/1?fields=name,description",
|
|
"operationId": "retrieveOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "productId",
|
|
"in": "path",
|
|
"description": "productId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsProductIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Fixed Deposit Product"
|
|
],
|
|
"summary": "Update a Fixed Deposit Product",
|
|
"description": "Updates a Fixed Deposit Product",
|
|
"operationId": "update",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "productId",
|
|
"in": "path",
|
|
"description": "productId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutFixedDepositProductsProductIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutFixedDepositProductsProductIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Fixed Deposit Product"
|
|
],
|
|
"summary": "Delete a Fixed Deposit Product",
|
|
"description": "Deletes a Fixed Deposit Product",
|
|
"operationId": "delete",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "productId",
|
|
"in": "path",
|
|
"description": "productId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteFixedDepositProductsProductIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/recurringdepositaccounts/{recurringDepositAccountId}/transactions/{transactionId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Recurring Deposit Account Transactions"
|
|
],
|
|
"summary": "Retrieve Recurring Deposit Account Transaction",
|
|
"description": "Retrieves Recurring Deposit Account Transaction\n\nExample Requests:\n\nrecurringdepositaccounts/1/transactions/1",
|
|
"operationId": "retrieveOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "recurringDepositAccountId",
|
|
"in": "path",
|
|
"description": "recurringDepositAccountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "transactionId",
|
|
"in": "path",
|
|
"description": "transactionId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsRecurringDepositAccountIdTransactionsTransactionIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Recurring Deposit Account Transactions"
|
|
],
|
|
"summary": "Adjust Transaction | Undo transaction",
|
|
"description": "Adjust Transaction:\n\nThis command modifies the given transaction.\n\nUndo transaction:\n\nThis command reverses the given transaction.\n\nShowing request/response for 'Adjust Transaction'",
|
|
"operationId": "handleTransactionCommands",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "recurringDepositAccountId",
|
|
"in": "path",
|
|
"description": "recurringDepositAccountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "transactionId",
|
|
"in": "path",
|
|
"description": "transactionId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsTransactionIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/recurringdepositaccounts/{recurringDepositAccountId}/transactions/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Recurring Deposit Account Transactions"
|
|
],
|
|
"summary": "Retrieve Recurring Deposit Account Transaction Template",
|
|
"description": "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:\n\nField Defaults\nAllowed Value Lists\nExample Requests:\n\nrecurringdepositaccounts/1/transactions/template?command=deposit\n\nrecurringdepositaccounts/1/transactions/template?command=withdrawal",
|
|
"operationId": "retrieveTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "recurringDepositAccountId",
|
|
"in": "path",
|
|
"description": "recurringDepositAccountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsRecurringDepositAccountIdTransactionsTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/recurringdepositaccounts/{recurringDepositAccountId}/transactions": {
|
|
"post": {
|
|
"tags": [
|
|
"Recurring Deposit Account Transactions"
|
|
],
|
|
"summary": "Deposit Transaction | Withdrawal Transaction",
|
|
"description": "Deposit Transaction:\n\nUsed for a deposit transaction\n\nWithdrawal Transaction:\n\nUsed for a Withdrawal Transaction\n\nShowing request/response for Deposit Transaction",
|
|
"operationId": "transaction",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "recurringDepositAccountId",
|
|
"in": "path",
|
|
"description": "recurringDepositAccountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/recurringdepositaccounts/downloadtemplate": {
|
|
"get": {
|
|
"tags": [
|
|
"Recurring Deposit Account"
|
|
],
|
|
"operationId": "getRecurringDepositTemplate",
|
|
"produces": [
|
|
"application/vnd.ms-excel"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "staffId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"default": {
|
|
"description": "successful operation"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/recurringdepositaccounts/uploadtemplate": {
|
|
"post": {
|
|
"tags": [
|
|
"Recurring Deposit Account"
|
|
],
|
|
"operationId": "postRecurringDepositTemplate",
|
|
"consumes": [
|
|
"multipart/form-data"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "file",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "file"
|
|
},
|
|
{
|
|
"name": "locale",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/recurringdepositaccounts/transactions/downloadtemplate": {
|
|
"get": {
|
|
"tags": [
|
|
"Recurring Deposit Account"
|
|
],
|
|
"operationId": "getRecurringDepositTransactionTemplate",
|
|
"produces": [
|
|
"application/vnd.ms-excel"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"default": {
|
|
"description": "successful operation"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/recurringdepositaccounts/transactions/uploadtemplate": {
|
|
"post": {
|
|
"tags": [
|
|
"Recurring Deposit Account"
|
|
],
|
|
"operationId": "postRecurringDepositTransactionsTemplate",
|
|
"consumes": [
|
|
"multipart/form-data"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "file",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "file"
|
|
},
|
|
{
|
|
"name": "locale",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/recurringdepositaccounts": {
|
|
"get": {
|
|
"tags": [
|
|
"Recurring Deposit Account"
|
|
],
|
|
"summary": "List Recurring deposit applications/accounts",
|
|
"description": "Lists Recurring deposit applications/accounts\n\nExample Requests:\n\nrecurringdepositaccounts\n\n\nrecurringdepositaccounts?fields=name",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "paged",
|
|
"in": "query",
|
|
"description": "paged",
|
|
"required": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"description": "orderBy",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "sortOrder",
|
|
"in": "query",
|
|
"description": "sortOrder",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Recurring Deposit Account"
|
|
],
|
|
"summary": "Submit new recurring deposit application",
|
|
"description": "Submits new recurring deposit application\n\nMandatory Fields: clientId or groupId, productId, submittedOnDate, depositAmount, depositPeriod, depositPeriodFrequencyId\n\nOptional Fields: accountNo, externalId, fieldOfficerId,linkAccountId(if provided initial deposit amount will be collected from this account),transferInterestToSavings(By enabling this flag all interest postings will be transferred to linked saving account )\n\nInherited from Product (if not provided): interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, lockinPeriodFrequency, lockinPeriodFrequencyType, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, charts, withHoldTax",
|
|
"operationId": "submitApplication",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostRecurringDepositAccountsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostRecurringDepositAccountsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/recurringdepositaccounts/{accountId}/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Recurring Deposit Account"
|
|
],
|
|
"operationId": "accountClosureTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountId",
|
|
"in": "path",
|
|
"description": "accountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/recurringdepositaccounts/{accountId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Recurring Deposit Account"
|
|
],
|
|
"summary": "Retrieve a recurring deposit application/account",
|
|
"description": "Retrieves a recurring deposit application/account\n\nExample Requests :\n\nrecurringdepositaccounts/1\n\n\nrecurringdepositaccounts/1?associations=all",
|
|
"operationId": "retrieveOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountId",
|
|
"in": "path",
|
|
"description": "accountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "staffInSelectedOfficeOnly",
|
|
"in": "query",
|
|
"description": "staffInSelectedOfficeOnly",
|
|
"required": false,
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
{
|
|
"name": "chargeStatus",
|
|
"in": "query",
|
|
"description": "chargeStatus",
|
|
"required": false,
|
|
"type": "string",
|
|
"default": "all"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsAccountIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Recurring Deposit Account"
|
|
],
|
|
"summary": "Approve recurring deposit application | Undo approval recurring deposit application | Reject recurring deposit application | Withdraw recurring deposit application | Activate a recurring deposit account | Update the recommended deposit amount for a recurring deposit account | Close a recurring deposit account | Premature Close a recurring deposit account | Calculate Premature amount on Recurring deposit account | Calculate Interest on recurring Deposit Account | Post Interest on recurring Deposit Account",
|
|
"description": "Approve recurring deposit application:\n\nApproves recurring deposit application so long as its in 'Submitted and pending approval' state.\n\nUndo approval recurring deposit application:\n\nWill move 'approved' recurring deposit application back to 'Submitted and pending approval' state.\n\nReject recurring deposit application\n\nRejects recurring deposit application so long as its in 'Submitted and pending approval' state.\n\nWithdraw recurring deposit application:\n\nUsed when an applicant withdraws from the recurring deposit application. It must be in 'Submitted and pending approval' state.\n\nActivate a recurring deposit account:\n\nResults in an approved recurring deposit application being converted into an 'active' recurring deposit account.\n\nUpdate the recommended deposit amount for a recurring deposit account:\n\nUpdates the recommended deposit amount for a RD account as on the effective date.\n\nClose a recurring deposit account\n\nResults in a Matured recurring deposit account being converted into a 'closed' recurring deposit account.\n\nOn account close allowed actions are.Premature Close a recurring deposit account:\n\nResults in an Active recurring deposit account being converted into a 'Premature Closed' recurring deposit account with options to withdraw prematured amount. (premature amount is calculated using interest rate chart applicable along with penal interest if any.)\n\nOn account premature closure allowed actions are.\n\nCalculate Premature amount on Recurring deposit account:\n\nCalculate premature amount on recurring deposit till premature close date. Premature amount is calculated based on interest chart and penal interest applicable if any.\n\nCalculate Interest on recurring Deposit Account:\n\nCalculates interest earned on a recurring deposit account based on todays date. It does not attempt to post or credit the interest on the account. That is responsibility of the Post Interest API that will likely be called by overnight process.\n\nPost Interest on recurring Deposit Account:\n\nCalculates and Posts interest earned on a recurring deposit account based on todays date and whether an interest posting or crediting event is due.\n\nShowing request/response for 'Post Interest on recurring Deposit Account'",
|
|
"operationId": "handleCommands",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountId",
|
|
"in": "path",
|
|
"description": "accountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostRecurringDepositAccountsAccountIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostRecurringDepositAccountsAccountIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Recurring Deposit Account"
|
|
],
|
|
"summary": "Modify a recurring deposit application",
|
|
"description": "Recurring deposit application can only be modified when in 'Submitted and pending approval' state. Once the application is approved, the details cannot be changed using this method. Specific api endpoints will be created to allow change of interest detail such as rate, compounding period, posting period etc",
|
|
"operationId": "update",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountId",
|
|
"in": "path",
|
|
"description": "accountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutRecurringDepositAccountsAccountIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutRecurringDepositAccountsAccountIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Recurring Deposit Account"
|
|
],
|
|
"summary": "Delete a recurring deposit application",
|
|
"description": "At present we support hard delete of recurring deposit application so long as its in 'Submitted and pending approval' state. One the application is moves past this state, it is not possible to do a 'hard' delete of the application or the account. An API endpoint will be added to close/de-activate the recurring deposit account.",
|
|
"operationId": "delete",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountId",
|
|
"in": "path",
|
|
"description": "accountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteRecurringDepositAccountsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/recurringdepositaccounts/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Recurring Deposit Account"
|
|
],
|
|
"summary": "Retrieve recurring Deposit Account Template",
|
|
"description": "This is a convenience resource. It can be useful when building maintenance user interface screens for recurring deposit applications. The template data returned consists of any or all of:\n\nField Defaults\nAllowed Value Lists\n\nExample Requests:\n\nrecurringdepositaccounts/template?clientId=1\n\n\nrecurringdepositaccounts/template?clientId=1&productId=1",
|
|
"operationId": "template",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "query",
|
|
"description": "clientId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "groupId",
|
|
"in": "query",
|
|
"description": "groupId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "productId",
|
|
"in": "query",
|
|
"description": "productId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "staffInSelectedOfficeOnly",
|
|
"in": "query",
|
|
"description": "staffInSelectedOfficeOnly",
|
|
"required": false,
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/recurringdepositproducts/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Recurring Deposit Product"
|
|
],
|
|
"operationId": "retrieveTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/recurringdepositproducts": {
|
|
"get": {
|
|
"tags": [
|
|
"Recurring Deposit Product"
|
|
],
|
|
"summary": "List Recuring Deposit Products",
|
|
"description": "Lists Recuring Deposit Products\n\nExample Requests:\n\nrecurringdepositproducts\n\n\nrecurringdepositproducts?fields=name",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Recurring Deposit Product"
|
|
],
|
|
"summary": "Create a Recurring Deposit Product",
|
|
"description": "Creates a Recurring Deposit Product\n\nMandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minDepositTerm, minDepositTermTypeId, recurringDepositFrequency, recurringDepositFrequencyTypeId, accountingRule, depositAmount\n\nMandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId\n\nOptional Fields: lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, charts, minDepositAmount, maxDepositAmount, withHoldTax, taxGroupId",
|
|
"operationId": "create",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostRecurringDepositProductsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostRecurringDepositProductsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/recurringdepositproducts/{productId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Recurring Deposit Product"
|
|
],
|
|
"summary": "Retrieve a Recurring Deposit Product",
|
|
"description": "Retrieves a Recurring Deposit Product\n\nExample Requests:\n\nrecurringdepositproducts/1\n\n\nrecurringdepositproducts/1?template=true\n\n\nrecurringdepositproducts/1?fields=name,description",
|
|
"operationId": "retrieveOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "productId",
|
|
"in": "path",
|
|
"description": "productId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsProductIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Recurring Deposit Product"
|
|
],
|
|
"summary": "Update a Recurring Deposit Product",
|
|
"description": "Updates a Recurring Deposit Product",
|
|
"operationId": "update",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "productId",
|
|
"in": "path",
|
|
"description": "productId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutRecurringDepositProductsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutRecurringDepositProductsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Recurring Deposit Product"
|
|
],
|
|
"summary": "Delete a Recurring Deposit Product",
|
|
"description": "Deletes a Recurring Deposit Product",
|
|
"operationId": "delete",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "productId",
|
|
"in": "path",
|
|
"description": "productId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteRecurringDepositProductsProductIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/savingsaccounts/{savingsAccountId}/charges": {
|
|
"get": {
|
|
"tags": [
|
|
"Savings Charges"
|
|
],
|
|
"summary": "List Savings Charges",
|
|
"description": "Lists Savings Charges\n\nExample Requests:\n\nsavingsaccounts/1/charges\n\nsavingsaccounts/1/charges?chargeStatus=all\n\nsavingsaccounts/1/charges?chargeStatus=inactive\n\nsavingsaccounts/1/charges?chargeStatus=active\n\nsavingsaccounts/1/charges?fields=name,amountOrPercentage",
|
|
"operationId": "retrieveAllSavingsAccountCharges",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "savingsAccountId",
|
|
"in": "path",
|
|
"description": "savingsAccountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "chargeStatus",
|
|
"in": "query",
|
|
"description": "chargeStatus",
|
|
"required": false,
|
|
"type": "string",
|
|
"default": "all"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetSavingsAccountsSavingsAccountIdChargesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Savings Charges"
|
|
],
|
|
"summary": "Create a Savings account Charge",
|
|
"description": "Creates a Savings account Charge\n\nMandatory Fields for Savings account Charges: chargeId, amount\n\nchargeId, amount, dueDate, dateFormat, locale\n\nchargeId, amount, feeOnMonthDay, monthDayFormat, locale",
|
|
"operationId": "addSavingsAccountCharge",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "savingsAccountId",
|
|
"in": "path",
|
|
"description": "savingsAccountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostSavingsAccountsSavingsAccountIdChargesRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostSavingsAccountsSavingsAccountIdChargesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/savingsaccounts/{savingsAccountId}/charges/{savingsAccountChargeId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Savings Charges"
|
|
],
|
|
"summary": "Retrieve a Savings account Charge",
|
|
"description": "Retrieves a Savings account Charge\n\nExample Requests:\n\n/savingsaccounts/1/charges/5\n\n\n/savingsaccounts/1/charges/5?fields=name,amountOrPercentage",
|
|
"operationId": "retrieveSavingsAccountCharge",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "savingsAccountId",
|
|
"in": "path",
|
|
"description": "savingsAccountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "savingsAccountChargeId",
|
|
"in": "path",
|
|
"description": "savingsAccountChargeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Savings Charges"
|
|
],
|
|
"summary": "Pay a Savings account Charge | Waive off a Savings account Charge | Inactivate a Savings account Charge",
|
|
"description": "Pay a Savings account Charge:\n\nAn active charge will be paid when savings account is active and having sufficient balance.\n\nWaive off a Savings account Charge:\n\nOutstanding charge amount will be waived off.\n\nInactivate a Savings account Charge:\n\nA charge will be allowed to inactivate when savings account is active and not having any dues as of today. If charge is overpaid, corresponding charge payment transactions will be reversed.\n\nShowing request/response for 'Pay a Savings account Charge'",
|
|
"operationId": "payOrWaiveSavingsAccountCharge",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "savingsAccountId",
|
|
"in": "path",
|
|
"description": "savingsAccountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "savingsAccountChargeId",
|
|
"in": "path",
|
|
"description": "savingsAccountChargeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Savings Charges"
|
|
],
|
|
"summary": "Update a Savings account Charge",
|
|
"description": "Currently Savings account Charges may be updated only if the Savings account is not yet approved.",
|
|
"operationId": "updateSavingsAccountCharge",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "savingsAccountId",
|
|
"in": "path",
|
|
"description": "savingsAccountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "savingsAccountChargeId",
|
|
"in": "path",
|
|
"description": "savingsAccountChargeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Savings Charges"
|
|
],
|
|
"summary": "Delete a Savings account Charge",
|
|
"description": "Note: Currently, A Savings account Charge may only be removed from Savings that are not yet approved.",
|
|
"operationId": "deleteSavingsAccountCharge",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "savingsAccountId",
|
|
"in": "path",
|
|
"description": "savingsAccountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "savingsAccountChargeId",
|
|
"in": "path",
|
|
"description": "savingsAccountChargeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/savingsaccounts/{savingsAccountId}/charges/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Savings Charges"
|
|
],
|
|
"summary": "Retrieve Savings Charges Template",
|
|
"description": "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:\n\nField Defaults\nAllowed Value Lists\nExample Request:\n\nsavingsaccounts/1/charges/template",
|
|
"operationId": "retrieveTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "savingsAccountId",
|
|
"in": "path",
|
|
"description": "savingsAccountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetSavingsAccountsSavingsAccountIdChargesTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/savingsaccounts/downloadtemplate": {
|
|
"get": {
|
|
"tags": [
|
|
"Savings Account"
|
|
],
|
|
"operationId": "getSavingsTemplate",
|
|
"produces": [
|
|
"application/vnd.ms-excel"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "staffId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"default": {
|
|
"description": "successful operation"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/savingsaccounts/uploadtemplate": {
|
|
"post": {
|
|
"tags": [
|
|
"Savings Account"
|
|
],
|
|
"operationId": "postSavingsTemplate",
|
|
"consumes": [
|
|
"multipart/form-data"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "file",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "file"
|
|
},
|
|
{
|
|
"name": "locale",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/savingsaccounts/transactions/downloadtemplate": {
|
|
"get": {
|
|
"tags": [
|
|
"Savings Account"
|
|
],
|
|
"operationId": "getSavingsTransactionTemplate",
|
|
"produces": [
|
|
"application/vnd.ms-excel"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"default": {
|
|
"description": "successful operation"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/savingsaccounts/transactions/uploadtemplate": {
|
|
"post": {
|
|
"tags": [
|
|
"Savings Account"
|
|
],
|
|
"operationId": "postSavingsTransactionTemplate",
|
|
"consumes": [
|
|
"multipart/form-data"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "file",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "file"
|
|
},
|
|
{
|
|
"name": "locale",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/savingsaccounts": {
|
|
"get": {
|
|
"tags": [
|
|
"Savings Account"
|
|
],
|
|
"summary": "List savings applications/accounts",
|
|
"description": "Lists savings applications/accounts\n\nExample Requests:\n\nsavingsaccounts\n\n\nsavingsaccounts?fields=name",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "sqlSearch",
|
|
"in": "query",
|
|
"description": "sqlSearch",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "externalId",
|
|
"in": "query",
|
|
"description": "externalId",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"description": "orderBy",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "sortOrder",
|
|
"in": "query",
|
|
"description": "sortOrder",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetSavingsAccountsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Savings Account"
|
|
],
|
|
"summary": "Submit new savings application",
|
|
"description": "Submits new savings application\n\nMandatory Fields: clientId or groupId, productId, submittedOnDate\n\nOptional Fields: accountNo, externalId, fieldOfficerId\n\nInherited from Product (if not provided): nominalAnnualInterestRate, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minRequiredOpeningBalance, lockinPeriodFrequency, lockinPeriodFrequencyType, withdrawalFeeForTransfers, allowOverdraft, overdraftLimit, withHoldTax\n\nAdditional Mandatory Field if Entity-Datatable Check is enabled for the entity of type Savings: datatables",
|
|
"operationId": "submitApplication",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostSavingsAccountsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostSavingsAccountsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/savingsaccounts/{accountId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Savings Account"
|
|
],
|
|
"summary": "Retrieve a savings application/account",
|
|
"description": "Retrieves a savings application/account\n\nExample Requests :\n\nsavingsaccounts/1\n\n\nsavingsaccounts/1?associations=all",
|
|
"operationId": "retrieveOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountId",
|
|
"in": "path",
|
|
"description": "accountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "staffInSelectedOfficeOnly",
|
|
"in": "query",
|
|
"description": "staffInSelectedOfficeOnly",
|
|
"required": false,
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
{
|
|
"name": "chargeStatus",
|
|
"in": "query",
|
|
"description": "chargeStatus",
|
|
"required": false,
|
|
"type": "string",
|
|
"default": "all"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetSavingsAccountsAccountIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Savings Account"
|
|
],
|
|
"summary": "Approve savings application | Undo approval savings application | Assign Savings Officer | Unassign Savings Officer | Reject savings application | Withdraw savings application | Activate a savings account | Close a savings account | Calculate Interest on Savings Account | Post Interest on Savings Account | Block Savings Account | Unblock Savings Account | Block Savings Account Credit transactions | Unblock Savings Account Credit transactions | Block Savings Account Debit transactions | Unblock Savings Account debit transactions",
|
|
"description": "Approve savings application:\n\nApproves savings application so long as its in 'Submitted and pending approval' state.\n\nUndo approval savings application:\n\nWill move 'approved' savings application back to 'Submitted and pending approval' state.\n\nAssign Savings Officer:\n\nAllows you to assign Savings Officer for existing Savings Account.\n\nUnassign Savings Officer:\n\nAllows you to unassign the Savings Officer.\n\nReject savings application:\n\nRejects savings application so long as its in 'Submitted and pending approval' state.\n\nWithdraw savings application:\n\nUsed when an applicant withdraws from the savings application. It must be in 'Submitted and pending approval' state.\n\nActivate a savings account:\n\nResults in an approved savings application being converted into an 'active' savings account.\n\nClose a savings account:\n\nResults in an Activated savings application being converted into an 'closed' savings account.\n\nclosedOnDate is closure date of savings account\n\nwithdrawBalance is a boolean value, true value of this field performs a withdrawal transaction with account's running balance.\n\nMandatory Fields: dateFormat,locale,closedOnDate\n\nOptional Fields: note, withdrawBalance, paymentTypeId, accountNumber, checkNumber, routingCode, receiptNumber, bankNumber\n\nCalculate Interest on Savings Account:\n\nCalculates interest earned on a savings account based on todays date. It does not attempt to post or credit the interest on the account. That is responsibility of the Post Interest API that will likely be called by overnight process.\n\nPost Interest on Savings Account:\n\nCalculates and Posts interest earned on a savings account based on today's date and whether an interest posting or crediting event is due.\n\nBlock Savings Account:\n\nBlocks Savings account from all types of credit and debit transactions\n\nUnblock Savings Account:\n\nUnblock a blocked account. On unblocking account, user can perform debit and credit transactions\n\nBlock Savings Account Credit transactions:\n\nSavings account will be blocked from all types of credit transactions.\n\nUnblock Savings Account Credit transactions:\n\nIt unblocks the Saving account's credit operations. Now all types of credits can be transacted to Savings account\n\nBlock Savings Account Debit transactions:\n\nAll types of debit operations from Savings account wil be blocked\n\nUnblock Savings Account debit transactions:\n\nIt unblocks the Saving account's debit operations. Now all types of debits can be transacted from Savings account\n\nShowing request/response for 'Unassign Savings Officer'",
|
|
"operationId": "handleCommands",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountId",
|
|
"in": "path",
|
|
"description": "accountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostSavingsAccountsAccountIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostSavingsAccountsAccountIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Savings Account"
|
|
],
|
|
"summary": "Modify a savings application | Modify savings account withhold tax applicability",
|
|
"description": "Modify a savings application:\n\nSavings application can only be modified when in 'Submitted and pending approval' state. Once the application is approved, the details cannot be changed using this method. Specific api endpoints will be created to allow change of interest detail such as rate, compounding period, posting period etc\n\nModify savings account withhold tax applicability:\n\nSavings 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-versaShowing request/response for 'Modify a savings application'",
|
|
"operationId": "update",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountId",
|
|
"in": "path",
|
|
"description": "accountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutSavingsAccountsAccountIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutSavingsAccountsAccountIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Savings Account"
|
|
],
|
|
"summary": "Delete a savings application",
|
|
"description": "At present we support hard delete of savings application so long as its in 'Submitted and pending approval' state. One the application is moves past this state, it is not possible to do a 'hard' delete of the application or the account. An API endpoint will be added to close/de-activate the savings account.",
|
|
"operationId": "delete",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountId",
|
|
"in": "path",
|
|
"description": "accountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteSavingsAccountsAccountIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/savingsaccounts/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Savings Account"
|
|
],
|
|
"summary": "Retrieve Savings Account Template",
|
|
"description": "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:\n\nField Defaults\nAllowed Value Lists\n\nExample Requests:\n\nsavingsaccounts/template?clientId=1\n\n\nsavingsaccounts/template?clientId=1&productId=1",
|
|
"operationId": "template",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "query",
|
|
"description": "clientId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "groupId",
|
|
"in": "query",
|
|
"description": "groupId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "productId",
|
|
"in": "query",
|
|
"description": "productId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "staffInSelectedOfficeOnly",
|
|
"in": "query",
|
|
"description": "staffInSelectedOfficeOnly",
|
|
"required": false,
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetSavingsAccountsTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/savingsproducts/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Savings Product"
|
|
],
|
|
"summary": "Retrieve Savings Product Template",
|
|
"description": "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:\n\nField Defaults\nAllowed Value Lists\nExample Request:\n\nsavingsproducts/template",
|
|
"operationId": "retrieveTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetSavingsProductsTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/savingsproducts": {
|
|
"get": {
|
|
"tags": [
|
|
"Savings Product"
|
|
],
|
|
"summary": "List Savings Products",
|
|
"description": "Lists Savings Products\n\nExample Requests:\n\nsavingsproducts\n\nsavingsproducts?fields=name",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetSavingsProductsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Savings Product"
|
|
],
|
|
"summary": "Create a Savings Product",
|
|
"description": "Creates a Savings Product\n\nMandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, nominalAnnualInterestRate, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType,accountingRule\n\nMandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId\n\nOptional Fields: minRequiredOpeningBalance, lockinPeriodFrequency, lockinPeriodFrequencyType, withdrawalFeeForTransfers, paymentChannelToFundSourceMappings, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, allowOverdraft, overdraftLimit, minBalanceForInterestCalculation,withHoldTax,taxGroupId",
|
|
"operationId": "create",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostSavingsProductsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostSavingsProductsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/savingsproducts/{productId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Savings Product"
|
|
],
|
|
"summary": "Retrieve a Savings Product",
|
|
"description": "Retrieves a Savings Product\n\nExample Requests:\n\nsavingsproducts/1\n\nsavingsproducts/1?template=true\n\nsavingsproducts/1?fields=name,description",
|
|
"operationId": "retrieveOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "productId",
|
|
"in": "path",
|
|
"description": "productId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetSavingsProductsProductIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Savings Product"
|
|
],
|
|
"summary": "Update a Savings Product",
|
|
"description": "Updates a Savings Product",
|
|
"operationId": "update",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "productId",
|
|
"in": "path",
|
|
"description": "productId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutSavingsProductsProductIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutSavingsProductsProductIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Savings Product"
|
|
],
|
|
"summary": "Delete a Savings Product",
|
|
"description": "Deletes a Savings Product",
|
|
"operationId": "delete",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "productId",
|
|
"in": "path",
|
|
"description": "productId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteSavingsProductsProductIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/beneficiaries/tpt/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Beneficiary Third Party Transfer"
|
|
],
|
|
"summary": "Beneficiary Third Party Transfer Template",
|
|
"description": "Returns Account Type enumerations. Self User is expected to know office name and account number to be able to add beneficiary.\n\nExample Requests:\n\n/self/beneficiaries/tpt/template",
|
|
"operationId": "template",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetSelfBeneficiariesTPTTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/beneficiaries/tpt": {
|
|
"get": {
|
|
"tags": [
|
|
"Beneficiary Third Party Transfer"
|
|
],
|
|
"summary": "Get All TPT Beneficiary",
|
|
"description": "Api to get all third party beneficiary linked to current user.\n\nExample Requests:\n\n/self/beneficiaries/tpt",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetSelfBeneficiariesTPTResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Beneficiary Third Party Transfer"
|
|
],
|
|
"summary": "Add TPT Beneficiary",
|
|
"description": "Api to add third party beneficiary linked to current user.\n\nParameter Definitions\n\nname : Nick name for beneficiary, should be unique for an self service user\n\nofficeName : Office Name of beneficiary(not id)\n\naccountNumber : Account Number of beneficiary(not id)\n\ntransferLimit : Each transfer initiated to this account will not exceed this amount\n\nExample Requests:\n\n/self/beneficiaries/tpt\n\nMandatory Fields: name, officeName, accountNumber, accountType\n\nOptional Fields: transferLimit",
|
|
"operationId": "add",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostSelfBeneficiariesTPTRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostSelfBeneficiariesTPTResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/beneficiaries/tpt/{beneficiaryId}": {
|
|
"put": {
|
|
"tags": [
|
|
"Beneficiary Third Party Transfer"
|
|
],
|
|
"summary": "Update TPT Beneficiary",
|
|
"description": "Api to update third party beneficiary linked to current user.\n\nExample Requests:\n\n/self/beneficiaries/tpt/{beneficiaryId}\n\nOptional Fields: name, transferLimit",
|
|
"operationId": "update",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "beneficiaryId",
|
|
"in": "path",
|
|
"description": "beneficiaryId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutSelfBeneficiariesTPTBeneficiaryIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutSelfBeneficiariesTPTBeneficiaryIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Beneficiary Third Party Transfer"
|
|
],
|
|
"summary": "Delete TPT Beneficiary",
|
|
"description": "Api to delete third party beneficiary linked to current user.\n\nExample Requests:\n\n/self/beneficiaries/tpt/{beneficiaryId}",
|
|
"operationId": "delete",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "beneficiaryId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteSelfBeneficiariesTPTBeneficiaryIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/clients/{clientId}/charges": {
|
|
"get": {
|
|
"tags": [
|
|
"Self Client"
|
|
],
|
|
"summary": "List Client Charges",
|
|
"description": "The list capability of client charges supports pagination.\n\nExample Requests:\n\nself/clients/1/charges\n\nself/clients/1/charges?offset=0&limit=5",
|
|
"operationId": "retrieveAllClientCharges",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "chargeStatus",
|
|
"in": "query",
|
|
"description": "chargeStatus",
|
|
"required": false,
|
|
"type": "string",
|
|
"default": "all"
|
|
},
|
|
{
|
|
"name": "pendingPayment",
|
|
"in": "query",
|
|
"description": "pendingPayment",
|
|
"required": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetSelfClientsClientIdChargesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/clients/{clientId}/charges/{chargeId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Self Client"
|
|
],
|
|
"summary": "Retrieve a Client Charge",
|
|
"description": "Retrieves a Client Charge\n\nExample Requests:\n\nself/clients/1/charges/1\n\n\nself/clients/1/charges/1?fields=name,id",
|
|
"operationId": "retrieveClientCharge",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "chargeId",
|
|
"in": "path",
|
|
"description": "chargeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetSelfClientsClientIdChargesChargeIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/clients/{clientId}/accounts": {
|
|
"get": {
|
|
"tags": [
|
|
"Self Client"
|
|
],
|
|
"summary": "Retrieve client accounts overview",
|
|
"description": "An example of how a loan portfolio summary can be provided. This is requested in a specific use case of the community application.\nIt is quite reasonable to add resources like this to simplify User Interface development.\n\nExample Requests:\n\nself/clients/1/accounts\n\n\nself/clients/1/accounts?fields=loanAccounts,savingsAccounts",
|
|
"operationId": "retrieveAssociatedAccounts",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetSelfClientsClientIdAccountsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/clients/{clientId}/obligeedetails": {
|
|
"get": {
|
|
"tags": [
|
|
"Self Client"
|
|
],
|
|
"operationId": "retrieveObligeeDetails",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/clients/{clientId}/transactions": {
|
|
"get": {
|
|
"tags": [
|
|
"Self Client"
|
|
],
|
|
"summary": "List Client Transactions",
|
|
"description": "The list capability of client transaction can support pagination.\n\nExample Requests:\n\nself/clients/189/transactions\n\nself/clients/189/transactions?offset=10&limit=50",
|
|
"operationId": "retrieveAllClientTransactions",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetSelfClientsClientIdTransactionsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/clients/{clientId}/transactions/{transactionId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Self Client"
|
|
],
|
|
"summary": "Retrieve a Client Transaction",
|
|
"description": "Retrieves a Client TransactionExample Requests:\n\nself/clients/1/transactions/1\n\n\nself/clients/1/transactions/1?fields=id,officeName",
|
|
"operationId": "retrieveClientTransaction",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "transactionId",
|
|
"in": "path",
|
|
"description": "transactionId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetSelfClientsClientIdTransactionsTransactionIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/clients/{clientId}/images": {
|
|
"get": {
|
|
"tags": [
|
|
"Self Client"
|
|
],
|
|
"summary": "Retrieve Client Image",
|
|
"description": "Optional arguments are identical to those of Get Image associated with an Entity (Binary file)\n\nExample Requests:\n\nself/clients/1/images",
|
|
"operationId": "retrieveImage",
|
|
"consumes": [
|
|
"text/plain",
|
|
"text/html",
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"text/plain"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "maxWidth",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"x-example": "maxWidth"
|
|
},
|
|
{
|
|
"name": "maxHeight",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"x-example": "maxHeight"
|
|
},
|
|
{
|
|
"name": "output",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string",
|
|
"x-example": "output"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Self Client"
|
|
],
|
|
"operationId": "addNewClientImage",
|
|
"consumes": [
|
|
"multipart/form-data"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "Content-Length",
|
|
"in": "header",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "file",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "file"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Self Client"
|
|
],
|
|
"operationId": "deleteClientImage",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/clients": {
|
|
"get": {
|
|
"tags": [
|
|
"Self Client"
|
|
],
|
|
"summary": "List Clients associated to the user",
|
|
"description": "The list capability of clients can support pagination and sorting.\n\nExample Requests:\n\nself/clients\n\nself/clients?fields=displayName,officeName\n\nself/clients?offset=10&limit=50\n\nself/clients?orderBy=displayName&sortOrder=DESC",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "displayName",
|
|
"in": "query",
|
|
"description": "displayName",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "firstName",
|
|
"in": "query",
|
|
"description": "firstName",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "lastName",
|
|
"in": "query",
|
|
"description": "lastName",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"in": "query",
|
|
"description": "offset",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "orderBy",
|
|
"in": "query",
|
|
"description": "orderBy",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "sortOrder",
|
|
"in": "query",
|
|
"description": "sortOrder",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetSelfClientsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/clients/{clientId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Self Client"
|
|
],
|
|
"summary": "Retrieve a Client",
|
|
"description": "Retrieves a Client\n\nExample Requests:\n\nself/clients/1\n\nself/clients/1?fields=id,displayName,officeName",
|
|
"operationId": "retrieveOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetSelfClientsClientIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/loans/{loanId}/transactions/{transactionId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Self Loans"
|
|
],
|
|
"summary": "Retrieve a Loan Transaction Details",
|
|
"description": "Retrieves a Loan Transaction DetailsExample Request:\n\nself/loans/5/transactions/3",
|
|
"operationId": "retrieveTransaction",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "transactionId",
|
|
"in": "path",
|
|
"description": "transactionId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetSelfLoansLoanIdTransactionsTransactionIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/loans/{loanId}/guarantors": {
|
|
"get": {
|
|
"tags": [
|
|
"Self Loans"
|
|
],
|
|
"operationId": "retrieveGuarantorDetails",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/loans": {
|
|
"post": {
|
|
"tags": [
|
|
"Self Loans"
|
|
],
|
|
"summary": "Calculate Loan Repayment Schedule | Submit a new Loan Application",
|
|
"description": "Calculate Loan Repayment Schedule:\n\nCalculates Loan Repayment Schedule\n\nMandatory Fields: productId, principal, loanTermFrequency, loanTermFrequencyType, numberOfRepayments, repaymentEvery, repaymentFrequencyType, interestRatePerPeriod, amortizationType, interestType, interestCalculationPeriodType, expectedDisbursementDate, transactionProcessingStrategyId\n\nSubmit a new Loan Application:\n\nMandatory Fields: clientId, productId, principal, loanTermFrequency, loanTermFrequencyType, loanType, numberOfRepayments, repaymentEvery, repaymentFrequencyType, interestRatePerPeriod, amortizationType, interestType, interestCalculationPeriodType, transactionProcessingStrategyId, expectedDisbursementDate, submittedOnDate, loanType\n\nAdditional Mandatory Fields if interest recalculation is enabled for product and Rest frequency not same as repayment period: recalculationRestFrequencyDate\n\nAdditional Mandatory Fields if interest recalculation with interest/fee compounding is enabled for product and compounding frequency not same as repayment period: recalculationCompoundingFrequencyDate\n\nAdditional Mandatory Field if Entity-Datatable Check is enabled for the entity of type loan: datatables\n\nOptional Fields: graceOnPrincipalPayment, graceOnInterestPayment, graceOnInterestCharged, linkAccountId, allowPartialPeriodInterestCalcualtion, fixedEmiAmount, maxOutstandingLoanBalance, disbursementData, graceOnArrearsAgeing, createStandingInstructionAtDisbursement (requires linkedAccountId if set to true)\n\nShowing request/response for 'Submit a new Loan Application'",
|
|
"operationId": "calculateLoanScheduleOrSubmitLoanApplication",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostSelfLoansRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostSelfLoansResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/loans/{loanId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Self Loans"
|
|
],
|
|
"summary": "Retrieve a Loan",
|
|
"description": "Retrieves a Loan\n\nExample Requests:\n\nself/loans/1\n\n\nself/loans/1?fields=id,principal,annualInterestRate\n\n\nself/loans/1?fields=id,principal,annualInterestRate&associations=repaymentSchedule,transactions",
|
|
"operationId": "retrieveLoan",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetSelfLoansLoanIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Self Loans"
|
|
],
|
|
"summary": "Applicant Withdraws from Loan Application",
|
|
"description": "Applicant Withdraws from Loan Application\n\nMandatory Fields: withdrawnOnDate",
|
|
"operationId": "stateTransitions",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostSelfLoansLoanIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostSelfLoansLoanIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Self Loans"
|
|
],
|
|
"summary": "Update a Loan Application",
|
|
"description": "Loan application can only be modified when in 'Submitted and pending approval' state. Once the application is approved, the details cannot be changed using this method.",
|
|
"operationId": "modifyLoanApplication",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutSelfLoansLoanIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutSelfLoansLoanIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/loans/{loanId}/charges": {
|
|
"get": {
|
|
"tags": [
|
|
"Self Loans"
|
|
],
|
|
"summary": "List Loan Charges",
|
|
"description": "Lists loan Charges\n\nExample Requests:\n\nself/loans/1/charges\n\n\nself/loans/1/charges?fields=name,amountOrPercentage",
|
|
"operationId": "retrieveAllLoanCharges",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetSelfLoansLoanIdChargesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/loans/{loanId}/charges/{chargeId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Self Loans"
|
|
],
|
|
"summary": "Retrieve a Loan Charge",
|
|
"description": "Retrieves a Loan Charge\n\nExample Requests:\n\nself/loans/1/charges/1\n\n\nself/loans/1/charges/1?fields=name,amountOrPercentage",
|
|
"operationId": "retrieveLoanCharge",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "loanId",
|
|
"in": "path",
|
|
"description": "loanId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "chargeId",
|
|
"in": "path",
|
|
"description": "chargeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetSelfLoansLoanIdChargesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/loans/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Self Loans"
|
|
],
|
|
"summary": "Retrieve Loan Details Template",
|
|
"description": "Retrieves Loan Details Template\n\nThis 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:\n\nField Defaults\nAllowed Value Lists\n\nExample Requests:\n\nself/loans/template?templateType=individual&clientId=1\n\n\nself/loans/template?templateType=individual&clientId=1&productId=1",
|
|
"operationId": "template",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "query",
|
|
"description": "clientId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "productId",
|
|
"in": "query",
|
|
"description": "productId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "templateType",
|
|
"in": "query",
|
|
"description": "templateType",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetSelfLoansTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/savingsaccounts/{accountId}/transactions/{transactionId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Self Savings Account"
|
|
],
|
|
"summary": "Retrieve Savings Account Transaction",
|
|
"description": "Retrieves Savings Account Transaction\n\nExample Requests:\n\nself/savingsaccounts/1/transactions/1",
|
|
"operationId": "retrieveSavingsTransaction",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountId",
|
|
"in": "path",
|
|
"description": "accountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "transactionId",
|
|
"in": "path",
|
|
"description": "transactionId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetSelfSavingsAccountsAccountIdTransactionsTransactionIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/savingsaccounts/{accountId}/charges": {
|
|
"get": {
|
|
"tags": [
|
|
"Self Savings Account"
|
|
],
|
|
"summary": "List Savings Charges",
|
|
"description": "Lists Savings Charges\n\nExample Requests:\n\nself/savingsaccounts/1/charges\n\nself/savingsaccounts/1/charges?chargeStatus=inactive\n\nself/savingsaccounts/1/charges?fields=name,amountOrPercentage",
|
|
"operationId": "retrieveAllSavingsAccountCharges",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountId",
|
|
"in": "path",
|
|
"description": "accountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "chargeStatus",
|
|
"in": "query",
|
|
"description": "chargeStatus",
|
|
"required": false,
|
|
"type": "string",
|
|
"default": "all"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetSelfSavingsAccountsAccountIdChargesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/savingsaccounts/{accountId}/charges/{savingsAccountChargeId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Self Savings Account"
|
|
],
|
|
"summary": "Retrieve a Savings account Charge",
|
|
"description": "Retrieves a Savings account Charge\n\nExample Requests:\n\nself/savingsaccounts/1/charges/5\n\n\nself/savingsaccounts/1/charges/5?fields=name,amountOrPercentage",
|
|
"operationId": "retrieveSavingsAccountCharge",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountId",
|
|
"in": "path",
|
|
"description": "accountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "savingsAccountChargeId",
|
|
"in": "path",
|
|
"description": "savingsAccountChargeId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetSelfSavingsAccountsAccountIdChargesSavingsAccountChargeIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/savingsaccounts": {
|
|
"post": {
|
|
"tags": [
|
|
"Self Savings Account"
|
|
],
|
|
"operationId": "submitSavingsAccountApplication",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/savingsaccounts/{accountId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Self Savings Account"
|
|
],
|
|
"summary": "Retrieve a savings account",
|
|
"description": "Retrieves a savings account\n\nExample Requests :\n\nself/savingsaccounts/1\n\n\nself/savingsaccounts/1?associations=transactions",
|
|
"operationId": "retrieveSavings",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountId",
|
|
"in": "path",
|
|
"description": "accountId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "chargeStatus",
|
|
"in": "query",
|
|
"description": "chargeStatus",
|
|
"required": false,
|
|
"type": "string",
|
|
"default": "all"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetSelfSavingsAccountsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Self Savings Account"
|
|
],
|
|
"operationId": "modifySavingsAccountApplication",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "accountId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/savingsaccounts/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Self Savings Account"
|
|
],
|
|
"operationId": "template",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "productId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/authentication": {
|
|
"post": {
|
|
"tags": [
|
|
"Self Authentication"
|
|
],
|
|
"summary": "Verify authentication",
|
|
"description": "Authenticates the credentials provided and returns the set roles and permissions allowed.\n\nPlease visit this link for more info - https://demo.openmf.org/api-docs/apiLive.htm#selfbasicauth",
|
|
"operationId": "authenticate",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "username",
|
|
"in": "query",
|
|
"description": "username",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "password",
|
|
"in": "query",
|
|
"description": "password",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostSelfAuthenticationResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/user": {
|
|
"put": {
|
|
"tags": [
|
|
"Self User"
|
|
],
|
|
"summary": "Update User",
|
|
"description": "This API can be used by Self Service user to update their own user information. Currently, \"password\" and \"repeatPassword\" are the only parameters accepted.",
|
|
"operationId": "update",
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutSelfUserRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutSelfUserResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self/userdetails": {
|
|
"get": {
|
|
"tags": [
|
|
"Self User Details"
|
|
],
|
|
"summary": "Fetch authenticated user details",
|
|
"description": "Checks the Authentication and returns the set roles and permissions allowed\n\nFor more info visit this link - https://demo.openmf.org/api-docs/apiLive.htm#selfoauth",
|
|
"operationId": "fetchAuthenticatedUserData",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "access_token",
|
|
"in": "query",
|
|
"description": "äccess_token",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetSelfUserDetailsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/taxes/component": {
|
|
"get": {
|
|
"tags": [
|
|
"Tax Components"
|
|
],
|
|
"summary": "List Tax Components",
|
|
"description": "List Tax Components",
|
|
"operationId": "retrieveAllTaxComponents",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetTaxesComponentsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Tax Components"
|
|
],
|
|
"summary": "Create a new Tax Component",
|
|
"description": "Creates a new Tax Component\n\nMandatory Fields: name, percentage\n\nOptional Fields: debitAccountType, debitAcountId, creditAccountType, creditAcountId, startDate",
|
|
"operationId": "createTaxCompoent",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostTaxesComponentsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostTaxesComponentsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/taxes/component/{taxComponentId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Tax Components"
|
|
],
|
|
"summary": "Retrieve Tax Component",
|
|
"description": "Retrieve Tax Component",
|
|
"operationId": "retrieveTaxComponent",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "taxComponentId",
|
|
"in": "path",
|
|
"description": "taxComponentId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetTaxesComponentsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Tax Components"
|
|
],
|
|
"summary": "Update Tax Component",
|
|
"description": "Updates Tax component. Debit and credit account details cannot be modified. All the future tax components would be replaced with the new percentage.",
|
|
"operationId": "updateTaxCompoent",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "taxComponentId",
|
|
"in": "path",
|
|
"description": "taxComponentId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutTaxesComponentsTaxComponentIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutTaxesComponentsTaxComponentIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/taxes/component/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Tax Components"
|
|
],
|
|
"operationId": "retrieveTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/taxes/group": {
|
|
"get": {
|
|
"tags": [
|
|
"Tax Group"
|
|
],
|
|
"summary": "List Tax Group",
|
|
"description": "List Tax Group",
|
|
"operationId": "retrieveAllTaxGroups",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetTaxesGroupResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Tax Group"
|
|
],
|
|
"summary": "Create a new Tax Group",
|
|
"description": "Create a new Tax Group\nMandatory Fields: name and taxComponents\nMandatory Fields in taxComponents: taxComponentId\nOptional Fields in taxComponents: id, startDate and endDate",
|
|
"operationId": "createTaxGroup",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostTaxesGroupRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostTaxesGroupResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/taxes/group/{taxGroupId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Tax Group"
|
|
],
|
|
"summary": "Retrieve Tax Group",
|
|
"description": "Retrieve Tax Group",
|
|
"operationId": "retrieveTaxGroup",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "taxGroupId",
|
|
"in": "path",
|
|
"description": "taxGroupId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetTaxesGroupResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Tax Group"
|
|
],
|
|
"summary": "Update Tax Group",
|
|
"description": "Updates Tax Group. Only end date can be up-datable and can insert new tax components.",
|
|
"operationId": "updateTaxGroup",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "taxGroupId",
|
|
"in": "path",
|
|
"description": "taxGroupId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutTaxesGroupTaxGroupIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutTaxesGroupTaxGroupIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/taxes/group/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Tax Group"
|
|
],
|
|
"operationId": "retrieveTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/surveys/{surveyId}/lookuptables/{key}": {
|
|
"get": {
|
|
"tags": [
|
|
"SPM API - LookUp Table"
|
|
],
|
|
"summary": "Retrieve a Lookup Table entry",
|
|
"description": "Retrieve a Lookup Table entry for a survey.",
|
|
"operationId": "findLookupTable",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "surveyId",
|
|
"in": "path",
|
|
"description": "Enter surveyId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "key",
|
|
"in": "path",
|
|
"description": "Enter key",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/LookupTableData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/surveys/{surveyId}/lookuptables": {
|
|
"get": {
|
|
"tags": [
|
|
"SPM API - LookUp Table"
|
|
],
|
|
"summary": "List all Lookup Table entries",
|
|
"description": "List all Lookup Table entries for a survey.",
|
|
"operationId": "fetchLookupTables",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "surveyId",
|
|
"in": "path",
|
|
"description": "Enter surveyId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/LookupTableData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"SPM API - LookUp Table"
|
|
],
|
|
"summary": "Create a Lookup Table entry",
|
|
"description": "Add a new netry to a survey.\n\nMandatory Fields\nkey, score, validFrom, validTo",
|
|
"operationId": "createLookupTable",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "surveyId",
|
|
"in": "path",
|
|
"description": "Enter surveyId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"$ref": "#/definitions/LookupTableData"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/surveys/scorecards/{surveyId}": {
|
|
"get": {
|
|
"tags": [
|
|
"SPM - Scorecards"
|
|
],
|
|
"summary": "List all Scorecard entries",
|
|
"description": "List all Scorecard entries for a survey.",
|
|
"operationId": "findBySurvey",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "surveyId",
|
|
"in": "path",
|
|
"description": "Enter surveyId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Scorecard"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"SPM - Scorecards"
|
|
],
|
|
"summary": "Create a Scorecard entry",
|
|
"description": "Add a new netry to a survey.\n\nMandatory Fields\nclientId, createdOn, questionId, responseId, staffId",
|
|
"operationId": "createScorecard",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "surveyId",
|
|
"in": "path",
|
|
"description": "Enter surveyId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"$ref": "#/definitions/ScorecardData"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/surveys/scorecards/{surveyId}/clients/{clientId}": {
|
|
"get": {
|
|
"tags": [
|
|
"SPM - Scorecards"
|
|
],
|
|
"operationId": "findBySurveyAndClient",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "surveyId",
|
|
"in": "path",
|
|
"description": "Enter surveyId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"description": "Enter clientId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/ScorecardData"
|
|
}
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/surveys/scorecards/clients/{clientId}": {
|
|
"get": {
|
|
"tags": [
|
|
"SPM - Scorecards"
|
|
],
|
|
"operationId": "findByClient",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "clientId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/ScorecardData"
|
|
}
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/surveys": {
|
|
"get": {
|
|
"tags": [
|
|
"SPM - Serveys"
|
|
],
|
|
"summary": "List all Surveys",
|
|
"description": "",
|
|
"operationId": "fetchAllSurveys",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "isActive",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "boolean"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/SurveyData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"SPM - Serveys"
|
|
],
|
|
"summary": "Create a Survey",
|
|
"description": "Adds a new survey to collect client related data.\n\nMandatory Fields\n\ncountryCode, key, name, questions, responses, sequenceNo, text, value",
|
|
"operationId": "createSurvey",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Create survey",
|
|
"required": false,
|
|
"schema": {
|
|
"$ref": "#/definitions/SurveyData"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/surveys/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"SPM - Serveys"
|
|
],
|
|
"summary": "Retrieve a Survey",
|
|
"description": "",
|
|
"operationId": "findSurvey",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"description": "Enter id",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/SurveyData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"SPM - Serveys"
|
|
],
|
|
"summary": "Deactivate Survey",
|
|
"description": "",
|
|
"operationId": "activateOrDeactivateSurvey",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"SPM - Serveys"
|
|
],
|
|
"operationId": "editSurvey",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"$ref": "#/definitions/SurveyData"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/templates/{templateId}/template": {
|
|
"get": {
|
|
"tags": [
|
|
"User Generated Documents"
|
|
],
|
|
"operationId": "getTemplateByTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "templateId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/templates/{templateId}": {
|
|
"get": {
|
|
"tags": [
|
|
"User Generated Documents"
|
|
],
|
|
"summary": "Retrieve a UGD",
|
|
"description": "Example Requests:\n\ntemplates/1",
|
|
"operationId": "retrieveOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "templateId",
|
|
"in": "path",
|
|
"description": "templateId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetTemplatesTemplateIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"User Generated Documents"
|
|
],
|
|
"operationId": "mergeTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"text/html"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "templateId",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"User Generated Documents"
|
|
],
|
|
"summary": "Update a UGD",
|
|
"description": "",
|
|
"operationId": "saveTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "templateId",
|
|
"in": "path",
|
|
"description": "templateId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutTemplatesTemplateIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutTemplatesTemplateIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"User Generated Documents"
|
|
],
|
|
"summary": "Delete a UGD",
|
|
"description": "",
|
|
"operationId": "deleteTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "templateId",
|
|
"in": "path",
|
|
"description": "templateId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteTemplatesTemplateIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/templates/template": {
|
|
"get": {
|
|
"tags": [
|
|
"User Generated Documents"
|
|
],
|
|
"summary": "Retrieve UGD Details Template",
|
|
"description": "This is a convenience resource. It can be useful when building maintenance user interface screens for UGDs. The UGD data returned consists of any or all of:\n\nARGUMENTS\nname String entity String type String text String optional mappers Mapper optional\nExample Request:\n\ntemplates/template",
|
|
"operationId": "template",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetTemplatesTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/templates": {
|
|
"get": {
|
|
"tags": [
|
|
"User Generated Documents"
|
|
],
|
|
"summary": "Retrieve all UGDs",
|
|
"description": "Example Requests:\n\ntemplates\n\nIt is also possible to get specific UGDs by entity and type:\n\ntemplates?type=0&entity=0\n[Entity: Id]\n\n\n\n\n\nclient: 0, loan: 1\n\n[Type: Id]\n\n\n\nDocument: 0, E-Mail (not yet): 1, SMS: 2",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "typeId",
|
|
"in": "query",
|
|
"description": "typeId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"default": -1,
|
|
"format": "int32"
|
|
},
|
|
{
|
|
"name": "entityId",
|
|
"in": "query",
|
|
"description": "entityId",
|
|
"required": false,
|
|
"type": "integer",
|
|
"default": -1,
|
|
"format": "int32"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetTemplatesResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"User Generated Documents"
|
|
],
|
|
"summary": "Add a UGD",
|
|
"description": "Adds a new UGD.\n\nMandatory Fields\nname\n\n\n\nExample Requests:\n\ntemplates/1",
|
|
"operationId": "createTemplate",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostTemplatesRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostTemplatesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/passwordpreferences": {
|
|
"get": {
|
|
"tags": [
|
|
"Password preferences"
|
|
],
|
|
"operationId": "retrieve",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetPasswordPreferencesTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Password preferences"
|
|
],
|
|
"summary": "Update password preferences",
|
|
"description": "",
|
|
"operationId": "update",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutPasswordPreferencesTemplateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": ""
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/passwordpreferences/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Password preferences"
|
|
],
|
|
"summary": "List Application Password validation policies",
|
|
"description": "ARGUMENTS\nExample Requests:\n\npasswordpreferences",
|
|
"operationId": "template",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetPasswordPreferencesTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/permissions": {
|
|
"get": {
|
|
"tags": [
|
|
"Permissions"
|
|
],
|
|
"summary": "List Application Permissions",
|
|
"description": "ARGUMENTS\nmakerCheckerableoptional, Values are true, false. Default is false.\nIf makerCheckerable=false or not supplied then a list of application permissions is returned. The \"selected\" attribute is always true in this case.\n\nIf makerCheckerable=true then the \"selected\" attribute shows whether the permission is enabled for Maker Check functionality.\n\nNote: Each Apache Fineract transaction is associated with a permission.\n\nExample Requests:\n\npermissions\n\n\npermissions?makerCheckerable=true\n\n\npermissions?fields=grouping,code",
|
|
"operationId": "retrieveAllPermissions",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetPermissionsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Permissions"
|
|
],
|
|
"summary": "Enable/Disable Permissions for Maker Checker",
|
|
"description": "",
|
|
"operationId": "updatePermissionsDetails",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutPermissionsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/CommandProcessingResult"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/roles": {
|
|
"get": {
|
|
"tags": [
|
|
"Roles"
|
|
],
|
|
"summary": "List Roles",
|
|
"description": "Example Requests:\n\nroles\n\n\nroles?fields=name",
|
|
"operationId": "retrieveAllRoles",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetRolesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Roles"
|
|
],
|
|
"summary": "Create a New Role",
|
|
"description": "Mandatory Fields\nname, description",
|
|
"operationId": "createRole",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostRolesRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostRolesResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/roles/{roleId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Roles"
|
|
],
|
|
"summary": "Retrieve a Role",
|
|
"description": "Example Requests:\n\nroles/1\n\n\nroles/1?fields=name",
|
|
"operationId": "retrieveRole",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "roleId",
|
|
"in": "path",
|
|
"description": "roleId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetRolesRoleIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Roles"
|
|
],
|
|
"summary": "Enable Role | Disable Role",
|
|
"description": "Description : Enable role in case role is disabled. | Disable the role in case role is not associated with any users.\n\n\n\n\n\nExample Request: https://DomainName/api/v1/roles/{roleId}?command=enable\n\n\n\n\n\nhttps://DomainName/api/v1/roles/{roleId}?command=disable",
|
|
"operationId": "actionsOnRoles",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "roleId",
|
|
"in": "path",
|
|
"description": "roleId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "command",
|
|
"in": "query",
|
|
"description": "command",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostRolesRoleIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Roles"
|
|
],
|
|
"summary": "Update a Role",
|
|
"description": "",
|
|
"operationId": "updateRole",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "roleId",
|
|
"in": "path",
|
|
"description": "roleId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutRolesRoleIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutRolesRoleIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Roles"
|
|
],
|
|
"summary": "Delete a Role",
|
|
"description": "Description : Delete the role in case role is not associated with any users.",
|
|
"operationId": "deleteRole",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "roleId",
|
|
"in": "path",
|
|
"description": "roleId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteRolesRoleIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/roles/{roleId}/permissions": {
|
|
"get": {
|
|
"tags": [
|
|
"Roles"
|
|
],
|
|
"summary": "Retrieve a Role's Permissions",
|
|
"description": "Example Requests:\n\nroles/1/permissions",
|
|
"operationId": "retrieveRolePermissions",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "roleId",
|
|
"in": "path",
|
|
"description": "roleId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetRolesRoleIdPermissionsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Roles"
|
|
],
|
|
"summary": "Update a Role's Permissions",
|
|
"description": "",
|
|
"operationId": "updateRolePermissions",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "roleId",
|
|
"in": "path",
|
|
"description": "roleId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutRolesRoleIdPermissionsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutRolesRoleIdPermissionsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/users/downloadtemplate": {
|
|
"get": {
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"operationId": "getUserTemplate",
|
|
"produces": [
|
|
"application/vnd.ms-excel"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "officeId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "staffId",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"default": {
|
|
"description": "successful operation"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/users/uploadtemplate": {
|
|
"post": {
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"operationId": "postUsersTemplate",
|
|
"consumes": [
|
|
"multipart/form-data"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "file",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "file"
|
|
},
|
|
{
|
|
"name": "locale",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "dateFormat",
|
|
"in": "formData",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"headers": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/users/template": {
|
|
"get": {
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"summary": "Retrieve User Details Template",
|
|
"description": "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:\n\nField Defaults\nAllowed Value Lists\nExample Request:\n\nusers/template",
|
|
"operationId": "template",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetUsersTemplateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/users": {
|
|
"get": {
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"summary": "Retrieve list of users",
|
|
"description": "Example Requests:\n\nusers\n\n\nusers?fields=id,username,email,officeName",
|
|
"operationId": "retrieveAll",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetUsersResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"summary": "Create a User",
|
|
"description": "Adds new application user.\n\nNote: Password information is not required (or processed). Password details at present are auto-generated and then sent to the email account given (which is why it can take a few seconds to complete).\n\nMandatory Fields: \nusername, firstname, lastname, email, officeId, roles, sendPasswordToEmail\n\nOptional Fields: \nstaffId,passwordNeverExpires,isSelfServiceUser,clients",
|
|
"operationId": "create",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PostUsersRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PostUsersResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/users/{userId}": {
|
|
"get": {
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"summary": "Retrieve a User",
|
|
"description": "Example Requests:\n\nusers/1\n\n\nusers/1?template=true\n\n\nusers/1?fields=username,officeName",
|
|
"operationId": "retrieveOne",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "userId",
|
|
"in": "path",
|
|
"description": "userId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/GetUsersUserIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"summary": "Update a User",
|
|
"description": "When updating a password you must provide the repeatPassword parameter also.",
|
|
"operationId": "update",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "userId",
|
|
"in": "path",
|
|
"description": "userId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/PutUsersUserIdRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/PutUsersUserIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"summary": "Delete a User",
|
|
"description": "Removes the user and the associated roles and permissions.",
|
|
"operationId": "delete",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "userId",
|
|
"in": "path",
|
|
"description": "userId",
|
|
"required": true,
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeleteUsersUserIdResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"definitions": {
|
|
"runaccrualsRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"tillDate"
|
|
],
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"tillDate": {
|
|
"type": "string",
|
|
"example": "04 June 2014"
|
|
}
|
|
}
|
|
},
|
|
"GetGLClosureResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 7
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"closingDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2013,1,2"
|
|
},
|
|
"deleted": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"createdDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2013,1,3"
|
|
},
|
|
"lastUpdatedDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2013,1,3"
|
|
},
|
|
"createdByUserId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"createdByUsername": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"lastUpdatedByUserId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"lastUpdatedByUsername": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"comments": {
|
|
"type": "string",
|
|
"example": "closed"
|
|
}
|
|
}
|
|
},
|
|
"PostGlClosuresResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 9
|
|
}
|
|
}
|
|
},
|
|
"PostGLCLosuresRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"closingDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "06 December 2012"
|
|
},
|
|
"comments": {
|
|
"type": "string",
|
|
"example": "The accountants are heading for a carribean vacation"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
}
|
|
}
|
|
},
|
|
"PutGlClosuresResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 9
|
|
},
|
|
"comments": {
|
|
"type": "string",
|
|
"example": "All transactions verified by Johnny Cash"
|
|
}
|
|
}
|
|
},
|
|
"PutGlClosuresRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"comments": {
|
|
"type": "string",
|
|
"example": "All transactions verified by Johnny Cash"
|
|
}
|
|
}
|
|
},
|
|
"DeleteGlClosuresResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 9
|
|
}
|
|
}
|
|
},
|
|
"CodeValueData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"active": {
|
|
"type": "boolean"
|
|
},
|
|
"mandatory": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"EnumOptionData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"code": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"FinancialActivityData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"mappedGLAccountType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ASSET",
|
|
"LIABILITY",
|
|
"EQUITY",
|
|
"INCOME",
|
|
"EXPENSE"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"GLAccountData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"glCode": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"tagId": {
|
|
"$ref": "#/definitions/CodeValueData"
|
|
},
|
|
"rowIndex": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"typeId": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
},
|
|
"GetFinancialActivityAccountsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"financialActivityData": {
|
|
"$ref": "#/definitions/FinancialActivityData"
|
|
},
|
|
"glAccountData": {
|
|
"$ref": "#/definitions/GLAccountData"
|
|
}
|
|
}
|
|
},
|
|
"PostFinancialActivityAccountsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostFinancialActivityAccountsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"financialActivityId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 200
|
|
},
|
|
"glAccountId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 2
|
|
}
|
|
}
|
|
},
|
|
"PutFinancialActivityAccountsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"comments": {
|
|
"$ref": "#/definitions/PutFinancialActivityAccountscommentsSwagger"
|
|
}
|
|
}
|
|
},
|
|
"PutFinancialActivityAccountscommentsSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"glAccountId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"DeleteFinancialActivityAccountsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"GetGLAccountsTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"disabled": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"manualEntriesAllowed": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"usage": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"accountTypeOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
}
|
|
},
|
|
"usageOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
}
|
|
},
|
|
"assetHeaderAccountOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GLAccountData"
|
|
}
|
|
},
|
|
"liabilityHeaderAccountOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GLAccountData"
|
|
}
|
|
},
|
|
"equityHeaderAccountOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GLAccountData"
|
|
}
|
|
},
|
|
"expenseHeaderAccountOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GLAccountData"
|
|
}
|
|
},
|
|
"allowedAssetsTagOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/CodeValueData"
|
|
}
|
|
},
|
|
"allowedLiabilitiesTagOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/CodeValueData"
|
|
}
|
|
},
|
|
"allowedEquityTagOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/CodeValueData"
|
|
}
|
|
},
|
|
"allowedIncomeTagOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/CodeValueData"
|
|
}
|
|
},
|
|
"allowedExpensesTagOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/CodeValueData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetGLAccountsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 16
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Cash"
|
|
},
|
|
"parentId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"glCode": {
|
|
"type": "string",
|
|
"example": "100001"
|
|
},
|
|
"disabled": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"manualEntriesAllowed": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"usage": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Desc"
|
|
},
|
|
"nameDecorated": {
|
|
"type": "string",
|
|
"example": "....Cash"
|
|
},
|
|
"tagId": {
|
|
"$ref": "#/definitions/CodeValueData"
|
|
},
|
|
"organizationRunningBalance": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 118437
|
|
}
|
|
}
|
|
},
|
|
"PostGLAccountsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 22
|
|
}
|
|
}
|
|
},
|
|
"PostGLAccountsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Cash at Bangalore"
|
|
},
|
|
"glCode": {
|
|
"type": "string",
|
|
"example": "100001"
|
|
},
|
|
"manualEntriesAllowed": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"example": "1"
|
|
},
|
|
"tagId": {
|
|
"type": "string",
|
|
"example": "10"
|
|
},
|
|
"parentId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"usage": {
|
|
"example": "1",
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Desc"
|
|
}
|
|
}
|
|
},
|
|
"PutGLAccountsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutGLAccountsResponsechangesSwagger"
|
|
}
|
|
}
|
|
},
|
|
"PutGLAccountsResponsechangesSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Cash at Bangalore"
|
|
}
|
|
}
|
|
},
|
|
"PutGLAccountsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Cash at Bangalore"
|
|
}
|
|
}
|
|
},
|
|
"DeleteGLAccountsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"JournalEntryData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"glAccountId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"glAccountType": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"transactionDate": {
|
|
"type": "string",
|
|
"format": "date"
|
|
},
|
|
"entryType": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"amount": {
|
|
"type": "number"
|
|
},
|
|
"transactionId": {
|
|
"type": "string"
|
|
},
|
|
"rowIndex": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
},
|
|
"PostJournalEntriesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "1"
|
|
},
|
|
"transactionId": {
|
|
"type": "string",
|
|
"description": "RS9MCISID4WK1ZM"
|
|
}
|
|
}
|
|
},
|
|
"JournalEntryCommand": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"transactionDate": {
|
|
"type": "string",
|
|
"format": "date"
|
|
},
|
|
"comments": {
|
|
"type": "string"
|
|
},
|
|
"referenceNumber": {
|
|
"type": "string"
|
|
},
|
|
"accountingRuleId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"credits": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/SingleDebitOrCreditEntryCommand"
|
|
}
|
|
},
|
|
"debits": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/SingleDebitOrCreditEntryCommand"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"SingleDebitOrCreditEntryCommand": {
|
|
"type": "object",
|
|
"properties": {
|
|
"glAccountId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"amount": {
|
|
"type": "number"
|
|
},
|
|
"comments": {
|
|
"type": "string"
|
|
},
|
|
"parametersPassedInRequest": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"glAccountIdChanged": {
|
|
"type": "boolean"
|
|
},
|
|
"glAmountChanged": {
|
|
"type": "boolean"
|
|
},
|
|
"commentsChanged": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"PostJournalEntriesTransactionIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "1"
|
|
}
|
|
}
|
|
},
|
|
"PostJournalEntriesTransactionIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "1"
|
|
}
|
|
}
|
|
},
|
|
"LoanProductProvisioningEntryData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"historyId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"currencyCode": {
|
|
"type": "string"
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"categoryId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"overdueInDays": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"percentage": {
|
|
"type": "number"
|
|
},
|
|
"liablityAccount": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"expenseAccount": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"criteriaId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"outstandingBalance": {
|
|
"type": "number"
|
|
}
|
|
}
|
|
},
|
|
"ProvisioningEntryData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"createdDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
}
|
|
}
|
|
},
|
|
"PostProvisioningEntriesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostProvisioningEntriesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"date": {
|
|
"type": "string",
|
|
"example": "16 October 2015"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"createjournalentries": {
|
|
"type": "string",
|
|
"example": "true"
|
|
},
|
|
"provisioningentry": {
|
|
"type": "string"
|
|
},
|
|
"entries": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"PutProvisioningEntriesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PutProvisioningEntriesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"command": {
|
|
"type": "string",
|
|
"example": "recreateprovisioningentry"
|
|
}
|
|
}
|
|
},
|
|
"AccountingTagRuleData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"tag": {
|
|
"$ref": "#/definitions/CodeValueData"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountRulesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"officeName": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"systemDefined": {
|
|
"type": "boolean"
|
|
},
|
|
"allowMultipleDebitEntries": {
|
|
"type": "boolean"
|
|
},
|
|
"allowMultipleCreditEntries": {
|
|
"type": "boolean"
|
|
},
|
|
"creditTags": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/AccountingTagRuleData"
|
|
}
|
|
},
|
|
"debitTags": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/AccountingTagRuleData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"AccountingRuleData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"creditTags": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/AccountingTagRuleData"
|
|
}
|
|
},
|
|
"debitTags": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/AccountingTagRuleData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PutAccountingRulesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutAccountingRulesResponsechangesSwagger"
|
|
}
|
|
}
|
|
},
|
|
"PutAccountingRulesResponsechangesSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Employee Salary posting rule"
|
|
}
|
|
}
|
|
},
|
|
"PutAccountingRulesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Employee Salary posting rule"
|
|
}
|
|
}
|
|
},
|
|
"DeleteAccountingRulesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostAccountingRulesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostAccountingRulesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "test"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"accountToDebit": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 21
|
|
},
|
|
"accountToCredit": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 9
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Employee salary"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountRulesTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"systemDefined": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"allowedOffices": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/OfficeData"
|
|
}
|
|
},
|
|
"allowedAccounts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GLAccountData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"OfficeData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"openingDate": {
|
|
"type": "string",
|
|
"format": "date"
|
|
},
|
|
"hierarchy": {
|
|
"type": "string"
|
|
},
|
|
"rowIndex": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
},
|
|
"BatchResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"requestId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"statusCode": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/Header"
|
|
}
|
|
},
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"Header": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"PostBatchesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"requestId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"relativeUrl": {
|
|
"type": "string",
|
|
"example": "clients"
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"example": "POST"
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/Header"
|
|
}
|
|
},
|
|
"reference": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"body": {
|
|
"$ref": "#/definitions/PostBodyRequestSwagger"
|
|
}
|
|
}
|
|
},
|
|
"PostBodyRequestSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"firstname": {
|
|
"type": "string",
|
|
"example": "\"Petra\""
|
|
},
|
|
"lastname": {
|
|
"type": "string",
|
|
"example": "\"Yton\""
|
|
},
|
|
"externalId": {
|
|
"type": "string",
|
|
"example": "\"ex_externalId1\""
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "\"dd MMMM yyyy\""
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "\"en\""
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"activationDate": {
|
|
"type": "string",
|
|
"example": "\"04 March 2009\""
|
|
},
|
|
"submittedOnDate": {
|
|
"type": "string",
|
|
"example": "\"04 March 2009\""
|
|
}
|
|
}
|
|
},
|
|
"GetMakerCheckerResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"actionName": {
|
|
"type": "string"
|
|
},
|
|
"entityName": {
|
|
"type": "string"
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"subresourceId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"maker": {
|
|
"type": "string"
|
|
},
|
|
"madeOnDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"checker": {
|
|
"type": "string"
|
|
},
|
|
"checkedOnDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"processingResult": {
|
|
"type": "string"
|
|
},
|
|
"commandAsJson": {
|
|
"type": "string"
|
|
},
|
|
"officeName": {
|
|
"type": "string"
|
|
},
|
|
"groupLevelName": {
|
|
"type": "string"
|
|
},
|
|
"groupName": {
|
|
"type": "string"
|
|
},
|
|
"clientName": {
|
|
"type": "string"
|
|
},
|
|
"loanAccountNo": {
|
|
"type": "string"
|
|
},
|
|
"savingsAccountNo": {
|
|
"type": "string"
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"loanId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"AppUserData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"rowIndex": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"selfServiceUser": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"GetMakerCheckersSearchTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"appUsers": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/AppUserData"
|
|
}
|
|
},
|
|
"actionNames": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"entityNames": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"processingResults": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/ProcessingResultLookup"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"ProcessingResultLookup": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"processingResult": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"PostMakerCheckersResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"auditId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"GetAccountNumberFormatsResponseTemplate": {
|
|
"type": "object",
|
|
"properties": {
|
|
"accountTypeOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
}
|
|
},
|
|
"prefixTypeOptions": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetAccountNumberFormatsIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 2
|
|
},
|
|
"accountType": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"prefixType": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
}
|
|
}
|
|
},
|
|
"PutAccountNumberFormatsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 2
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutAccountNumberFormatschangesSwagger"
|
|
}
|
|
}
|
|
},
|
|
"PutAccountNumberFormatschangesSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"prefixType": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": "OFFICE_NAME"
|
|
}
|
|
}
|
|
},
|
|
"PutAccountNumberFormatsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"prefixType": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"DeleteAccountNumberFormatsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 2
|
|
}
|
|
}
|
|
},
|
|
"PostAccountNumberFormatsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 4
|
|
}
|
|
}
|
|
},
|
|
"PostAccountNumberFormatsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"accountType": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"prefixType": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 101
|
|
}
|
|
}
|
|
},
|
|
"PutCachechangesSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"cacheType": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 2
|
|
}
|
|
}
|
|
},
|
|
"PutCachesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"cacheType": {
|
|
"$ref": "#/definitions/PutCachechangesSwagger"
|
|
}
|
|
}
|
|
},
|
|
"PutCachesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"cacheType": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 2
|
|
}
|
|
}
|
|
},
|
|
"GetCachesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"cacheType": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"enabled": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"CommandWrapper": {
|
|
"type": "object",
|
|
"properties": {
|
|
"groupId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"loanId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"savingsId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"entityName": {
|
|
"type": "string"
|
|
},
|
|
"taskPermissionName": {
|
|
"type": "string"
|
|
},
|
|
"entityId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"subentityId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"href": {
|
|
"type": "string"
|
|
},
|
|
"json": {
|
|
"type": "string"
|
|
},
|
|
"transactionId": {
|
|
"type": "string"
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"creditBureauId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"organisationCreditBureauId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"update": {
|
|
"type": "boolean"
|
|
},
|
|
"create": {
|
|
"type": "boolean"
|
|
},
|
|
"createDatatable": {
|
|
"type": "boolean"
|
|
},
|
|
"deleteDatatable": {
|
|
"type": "boolean"
|
|
},
|
|
"updateDatatable": {
|
|
"type": "boolean"
|
|
},
|
|
"datatableResource": {
|
|
"type": "boolean"
|
|
},
|
|
"deleteOneToOne": {
|
|
"type": "boolean"
|
|
},
|
|
"deleteMultiple": {
|
|
"type": "boolean"
|
|
},
|
|
"updateOneToOne": {
|
|
"type": "boolean"
|
|
},
|
|
"updateMultiple": {
|
|
"type": "boolean"
|
|
},
|
|
"registerDatatable": {
|
|
"type": "boolean"
|
|
},
|
|
"noteResource": {
|
|
"type": "boolean"
|
|
},
|
|
"cacheResource": {
|
|
"type": "boolean"
|
|
},
|
|
"updateOperation": {
|
|
"type": "boolean"
|
|
},
|
|
"delete": {
|
|
"type": "boolean"
|
|
},
|
|
"deleteOperation": {
|
|
"type": "boolean"
|
|
},
|
|
"surveyResource": {
|
|
"type": "boolean"
|
|
},
|
|
"registerSurvey": {
|
|
"type": "boolean"
|
|
},
|
|
"fullFilSurvey": {
|
|
"type": "boolean"
|
|
},
|
|
"workingDaysResource": {
|
|
"type": "boolean"
|
|
},
|
|
"passwordPreferencesResource": {
|
|
"type": "boolean"
|
|
},
|
|
"permissionResource": {
|
|
"type": "boolean"
|
|
},
|
|
"userResource": {
|
|
"type": "boolean"
|
|
},
|
|
"currencyResource": {
|
|
"type": "boolean"
|
|
},
|
|
"loanDisburseDetailResource": {
|
|
"type": "boolean"
|
|
},
|
|
"updateDisbursementDate": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"GetCodeValuesDataResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Passport"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Passport information"
|
|
},
|
|
"position": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
}
|
|
}
|
|
},
|
|
"PostCodeValueDataResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 4
|
|
}
|
|
}
|
|
},
|
|
"PostCodeValuesDataRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Passport"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Passport information"
|
|
},
|
|
"position": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
}
|
|
}
|
|
},
|
|
"PutCodeValueDataResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 4
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutCodeValuechangesSwagger"
|
|
}
|
|
}
|
|
},
|
|
"PutCodeValuechangesSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Passport"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Passport information"
|
|
},
|
|
"position": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
}
|
|
}
|
|
},
|
|
"PutCodeValuesDataRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Passport"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Passport information"
|
|
},
|
|
"position": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
}
|
|
}
|
|
},
|
|
"DeleteCodeValueDataResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 4
|
|
}
|
|
}
|
|
},
|
|
"PostCodesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 4
|
|
}
|
|
}
|
|
},
|
|
"PostCodesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "MyNewCode"
|
|
}
|
|
}
|
|
},
|
|
"GetCodesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Education"
|
|
},
|
|
"systemDefined": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
}
|
|
},
|
|
"PutCodesApichangesSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "MyNewCode(changed)"
|
|
}
|
|
}
|
|
},
|
|
"PutCodesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 4
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutCodesApichangesSwagger"
|
|
}
|
|
}
|
|
},
|
|
"PutCodesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "MyNewCode(changed)"
|
|
}
|
|
}
|
|
},
|
|
"DeleteCodesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 4
|
|
}
|
|
}
|
|
},
|
|
"PutExternalServiceRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"username": {
|
|
"type": "string",
|
|
"example": "test@mifos.org"
|
|
},
|
|
"password": {
|
|
"type": "string",
|
|
"example": "XXXX"
|
|
}
|
|
}
|
|
},
|
|
"ExternalServicesPropertiesData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"PutGlobalConfigurationsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 4
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutGlobalConfigurationsResponsechangesSwagger"
|
|
}
|
|
}
|
|
},
|
|
"PutGlobalConfigurationsResponsechangesSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"enabled": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
}
|
|
},
|
|
"PutGlobalConfigurationsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"enabled": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"value": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 2
|
|
}
|
|
}
|
|
},
|
|
"GetGlobalConfigurationsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"globalConfiguration": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GlobalConfigurationPropertyData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GlobalConfigurationPropertyData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"enabled": {
|
|
"type": "boolean"
|
|
},
|
|
"value": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"dateValue": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"trapDoor": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"PutDataTablesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceIdentifier": {
|
|
"type": "string",
|
|
"example": "extra_client_details"
|
|
}
|
|
}
|
|
},
|
|
"PostDataTablesRegisterDatatableAppTable": {
|
|
"type": "object"
|
|
},
|
|
"GetDataTablesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"appTableName": {
|
|
"type": "string",
|
|
"example": "m_client"
|
|
},
|
|
"datatableName": {
|
|
"type": "string",
|
|
"example": "extra_client_details"
|
|
},
|
|
"column": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/ResultsetColumnHeaderData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"ResultsetColumnHeaderData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"columnName": {
|
|
"type": "string"
|
|
},
|
|
"columnType": {
|
|
"type": "string"
|
|
},
|
|
"columnLength": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"columnDisplayType": {
|
|
"type": "string"
|
|
},
|
|
"columnCode": {
|
|
"type": "string"
|
|
},
|
|
"dateDisplayType": {
|
|
"type": "boolean"
|
|
},
|
|
"dateTimeDisplayType": {
|
|
"type": "boolean"
|
|
},
|
|
"integerDisplayType": {
|
|
"type": "boolean"
|
|
},
|
|
"decimalDisplayType": {
|
|
"type": "boolean"
|
|
},
|
|
"booleanDisplayType": {
|
|
"type": "boolean"
|
|
},
|
|
"codeValueDisplayType": {
|
|
"type": "boolean"
|
|
},
|
|
"codeLookupDisplayType": {
|
|
"type": "boolean"
|
|
},
|
|
"string": {
|
|
"type": "boolean"
|
|
},
|
|
"mandatory": {
|
|
"type": "boolean"
|
|
},
|
|
"optional": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"GetDataTablesAppTableIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"columnHeaders": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/ResultsetColumnHeaderData"
|
|
}
|
|
},
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/ResultsetRowData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"ResultsetRowData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"row": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PostDataTablesAppTableIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostDataTablesAppTableIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"BusinessDescription": {
|
|
"type": "string",
|
|
"example": "Livestock sales"
|
|
},
|
|
"Comment": {
|
|
"type": "string",
|
|
"example": "First comment made"
|
|
},
|
|
"Education_cv": {
|
|
"type": "string",
|
|
"example": "Primary"
|
|
},
|
|
"Gender_cd": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 6
|
|
},
|
|
"HighestRatePaid": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 8.5
|
|
},
|
|
"NextVisit": {
|
|
"type": "string",
|
|
"example": "01 October 2012"
|
|
},
|
|
"YearsinBusiness": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 5
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
}
|
|
}
|
|
},
|
|
"PutDataTablesAppTableIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutDataTablesAppTableIdResponseChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutDataTablesAppTableIdResponseChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"BusinessDescription": {
|
|
"type": "string",
|
|
"example": "Livestock sales updated"
|
|
}
|
|
}
|
|
},
|
|
"PutDataTablesAppTableIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"BusinessDescription": {
|
|
"type": "string",
|
|
"example": "Livestock sales updated"
|
|
}
|
|
}
|
|
},
|
|
"PutDataTablesAppTableIdDatatableIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PutDataTablesAppTableIdDatatableIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"DateOfBirth": {
|
|
"type": "string",
|
|
"example": "01 June 1982"
|
|
},
|
|
"Education_cdHighest": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 5
|
|
},
|
|
"Name": {
|
|
"type": "string",
|
|
"example": "June"
|
|
},
|
|
"OtherNotes": {
|
|
"type": "string",
|
|
"example": "More notes"
|
|
},
|
|
"PointsScore": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 20
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
}
|
|
}
|
|
},
|
|
"DeleteDataTablesDatatableAppTableIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"DeleteDataTablesDatatableAppTableIdDatatableIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostDataTablesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceIdentifier": {
|
|
"type": "string",
|
|
"example": "extra_client_details"
|
|
}
|
|
}
|
|
},
|
|
"PostDataTablesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"applicationTableName": {
|
|
"type": "string",
|
|
"example": "m_client"
|
|
},
|
|
"registeredTableName": {
|
|
"type": "string",
|
|
"example": "extra_client_details"
|
|
},
|
|
"multiRow": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"columnHeaderData": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/ResultsetColumnHeaderData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PutDataTablesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"appTableName": {
|
|
"type": "string",
|
|
"example": "m_client"
|
|
},
|
|
"dropColumns": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/PutDataTablesRequestDropColumns"
|
|
}
|
|
},
|
|
"addColumns": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/PutDataTablesRequestAddColumns"
|
|
}
|
|
},
|
|
"ChangeColumns": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/PutDataTablesRequestChangeColumns"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PutDataTablesRequestAddColumns": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Question"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"example": "Dropdown"
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "Gender"
|
|
},
|
|
"mandatory": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
}
|
|
},
|
|
"PutDataTablesRequestChangeColumns": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Question"
|
|
},
|
|
"newName": {
|
|
"type": "string",
|
|
"example": "Question 2"
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "Gender"
|
|
},
|
|
"newCode": {
|
|
"type": "string",
|
|
"example": "Gender2"
|
|
},
|
|
"mandatory": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
}
|
|
},
|
|
"PutDataTablesRequestDropColumns": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Gender_cd_Question"
|
|
}
|
|
}
|
|
},
|
|
"DeleteDataTablesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceIdentifier": {
|
|
"type": "string",
|
|
"example": "extra_client_details"
|
|
}
|
|
}
|
|
},
|
|
"PostEntityDatatableChecksTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostEntityDatatableChecksTemplateRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"entity": {
|
|
"type": "string",
|
|
"example": "m_loan"
|
|
},
|
|
"status": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 100
|
|
},
|
|
"datatableName": {
|
|
"type": "string",
|
|
"example": "Additional Details"
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"DeleteEntityDatatableChecksTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"AppUser": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
},
|
|
"firstname": {
|
|
"type": "string"
|
|
},
|
|
"lastname": {
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"type": "string"
|
|
},
|
|
"accountNonExpired": {
|
|
"type": "boolean"
|
|
},
|
|
"accountNonLocked": {
|
|
"type": "boolean"
|
|
},
|
|
"credentialsNonExpired": {
|
|
"type": "boolean"
|
|
},
|
|
"enabled": {
|
|
"type": "boolean"
|
|
},
|
|
"deleted": {
|
|
"type": "boolean"
|
|
},
|
|
"office": {
|
|
"$ref": "#/definitions/Office"
|
|
},
|
|
"staff": {
|
|
"$ref": "#/definitions/Staff"
|
|
},
|
|
"roles": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/Role"
|
|
}
|
|
},
|
|
"lastTimePasswordUpdated": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"passwordNeverExpires": {
|
|
"type": "boolean"
|
|
},
|
|
"appUserClientMappings": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/AppUserClientMapping"
|
|
}
|
|
},
|
|
"authorities": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GrantedAuthority"
|
|
}
|
|
},
|
|
"selfServiceUser": {
|
|
"type": "boolean"
|
|
},
|
|
"staffId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"staffDisplayName": {
|
|
"type": "string"
|
|
},
|
|
"notEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"AppUserClientMapping": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"client": {
|
|
"$ref": "#/definitions/Client"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"Charge": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"amount": {
|
|
"type": "number"
|
|
},
|
|
"currencyCode": {
|
|
"type": "string"
|
|
},
|
|
"chargeTimeType": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"chargeCalculation": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"chargePaymentMode": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"feeInterval": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"penalty": {
|
|
"type": "boolean"
|
|
},
|
|
"active": {
|
|
"type": "boolean"
|
|
},
|
|
"deleted": {
|
|
"type": "boolean"
|
|
},
|
|
"minCap": {
|
|
"type": "number"
|
|
},
|
|
"maxCap": {
|
|
"type": "number"
|
|
},
|
|
"account": {
|
|
"$ref": "#/definitions/GLAccount"
|
|
},
|
|
"taxGroup": {
|
|
"$ref": "#/definitions/TaxGroup"
|
|
},
|
|
"annualFee": {
|
|
"type": "boolean"
|
|
},
|
|
"monthlyFee": {
|
|
"type": "boolean"
|
|
},
|
|
"overdueInstallment": {
|
|
"type": "boolean"
|
|
},
|
|
"allowedLoanChargeTime": {
|
|
"type": "boolean"
|
|
},
|
|
"allowedClientChargeTime": {
|
|
"type": "boolean"
|
|
},
|
|
"allowedSavingsChargeTime": {
|
|
"type": "boolean"
|
|
},
|
|
"percentageOfApprovedAmount": {
|
|
"type": "boolean"
|
|
},
|
|
"allowedSavingsChargeCalculationType": {
|
|
"type": "boolean"
|
|
},
|
|
"allowedClientChargeCalculationType": {
|
|
"type": "boolean"
|
|
},
|
|
"percentageOfDisbursementAmount": {
|
|
"type": "boolean"
|
|
},
|
|
"loanCharge": {
|
|
"type": "boolean"
|
|
},
|
|
"savingsCharge": {
|
|
"type": "boolean"
|
|
},
|
|
"clientCharge": {
|
|
"type": "boolean"
|
|
},
|
|
"feeOnMonthDay": {
|
|
"$ref": "#/definitions/MonthDay"
|
|
},
|
|
"disbursementCharge": {
|
|
"type": "boolean"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"ChargeData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"penalty": {
|
|
"type": "boolean"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/CurrencyData"
|
|
},
|
|
"overdueInstallmentCharge": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"Chronology": {
|
|
"type": "object",
|
|
"properties": {
|
|
"zone": {
|
|
"$ref": "#/definitions/DateTimeZone"
|
|
}
|
|
}
|
|
},
|
|
"Client": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"office": {
|
|
"$ref": "#/definitions/Office"
|
|
},
|
|
"transferToOffice": {
|
|
"$ref": "#/definitions/Office"
|
|
},
|
|
"image": {
|
|
"$ref": "#/definitions/Image"
|
|
},
|
|
"status": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"firstname": {
|
|
"type": "string"
|
|
},
|
|
"middlename": {
|
|
"type": "string"
|
|
},
|
|
"lastname": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"staff": {
|
|
"$ref": "#/definitions/Staff"
|
|
},
|
|
"groups": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/Group"
|
|
}
|
|
},
|
|
"accountNumberRequiresAutoGeneration": {
|
|
"type": "boolean"
|
|
},
|
|
"closureDate": {
|
|
"type": "string",
|
|
"format": "date"
|
|
},
|
|
"withdrawalDate": {
|
|
"type": "string",
|
|
"format": "date"
|
|
},
|
|
"submittedOnDate": {
|
|
"type": "string",
|
|
"format": "date"
|
|
},
|
|
"legalForm": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"reopenedDate": {
|
|
"type": "string",
|
|
"format": "date"
|
|
},
|
|
"proposedTransferDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"active": {
|
|
"type": "boolean"
|
|
},
|
|
"closed": {
|
|
"type": "boolean"
|
|
},
|
|
"rejected": {
|
|
"type": "boolean"
|
|
},
|
|
"officeJoiningLocalDate": {
|
|
"type": "string",
|
|
"format": "date"
|
|
},
|
|
"withdrawn": {
|
|
"type": "boolean"
|
|
},
|
|
"notStaff": {
|
|
"type": "boolean"
|
|
},
|
|
"rejectedDate": {
|
|
"type": "string",
|
|
"format": "date"
|
|
},
|
|
"pending": {
|
|
"type": "boolean"
|
|
},
|
|
"notActive": {
|
|
"type": "boolean"
|
|
},
|
|
"notPending": {
|
|
"type": "boolean"
|
|
},
|
|
"activationLocalDate": {
|
|
"type": "string",
|
|
"format": "date"
|
|
},
|
|
"transferInProgress": {
|
|
"type": "boolean"
|
|
},
|
|
"transferOnHold": {
|
|
"type": "boolean"
|
|
},
|
|
"transferInProgressOrOnHold": {
|
|
"type": "boolean"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"CurrencyData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"DatatableCheckStatusData": {
|
|
"type": "object"
|
|
},
|
|
"DatatableChecksData": {
|
|
"type": "object"
|
|
},
|
|
"DateTimeField": {
|
|
"type": "object",
|
|
"properties": {
|
|
"durationField": {
|
|
"$ref": "#/definitions/DurationField"
|
|
},
|
|
"rangeDurationField": {
|
|
"$ref": "#/definitions/DurationField"
|
|
},
|
|
"leapDurationField": {
|
|
"$ref": "#/definitions/DurationField"
|
|
},
|
|
"minimumValue": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"maximumValue": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"lenient": {
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/DateTimeFieldType"
|
|
},
|
|
"supported": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"DateTimeFieldType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"rangeDurationType": {
|
|
"$ref": "#/definitions/DurationFieldType"
|
|
},
|
|
"durationType": {
|
|
"$ref": "#/definitions/DurationFieldType"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"DateTimeZone": {
|
|
"type": "object",
|
|
"properties": {
|
|
"fixed": {
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"DurationField": {
|
|
"type": "object",
|
|
"properties": {
|
|
"precise": {
|
|
"type": "boolean"
|
|
},
|
|
"unitMillis": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/DurationFieldType"
|
|
},
|
|
"supported": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"DurationFieldType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"FloatingRate": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"floatingRatePeriods": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/FloatingRatePeriod"
|
|
}
|
|
},
|
|
"createdBy": {
|
|
"$ref": "#/definitions/AppUser"
|
|
},
|
|
"modifiedBy": {
|
|
"$ref": "#/definitions/AppUser"
|
|
},
|
|
"createdOn": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"modifiedOn": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"active": {
|
|
"type": "boolean"
|
|
},
|
|
"baseLendingRate": {
|
|
"type": "boolean"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"FloatingRatePeriod": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"fromDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"interestRate": {
|
|
"type": "number"
|
|
},
|
|
"createdBy": {
|
|
"$ref": "#/definitions/AppUser"
|
|
},
|
|
"modifiedBy": {
|
|
"$ref": "#/definitions/AppUser"
|
|
},
|
|
"createdOn": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"modifiedOn": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"active": {
|
|
"type": "boolean"
|
|
},
|
|
"differentialToBaseLendingRate": {
|
|
"type": "boolean"
|
|
},
|
|
"floatingRatesId": {
|
|
"$ref": "#/definitions/FloatingRate"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"FundData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"GLAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"children": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GLAccount"
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"glCode": {
|
|
"type": "string"
|
|
},
|
|
"disabled": {
|
|
"type": "boolean"
|
|
},
|
|
"manualEntriesAllowed": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"usage": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"headerAccount": {
|
|
"type": "boolean"
|
|
},
|
|
"detailAccount": {
|
|
"type": "boolean"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"GetEntityDatatableChecksTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"entities": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"statusClient": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/DatatableCheckStatusData"
|
|
}
|
|
},
|
|
"statusGroup": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/DatatableCheckStatusData"
|
|
}
|
|
},
|
|
"statusSavings": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/DatatableCheckStatusData"
|
|
}
|
|
},
|
|
"statusLoans": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/DatatableCheckStatusData"
|
|
}
|
|
},
|
|
"datatables": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/DatatableChecksData"
|
|
}
|
|
},
|
|
"loanProductDatas": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/LoanProductData"
|
|
}
|
|
},
|
|
"savingsProductDatas": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/SavingsProductData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GrantedAuthority": {
|
|
"type": "object",
|
|
"properties": {
|
|
"authority": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"Group": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"office": {
|
|
"$ref": "#/definitions/Office"
|
|
},
|
|
"staff": {
|
|
"$ref": "#/definitions/Staff"
|
|
},
|
|
"parent": {
|
|
"$ref": "#/definitions/Group"
|
|
},
|
|
"groupLevel": {
|
|
"$ref": "#/definitions/GroupLevel"
|
|
},
|
|
"clientMembers": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/Client"
|
|
}
|
|
},
|
|
"submittedOnDate": {
|
|
"type": "string",
|
|
"format": "date"
|
|
},
|
|
"accountNumberRequiresAutoGeneration": {
|
|
"type": "boolean"
|
|
},
|
|
"active": {
|
|
"type": "boolean"
|
|
},
|
|
"closed": {
|
|
"type": "boolean"
|
|
},
|
|
"pending": {
|
|
"type": "boolean"
|
|
},
|
|
"notActive": {
|
|
"type": "boolean"
|
|
},
|
|
"center": {
|
|
"type": "boolean"
|
|
},
|
|
"group": {
|
|
"type": "boolean"
|
|
},
|
|
"notPending": {
|
|
"type": "boolean"
|
|
},
|
|
"activationLocalDate": {
|
|
"type": "string",
|
|
"format": "date"
|
|
},
|
|
"transferInProgress": {
|
|
"type": "boolean"
|
|
},
|
|
"transferOnHold": {
|
|
"type": "boolean"
|
|
},
|
|
"transferInProgressOrOnHold": {
|
|
"type": "boolean"
|
|
},
|
|
"childGroup": {
|
|
"type": "boolean"
|
|
},
|
|
"activeClientMembers": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/Client"
|
|
}
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"GroupLevel": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"parentId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"superParent": {
|
|
"type": "boolean"
|
|
},
|
|
"levelName": {
|
|
"type": "string"
|
|
},
|
|
"recursable": {
|
|
"type": "boolean"
|
|
},
|
|
"center": {
|
|
"type": "boolean"
|
|
},
|
|
"group": {
|
|
"type": "boolean"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"Image": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"location": {
|
|
"type": "string"
|
|
},
|
|
"storageType": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"LoanProduct": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"shortName": {
|
|
"type": "string"
|
|
},
|
|
"loanProductRelatedDetail": {
|
|
"$ref": "#/definitions/LoanProductRelatedDetail"
|
|
},
|
|
"includeInBorrowerCycle": {
|
|
"type": "boolean"
|
|
},
|
|
"startDate": {
|
|
"type": "string",
|
|
"format": "date"
|
|
},
|
|
"closeDate": {
|
|
"type": "string",
|
|
"format": "date"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"minimumDaysBetweenDisbursalAndFirstRepayment": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"productInterestRecalculationDetails": {
|
|
"$ref": "#/definitions/LoanProductInterestRecalculationDetails"
|
|
},
|
|
"loanProductGuaranteeDetails": {
|
|
"$ref": "#/definitions/LoanProductGuaranteeDetails"
|
|
},
|
|
"principalThresholdForLastInstallment": {
|
|
"type": "number"
|
|
},
|
|
"installmentAmountInMultiplesOf": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"floatingRates": {
|
|
"$ref": "#/definitions/LoanProductFloatingRates"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/MonetaryCurrency"
|
|
},
|
|
"interestRecalculationEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"equalAmortization": {
|
|
"type": "boolean"
|
|
},
|
|
"nominalInterestRatePerPeriod": {
|
|
"type": "number"
|
|
},
|
|
"interestPeriodFrequencyType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"DAYS",
|
|
"WEEKS",
|
|
"MONTHS",
|
|
"YEARS",
|
|
"WHOLE_TERM",
|
|
"INVALID"
|
|
]
|
|
},
|
|
"numberOfRepayments": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"arrearsBasedOnOriginalSchedule": {
|
|
"type": "boolean"
|
|
},
|
|
"linkedToFloatingInterestRate": {
|
|
"type": "boolean"
|
|
},
|
|
"repaymentStrategy": {
|
|
"$ref": "#/definitions/LoanTransactionProcessingStrategy"
|
|
},
|
|
"accountingType": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"loanProductCharges": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Charge"
|
|
}
|
|
},
|
|
"loanProductConfigurableAttributes": {
|
|
"$ref": "#/definitions/LoanProductConfigurableAttributes"
|
|
},
|
|
"accountingDisabled": {
|
|
"type": "boolean"
|
|
},
|
|
"cashBasedAccountingEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"accrualBasedAccountingEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"upfrontAccrualAccountingEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"periodicAccrualAccountingEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"principalAmount": {
|
|
"$ref": "#/definitions/Money"
|
|
},
|
|
"minPrincipalAmount": {
|
|
"$ref": "#/definitions/Money"
|
|
},
|
|
"maxPrincipalAmount": {
|
|
"$ref": "#/definitions/Money"
|
|
},
|
|
"minNominalInterestRatePerPeriod": {
|
|
"type": "number"
|
|
},
|
|
"maxNominalInterestRatePerPeriod": {
|
|
"type": "number"
|
|
},
|
|
"minNumberOfRepayments": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"maxNumberOfRepayments": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"multiDisburseLoan": {
|
|
"type": "boolean"
|
|
},
|
|
"holdGuaranteeFundsEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"LoanProductBorrowerCycleVariationData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"borrowerCycleNumber": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"paramType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"INVALID",
|
|
"PRINCIPAL",
|
|
"INTERESTRATE",
|
|
"REPAYMENT"
|
|
]
|
|
},
|
|
"valueConditionType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"INVALID",
|
|
"EQUAL",
|
|
"GREATERTHAN"
|
|
]
|
|
},
|
|
"defaultValue": {
|
|
"type": "number"
|
|
}
|
|
}
|
|
},
|
|
"LoanProductConfigurableAttributes": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"loanProduct": {
|
|
"$ref": "#/definitions/LoanProduct"
|
|
},
|
|
"amortizationBoolean": {
|
|
"type": "boolean"
|
|
},
|
|
"interestMethodBoolean": {
|
|
"type": "boolean"
|
|
},
|
|
"transactionProcessingStrategyBoolean": {
|
|
"type": "boolean"
|
|
},
|
|
"interestCalcPeriodBoolean": {
|
|
"type": "boolean"
|
|
},
|
|
"arrearsToleranceBoolean": {
|
|
"type": "boolean"
|
|
},
|
|
"repaymentEveryBoolean": {
|
|
"type": "boolean"
|
|
},
|
|
"graceOnPrincipalAndInterestPaymentBoolean": {
|
|
"type": "boolean"
|
|
},
|
|
"graceOnArrearsAgingBoolean": {
|
|
"type": "boolean"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"LoanProductData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"fundId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"fundName": {
|
|
"type": "string"
|
|
},
|
|
"startDate": {
|
|
"type": "string",
|
|
"format": "date"
|
|
},
|
|
"closeDate": {
|
|
"type": "string",
|
|
"format": "date"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/CurrencyData"
|
|
},
|
|
"principal": {
|
|
"type": "number"
|
|
},
|
|
"minPrincipal": {
|
|
"type": "number"
|
|
},
|
|
"maxPrincipal": {
|
|
"type": "number"
|
|
},
|
|
"numberOfRepayments": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"minNumberOfRepayments": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"maxNumberOfRepayments": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"repaymentEvery": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"repaymentFrequencyType": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"interestRatePerPeriod": {
|
|
"type": "number"
|
|
},
|
|
"minInterestRatePerPeriod": {
|
|
"type": "number"
|
|
},
|
|
"maxInterestRatePerPeriod": {
|
|
"type": "number"
|
|
},
|
|
"interestRateFrequencyType": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"annualInterestRate": {
|
|
"type": "number"
|
|
},
|
|
"interestRateDifferential": {
|
|
"type": "number"
|
|
},
|
|
"minDifferentialLendingRate": {
|
|
"type": "number"
|
|
},
|
|
"defaultDifferentialLendingRate": {
|
|
"type": "number"
|
|
},
|
|
"maxDifferentialLendingRate": {
|
|
"type": "number"
|
|
},
|
|
"amortizationType": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"interestType": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"interestCalculationPeriodType": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"allowPartialPeriodInterestCalcualtion": {
|
|
"type": "boolean"
|
|
},
|
|
"inArrearsTolerance": {
|
|
"type": "number"
|
|
},
|
|
"transactionProcessingStrategyId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"transactionProcessingStrategyName": {
|
|
"type": "string"
|
|
},
|
|
"graceOnPrincipalPayment": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"recurringMoratoriumOnPrincipalPeriods": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"graceOnInterestPayment": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"graceOnInterestCharged": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"graceOnArrearsAgeing": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"daysInMonthType": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"daysInYearType": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"interestRecalculationData": {
|
|
"$ref": "#/definitions/LoanProductInterestRecalculationData"
|
|
},
|
|
"principalVariationsForBorrowerCycle": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/LoanProductBorrowerCycleVariationData"
|
|
}
|
|
},
|
|
"interestRateVariationsForBorrowerCycle": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/LoanProductBorrowerCycleVariationData"
|
|
}
|
|
},
|
|
"numberOfRepaymentVariationsForBorrowerCycle": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/LoanProductBorrowerCycleVariationData"
|
|
}
|
|
},
|
|
"fundOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/FundData"
|
|
}
|
|
},
|
|
"repaymentFrequencyTypeOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
}
|
|
},
|
|
"interestRateFrequencyTypeOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
}
|
|
},
|
|
"amortizationTypeOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
}
|
|
},
|
|
"interestTypeOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
}
|
|
},
|
|
"interestCalculationPeriodTypeOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
}
|
|
},
|
|
"chargeOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/ChargeData"
|
|
}
|
|
},
|
|
"multiDisburseLoan": {
|
|
"type": "boolean"
|
|
},
|
|
"outstandingLoanBalance": {
|
|
"type": "number"
|
|
},
|
|
"getloanProductConfigurableAttributes": {
|
|
"$ref": "#/definitions/LoanProductConfigurableAttributes"
|
|
},
|
|
"minimumGapBetweenInstallments": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"maximumGapBetweenInstallments": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"interestRecalculationEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"equalAmortization": {
|
|
"type": "boolean"
|
|
},
|
|
"compoundingToBePostedAsTransaction": {
|
|
"type": "boolean"
|
|
},
|
|
"floatingInterestRateCalculationAllowed": {
|
|
"type": "boolean"
|
|
},
|
|
"linkedToFloatingInterestRates": {
|
|
"type": "boolean"
|
|
},
|
|
"variableInstallmentsAllowed": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"LoanProductFloatingRates": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"loanProduct": {
|
|
"$ref": "#/definitions/LoanProduct"
|
|
},
|
|
"floatingRate": {
|
|
"$ref": "#/definitions/FloatingRate"
|
|
},
|
|
"interestRateDifferential": {
|
|
"type": "number"
|
|
},
|
|
"minDifferentialLendingRate": {
|
|
"type": "number"
|
|
},
|
|
"defaultDifferentialLendingRate": {
|
|
"type": "number"
|
|
},
|
|
"maxDifferentialLendingRate": {
|
|
"type": "number"
|
|
},
|
|
"floatingInterestRateCalculationAllowed": {
|
|
"type": "boolean"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"LoanProductGuaranteeDetails": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"mandatoryGuarantee": {
|
|
"type": "number"
|
|
},
|
|
"minimumGuaranteeFromOwnFunds": {
|
|
"type": "number"
|
|
},
|
|
"minimumGuaranteeFromGuarantor": {
|
|
"type": "number"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"LoanProductInterestRecalculationData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"interestRecalculationCompoundingType": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"rescheduleStrategyType": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"recalculationRestFrequencyType": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"recalculationRestFrequencyInterval": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"recalculationRestFrequencyNthDay": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"recalculationRestFrequencyWeekday": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"recalculationRestFrequencyOnDay": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"recalculationCompoundingFrequencyType": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"recalculationCompoundingFrequencyInterval": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"recalculationCompoundingFrequencyNthDay": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"recalculationCompoundingFrequencyWeekday": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"recalculationCompoundingFrequencyOnDay": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"compoundingToBePostedAsTransaction": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"LoanProductInterestRecalculationDetails": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"interestRecalculationCompoundingMethod": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"rescheduleStrategyMethod": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"restFrequencyType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"INVALID",
|
|
"SAME_AS_REPAYMENT_PERIOD",
|
|
"DAILY",
|
|
"WEEKLY",
|
|
"MONTHLY"
|
|
]
|
|
},
|
|
"restInterval": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"restFrequencyNthDay": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"restFrequencyWeekday": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"restFrequencyOnDay": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"compoundingFrequencyType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"INVALID",
|
|
"SAME_AS_REPAYMENT_PERIOD",
|
|
"DAILY",
|
|
"WEEKLY",
|
|
"MONTHLY"
|
|
]
|
|
},
|
|
"compoundingInterval": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"compoundingFrequencyNthDay": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"compoundingFrequencyWeekday": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"compoundingFrequencyOnDay": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"isCompoundingToBePostedAsTransaction": {
|
|
"type": "boolean"
|
|
},
|
|
"arrearsBasedOnOriginalSchedule": {
|
|
"type": "boolean"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"LoanProductRelatedDetail": {
|
|
"type": "object",
|
|
"properties": {
|
|
"currency": {
|
|
"$ref": "#/definitions/MonetaryCurrency"
|
|
},
|
|
"principal": {
|
|
"$ref": "#/definitions/Money"
|
|
},
|
|
"nominalInterestRatePerPeriod": {
|
|
"type": "number"
|
|
},
|
|
"interestPeriodFrequencyType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"DAYS",
|
|
"WEEKS",
|
|
"MONTHS",
|
|
"YEARS",
|
|
"WHOLE_TERM",
|
|
"INVALID"
|
|
]
|
|
},
|
|
"annualNominalInterestRate": {
|
|
"type": "number"
|
|
},
|
|
"interestMethod": {
|
|
"type": "string",
|
|
"enum": [
|
|
"DECLINING_BALANCE",
|
|
"FLAT",
|
|
"INVALID"
|
|
]
|
|
},
|
|
"interestCalculationPeriodMethod": {
|
|
"type": "string",
|
|
"enum": [
|
|
"DAILY",
|
|
"SAME_AS_REPAYMENT_PERIOD",
|
|
"INVALID"
|
|
]
|
|
},
|
|
"allowPartialPeriodInterestCalcualtion": {
|
|
"type": "boolean"
|
|
},
|
|
"repayEvery": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"repaymentPeriodFrequencyType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"DAYS",
|
|
"WEEKS",
|
|
"MONTHS",
|
|
"YEARS",
|
|
"WHOLE_TERM",
|
|
"INVALID"
|
|
]
|
|
},
|
|
"numberOfRepayments": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"graceOnPrincipalPayment": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"graceOnInterestPayment": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"amortizationMethod": {
|
|
"type": "string",
|
|
"enum": [
|
|
"EQUAL_PRINCIPAL",
|
|
"EQUAL_INSTALLMENTS",
|
|
"INVALID"
|
|
]
|
|
},
|
|
"inArrearsTolerance": {
|
|
"$ref": "#/definitions/Money"
|
|
},
|
|
"graceOnArrearsAgeing": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"interestRecalculationEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"equalAmortization": {
|
|
"type": "boolean"
|
|
},
|
|
"graceOnDueDate": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"arrearsTolerance": {
|
|
"type": "number"
|
|
}
|
|
}
|
|
},
|
|
"LoanTransactionProcessingStrategy": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"standardStrategy": {
|
|
"type": "boolean"
|
|
},
|
|
"heavensfamilyStrategy": {
|
|
"type": "boolean"
|
|
},
|
|
"earlyPaymentStrategy": {
|
|
"type": "boolean"
|
|
},
|
|
"creocoreStrategy": {
|
|
"type": "boolean"
|
|
},
|
|
"indianRBIStrategy": {
|
|
"type": "boolean"
|
|
},
|
|
"principalInterestPenaltiesFeesOrderStrategy": {
|
|
"type": "boolean"
|
|
},
|
|
"interestPrincipalPenaltiesFeesOrderStrategy": {
|
|
"type": "boolean"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"MonetaryCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string"
|
|
},
|
|
"digitsAfterDecimal": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"currencyInMultiplesOf": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
},
|
|
"Money": {
|
|
"type": "object",
|
|
"properties": {
|
|
"currencyCode": {
|
|
"type": "string"
|
|
},
|
|
"currencyDigitsAfterDecimal": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"amount": {
|
|
"type": "number"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/MonetaryCurrency"
|
|
},
|
|
"zero": {
|
|
"type": "boolean"
|
|
},
|
|
"currencyInMultiplesOf": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"greaterThanZero": {
|
|
"type": "boolean"
|
|
},
|
|
"lessThanZero": {
|
|
"type": "boolean"
|
|
},
|
|
"amountDefaultedToNullIfZero": {
|
|
"type": "number"
|
|
}
|
|
}
|
|
},
|
|
"MonthDay": {
|
|
"type": "object",
|
|
"properties": {
|
|
"dayOfMonth": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"fieldTypes": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/DateTimeFieldType"
|
|
}
|
|
},
|
|
"monthOfYear": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"chronology": {
|
|
"$ref": "#/definitions/Chronology"
|
|
},
|
|
"values": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"fields": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/DateTimeField"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"Office": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"parent": {
|
|
"$ref": "#/definitions/Office"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"hierarchy": {
|
|
"type": "string"
|
|
},
|
|
"openingLocalDate": {
|
|
"type": "string",
|
|
"format": "date"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"Permission": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"grouping": {
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"type": "string"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"Role": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"disabled": {
|
|
"type": "boolean"
|
|
},
|
|
"permissions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Permission"
|
|
}
|
|
},
|
|
"enabled": {
|
|
"type": "boolean"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"SavingsProductData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/CurrencyData"
|
|
},
|
|
"nominalAnnualInterestRate": {
|
|
"type": "number"
|
|
},
|
|
"interestCompoundingPeriodType": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"interestPostingPeriodType": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"interestCalculationType": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"interestCalculationDaysInYearType": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"minRequiredOpeningBalance": {
|
|
"type": "number"
|
|
},
|
|
"lockinPeriodFrequency": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"lockinPeriodFrequencyType": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"withdrawalFeeForTransfers": {
|
|
"type": "boolean"
|
|
},
|
|
"allowOverdraft": {
|
|
"type": "boolean"
|
|
},
|
|
"overdraftLimit": {
|
|
"type": "number"
|
|
},
|
|
"minRequiredBalance": {
|
|
"type": "number"
|
|
},
|
|
"depositAccountType": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"Staff": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"loanOfficer": {
|
|
"type": "boolean"
|
|
},
|
|
"active": {
|
|
"type": "boolean"
|
|
},
|
|
"image": {
|
|
"$ref": "#/definitions/Image"
|
|
},
|
|
"notLoanOfficer": {
|
|
"type": "boolean"
|
|
},
|
|
"notActive": {
|
|
"type": "boolean"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"TaxComponent": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"createdBy": {
|
|
"$ref": "#/definitions/AppUser"
|
|
},
|
|
"createdDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"lastModifiedBy": {
|
|
"$ref": "#/definitions/AppUser"
|
|
},
|
|
"lastModifiedDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"percentage": {
|
|
"type": "number"
|
|
},
|
|
"debitAccountType": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"debitAcount": {
|
|
"$ref": "#/definitions/GLAccount"
|
|
},
|
|
"creditAccountType": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"creditAcount": {
|
|
"$ref": "#/definitions/GLAccount"
|
|
},
|
|
"taxComponentHistories": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/TaxComponentHistory"
|
|
}
|
|
},
|
|
"taxGroupMappings": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/TaxGroupMappings"
|
|
}
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"TaxComponentHistory": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"createdBy": {
|
|
"$ref": "#/definitions/AppUser"
|
|
},
|
|
"createdDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"lastModifiedBy": {
|
|
"$ref": "#/definitions/AppUser"
|
|
},
|
|
"lastModifiedDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"percentage": {
|
|
"type": "number"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"TaxGroup": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"createdBy": {
|
|
"$ref": "#/definitions/AppUser"
|
|
},
|
|
"createdDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"lastModifiedBy": {
|
|
"$ref": "#/definitions/AppUser"
|
|
},
|
|
"lastModifiedDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"taxGroupMappings": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/TaxGroupMappings"
|
|
}
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"TaxGroupMappings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"createdBy": {
|
|
"$ref": "#/definitions/AppUser"
|
|
},
|
|
"createdDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"lastModifiedBy": {
|
|
"$ref": "#/definitions/AppUser"
|
|
},
|
|
"lastModifiedDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"taxComponent": {
|
|
"$ref": "#/definitions/TaxComponent"
|
|
},
|
|
"endDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"GetEntityDatatableChecksResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"entity": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"datatableName": {
|
|
"type": "string"
|
|
},
|
|
"systemDefined": {
|
|
"type": "boolean"
|
|
},
|
|
"order": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"productName": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"GetReportsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"reportName": {
|
|
"type": "string",
|
|
"example": "Client Listing"
|
|
},
|
|
"reportType": {
|
|
"type": "string",
|
|
"example": "Table"
|
|
},
|
|
"reportSubType": {
|
|
"type": "string"
|
|
},
|
|
"reportCategory": {
|
|
"type": "string",
|
|
"example": "Client"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Individual Client Report Lists the small number of defined fields on the client table. Would expect to copy this report and add any one to one additional data for specific tenant needs. Can be run for any size MFI but you expect it only to be run within a branch for larger ones. Depending on how many columns are displayed, there is probably is a limit of about 20/50k clients returned for html display (export to excel doesnt have that client browser/memory impact)."
|
|
},
|
|
"reportSql": {
|
|
"type": "string"
|
|
},
|
|
"coreReport": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"useReport": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"reportParameters": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/ReportParameterData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"ReportParameterData": {
|
|
"type": "object"
|
|
},
|
|
"GetReportsTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"allowedReportTypes": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"allowedReportSubTypes": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"allowedParameters": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/ReportParameterData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PutReportResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 132
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutReportResponseChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutReportResponseChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"reportName": {
|
|
"type": "string",
|
|
"example": "Changed New Report"
|
|
},
|
|
"reportParameters": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/ReportParameterData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PutReportRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"reportName": {
|
|
"type": "string",
|
|
"example": "Completely New Report"
|
|
},
|
|
"reportParameters": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/ReportParameterData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"DeleteReportsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 132
|
|
}
|
|
}
|
|
},
|
|
"PostReportsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 132
|
|
}
|
|
}
|
|
},
|
|
"PostRepostRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"reportName": {
|
|
"type": "string",
|
|
"example": "Completely New Report"
|
|
},
|
|
"reportType": {
|
|
"type": "string",
|
|
"example": "Table"
|
|
},
|
|
"reportSubType": {
|
|
"type": "string"
|
|
},
|
|
"reportCategory": {
|
|
"type": "string",
|
|
"example": "Loan"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Just An Example"
|
|
},
|
|
"reportSql": {
|
|
"type": "string",
|
|
"example": "select 'very good sql' as AComment"
|
|
},
|
|
"reportParameters": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/ReportParameterData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetReportNameResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"columnHeaders": {
|
|
"$ref": "#/definitions/ResultsetColumnHeaderData"
|
|
},
|
|
"row": {
|
|
"$ref": "#/definitions/ResultsetRowData"
|
|
}
|
|
}
|
|
},
|
|
"GetEntityTypeEntityIdDocumentsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"parentEntityType": {
|
|
"type": "string",
|
|
"example": "clients"
|
|
},
|
|
"parentEntityId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Client Details Form"
|
|
},
|
|
"fileName": {
|
|
"type": "string",
|
|
"example": "CGAP.pdf"
|
|
},
|
|
"size": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 5246719
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"example": "application/pdf"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "A signed form signed by new member"
|
|
},
|
|
"location": {
|
|
"type": "string"
|
|
},
|
|
"storageType": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
},
|
|
"PutEntityTypeEntityIdDocumentsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 3
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutEntityTypeEntityIdDocumentsResponseChangesSwagger"
|
|
},
|
|
"resourceIdentifier": {
|
|
"type": "string",
|
|
"example": "3"
|
|
}
|
|
}
|
|
},
|
|
"PutEntityTypeEntityIdDocumentsResponseChangesSwagger": {
|
|
"type": "object"
|
|
},
|
|
"DeleteEntityTypeEntityIdDocumentsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 3
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutEntityTypeEntityIdDocumentsResponseChangesSwagger"
|
|
},
|
|
"resourceIdentifier": {
|
|
"type": "string",
|
|
"example": "3"
|
|
}
|
|
}
|
|
},
|
|
"PostEntityTypeEntityIdDocumentsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 3
|
|
},
|
|
"resourceIdentifier": {
|
|
"type": "string",
|
|
"example": "3"
|
|
}
|
|
}
|
|
},
|
|
"DeleteHookResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 4
|
|
}
|
|
}
|
|
},
|
|
"Event": {
|
|
"type": "object",
|
|
"properties": {
|
|
"actionName": {
|
|
"type": "string"
|
|
},
|
|
"entityName": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"Field": {
|
|
"type": "object",
|
|
"properties": {
|
|
"fieldName": {
|
|
"type": "string"
|
|
},
|
|
"fieldValue": {
|
|
"type": "string"
|
|
},
|
|
"fieldType": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"GetHookResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Web"
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"example": "Kremlin"
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2014, 9, 16]"
|
|
},
|
|
"updatedAt": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2014, 9, 16]"
|
|
},
|
|
"templateId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"templateName": {
|
|
"type": "string",
|
|
"example": "My UGD"
|
|
},
|
|
"events": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Event"
|
|
}
|
|
},
|
|
"config": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Field"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PostHookResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 4
|
|
}
|
|
}
|
|
},
|
|
"PostHookRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Web"
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"example": "Kremlin"
|
|
},
|
|
"templateId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"events": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Event"
|
|
}
|
|
},
|
|
"config": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Field"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PutHookResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 4
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutHookResponseChangesSwagger"
|
|
}
|
|
}
|
|
},
|
|
"PutHookResponseChangesSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string",
|
|
"example": "Kremlin"
|
|
},
|
|
"events": {
|
|
"type": "array",
|
|
"example": "1",
|
|
"items": {
|
|
"$ref": "#/definitions/Event"
|
|
}
|
|
},
|
|
"config": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Field"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PutHookRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Web"
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"example": "Kremlin"
|
|
},
|
|
"templateId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"events": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Event"
|
|
}
|
|
},
|
|
"config": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Field"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetHookTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"templates": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/HookTemplateData"
|
|
}
|
|
},
|
|
"groupings": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Grouping"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"Grouping": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"HookTemplateData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"serviceId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
}
|
|
},
|
|
"GetSchedulerResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
}
|
|
},
|
|
"PutJobsJobsIDRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string",
|
|
"example": "Update loan Summary"
|
|
},
|
|
"cronExpression": {
|
|
"type": "string",
|
|
"example": "0 0 22 1/1 * ? *"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetJobsJobIDJobRunHistoryResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalFilteredRecords": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 8
|
|
},
|
|
"pageItems": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/JobDetailHistoryDataSwagger"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"JobDetailHistoryDataSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"jobRunStartTime": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "Jul 16, 2013 12:00:00 PM"
|
|
},
|
|
"jobRunEndTime": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "Jul 16, 2013 12:00:00 PM"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"example": "success"
|
|
},
|
|
"triggerType": {
|
|
"type": "string",
|
|
"example": "cron"
|
|
}
|
|
}
|
|
},
|
|
"GetJobsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"jobId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"example": "Update loan Summary"
|
|
},
|
|
"nextRunTime": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"initializingError": {
|
|
"type": "string"
|
|
},
|
|
"cronExpression": {
|
|
"type": "string",
|
|
"example": "0 0 22 1/1 * ? *"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"currentlyRunning": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"lastRunHistory": {
|
|
"$ref": "#/definitions/JobDetailHistoryData"
|
|
}
|
|
}
|
|
},
|
|
"JobDetailHistoryData": {
|
|
"type": "object"
|
|
},
|
|
"PutReportMailingJobsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutReportMailingJobsResponseChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutReportMailingJobsResponseChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"startDateTime": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "10-08-2016 23:30:00"
|
|
}
|
|
}
|
|
},
|
|
"PutReportMailingJobsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en_GB"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd-MM-yyyy HH:mm:ss"
|
|
},
|
|
"startDateTime": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "10-08-2016 23:30:00"
|
|
}
|
|
}
|
|
},
|
|
"PostReportMailingJobsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostReportMailingJobsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en_GB"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd-MM-yyyy HH:mm:ss"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Client Numbers Report"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Client Numbers Report"
|
|
},
|
|
"startDateTime": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "1469627093000"
|
|
},
|
|
"stretchyReportId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 120
|
|
},
|
|
"emailRecipients": {
|
|
"type": "string",
|
|
"example": "info@musonisystem.com"
|
|
},
|
|
"emailSubject": {
|
|
"type": "string",
|
|
"example": "Client Numbers Report"
|
|
},
|
|
"emailMessage": {
|
|
"type": "string",
|
|
"example": "Client Numbers Report"
|
|
},
|
|
"recurrence": {
|
|
"type": "string",
|
|
"example": "FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR"
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"stretchyReportParamMap": {
|
|
"type": "string",
|
|
"example": "{\"startDate\":\"2016-07-01\",\"endDate\":\"2016-08-02\",\"selectOffice\":\"1\",\"environementUrl\":\"environementUrl\"}"
|
|
}
|
|
}
|
|
},
|
|
"DeleteReportMailingJobsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"DeleteReportMailingJobsRequest": {
|
|
"type": "object"
|
|
},
|
|
"GetReportMailingJobsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Client Numbers Report"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Client Numbers Report"
|
|
},
|
|
"startDateTime": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "1469627093000"
|
|
},
|
|
"recurrence": {
|
|
"type": "string"
|
|
},
|
|
"timeline": {
|
|
"$ref": "#/definitions/ReportMailingJobTimelineData"
|
|
},
|
|
"emailRecipients": {
|
|
"type": "string",
|
|
"example": "info@musonisystem.com"
|
|
},
|
|
"emailSubject": {
|
|
"type": "string",
|
|
"example": "Client Numbers Report"
|
|
},
|
|
"emailMessage": {
|
|
"type": "string",
|
|
"example": "Client Numbers Report"
|
|
},
|
|
"emailAttachmentFileFormat": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"stretchyReport": {
|
|
"$ref": "#/definitions/ReportData"
|
|
},
|
|
"stretchyReportParamMap": {
|
|
"type": "string",
|
|
"example": "{\"startDate\":\"2016-07-01\",\"endDate\":\"2016-08-02\",\"selectOffice\":\"1\",\"environementUrl\":\"environementUrl\"}"
|
|
},
|
|
"nextRunDateTime": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "1469627093000"
|
|
},
|
|
"numberOfRuns": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"runAsUserId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"ReportData": {
|
|
"type": "object"
|
|
},
|
|
"ReportMailingJobTimelineData": {
|
|
"type": "object"
|
|
},
|
|
"GetReportMailingJobsTemplate": {
|
|
"type": "object",
|
|
"properties": {
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"emailAttachmentFileFormatOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
}
|
|
},
|
|
"stretchyReportParamDateOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"ReportMailingJobRunHistoryData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"reportMailingJobId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"startDateTime": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"endDateTime": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"status": {
|
|
"type": "string"
|
|
},
|
|
"errorMessage": {
|
|
"type": "string"
|
|
},
|
|
"errorLog": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"PostAuthenticationResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"username": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"userId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"base64EncodedAuthenticationKey": {
|
|
"type": "string",
|
|
"example": "bWlmb3M6cGFzc3dvcmQ="
|
|
},
|
|
"authenticated": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"staffId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"staffDisplayName": {
|
|
"type": "string",
|
|
"example": "Director, Program"
|
|
},
|
|
"organisationalRole": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"roles": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/RoleData"
|
|
}
|
|
},
|
|
"permissions": {
|
|
"type": "array",
|
|
"example": "ALL_FUNCTIONS",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"RoleData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"GetUserDetailsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"username": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"userId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"accessToken": {
|
|
"type": "string",
|
|
"example": "bWlmb3M6cGFzc3dvcmQ="
|
|
},
|
|
"authenticated": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"staffId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"staffDisplayName": {
|
|
"type": "string",
|
|
"example": "mifosStaffDisplayName"
|
|
},
|
|
"organisationalRole": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"roles": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/RoleData"
|
|
}
|
|
},
|
|
"permissions": {
|
|
"type": "array",
|
|
"example": "ALL_FUNCTIONS",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetSurveyResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"datatableData": {
|
|
"$ref": "#/definitions/GetSurveyResponseDatatableData"
|
|
},
|
|
"enabled": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetSurveyResponseDatatableData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"applicationTableName": {
|
|
"type": "string",
|
|
"example": "m_client"
|
|
},
|
|
"registeredTableName": {
|
|
"type": "string",
|
|
"example": "ppi_kenya_2005"
|
|
},
|
|
"columnHeaderData": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/ResultsetColumnHeaderData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PostSurveySurveyNameApptableIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 2
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 87
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 87
|
|
}
|
|
}
|
|
},
|
|
"PostSurveySurveyNameApptableIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"ppi_household_members_cd_q1_householdmembers": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 167
|
|
},
|
|
"ppi_highestschool_cd_q2_highestschool": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 174
|
|
},
|
|
"ppi_businessoccupation_cd_q3_businessoccupation": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 180
|
|
},
|
|
"ppi_habitablerooms_cd_q4_habitablerooms": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 184
|
|
},
|
|
"ppi_floortype_cd_q5_floortype": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 188
|
|
},
|
|
"ppi_lightingsource_cd_q6_lightingsource": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 190
|
|
},
|
|
"ppi_irons_cd_q7_irons": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 193
|
|
},
|
|
"ppi_mosquitonets_cd_q8_mosquitonets": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 195
|
|
},
|
|
"ppi_towels_cd_q9_towels": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 198
|
|
},
|
|
"ppi_fryingpans_cd_q10_fryingpans": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 201
|
|
},
|
|
"Date": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2014-12-02 20:30:00"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "Y-m-d H:i:s"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en_GB"
|
|
}
|
|
}
|
|
},
|
|
"GetHolidaysResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Good Friday"
|
|
},
|
|
"fromDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2013, 10, 26]"
|
|
},
|
|
"toDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2013, 10, 26]"
|
|
},
|
|
"repaymentsRescheduledTo": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2013, 10, 27]"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
}
|
|
}
|
|
},
|
|
"PostHolidaysResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostHolidaysRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Good Friday"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Good Friday"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"fromDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "25 October 2013"
|
|
},
|
|
"toDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "25 October 2013"
|
|
},
|
|
"repaymentsRescheduledTo": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "26 October 2013"
|
|
},
|
|
"offices": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/PostHolidaysRequestOffices"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PostHolidaysRequestOffices": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostHolidaysHolidayIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostHolidaysHolidayIdRequest": {
|
|
"type": "object"
|
|
},
|
|
"PutHolidaysHolidayIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutHolidaysHolidayIdResponseChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutHolidaysHolidayIdResponseChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Independence day"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Holiday for Independence day celebration"
|
|
}
|
|
}
|
|
},
|
|
"PutHolidaysHolidayIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Independence day"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Holiday for Independence day celebration"
|
|
}
|
|
}
|
|
},
|
|
"DeleteHolidaysHolidayIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PutCurrenciesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"currencies": {
|
|
"type": "string",
|
|
"example": "[\"KES\",\n \"BND\",\n \"LBP\",\n \"GHC\",\n \"USD\",\n \"XOF\",\n \"AED\",\n \"AMD\"]"
|
|
}
|
|
}
|
|
},
|
|
"PutCurrenciesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"currencies": {
|
|
"type": "string",
|
|
"example": "[\"KES\",\n \"BND\",\n \"LBP\",\n \"GHC\",\n \"USD\",\n \"XOF\",\n \"AED\",\n \"AMD\"]"
|
|
}
|
|
}
|
|
},
|
|
"GetCurrenciesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"selectedCurrencyOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/CurrencyData"
|
|
}
|
|
},
|
|
"currencyOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/CurrencyData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PostOfficesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 3
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 3
|
|
}
|
|
}
|
|
},
|
|
"PostOfficesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Good Friday"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"openingDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "01 July 2007"
|
|
},
|
|
"parentId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 2
|
|
},
|
|
"externalId": {
|
|
"type": "string",
|
|
"example": "SYS54-88"
|
|
}
|
|
}
|
|
},
|
|
"GetOfficesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"nameDecorated": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"externalId": {
|
|
"type": "string",
|
|
"example": "1"
|
|
},
|
|
"openingDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2009, 1, 1]"
|
|
},
|
|
"hierarchy": {
|
|
"type": "string",
|
|
"example": "."
|
|
}
|
|
}
|
|
},
|
|
"GetOfficesTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"openingDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2009, 1, 1]"
|
|
},
|
|
"allowedParents": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetOfficesResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PutOfficesOfficeIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 3
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 3
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutOfficesOfficeIdResponseChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutOfficesOfficeIdResponseChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Name is updated"
|
|
}
|
|
}
|
|
},
|
|
"PutOfficesOfficeIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Name is updated"
|
|
}
|
|
}
|
|
},
|
|
"GetProvisioningCriteriaCriteriaIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"criteriaId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"criteriaName": {
|
|
"type": "string",
|
|
"example": "High Risk Products Criteria"
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"loanProducts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/LoanProductData"
|
|
}
|
|
},
|
|
"provisioningcriteria": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/ProvisioningCriteriaDefinitionData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"ProvisioningCriteriaDefinitionData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"categoryId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"categoryName": {
|
|
"type": "string"
|
|
},
|
|
"minAge": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"maxAge": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"provisioningPercentage": {
|
|
"type": "number"
|
|
},
|
|
"liabilityAccount": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"liabilityCode": {
|
|
"type": "string"
|
|
},
|
|
"expenseAccount": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"expenseCode": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"GetProvisioningCriteriaResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"criteriaId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"criteriaName": {
|
|
"type": "string",
|
|
"example": "High Risk Products Criteria"
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
}
|
|
}
|
|
},
|
|
"PostProvisioningCriteriaResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostProvisioningCriteriaRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"criteriaName": {
|
|
"type": "string",
|
|
"example": "High Risk Products Criteria"
|
|
},
|
|
"loanProducts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/LoanProductData"
|
|
}
|
|
},
|
|
"provisioningcriteria": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/ProvisioningCriteriaDefinitionData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PutProvisioningCriteriaResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutProvisioningCriteriaResponseChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutProvisioningCriteriaResponseChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"criteriaName": {
|
|
"type": "string",
|
|
"example": "High Risk Products Criteria"
|
|
}
|
|
}
|
|
},
|
|
"PutProvisioningCriteriaRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"criteriaName": {
|
|
"type": "string",
|
|
"example": "High Risk Products Criteria"
|
|
},
|
|
"loanProducts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/LoanProductData"
|
|
}
|
|
},
|
|
"provisioningcriteria": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/ProvisioningCriteriaDefinitionData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"DeleteProvisioningCriteriaResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"GetStaffResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"firstname": {
|
|
"type": "string",
|
|
"example": "John"
|
|
},
|
|
"lastname": {
|
|
"type": "string",
|
|
"example": "Doe"
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"example": "Doe, John"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"isLoanOfficer": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"externalId": {
|
|
"type": "string",
|
|
"example": "17H"
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"joiningDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2009,8,1]"
|
|
}
|
|
}
|
|
},
|
|
"PostStaffResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostStaffRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"firstname": {
|
|
"type": "string",
|
|
"example": "John"
|
|
},
|
|
"lastname": {
|
|
"type": "string",
|
|
"example": "Doe"
|
|
},
|
|
"isLoanOfficer": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"externalId": {
|
|
"type": "string",
|
|
"example": "17H"
|
|
},
|
|
"mobileNo": {
|
|
"type": "string",
|
|
"example": "+353851239876"
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"joiningDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "01 January 2009"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
}
|
|
}
|
|
},
|
|
"PutStaffResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PutStaffRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"isLoanOfficer": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"externalId": {
|
|
"type": "string",
|
|
"example": "17Hbb"
|
|
}
|
|
}
|
|
},
|
|
"PostTellersResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 5
|
|
}
|
|
}
|
|
},
|
|
"PostTellersRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Teller3"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "cash handling"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"example": "ACTIVE",
|
|
"enum": [
|
|
"INVALID",
|
|
"PENDING",
|
|
"ACTIVE",
|
|
"INACTIVE",
|
|
"CLOSED"
|
|
]
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd-MM-yyyy"
|
|
},
|
|
"startDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "01 February 2015"
|
|
}
|
|
}
|
|
},
|
|
"CashierData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"tellerId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"staffId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"startDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"endDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"startTime": {
|
|
"type": "string"
|
|
},
|
|
"endTime": {
|
|
"type": "string"
|
|
},
|
|
"officeName": {
|
|
"type": "string"
|
|
},
|
|
"tellerName": {
|
|
"type": "string"
|
|
},
|
|
"staffName": {
|
|
"type": "string"
|
|
},
|
|
"fullDay": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"GetTellersTellerIdCashiersResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"tellerId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"tellerName": {
|
|
"type": "string",
|
|
"example": "Teller1"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"cashiers": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/CashierData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetTellersResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 3
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"debitAccountId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"creditAccountId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Teller3"
|
|
},
|
|
"startDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2015,2,1]"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"example": "ACTIVE",
|
|
"enum": [
|
|
"INVALID",
|
|
"PENDING",
|
|
"ACTIVE",
|
|
"INACTIVE",
|
|
"CLOSED"
|
|
]
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
}
|
|
}
|
|
},
|
|
"PutTellersResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 5
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutTellersResponseChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutTellersResponseChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"description": {
|
|
"type": "string",
|
|
"example": "teller cash handling"
|
|
},
|
|
"endDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "28 February 2015"
|
|
},
|
|
"startDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "01 February 2015"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd-MM-yyyy"
|
|
}
|
|
}
|
|
},
|
|
"PutTellersRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Teller3"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "teller cash handling"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"example": "ACTIVE",
|
|
"enum": [
|
|
"INVALID",
|
|
"PENDING",
|
|
"ACTIVE",
|
|
"INACTIVE",
|
|
"CLOSED"
|
|
]
|
|
},
|
|
"endDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "28 February 2015"
|
|
},
|
|
"startDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "01 February 2015"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd-MM-yyyy"
|
|
}
|
|
}
|
|
},
|
|
"GetTellersTellerIdCashiersCashierIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"tellerId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"staffId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"startDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "Feb 20, 2015 12:00:00 AM"
|
|
},
|
|
"endDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "Feb 27, 2015 12:00:00 AM"
|
|
},
|
|
"isFullDay": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"startTime": {
|
|
"type": "string"
|
|
},
|
|
"endTime": {
|
|
"type": "string"
|
|
},
|
|
"tellerName": {
|
|
"type": "string",
|
|
"example": "Teller1"
|
|
},
|
|
"staffName": {
|
|
"type": "string",
|
|
"example": "Staff1, Test"
|
|
}
|
|
}
|
|
},
|
|
"GetTellersTellerIdCashiersTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"tellerId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"tellerName": {
|
|
"type": "string",
|
|
"example": "Teller1"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"staffOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/StaffData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"StaffData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"firstname": {
|
|
"type": "string"
|
|
},
|
|
"lastname": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"officeName": {
|
|
"type": "string"
|
|
},
|
|
"joiningDate": {
|
|
"type": "string",
|
|
"format": "date"
|
|
},
|
|
"rowIndex": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
},
|
|
"PostTellersTellerIdCashiersResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"subResourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 2
|
|
}
|
|
}
|
|
},
|
|
"PostTellersTellerIdCashiersRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"endDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "28 February 2015"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "teller cash handling"
|
|
},
|
|
"isFullDay": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"staffId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 3
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd-MM-yyyy"
|
|
},
|
|
"startDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "01 February 2015"
|
|
}
|
|
}
|
|
},
|
|
"PutTellersTellerIdCashiersCashierIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"subResourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 2
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutTellersTellerIdCashiersCashierIdResponseChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutTellersTellerIdCashiersCashierIdResponseChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"endDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "25 February 2015"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Cashier updated."
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd-MM-yyyy"
|
|
}
|
|
}
|
|
},
|
|
"PutTellersTellerIdCashiersCashierIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"endDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "25 February 2015"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Cashier updated."
|
|
},
|
|
"isFullDay": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"staffId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd-MM-yyyy"
|
|
},
|
|
"startDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "01 February 2015"
|
|
}
|
|
}
|
|
},
|
|
"DeleteTellersTellerIdCashiersCashierIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostTellersTellerIdCashiersCashierIdAllocateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"subResourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 4
|
|
}
|
|
}
|
|
},
|
|
"PostTellersTellerIdCashiersCashierIdAllocateRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"currencyCode": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"txnAmount": {
|
|
"type": "number",
|
|
"example": 5000
|
|
},
|
|
"txnNote": {
|
|
"type": "string",
|
|
"example": "allocating cash"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd-MM-yyyy"
|
|
},
|
|
"txnDate": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "01 February 2015"
|
|
}
|
|
}
|
|
},
|
|
"PostTellersTellerIdCashiersCashierIdSettleResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"subResourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 5
|
|
}
|
|
}
|
|
},
|
|
"PostTellersTellerIdCashiersCashierIdSettleRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"currencyCode": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"txnAmount": {
|
|
"type": "number",
|
|
"example": 2000
|
|
},
|
|
"txnNote": {
|
|
"type": "string",
|
|
"example": "cash settlement"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd-MM-yyyy"
|
|
},
|
|
"txnDate": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "20 February 2015"
|
|
}
|
|
}
|
|
},
|
|
"CashierTxnType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"GetTellersTellerIdCashiersCashiersIdTransactionsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 8
|
|
},
|
|
"cashierId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 15
|
|
},
|
|
"txnType": {
|
|
"$ref": "#/definitions/CashierTxnType"
|
|
},
|
|
"txnAmount": {
|
|
"type": "number",
|
|
"example": 1000
|
|
},
|
|
"txnDate": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "Feb 25, 2015 12:00:00 AM"
|
|
},
|
|
"entityId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 2
|
|
},
|
|
"entityType": {
|
|
"type": "string",
|
|
"example": "loans"
|
|
},
|
|
"txnNote": {
|
|
"type": "string",
|
|
"example": "Disbursement, Loan:2-000000002,Client:1-Test 1"
|
|
},
|
|
"createdDate": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "Feb 25, 2015 12:00:00 AM"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"tellerId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"cashierName": {
|
|
"type": "string",
|
|
"example": "B, Ramesh"
|
|
}
|
|
}
|
|
},
|
|
"CashierTransactionData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"cashierId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"txnType": {
|
|
"$ref": "#/definitions/CashierTxnType"
|
|
},
|
|
"txnAmount": {
|
|
"type": "number"
|
|
},
|
|
"txnDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"entityId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"entityType": {
|
|
"type": "string"
|
|
},
|
|
"txnNote": {
|
|
"type": "string"
|
|
},
|
|
"createdDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"officeName": {
|
|
"type": "string"
|
|
},
|
|
"tellerId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"tellerName": {
|
|
"type": "string"
|
|
},
|
|
"cashierName": {
|
|
"type": "string"
|
|
},
|
|
"cashierData": {
|
|
"$ref": "#/definitions/CashierData"
|
|
},
|
|
"startDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"endDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
}
|
|
}
|
|
},
|
|
"GetTellersTellerIdCashiersCashiersIdSummaryAndTransactionsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"sumCashAllocation": {
|
|
"type": "number",
|
|
"example": 7000
|
|
},
|
|
"sumInwardCash": {
|
|
"type": "number",
|
|
"example": 0
|
|
},
|
|
"sumOutwardCash": {
|
|
"type": "number",
|
|
"example": 0
|
|
},
|
|
"sumCashSettlement": {
|
|
"type": "number",
|
|
"example": 50
|
|
},
|
|
"netCash": {
|
|
"type": "number",
|
|
"example": 6950
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"tellerId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"tellerName": {
|
|
"type": "string",
|
|
"example": "Teller1"
|
|
},
|
|
"cashierId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"cashierName": {
|
|
"type": "string",
|
|
"example": "Staff1, Test"
|
|
},
|
|
"cashierTransactions": {
|
|
"$ref": "#/definitions/PageCashierTransactionData"
|
|
}
|
|
}
|
|
},
|
|
"Page": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalFilteredRecords": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"pageItems": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PageCashierTransactionData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalFilteredRecords": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"pageItems": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/CashierTransactionData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetTellersTellerIdCashiersCashiersIdTransactionsTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"cashierId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"tellerId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"tellerName": {
|
|
"type": "string",
|
|
"example": "Teller1"
|
|
},
|
|
"cashierName": {
|
|
"type": "string",
|
|
"example": "Staff1, Test"
|
|
},
|
|
"cashierData": {
|
|
"$ref": "#/definitions/CashierData"
|
|
},
|
|
"startDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "Feb 20, 2015 12:00:00 AM"
|
|
},
|
|
"endDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "Feb 27, 2015 12:00:00 AM"
|
|
},
|
|
"currencyOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/CurrencyData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetWorkingDaysTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"repaymentRescheduleOptions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetWorkingDaysResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"recurrence": {
|
|
"type": "string",
|
|
"example": "FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR"
|
|
},
|
|
"repaymentRescheduleType": {
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"extendTermForDailyRepayments": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
}
|
|
},
|
|
"PutWorkingDaysResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PutWorkingDaysRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"recurrence": {
|
|
"type": "string",
|
|
"example": "FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"repaymentRescheduleType": {
|
|
"example": "4",
|
|
"$ref": "#/definitions/EnumOptionData"
|
|
},
|
|
"extendTermForDailyRepayments": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersClientClassification": {
|
|
"type": "object"
|
|
},
|
|
"GetAccountTransfersClientType": {
|
|
"type": "object"
|
|
},
|
|
"GetAccountTransfersFromAccountType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.savings"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Savings Account"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersGender": {
|
|
"type": "object"
|
|
},
|
|
"GetAccountTransfersGroups": {
|
|
"type": "object"
|
|
},
|
|
"GetAccountTransfersPageItemsToAccountType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.loan"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Loan Account"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 300
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "clientStatusType.active"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Active"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersTemplateRefundByTransferCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"inMultiplesOf": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersTemplateRefundByTransferFromAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 2
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientName": {
|
|
"type": "string",
|
|
"example": "Daniel Owusu"
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"productName": {
|
|
"type": "string",
|
|
"example": "CTRL"
|
|
},
|
|
"fieldOfficerId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetAccountTransfersTemplateRefundByTransferCurrency"
|
|
},
|
|
"amtForTransfer": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 130
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersTemplateRefundByTransferFromAccountOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 2
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientName": {
|
|
"type": "string",
|
|
"example": "Daniel Owusu"
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"productName": {
|
|
"type": "string",
|
|
"example": "CTRL"
|
|
},
|
|
"fieldOfficerId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetAccountTransfersTemplateRefundByTransferCurrency"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersTemplateRefundByTransferFromClient": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetAccountTransfersStatus"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"activationDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2012, 2, 1]"
|
|
},
|
|
"firstname": {
|
|
"type": "string",
|
|
"example": "Daniel"
|
|
},
|
|
"lastname": {
|
|
"type": "string",
|
|
"example": "Owusu"
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"example": "Daniel Owusu"
|
|
},
|
|
"gender": {
|
|
"$ref": "#/definitions/GetAccountTransfersGender"
|
|
},
|
|
"clientType": {
|
|
"$ref": "#/definitions/GetAccountTransfersClientType"
|
|
},
|
|
"clientClassification": {
|
|
"$ref": "#/definitions/GetAccountTransfersClientClassification"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"timeline": {
|
|
"$ref": "#/definitions/GetAccountTransfersTimeline"
|
|
},
|
|
"groups": {
|
|
"$ref": "#/definitions/GetAccountTransfersGroups"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersTemplateRefundByTransferFromClientOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"example": "Daniel Owusu"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersTemplateRefundByTransferFromOffice": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"nameDecorated": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"externalId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"openingDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2009, 1, 1]"
|
|
},
|
|
"hierarchy": {
|
|
"type": "string",
|
|
"example": "."
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersTemplateRefundByTransferFromOfficeOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"nameDecorated": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersTemplateRefundByTransferResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"currency": {
|
|
"$ref": "#/definitions/GetAccountTransfersTemplateRefundByTransferCurrency"
|
|
},
|
|
"transferAmount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 130
|
|
},
|
|
"transferDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2014, 11, 1]"
|
|
},
|
|
"fromOffice": {
|
|
"$ref": "#/definitions/GetAccountTransfersTemplateRefundByTransferFromOffice"
|
|
},
|
|
"fromClient": {
|
|
"$ref": "#/definitions/GetAccountTransfersTemplateRefundByTransferFromClient"
|
|
},
|
|
"fromAccountType": {
|
|
"$ref": "#/definitions/GetAccountTransfersPageItemsToAccountType"
|
|
},
|
|
"fromAccount": {
|
|
"$ref": "#/definitions/GetAccountTransfersTemplateRefundByTransferFromAccount"
|
|
},
|
|
"toOffice": {
|
|
"$ref": "#/definitions/GetAccountTransfersTemplateRefundByTransferFromOffice"
|
|
},
|
|
"toClient": {
|
|
"$ref": "#/definitions/GetAccountTransfersTemplateRefundByTransferToClient"
|
|
},
|
|
"toAccountType": {
|
|
"$ref": "#/definitions/GetAccountTransfersFromAccountType"
|
|
},
|
|
"toAccount": {
|
|
"$ref": "#/definitions/GetAccountTransfersTemplateRefundByTransferToAccount"
|
|
},
|
|
"fromOfficeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetAccountTransfersTemplateRefundByTransferFromOfficeOptions"
|
|
}
|
|
},
|
|
"fromClientOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetAccountTransfersTemplateRefundByTransferFromClientOptions"
|
|
}
|
|
},
|
|
"fromAccountTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetAccountTransfersFromAccountType"
|
|
}
|
|
},
|
|
"fromAccountOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetAccountTransfersTemplateRefundByTransferFromAccountOptions"
|
|
}
|
|
},
|
|
"toOfficeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetAccountTransfersTemplateRefundByTransferFromOfficeOptions"
|
|
}
|
|
},
|
|
"toClientOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetAccountTransfersTemplateRefundByTransferFromClientOptions"
|
|
}
|
|
},
|
|
"toAccountTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetAccountTransfersFromAccountType"
|
|
}
|
|
},
|
|
"toAccountOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetAccountTransfersTemplateRefundByTransferToAccount"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersTemplateRefundByTransferToAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientName": {
|
|
"type": "string",
|
|
"example": "Daniel Owusu"
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"productName": {
|
|
"type": "string",
|
|
"example": "TEST"
|
|
},
|
|
"fieldOfficerId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetAccountTransfersTemplateRefundByTransferCurrency"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersTemplateRefundByTransferToClient": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"example": "Daniel Owusu"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersTimeline": {
|
|
"type": "object",
|
|
"properties": {
|
|
"submittedOnDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2012, 2, 1]"
|
|
},
|
|
"submittedByUsername": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"submittedByFirstname": {
|
|
"type": "string",
|
|
"example": "App"
|
|
},
|
|
"submittedByLastname": {
|
|
"type": "string",
|
|
"example": "Administrator"
|
|
},
|
|
"activatedOnDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2012, 2, 1]"
|
|
},
|
|
"activatedByUsername": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"activatedByFirstname": {
|
|
"type": "string",
|
|
"example": "App"
|
|
},
|
|
"activatedByLastname": {
|
|
"type": "string",
|
|
"example": "Administrator"
|
|
}
|
|
}
|
|
},
|
|
"PostAccountTransfersRefundByTransferResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"savingsId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostAccountTransfersRefundByTransferRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"fromAccountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"fromAccountType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"toOfficeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"toClientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"toAccountType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"toAccountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"transferAmount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 130
|
|
},
|
|
"transferDate": {
|
|
"type": "string",
|
|
"example": "31 October 2014"
|
|
},
|
|
"transferDescription": {
|
|
"type": "string",
|
|
"example": "Transfer refund to my savings account"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"fromClientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"fromOfficeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersFromAccountTypeOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.savings"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Savings Account"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersFromClientOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"example": "Small shop"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "HO"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersFromOffice": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "HO"
|
|
},
|
|
"nameDecorated": {
|
|
"type": "string",
|
|
"example": "HO"
|
|
},
|
|
"externalId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"openingDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2009, 1, 1]"
|
|
},
|
|
"hierarchy": {
|
|
"type": "string",
|
|
"example": "."
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersFromOfficeOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "HO"
|
|
},
|
|
"nameDecorated": {
|
|
"type": "string",
|
|
"example": "HO"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"transferAmount": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"transferDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2013, 8, 15]"
|
|
},
|
|
"fromOffice": {
|
|
"$ref": "#/definitions/GetAccountTransfersFromOffice"
|
|
},
|
|
"fromAccountType": {
|
|
"$ref": "#/definitions/GetAccountTransfersFromAccountType"
|
|
},
|
|
"fromOfficeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetAccountTransfersFromOfficeOptions"
|
|
}
|
|
},
|
|
"fromClientOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetAccountTransfersFromClientOptions"
|
|
}
|
|
},
|
|
"fromAccountTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetAccountTransfersFromAccountTypeOptions"
|
|
}
|
|
},
|
|
"toOfficeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetAccountTransfersToOfficeOptions"
|
|
}
|
|
},
|
|
"toAccountTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetAccountTransfersToAccountTypeOptions"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersToAccountTypeOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.savings"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Savings Account"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersToOfficeOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "HO"
|
|
},
|
|
"nameDecorated": {
|
|
"type": "string",
|
|
"example": "HO"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersPageItems": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"reversed": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetAccountTransfersPageItemsCurrency"
|
|
},
|
|
"transferAmount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 200
|
|
},
|
|
"transferDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2013, 4, 1]"
|
|
},
|
|
"transferDescription": {
|
|
"type": "string",
|
|
"example": "pay off loan from savings."
|
|
},
|
|
"fromOffice": {
|
|
"$ref": "#/definitions/GetAccountTransfersPageItemsFromOffice"
|
|
},
|
|
"fromClient": {
|
|
"$ref": "#/definitions/GetAccountTransfersFromClientOptions"
|
|
},
|
|
"fromAccountType": {
|
|
"$ref": "#/definitions/GetAccountTransfersFromAccountType"
|
|
},
|
|
"fromAccount": {
|
|
"$ref": "#/definitions/GetAccountTransfersPageItemsFromAccount"
|
|
},
|
|
"toOffice": {
|
|
"$ref": "#/definitions/GetAccountTransfersPageItemsFromOffice"
|
|
},
|
|
"toClient": {
|
|
"$ref": "#/definitions/GetAccountTransfersFromClientOptions"
|
|
},
|
|
"toAccountType": {
|
|
"$ref": "#/definitions/GetAccountTransfersPageItemsToAccountType"
|
|
},
|
|
"toAccount": {
|
|
"$ref": "#/definitions/GetAccountTransfersPageItemsFromAccount"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersPageItemsCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersPageItemsFromAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersPageItemsFromOffice": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "HO"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountTransfersResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalFilteredRecords": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"pageItems": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetAccountTransfersPageItems"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PostAccountTransfersResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"savingsId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostAccountTransfersRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"fromOfficeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"fromClientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"fromAccountType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"fromAccountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"toOfficeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"toClientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"toAccountType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"toAccountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"transferDate": {
|
|
"type": "string",
|
|
"example": "01 August 2011"
|
|
},
|
|
"transferAmount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 112.45
|
|
},
|
|
"transferDescription": {
|
|
"type": "string",
|
|
"example": "A description of the transfer"
|
|
}
|
|
}
|
|
},
|
|
"GetFromAccountTypeOptionsResponseStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.savings"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Savings Account"
|
|
}
|
|
}
|
|
},
|
|
"GetFromAccountTypeResponseStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.savings"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Savings Account"
|
|
}
|
|
}
|
|
},
|
|
"GetFromClientOptionsResponseStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"example": "Client_FirstName_2VRAG Client_LastName_9QCY"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
}
|
|
}
|
|
},
|
|
"GetFromOfficeOptionsResponseStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"nameDecorated": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
}
|
|
}
|
|
},
|
|
"GetFromOfficeResponseStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"decoratedName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"externalId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"openingDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2009, 1, 1]"
|
|
},
|
|
"hierarchy": {
|
|
"type": "string",
|
|
"example": "."
|
|
}
|
|
}
|
|
},
|
|
"GetInstructionTypeOptionsResponseStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "standingInstructionType.fixed"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Fixed"
|
|
}
|
|
}
|
|
},
|
|
"GetPriorityOptionsResponseStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "standingInstructionPriority.urgent"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Urgent Priority"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurrenceFrequencyOptionsResponseStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "frequencyperiodFrequencyType.days"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Days"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurrenceTypeOptionsResponseStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountTransferRecurrenceType.periodic"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Periodic Recurrence"
|
|
}
|
|
}
|
|
},
|
|
"GetStandingInstructionsTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"fromOffice": {
|
|
"$ref": "#/definitions/GetFromOfficeResponseStandingInstructionSwagger"
|
|
},
|
|
"fromAccountType": {
|
|
"$ref": "#/definitions/GetFromAccountTypeResponseStandingInstructionSwagger"
|
|
},
|
|
"fromOfficeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetFromOfficeOptionsResponseStandingInstructionSwagger"
|
|
}
|
|
},
|
|
"fromClientOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetFromClientOptionsResponseStandingInstructionSwagger"
|
|
}
|
|
},
|
|
"fromAccountTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetFromAccountTypeOptionsResponseStandingInstructionSwagger"
|
|
}
|
|
},
|
|
"toOfficeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetToOfficeOptionsResponseStandingInstructionSwagger"
|
|
}
|
|
},
|
|
"toAccountTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetToAccountTypeOptionsResponseStandingInstructionSwagger"
|
|
}
|
|
},
|
|
"transferTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetTransferTypeOptionsResponseStandingInstructionSwagger"
|
|
}
|
|
},
|
|
"statusOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetStatusOptionsResponseStandingInstructionSwagger"
|
|
}
|
|
},
|
|
"instructionTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetInstructionTypeOptionsResponseStandingInstructionSwagger"
|
|
}
|
|
},
|
|
"priorityOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetPriorityOptionsResponseStandingInstructionSwagger"
|
|
}
|
|
},
|
|
"recurrenceTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetRecurrenceTypeOptionsResponseStandingInstructionSwagger"
|
|
}
|
|
},
|
|
"recurrenceFrequencyOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetRecurrenceFrequencyOptionsResponseStandingInstructionSwagger"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetStatusOptionsResponseStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "standingInstructionStatus.active"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Active"
|
|
}
|
|
}
|
|
},
|
|
"GetToAccountTypeOptionsResponseStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.loan"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Loan Account"
|
|
}
|
|
}
|
|
},
|
|
"GetToOfficeOptionsResponseStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"nameDecorated": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
}
|
|
}
|
|
},
|
|
"GetTransferTypeOptionsResponseStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountTransferType.account.transfer"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Account Transfer"
|
|
}
|
|
}
|
|
},
|
|
"GetFromAccountStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 14
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 14
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"productName": {
|
|
"type": "string",
|
|
"example": "savings old"
|
|
}
|
|
}
|
|
},
|
|
"GetFromAccountTypeStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.savings"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Savings Account"
|
|
}
|
|
}
|
|
},
|
|
"GetFromClientStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"example": "Test test"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
}
|
|
}
|
|
},
|
|
"GetFromOfficeStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
}
|
|
}
|
|
},
|
|
"GetInstructionTypeStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "standingInstructionType.fixed"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Fixed"
|
|
}
|
|
}
|
|
},
|
|
"GetPageItemsStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"accountDetailId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 6
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "test standing"
|
|
},
|
|
"fromOffice": {
|
|
"$ref": "#/definitions/GetFromOfficeStandingInstructionSwagger"
|
|
},
|
|
"fromClient": {
|
|
"$ref": "#/definitions/GetFromClientStandingInstructionSwagger"
|
|
},
|
|
"fromAccountType": {
|
|
"$ref": "#/definitions/GetFromAccountTypeStandingInstructionSwagger"
|
|
},
|
|
"fromAccount": {
|
|
"$ref": "#/definitions/GetFromAccountStandingInstructionSwagger"
|
|
},
|
|
"toOffice": {
|
|
"$ref": "#/definitions/GetToOfficeStandingInstructionSwagger"
|
|
},
|
|
"toClient": {
|
|
"$ref": "#/definitions/GetToClientStandingInstructionSwagger"
|
|
},
|
|
"toAccountType": {
|
|
"$ref": "#/definitions/GetToAccountTypeStandingInstructionSwagger"
|
|
},
|
|
"toAccount": {
|
|
"$ref": "#/definitions/GetToAccountStandingInstructionSwagger"
|
|
},
|
|
"transferType": {
|
|
"$ref": "#/definitions/GetTransferTypeStandingInstructionSwagger"
|
|
},
|
|
"priority": {
|
|
"$ref": "#/definitions/GetPriorityStandingInstructionSwagger"
|
|
},
|
|
"instructionType": {
|
|
"$ref": "#/definitions/GetInstructionTypeStandingInstructionSwagger"
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetStatusStandingInstructionSwagger"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 150
|
|
},
|
|
"validFrom": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2014, 4, 3]"
|
|
},
|
|
"recurrenceType": {
|
|
"$ref": "#/definitions/GetRecurrenceTypeStandingInstructionSwagger"
|
|
},
|
|
"recurrenceFrequency": {
|
|
"$ref": "#/definitions/GetRecurrenceFrequencyStandingInstructionSwagger"
|
|
},
|
|
"recurrenceInterval": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"recurrenceOnMonthDay": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[4, 3]"
|
|
}
|
|
}
|
|
},
|
|
"GetPriorityStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "standingInstructionPriority.medium"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Medium Priority"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurrenceFrequencyStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "frequencyperiodFrequencyType.months"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Months"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurrenceTypeStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountTransferRecurrenceType.periodic"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Periodic Recurrence"
|
|
}
|
|
}
|
|
},
|
|
"GetStandingInstructionsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalFilteredRecords": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"pageItems": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetPageItemsStandingInstructionSwagger"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetStatusStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "standingInstructionStatus.deleted"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Deleted"
|
|
}
|
|
}
|
|
},
|
|
"GetToAccountStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 3
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 3
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 4
|
|
},
|
|
"productName": {
|
|
"type": "string",
|
|
"example": "account overdraft"
|
|
}
|
|
}
|
|
},
|
|
"GetToAccountTypeStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.savings"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Savings Account"
|
|
}
|
|
}
|
|
},
|
|
"GetToClientStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"example": "Test test"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
}
|
|
}
|
|
},
|
|
"GetToOfficeStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
}
|
|
}
|
|
},
|
|
"GetTransferTypeStandingInstructionSwagger": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountTransferType.account.transfer"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Account Transfer"
|
|
}
|
|
}
|
|
},
|
|
"GetStandingInstructionsStandingInstructionIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"accountDetailId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 6
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "test standing"
|
|
},
|
|
"fromOffice": {
|
|
"$ref": "#/definitions/GetFromOfficeStandingInstructionSwagger"
|
|
},
|
|
"fromClient": {
|
|
"$ref": "#/definitions/GetFromClientStandingInstructionSwagger"
|
|
},
|
|
"fromAccountType": {
|
|
"$ref": "#/definitions/GetFromAccountTypeStandingInstructionSwagger"
|
|
},
|
|
"fromAccount": {
|
|
"$ref": "#/definitions/GetFromAccountStandingInstructionSwagger"
|
|
},
|
|
"toOffice": {
|
|
"$ref": "#/definitions/GetToOfficeStandingInstructionSwagger"
|
|
},
|
|
"toClient": {
|
|
"$ref": "#/definitions/GetToClientStandingInstructionSwagger"
|
|
},
|
|
"toAccountType": {
|
|
"$ref": "#/definitions/GetToAccountTypeStandingInstructionSwagger"
|
|
},
|
|
"toAccount": {
|
|
"$ref": "#/definitions/GetToAccountStandingInstructionSwagger"
|
|
},
|
|
"transferType": {
|
|
"$ref": "#/definitions/GetTransferTypeStandingInstructionSwagger"
|
|
},
|
|
"priority": {
|
|
"$ref": "#/definitions/GetPriorityStandingInstructionSwagger"
|
|
},
|
|
"instructionType": {
|
|
"$ref": "#/definitions/GetInstructionTypeStandingInstructionSwagger"
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetStatusStandingInstructionSwagger"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 150
|
|
},
|
|
"validFrom": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2014, 4, 3]"
|
|
},
|
|
"recurrenceType": {
|
|
"$ref": "#/definitions/GetRecurrenceTypeStandingInstructionSwagger"
|
|
},
|
|
"recurrenceFrequency": {
|
|
"$ref": "#/definitions/GetRecurrenceFrequencyStandingInstructionSwagger"
|
|
},
|
|
"recurrenceInterval": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"recurrenceOnMonthDay": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[4, 3]"
|
|
}
|
|
}
|
|
},
|
|
"PutStandingInstructionsStandingInstructionIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 20
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutUpdateStandingInstructionChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutUpdateStandingInstructionChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"recurrenceInterval": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
}
|
|
}
|
|
},
|
|
"PutStandingInstructionsStandingInstructionIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"recurrenceInterval": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
}
|
|
}
|
|
},
|
|
"PostStandingInstructionsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 65
|
|
}
|
|
}
|
|
},
|
|
"PostStandingInstructionsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"fromOfficeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"fromClientId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"fromAccountType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "standing instruction"
|
|
},
|
|
"transferType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"priority": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"status": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"fromAccountId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"toOfficeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"toClientId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"toAccountType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"toAccountId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 3
|
|
},
|
|
"instructionType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"amount": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 221
|
|
},
|
|
"validFrom": {
|
|
"type": "string",
|
|
"example": "08 April 2014"
|
|
},
|
|
"recurrenceType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"recurrenceInterval": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"recurrenceFrequency": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"description": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"recurrenceOnMonthDay": {
|
|
"type": "string",
|
|
"example": "02 April"
|
|
},
|
|
"monthDayFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM"
|
|
}
|
|
}
|
|
},
|
|
"GetStandingInstructionHistoryFromAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 2
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 2
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"productName": {
|
|
"type": "string",
|
|
"example": "General Savings"
|
|
}
|
|
}
|
|
},
|
|
"GetStandingInstructionHistoryPageItemsFromClient": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"example": "Test client"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
}
|
|
}
|
|
},
|
|
"GetStandingInstructionHistoryPageItemsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"standingInstructionId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "ACC Transfer"
|
|
},
|
|
"fromOffice": {
|
|
"$ref": "#/definitions/GetFromOfficeStandingInstructionSwagger"
|
|
},
|
|
"fromClient": {
|
|
"$ref": "#/definitions/GetStandingInstructionHistoryPageItemsFromClient"
|
|
},
|
|
"fromAccountType": {
|
|
"$ref": "#/definitions/GetFromAccountTypeStandingInstructionSwagger"
|
|
},
|
|
"fromAccount": {
|
|
"$ref": "#/definitions/GetStandingInstructionHistoryFromAccount"
|
|
},
|
|
"toAccountType": {
|
|
"$ref": "#/definitions/GetToAccountTypeStandingInstructionSwagger"
|
|
},
|
|
"toAccount": {
|
|
"$ref": "#/definitions/GetStandingInstructionHistoryToAccount"
|
|
},
|
|
"toOffice": {
|
|
"$ref": "#/definitions/GetToOfficeStandingInstructionSwagger"
|
|
},
|
|
"toClient": {
|
|
"$ref": "#/definitions/GetStandingInstructionHistoryToClient"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 10
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"example": "success"
|
|
},
|
|
"executionTime": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2014, 6, 30]"
|
|
},
|
|
"errorLog": {
|
|
"type": "string",
|
|
"example": " "
|
|
}
|
|
}
|
|
},
|
|
"GetStandingInstructionHistoryToAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"productName": {
|
|
"type": "string",
|
|
"example": "General Savings"
|
|
}
|
|
}
|
|
},
|
|
"GetStandingInstructionHistoryToClient": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"example": "Test client"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
}
|
|
}
|
|
},
|
|
"GetStandingInstructionRunHistoryResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalFilteredRecords": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"pageItems": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetStandingInstructionHistoryPageItemsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetAccountsChargeCalculationType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeCalculationType.flat"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Flat"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountsChargeTimeType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 13
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeTimeType.activation"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Share Account Activate"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountsCharges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 9
|
|
},
|
|
"chargeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 20
|
|
},
|
|
"accountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Share Account Activation Flat"
|
|
},
|
|
"chargeTimeType": {
|
|
"$ref": "#/definitions/GetAccountsChargeTimeType"
|
|
},
|
|
"chargeCalculationType": {
|
|
"$ref": "#/definitions/GetAccountsChargeCalculationType"
|
|
},
|
|
"percentage": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 0
|
|
},
|
|
"amountPercentageAppliedTo": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 0
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetAccountsChargesCurrency"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 1
|
|
},
|
|
"amountPaid": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 1
|
|
},
|
|
"amountWaived": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"amountWrittenOff": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"amountOutstanding": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"amountOrPercentage": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 1
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
}
|
|
},
|
|
"GetAccountsChargesCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountsCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"inMultiplesOf": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountsLockPeriodTypeEnum": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savings.lockin.sharePeriodFrequencyType.days"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Days"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountsPurchasedShares": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 6
|
|
},
|
|
"accountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"purchasedDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2016, 4, 1]"
|
|
},
|
|
"numberOfShares": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 10
|
|
},
|
|
"purchasedPrice": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 0.5
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetAccountsPurchasedSharesStatus"
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/GetAccountsPurchasedSharesType"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 5.05
|
|
},
|
|
"chargeAmount": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 0.05
|
|
},
|
|
"amountPaid": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 5.05
|
|
}
|
|
}
|
|
},
|
|
"GetAccountsPurchasedSharesStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 300
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "purchasedSharesStatusType.approved"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Approved"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountsPurchasedSharesType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 500
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "purchasedSharesType.purchased"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Purchase"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountsStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 300
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "shareAccountStatusType.active"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Active"
|
|
},
|
|
"submittedAndPendingApproval": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"approved": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"rejected": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"closed": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetAccountsSummary": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 2
|
|
},
|
|
"totalApprovedShares": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"totalPendingForApprovalShares": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"productName": {
|
|
"type": "string",
|
|
"example": "Conflux Share Product"
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetAccountsStatus"
|
|
},
|
|
"timeline": {
|
|
"$ref": "#/definitions/GetAccountsTimeline"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetAccountsCurrency"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountsTimeline": {
|
|
"type": "object",
|
|
"properties": {
|
|
"submittedOnDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2016, 4, 1]"
|
|
},
|
|
"submittedByUsername": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"submittedByFirstname": {
|
|
"type": "string",
|
|
"example": "App"
|
|
},
|
|
"submittedByLastname": {
|
|
"type": "string",
|
|
"example": "Administrator"
|
|
},
|
|
"approvedDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2016, 4, 1]"
|
|
},
|
|
"approvedByUsername": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"approvedByFirstname": {
|
|
"type": "string",
|
|
"example": "App"
|
|
},
|
|
"approvedByLastname": {
|
|
"type": "string",
|
|
"example": "Administrator"
|
|
},
|
|
"activatedDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2016, 4, 1]"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountsTypeAccountIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 2
|
|
},
|
|
"savingsAccountNumber": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 13
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 7
|
|
},
|
|
"clientName": {
|
|
"type": "string",
|
|
"example": "Client_FirstName_2KX8C Client_LastName_NWNG"
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"productName": {
|
|
"type": "string",
|
|
"example": "Share Product"
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetAccountsStatus"
|
|
},
|
|
"timeline": {
|
|
"$ref": "#/definitions/GetAccountsTimeline"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetAccountsCurrency"
|
|
},
|
|
"summary": {
|
|
"$ref": "#/definitions/GetAccountsSummary"
|
|
},
|
|
"purchasedShares": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetAccountsPurchasedShares"
|
|
}
|
|
},
|
|
"savingsAccountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 13
|
|
},
|
|
"currentMarketPrice": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 5
|
|
},
|
|
"lockinPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"lockPeriodTypeEnum": {
|
|
"$ref": "#/definitions/GetAccountsLockPeriodTypeEnum"
|
|
},
|
|
"minimumActivePeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"minimumActivePeriodTypeEnum": {
|
|
"$ref": "#/definitions/GetAccountsLockPeriodTypeEnum"
|
|
},
|
|
"allowDividendCalculationForInactiveClients": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"charges": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetAccountsCharges"
|
|
}
|
|
},
|
|
"dividends": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PostAccountsTypeResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostAccountsCharges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"chargeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 20
|
|
},
|
|
"amount": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostAccountsTypeRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 7
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"requestedShares": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"externalId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"submittedDate": {
|
|
"type": "string",
|
|
"example": "01 May 2016"
|
|
},
|
|
"minimumActivePeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"minimumActivePeriodFrequencyType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"lockinPeriodFrequency": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"lockinPeriodFrequencyType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"applicationDate": {
|
|
"type": "string",
|
|
"example": "01 May 2016"
|
|
},
|
|
"allowDividendCalculationForInactiveClients": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"charges": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/PostAccountsCharges"
|
|
}
|
|
},
|
|
"savingsAccountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 13
|
|
}
|
|
}
|
|
},
|
|
"PutAccountsChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"applicationDate": {
|
|
"type": "string",
|
|
"example": "01 April 2016"
|
|
},
|
|
"requestedShares": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 20
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
}
|
|
}
|
|
},
|
|
"PutAccountsTypeAccountIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutAccountsChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutAccountsTypeAccountIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"applicationDate": {
|
|
"type": "string",
|
|
"example": "01 April 2016"
|
|
},
|
|
"requestedShares": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 20
|
|
}
|
|
}
|
|
},
|
|
"GetAccountsPageItems": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientName": {
|
|
"type": "string",
|
|
"example": "Client Name"
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"productName": {
|
|
"type": "string",
|
|
"example": "Share Product Name"
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetAccountsTypeStatus"
|
|
},
|
|
"timeline": {
|
|
"$ref": "#/definitions/GetAccountsTypeTimeline"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetAccountsChargesCurrency"
|
|
},
|
|
"purchasedShares": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetAccountsTypePurchasedShares"
|
|
}
|
|
},
|
|
"summary": {
|
|
"$ref": "#/definitions/GetAccountsTypeSummary"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountsTypePurchasedShares": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"purchasedDate": {
|
|
"type": "string",
|
|
"example": "01 May 2013"
|
|
},
|
|
"numberOfShares": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 10
|
|
},
|
|
"purchasedPrice": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 5
|
|
}
|
|
}
|
|
},
|
|
"GetAccountsTypeResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalFilteredRecords": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"pageItems": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetAccountsPageItems"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetAccountsTypeStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "shareAccountStatusType.submitted.and.pending.approval"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Submitted and pending approval"
|
|
},
|
|
"submittedAndPendingApproval": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"approved": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"rejected": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closed": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetAccountsTypeSummary": {
|
|
"type": "object",
|
|
"properties": {
|
|
"currency": {
|
|
"$ref": "#/definitions/GetAccountsChargesCurrency"
|
|
}
|
|
}
|
|
},
|
|
"GetAccountsTypeTimeline": {
|
|
"type": "object",
|
|
"properties": {
|
|
"submittedOnDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2013, 3, 1]"
|
|
}
|
|
}
|
|
},
|
|
"PostAccountsTypeAccountIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 5
|
|
}
|
|
}
|
|
},
|
|
"PostAccountsRequestedShares": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 35
|
|
}
|
|
}
|
|
},
|
|
"PostAccountsTypeAccountIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"requestedShares": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/PostAccountsRequestedShares"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetAccountsTypeProductOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Share Product"
|
|
},
|
|
"shortName": {
|
|
"type": "string",
|
|
"example": "SP"
|
|
},
|
|
"totalShares": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 100
|
|
}
|
|
}
|
|
},
|
|
"GetAccountsTypeTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 7
|
|
},
|
|
"clientName": {
|
|
"type": "string",
|
|
"example": "Client Name"
|
|
},
|
|
"productOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetAccountsTypeProductOptions"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetFieldConfigurationEntityResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"fieldConfigurationId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"entity": {
|
|
"type": "string",
|
|
"example": "ADDRESS"
|
|
},
|
|
"subentity": {
|
|
"type": "string",
|
|
"example": "CLIENT"
|
|
},
|
|
"field": {
|
|
"type": "string",
|
|
"example": "addressType"
|
|
},
|
|
"is_enabled": {
|
|
"type": "string",
|
|
"example": "true"
|
|
},
|
|
"is_mandatory": {
|
|
"type": "string",
|
|
"example": "false"
|
|
},
|
|
"validation_regex": {
|
|
"type": "string",
|
|
"example": " "
|
|
}
|
|
}
|
|
},
|
|
"GetChargesAppliesToResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeAppliesTo.loan"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Loan"
|
|
}
|
|
}
|
|
},
|
|
"GetChargesCalculationTypeResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeCalculationType.flat"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Flat"
|
|
}
|
|
}
|
|
},
|
|
"GetChargesCurrencyResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetChargesPaymentModeResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargepaymentmode.accounttransfer"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Account Transfer"
|
|
}
|
|
}
|
|
},
|
|
"GetChargesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Loan Service fee"
|
|
},
|
|
"active": {
|
|
"type": "string",
|
|
"example": "true"
|
|
},
|
|
"penalty": {
|
|
"type": "string",
|
|
"example": "false"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetChargesCurrencyResponse"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 230.56
|
|
},
|
|
"chargeTimeType": {
|
|
"$ref": "#/definitions/GetChargesTimeTypeResponse"
|
|
},
|
|
"chargeAppliesTo": {
|
|
"$ref": "#/definitions/GetChargesAppliesToResponse"
|
|
},
|
|
"chargeCalculationType": {
|
|
"$ref": "#/definitions/GetChargesCalculationTypeResponse"
|
|
},
|
|
"chargePaymentMode": {
|
|
"$ref": "#/definitions/GetChargesPaymentModeResponse"
|
|
}
|
|
}
|
|
},
|
|
"GetChargesTimeTypeResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeTimeType.disbursement"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Disbursement"
|
|
}
|
|
}
|
|
},
|
|
"GetChargesTemplateFeeFrequencyOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "loanTermFrequency.periodFrequencyType.days"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Days"
|
|
}
|
|
}
|
|
},
|
|
"GetChargesTemplateLoanChargeCalculationTypeOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeCalculationType.flat"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Flat"
|
|
}
|
|
}
|
|
},
|
|
"GetChargesTemplateLoanChargeTimeTypeOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeTimeType.specifiedDueDate"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Specified due date"
|
|
}
|
|
}
|
|
},
|
|
"GetChargesTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"active": {
|
|
"type": "string",
|
|
"example": "false"
|
|
},
|
|
"penalty": {
|
|
"type": "string",
|
|
"example": "false"
|
|
},
|
|
"currencyOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetChargesCurrencyResponse"
|
|
}
|
|
},
|
|
"chargeCalculationTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetChargesCalculationTypeResponse"
|
|
}
|
|
},
|
|
"chargeAppliesToOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetChargesAppliesToResponse"
|
|
}
|
|
},
|
|
"chargeTimeTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetChargesTimeTypeResponse"
|
|
}
|
|
},
|
|
"chargePaymentModeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetChargesPaymentModeResponse"
|
|
}
|
|
},
|
|
"loanChargeCalculationTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetChargesTemplateLoanChargeCalculationTypeOptions"
|
|
}
|
|
},
|
|
"loanChargeTimeTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetChargesTemplateLoanChargeTimeTypeOptions"
|
|
}
|
|
},
|
|
"savingsChargeCalculationTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetChargesTemplateLoanChargeCalculationTypeOptions"
|
|
}
|
|
},
|
|
"savingsChargeTimeTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetChargesTemplateLoanChargeTimeTypeOptions"
|
|
}
|
|
},
|
|
"feeFrequencyOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetChargesTemplateFeeFrequencyOptions"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PostChargesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostChargesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Loan Service fee"
|
|
},
|
|
"chargeAppliesTo": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"currencyCode": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 230.56
|
|
},
|
|
"chargeTimeType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"chargeCalculationType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"chargePaymentMode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"active": {
|
|
"type": "string",
|
|
"example": "true"
|
|
}
|
|
}
|
|
},
|
|
"PutChargesChargeIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Loan service fee(changed)"
|
|
}
|
|
}
|
|
},
|
|
"PutChargesChargeIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutChargesChargeIdRequest"
|
|
}
|
|
}
|
|
},
|
|
"DeleteChargesChargeIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostClientClientIdAddressesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 15
|
|
}
|
|
}
|
|
},
|
|
"PostClientClientIdAddressesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"street": {
|
|
"type": "string",
|
|
"example": "Ipca"
|
|
},
|
|
"addressLine1": {
|
|
"type": "string",
|
|
"example": "Kandivali"
|
|
},
|
|
"addressLine2": {
|
|
"type": "string",
|
|
"example": "plot47"
|
|
},
|
|
"addressLine3": {
|
|
"type": "string",
|
|
"example": "charkop"
|
|
},
|
|
"city": {
|
|
"type": "string",
|
|
"example": "Mumbai"
|
|
},
|
|
"stateProvinceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 800
|
|
},
|
|
"countryId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 802
|
|
},
|
|
"postalCode": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 400064
|
|
}
|
|
}
|
|
},
|
|
"PutClientClientIdAddressesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 67
|
|
}
|
|
}
|
|
},
|
|
"PutClientClientIdAddressesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"addressId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 67
|
|
},
|
|
"street": {
|
|
"type": "string",
|
|
"example": "goldensource"
|
|
}
|
|
}
|
|
},
|
|
"GetClientClientIdAddressesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"client_id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 111755
|
|
},
|
|
"addressType": {
|
|
"type": "string",
|
|
"example": "PERMANENT ADDRESS"
|
|
},
|
|
"addressId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 14
|
|
},
|
|
"addressTypeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 804
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"street": {
|
|
"type": "string",
|
|
"example": "anki's home"
|
|
},
|
|
"addressLine1": {
|
|
"type": "string",
|
|
"example": "test123"
|
|
},
|
|
"addressLine2": {
|
|
"type": "string",
|
|
"example": "iuyt"
|
|
},
|
|
"addressLine3": {
|
|
"type": "string",
|
|
"example": " "
|
|
},
|
|
"townVillage": {
|
|
"type": "string",
|
|
"example": " "
|
|
},
|
|
"city": {
|
|
"type": "string",
|
|
"example": "mumbai"
|
|
},
|
|
"countyDistrict": {
|
|
"type": "string",
|
|
"example": " "
|
|
},
|
|
"stateProvinceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 801
|
|
},
|
|
"countryName": {
|
|
"type": "string",
|
|
"example": "UNITED STATES"
|
|
},
|
|
"stateName": {
|
|
"type": "string",
|
|
"example": "GUJRAT"
|
|
},
|
|
"countryId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 807
|
|
},
|
|
"postalCode": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 400095
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"example": " "
|
|
},
|
|
"updatedBy": {
|
|
"type": "string",
|
|
"example": " "
|
|
}
|
|
}
|
|
},
|
|
"GetClientChargeCalculationType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeCalculationType.flat"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Flat"
|
|
}
|
|
}
|
|
},
|
|
"GetClientChargeCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetClientChargeTimeType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeTimeType.specifiedDueDate"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Specified due date"
|
|
}
|
|
}
|
|
},
|
|
"GetClientsChargesPageItems": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"chargeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 5
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Client Fee 1"
|
|
},
|
|
"chargeTimeType": {
|
|
"$ref": "#/definitions/GetClientChargeTimeType"
|
|
},
|
|
"dueDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2015, 8, 17]"
|
|
},
|
|
"chargeCalculationType": {
|
|
"$ref": "#/definitions/GetClientChargeCalculationType"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetClientChargeCurrency"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"example": 100
|
|
},
|
|
"amountPaid": {
|
|
"type": "number",
|
|
"example": 0
|
|
},
|
|
"amountWaived": {
|
|
"type": "number",
|
|
"example": 100
|
|
},
|
|
"amountWrittenOff": {
|
|
"type": "number",
|
|
"example": 0
|
|
},
|
|
"amountOutstanding": {
|
|
"type": "number",
|
|
"example": 0
|
|
},
|
|
"penalty": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"isPaid": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"isWaived": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
}
|
|
},
|
|
"GetClientsClientIdChargesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalFilteredRecords": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"pageItems": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetClientsChargesPageItems"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PostClientsClientIdChargesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"chargeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 189
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 164
|
|
}
|
|
}
|
|
},
|
|
"PostClientsClientIdChargesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"amount": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"chargeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 226
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"dueDate": {
|
|
"type": "string",
|
|
"example": "01 September 2015"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
}
|
|
}
|
|
},
|
|
"PostClientsClientIdChargesChargeIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 189
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 157
|
|
},
|
|
"transactionId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 221
|
|
}
|
|
}
|
|
},
|
|
"PostClientsClientIdChargesChargeIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"amount": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 200
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"transactionDate": {
|
|
"type": "string",
|
|
"example": "01 September 2015"
|
|
}
|
|
}
|
|
},
|
|
"DeleteClientsClientIdChargesChargeIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 189
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 164
|
|
}
|
|
}
|
|
},
|
|
"GetClientsClientIdIdentifiersResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"documentType": {
|
|
"$ref": "#/definitions/GetClientsDocumentType"
|
|
},
|
|
"documentKey": {
|
|
"type": "string",
|
|
"example": "12345"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Issued in the year 2--7"
|
|
}
|
|
}
|
|
},
|
|
"GetClientsDocumentType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Drivers License"
|
|
}
|
|
}
|
|
},
|
|
"GetClientsAllowedDocumentTypes": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Passport"
|
|
},
|
|
"position": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
}
|
|
}
|
|
},
|
|
"GetClientsClientIdIdentifiersTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"allowedDocumentTypes": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetClientsAllowedDocumentTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PostClientsClientIdIdentifiersResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
}
|
|
}
|
|
},
|
|
"PostClientsClientIdIdentifiersRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"documentTypeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"documentKey": {
|
|
"type": "string",
|
|
"example": "KA-54677"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Document has been verified"
|
|
}
|
|
}
|
|
},
|
|
"PutClientsClientIdIdentifiersIdentifierIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"documentTypeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"documentKey": {
|
|
"type": "string",
|
|
"example": "KA-94667"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Document has been updated"
|
|
}
|
|
}
|
|
},
|
|
"PutClientsClientIdIdentifiersIdentifierIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutClientsClientIdIdentifiersIdentifierIdRequest"
|
|
}
|
|
}
|
|
},
|
|
"DeleteClientsClientIdIdentifiersIdentifierIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
}
|
|
}
|
|
},
|
|
"GetClientTransactionsCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetClientsClientIdTransactionsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalFilteredRecords": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 20
|
|
},
|
|
"pageItems": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetClientsPageItems"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetClientsClientIdTransactionsType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "clientTransactionType.payCharge"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "PAY_CHARGE"
|
|
}
|
|
}
|
|
},
|
|
"GetClientsPageItems": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 226
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/GetClientsClientIdTransactionsType"
|
|
},
|
|
"date": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2015, 9, 2]"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetClientTransactionsCurrency"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 22
|
|
},
|
|
"submittedOnDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2015, 9, 2]"
|
|
},
|
|
"reversed": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetClientsClientIdTransactionsTransactionIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/GetClientsClientIdTransactionsType"
|
|
},
|
|
"date": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2015, 8, 17]"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetClientTransactionsCurrency"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"example": 60
|
|
},
|
|
"submittedOnDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2015, 8, 17]"
|
|
},
|
|
"reversed": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
}
|
|
},
|
|
"PostClientsClientIdTransactionsTransactionIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 189
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 222
|
|
}
|
|
}
|
|
},
|
|
"GetClientsClientIdAccountsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"loanAccounts": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetClientsLoanAccounts"
|
|
}
|
|
},
|
|
"savingsAccounts": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetClientsSavingsAccounts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetClientsLoanAccounts": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"externalId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 456
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"productName": {
|
|
"type": "string",
|
|
"example": "TestOne"
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetClientsLoanAccountsStatus"
|
|
},
|
|
"loanType": {
|
|
"$ref": "#/definitions/GetClientsLoanAccountsType"
|
|
},
|
|
"loanCycle": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"GetClientsLoanAccountsStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 300
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "loanStatusType.active"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Active"
|
|
},
|
|
"pendingApproval": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"waitingForDisbursal": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"closedObligationsMet": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closedWrittenOff": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closedRescheduled": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closed": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"overpaid": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetClientsLoanAccountsType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "loanType.individual"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Individual"
|
|
}
|
|
}
|
|
},
|
|
"GetClientsSavingsAccounts": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 7
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 7
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"productName": {
|
|
"type": "string",
|
|
"example": "Other product"
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetClientsSavingsAccountsStatus"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetClientsSavingsAccountsCurrency"
|
|
}
|
|
}
|
|
},
|
|
"GetClientsSavingsAccountsCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetClientsSavingsAccountsStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsAccountStatusType.submitted.and.pending.approval"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Submitted and pending approval"
|
|
},
|
|
"submittedAndPendingApproval": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"approved": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"rejected": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"withdrawnByApplicant": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closed": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetClientsColumnHeaderData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"columnName": {
|
|
"type": "string",
|
|
"example": "client_id"
|
|
},
|
|
"columnType": {
|
|
"type": "string",
|
|
"example": "bigint"
|
|
},
|
|
"columnLength": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"columnDisplayType": {
|
|
"type": "string",
|
|
"example": "INTEGER"
|
|
},
|
|
"isColumnNullable": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"isColumnPrimaryKey": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"columnValues": {
|
|
"type": "array",
|
|
"example": "[]",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetClientsDataTables": {
|
|
"type": "object",
|
|
"properties": {
|
|
"applicationTableName": {
|
|
"type": "string",
|
|
"example": "m_client"
|
|
},
|
|
"registeredTableName": {
|
|
"type": "string",
|
|
"example": "Address Details"
|
|
},
|
|
"columnHeaderData": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetClientsColumnHeaderData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetClientsOfficeOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"nameDecorated": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
}
|
|
}
|
|
},
|
|
"GetClientsSavingProductOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "account overdraft"
|
|
},
|
|
"withdrawalFeeForTransfers": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"allowOverdraft": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetClientsStaffOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"firstname": {
|
|
"type": "string",
|
|
"example": "xyz"
|
|
},
|
|
"lastname": {
|
|
"type": "string",
|
|
"example": "sjs"
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"example": "sjs, xyz"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"isLoanOfficer": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
}
|
|
},
|
|
"GetClientsTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"activationDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2014, 3, 4]"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"officeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetClientsOfficeOptions"
|
|
}
|
|
},
|
|
"staffOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetClientsStaffOptions"
|
|
}
|
|
},
|
|
"savingProductOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetClientsSavingProductOptions"
|
|
}
|
|
},
|
|
"datatables": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetClientsDataTables"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetClientStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "clientStatusType.pending"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Pending"
|
|
}
|
|
}
|
|
},
|
|
"GetClientsPageItemsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"accountNo": {
|
|
"type": "string",
|
|
"example": "000000002"
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetClientStatus"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"fullname": {
|
|
"type": "string",
|
|
"example": "Home Farm Produce"
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"example": "Home Farm Produce"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
}
|
|
}
|
|
},
|
|
"GetClientsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalFilteredRecords": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"pageItems": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetClientsPageItemsResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PostClientsClientIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
}
|
|
}
|
|
},
|
|
"PostClientsClientIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"note": {
|
|
"type": "string",
|
|
"example": "We cannot accept transfers of clients having loans with less than 1 repayment left"
|
|
}
|
|
}
|
|
},
|
|
"GetClientsClientIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 27
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 27
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetClientsClientIdStatus"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"activationDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2013, 1, 1]"
|
|
},
|
|
"firstname": {
|
|
"type": "string",
|
|
"example": "savings"
|
|
},
|
|
"lastname": {
|
|
"type": "string",
|
|
"example": "test"
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"example": "savings test"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"timeline": {
|
|
"$ref": "#/definitions/GetClientsTimeline"
|
|
},
|
|
"savingsProductId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"savingsProductName": {
|
|
"type": "string",
|
|
"example": "account overdraft"
|
|
},
|
|
"groups": {
|
|
"type": "array",
|
|
"example": "[]",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetClientsClientIdStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 300
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "clientStatusType.active"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Active"
|
|
}
|
|
}
|
|
},
|
|
"GetClientsTimeline": {
|
|
"type": "object",
|
|
"properties": {
|
|
"submittedOnDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2013, 1, 1]"
|
|
},
|
|
"submittedByUsername": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"submittedByFirstname": {
|
|
"type": "string",
|
|
"example": "App"
|
|
},
|
|
"submittedByLastname": {
|
|
"type": "string",
|
|
"example": "Administrator"
|
|
},
|
|
"activatedOnDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2013, 1, 1]"
|
|
},
|
|
"activatedByUsername": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"activatedByFirstname": {
|
|
"type": "string",
|
|
"example": "App"
|
|
},
|
|
"activatedByLastname": {
|
|
"type": "string",
|
|
"example": "Administrator"
|
|
}
|
|
}
|
|
},
|
|
"PutClientsClientIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"externalId": {
|
|
"type": "string",
|
|
"example": "786444UUUYYH7"
|
|
}
|
|
}
|
|
},
|
|
"PutClientsClientIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutClientsClientIdRequest"
|
|
}
|
|
}
|
|
},
|
|
"DeleteClientsClientIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
}
|
|
}
|
|
},
|
|
"DeleteClientsClientIdRequest": {
|
|
"type": "object"
|
|
},
|
|
"PostClientsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"groupId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
}
|
|
}
|
|
},
|
|
"PostClientsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"fullname": {
|
|
"type": "string",
|
|
"example": "Client of group"
|
|
},
|
|
"groupId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"activationDate": {
|
|
"type": "string",
|
|
"example": "04 March 2009"
|
|
}
|
|
}
|
|
},
|
|
"GetCollateralsTemplateAllowedTypes": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 9
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Silver"
|
|
},
|
|
"position": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
}
|
|
}
|
|
},
|
|
"GetLoansLoanIdCollateralsTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"allowedCollateralTypes": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetCollateralsTemplateAllowedTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetCollateralCurrencyResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetCollateralTypeResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 8
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Gold"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansLoanIdCollateralsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 12
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/GetCollateralTypeResponse"
|
|
},
|
|
"value": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 50000
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "24 Carat Gold chain weighing 12 grams"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetCollateralCurrencyResponse"
|
|
}
|
|
}
|
|
},
|
|
"PostLoansLoanIdCollateralsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"loanId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 12
|
|
}
|
|
}
|
|
},
|
|
"PostLoansLoanIdCollateralsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"collateralTypeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 9
|
|
}
|
|
}
|
|
},
|
|
"PutLoansLoanIdCollateralsCollateralIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"loanId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 12
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutLoansLoandIdCollateralsCollateralIdRequest"
|
|
}
|
|
}
|
|
},
|
|
"PutLoansLoandIdCollateralsCollateralIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"description": {
|
|
"type": "string",
|
|
"example": "22 Carat Gold chain weighing 12 grams"
|
|
}
|
|
}
|
|
},
|
|
"DeleteLoansLoanIdCollateralsCollateralIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"loanId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 12
|
|
}
|
|
}
|
|
},
|
|
"PostCollectionSheetChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"loanTransactions": {
|
|
"type": "array",
|
|
"example": "[15]",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"SavingsTransactions": {
|
|
"type": "array",
|
|
"example": "[]",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PostCollectionSheetResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"groupId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 10
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 10
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PostCollectionSheetChanges"
|
|
}
|
|
}
|
|
},
|
|
"PostCollectionSheetBulkRepaymentTransactions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"loanId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 10
|
|
},
|
|
"transactionAmount": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 1221.36
|
|
},
|
|
"paymentTypeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 19
|
|
},
|
|
"receiptNumber": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1245356
|
|
}
|
|
}
|
|
},
|
|
"PostCollectionSheetRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"transactionDate": {
|
|
"type": "string",
|
|
"example": "04 May 2014"
|
|
},
|
|
"actualDisbursementDate": {
|
|
"type": "string",
|
|
"example": "04 May 2014"
|
|
},
|
|
"bulkDisbursementTransactions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"bulkRepaymentTransactions": {
|
|
"$ref": "#/definitions/PostCollectionSheetBulkRepaymentTransactions"
|
|
},
|
|
"bulkSavingsDueTransactions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PostFloatingRatesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostFloatingRatesRatePeriods": {
|
|
"type": "object",
|
|
"properties": {
|
|
"fromDate": {
|
|
"type": "string",
|
|
"example": "19 November 2015"
|
|
},
|
|
"interestRate": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 10
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
}
|
|
}
|
|
},
|
|
"PostFloatingRatesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Floating Rate 1"
|
|
},
|
|
"isBaseLendingRate": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"ratePeriods": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/PostFloatingRatesRatePeriods"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PutFloatingRatesChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"ratePeriods": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/PostFloatingRatesRatePeriods"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PutFloatingRatesFloatingRateIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutFloatingRatesChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutFloatingRatesFloatingRateIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Floating Rate 1"
|
|
},
|
|
"isBaseLendingRate": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"ratePeriods": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/PostFloatingRatesRatePeriods"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetFloatingRatesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Floating Rate 1"
|
|
},
|
|
"isBaseLendingRate": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"createdOn": {
|
|
"type": "string",
|
|
"example": "Nov 18, 2015"
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"modifiedOn": {
|
|
"type": "string",
|
|
"example": "Nov 18, 2015"
|
|
}
|
|
}
|
|
},
|
|
"GetFloatingRatesFloatingRateIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Floating Rate 1"
|
|
},
|
|
"isBaseLendingRate": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"createdOn": {
|
|
"type": "string",
|
|
"example": "Nov 18, 2015"
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"modifiedOn": {
|
|
"type": "string",
|
|
"example": "Nov 18, 2015"
|
|
},
|
|
"ratePeriods": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetFloatingRatesRatePeriods"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetFloatingRatesRatePeriods": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"fromDate": {
|
|
"type": "string",
|
|
"example": "Dec 15, 2015"
|
|
},
|
|
"interestRate": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 11
|
|
},
|
|
"isDifferentialToBaseLendingRate": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"createdOn": {
|
|
"type": "string",
|
|
"example": "Nov 18, 2015"
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"modifiedOn": {
|
|
"type": "string",
|
|
"example": "Nov 18, 2015"
|
|
}
|
|
}
|
|
},
|
|
"GetFundsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "EU Agri Fund"
|
|
}
|
|
}
|
|
},
|
|
"PostFundsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostFundsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "EU Agri Fund"
|
|
}
|
|
}
|
|
},
|
|
"PutFundsFundIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "EU Agri Fund (2010-2020)"
|
|
}
|
|
}
|
|
},
|
|
"PutFundsFundIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutFundsFundIdRequest"
|
|
}
|
|
}
|
|
},
|
|
"GetCentersAccountType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.group"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Group"
|
|
}
|
|
}
|
|
},
|
|
"GetCentersCenterIdAccountsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"savingsAccounts": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetCentersSavingsAccounts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetCentersCenterIdCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"inMultiplesOf": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetCentersCenterIdStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsAccountStatusType.submitted.and.pending.approval"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Submitted and pending approval"
|
|
},
|
|
"submittedAndPendingApproval": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"approved": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"rejected": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"withdrawnByApplicant": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closed": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"prematureClosed": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"transferInProgress": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"transferOnHold": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetCentersDepositType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "depositAccountType.savingsDeposit"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Savings"
|
|
}
|
|
}
|
|
},
|
|
"GetCentersSavingsAccounts": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 16
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 16
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"productName": {
|
|
"type": "string",
|
|
"example": "Voluntary savings"
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetCentersCenterIdStatus"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetCentersCenterIdCurrency"
|
|
},
|
|
"accountType": {
|
|
"$ref": "#/definitions/GetCentersAccountType"
|
|
},
|
|
"timeline": {
|
|
"$ref": "#/definitions/GetCentersTimeline"
|
|
},
|
|
"depositType": {
|
|
"$ref": "#/definitions/GetCentersDepositType"
|
|
}
|
|
}
|
|
},
|
|
"GetCentersTimeline": {
|
|
"type": "object",
|
|
"properties": {
|
|
"submittedOnDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2014, 5, 1]"
|
|
},
|
|
"submittedByUsername": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"submittedByFirstname": {
|
|
"type": "string",
|
|
"example": "App"
|
|
},
|
|
"submittedByLastname": {
|
|
"type": "string",
|
|
"example": "Administrator"
|
|
}
|
|
}
|
|
},
|
|
"GetCentersOfficeOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"nameDecorated": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
}
|
|
}
|
|
},
|
|
"GetCentersStaffOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"example": "D, Mary"
|
|
}
|
|
}
|
|
},
|
|
"GetCentersTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"activationDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2013, 4, 18]"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"officeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetCentersOfficeOptions"
|
|
}
|
|
},
|
|
"staffOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetCentersStaffOptions"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetCentersPageItems": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetCentersStatus"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Center 1"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"hierarchy": {
|
|
"type": "string",
|
|
"example": ".2."
|
|
}
|
|
}
|
|
},
|
|
"GetCentersResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalFilteredRecords": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"pageItems": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetCentersPageItems"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetCentersStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "groupingStatusType.pending"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Pending"
|
|
}
|
|
}
|
|
},
|
|
"PostCentersCenterIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostCentersCenterIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"closureReasonId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 32
|
|
},
|
|
"closureDate": {
|
|
"type": "string",
|
|
"example": "05 May 2014"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
}
|
|
}
|
|
},
|
|
"GetCentersCenterIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 8
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetCentersStatus"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "First Center (No groups)"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"hierarchy": {
|
|
"type": "string",
|
|
"example": ".8."
|
|
}
|
|
}
|
|
},
|
|
"PutCentersCenterIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"groupId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 8
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 8
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutCentersChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutCentersChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "First Center (No groups) - modified"
|
|
}
|
|
}
|
|
},
|
|
"PutCentersCenterIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "First Center (No groups)"
|
|
}
|
|
}
|
|
},
|
|
"DeleteCentersCenterIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/DeleteCentersChanges"
|
|
}
|
|
}
|
|
},
|
|
"DeleteCentersChanges": {
|
|
"type": "object"
|
|
},
|
|
"PostCentersResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"groupId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 8
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 8
|
|
}
|
|
}
|
|
},
|
|
"PostCentersRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "First Center (No groups)"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"PostGroupsGroupIdCommandUnassignStaffChanges": {
|
|
"type": "object"
|
|
},
|
|
"PostGroupsGroupIdCommandUnassignStaffResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"groupId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PostGroupsGroupIdCommandUnassignStaffChanges"
|
|
}
|
|
}
|
|
},
|
|
"PostGroupsGroupIdCommandUnassignStaffRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"staffId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostGroupsGroupIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostGroupsGroupIdClients": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostGroupsGroupIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"destinationGroupId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"clients": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/PostGroupsGroupIdClients"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetGroupsGroupIdAccountsLoanAccounts": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 3
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"productName": {
|
|
"type": "string",
|
|
"example": "daily product"
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetGroupsGroupIdAccountsStatus"
|
|
},
|
|
"loanType": {
|
|
"$ref": "#/definitions/GetGroupsGroupIdAccountsLoanType"
|
|
}
|
|
}
|
|
},
|
|
"GetGroupsGroupIdAccountsLoanType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.group"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Group"
|
|
}
|
|
}
|
|
},
|
|
"GetGroupsGroupIdAccountsMemberLoanAccounts": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 4
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"productName": {
|
|
"type": "string",
|
|
"example": "testLoan"
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetGroupsGroupIdAccountsMemberLoanStatus"
|
|
},
|
|
"loanType": {
|
|
"$ref": "#/definitions/GetGroupsGroupIdAccountsMemberLoanType"
|
|
}
|
|
}
|
|
},
|
|
"GetGroupsGroupIdAccountsMemberLoanStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 200
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "loanStatusType.approved"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Approved"
|
|
},
|
|
"pendingApproval": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"waitingForDisbursal": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closedObligationsMet": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closedWrittenOff": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closedRescheduled": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closed": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"overpaid": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetGroupsGroupIdAccountsMemberLoanType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.jlg"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "JLG"
|
|
}
|
|
}
|
|
},
|
|
"GetGroupsGroupIdAccountsMemberSavingsAccounts": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 3
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"productName": {
|
|
"type": "string",
|
|
"example": "p_sav"
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetGroupsGroupIdAccountsSavingStatus"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetGroupsGroupIdAccountsSavingCurrency"
|
|
},
|
|
"accountType": {
|
|
"$ref": "#/definitions/GetGroupsGroupIdAccountsMemberLoanType"
|
|
}
|
|
}
|
|
},
|
|
"GetGroupsGroupIdAccountsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"loanAccounts": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetGroupsGroupIdAccountsLoanAccounts"
|
|
}
|
|
},
|
|
"savingsAccounts": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetGroupsGroupIdAccountsSavingAccounts"
|
|
}
|
|
},
|
|
"memberLoanAccounts": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetGroupsGroupIdAccountsMemberLoanAccounts"
|
|
}
|
|
},
|
|
"memberSavingsAccounts": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetGroupsGroupIdAccountsMemberSavingsAccounts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetGroupsGroupIdAccountsSavingAccountType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.group"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Group"
|
|
}
|
|
}
|
|
},
|
|
"GetGroupsGroupIdAccountsSavingAccounts": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 9
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 9
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"productName": {
|
|
"type": "string",
|
|
"example": "p_sav"
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetGroupsGroupIdAccountsSavingStatus"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetGroupsGroupIdAccountsSavingCurrency"
|
|
},
|
|
"accountType": {
|
|
"$ref": "#/definitions/GetGroupsGroupIdAccountsSavingAccountType"
|
|
}
|
|
}
|
|
},
|
|
"GetGroupsGroupIdAccountsSavingCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetGroupsGroupIdAccountsSavingStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsAccountStatusType.submitted.and.pending.approval"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Submitted and pending approval"
|
|
},
|
|
"submittedAndPendingApproval": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"approved": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"rejected": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"withdrawnByApplicant": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closed": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetGroupsGroupIdAccountsStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "loanStatusType.submitted.and.pending.approval"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Submitted and pending approval"
|
|
},
|
|
"pendingApproval": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"waitingForDisbursal": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closedObligationsMet": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closedWrittenOff": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closedRescheduled": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closed": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"overpaid": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetGroupsTemplateClientOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"example": "Petra Yton"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
}
|
|
}
|
|
},
|
|
"GetGroupsTemplateColumnHeaderData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"columnName": {
|
|
"type": "string",
|
|
"example": "group_id"
|
|
},
|
|
"columnType": {
|
|
"type": "string",
|
|
"example": "bigint"
|
|
},
|
|
"columnLength": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"columnDisplayType": {
|
|
"type": "string",
|
|
"example": "INTEGER"
|
|
},
|
|
"isColumnNullable": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"isColumnPrimaryKey": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"columnValues": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetGroupsTemplateColumnValues"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetGroupsTemplateColumnValues": {
|
|
"type": "object"
|
|
},
|
|
"GetGroupsTemplateDatatables": {
|
|
"type": "object",
|
|
"properties": {
|
|
"applicationTableName": {
|
|
"type": "string",
|
|
"example": "m_group"
|
|
},
|
|
"registeredTableName": {
|
|
"type": "string",
|
|
"example": "Group Activation Data"
|
|
},
|
|
"columnHeaderData": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetGroupsTemplateColumnHeaderData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetGroupsTemplateOfficeOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"nameDecorated": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
}
|
|
}
|
|
},
|
|
"GetGroupsTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"officeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetGroupsTemplateOfficeOptions"
|
|
}
|
|
},
|
|
"staffOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetGroupsTemplateStaffOptions"
|
|
}
|
|
},
|
|
"clientOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetGroupsTemplateClientOptions"
|
|
}
|
|
},
|
|
"datatables": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetGroupsTemplateDatatables"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetGroupsTemplateStaffOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"example": "C, Mike"
|
|
}
|
|
}
|
|
},
|
|
"GetGroupsPageItems": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "AnotherGroup"
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetGroupsStatus"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"hierarchy": {
|
|
"type": "string",
|
|
"example": ".4."
|
|
}
|
|
}
|
|
},
|
|
"GetGroupsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalFilteredRecords": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"pageItems": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetGroupsPageItems"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetGroupsStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "clientStatusType.pending"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Pending"
|
|
}
|
|
}
|
|
},
|
|
"GetGroupsGroupIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "First Group"
|
|
},
|
|
"externalId": {
|
|
"type": "string",
|
|
"example": "000-1A"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"hierarchy": {
|
|
"type": "string",
|
|
"example": ".1."
|
|
},
|
|
"timeline": {
|
|
"$ref": "#/definitions/GetGroupsGroupIdTimeline"
|
|
}
|
|
}
|
|
},
|
|
"GetGroupsGroupIdTimeline": {
|
|
"type": "object",
|
|
"properties": {
|
|
"activatedOnDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2013, 11, 14]"
|
|
},
|
|
"activatedByUsername": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"activatedByFirstname": {
|
|
"type": "string",
|
|
"example": "App"
|
|
},
|
|
"activatedByLastname": {
|
|
"type": "string",
|
|
"example": "Administrator"
|
|
}
|
|
}
|
|
},
|
|
"PutGroupsGroupIdChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "First Group (changed)"
|
|
}
|
|
}
|
|
},
|
|
"PutGroupsGroupIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"groupId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutGroupsGroupIdChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutGroupsGroupIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "First Group (changed)"
|
|
}
|
|
}
|
|
},
|
|
"DeleteGroupsGroupIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"groupId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
}
|
|
}
|
|
},
|
|
"PostGroupsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"groupId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
}
|
|
}
|
|
},
|
|
"PostGroupsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Pending Group"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetInterestRateChartsChartIdChartSlabsAttributeName": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": "InterestIncentiveAttributeName.gender"
|
|
},
|
|
"value": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": "Gender"
|
|
}
|
|
}
|
|
},
|
|
"GetInterestRateChartsChartIdChartSlabsConditionType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": "incentiveConditionType.equal"
|
|
},
|
|
"value": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": "equal"
|
|
}
|
|
}
|
|
},
|
|
"GetInterestRateChartsChartIdChartSlabsEntityType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": "InterestIncentiveEntityType.customer"
|
|
},
|
|
"value": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": "Customer"
|
|
}
|
|
}
|
|
},
|
|
"GetInterestRateChartsChartIdChartSlabsIncentiveType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": "InterestIncentiveType.incentive"
|
|
},
|
|
"value": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": "Incentive"
|
|
}
|
|
}
|
|
},
|
|
"GetInterestRateChartsChartIdChartSlabsIncentives": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"entityType": {
|
|
"$ref": "#/definitions/GetInterestRateChartsChartIdChartSlabsEntityType"
|
|
},
|
|
"attributeName": {
|
|
"$ref": "#/definitions/GetInterestRateChartsChartIdChartSlabsAttributeName"
|
|
},
|
|
"conditionType": {
|
|
"$ref": "#/definitions/GetInterestRateChartsChartIdChartSlabsConditionType"
|
|
},
|
|
"attributeValue": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 11
|
|
},
|
|
"attributeValueDesc": {
|
|
"type": "string",
|
|
"example": "FEMALE"
|
|
},
|
|
"incentiveType": {
|
|
"$ref": "#/definitions/GetInterestRateChartsChartIdChartSlabsIncentiveType"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": -1
|
|
}
|
|
}
|
|
},
|
|
"GetInterestRateChartsChartIdChartSlabsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "5% interest from 1 day till 180 days of deposit"
|
|
},
|
|
"periodTypes": {
|
|
"$ref": "#/definitions/GetInterestRateChartsTemplatePeriodTypes"
|
|
},
|
|
"fromPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"toPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 180
|
|
},
|
|
"annualInterestRate": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 5
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetInterestRateChartsCurrency"
|
|
},
|
|
"incentives": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetInterestRateChartsChartIdChartSlabsIncentives"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetInterestRateChartsCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetInterestRateChartsTemplatePeriodTypes": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "interestChartPeriodType.days"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Days"
|
|
}
|
|
}
|
|
},
|
|
"PutInterestRateChartsChartIdChartSlabsChartSlabIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"annualInterestRate": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 6
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Interest rate changed to 6%"
|
|
}
|
|
}
|
|
},
|
|
"PutInterestRateChartsChartIdChartSlabsChartSlabIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutInterestRateChartsChartIdChartSlabsChartSlabIdRequest"
|
|
}
|
|
}
|
|
},
|
|
"DeleteInterestRateChartsChartIdChartSlabsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostInterestRateChartsChartIdChartSlabsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostInterestRateChartsChartIdChartSlabsIncentives": {
|
|
"type": "object",
|
|
"properties": {
|
|
"entityType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"attributeName": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"conditionType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"attributeValue": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 11
|
|
},
|
|
"incentiveType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": -1
|
|
}
|
|
}
|
|
},
|
|
"PostInterestRateChartsChartIdChartSlabsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"periodType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"fromPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"toPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 180
|
|
},
|
|
"annualInterestRate": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 5
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "5% interest from 1 day till 180 days of deposit"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"incentives": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/PostInterestRateChartsChartIdChartSlabsIncentives"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetInterestRateChartsTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"periodTypes": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetInterestRateChartsTemplatePeriodTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetInterestRateChartsChartSlabs": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"periodTypes": {
|
|
"$ref": "#/definitions/GetInterestRateChartsTemplatePeriodTypes"
|
|
},
|
|
"fromPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"annualInterestRate": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 6
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetInterestRateChartsCurrency"
|
|
}
|
|
}
|
|
},
|
|
"GetInterestRateChartsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"fromDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2014, 1, 1]"
|
|
},
|
|
"savingsProductId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"savingsProductName": {
|
|
"type": "string",
|
|
"example": "Fixed Deposit Product 001"
|
|
},
|
|
"chartSlabs": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetInterestRateChartsChartSlabs"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PutInterestRateChartsChartIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PutInterestRateChartsChartIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Interest rate chart for 2014"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Interest rate chart for 2014"
|
|
}
|
|
}
|
|
},
|
|
"DeleteInterestRateChartsChartIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostInterestRateChartsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostInterestRateChartsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Chart - 2014"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "This chart is applicable for year 2014"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"example": "Document"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"fromDate": {
|
|
"type": "string",
|
|
"example": "01 Jan 2014"
|
|
}
|
|
}
|
|
},
|
|
"PostLoansLoanIdChargesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"loanId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 31
|
|
}
|
|
}
|
|
},
|
|
"PostLoansLoanIdChargesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"chargeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 100
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"dueDate": {
|
|
"type": "string",
|
|
"example": "29 April 2013"
|
|
}
|
|
}
|
|
},
|
|
"PostLoansLoanIdChargesChargeIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"loanId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 6
|
|
},
|
|
"savingsId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 12
|
|
}
|
|
}
|
|
},
|
|
"PostLoansLoanIdChargesChargeIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"transactionDate": {
|
|
"type": "string",
|
|
"example": "19 September 2013"
|
|
}
|
|
}
|
|
},
|
|
"DeleteLoansLoanIdChargesChargeIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"loanId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
}
|
|
}
|
|
},
|
|
"GetLoanChargeCalculationType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeCalculationType.flat"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Flat"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanChargeCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanChargeTimeType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeTimeType.disbursement"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Disbursement"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansLoanIdChargesChargeIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"chargeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Loan Processing fee"
|
|
},
|
|
"chargeTimeType": {
|
|
"$ref": "#/definitions/GetLoanChargeTimeType"
|
|
},
|
|
"chargeCalculationType": {
|
|
"$ref": "#/definitions/GetLoanChargeCalculationType"
|
|
},
|
|
"percentage": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 0
|
|
},
|
|
"amountPercentageAppliedTo": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 0
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetLoanChargeCurrency"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 100
|
|
},
|
|
"amountPaid": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"amountWaived": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"amountWrittenOff": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"amountOutstanding": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 100
|
|
},
|
|
"amountOrPercentage": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 100
|
|
},
|
|
"penalty": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"PutLoansLoanIdChargesChargeIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 60
|
|
},
|
|
"dueDate": {
|
|
"type": "string",
|
|
"example": "27 March 2013"
|
|
}
|
|
}
|
|
},
|
|
"PutLoansLoanIdChargesChargeIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"loanId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 6
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutLoansLoanIdChargesChargeIdRequest"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanChargeTemplateChargeAppliesTo": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": "1 "
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeAppliesTo.loan"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Loan"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanChargeTemplateChargeOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Collection fee"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"penalty": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetLoanChargeCurrency"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 100
|
|
},
|
|
"chargeTimeType": {
|
|
"$ref": "#/definitions/GetLoanChargeTemplateChargeTimeType"
|
|
},
|
|
"chargeAppliesTo": {
|
|
"$ref": "#/definitions/GetLoanChargeTemplateChargeAppliesTo"
|
|
},
|
|
"chargeCalculationType": {
|
|
"$ref": "#/definitions/GetLoanChargeCalculationType"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanChargeTemplateChargeTimeType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeTimeType.specifiedDueDate"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Specified due date"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansLoanIdChargesTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"amountPaid": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"amountWaived": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"amountWrittenOff": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"chargeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoanChargeTemplateChargeOptions"
|
|
}
|
|
},
|
|
"penalty": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"PostLoanChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"removedEntityIds": {
|
|
"type": "array",
|
|
"example": "[21, 22]",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PostLoansLoanIdScheduleResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"loanId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PostLoanChanges"
|
|
}
|
|
}
|
|
},
|
|
"PostLoansLoanIdScheduleRequest": {
|
|
"type": "object"
|
|
},
|
|
"GetLoansCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansLoanIdTransactionsTransactionIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/GetLoansType"
|
|
},
|
|
"date": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2012, 5, 14]"
|
|
},
|
|
"manuallyReversed": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetLoansCurrency"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 559.88
|
|
},
|
|
"interestPortion": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 559.88
|
|
}
|
|
}
|
|
},
|
|
"GetLoansType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "loanTransactionType.repayment"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Repayment"
|
|
},
|
|
"disbursement": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"repaymentAtDisbursement": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"repayment": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"contra": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"waiveInterest": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"waiveCharges": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"writeOff": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"recoveryRepayment": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetLoansLoanIdTransactionsTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"transactionType": {
|
|
"$ref": "#/definitions/GetLoansTransactionType"
|
|
},
|
|
"date": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2009, 8, 1]"
|
|
},
|
|
"total": {
|
|
"$ref": "#/definitions/GetLoansTotal"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansTotal": {
|
|
"type": "object",
|
|
"properties": {
|
|
"currencyCode": {
|
|
"type": "string",
|
|
"example": "XOF"
|
|
},
|
|
"digitsAfterDecimal": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"inMultiplesOf": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 471
|
|
},
|
|
"defaultName": {
|
|
"type": "string",
|
|
"example": "CFA Franc BCEAO"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.XOF"
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "CFA"
|
|
},
|
|
"zero": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"greaterThanZero": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"displaySymbolValue": {
|
|
"type": "string",
|
|
"example": "471 CFA"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansTransactionType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "loanTransactionType.repayment"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Repayment"
|
|
}
|
|
}
|
|
},
|
|
"PostLoansLoanIdTransactionsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 22
|
|
}
|
|
}
|
|
},
|
|
"PostLoansLoanIdTransactionsRequest": {
|
|
"type": "object"
|
|
},
|
|
"PostLoansLoanIdTransactionsTransactionIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 16
|
|
}
|
|
}
|
|
},
|
|
"PostLoansLoanIdTransactionsTransactionIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en_GB"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"transactionDate": {
|
|
"type": "string",
|
|
"example": "25 May 2012"
|
|
},
|
|
"transactionAmount": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": "50,000.00"
|
|
},
|
|
"note": {
|
|
"type": "string",
|
|
"example": "An optional note about why your adjusting or changing the transaction."
|
|
}
|
|
}
|
|
},
|
|
"GetLoansLoanIdCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "UGX"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Uganda Shilling"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "USh"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.UGX"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "Uganda Shilling (USh)"
|
|
}
|
|
}
|
|
},
|
|
"PostLoansRepaymentSchedulePeriods": {
|
|
"type": "object",
|
|
"properties": {
|
|
"period": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"dueDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2011, 9, 20]"
|
|
},
|
|
"principalDisbursed": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 100000
|
|
},
|
|
"principalLoanBalanceOutstanding": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 100000
|
|
},
|
|
"feeChargesDue": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"feeChargesOutstanding": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"totalOriginalDueForPeriod": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"totalDueForPeriod": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"totalOutstandingForPeriod": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"totalOverdue": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"totalActualCostOfLoanForPeriod": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
}
|
|
}
|
|
},
|
|
"PostLoansResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"currency": {
|
|
"$ref": "#/definitions/GetLoansLoanIdCurrency"
|
|
},
|
|
"loanTermInDays": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 366
|
|
},
|
|
"totalPrincipalDisbursed": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 100000
|
|
},
|
|
"totalPrincipalExpected": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 100000
|
|
},
|
|
"totalPrincipalPaid": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"totalInterestCharged": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 13471.52
|
|
},
|
|
"totalFeeChargesCharged": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"totalPenaltyChargesCharged": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"totalWaived": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"totalWrittenOff": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"totalRepaymentExpected": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 113471.52
|
|
},
|
|
"totalRepayment": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"totalOutstanding": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"periods": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/PostLoansRepaymentSchedulePeriods"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PostLoansRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en_GB"
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"principal": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": "100,000.00"
|
|
},
|
|
"loanTermFrequency": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 12
|
|
},
|
|
"loanTermFrequencyType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"numberOfRepayments": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 12
|
|
},
|
|
"repaymentEvery": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"repaymentFrequencyType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"interestRatePerPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"amortizationType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"interestType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"interestCalculationPeriodType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"expectedDisbursementDate": {
|
|
"type": "string",
|
|
"example": "20 September 2011"
|
|
},
|
|
"transactionProcessingStrategyId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
}
|
|
}
|
|
},
|
|
"PutLoansLoanIdChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"principal": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 5000
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
}
|
|
}
|
|
},
|
|
"PutLoansLoanIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"loanId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutLoansLoanIdChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutLoansLoanIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"principal": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 5000
|
|
},
|
|
"loanTermFrequency": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 10
|
|
},
|
|
"loanTermFrequencyType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"numberOfRepayments": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 10
|
|
},
|
|
"repaymentEvery": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"repaymentFrequencyType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"interestRatePerPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"interestType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"interestCalculationPeriodType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"amortizationType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"expectedDisbursementDate": {
|
|
"type": "string",
|
|
"example": "04 March 2014"
|
|
},
|
|
"transactionProcessingStrategyId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"DeleteLoansLoanIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"loanId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostLoansLoanIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 6
|
|
},
|
|
"loanId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
}
|
|
}
|
|
},
|
|
"PostLoansLoanIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"toLoanOfficerId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"assignmentDate": {
|
|
"type": "string",
|
|
"example": "02 September 2014"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"fromLoanOfficerId": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansLoanIdAmortizationType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "amortizationType.equal.installments"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Equal installments"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansLoanIdChargeCalculationType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeCalculationType.percent.of.amount"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "% Amount"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansLoanIdChargePaymentMode": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargepaymentmode.regular"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Regular"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansLoanIdChargeTimeType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 9
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeTimeType.overdueInstallment"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "overdue fees"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansLoanIdDisbursementDetails": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 71
|
|
},
|
|
"expectedDisbursementDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2013, 11, 1]"
|
|
},
|
|
"principal": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 22000
|
|
},
|
|
"approvedPrincipal": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 22000
|
|
}
|
|
}
|
|
},
|
|
"GetLoansLoanIdEmiVariations": {
|
|
"type": "object"
|
|
},
|
|
"GetLoansLoanIdFeeFrequency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "feeFrequencyperiodFrequencyType.weeks"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Weeks"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansLoanIdInterestCalculationPeriodType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "interestCalculationPeriodType.same.as.repayment.period"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Same as repayment period"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansLoanIdInterestRateFrequencyType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "interestRateFrequency.periodFrequencyType.years"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Per year"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansLoanIdInterestType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "interestType.flat"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Flat"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansLoanIdLinkedAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"GetLoansLoanIdLoanType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "loanType.individual"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Individual"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansLoanIdOverdueCharges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 20
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "overdraft penality"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"penalty": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetLoanCurrency"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 3
|
|
},
|
|
"chargeTimeType": {
|
|
"$ref": "#/definitions/GetLoansLoanIdChargeTimeType"
|
|
},
|
|
"chargeAppliesTo": {
|
|
"$ref": "#/definitions/GetLoanChargeTemplateChargeAppliesTo"
|
|
},
|
|
"chargeCalculationType": {
|
|
"$ref": "#/definitions/GetLoansLoanIdChargeCalculationType"
|
|
},
|
|
"chargePaymentMode": {
|
|
"$ref": "#/definitions/GetLoansLoanIdChargePaymentMode"
|
|
},
|
|
"feeInterval": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"feeFrequency": {
|
|
"$ref": "#/definitions/GetLoansLoanIdFeeFrequency"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansLoanIdRepaymentFrequencyType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "repaymentFrequency.periodFrequencyType.months"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Months"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansLoanIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetLoansLoanIdStatus"
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientName": {
|
|
"type": "string",
|
|
"example": "Kampala first Client"
|
|
},
|
|
"clientOfficeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"loanProductId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"loanProductName": {
|
|
"type": "string",
|
|
"example": "Kampala Product (with cash accounting)"
|
|
},
|
|
"loanProductDescription": {
|
|
"type": "string",
|
|
"example": "Typical Kampala loan product with cash accounting enabled for testing."
|
|
},
|
|
"loanPurposeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 22
|
|
},
|
|
"loanPurposeName": {
|
|
"type": "string",
|
|
"example": "option.HousingImprovement"
|
|
},
|
|
"loanOfficerId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"loanOfficerName": {
|
|
"type": "string",
|
|
"example": "LoanOfficer, Kampala"
|
|
},
|
|
"loanType": {
|
|
"$ref": "#/definitions/GetLoansLoanIdLoanType"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetLoansLoanIdCurrency"
|
|
},
|
|
"principal": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1000000
|
|
},
|
|
"termFrequency": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 12
|
|
},
|
|
"termPeriodFrequencyType": {
|
|
"$ref": "#/definitions/GetLoansLoanIdTermPeriodFrequencyType"
|
|
},
|
|
"numberOfRepayments": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 12
|
|
},
|
|
"repaymentEvery": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"repaymentFrequencyType": {
|
|
"$ref": "#/definitions/GetLoansLoanIdRepaymentFrequencyType"
|
|
},
|
|
"interestRatePerPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 24
|
|
},
|
|
"interestRateFrequencyType": {
|
|
"$ref": "#/definitions/GetLoansLoanIdInterestRateFrequencyType"
|
|
},
|
|
"annualInterestRate": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 24
|
|
},
|
|
"amortizationType": {
|
|
"$ref": "#/definitions/GetLoansLoanIdAmortizationType"
|
|
},
|
|
"interestType": {
|
|
"$ref": "#/definitions/GetLoansLoanIdInterestType"
|
|
},
|
|
"interestCalculationPeriodType": {
|
|
"$ref": "#/definitions/GetLoansLoanIdInterestCalculationPeriodType"
|
|
},
|
|
"transactionProcessingStrategyId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"timeline": {
|
|
"$ref": "#/definitions/GetLoansLoanIdTimeline"
|
|
},
|
|
"summary": {
|
|
"$ref": "#/definitions/GetLoansLoanIdSummary"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansLoanIdStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 300
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "loanStatusType.active"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Active"
|
|
},
|
|
"pendingApproval": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"waitingForDisbursal": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"closedObligationsMet": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closedWrittenOff": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closedRescheduled": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closed": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"overpaid": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetLoansLoanIdSummary": {
|
|
"type": "object",
|
|
"properties": {
|
|
"currency": {
|
|
"$ref": "#/definitions/GetLoansLoanIdCurrency"
|
|
},
|
|
"principalDisbursed": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1000000
|
|
},
|
|
"principalPaid": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"principalWrittenOff": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"principalOutstanding": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1000000
|
|
},
|
|
"principalOverdue": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 833333.3
|
|
},
|
|
"interestCharged": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 240000
|
|
},
|
|
"interestPaid": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"interestWaived": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"interestWrittenOff": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"interestOutstanding": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 240000
|
|
},
|
|
"interestOverdue": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 200000
|
|
},
|
|
"feeChargesCharged": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 18000
|
|
},
|
|
"feeChargesDueAtDisbursementCharged": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"feeChargesPaid": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"feeChargesWaived": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"feeChargesWrittenOff": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"feeChargesOutstanding": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 18000
|
|
},
|
|
"feeChargesOverdue": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 15000
|
|
},
|
|
"penaltyChargesCharged": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"penaltyChargesPaid": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"penaltyChargesWaived": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"penaltyChargesWrittenOff": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"penaltyChargesOutstanding": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"penaltyChargesOverdue": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"totalExpectedRepayment": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1258000
|
|
},
|
|
"totalRepayment": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"totalExpectedCostOfLoan": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 258000
|
|
},
|
|
"totalCostOfLoan": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"totalWaived": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"totalWrittenOff": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"totalOutstanding": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1258000
|
|
},
|
|
"totalOverdue": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 1048333.3
|
|
},
|
|
"overdueSinceDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2012, 5, 10]"
|
|
},
|
|
"linkedAccount": {
|
|
"$ref": "#/definitions/GetLoansLoanIdLinkedAccount"
|
|
},
|
|
"disbursementDetails": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoansLoanIdDisbursementDetails"
|
|
}
|
|
},
|
|
"fixedEmiAmount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 1100
|
|
},
|
|
"maxOutstandingLoanBalance": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 35000
|
|
},
|
|
"canDisburse": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"emiAmountVariations": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoansLoanIdEmiVariations"
|
|
}
|
|
},
|
|
"inArrears": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"isNPA": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"overdueCharges": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoansLoanIdOverdueCharges"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetLoansLoanIdTermPeriodFrequencyType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "termFrequency.periodFrequencyType.months"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Months"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansLoanIdTimeline": {
|
|
"type": "object",
|
|
"properties": {
|
|
"submittedOnDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2012, 4, 3]"
|
|
},
|
|
"submittedByUsername": {
|
|
"type": "string",
|
|
"example": "admin"
|
|
},
|
|
"submittedByFirstname": {
|
|
"type": "string",
|
|
"example": "App"
|
|
},
|
|
"submittedByLastname": {
|
|
"type": "string",
|
|
"example": "Administrator"
|
|
},
|
|
"approvedOnDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2012, 4, 3]"
|
|
},
|
|
"approvedByUsername": {
|
|
"type": "string",
|
|
"example": "admin"
|
|
},
|
|
"approvedByFirstname": {
|
|
"type": "string",
|
|
"example": "App"
|
|
},
|
|
"approvedByLastname": {
|
|
"type": "string",
|
|
"example": "Administrator"
|
|
},
|
|
"expectedDisbursementDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2012, 4, 10]"
|
|
},
|
|
"actualDisbursementDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2012, 4, 10]"
|
|
},
|
|
"disbursedByUsername": {
|
|
"type": "string",
|
|
"example": "admin"
|
|
},
|
|
"disbursedByFirstname": {
|
|
"type": "string",
|
|
"example": "App"
|
|
},
|
|
"disbursedByLastname": {
|
|
"type": "string",
|
|
"example": "Administrator"
|
|
},
|
|
"expectedMaturityDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2012, 4, 10]"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansTemplateProductOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Kampala Product (with cash accounting)"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"clientName": {
|
|
"type": "string",
|
|
"example": "Kampala first Client"
|
|
},
|
|
"clientOfficeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"timeline": {
|
|
"$ref": "#/definitions/GetLoansTemplateTimeline"
|
|
},
|
|
"productOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoansTemplateProductOptions"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetLoansTemplateTimeline": {
|
|
"type": "object",
|
|
"properties": {
|
|
"expectedDisbursementDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2013, 3, 8]"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalFilteredRecords": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"pageItems": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoansLoanIdResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetLoanAccountingMappings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"fundSourceAccount": {
|
|
"$ref": "#/definitions/GetLoanFundSourceAccount"
|
|
},
|
|
"loanPortfolioAccount": {
|
|
"$ref": "#/definitions/GetLoanPortfolioAccount"
|
|
},
|
|
"transfersInSuspenseAccount": {
|
|
"$ref": "#/definitions/GetLoanTransfersInSuspenseAccount"
|
|
},
|
|
"interestOnLoanAccount": {
|
|
"$ref": "#/definitions/GetLoanInterestOnLoanAccount"
|
|
},
|
|
"incomeFromFeeAccount": {
|
|
"$ref": "#/definitions/GetLoanIncomeFromFeeAccount"
|
|
},
|
|
"incomeFromPenaltyAccount": {
|
|
"$ref": "#/definitions/GetLoanIncomeFromPenaltyAccount"
|
|
},
|
|
"writeOffAccount": {
|
|
"$ref": "#/definitions/GetLoanWriteOffAccount"
|
|
},
|
|
"overpaymentLiabilityAccount": {
|
|
"$ref": "#/definitions/GetLoanOverpaymentLiabilityAccount"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanCharge": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "flat install"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"penalty": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetLoanFeeToIncomeAccountMappings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"charge": {
|
|
"$ref": "#/definitions/GetLoanCharge"
|
|
},
|
|
"incomeAccount": {
|
|
"$ref": "#/definitions/GetLoanIncomeFromFeeAccount"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanFundSourceAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "fund source"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"GetLoanIncomeFromFeeAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 8
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "income from fees 2"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 10
|
|
}
|
|
}
|
|
},
|
|
"GetLoanIncomeFromPenaltyAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 9
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "income from penalities 2"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 11
|
|
}
|
|
}
|
|
},
|
|
"GetLoanInterestOnLoanAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "income from interest"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
}
|
|
}
|
|
},
|
|
"GetLoanOverpaymentLiabilityAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 11
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "over payment"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 13
|
|
}
|
|
}
|
|
},
|
|
"GetLoanPaymentChannelToFundSourceMappings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"paymentType": {
|
|
"$ref": "#/definitions/GetLoanPaymentType"
|
|
},
|
|
"fundSourceAccount": {
|
|
"$ref": "#/definitions/GetLoanFundSourceAccount"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanPaymentType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 10
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "check"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanPortfolioAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Loan portfolio"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsAccountingRule": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountingRuleType.cash"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "CASH BASED"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsAmortizationType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "amortizationType.equal.installments"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Equal installments"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"inMultiplesOf": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsInterestRateFrequencyType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "interestRateFrequency.periodFrequencyType.years"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Per year"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsInterestTemplateType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "interestType.declining.balance"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Declining Balance"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsParamType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "LoanProductParamType.principal"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "principal"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsPrincipalVariationsForBorrowerCycle": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 21
|
|
},
|
|
"borrowerCycleNumber": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"paramType": {
|
|
"$ref": "#/definitions/GetLoanProductsParamType"
|
|
},
|
|
"valueConditionType": {
|
|
"$ref": "#/definitions/GetLoanProductsValueConditionType"
|
|
},
|
|
"minValue": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 2000
|
|
},
|
|
"maxValue": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 20000
|
|
},
|
|
"defaultValue": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 15000
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsProductIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 11
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "advanced accounting"
|
|
},
|
|
"shortName": {
|
|
"type": "string",
|
|
"example": "ad11"
|
|
},
|
|
"includeInBorrowerCycle": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"useBorrowerCycle": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"example": "loanProduct.active"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetLoanProductsCurrency"
|
|
},
|
|
"principal": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 10000
|
|
},
|
|
"minPrincipal": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 2000
|
|
},
|
|
"maxPrincipal": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 15000
|
|
},
|
|
"numberOfRepayments": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 7
|
|
},
|
|
"repaymentEvery": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 7
|
|
},
|
|
"repaymentFrequencyType": {
|
|
"$ref": "#/definitions/GetLoanProductsRepaymentFrequencyType"
|
|
},
|
|
"interestRatePerPeriod": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 5
|
|
},
|
|
"interestRateFrequencyType": {
|
|
"$ref": "#/definitions/GetLoanProductsInterestRateFrequencyType"
|
|
},
|
|
"annualInterestRate": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 60
|
|
},
|
|
"amortizationType": {
|
|
"$ref": "#/definitions/GetLoanProductsAmortizationType"
|
|
},
|
|
"interestType": {
|
|
"$ref": "#/definitions/GetLoanProductsInterestTemplateType"
|
|
},
|
|
"interestCalculationPeriodType": {
|
|
"$ref": "#/definitions/GetLoansProductsInterestCalculationPeriodType"
|
|
},
|
|
"transactionProcessingStrategyId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"transactionProcessingStrategyName": {
|
|
"type": "string",
|
|
"example": "Mifos style"
|
|
},
|
|
"charges": {
|
|
"type": "array",
|
|
"example": "[]",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"productsPrincipalVariationsForBorrowerCycle": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoanProductsPrincipalVariationsForBorrowerCycle"
|
|
}
|
|
},
|
|
"interestRateVariationsForBorrowerCycle": {
|
|
"type": "array",
|
|
"example": "[]",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"numberOfRepaymentVariationsForBorrowerCycle": {
|
|
"type": "array",
|
|
"example": "[]",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"accountingRule": {
|
|
"$ref": "#/definitions/GetLoanProductsAccountingRule"
|
|
},
|
|
"accountingMappings": {
|
|
"$ref": "#/definitions/GetLoanAccountingMappings"
|
|
},
|
|
"paymentChannelToFundSourceMappings": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoanPaymentChannelToFundSourceMappings"
|
|
}
|
|
},
|
|
"feeToIncomeAccountMappings": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoanFeeToIncomeAccountMappings"
|
|
}
|
|
},
|
|
"multiDisburseLoan": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"maxTrancheCount": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"outstandingLoanBalance": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 36000
|
|
},
|
|
"overdueDaysForNPA": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"principalThresholdForLastInstalment": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 50
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsRepaymentFrequencyType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "repaymentFrequency.periodFrequencyType.days"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Days"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsValueConditionType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "LoanProductValueConditionType.equal"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "equals"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanTransfersInSuspenseAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "transfers"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
}
|
|
}
|
|
},
|
|
"GetLoanWriteOffAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 10
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "loans written off 2"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 12
|
|
}
|
|
}
|
|
},
|
|
"GetLoansProductsInterestCalculationPeriodType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "interestCalculationPeriodType.same.as.repayment.period"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Same as repayment period"
|
|
}
|
|
}
|
|
},
|
|
"PostLoanProductsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
}
|
|
}
|
|
},
|
|
"PostLoanProductsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "LP Accrual Accounting"
|
|
},
|
|
"shortName": {
|
|
"type": "string",
|
|
"example": "LPAA"
|
|
},
|
|
"currencyCode": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en_GB"
|
|
},
|
|
"digitsAfterDecimal": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"inMultiplesOf": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"principal": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": "100,000.00"
|
|
},
|
|
"numberOfRepayments": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 12
|
|
},
|
|
"repaymentEvery": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"repaymentFrequencyType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"transactionProcessingStrategyId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"interestRatePerPeriod": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 1.75
|
|
},
|
|
"interestRateFrequencyType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"amortizationType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"interestType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"interestCalculationPeriodType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"daysInMonthType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"daysInYearType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"isInterestRecalculationEnabled": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"accountingRule": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"fundSourceAccountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"loanPortfolioAccountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 8
|
|
},
|
|
"receivableInterestAccountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 9
|
|
},
|
|
"receivableFeeAccountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 11
|
|
},
|
|
"receivablePenaltyAccountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 10
|
|
},
|
|
"interestOnLoanAccountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 34
|
|
},
|
|
"incomeFromFeeAccountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 37
|
|
},
|
|
"incomeFromPenaltyAccountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 35
|
|
},
|
|
"overpaymentLiabilityAccountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"writeOffAccountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 41
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsInterestRecalculationCompoundingFrequencyType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "interestRecalculationFrequencyType.same.as.repayment.period"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Same as repayment period"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsInterestRecalculationCompoundingType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "interestRecalculationCompoundingMethod.fee"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Fee"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsInterestRecalculationData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"interestRecalculationCompoundingType": {
|
|
"$ref": "#/definitions/GetLoanProductsInterestRecalculationCompoundingType"
|
|
},
|
|
"interestRecalculationCompoundingFrequencyType": {
|
|
"$ref": "#/definitions/GetLoanProductsInterestRecalculationCompoundingFrequencyType"
|
|
},
|
|
"rescheduleStrategyType": {
|
|
"$ref": "#/definitions/GetLoanProductsRescheduleStrategyType"
|
|
},
|
|
"recalculationRestFrequencyType": {
|
|
"$ref": "#/definitions/GetLoanProductsInterestRecalculationCompoundingFrequencyType"
|
|
},
|
|
"preClosureInterestCalculationStrategy": {
|
|
"$ref": "#/definitions/GetLoanProductsPreClosureInterestCalculationStrategy"
|
|
},
|
|
"isArrearsBasedOnOriginalSchedule": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsInterestType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "interestType.flat"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Flat"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsPreClosureInterestCalculationStrategy": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "loanPreClosureInterestCalculationStrategy.tillPreClosureDate"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Till preclose Date"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsRescheduleStrategyType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "loanRescheduleStrategyMethod.reduce.number.of.installments"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Reduce number of installments"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "personal loan product"
|
|
},
|
|
"shortName": {
|
|
"type": "string",
|
|
"example": "pe1"
|
|
},
|
|
"includeInBorrowerCycle": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"useBorrowerCycle": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"startDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2013, 9, 2]"
|
|
},
|
|
"endDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2014, 2, 7]"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"example": "loanProduct.active"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetLoanProductsCurrency"
|
|
},
|
|
"principal": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 10000
|
|
},
|
|
"minPrincipal": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 5000
|
|
},
|
|
"maxPrincipal": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 15000
|
|
},
|
|
"numberOfRepayments": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 10
|
|
},
|
|
"minNumberOfRepayments": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 5
|
|
},
|
|
"maxNumberOfRepayments": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 15
|
|
},
|
|
"repaymentEvery": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 7
|
|
},
|
|
"repaymentFrequencyType": {
|
|
"$ref": "#/definitions/GetLoanProductsRepaymentFrequencyType"
|
|
},
|
|
"interestRatePerPeriod": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 15
|
|
},
|
|
"interestRateFrequencyType": {
|
|
"$ref": "#/definitions/GetLoanProductsInterestRateFrequencyType"
|
|
},
|
|
"annualInterestRate": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 15
|
|
},
|
|
"amortizationType": {
|
|
"$ref": "#/definitions/GetLoanProductsAmortizationType"
|
|
},
|
|
"interestType": {
|
|
"$ref": "#/definitions/GetLoanProductsInterestType"
|
|
},
|
|
"interestCalculationPeriodType": {
|
|
"$ref": "#/definitions/GetLoansProductsInterestCalculationPeriodType"
|
|
},
|
|
"transactionProcessingStrategyId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"transactionProcessingStrategyName": {
|
|
"type": "string",
|
|
"example": "Mifos style"
|
|
},
|
|
"principalVariationsForBorrowerCycle": {
|
|
"type": "array",
|
|
"example": "[]",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"interestRateVariationsForBorrowerCycle": {
|
|
"type": "array",
|
|
"example": "[]",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"numberOfRepaymentVariationsForBorrowerCycle": {
|
|
"type": "array",
|
|
"example": "[]",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"daysInMonthType": {
|
|
"$ref": "#/definitions/GetLoansProductsDaysInMonthType"
|
|
},
|
|
"daysInYearType": {
|
|
"$ref": "#/definitions/GetLoansProductsDaysInYearType"
|
|
},
|
|
"isInterestRecalculationEnabled": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"interestRecalculationData": {
|
|
"$ref": "#/definitions/GetLoanProductsInterestRecalculationData"
|
|
},
|
|
"accountingRule": {
|
|
"$ref": "#/definitions/GetLoanProductsAccountingRule"
|
|
},
|
|
"principalThresholdForLastInstalment": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
}
|
|
}
|
|
},
|
|
"GetLoansProductsDaysInMonthType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 30
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "DaysInMonthType.days360"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "30 Days"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansProductsDaysInYearType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 360
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "DaysInYearType.days360"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "360 Days"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsAccountingMappingOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"liabilityAccountOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoanProductsLiabilityAccountOptions"
|
|
}
|
|
},
|
|
"assetAccountOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoanProductsAssetAccountOptions"
|
|
}
|
|
},
|
|
"expenseAccountOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoanProductsExpenseAccountOptions"
|
|
}
|
|
},
|
|
"incomeAccountOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoanProductsIncomeAccountOptions"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsAssetAccountOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Loan portfolio"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"disabled": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"manualEntriesAllowed": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/GetLoanProductsLiabilityType"
|
|
},
|
|
"usage": {
|
|
"$ref": "#/definitions/GetLoanProductsLiabilityUsage"
|
|
},
|
|
"nameDecorated": {
|
|
"type": "string",
|
|
"example": "Loan portfolio"
|
|
},
|
|
"tagId": {
|
|
"$ref": "#/definitions/GetLoanProductsLiabilityTagId"
|
|
},
|
|
"organizationRunningBalance": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 60000
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsChargeAppliesTo": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": "1 "
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeAppliesTo.loan"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Loan"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsChargeOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 5
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "des charges"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"penalty": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetLoanProductsCurrencyOptions"
|
|
},
|
|
"amount": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 100
|
|
},
|
|
"chargeTimeType": {
|
|
"$ref": "#/definitions/GetLoanChargeTimeType"
|
|
},
|
|
"chargeAppliesTo": {
|
|
"$ref": "#/definitions/GetLoanProductsChargeAppliesTo"
|
|
},
|
|
"chargeCalculationType": {
|
|
"$ref": "#/definitions/GetLoanChargeCalculationType"
|
|
},
|
|
"chargePaymentMode": {
|
|
"$ref": "#/definitions/GetLoansChargePaymentMode"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsCurrencyOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsDaysInYearTemplateType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "DaysInYearType.actual"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Actual"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsExpenseAccountOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 10
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "loans written off 2"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 12
|
|
},
|
|
"disabled": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"manualEntriesAllowed": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/GetLoanProductsExpenseType"
|
|
},
|
|
"usage": {
|
|
"$ref": "#/definitions/GetLoanProductsLiabilityUsage"
|
|
},
|
|
"nameDecorated": {
|
|
"type": "string",
|
|
"example": "loans written off 2"
|
|
},
|
|
"tagId": {
|
|
"$ref": "#/definitions/GetLoanProductsLiabilityTagId"
|
|
},
|
|
"organizationRunningBalance": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsExpenseType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 5
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.expense"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "EXPENSE"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsIncomeAccountOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "income from interest"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"disabled": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"manualEntriesAllowed": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/GetLoanProductsIncomeType"
|
|
},
|
|
"usage": {
|
|
"$ref": "#/definitions/GetLoanProductsLiabilityUsage"
|
|
},
|
|
"nameDecorated": {
|
|
"type": "string",
|
|
"example": "income from interest"
|
|
},
|
|
"tagId": {
|
|
"$ref": "#/definitions/GetLoanProductsLiabilityTagId"
|
|
},
|
|
"organizationRunningBalance": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 19
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsIncomeType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.income"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "INCOME"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsInterestRateTemplateFrequencyType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "interestRateFrequency.periodFrequencyType.months"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Per month"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsInterestRecalculationTemplateData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"interestRecalculationCompoundingType": {
|
|
"$ref": "#/definitions/GetLoanProductsInterestRecalculationCompoundingType"
|
|
},
|
|
"rescheduleStrategyType": {
|
|
"$ref": "#/definitions/GetLoanProductsRescheduleStrategyType"
|
|
},
|
|
"preClosureInterestCalculationStrategy": {
|
|
"$ref": "#/definitions/GetLoanProductsPreClosureInterestCalculationStrategy"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsLiabilityAccountOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 11
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "over payment"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 13
|
|
},
|
|
"disabled": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"manualEntriesAllowed": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/GetLoanProductsLiabilityType"
|
|
},
|
|
"usage": {
|
|
"$ref": "#/definitions/GetLoanProductsLiabilityUsage"
|
|
},
|
|
"nameDecorated": {
|
|
"type": "string",
|
|
"example": "over payment"
|
|
},
|
|
"tagId": {
|
|
"$ref": "#/definitions/GetLoanProductsLiabilityTagId"
|
|
},
|
|
"organizationRunningBalance": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsLiabilityTagId": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsLiabilityType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.liability"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "LIABILITY"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsLiabilityUsage": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountUsage.detail"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "DETAIL"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsPaymentTypeOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 10
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "check"
|
|
},
|
|
"position": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsRepaymentTemplateFrequencyType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "repaymentFrequency.periodFrequencyType.months"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Months"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsTemplateCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"inMultiplesOf": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string"
|
|
},
|
|
"nameCode": {
|
|
"type": "string"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "[]"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"includeInBorrowerCycle": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"useBorrowerCycle": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetLoanProductsTemplateCurrency"
|
|
},
|
|
"repaymentFrequencyType": {
|
|
"$ref": "#/definitions/GetLoanProductsRepaymentTemplateFrequencyType"
|
|
},
|
|
"interestRateFrequencyType": {
|
|
"$ref": "#/definitions/GetLoanProductsInterestRateTemplateFrequencyType"
|
|
},
|
|
"amortizationType": {
|
|
"$ref": "#/definitions/GetLoanProductsAmortizationType"
|
|
},
|
|
"interestType": {
|
|
"$ref": "#/definitions/GetLoanProductsInterestTemplateType"
|
|
},
|
|
"interestCalculationPeriodType": {
|
|
"$ref": "#/definitions/GetLoansProductsInterestCalculationPeriodType"
|
|
},
|
|
"principalVariationsForBorrowerCycle": {
|
|
"type": "array",
|
|
"example": "[]",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"interestRateVariationsForBorrowerCycle": {
|
|
"type": "array",
|
|
"example": "[]",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"numberOfRepaymentVariationsForBorrowerCycle": {
|
|
"type": "array",
|
|
"example": "[]",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"accountingRule": {
|
|
"$ref": "#/definitions/GetLoanProductsAccountingRule"
|
|
},
|
|
"daysInMonthType": {
|
|
"$ref": "#/definitions/GetLoansProductsDaysInMonthTemplateType"
|
|
},
|
|
"daysInYearType": {
|
|
"$ref": "#/definitions/GetLoanProductsDaysInYearTemplateType"
|
|
},
|
|
"isInterestRecalculationEnabled": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"interestRecalculationData": {
|
|
"$ref": "#/definitions/GetLoanProductsInterestRecalculationTemplateData"
|
|
},
|
|
"paymentTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoanProductsPaymentTypeOptions"
|
|
}
|
|
},
|
|
"currencyOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoanProductsCurrencyOptions"
|
|
}
|
|
},
|
|
"repaymentFrequencyTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoanProductsRepaymentTemplateFrequencyType"
|
|
}
|
|
},
|
|
"preClosureInterestCalculationStrategyOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoanProductsPreClosureInterestCalculationStrategy"
|
|
}
|
|
},
|
|
"interestRateFrequencyTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoanProductsInterestRateTemplateFrequencyType"
|
|
}
|
|
},
|
|
"amortizationTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoanProductsAmortizationType"
|
|
}
|
|
},
|
|
"interestTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoanProductsInterestTemplateType"
|
|
}
|
|
},
|
|
"interestCalculationPeriodTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoansProductsInterestCalculationPeriodType"
|
|
}
|
|
},
|
|
"transactionProcessingStrategyOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoanProductsTransactionProcessingStrategyOptions"
|
|
}
|
|
},
|
|
"chargeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoanProductsChargeOptions"
|
|
}
|
|
},
|
|
"accountingRuleOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoanProductsAccountingRule"
|
|
}
|
|
},
|
|
"accountingMappingOptions": {
|
|
"$ref": "#/definitions/GetLoanProductsAccountingMappingOptions"
|
|
},
|
|
"valueConditionTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoanProductsValueConditionTypeOptions"
|
|
}
|
|
},
|
|
"daysInMonthTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoansProductsDaysInMonthTemplateType"
|
|
}
|
|
},
|
|
"daysInYearTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoanProductsInterestTemplateType"
|
|
}
|
|
},
|
|
"interestRecalculationCompoundingTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoanProductsInterestRecalculationCompoundingType"
|
|
}
|
|
},
|
|
"rescheduleStrategyTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoanProductsRescheduleStrategyType"
|
|
}
|
|
},
|
|
"interestRecalculationFrequencyTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetLoanProductsInterestRecalculationCompoundingFrequencyType"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsTransactionProcessingStrategyOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "mifos-standard-strategy"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Penalties, Fees, Interest, Principal order"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanProductsValueConditionTypeOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "mifos-standard-strategyLoanProductValueConditionType.equal"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "equals"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansChargePaymentMode": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargepaymentmode.regular"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Regular"
|
|
}
|
|
}
|
|
},
|
|
"GetLoansProductsDaysInMonthTemplateType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "DaysInMonthType.actual"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Actual"
|
|
}
|
|
}
|
|
},
|
|
"PutLoanChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"principal": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": "70,000.00"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en_GB"
|
|
}
|
|
}
|
|
},
|
|
"PutLoanProductsProductIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutLoanChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutLoanProductsProductIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en_GB"
|
|
},
|
|
"principal": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": "70,000.00"
|
|
}
|
|
}
|
|
},
|
|
"GetNotesNoteType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "noteType.client"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Client note"
|
|
}
|
|
}
|
|
},
|
|
"GetResourceTypeResourceIdNotesNoteIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 76
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"noteType": {
|
|
"$ref": "#/definitions/GetNotesNoteType"
|
|
},
|
|
"note": {
|
|
"type": "string",
|
|
"example": "a note about the client"
|
|
},
|
|
"createdById": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"createdByUsername": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"createdOn": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "1359463135000"
|
|
},
|
|
"updatedById": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"updatedByUsername": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"updatedOn": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "1359463135000"
|
|
}
|
|
}
|
|
},
|
|
"GetResourceTypeResourceIdNotesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"noteType": {
|
|
"$ref": "#/definitions/GetNotesNoteType"
|
|
},
|
|
"note": {
|
|
"type": "string",
|
|
"example": "First note edited"
|
|
},
|
|
"createdById": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"createdByUsername": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"createdOn": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "1342498505000"
|
|
},
|
|
"updatedById": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"updatedByUsername": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"updatedOn": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "1342498517000"
|
|
}
|
|
}
|
|
},
|
|
"PostResourceTypeResourceIdNotesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 76
|
|
}
|
|
}
|
|
},
|
|
"PostResourceTypeResourceIdNotesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"note": {
|
|
"type": "string",
|
|
"example": "a note about the client"
|
|
}
|
|
}
|
|
},
|
|
"PutNotesChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"note": {
|
|
"type": "string",
|
|
"example": "a note about the client"
|
|
}
|
|
}
|
|
},
|
|
"PutResourceTypeResourceIdNotesNoteIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 76
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutNotesChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutResourceTypeResourceIdNotesNoteIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"note": {
|
|
"type": "string",
|
|
"example": "a note about the client"
|
|
}
|
|
}
|
|
},
|
|
"DeleteResourceTypeResourceIdNotesNoteIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 76
|
|
}
|
|
}
|
|
},
|
|
"GetPaymentTypesPaymentTypeIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 13
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "cash"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "cash Payment"
|
|
},
|
|
"isCashPayment": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"position": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostPaymentTypesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostPaymentTypesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "cash"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "cash payment type"
|
|
},
|
|
"isCashPayment": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"position": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PutPaymentTypesPaymentTypeIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 13
|
|
}
|
|
}
|
|
},
|
|
"PutPaymentTypesPaymentTypeIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "mPay"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "not a cash payment type"
|
|
},
|
|
"isCashPayment": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"position": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
}
|
|
}
|
|
},
|
|
"DeletePaymentTypesPaymentTypeIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 13
|
|
}
|
|
}
|
|
},
|
|
"GetPaymentTypesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 24
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "PTC"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Cash"
|
|
},
|
|
"isCashPayment": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"position": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
}
|
|
}
|
|
},
|
|
"GetAssetType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.asset"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "ASSET"
|
|
}
|
|
}
|
|
},
|
|
"GetChargeAppliesTo": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeAppliesTo.shares"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Shares"
|
|
}
|
|
}
|
|
},
|
|
"GetChargeCalculationType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeCalculationType.flat"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Flat"
|
|
}
|
|
}
|
|
},
|
|
"GetChargePaymentMode": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargepaymentmode.regular"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Regular"
|
|
}
|
|
}
|
|
},
|
|
"GetChargeTimeType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 13
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeTimeType.activation"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Share Account Activate"
|
|
}
|
|
}
|
|
},
|
|
"GetChargesCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetEquityType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.equity"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "EQUITY"
|
|
}
|
|
}
|
|
},
|
|
"GetIncomeFromFeeAccountId": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 14
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "ACCOUNT_NAME_1FJBQ"
|
|
},
|
|
"glCode": {
|
|
"type": "string",
|
|
"example": "INCOME_OY1461237869836"
|
|
}
|
|
}
|
|
},
|
|
"GetIncomeType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.income"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "INCOME"
|
|
}
|
|
}
|
|
},
|
|
"GetLockPeriodTypeEnum": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Days"
|
|
}
|
|
}
|
|
},
|
|
"GetProductsAccountingMappingOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"liabilityAccountOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetProductsLiabilityAccountOptions"
|
|
}
|
|
},
|
|
"assetAccountOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetProductsAssetAccountOptions"
|
|
}
|
|
},
|
|
"incomeAccountOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetProductsIncomeAccountOptions"
|
|
}
|
|
},
|
|
"equityAccountOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetProductsEquityAccountOptions"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetProductsAccountingMappings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"shareReferenceId": {
|
|
"$ref": "#/definitions/GetShareReferenceId"
|
|
},
|
|
"incomeFromFeeAccountId": {
|
|
"$ref": "#/definitions/GetIncomeFromFeeAccountId"
|
|
},
|
|
"shareEquityId": {
|
|
"$ref": "#/definitions/GetShareEquityId"
|
|
},
|
|
"shareSuspenseId": {
|
|
"$ref": "#/definitions/GetShareSuspenseId"
|
|
}
|
|
}
|
|
},
|
|
"GetProductsAccountingRule": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountingRuleType.cash"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "CASH BASED"
|
|
}
|
|
}
|
|
},
|
|
"GetProductsAssetAccountOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "ACCOUNT_NAME_1FJBQ"
|
|
},
|
|
"glCode": {
|
|
"type": "string",
|
|
"example": "ASSET_ED1461237837829"
|
|
},
|
|
"disabled": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"manualEntriesAllowed": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/GetAssetType"
|
|
},
|
|
"usage": {
|
|
"$ref": "#/definitions/GetProductsLiabilityUsage"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "DEFAULT_DESCRIPTION"
|
|
},
|
|
"nameDecorated": {
|
|
"type": "string",
|
|
"example": "ACCOUNT_NAME_1FJBQ"
|
|
},
|
|
"tagId": {
|
|
"$ref": "#/definitions/GetProductsTagId"
|
|
}
|
|
}
|
|
},
|
|
"GetProductsCharges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 20
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Share Account Activation Flat"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"penalty": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetChargesCurrency"
|
|
},
|
|
"amount": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"chargeTimeType": {
|
|
"$ref": "#/definitions/GetChargeTimeType"
|
|
},
|
|
"chargeAppliesTo": {
|
|
"$ref": "#/definitions/GetChargeAppliesTo"
|
|
},
|
|
"chargeCalculationType": {
|
|
"$ref": "#/definitions/GetChargeCalculationType"
|
|
},
|
|
"chargePaymentMode": {
|
|
"$ref": "#/definitions/GetChargePaymentMode"
|
|
}
|
|
}
|
|
},
|
|
"GetProductsCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"inMultiplesOf": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetProductsEquityAccountOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 66
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Equity Account"
|
|
},
|
|
"glCode": {
|
|
"type": "string",
|
|
"example": "EQUITY1"
|
|
},
|
|
"disabled": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"manualEntriesAllowed": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/GetEquityType"
|
|
},
|
|
"usage": {
|
|
"$ref": "#/definitions/GetProductsLiabilityUsage"
|
|
},
|
|
"nameDecorated": {
|
|
"type": "string",
|
|
"example": "Equity Account"
|
|
},
|
|
"tagId": {
|
|
"$ref": "#/definitions/GetProductsTagId"
|
|
}
|
|
}
|
|
},
|
|
"GetProductsIncomeAccountOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "ACCOUNT_NAME_1FJBQ"
|
|
},
|
|
"glCode": {
|
|
"type": "string",
|
|
"example": "INCOME_9O1461237838422"
|
|
},
|
|
"disabled": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"manualEntriesAllowed": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/GetIncomeType"
|
|
},
|
|
"usage": {
|
|
"$ref": "#/definitions/GetProductsLiabilityUsage"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "DEFAULT_DESCRIPTION"
|
|
},
|
|
"nameDecorated": {
|
|
"type": "string",
|
|
"example": "ACCOUNT_NAME_1FJBQ"
|
|
},
|
|
"tagId": {
|
|
"$ref": "#/definitions/GetProductsTagId"
|
|
}
|
|
}
|
|
},
|
|
"GetProductsLiabilityAccountOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "ACCOUNT_NAME_1FJBQ"
|
|
},
|
|
"glCode": {
|
|
"type": "string",
|
|
"example": "LIABILITY_2T1461237838897"
|
|
},
|
|
"disabled": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"manualEntriesAllowed": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/GetProductsLiabilityType"
|
|
},
|
|
"usage": {
|
|
"$ref": "#/definitions/GetProductsLiabilityUsage"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "DEFAULT_DESCRIPTION"
|
|
},
|
|
"nameDecorated": {
|
|
"type": "string",
|
|
"example": "ACCOUNT_NAME_1FJBQ"
|
|
},
|
|
"tagId": {
|
|
"$ref": "#/definitions/GetProductsTagId"
|
|
}
|
|
}
|
|
},
|
|
"GetProductsLiabilityType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.liability"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "LIABILITY"
|
|
}
|
|
}
|
|
},
|
|
"GetProductsLiabilityUsage": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountUsage.detail"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "DETAIL"
|
|
}
|
|
}
|
|
},
|
|
"GetProductsMarketPrice": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"fromDate": {
|
|
"type": "string",
|
|
"example": "Feb 1, 2016"
|
|
},
|
|
"shareValue": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"GetProductsMinimumActivePeriodFrequencyTypeOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savings.lockin.sharePeriodFrequencyType.days"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Days"
|
|
}
|
|
}
|
|
},
|
|
"GetProductsTagId": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetProductsTypeProductIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Share Product"
|
|
},
|
|
"shortName": {
|
|
"type": "string",
|
|
"example": "SP"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "SP"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetProductsCurrency"
|
|
},
|
|
"totalShares": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"totalSharesIssued": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 50
|
|
},
|
|
"unitPrice": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"shareCapital": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 50
|
|
},
|
|
"minimumShares": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"nominalShares": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 10
|
|
},
|
|
"maximumShares": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 50
|
|
},
|
|
"marketPrice": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetProductsMarketPrice"
|
|
}
|
|
},
|
|
"charges": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetProductsCharges"
|
|
}
|
|
},
|
|
"allowDividendCalculationForInactiveClients": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"lockinPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"lockPeriodTypeEnum": {
|
|
"$ref": "#/definitions/GetLockPeriodTypeEnum"
|
|
},
|
|
"minimumActivePeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"minimumActivePeriodForDividendsTypeEnum": {
|
|
"$ref": "#/definitions/GetLockPeriodTypeEnum"
|
|
},
|
|
"accountingRule": {
|
|
"$ref": "#/definitions/GetProductsAccountingRule"
|
|
},
|
|
"accountingMappings": {
|
|
"$ref": "#/definitions/GetProductsAccountingMappings"
|
|
},
|
|
"currencyOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetChargesCurrency"
|
|
}
|
|
},
|
|
"chargeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetProductsCharges"
|
|
}
|
|
},
|
|
"minimumActivePeriodFrequencyTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetProductsMinimumActivePeriodFrequencyTypeOptions"
|
|
}
|
|
},
|
|
"lockinPeriodFrequencyTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetProductsMinimumActivePeriodFrequencyTypeOptions"
|
|
}
|
|
},
|
|
"accountingMappingOptions": {
|
|
"$ref": "#/definitions/GetProductsAccountingMappingOptions"
|
|
}
|
|
}
|
|
},
|
|
"GetShareEquityId": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 66
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Equity Account"
|
|
},
|
|
"glCode": {
|
|
"type": "string",
|
|
"example": "EQUITY1"
|
|
}
|
|
}
|
|
},
|
|
"GetShareReferenceId": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "ACCOUNT_NAME_1FJBQ"
|
|
},
|
|
"glCode": {
|
|
"type": "string",
|
|
"example": "ASSET_ED1461237837829"
|
|
}
|
|
}
|
|
},
|
|
"GetShareSuspenseId": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 8
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "ACCOUNT_NAME_1FJBQ"
|
|
},
|
|
"glCode": {
|
|
"type": "string",
|
|
"example": "LIABILITY_MA1461237860198"
|
|
}
|
|
}
|
|
},
|
|
"PostProductsTypeResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostProductsChargesSelected": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 20
|
|
}
|
|
}
|
|
},
|
|
"PostProductsMarketPricePeriods": {
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"fromDate": {
|
|
"type": "string",
|
|
"example": "04 May 2016"
|
|
},
|
|
"shareValue": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
}
|
|
}
|
|
},
|
|
"PostProductsTypeRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Share Product"
|
|
},
|
|
"shortName": {
|
|
"type": "string",
|
|
"example": "SP"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Description"
|
|
},
|
|
"currencyCode": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"digitsAfterDecimal": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"inMultiplesOf": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"totalShares": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1000
|
|
},
|
|
"sharesIssued": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1000
|
|
},
|
|
"unitPrice": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"minimumShares": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 10
|
|
},
|
|
"nominalShares": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 20
|
|
},
|
|
"maximumShares": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 30
|
|
},
|
|
"minimumActivePeriodForDividends": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"minimumactiveperiodFrequencyType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"lockinPeriodFrequency": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"lockinPeriodFrequencyType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"allowDividendCalculationForInactiveClients": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"marketPricePeriods": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/PostProductsMarketPricePeriods"
|
|
}
|
|
},
|
|
"chargesSelected": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/PostProductsChargesSelected"
|
|
}
|
|
},
|
|
"accountingRule": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"GetProductsPageItems": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Share Product"
|
|
},
|
|
"shortName": {
|
|
"type": "string",
|
|
"example": "Share Product Description"
|
|
},
|
|
"totalShares": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
}
|
|
}
|
|
},
|
|
"GetProductsTypeResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalFilteredRecords": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"pageItems": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetProductsPageItems"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PutProductsChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Share Product Description."
|
|
},
|
|
"unitPrice": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 5
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
}
|
|
}
|
|
},
|
|
"PutProductsTypeProductIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutProductsChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutProductsTypeProductIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Share Product Description."
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"unitPrice": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 5
|
|
}
|
|
}
|
|
},
|
|
"PostFixedDepositAccountsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"savingsId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostFixedDepositAccountsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"submittedOnDate": {
|
|
"type": "string",
|
|
"example": "01 March 2014"
|
|
},
|
|
"depositAmount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 5000
|
|
},
|
|
"depositPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 6
|
|
},
|
|
"depositPeriodFrequencyId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
}
|
|
}
|
|
},
|
|
"PostFixedDepositAccountsAccountIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"savingsId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostFixedDepositAccountsAccountIdRequest": {
|
|
"type": "object"
|
|
},
|
|
"GetFixedDepositAccountsProductOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Passbook Savings"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositAccountsTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientName": {
|
|
"type": "string",
|
|
"example": "small business"
|
|
},
|
|
"productOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsProductOptions"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositAccountsCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"inMultiplesOf": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositAccountsDepositPeriodFrequency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "deposit.period.savingsPeriodFrequencyType.months"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Months"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositAccountsInterestCalculationDaysInYearType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 365
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsInterestCalculationDaysInYearType.days365"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "365 Days"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositAccountsInterestCalculationType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsInterestCalculationType.dailybalance"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Daily Balance"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositAccountsInterestCompoundingPeriodType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savings.interest.period.savingsCompoundingInterestPeriodType.monthly"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Monthly"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositAccountsInterestPostingPeriodType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savings.interest.posting.period.savingsPostingInterestPeriodType.monthly"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Monthly"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositAccountsMaxDepositTermType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "deposit.term.savingsPeriodFrequencyType.years"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Years"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositAccountsMinDepositTermType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "deposit.term.savingsPeriodFrequencyType.months"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Months"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositAccountsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientName": {
|
|
"type": "string",
|
|
"example": "Sangamesh N"
|
|
},
|
|
"savingsProductId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"savingsProductName": {
|
|
"type": "string",
|
|
"example": "FD01"
|
|
},
|
|
"fieldOfficerId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsStatus"
|
|
},
|
|
"timeline": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsTimeline"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsCurrency"
|
|
},
|
|
"interestCompoundingPeriodType": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsInterestCompoundingPeriodType"
|
|
},
|
|
"interestPostingPeriodType": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsInterestPostingPeriodType"
|
|
},
|
|
"interestCalculationType": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsInterestCalculationType"
|
|
},
|
|
"interestCalculationDaysInYearType": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsInterestCalculationDaysInYearType"
|
|
},
|
|
"summary": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsSummary"
|
|
},
|
|
"interestFreePeriodApplicable": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"preClosurePenalApplicable": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"minDepositTerm": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"maxDepositTerm": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"minDepositTermType": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsMinDepositTermType"
|
|
},
|
|
"maxDepositTermType": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsMaxDepositTermType"
|
|
},
|
|
"depositAmount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 5000
|
|
},
|
|
"maturityAmount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 5140.25
|
|
},
|
|
"maturityDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2014, 9, 1]"
|
|
},
|
|
"depositPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 6
|
|
},
|
|
"depositPeriodFrequency": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsDepositPeriodFrequency"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositAccountsStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsAccountStatusType.submitted.and.pending.approval"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Submitted and pending approval"
|
|
},
|
|
"submittedAndPendingApproval": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"approved": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"rejected": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"withdrawnByApplicant": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closed": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"prematureClosed": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"transferInProgress": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"transferOnHold": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositAccountsSummary": {
|
|
"type": "object",
|
|
"properties": {
|
|
"currency": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsCurrency"
|
|
},
|
|
"accountBalance": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositAccountsTimeline": {
|
|
"type": "object",
|
|
"properties": {
|
|
"submittedOnDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2014, 3, 1]"
|
|
},
|
|
"submittedByUsername": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"submittedByFirstname": {
|
|
"type": "string",
|
|
"example": "App"
|
|
},
|
|
"submittedByLastname": {
|
|
"type": "string",
|
|
"example": "Administrator"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositAccountsAccountChart": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"fromDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2013, 10, 2]"
|
|
},
|
|
"accountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 5
|
|
},
|
|
"accountNumber": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": "FD000023"
|
|
},
|
|
"chartSlabs": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsChartSlabs"
|
|
}
|
|
},
|
|
"periodTypes": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsPeriodTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositAccountsAccountChartCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositAccountsAccountIdCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"inMultiplesOf": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositAccountsAccountIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": "FD000023"
|
|
},
|
|
"externalId": {
|
|
"type": "string",
|
|
"example": "FD-23"
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientName": {
|
|
"type": "string",
|
|
"example": "Sangamesh N"
|
|
},
|
|
"savingsProductId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"savingsProductName": {
|
|
"type": "string",
|
|
"example": "FD01"
|
|
},
|
|
"fieldOfficerId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsStatus"
|
|
},
|
|
"timeline": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsTimeline"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsAccountIdCurrency"
|
|
},
|
|
"interestCompoundingPeriodType": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsInterestCompoundingPeriodType"
|
|
},
|
|
"interestPostingPeriodType": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsInterestPostingPeriodType"
|
|
},
|
|
"interestCalculationType": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsInterestCalculationType"
|
|
},
|
|
"interestCalculationDaysInYearType": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsInterestCalculationDaysInYearType"
|
|
},
|
|
"interestFreePeriodApplicable": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"preClosurePenalApplicable": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"minDepositTerm": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"maxDepositTerm": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"minDepositTermType": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsMinDepositTermType"
|
|
},
|
|
"maxDepositTermType": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsMaxDepositTermType"
|
|
},
|
|
"depositAmount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 5000
|
|
},
|
|
"maturityAmount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 5140.25
|
|
},
|
|
"maturityDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2014, 9, 1]"
|
|
},
|
|
"depositPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 6
|
|
},
|
|
"depositPeriodFrequency": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsDepositPeriodFrequency"
|
|
},
|
|
"summary": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsAccountIdSummary"
|
|
},
|
|
"accountChart": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsAccountChart"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositAccountsAccountIdSummary": {
|
|
"type": "object",
|
|
"properties": {
|
|
"currency": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsAccountIdCurrency"
|
|
},
|
|
"accountBalance": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositAccountsChartSlabs": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 13
|
|
},
|
|
"periodType": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsPeriodType"
|
|
},
|
|
"fromPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 181
|
|
},
|
|
"toPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 365
|
|
},
|
|
"annualInterestRate": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 5.5
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetFixedDepositAccountsAccountChartCurrency"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositAccountsPeriodType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "interestChartPeriodType.days"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Days"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositAccountsPeriodTypes": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "interestChartPeriodType.days"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Days"
|
|
}
|
|
}
|
|
},
|
|
"PutFixedDepositAccountsAccountIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"savingsId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutFixedDepositAccountsChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutFixedDepositAccountsChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"depositAmount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 6000
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
}
|
|
}
|
|
},
|
|
"PutFixedDepositAccountsAccountIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"depositAmount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 6000
|
|
}
|
|
}
|
|
},
|
|
"DeleteFixedDepositAccountsAccountIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsAccountingRule": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountingRuleType.none"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "NONE"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"inMultiplesOf": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsInterestCalculationDaysInYearType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 365
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsInterestCalculationDaysInYearType.days365"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "365 Days"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsInterestCalculationType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsInterestCalculationType.dailybalance"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Daily Balance"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsInterestCompoundingPeriodType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savings.interest.period.savingsCompoundingInterestPeriodType.monthly"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Monthly"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsInterestPostingPeriodType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savings.interest.posting.period.savingsPostingInterestPeriodType.monthly"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Monthly"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsMaxDepositTermType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "deposit.term.savingsPeriodFrequencyType.years"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Years"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsMinDepositTermType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "deposit.term.savingsPeriodFrequencyType.months"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Months"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "FD01"
|
|
},
|
|
"shortName": {
|
|
"type": "string",
|
|
"example": "FD01"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "FD01"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsCurrency"
|
|
},
|
|
"preClosurePenalApplicable": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"minDepositTerm": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"maxDepositTerm": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"minDepositTermType": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsMinDepositTermType"
|
|
},
|
|
"maxDepositTermType": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsMaxDepositTermType"
|
|
},
|
|
"nominalAnnualInterestRate": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 0
|
|
},
|
|
"interestCompoundingPeriodType": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsInterestCompoundingPeriodType"
|
|
},
|
|
"interestPostingPeriodType": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsInterestPostingPeriodType"
|
|
},
|
|
"interestCalculationType": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsInterestCalculationType"
|
|
},
|
|
"interestCalculationDaysInYearType": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsInterestCalculationDaysInYearType"
|
|
},
|
|
"accountingRule": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsAccountingRule"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsProductIdAccountingMappings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"savingsReferenceAccount": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsProductIdSavingsReferenceAccount"
|
|
},
|
|
"incomeFromFeeAccount": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsProductIdIncomeFromFeeAccount"
|
|
},
|
|
"incomeFromPenaltyAccount": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsProductIdIncomeFromPenaltyAccount"
|
|
},
|
|
"interestOnSavingsAccount": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsProductIdInterestOnSavingsAccount"
|
|
},
|
|
"savingsControlAccount": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsProductIdSavingsControlAccount"
|
|
},
|
|
"transfersInSuspenseAccount": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsProductIdTransfersInSuspenseAccount"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsProductIdActiveChart": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 8
|
|
},
|
|
"fromDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2014, 1, 1]"
|
|
},
|
|
"savingsProductId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 8
|
|
},
|
|
"savingsProductName": {
|
|
"type": "string",
|
|
"example": "Fixed deposit product"
|
|
},
|
|
"chartSlabs": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsProductIdChartSlabs"
|
|
}
|
|
},
|
|
"periodTypes": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsProductIdPeriodType"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsProductIdChartSlabs": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 18
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "from 0 to 90 days"
|
|
},
|
|
"periodType": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsProductIdPeriodType"
|
|
},
|
|
"fromPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"toPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 90
|
|
},
|
|
"annualInterestRate": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 4.5
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsProductIdCurrency"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsProductIdCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsProductIdFeeToIncomeAccountMappings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"charge": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsProductIdFeeToIncomeAccountMappingsCharge"
|
|
},
|
|
"incomeAccount": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsProductIdFeeToIncomeAccountMappingsIncomeAccount"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsProductIdFeeToIncomeAccountMappingsCharge": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 11
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "sav charge"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"penalty": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsProductIdFeeToIncomeAccountMappingsIncomeAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 16
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "income from savings fee"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 24
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsProductIdIncomeFromFeeAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 16
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "income from savings fee"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 24
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsProductIdIncomeFromPenaltyAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 17
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "income from sav penalties"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 25
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsProductIdInterestCompoundingPeriodType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savings.interest.period.savingsCompoundingInterestPeriodType.daily"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Daily"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsProductIdInterestOnSavingsAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 15
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "interest on savings"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 23
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsProductIdMaxDepositTermType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "deposit.term.savingsPeriodFrequencyType.years"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Years"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsProductIdMinDepositTermType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "deposit.term.savingsPeriodFrequencyType.weeks"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Weeks"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsProductIdPenaltyToIncomeAccountMappings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"charge": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsProductIdPenaltyToIncomeAccountMappingsCharge"
|
|
},
|
|
"incomeAccount": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsProductIdIncomeFromPenaltyAccount"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsProductIdPenaltyToIncomeAccountMappingsCharge": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 12
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "sav 2"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"penalty": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsProductIdPeriodType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "interestChartPeriodType.weeks"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Weeks"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsProductIdPreClosurePenalInterestOnType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "preClosurePenalInterestOnType.wholeTerm"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Whole term"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsProductIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Fixed deposit product"
|
|
},
|
|
"shortName": {
|
|
"type": "string",
|
|
"example": "FD01"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Daily compounding using Daily Balance, 5% per year, 365 days in year"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsProductIdCurrency"
|
|
},
|
|
"interestCompoundingPeriodType": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsProductIdInterestCompoundingPeriodType"
|
|
},
|
|
"interestPostingPeriodType": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsInterestPostingPeriodType"
|
|
},
|
|
"interestCalculationType": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsInterestCalculationType"
|
|
},
|
|
"interestCalculationDaysInYearType": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsInterestCalculationDaysInYearType"
|
|
},
|
|
"accountingMappings": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsProductIdAccountingMappings"
|
|
},
|
|
"feeToIncomeAccountMappings": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsProductIdFeeToIncomeAccountMappings"
|
|
}
|
|
},
|
|
"penaltyToIncomeAccountMappings": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsProductIdPenaltyToIncomeAccountMappings"
|
|
}
|
|
},
|
|
"preClosurePenalApplicable": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"preClosurePenalInterest": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 1.75
|
|
},
|
|
"preClosurePenalInterestOnType": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsProductIdPreClosurePenalInterestOnType"
|
|
},
|
|
"minDepositTerm": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"minDepositTermType": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsProductIdMinDepositTermType"
|
|
},
|
|
"maxDepositTerm": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 5
|
|
},
|
|
"maxDepositTermType": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsProductIdMaxDepositTermType"
|
|
},
|
|
"activeChart": {
|
|
"$ref": "#/definitions/GetFixedDepositProductsProductIdActiveChart"
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsProductIdSavingsControlAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 13
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "savings ref tool kit"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 21
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsProductIdSavingsReferenceAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 12
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "savings ref"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 20
|
|
}
|
|
}
|
|
},
|
|
"GetFixedDepositProductsProductIdTransfersInSuspenseAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 14
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "saving transfers"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 22
|
|
}
|
|
}
|
|
},
|
|
"PutFixedDepositProductsChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Fixed deposit product new offerings"
|
|
},
|
|
"minDepositTerm": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 5
|
|
}
|
|
}
|
|
},
|
|
"PutFixedDepositProductsProductIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutFixedDepositProductsChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutFixedDepositProductsProductIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Fixed deposit product new offerings"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"minDepositTerm": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 5
|
|
},
|
|
"minDepositTermTypeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"DeleteFixedDepositProductsProductIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostFixedDepositProductsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostFixedDepositProductsChartSlabs": {
|
|
"type": "object",
|
|
"properties": {
|
|
"description": {
|
|
"type": "string",
|
|
"example": "from 0 to 90 days"
|
|
},
|
|
"periodType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"fromPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"toPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 90
|
|
},
|
|
"annualInterestRate": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 4.5
|
|
}
|
|
}
|
|
},
|
|
"PostFixedDepositProductsCharts": {
|
|
"type": "object",
|
|
"properties": {
|
|
"fromDate": {
|
|
"type": "string",
|
|
"example": "01 Jan 2014"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"chartSlabs": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/PostFixedDepositProductsChartSlabs"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PostFixedDepositProductsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Fixed deposit product"
|
|
},
|
|
"shortName": {
|
|
"type": "string",
|
|
"example": "FD01"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Daily compounding using Daily Balance, 5% per year, 365 days in year"
|
|
},
|
|
"currencyCode": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"digitsAfterDecimal": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"inMultiplesOf": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"interestCompoundingPeriodType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"interestPostingPeriodType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"interestCalculationType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"interestCalculationDaysInYearType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 365
|
|
},
|
|
"accountingRule": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"preClosurePenalApplicable": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"preClosurePenalInterest": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 1.75
|
|
},
|
|
"preClosurePenalInterestOnTypeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"minDepositTerm": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"minDepositTermTypeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"maxDepositTerm": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 5
|
|
},
|
|
"maxDepositTermTypeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"charts": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/PostFixedDepositProductsCharts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PostRecurringChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"accountNumber": {
|
|
"type": "string",
|
|
"example": "acc123"
|
|
},
|
|
"checkNumber": {
|
|
"type": "string",
|
|
"example": "che123"
|
|
},
|
|
"routingCode": {
|
|
"type": "string",
|
|
"example": "rou123"
|
|
},
|
|
"receiptNumber": {
|
|
"type": "string",
|
|
"example": "rec123"
|
|
},
|
|
"bankNumber": {
|
|
"type": "string",
|
|
"example": "ban123"
|
|
}
|
|
}
|
|
},
|
|
"PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsTransactionIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"savingsId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 48
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PostRecurringChanges"
|
|
}
|
|
}
|
|
},
|
|
"PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"transactionDate": {
|
|
"type": "string",
|
|
"example": "27 May 2013"
|
|
},
|
|
"transactionAmount": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 500
|
|
},
|
|
"paymentTypeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 14
|
|
},
|
|
"accountNumber": {
|
|
"type": "string",
|
|
"example": "acc123"
|
|
},
|
|
"checkNumber": {
|
|
"type": "string",
|
|
"example": "che123"
|
|
},
|
|
"routingCode": {
|
|
"type": "string",
|
|
"example": "rou123"
|
|
},
|
|
"receiptNumber": {
|
|
"type": "string",
|
|
"example": "rec123"
|
|
},
|
|
"bankNumber": {
|
|
"type": "string",
|
|
"example": "ban123"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"inMultiplesOf": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositAccountsRecurringDepositAccountIdTransactionsTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"transactionType": {
|
|
"$ref": "#/definitions/GetRecurringTransactionType"
|
|
},
|
|
"accountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"accountNo": {
|
|
"type": "string",
|
|
"example": "000000001"
|
|
},
|
|
"date": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2014, 6, 25]"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetRecurringCurrency"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"example": 100000
|
|
},
|
|
"reversed": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"paymentTypeOptions": {
|
|
"type": "array",
|
|
"example": "[]",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringTransactionType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsAccountTransactionType.deposit"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Deposit"
|
|
},
|
|
"deposit": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"withdrawal": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"interestPosting": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"feeDeduction": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"initiateTransfer": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"approveTransfer": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"withdrawTransfer": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"rejectTransfer": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"overdraftInterest": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"writtenoff": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"overdraftFee": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
}
|
|
},
|
|
"PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"savingsId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 47
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PostRecurringChanges"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositAccountsRecurringDepositAccountIdTransactionsTransactionIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"transactionType": {
|
|
"$ref": "#/definitions/GetRecurringTransactionsTransactionType"
|
|
},
|
|
"accountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"accountNo": {
|
|
"type": "string",
|
|
"example": "000000001"
|
|
},
|
|
"date": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2013, 8, 7]"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetRecurringTransactionsCurrency"
|
|
},
|
|
"paymentDetailData": {
|
|
"$ref": "#/definitions/GetRecurringPaymentDetailData"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 5000
|
|
},
|
|
"runningBalance": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"reversed": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringPaymentDetailData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 62
|
|
},
|
|
"paymentType": {
|
|
"$ref": "#/definitions/GetRecurringPaymentType"
|
|
},
|
|
"accountNumber": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"checkNumber": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"routingCode": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"receiptNumber": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"bankNumber": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringPaymentType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 11
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "cash"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringTransactionsCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"inMultiplesOf": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringTransactionsTransactionType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsAccountTransactionType.withdrawal"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Withdrawal"
|
|
},
|
|
"deposit": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"withdrawal": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"interestPosting": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"feeDeduction": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"PostRecurringDepositAccountsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"savingsId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostRecurringDepositAccountsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"submittedOnDate": {
|
|
"type": "string",
|
|
"example": "02 June 2014"
|
|
},
|
|
"depositPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 20
|
|
},
|
|
"depositPeriodFrequencyId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"depositAmount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 10000
|
|
},
|
|
"isCalendarInherited": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"recurringFrequency": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"recurringFrequencyType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"mandatoryRecommendedDepositAmount": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 2000
|
|
}
|
|
}
|
|
},
|
|
"PostRecurringDepositAccountsAccountIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"savingsId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostRecurringDepositAccountsAccountIdRequest": {
|
|
"type": "object"
|
|
},
|
|
"GetRecurringDepositAccountsTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientName": {
|
|
"type": "string",
|
|
"example": "small business"
|
|
},
|
|
"productOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetRecurringProductOptions"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringProductOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Passbook Savings"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositAccountsCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"inMultiplesOf": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositAccountsDepositPeriodFrequency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "deposit.period.savingsPeriodFrequencyType.months"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Months"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositAccountsInterestCalculationDaysInYearType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 365
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsInterestCalculationDaysInYearType.days365"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "365 Days"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositAccountsInterestCalculationType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsInterestCalculationType.dailybalance"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Daily Balance"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositAccountsInterestCompoundingPeriodType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savings.interest.period.savingsCompoundingInterestPeriodType.monthly"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Monthly"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositAccountsInterestPostingPeriodType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savings.interest.posting.period.savingsPostingInterestPeriodType.monthly"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Monthly"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositAccountsMaxDepositTermType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "deposit.term.savingsPeriodFrequencyType.years"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Years"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositAccountsMinDepositTermType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "deposit.term.savingsPeriodFrequencyType.months"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Months"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositAccountsRecurringDepositFrequencyType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "recurring.deposit.savingsPeriodFrequencyType.months"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Months"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositAccountsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientName": {
|
|
"type": "string",
|
|
"example": "Sangamesh N"
|
|
},
|
|
"savingsProductId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"savingsProductName": {
|
|
"type": "string",
|
|
"example": "RD01"
|
|
},
|
|
"fieldOfficerId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsStatus"
|
|
},
|
|
"timeline": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsTimeline"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsCurrency"
|
|
},
|
|
"interestCompoundingPeriodType": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsInterestCompoundingPeriodType"
|
|
},
|
|
"interestPostingPeriodType": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsInterestPostingPeriodType"
|
|
},
|
|
"interestCalculationType": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsInterestCalculationType"
|
|
},
|
|
"interestCalculationDaysInYearType": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsInterestCalculationDaysInYearType"
|
|
},
|
|
"summary": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsSummary"
|
|
},
|
|
"depositAmount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 1150
|
|
},
|
|
"maturityAmount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 252.59
|
|
},
|
|
"maturityDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2014, 4, 3]"
|
|
},
|
|
"recurringDepositAmount": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"recurringDepositFrequency": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"recurringDepositFrequencyType": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsRecurringDepositFrequencyType"
|
|
},
|
|
"preClosurePenalApplicable": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"minDepositTerm": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"maxDepositTerm": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"minDepositTermType": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsMinDepositTermType"
|
|
},
|
|
"maxDepositTermType": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsMaxDepositTermType"
|
|
},
|
|
"depositPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 6
|
|
},
|
|
"depositPeriodFrequency": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsDepositPeriodFrequency"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositAccountsStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsAccountStatusType.submitted.and.pending.approval"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Submitted and pending approval"
|
|
},
|
|
"submittedAndPendingApproval": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"approved": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"rejected": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"withdrawnByApplicant": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closed": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"prematureClosed": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"transferInProgress": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"transferOnHold": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositAccountsSummary": {
|
|
"type": "object",
|
|
"properties": {
|
|
"currency": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsCurrency"
|
|
},
|
|
"accountBalance": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositAccountsTimeline": {
|
|
"type": "object",
|
|
"properties": {
|
|
"submittedOnDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2014, 3, 1]"
|
|
},
|
|
"submittedByUsername": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"submittedByFirstname": {
|
|
"type": "string",
|
|
"example": "App"
|
|
},
|
|
"submittedByLastname": {
|
|
"type": "string",
|
|
"example": "Administrator"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositAccountsAccountChart": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"fromDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2013, 10, 2]"
|
|
},
|
|
"accountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 5
|
|
},
|
|
"accountNumber": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": "RD000023"
|
|
},
|
|
"chartSlabs": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsChartSlabs"
|
|
}
|
|
},
|
|
"periodTypes": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsPeriodTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositAccountsAccountChartCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositAccountsAccountIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": "RD000023"
|
|
},
|
|
"externalId": {
|
|
"type": "string",
|
|
"example": "RD-23"
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientName": {
|
|
"type": "string",
|
|
"example": "Sangamesh N"
|
|
},
|
|
"savingsProductId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"savingsProductName": {
|
|
"type": "string",
|
|
"example": "RD01"
|
|
},
|
|
"fieldOfficerId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsStatus"
|
|
},
|
|
"timeline": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsTimeline"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsCurrency"
|
|
},
|
|
"interestCompoundingPeriodType": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsInterestCompoundingPeriodType"
|
|
},
|
|
"interestPostingPeriodType": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsInterestPostingPeriodType"
|
|
},
|
|
"interestCalculationType": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsInterestCalculationType"
|
|
},
|
|
"interestCalculationDaysInYearType": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsInterestCalculationDaysInYearType"
|
|
},
|
|
"preClosurePenalApplicable": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"minDepositTerm": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"maxDepositTerm": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"minDepositTermType": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsMinDepositTermType"
|
|
},
|
|
"maxDepositTermType": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsMaxDepositTermType"
|
|
},
|
|
"recurringDepositAmount": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"recurringDepositFrequency": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"expectedFirstDepositOnDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2014, 4, 2]"
|
|
},
|
|
"recurringDepositFrequencyType": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsRecurringDepositFrequencyType"
|
|
},
|
|
"depositPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 6
|
|
},
|
|
"depositPeriodFrequency": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsDepositPeriodFrequency"
|
|
},
|
|
"summary": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsSummary"
|
|
},
|
|
"accountChart": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsAccountChart"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositAccountsChartSlabs": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 13
|
|
},
|
|
"periodType": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsPeriodType"
|
|
},
|
|
"fromPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 181
|
|
},
|
|
"toPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 365
|
|
},
|
|
"annualInterestRate": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 5.5
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetRecurringDepositAccountsAccountChartCurrency"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositAccountsPeriodType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "interestChartPeriodType.days"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Days"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositAccountsPeriodTypes": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "interestChartPeriodType.days"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Days"
|
|
}
|
|
}
|
|
},
|
|
"PutRecurringDepositAccountsAccountIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"savingsId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutRecurringDepositAccountsChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutRecurringDepositAccountsChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"depositAmount": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 6000
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
}
|
|
}
|
|
},
|
|
"PutRecurringDepositAccountsAccountIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"depositAmount": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 6000
|
|
}
|
|
}
|
|
},
|
|
"DeleteRecurringDepositAccountsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsAccountingRule": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountingRuleType.none"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "NONE"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"inMultiplesOf": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsInterestCalculationDaysInYearType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 365
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsInterestCalculationDaysInYearType.days365"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "365 Days"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsInterestCalculationType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsInterestCalculationType.dailybalance"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Daily Balance"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsInterestCompoundingPeriodType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savings.interest.period.savingsCompoundingInterestPeriodType.monthly"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Monthly"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsInterestPostingPeriodType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savings.interest.posting.period.savingsPostingInterestPeriodType.monthly"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Monthly"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsMaxDepositTermType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "deposit.term.savingsPeriodFrequencyType.years"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Years"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsMinDepositTermType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "deposit.term.savingsPeriodFrequencyType.months"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Months"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsRecurringDepositFrequencyType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "recurring.deposit.savingsPeriodFrequencyType.months"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Months"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "RD01"
|
|
},
|
|
"shortName": {
|
|
"type": "string",
|
|
"example": "RD01"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "RD01"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsCurrency"
|
|
},
|
|
"recurringDepositFrequency": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"recurringDepositFrequencyType": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsRecurringDepositFrequencyType"
|
|
},
|
|
"preClosurePenalApplicable": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"minDepositTerm": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"maxDepositTerm": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"minDepositTermType": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsMinDepositTermType"
|
|
},
|
|
"maxDepositTermType": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsMaxDepositTermType"
|
|
},
|
|
"nominalAnnualInterestRate": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 0
|
|
},
|
|
"interestCompoundingPeriodType": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsInterestCompoundingPeriodType"
|
|
},
|
|
"interestPostingPeriodType": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsInterestPostingPeriodType"
|
|
},
|
|
"interestCalculationType": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsInterestCalculationType"
|
|
},
|
|
"interestCalculationDaysInYearType": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsInterestCalculationDaysInYearType"
|
|
},
|
|
"accountingRule": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsAccountingRule"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsProductIdAccountingMappings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"savingsReferenceAccount": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsProductIdSavingsReferenceAccount"
|
|
},
|
|
"incomeFromFeeAccount": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsProductIdIncomeFromFeeAccount"
|
|
},
|
|
"incomeFromPenaltyAccount": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsProductIdIncomeFromPenaltyAccount"
|
|
},
|
|
"interestOnSavingsAccount": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsProductIdInterestOnSavingsAccount"
|
|
},
|
|
"savingsControlAccount": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsProductIdSavingsControlAccount"
|
|
},
|
|
"transfersInSuspenseAccount": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsProductIdTransfersInSuspenseAccount"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsProductIdActiveChart": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 8
|
|
},
|
|
"fromDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2014, 1, 1]"
|
|
},
|
|
"savingsProductId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 8
|
|
},
|
|
"savingsProductName": {
|
|
"type": "string",
|
|
"example": "Recurring deposit product"
|
|
},
|
|
"chartSlabs": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsProductIdChartSlabs"
|
|
}
|
|
},
|
|
"periodTypes": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsProductIdPeriodType"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsProductIdChartSlabs": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 18
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "from 0 to 90 days"
|
|
},
|
|
"periodType": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsProductIdPeriodType"
|
|
},
|
|
"fromPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"toPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 90
|
|
},
|
|
"annualInterestRate": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 4.5
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsProductIdCurrency"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsProductIdCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsProductIdFeeToIncomeAccountMappings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"charge": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsProductIdFeeToIncomeAccountMappingsCharge"
|
|
},
|
|
"incomeAccount": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsProductIdFeeToIncomeAccountMappingsIncomeAccount"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsProductIdFeeToIncomeAccountMappingsCharge": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 11
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "sav charge"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"penalty": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsProductIdFeeToIncomeAccountMappingsIncomeAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 16
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "income from savings fee"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 24
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsProductIdIncomeFromFeeAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 16
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "income from savings fee"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 24
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsProductIdIncomeFromPenaltyAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 17
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "income from sav penalties"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 25
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsProductIdInterestCompoundingPeriodType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savings.interest.period.savingsCompoundingInterestPeriodType.daily"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Daily"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsProductIdInterestOnSavingsAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 15
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "interest on savings"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 23
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsProductIdMaxDepositTermType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "deposit.term.savingsPeriodFrequencyType.years"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Years"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsProductIdMinDepositTermType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "deposit.term.savingsPeriodFrequencyType.weeks"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Weeks"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsProductIdPenaltyToIncomeAccountMappings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"charge": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsProductIdPenaltyToIncomeAccountMappingsCharge"
|
|
},
|
|
"incomeAccount": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsProductIdIncomeFromPenaltyAccount"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsProductIdPenaltyToIncomeAccountMappingsCharge": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 12
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "sav 2"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"penalty": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsProductIdPeriodType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "interestChartPeriodType.weeks"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Weeks"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsProductIdPreClosurePenalInterestOnType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "preClosurePenalInterestOnType.wholeTerm"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Whole term"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsProductIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Recurring deposit product"
|
|
},
|
|
"shortName": {
|
|
"type": "string",
|
|
"example": "RD01"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Daily compounding using Daily Balance, 5% per year, 365 days in year"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsProductIdCurrency"
|
|
},
|
|
"interestCompoundingPeriodType": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsProductIdInterestCompoundingPeriodType"
|
|
},
|
|
"interestPostingPeriodType": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsInterestPostingPeriodType"
|
|
},
|
|
"interestCalculationType": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsInterestCalculationType"
|
|
},
|
|
"interestCalculationDaysInYearType": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsInterestCalculationDaysInYearType"
|
|
},
|
|
"accountingMappings": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsProductIdAccountingMappings"
|
|
},
|
|
"feeToIncomeAccountMappings": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsProductIdFeeToIncomeAccountMappings"
|
|
}
|
|
},
|
|
"penaltyToIncomeAccountMappings": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsProductIdPenaltyToIncomeAccountMappings"
|
|
}
|
|
},
|
|
"recurringDepositFrequency": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"recurringDepositFrequencyType": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsRecurringDepositFrequencyType"
|
|
},
|
|
"preClosurePenalApplicable": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"preClosurePenalInterest": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 1.75
|
|
},
|
|
"preClosurePenalInterestOnType": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsProductIdPreClosurePenalInterestOnType"
|
|
},
|
|
"minDepositTerm": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"minDepositTermType": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsProductIdMinDepositTermType"
|
|
},
|
|
"maxDepositTerm": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 5
|
|
},
|
|
"maxDepositTermType": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsProductIdMaxDepositTermType"
|
|
},
|
|
"activeChart": {
|
|
"$ref": "#/definitions/GetRecurringDepositProductsProductIdActiveChart"
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsProductIdSavingsControlAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 13
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "savings ref tool kit"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 21
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsProductIdSavingsReferenceAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 12
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "savings ref"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 20
|
|
}
|
|
}
|
|
},
|
|
"GetRecurringDepositProductsProductIdTransfersInSuspenseAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 14
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "saving transfers"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 22
|
|
}
|
|
}
|
|
},
|
|
"PutRecurringDepositProductsChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Recurring deposit product new offerings"
|
|
},
|
|
"minDepositTerm": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 5
|
|
}
|
|
}
|
|
},
|
|
"PutRecurringDepositProductsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutRecurringDepositProductsChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutRecurringDepositProductsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Recurring deposit product new offerings"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"minDepositTerm": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 5
|
|
},
|
|
"minDepositTermTypeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"DeleteRecurringDepositProductsProductIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostRecurringDepositProductsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostRecurringDepositProductsChartSlabs": {
|
|
"type": "object",
|
|
"properties": {
|
|
"description": {
|
|
"type": "string",
|
|
"example": "from 0 to 90 days"
|
|
},
|
|
"periodType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"fromPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"toPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 90
|
|
},
|
|
"annualInterestRate": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 4.5
|
|
}
|
|
}
|
|
},
|
|
"PostRecurringDepositProductsCharts": {
|
|
"type": "object",
|
|
"properties": {
|
|
"fromDate": {
|
|
"type": "string",
|
|
"example": "01 Jan 2014"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"chartSlabs": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/PostRecurringDepositProductsChartSlabs"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PostRecurringDepositProductsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Recurring deposit product"
|
|
},
|
|
"shortName": {
|
|
"type": "string",
|
|
"example": "RD01"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Daily compounding using Daily Balance, 5% per year, 365 days in year"
|
|
},
|
|
"currencyCode": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"digitsAfterDecimal": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"inMultiplesOf": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"interestCompoundingPeriodType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"interestPostingPeriodType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"interestCalculationType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"interestCalculationDaysInYearType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 365
|
|
},
|
|
"accountingRule": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"recurringDepositFrequency": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"recurringDepositFrequencyTypeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"preClosurePenalApplicable": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"preClosurePenalInterest": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 1.75
|
|
},
|
|
"preClosurePenalInterestOnTypeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"minDepositTerm": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"minDepositTermTypeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"maxDepositTerm": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 5
|
|
},
|
|
"maxDepositTermTypeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"depositAmount": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 10000
|
|
},
|
|
"minDepositAmount": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 100
|
|
},
|
|
"maxDepositAmount": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1000000
|
|
},
|
|
"charts": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/PostRecurringDepositProductsCharts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetChargesChargeCalculationType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeCalculationType.flat"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Flat"
|
|
}
|
|
}
|
|
},
|
|
"GetChargesChargeTimeType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeTimeType.specifiedDueDate"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Specified due date"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsAccountsSavingsAccountIdChargesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"chargeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"accountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 57
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Savings account maintenance fee"
|
|
},
|
|
"chargeTimeType": {
|
|
"$ref": "#/definitions/GetChargesChargeTimeType"
|
|
},
|
|
"chargeCalculationType": {
|
|
"$ref": "#/definitions/GetChargesChargeCalculationType"
|
|
},
|
|
"percentage": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 0
|
|
},
|
|
"amountPercentageAppliedTo": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 0
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetChargesCurrencyResponse"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 100
|
|
},
|
|
"amountPaid": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"amountWaived": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"amountWrittenOff": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"amountOutstanding": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 100
|
|
},
|
|
"amountOrPercentage": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 100
|
|
},
|
|
"penalty": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"chargeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Passbook fee"
|
|
},
|
|
"chargeTimeType": {
|
|
"$ref": "#/definitions/GetChargesChargeTimeType"
|
|
},
|
|
"chargeCalculationType": {
|
|
"$ref": "#/definitions/GetChargesChargeCalculationType"
|
|
},
|
|
"percentage": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 0
|
|
},
|
|
"amountPercentageAppliedTo": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 0
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetChargesCurrencyResponse"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 100
|
|
},
|
|
"amountPaid": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"amountWaived": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"amountWrittenOff": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"amountOutstanding": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 100
|
|
},
|
|
"amountOrPercentage": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 100
|
|
},
|
|
"penalty": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"PostSavingsAccountsSavingsAccountIdChargesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"savingsId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 6
|
|
}
|
|
}
|
|
},
|
|
"PostSavingsAccountsSavingsAccountIdChargesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"chargeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 100
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"dueDate": {
|
|
"type": "string",
|
|
"example": "29 April 2013"
|
|
}
|
|
}
|
|
},
|
|
"PutSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"savingsId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 6
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutSavingsChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutSavingsChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Passbook Savings Lite."
|
|
},
|
|
"interestRate": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 5.73
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
}
|
|
}
|
|
},
|
|
"PutSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 60
|
|
},
|
|
"dueDate": {
|
|
"type": "string",
|
|
"example": "27 March 2013"
|
|
}
|
|
}
|
|
},
|
|
"PostSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"savingsId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
}
|
|
}
|
|
},
|
|
"PostSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 60
|
|
},
|
|
"dueDate": {
|
|
"type": "string",
|
|
"example": "12 September 2013"
|
|
}
|
|
}
|
|
},
|
|
"DeleteSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"savingsId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
}
|
|
}
|
|
},
|
|
"GetChargesAppliesTo": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeAppliesTo.savings"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Savings"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsAccountsSavingsAccountIdChargesTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"amountPaid": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"amountWaived": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"amountWrittenOff": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"chargeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSavingsChargesOptions"
|
|
}
|
|
},
|
|
"penalty": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsChargesChargeTimeType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeTimeType.specifiedDueDate"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Specified due date"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsChargesOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Passbook Fee"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"penalty": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetChargesCurrencyResponse"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 100
|
|
},
|
|
"chargeTimeType": {
|
|
"$ref": "#/definitions/GetSavingsChargesChargeTimeType"
|
|
},
|
|
"chargesAppliesTo": {
|
|
"$ref": "#/definitions/GetChargesAppliesTo"
|
|
},
|
|
"chargeCalculationType": {
|
|
"$ref": "#/definitions/GetChargesChargeCalculationType"
|
|
}
|
|
}
|
|
},
|
|
"PostSavingsAccountsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"savingsId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostSavingsAccountsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"submittedOnDate": {
|
|
"type": "string",
|
|
"example": "01 March 2011"
|
|
}
|
|
}
|
|
},
|
|
"PostSavingsAccountsAccountIdChanges": {
|
|
"type": "object"
|
|
},
|
|
"PostSavingsAccountsAccountIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 8
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 8
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PostSavingsAccountsAccountIdChanges"
|
|
}
|
|
}
|
|
},
|
|
"PostSavingsAccountsAccountIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"unassignedDate": {
|
|
"type": "string",
|
|
"example": "05 September 2014"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsAccountsTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientName": {
|
|
"type": "string",
|
|
"example": "small business"
|
|
},
|
|
"productOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSavingsProductOptions"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Passbook Savings"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsAccountsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalFilteredRecords": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"pageItems": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSavingsPageItems"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsInterestCalculationDaysInYearType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 365
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsInterestCalculationDaysInYearType.days365"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "365 Days"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsInterestCalculationType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsInterestCalculationType.dailybalance"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Daily Balance"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsInterestCompoundingPeriodType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savings.interest.period.savingsCompoundingInterestPeriodType.daily"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Daily"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsInterestPostingPeriodType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savings.interest.posting.period.savingsPostingInterestPeriodType.monthly"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Monthly"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsPageItems": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"accountNo": {
|
|
"type": "string",
|
|
"example": "000000001"
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientName": {
|
|
"type": "string",
|
|
"example": "small business"
|
|
},
|
|
"savingsProductId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"savingsProductName": {
|
|
"type": "string",
|
|
"example": "Passbook Savings"
|
|
},
|
|
"fieldOfficerId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetSavingsStatus"
|
|
},
|
|
"timeline": {
|
|
"$ref": "#/definitions/GetSavingsTimeline"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetSavingsCurrency"
|
|
},
|
|
"nominalAnnualInterestRate": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 5
|
|
},
|
|
"interestCompoundingPeriodType": {
|
|
"$ref": "#/definitions/GetSavingsInterestCompoundingPeriodType"
|
|
},
|
|
"interestPostingPeriodType": {
|
|
"$ref": "#/definitions/GetSavingsInterestPostingPeriodType"
|
|
},
|
|
"interestCalculationType": {
|
|
"$ref": "#/definitions/GetSavingsInterestCalculationType"
|
|
},
|
|
"interestCalculationDaysInYearType": {
|
|
"$ref": "#/definitions/GetSavingsInterestCalculationDaysInYearType"
|
|
},
|
|
"summary": {
|
|
"$ref": "#/definitions/GetSavingsSummary"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsAccountStatusType.submitted.and.pending.approval"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Submitted and pending approval"
|
|
},
|
|
"submittedAndPendingApproval": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"approved": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"rejected": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"withdrawnByApplicant": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closed": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsSummary": {
|
|
"type": "object",
|
|
"properties": {
|
|
"currency": {
|
|
"$ref": "#/definitions/GetSavingsCurrency"
|
|
},
|
|
"accountBalance": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsTimeline": {
|
|
"type": "object",
|
|
"properties": {
|
|
"submittedOnDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2013, 3, 1]"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsAccountsAccountIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"accountNo": {
|
|
"type": "string",
|
|
"example": "000000001"
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientName": {
|
|
"type": "string",
|
|
"example": "small business"
|
|
},
|
|
"savingsProductId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"savingsProductName": {
|
|
"type": "string",
|
|
"example": "Passbook Savings"
|
|
},
|
|
"fieldOfficerId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetSavingsStatus"
|
|
},
|
|
"timeline": {
|
|
"$ref": "#/definitions/GetSavingsTimeline"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetSavingsCurrency"
|
|
},
|
|
"nominalAnnualInterestRate": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 5
|
|
},
|
|
"interestCompoundingPeriodType": {
|
|
"$ref": "#/definitions/GetSavingsInterestCompoundingPeriodType"
|
|
},
|
|
"interestPostingPeriodType": {
|
|
"$ref": "#/definitions/GetSavingsInterestPostingPeriodType"
|
|
},
|
|
"interestCalculationType": {
|
|
"$ref": "#/definitions/GetSavingsInterestCalculationType"
|
|
},
|
|
"interestCalculationDaysInYearType": {
|
|
"$ref": "#/definitions/GetSavingsInterestCalculationDaysInYearType"
|
|
},
|
|
"summary": {
|
|
"$ref": "#/definitions/GetSavingsAccountsSummary"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsAccountsSummary": {
|
|
"type": "object",
|
|
"properties": {
|
|
"currency": {
|
|
"$ref": "#/definitions/GetSavingsCurrency"
|
|
},
|
|
"accountBalance": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"availableBalance": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
}
|
|
}
|
|
},
|
|
"PutSavingsAccountsAccountIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"savingsId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutSavingsAccountsChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutSavingsAccountsChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"nominalAnnualInterestRate": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 5.9999999999
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
}
|
|
}
|
|
},
|
|
"PutSavingsAccountsAccountIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"nominalAnnualInterestRate": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 5.9999999999
|
|
}
|
|
}
|
|
},
|
|
"DeleteSavingsAccountsAccountIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsAssetLiabilityType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.asset"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "ASSET"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsAssetTagId": {
|
|
"type": "object"
|
|
},
|
|
"GetSavingsChargeCalculationType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeCalculationType.flat"
|
|
},
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Flat"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsChargePaymentMode": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargepaymentmode.regular"
|
|
},
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "chargepaymentmode.regular"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsChargeTimeType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeTimeType.specifiedDueDate"
|
|
},
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Specified due date"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsAccountingMappingOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"liabilityAccountOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSavingsProductsLiabilityAccountOptions"
|
|
}
|
|
},
|
|
"assetAccountOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSavingsProductsAssetAccountOptions"
|
|
}
|
|
},
|
|
"expenseAccountOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSavingsProductsExpenseAccountOptions"
|
|
}
|
|
},
|
|
"incomeAccountOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSavingsProductsIncomeAccountOptions"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsAssetAccountOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Cash"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100001
|
|
},
|
|
"disabled": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"manualEntriesAllowed": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/GetSavingsAssetLiabilityType"
|
|
},
|
|
"usage": {
|
|
"$ref": "#/definitions/GetSavingsProductsLiabilityUsage"
|
|
},
|
|
"tagId": {
|
|
"$ref": "#/definitions/GetSavingsAssetTagId"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsChargeAppliesTo": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeAppliesTo.savings"
|
|
},
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Savings"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsChargeOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"amount": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 200
|
|
},
|
|
"chargeAppliesTo": {
|
|
"$ref": "#/definitions/GetSavingsProductsChargeAppliesTo"
|
|
},
|
|
"chargeCalculationType": {
|
|
"$ref": "#/definitions/GetSavingsChargeCalculationType"
|
|
},
|
|
"chargePaymentMode": {
|
|
"$ref": "#/definitions/GetSavingsChargePaymentMode"
|
|
},
|
|
"chargeTimeType": {
|
|
"$ref": "#/definitions/GetSavingsChargeTimeType"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetSavingsCurrency"
|
|
},
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Savings charge 1"
|
|
},
|
|
"penalty": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsExpenseAccountOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 6
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Write Off Expenses"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 60001
|
|
},
|
|
"disabled": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"manualEntriesAllowed": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/GetSavingsProductsExpenseType"
|
|
},
|
|
"usage": {
|
|
"$ref": "#/definitions/GetSavingsProductsLiabilityUsage"
|
|
},
|
|
"tagId": {
|
|
"$ref": "#/definitions/GetSavingsAssetTagId"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsExpenseType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 5
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.expense"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "EXPENSE"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsIncomeAccountOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "income from interest"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 40001
|
|
},
|
|
"disabled": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"manualEntriesAllowed": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/GetSavingsProductsIncomeType"
|
|
},
|
|
"usage": {
|
|
"$ref": "#/definitions/GetSavingsProductsLiabilityUsage"
|
|
},
|
|
"tagId": {
|
|
"$ref": "#/definitions/GetSavingsAssetTagId"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsIncomeType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.income"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "INCOME"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsInterestCalculationDaysInYearType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 365
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsInterestCalculationDaysInYearType.days365"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "365 Days"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsInterestCalculationType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsInterestCalculationType.dailybalance"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Daily Balance"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsInterestCompoundingPeriodType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savings.interest.period.savingsCompoundingInterestPeriodType.daily"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Daily"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsInterestPostingPeriodType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savings.interest.posting.period.savingsPostingInterestPeriodType.monthly"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Monthly"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsLiabilityAccountOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 15
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Savings Control"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 50001
|
|
},
|
|
"disabled": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"manualEntriesAllowed": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/GetSavingsProductsLiabilityType"
|
|
},
|
|
"usage": {
|
|
"$ref": "#/definitions/GetSavingsProductsLiabilityUsage"
|
|
},
|
|
"nameDecorated": {
|
|
"type": "string",
|
|
"example": "Savings Control"
|
|
},
|
|
"tagId": {
|
|
"$ref": "#/definitions/GetSavingsProductsLiabilityTagId"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsLiabilityTagId": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsLiabilityType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.liability"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "LIABILITY"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsLiabilityUsage": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountUsage.detail"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "DETAIL"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsLockinPeriodFrequencyTypeOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savings.lockin.savingsPeriodFrequencyType.days"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Days"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsPaymentTypeOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 14
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Wire Transfer"
|
|
},
|
|
"position": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsTemplateAccountingRule": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountingRuleType.none"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "NONE"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"currency": {
|
|
"$ref": "#/definitions/GetSavingsCurrency"
|
|
},
|
|
"interestCompoundingPeriodType": {
|
|
"$ref": "#/definitions/GetSavingsProductsInterestCompoundingPeriodType"
|
|
},
|
|
"interestPostingPeriodType": {
|
|
"$ref": "#/definitions/GetSavingsProductsInterestPostingPeriodType"
|
|
},
|
|
"interestCalculationType": {
|
|
"$ref": "#/definitions/GetSavingsProductsInterestCalculationType"
|
|
},
|
|
"interestCalculationDaysInYearType": {
|
|
"$ref": "#/definitions/GetSavingsProductsInterestCalculationDaysInYearType"
|
|
},
|
|
"accountingRule": {
|
|
"$ref": "#/definitions/GetSavingsProductsTemplateAccountingRule"
|
|
},
|
|
"currencyOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSavingsCurrency"
|
|
}
|
|
},
|
|
"interestCompoundingPeriodTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSavingsProductsInterestCompoundingPeriodType"
|
|
}
|
|
},
|
|
"interestPostingPeriodTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSavingsProductsInterestPostingPeriodType"
|
|
}
|
|
},
|
|
"interestCalculationTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSavingsProductsInterestCalculationType"
|
|
}
|
|
},
|
|
"interestCalculationDaysInYearTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSavingsProductsInterestCalculationDaysInYearType"
|
|
}
|
|
},
|
|
"lockinPeriodFrequencyTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSavingsProductsLockinPeriodFrequencyTypeOptions"
|
|
}
|
|
},
|
|
"withdrawalFeeTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSavingsProductsWithdrawalFeeTypeOptions"
|
|
}
|
|
},
|
|
"paymentTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSavingsProductsPaymentTypeOptions"
|
|
}
|
|
},
|
|
"accountingRuleOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSavingsProductsTemplateAccountingRule"
|
|
}
|
|
},
|
|
"accountingMappingOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSavingsProductsAccountingMappingOptions"
|
|
}
|
|
},
|
|
"chargeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSavingsProductsChargeOptions"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsWithdrawalFeeTypeOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsWithdrawalFeesType.flat"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Flat"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsAccountingRule": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountingRuleType.cash"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "CASH BASED"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Savings product"
|
|
},
|
|
"shortName": {
|
|
"type": "string",
|
|
"example": "sa1"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "gtasga"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetSavingsCurrency"
|
|
},
|
|
"nominalAnnualInterestRate": {
|
|
"type": "number",
|
|
"example": 5
|
|
},
|
|
"interestCompoundingPeriodType": {
|
|
"$ref": "#/definitions/GetSavingsProductsInterestCompoundingPeriodType"
|
|
},
|
|
"interestPostingPeriodType": {
|
|
"$ref": "#/definitions/GetSavingsProductsInterestPostingPeriodType"
|
|
},
|
|
"interestCalculationType": {
|
|
"$ref": "#/definitions/GetSavingsProductsInterestCalculationType"
|
|
},
|
|
"interestCalculationDaysInYearType": {
|
|
"$ref": "#/definitions/GetSavingsProductsInterestCalculationDaysInYearType"
|
|
},
|
|
"withdrawalFeeForTransfers": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"accountingRule": {
|
|
"$ref": "#/definitions/GetSavingsProductsAccountingRule"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsAccountingMappings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"savingsReferenceAccount": {
|
|
"$ref": "#/definitions/GetSavingsProductsSavingsReferenceAccount"
|
|
},
|
|
"incomeFromFeeAccount": {
|
|
"$ref": "#/definitions/GetSavingsProductsIncomeFromFeeAccount"
|
|
},
|
|
"incomeFromPenaltyAccount": {
|
|
"$ref": "#/definitions/GetSavingsProductsIncomeFromPenaltyAccount"
|
|
},
|
|
"interestOnSavingsAccount": {
|
|
"$ref": "#/definitions/GetSavingsProductsInterestOnSavingsAccount"
|
|
},
|
|
"savingsControlAccount": {
|
|
"$ref": "#/definitions/GetSavingsProductsSavingsControlAccount"
|
|
},
|
|
"transfersInSuspenseAccount": {
|
|
"$ref": "#/definitions/GetSavingsProductsTransfersInSuspenseAccount"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsFeeToIncomeAccountMappings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"charge": {
|
|
"$ref": "#/definitions/GetSavingsProductsFeeToIncomeAccountMappingsCharge"
|
|
},
|
|
"incomeAccount": {
|
|
"$ref": "#/definitions/GetSavingsProductsFeeToIncomeAccountMappingsIncomeAccount"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsFeeToIncomeAccountMappingsCharge": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 11
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "sav charge"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"penalty": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsFeeToIncomeAccountMappingsIncomeAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 16
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "income from savings fee"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 24
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsFundSourceAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 12
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "savings ref"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 20
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsIncomeFromFeeAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 16
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "income from savings fee"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 24
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsIncomeFromPenaltyAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 17
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "income from sav penalties"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 25
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsInterestOnSavingsAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 15
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "interest on savings"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 23
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsPaymentChannelToFundSourceMappings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"paymentType": {
|
|
"$ref": "#/definitions/GetSavingsProductsPaymentType"
|
|
},
|
|
"fundSourceAccount": {
|
|
"$ref": "#/definitions/GetSavingsProductsFundSourceAccount"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsPaymentType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 10
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "check"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsPenaltyToIncomeAccountMappings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"charge": {
|
|
"$ref": "#/definitions/GetSavingsProductsPenaltyToIncomeAccountMappingsCharge"
|
|
},
|
|
"incomeAccount": {
|
|
"$ref": "#/definitions/GetSavingsProductsIncomeFromPenaltyAccount"
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsPenaltyToIncomeAccountMappingsCharge": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 12
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "sav 2"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"penalty": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsProductIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "savings product"
|
|
},
|
|
"shortName": {
|
|
"type": "string",
|
|
"example": "sa1"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "gtasga"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetSavingsCurrency"
|
|
},
|
|
"nominalAnnualInterestRate": {
|
|
"type": "number",
|
|
"example": 5
|
|
},
|
|
"interestCompoundingPeriodType": {
|
|
"$ref": "#/definitions/GetSavingsProductsInterestCompoundingPeriodType"
|
|
},
|
|
"interestPostingPeriodType": {
|
|
"$ref": "#/definitions/GetSavingsProductsInterestPostingPeriodType"
|
|
},
|
|
"interestCalculationType": {
|
|
"$ref": "#/definitions/GetSavingsProductsInterestCalculationType"
|
|
},
|
|
"interestCalculationDaysInYearType": {
|
|
"$ref": "#/definitions/GetSavingsProductsInterestCalculationDaysInYearType"
|
|
},
|
|
"withdrawalFeeForTransfers": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"accountingRule": {
|
|
"$ref": "#/definitions/GetSavingsProductsAccountingRule"
|
|
},
|
|
"accountingMappings": {
|
|
"$ref": "#/definitions/GetSavingsProductsAccountingMappings"
|
|
},
|
|
"paymentChannelToFundSourceMappings": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSavingsProductsPaymentChannelToFundSourceMappings"
|
|
}
|
|
},
|
|
"feeToIncomeAccountMappings": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSavingsProductsFeeToIncomeAccountMappings"
|
|
}
|
|
},
|
|
"penaltyToIncomeAccountMappings": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSavingsProductsPenaltyToIncomeAccountMappings"
|
|
}
|
|
},
|
|
"charges": {
|
|
"type": "array",
|
|
"example": "[]",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsSavingsControlAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 13
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "savings ref tool kit"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 21
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsSavingsReferenceAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 12
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "savings ref"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 20
|
|
}
|
|
}
|
|
},
|
|
"GetSavingsProductsTransfersInSuspenseAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 14
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "saving transfers"
|
|
},
|
|
"glCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 22
|
|
}
|
|
}
|
|
},
|
|
"PutSavingsProductsProductIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutSavingsChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutSavingsProductsProductIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Passbook Savings Lite."
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"interestRate": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 5.73
|
|
}
|
|
}
|
|
},
|
|
"DeleteSavingsProductsProductIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostSavingsProductsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostSavingsCharges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostSavingsProductsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Passbook Savings"
|
|
},
|
|
"shortName": {
|
|
"type": "string",
|
|
"example": "PBSV"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Daily compounding using Daily Balance, 5% per year, 365 days in year"
|
|
},
|
|
"currencyCode": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"digitsAfterDecimal": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"inMultiplesOf": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"nominalAnnualInterestRate": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 5
|
|
},
|
|
"interestCompoundingPeriodType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"interestPostingPeriodType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"interestCalculationType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"interestCalculationDaysInYearType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 365
|
|
},
|
|
"accountingRule": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"charges": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/PostSavingsCharges"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetSelfBeneficiariesAccountOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.savings"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Savings Account"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfBeneficiariesTPTTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"accountTypeOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSelfBeneficiariesAccountOptions"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetSelfBeneficiariesTPTResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Client2Savings"
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Test Office"
|
|
},
|
|
"clientName": {
|
|
"type": "string",
|
|
"example": "FN2 LN2"
|
|
},
|
|
"accountType": {
|
|
"$ref": "#/definitions/GetSelfBeneficiariesAccountOptions"
|
|
},
|
|
"accountNumber": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 2
|
|
},
|
|
"transferLimit": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
}
|
|
}
|
|
},
|
|
"PostSelfBeneficiariesTPTResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 5
|
|
}
|
|
}
|
|
},
|
|
"PostSelfBeneficiariesTPTRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en_GB"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "beneficiary nick name"
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "HEAD OFFICE"
|
|
},
|
|
"accountNumber": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"accountType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"transferLimit": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1000
|
|
}
|
|
}
|
|
},
|
|
"PutSelfBeneficiariesChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"transferLimit": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1000
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Client22"
|
|
}
|
|
}
|
|
},
|
|
"PutSelfBeneficiariesTPTBeneficiaryIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 5
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutSelfBeneficiariesChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutSelfBeneficiariesTPTBeneficiaryIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "beneficiary nick name"
|
|
},
|
|
"transferLimit": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1000
|
|
}
|
|
}
|
|
},
|
|
"DeleteSelfBeneficiariesTPTBeneficiaryIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 5
|
|
}
|
|
}
|
|
},
|
|
"GetSelfClientsChargeCalculationType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeCalculationType.flat"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Flat"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfClientsChargeTimeType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeTimeType.specifiedDueDate"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Specified due date"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfClientsChargesPageItems": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 5
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"chargeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 6
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Client Fees 2"
|
|
},
|
|
"chargeTimeType": {
|
|
"$ref": "#/definitions/GetSelfClientsChargeTimeType"
|
|
},
|
|
"dueDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2015, 9, 1]"
|
|
},
|
|
"chargeCalculationType": {
|
|
"$ref": "#/definitions/GetSelfClientsChargeCalculationType"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetSelfClientsSavingsAccountsCurrency"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 550
|
|
},
|
|
"amountPaid": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"amountWaived": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"amountWrittenOff": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"amountOutstanding": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 550
|
|
},
|
|
"penalty": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"isPaid": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"isWaived": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetSelfClientsClientIdChargesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalFilteredRecords": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"pageItems": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSelfClientsChargesPageItems"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetSelfClientsSavingsAccountsCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfClientsClientIdChargesChargeIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"chargeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 5
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Client Fee 1"
|
|
},
|
|
"chargeTimeType": {
|
|
"$ref": "#/definitions/GetSelfClientsChargeTimeType"
|
|
},
|
|
"dueDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2015, 8, 17]"
|
|
},
|
|
"chargeCalculationType": {
|
|
"$ref": "#/definitions/GetSelfClientsChargeCalculationType"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetSelfClientsSavingsAccountsCurrency"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 100
|
|
},
|
|
"amountPaid": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"amountWaived": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 100
|
|
},
|
|
"amountWrittenOff": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"amountOutstanding": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"penalty": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"isPaid": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"isWaived": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
}
|
|
},
|
|
"GetSelfClientsClientIdAccountsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"loanAccounts": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSelfClientsLoanAccounts"
|
|
}
|
|
},
|
|
"savingsAccounts": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSelfClientsSavingsAccounts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetSelfClientsLoanAccounts": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"externalId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 456
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"productName": {
|
|
"type": "string",
|
|
"example": "TestOne"
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetSelfClientsLoanAccountsStatus"
|
|
},
|
|
"loanType": {
|
|
"$ref": "#/definitions/GetSelfClientsLoanAccountsType"
|
|
},
|
|
"loanCycle": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"GetSelfClientsLoanAccountsStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 300
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "loanStatusType.active"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Active"
|
|
},
|
|
"pendingApproval": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"waitingForDisbursal": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"closedObligationsMet": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closedWrittenOff": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closedRescheduled": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closed": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"overpaid": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetSelfClientsLoanAccountsType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "loanType.individual"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Individual"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfClientsSavingsAccounts": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 7
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 7
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"productName": {
|
|
"type": "string",
|
|
"example": "Other product"
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetSelfClientsSavingsAccountsStatus"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetSelfClientsSavingsAccountsCurrency"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfClientsSavingsAccountsStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsAccountStatusType.submitted.and.pending.approval"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Submitted and pending approval"
|
|
},
|
|
"submittedAndPendingApproval": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"approved": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"rejected": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"withdrawnByApplicant": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closed": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetSelfClientsClientIdTransactionsPageItems": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 226
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/GetSelfClientsClientIdTransactionsType"
|
|
},
|
|
"date": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2015, 9, 2]"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetSelfClientsSavingsAccountsCurrency"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 22
|
|
},
|
|
"submittedOnDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2015, 9, 2]"
|
|
},
|
|
"reversed": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetSelfClientsClientIdTransactionsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalFilteredRecords": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 20
|
|
},
|
|
"pageItems": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSelfClientsClientIdTransactionsPageItems"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetSelfClientsClientIdTransactionsType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "clientTransactionType.payCharge"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "PAY_CHARGE"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfClientsClientIdTransactionsTransactionIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/GetSelfClientsClientIdTransactionsType"
|
|
},
|
|
"date": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2015, 8, 17]"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetSelfClientsSavingsAccountsCurrency"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 60
|
|
},
|
|
"submittedOnDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2015, 8, 19]"
|
|
},
|
|
"reversed": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
}
|
|
},
|
|
"GetSelfClientsPageItems": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetSelfClientsStatus"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"activationDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2013, 3, 1]"
|
|
},
|
|
"fullname": {
|
|
"type": "string",
|
|
"example": "Small shop"
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"example": "Small shop"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfClientsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalFilteredRecords": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"pageItems": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSelfClientsPageItems"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetSelfClientsStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 300
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "clientStatusType.active"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Active"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfClientsClientIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 27
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 27
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetSelfClientsStatus"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"activationDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2013, 1, 1]"
|
|
},
|
|
"firstname": {
|
|
"type": "string",
|
|
"example": "savings"
|
|
},
|
|
"lastname": {
|
|
"type": "string",
|
|
"example": "test"
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"example": "savings test"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"timeline": {
|
|
"$ref": "#/definitions/GetSelfClientsTimeline"
|
|
},
|
|
"savingsProductId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"savingsProductName": {
|
|
"type": "string",
|
|
"example": "account overdraft"
|
|
},
|
|
"groups": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetSelfClientsTimeline": {
|
|
"type": "object",
|
|
"properties": {
|
|
"submittedOnDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2013, 1, 1]"
|
|
},
|
|
"submittedByUsername": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"submittedByFirstname": {
|
|
"type": "string",
|
|
"example": "App"
|
|
},
|
|
"submittedByLastname": {
|
|
"type": "string",
|
|
"example": "Administrator"
|
|
},
|
|
"activatedOnDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2013, 1, 1]"
|
|
},
|
|
"activatedByUsername": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"activatedByFirstname": {
|
|
"type": "string",
|
|
"example": "App"
|
|
},
|
|
"activatedByLastname": {
|
|
"type": "string",
|
|
"example": "Administrator"
|
|
}
|
|
}
|
|
},
|
|
"GetLoanCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfLoansLoanIdTransactionsTransactionIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/GetSelfLoansLoanIdTransactionsType"
|
|
},
|
|
"date": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2012, 5, 14]"
|
|
},
|
|
"manuallyReversed": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetLoanCurrency"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 559.88
|
|
},
|
|
"interestPortion": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 559.88
|
|
}
|
|
}
|
|
},
|
|
"GetSelfLoansLoanIdTransactionsType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "loanTransactionType.repayment"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Repayment"
|
|
},
|
|
"disbursement": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"repaymentAtDisbursement": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"repayment": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"contra": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"waiveInterest": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"waiveCharges": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"writeOff": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"recoveryRepayment": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"PostSelfLoansResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"loanId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostSelfLoansData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"Activation_Date": {
|
|
"type": "string",
|
|
"example": "01 December 2016 00:00"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy HH:mm"
|
|
}
|
|
}
|
|
},
|
|
"PostSelfLoansDatatables": {
|
|
"type": "object",
|
|
"properties": {
|
|
"registeredTableName": {
|
|
"type": "string",
|
|
"example": "Date Loan Field"
|
|
},
|
|
"data": {
|
|
"$ref": "#/definitions/PostSelfLoansData"
|
|
}
|
|
}
|
|
},
|
|
"PostSelfLoansDisbursementData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"expectedDisbursementDate": {
|
|
"type": "string",
|
|
"example": "01 November 2013"
|
|
},
|
|
"principal": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 22000
|
|
},
|
|
"approvedPrincipal": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 22000
|
|
}
|
|
}
|
|
},
|
|
"PostSelfLoansRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en_GB"
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"principal": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": "10,000.00"
|
|
},
|
|
"loanTermFrequency": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 12
|
|
},
|
|
"loanTermFrequencyType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"loanType": {
|
|
"type": "string",
|
|
"example": "individual"
|
|
},
|
|
"numberOfRepayments": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 10
|
|
},
|
|
"repaymentEvery": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"repaymentFrequencyType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"interestRatePerPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 10
|
|
},
|
|
"amortizationType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"interestType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"interestCalculationPeriodType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"transactionProcessingStrategyId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"expectedDisbursementDate": {
|
|
"type": "string",
|
|
"example": "10 Jun 2013"
|
|
},
|
|
"submittedOnDate": {
|
|
"type": "string",
|
|
"example": "10 Jun 2013"
|
|
},
|
|
"linkAccountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"fixedEmiAmount": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1100
|
|
},
|
|
"maxOutstandingLoanBalance": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 35000
|
|
},
|
|
"disbursementData": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/PostSelfLoansDisbursementData"
|
|
}
|
|
},
|
|
"datatables": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/PostSelfLoansDatatables"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PutSelfLoansChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"principal": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 5000
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
}
|
|
}
|
|
},
|
|
"PutSelfLoansLoanIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"loanId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutSelfLoansChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutSelfLoansLoanIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"principal": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 5000
|
|
},
|
|
"loanTermFrequency": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 10
|
|
},
|
|
"loanTermFrequencyType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"numberOfRepayments": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 10
|
|
},
|
|
"repaymentEvery": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"repaymentFrequencyType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"interestRatePerPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"interestType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"interestCalculationPeriodType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"amortizationType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"expectedDisbursementDate": {
|
|
"type": "string",
|
|
"example": "04 March 2014"
|
|
},
|
|
"transactionProcessingStrategyId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostSelfLoansLoanIdChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"status": {
|
|
"$ref": "#/definitions/PostSelfLoansLoanIdStatus"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"withdrawnOnDate": {
|
|
"type": "string",
|
|
"example": "20 September 2011"
|
|
},
|
|
"closedOnDate": {
|
|
"type": "string",
|
|
"example": "20 September 2011"
|
|
}
|
|
}
|
|
},
|
|
"PostSelfLoansLoanIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"loanId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PostSelfLoansLoanIdChanges"
|
|
}
|
|
}
|
|
},
|
|
"PostSelfLoansLoanIdStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 400
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "loanStatusType.withdrawn.by.client"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Withdrawn by applicant"
|
|
},
|
|
"pendingApproval": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"waitingForDisbursal": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closedObligationsMet": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closedWrittenOff": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closedRescheduled": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closed": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"overpaid": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"PostSelfLoansLoanIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"withdrawnOnDate": {
|
|
"type": "string",
|
|
"example": "20 September 2011"
|
|
},
|
|
"note": {
|
|
"type": "string",
|
|
"example": "Reason loan applicant withdrew from application."
|
|
}
|
|
}
|
|
},
|
|
"GetSelfLoansLoanIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetLoansLoanIdStatus"
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientName": {
|
|
"type": "string",
|
|
"example": "Kampala first Client"
|
|
},
|
|
"clientOfficeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"loanProductId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"loanProductName": {
|
|
"type": "string",
|
|
"example": "Kampala Product (with cash accounting)"
|
|
},
|
|
"loanProductDescription": {
|
|
"type": "string",
|
|
"example": "Typical Kampala loan product with cash accounting enabled for testing."
|
|
},
|
|
"loanPurposeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 22
|
|
},
|
|
"loanPurposeName": {
|
|
"type": "string",
|
|
"example": "option.HousingImprovement"
|
|
},
|
|
"loanOfficerId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"loanOfficerName": {
|
|
"type": "string",
|
|
"example": "LoanOfficer, Kampala"
|
|
},
|
|
"loanType": {
|
|
"$ref": "#/definitions/GetLoansLoanIdLoanType"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetLoansLoanIdCurrency"
|
|
},
|
|
"principal": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1000000
|
|
},
|
|
"termFrequency": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 12
|
|
},
|
|
"termPeriodFrequencyType": {
|
|
"$ref": "#/definitions/GetLoansLoanIdTermPeriodFrequencyType"
|
|
},
|
|
"numberOfRepayments": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 12
|
|
},
|
|
"repaymentEvery": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"repaymentFrequencyType": {
|
|
"$ref": "#/definitions/GetLoansLoanIdRepaymentFrequencyType"
|
|
},
|
|
"interestRatePerPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 24
|
|
},
|
|
"interestRateFrequencyType": {
|
|
"$ref": "#/definitions/GetLoansLoanIdInterestRateFrequencyType"
|
|
},
|
|
"annualInterestRate": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 24
|
|
},
|
|
"amortizationType": {
|
|
"$ref": "#/definitions/GetLoansLoanIdAmortizationType"
|
|
},
|
|
"interestType": {
|
|
"$ref": "#/definitions/GetLoansLoanIdInterestType"
|
|
},
|
|
"interestCalculationPeriodType": {
|
|
"$ref": "#/definitions/GetLoansLoanIdInterestCalculationPeriodType"
|
|
},
|
|
"transactionProcessingStrategyId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"timeline": {
|
|
"$ref": "#/definitions/GetLoansLoanIdTimeline"
|
|
},
|
|
"summary": {
|
|
"$ref": "#/definitions/GetLoansLoanIdSummary"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfLoansChargeCalculationType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeCalculationType.flat"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Flat"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfLoansChargeTimeType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeTimeType.disbursement"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Disbursement"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfLoansLoanIdChargesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"chargeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Loan Processing fee"
|
|
},
|
|
"chargeTimeType": {
|
|
"$ref": "#/definitions/GetSelfLoansChargeTimeType"
|
|
},
|
|
"chargeCalculationType": {
|
|
"$ref": "#/definitions/GetSelfLoansChargeCalculationType"
|
|
},
|
|
"percentage": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 0
|
|
},
|
|
"amountPercentageAppliedTo": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 0
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetLoanCurrency"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 100
|
|
},
|
|
"amountPaid": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"amountWaived": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"amountWrittenOff": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 0
|
|
},
|
|
"amountOutstanding": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 100
|
|
},
|
|
"amountOrPercentage": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 100
|
|
},
|
|
"penalty": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetSelfLoansProductOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Kampala Product (with cash accounting)"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfLoansTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientName": {
|
|
"type": "string",
|
|
"example": "Kampala first Client"
|
|
},
|
|
"clientOfficeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"timeline": {
|
|
"$ref": "#/definitions/GetSelfLoansTimeline"
|
|
},
|
|
"productOptions": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSelfLoansProductOptions"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetSelfLoansTimeline": {
|
|
"type": "object",
|
|
"properties": {
|
|
"expectedDisbursementDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2013, 3, 8]"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfSavingsAccountsAccountIdTransactionsTransactionIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"transactionType": {
|
|
"$ref": "#/definitions/GetSelfSavingsTransactionType"
|
|
},
|
|
"accountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"date": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2013, 8, 7]"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetSelfSavingsTransactionCurrency"
|
|
},
|
|
"paymentDetailData": {
|
|
"$ref": "#/definitions/GetSelfSavingsPaymentDetailData"
|
|
},
|
|
"amount": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 5000
|
|
},
|
|
"runningBalance": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"reversed": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
}
|
|
},
|
|
"GetSelfSavingsPaymentDetailData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 62
|
|
},
|
|
"paymentType": {
|
|
"$ref": "#/definitions/GetSelfSavingsPaymentType"
|
|
},
|
|
"accountNumber": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"checkNumber": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"routingCode": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"receiptNumber": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"bankNumber": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfSavingsPaymentType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 11
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "cash"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfSavingsTransactionCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"inMultiplesOf": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfSavingsTransactionType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsAccountTransactionType.withdrawal"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Withdrawal"
|
|
},
|
|
"deposit": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"withdrawal": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"interestPosting": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"feeDeduction": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetSelfSavingsAccountsAccountIdChargesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"chargeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 3
|
|
},
|
|
"accountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 57
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Savings account maintenance fee"
|
|
},
|
|
"chargeTimeType": {
|
|
"$ref": "#/definitions/GetSelfSavingsChargeTimeType"
|
|
},
|
|
"chargeCalculationType": {
|
|
"$ref": "#/definitions/GetSelfSavingsChargeCalculationType"
|
|
},
|
|
"percentage": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 0
|
|
},
|
|
"amountPercentageAppliedTo": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 0
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetSelfSavingsCurrency"
|
|
},
|
|
"amount": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"amountPaid": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"amountWaived": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"amountWrittenOff": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"amountOutstanding": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"amountOrPercentage": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"penalty": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetSelfSavingsChargeCalculationType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeCalculationType.flat"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Flat"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfSavingsChargeTimeType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "chargeTimeType.specifiedDueDate"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Specified due date"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfSavingsCurrency": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"example": "USD"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "US Dollar"
|
|
},
|
|
"decimalPlaces": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"displaySymbol": {
|
|
"type": "string",
|
|
"example": "$"
|
|
},
|
|
"nameCode": {
|
|
"type": "string",
|
|
"example": "currency.USD"
|
|
},
|
|
"displayLabel": {
|
|
"type": "string",
|
|
"example": "US Dollar ($)"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfSavingsAccountsAccountIdChargesSavingsAccountChargeIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"chargeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Passbook fee"
|
|
},
|
|
"chargeTimeType": {
|
|
"$ref": "#/definitions/GetSelfSavingsChargeTimeType"
|
|
},
|
|
"chargeCalculationType": {
|
|
"$ref": "#/definitions/GetSelfSavingsChargeCalculationType"
|
|
},
|
|
"percentage": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 0
|
|
},
|
|
"amountPercentageAppliedTo": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 0
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetSelfSavingsCurrency"
|
|
},
|
|
"amount": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"amountPaid": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"amountWaived": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"amountWrittenOff": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"amountOutstanding": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"amountOrPercentage": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"penalty": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetSelfSavingsAccountsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"accountNo": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"clientName": {
|
|
"type": "string",
|
|
"example": "small business"
|
|
},
|
|
"savingsProductId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"savingsProductName": {
|
|
"type": "string",
|
|
"example": "Passbook Savings"
|
|
},
|
|
"fieldOfficerId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
},
|
|
"status": {
|
|
"$ref": "#/definitions/GetSelfSavingsStatus"
|
|
},
|
|
"timeline": {
|
|
"$ref": "#/definitions/GetSelfSavingsTimeline"
|
|
},
|
|
"currency": {
|
|
"$ref": "#/definitions/GetSelfSavingsCurrency"
|
|
},
|
|
"nominalAnnualInterestRate": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"example": 5
|
|
},
|
|
"interestCompoundingPeriodType": {
|
|
"$ref": "#/definitions/GetSelfSavingsInterestCompoundingPeriodType"
|
|
},
|
|
"interestPostingPeriodType": {
|
|
"$ref": "#/definitions/GetSelfSavingsInterestPostingPeriodType"
|
|
},
|
|
"interestCalculationType": {
|
|
"$ref": "#/definitions/GetSelfSavingsInterestCalculationType"
|
|
},
|
|
"interestCalculationDaysInYearType": {
|
|
"$ref": "#/definitions/GetSelfSavingsInterestCalculationDaysInYearType"
|
|
},
|
|
"summary": {
|
|
"$ref": "#/definitions/GetSelfSavingsSummary"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfSavingsInterestCalculationDaysInYearType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 365
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsInterestCalculationDaysInYearType.days365"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "365 Days"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfSavingsInterestCalculationType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsInterestCalculationType.dailybalance"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Daily Balance"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfSavingsInterestCompoundingPeriodType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savings.interest.period.savingsCompoundingInterestPeriodType.daily"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Daily"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfSavingsInterestPostingPeriodType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savings.interest.posting.period.savingsPostingInterestPeriodType.monthly"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Monthly"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfSavingsStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "savingsAccountStatusType.submitted.and.pending.approval"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Submitted and pending approval"
|
|
},
|
|
"submittedAndPendingApproval": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"approved": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"rejected": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"withdrawnByApplicant": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"closed": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"GetSelfSavingsSummary": {
|
|
"type": "object",
|
|
"properties": {
|
|
"currency": {
|
|
"$ref": "#/definitions/GetSelfSavingsCurrency"
|
|
},
|
|
"accountBalance": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 0
|
|
}
|
|
}
|
|
},
|
|
"GetSelfSavingsTimeline": {
|
|
"type": "object",
|
|
"properties": {
|
|
"submittedOnDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2013, 3, 1]"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfUserDetailsOrganisationalRole": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 100
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "staffOrganisationalRoleType.programDirector"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "Program Director"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfUserDetailsRoles": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Super user"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "This role provides all application permissions."
|
|
}
|
|
}
|
|
},
|
|
"PostSelfAuthenticationResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"username": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"userId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"base64EncodedAuthenticationKey": {
|
|
"type": "string",
|
|
"example": "bWlmb3M6cGFzc3dvcmQ="
|
|
},
|
|
"authenticated": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"staffId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"staffDisplayName": {
|
|
"type": "string",
|
|
"example": "Director, Program"
|
|
},
|
|
"organisationalRole": {
|
|
"$ref": "#/definitions/GetSelfUserDetailsOrganisationalRole"
|
|
},
|
|
"roles": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSelfUserDetailsRoles"
|
|
}
|
|
},
|
|
"permissions": {
|
|
"type": "array",
|
|
"example": "ALL_FUNCTIONS",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"isSelfServiceUser": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"clients": {
|
|
"type": "array",
|
|
"example": "1, 2, 3",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PutSelfUserChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"passwordEncoded": {
|
|
"type": "string",
|
|
"example": "6a72a630795be86fe926ce540fc45b6b922fe5ba130f185fe806a26b5e5efcdd"
|
|
}
|
|
}
|
|
},
|
|
"PutSelfUserResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 6
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutSelfUserChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutSelfUserRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"password": {
|
|
"type": "string",
|
|
"example": "Abcd1234"
|
|
},
|
|
"repeatPassword": {
|
|
"type": "string",
|
|
"example": "Abcd1234"
|
|
}
|
|
}
|
|
},
|
|
"GetSelfUserDetailsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"username": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"userId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"base64EncodedAuthenticationKey": {
|
|
"type": "string",
|
|
"example": "bWlmb3M6cGFzc3dvcmQ="
|
|
},
|
|
"authenticated": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"staffId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"staffDisplayName": {
|
|
"type": "string",
|
|
"example": "Director, Program"
|
|
},
|
|
"organisationalRole": {
|
|
"$ref": "#/definitions/GetSelfUserDetailsOrganisationalRole"
|
|
},
|
|
"roles": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetSelfUserDetailsRoles"
|
|
}
|
|
},
|
|
"permissions": {
|
|
"type": "array",
|
|
"example": "ALL_FUNCTIONS",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"isSelfServiceUser": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"clients": {
|
|
"type": "array",
|
|
"example": "[1, 2, 3]",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetTaxesComponentsCreditAccount": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "ACCOUNT_NAME_7BR9C"
|
|
},
|
|
"glCode": {
|
|
"type": "string",
|
|
"example": "LIABILITY_PA1460364665046"
|
|
}
|
|
}
|
|
},
|
|
"GetTaxesComponentsCreditAccountType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "accountType.liability"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"example": "LIABILITY"
|
|
}
|
|
}
|
|
},
|
|
"GetTaxesComponentsHistories": {
|
|
"type": "object"
|
|
},
|
|
"GetTaxesComponentsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "tax component 1"
|
|
},
|
|
"percentage": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 10
|
|
},
|
|
"creditAccountType": {
|
|
"$ref": "#/definitions/GetTaxesComponentsCreditAccountType"
|
|
},
|
|
"creditAccount": {
|
|
"$ref": "#/definitions/GetTaxesComponentsCreditAccount"
|
|
},
|
|
"startDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2016, 4, 11]"
|
|
},
|
|
"taxComponentsHistories": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetTaxesComponentsHistories"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PostTaxesComponentsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostTaxesComponentsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "tax component 1"
|
|
},
|
|
"percentage": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 10
|
|
},
|
|
"creditAccountType": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 2
|
|
},
|
|
"creditAcountId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 4
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"startDate": {
|
|
"type": "string",
|
|
"example": "11 April 2016"
|
|
}
|
|
}
|
|
},
|
|
"PutTaxesComponentsChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"percentage": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 15
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "tax component 2"
|
|
},
|
|
"startDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2016, 4, 15]"
|
|
}
|
|
}
|
|
},
|
|
"PutTaxesComponentsTaxComponentIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutTaxesComponentsChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutTaxesComponentsTaxComponentIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "tax component 2"
|
|
},
|
|
"percentage": {
|
|
"type": "number",
|
|
"format": "float",
|
|
"example": 15
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
},
|
|
"startDate": {
|
|
"type": "string",
|
|
"example": "15 April 2016"
|
|
}
|
|
}
|
|
},
|
|
"GetTaxesGroupResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 7
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "tax group 1"
|
|
},
|
|
"taxAssociations": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/GetTaxesGroupTaxAssociations"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetTaxesGroupTaxAssociations": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 7
|
|
},
|
|
"taxComponent": {
|
|
"$ref": "#/definitions/GetTaxesGroupTaxComponent"
|
|
},
|
|
"startDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "[2016, 4, 11]"
|
|
}
|
|
}
|
|
},
|
|
"GetTaxesGroupTaxComponent": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 7
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "tax component 2"
|
|
}
|
|
}
|
|
},
|
|
"PutTaxesGroupChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"addComponents": {
|
|
"type": "array",
|
|
"example": "[6]",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"modifiedComponents": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/PutTaxesGroupModifiedComponents"
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "tax group 2"
|
|
}
|
|
}
|
|
},
|
|
"PutTaxesGroupModifiedComponents": {
|
|
"type": "object",
|
|
"properties": {
|
|
"endDate": {
|
|
"type": "string",
|
|
"example": "Apr 22, 2016 12:00:00 AM"
|
|
},
|
|
"taxComponentId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 7
|
|
}
|
|
}
|
|
},
|
|
"PutTaxesGroupTaxGroupIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 7
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutTaxesGroupChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutTaxesGroupTaxComponents": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 7
|
|
},
|
|
"taxComponentId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 7
|
|
},
|
|
"endDate": {
|
|
"type": "string",
|
|
"example": "22 April 2016"
|
|
}
|
|
}
|
|
},
|
|
"PutTaxesGroupTaxGroupIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "tax group 2"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"taxComponents": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/PutTaxesGroupTaxComponents"
|
|
}
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
}
|
|
}
|
|
},
|
|
"PostTaxesGroupResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostTaxesGroupRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "tax group 1"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"example": "en"
|
|
},
|
|
"taxComponents": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"$ref": "#/definitions/PostTaxesGroupTaxComponents"
|
|
}
|
|
},
|
|
"dateFormat": {
|
|
"type": "string",
|
|
"example": "dd MMMM yyyy"
|
|
}
|
|
}
|
|
},
|
|
"PostTaxesGroupTaxComponents": {
|
|
"type": "object",
|
|
"properties": {
|
|
"taxComponentId": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 7
|
|
},
|
|
"startDate": {
|
|
"type": "string",
|
|
"example": "11 April 2016"
|
|
}
|
|
}
|
|
},
|
|
"LookupTableData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"entries": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/LookupTableEntry"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"LookupTableEntry": {
|
|
"type": "object",
|
|
"properties": {
|
|
"valueFrom": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"valueTo": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"score": {
|
|
"type": "number",
|
|
"format": "double"
|
|
}
|
|
}
|
|
},
|
|
"ScorecardData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"userId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"surveyId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"surveyName": {
|
|
"type": "string"
|
|
},
|
|
"scorecardValues": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/ScorecardValue"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"ScorecardValue": {
|
|
"type": "object",
|
|
"properties": {
|
|
"questionId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"responseId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"value": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"createdOn": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
}
|
|
}
|
|
},
|
|
"Component": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"survey": {
|
|
"$ref": "#/definitions/Survey"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"text": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"sequenceNo": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"Question": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"survey": {
|
|
"$ref": "#/definitions/Survey"
|
|
},
|
|
"responses": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Response"
|
|
}
|
|
},
|
|
"componentKey": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"text": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"sequenceNo": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"Response": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"question": {
|
|
"$ref": "#/definitions/Question"
|
|
},
|
|
"text": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"sequenceNo": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"Scorecard": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"survey": {
|
|
"$ref": "#/definitions/Survey"
|
|
},
|
|
"question": {
|
|
"$ref": "#/definitions/Question"
|
|
},
|
|
"response": {
|
|
"$ref": "#/definitions/Response"
|
|
},
|
|
"appUser": {
|
|
"$ref": "#/definitions/AppUser"
|
|
},
|
|
"client": {
|
|
"$ref": "#/definitions/Client"
|
|
},
|
|
"createdOn": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"value": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"Survey": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"components": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Component"
|
|
}
|
|
},
|
|
"questions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Question"
|
|
}
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"countryCode": {
|
|
"type": "string"
|
|
},
|
|
"validFrom": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"validTo": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"ComponentData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"text": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"sequenceNo": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
},
|
|
"QuestionData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"responseDatas": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/ResponseData"
|
|
}
|
|
},
|
|
"componentKey": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"text": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"sequenceNo": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
},
|
|
"ResponseData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"text": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"sequenceNo": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
},
|
|
"SurveyData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"componentDatas": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/ComponentData"
|
|
}
|
|
},
|
|
"questionDatas": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/QuestionData"
|
|
}
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"countryCode": {
|
|
"type": "string"
|
|
},
|
|
"validFrom": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"validTo": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
}
|
|
}
|
|
},
|
|
"PutTemplatesTemplateIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PutTemplatesTemplateIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Text"
|
|
},
|
|
"entity": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"type": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"text": {
|
|
"type": "string",
|
|
"example": "This is a loan for {{loan.clientName}}"
|
|
},
|
|
"mappers": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/TemplateMapper"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"TemplateMapper": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"mapperorder": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"mapperkey": {
|
|
"type": "string"
|
|
},
|
|
"mappervalue": {
|
|
"type": "string"
|
|
},
|
|
"new": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"DeleteTemplatesTemplateIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"GetTemplatesTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Text"
|
|
},
|
|
"entity": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"type": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"text": {
|
|
"type": "string",
|
|
"example": "This is a loan for {{loan.clientName}}"
|
|
},
|
|
"mappers": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/TemplateMapper"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PostTemplatesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostTemplatesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Text"
|
|
},
|
|
"entity": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"type": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"text": {
|
|
"type": "string",
|
|
"example": "This is a loan for {{loan.clientName}}"
|
|
},
|
|
"mappers": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/TemplateMapper"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetTemplatesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Text"
|
|
},
|
|
"entity": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"type": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"text": {
|
|
"type": "string",
|
|
"example": "This is a loan for {{loan.clientName}}"
|
|
},
|
|
"mappers": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/TemplateMapper"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetTemplatesTemplateIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Text"
|
|
},
|
|
"entity": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"type": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 0
|
|
},
|
|
"text": {
|
|
"type": "string",
|
|
"example": "This is a loan for {{loan.clientName}}"
|
|
},
|
|
"mappers": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/TemplateMapper"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetPasswordPreferencesTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "Password must be at least 1 character and not more that 50 characters long"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"key": {
|
|
"type": "string",
|
|
"example": "simple"
|
|
}
|
|
}
|
|
},
|
|
"PutPasswordPreferencesTemplateRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"validationPolicyId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"GetPermissionsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"grouping": {
|
|
"type": "string",
|
|
"example": "authorisation"
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "READ_PERMISSION"
|
|
},
|
|
"entityName": {
|
|
"type": "string",
|
|
"example": "PERMISSION"
|
|
},
|
|
"actionName": {
|
|
"type": "string",
|
|
"example": "READ"
|
|
},
|
|
"selected": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
}
|
|
},
|
|
"CommandProcessingResult": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"groupId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"clientId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"loanId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"savingsId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"subResourceId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"transactionId": {
|
|
"type": "string"
|
|
},
|
|
"changes": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "object"
|
|
}
|
|
},
|
|
"productId": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"rollbackTransaction": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"PutPermissionsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"permissions": {
|
|
"type": "string",
|
|
"example": "\"CREATE_GUARANTOR\":true,\n \"CREATE_CLIENT\":true"
|
|
}
|
|
}
|
|
},
|
|
"GetRolesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Super Users"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "This role provides all application permissions."
|
|
}
|
|
}
|
|
},
|
|
"PostRolesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PostRolesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Another Role Name"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "A description outlining the purpose of this role in relation to the application."
|
|
}
|
|
}
|
|
},
|
|
"GetRolesRoleIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Super Users"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "This role provides all application permissions."
|
|
}
|
|
}
|
|
},
|
|
"PostRolesRoleIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"GetRolesRoleIdPermissionsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Super Users"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"example": "This role provides all application permissions."
|
|
},
|
|
"permissionUsageData": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/GetRolesRoleIdPermissionsResponsePermissionData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetRolesRoleIdPermissionsResponsePermissionData": {
|
|
"type": "object",
|
|
"properties": {
|
|
"grouping": {
|
|
"type": "string",
|
|
"example": "authorisation"
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"example": "READ_PERMISSION"
|
|
},
|
|
"entityName": {
|
|
"type": "string",
|
|
"example": "PERMISSION"
|
|
},
|
|
"actionName": {
|
|
"type": "string",
|
|
"example": "READ"
|
|
},
|
|
"selected": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"PostRolesRoleIdPermissionsResponsePermissions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"ALL_FUNCTIONS_READ": {
|
|
"type": "string",
|
|
"example": "true"
|
|
}
|
|
}
|
|
},
|
|
"PutRolesRoleIdPermissionsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 8
|
|
},
|
|
"permissions": {
|
|
"$ref": "#/definitions/PostRolesRoleIdPermissionsResponsePermissions"
|
|
}
|
|
}
|
|
},
|
|
"PutRolesRoleIdPermissionsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"permissions": {
|
|
"$ref": "#/definitions/PostRolesRoleIdPermissionsResponsePermissions"
|
|
}
|
|
}
|
|
},
|
|
"DeleteRolesRoleIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"PutRolesRoleIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutRolesRoleIdResponseChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutRolesRoleIdResponseChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"description": {
|
|
"type": "string",
|
|
"example": "some description(changed)"
|
|
}
|
|
}
|
|
},
|
|
"PutRolesRoleIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"description": {
|
|
"type": "string",
|
|
"example": "some description(changed)"
|
|
}
|
|
}
|
|
},
|
|
"GetUsersTemplateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"allowedOffices": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/OfficeData"
|
|
}
|
|
},
|
|
"availableRoles": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/RoleData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetUsersResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"username": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"firstname": {
|
|
"type": "string",
|
|
"example": "App"
|
|
},
|
|
"lastname": {
|
|
"type": "string",
|
|
"example": "Administrator"
|
|
},
|
|
"email": {
|
|
"type": "string",
|
|
"example": "demomfi@mifos.org"
|
|
},
|
|
"passwordNeverExpires": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"staff": {
|
|
"$ref": "#/definitions/StaffData"
|
|
},
|
|
"selectedRoles": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/RoleData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GetUsersUserIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"username": {
|
|
"type": "string",
|
|
"example": "mifos"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"officeName": {
|
|
"type": "string",
|
|
"example": "Head Office"
|
|
},
|
|
"firstname": {
|
|
"type": "string",
|
|
"example": "App"
|
|
},
|
|
"lastname": {
|
|
"type": "string",
|
|
"example": "Administrator"
|
|
},
|
|
"email": {
|
|
"type": "string",
|
|
"example": "demomfi@mifos.org"
|
|
},
|
|
"passwordNeverExpires": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"staff": {
|
|
"$ref": "#/definitions/StaffData"
|
|
},
|
|
"availableRoles": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/RoleData"
|
|
}
|
|
},
|
|
"selectedRoles": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/RoleData"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PutUsersUserIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 11
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/PutUsersUserIdResponseChanges"
|
|
}
|
|
}
|
|
},
|
|
"PutUsersUserIdResponseChanges": {
|
|
"type": "object",
|
|
"properties": {
|
|
"firstname": {
|
|
"type": "string",
|
|
"example": "Test"
|
|
},
|
|
"passwordEncoded": {
|
|
"type": "string",
|
|
"example": "abc3326b1bb376351c7baeb4175f5e0504e33aadf6a158474a6d71de1befae51"
|
|
}
|
|
}
|
|
},
|
|
"PutUsersUserIdRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"firstname": {
|
|
"type": "string",
|
|
"example": "Test"
|
|
},
|
|
"password": {
|
|
"type": "string",
|
|
"example": "window75"
|
|
},
|
|
"repeatPassword": {
|
|
"type": "string",
|
|
"example": "window75"
|
|
}
|
|
}
|
|
},
|
|
"DeleteUsersUserIdResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 11
|
|
},
|
|
"changes": {
|
|
"$ref": "#/definitions/DeleteUsersUserIdResponseChanges"
|
|
}
|
|
}
|
|
},
|
|
"DeleteUsersUserIdResponseChanges": {
|
|
"type": "object"
|
|
},
|
|
"PostUsersResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"resourceId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 11
|
|
}
|
|
}
|
|
},
|
|
"PostUsersRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"username": {
|
|
"type": "string",
|
|
"example": "newuser"
|
|
},
|
|
"firstname": {
|
|
"type": "string",
|
|
"example": "Test"
|
|
},
|
|
"lastname": {
|
|
"type": "string",
|
|
"example": "User"
|
|
},
|
|
"email": {
|
|
"type": "string",
|
|
"example": "whatever@mifos.org"
|
|
},
|
|
"officeId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"staffId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"Roles": {
|
|
"type": "string",
|
|
"example": "[2,3]"
|
|
},
|
|
"sendPasswordToEmail": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"isSelfServiceUser": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} |