Welcome

This documentation was last updated on Thu Oct 3 11:26:42 UTC 2024 and covers Mambu Version v9.165.4

Welcome to the Mambu API v1 Reference documentation.

About Mambu API v1

Scroll down for operations, schemas, example requests and responses.

Mambu API v1 is a fully compliant REST API and in this API Reference we provide you with all the necessary information to work with it.

Base URLs

The base URL for API requests is:

https://TENANT_NAME.mambu.com/api

Replace TENANT_NAME above with the tenant name in your Mambu tenant URL.

To make API requests to your tenant's sandbox, use the following base URL:

https://TENANT_NAME.sandbox.mambu.com/api

For more information, see the Sandbox section.

HTTP Verbs

Standard HTTP verbs are used to indicate the API request method.

Verb	Function
`GET`	To retrieve a resource or a collection of resources
`POST`	To create a resource
`PATCH`	To modify an existing resource
`PUT`	To replace an existing resource
`DELETE`	To delete a resource

Authentication

Mambu supports two methods for authenticating API requests:

Basic authentication, using Mambu UI login credentials for a user account with API access permissions.
API keys, which are unique UUID tokens provided in an apiKey header (Early Access Feature).

Basic Authentication

Example using curl

curl --location --request GET 'https://TENANT_NAME.mambu.com/api/users' \
--header 'Authorization: Basic U29tZVVzZXI6T3BlblNlc2FtZQ=='

For basic authorization, provide your username and password directly via the Authorization header in the format Basic {base64-encoded-string}, where base64-encoded-string is the base-64-encoded value of your username and password separated by a colon ':'.

For example, a user with the username SomeUser and the password OpenSesame would take the value SomeUser:OpenSesame and base-64 encode it, yielding U29tZVVzZXI6T3BlblNlc2FtZQ==. They would then provide an Authorization header for their request with the value Basic U29tZVVzZXI6T3BlblNlc2FtZQ==.

See the example GET requests to the /users endpoint using curl.

Note that the login credentials must be for an account with API access permissions. For more information, see Creating a User - Access Rights in our User Guide.

API Keys

API keys are tokens that you provide in an apiKey header to authenticate requests. They are generated by API consumers, which are an abstraction similar to an OAuth client.

API consumers are currently an Early Access Feature. If you would like to request access to this feature, please get in touch with your Mambu Customer Success Manager to discuss your requirements.

For more information on API consumers and keys, see API Consumers in our User Guide.

Payloads

Mambu API v1 has endpoints that usually accept and return only application/json. When making a POST, PUT, or PATCH request that sends data through a JSON body, you must set the Content-Type header to application/json. When making a POST request that sends data through query parameters, the Content-Type header must not be set.

Requests

API requests (also known as API calls) to the Mambu API identify who the requester is and exactly what information they wish to retrieve or which action they wish to perform.

To put together an API Request you will need to combine:

The HTTP verb
The full URI to the resource
HTTP headers, for example, headers for authentication and payload content types
The JSON-formatted payload (if required)

Responses

Error Response

{
  "errorCode":"4",
  "errorSource":"Property scheduleSettings.repaymentInstallments may not be null",
  "errorReason":"INVALID_PARAMETERS"
}

Single Resource - JSON object

{
  "field": "value"
}

Collection of Resources - JSON array

[
  {
    "field": "value"
  },
  {
    "field": "value"
  }
]

The response to a request will contain either the JSON-formatted payload or an error response.

Error response

An error response will consist of:

Field	Type	Availability	Content
`errorCode`	number	Always present	A unique error code. For more information, see API Responses and Error Codes.
`errorSource`	string	Sometimes present	A human-readable message capturing unsatisfied constraints.
`errorReason`	string	Always present	A human-readable message stating the general category of the failure.

The contents of the errorSource and ErrorResponse fields are subject to change without backwards compatibility.

Sandbox

The sandbox tenant (also known as sandbox environment) is independent from the production tenant, and any changes you make in the sandbox will not affect the data in your production tenant. For more information, see Sandbox in our User Guide.

To make requests to your tenant's sandbox, use the following base URL:

https://TENANT_NAME.sandbox.mambu.com/api/

The sandbox is generally one version ahead of the production tenant. As such, it may include changes that are currently in, or may soon be in, the production environment. For more information, see Mambu Release Cycle.

Sandbox management

To manage your sandbox go to the Customer Service Portal. For more information and instructions, see Customer Service Portal - Sandbox Management.

Pagination

To customize the response, the offset and limit parameters can be adjusted from their default values.

`limit`

The default limit for responses is 50. A value of up to 1,000 can be specified with limit.

`offset`

offset determines how many records will be skipped before being included in the returned results. The default offset value is 0.

Detail Level

Some Mambu API v1 endpoints support two levels of detail for responses, basic details and full details. To retrieve a response in full details, you must set the fullDetails query parameter to true.

Basic details

By default, Mambu API v1 will return basic details, this includes all first level elements of an object.

Full details

Some endpoints can return full details, this includes everything from basic details as well as all custom field values, any address or contact information, and any other related objects.

Audit Trail and the User-Agent Header

Error when User Agent header is not provided

{
  "errors": [
    {
      "errorCode": 4,
      "errorSource": "The user agent cannot be null when the Audit Trail feature is enabled",
      "errorReason": "INVALID_PARAMETERS"
    }
  ]
}

Audit trail tracks all activities performed in the Mambu Core Banking system via the UI or API v1 and v2. For more information, see Audit Trail in our User Guide.

When the audit trail feature is enabled, you must provide a User-Agent header for all requests to any endpoint, or the request will fail with the error message The user agent cannot be null when the Audit Trail feature is enabled.

Note that if you are using a REST client like Postman or Curl, this header is probably provided automatically. However, if you generate a request to the API, you must provide it yourself.

The User-Agent header provides information regarding the browser and operating system (such as the browser version), and information about the library or tool issuing the request (such as the client Java version). It is generally used to assist with debugging problems.

Posting Data

API requests that post data can either use URL-encoded query parameters or a JSON body to enter data. The Content-Type header must be set to application/json for the JSON request.

Please be Aware: GET and POST requests using query parameters should always use url-encoding for parameter values to make sure any special characters are properly escaped and do not cause errors or loss of information.

The examples to the right, show the two methods for posting data. Note that for some requests, much more information can be posted using the JSON input than is available with query parameters.

Using query parameters

curl -d "type=APPROVAL" https://user:pword@test.mambu.com/api/loans/4028329c3ad6c515013ad6d0f6e40006/transactions

Using JSON:

curl -H "Accept: application/json" -H "Content-Type: application/json" -X POST -d '{ "type": "APPROVAL"} https://user:pword@test.mambu.com/api/loans/4028329c3ad6c515013ad6d0f6e40006/transactions`

Example

The example to the right makes a request using the username user, the password pword to the tenant demo to retrieve all repayments for loan account abc

Request with authorization made ...

https://user:pword@demo.mambu.com/api/loans/abc/repayments

And returns a response such as:

[
    {
        "encodedKey": "402832b4380a2d8801380a9cac860010",
        "parentAccountKey": "402832b4380a2d8801380a9cac41000f",
        "dueDate": "2012-07-28T00:00:00+0200",
        "principalDue": "190",
        "principalPaid": "0",
        "interestDue": "25.45",
        "interestPaid": "0",
        "state": "PENDING"
    },
    {
        "encodedKey": "402832b4380a2d8801380a9cac870011",
        "parentAccountKey": "402832b4380a2d8801380a9cac41000f",
        "dueDate": "2012-08-28T00:00:00+0200",
        "principalDue": "190",
        "principalPaid": "0",
        "interestDue": "26.29",
        "interestPaid": "0",
        "state": "PENDING"
    }
]

Searching and Filtering

Many entities allow you multiple ways to filter your request, either by providing fields and values as query parameters or by using the entity's /search facility. This option is available for: Clients, Groups, Loan Accounts & Loan Transactions, Savings Accounts & Savings Transactions, Notifications, General Ledger Journal Entries and Lines of Credit.

Additionally, the object search API allows you to execute the same search query across multiple types of entity, for example, both loan and savings accounts, or both users and clients, although the number of fields which will be searched is limited.

In each case you will use a POST request and provide your search parameters and sorting preference in the request body, while other constraints, such as the number of records to return, an offset to page through large result sets, or whether you would like full details or only basic data, can be provided as query parameters.

Filter Constraints

Example query with an array of filters on a standard field and a custom field definition and its value, and a sorting order

{
   "filterConstraints":[
      {
         "filterSelection":"CREATION_DATE",
         "filterElement":"BETWEEN",
         "value":"2015-01-01",
         "secondValue":"2015-06-20"
      },
      {
         "filterSelection":"MY_CUSTOM_FIELD",
         "filterElement":"EQUALS",
         "dataItemType":"CLIENT",
         "dataFieldType":"CUSTOM",
         "value":"BIG spenders"
      }
   ],
   "sortDetails":{
        "sortingColumn":"lastModifiedDate",
        "sortingOrder":"DESCENDING"
    }
}

`filterContraints` array

Parameter	Value
filterSelection	The field on which the constraint will be applied. For custom fields, the custom field definition encoded key must be provided.
filterElement	The constraint operator. Available filter elements can be found below.
value	The constraint value. Required for filter elements with one or two values.
secondValue	The constraint second value. Required for filter elements with two values.
dataItemType	The entity where the field on which to apply the constraint is located. If the field is located in the same entity with the entity being searched, this field is optional. Possible values: CLIENT - can be used for client/loans/savings/transactions endpoints GROUP - can be used for group/loans/savings/transactions endpoints LOANS - can be used for loans/transactions endpoints TRANCHE - can be used for loans endpoint DISBURSEMENT_DETAILS - can be used for loans/transactions endpoints SAVINGS - can be used savings/transactions endpoints TRANSACTION - cab be used for transactions/gljournalentries endpoint JOURNAL_ENTRY - can be used for gljournalentries endpoint NOTIFICATION_MESSAGE - can be used only for notification messages
dataFieldType	`NATIVE`(default)/`CUSTOM` for custom field definition searches

`sortDetails` object

Parameter	Value
sortingColumn	The name of the column on which the order is going to take place
sortingOrder	The order in which your results should be presented, either `ASCENDING` or `DESCENDING`

The table below contains a list of filters available for your search and which types of data you can use them with.

Filter Element	Number Of affected values	Available for
`EQUALS`	`ONE_VALUE`	`BIG_DECIMAL`,`BOOLEAN`,`LONG`,`MONEY`,`NUMBER`,`PERCENT`,`STRING`,`ENUM`,`KEY`
`MORE_THAN`	`ONE_VALUE`	`BIG_DECIMAL`,`NUMBER`,`MONEY`
`LESS_THAN`	`ONE_VALUE`	`BIG_DECIMAL`,`NUMBER`,`MONEY`
`BETWEEN`	`TWO_VALUES`	`BIG_DECIMAL`,`NUMBER`,`MONEY`,`DATE`,`DATE_UTC`
`ON`	`ONE_VALUE`	`DATE`,`DATE_UTC`
`AFTER`	`ONE_VALUE`	`DATE`,`DATE_UTC`
`BEFORE`	`ONE_VALUE`	`DATE`,`DATE_UTC`
`STARTS_WITH`	`ONE_VALUE`	`STRING`
`IN`	`LIST`	`ENUM` - When using the filter in Mambu default selection fields (for example, `ACCOUNT_STATE`) the names of the options (e.g. `ACTIVE` or `APPROVED`) may be used. `KEY` - When using the filter in custom field definitions, the encoded key of the custom field definition must be used and the names of the available options cannot be used.
`TODAY`	`NO_VALUE`	`DATE`,`DATE_UTC`
`THIS_WEEK`	`NO_VALUE`	`DATE`,`DATE_UTC`
`THIS_MONTH`	`NO_VALUE`	`DATE`,`DATE_UTC`
`THIS_YEAR`	`NO_VALUE`	`DATE`,`DATE_UTC`
`LAST_DAYS`	`ONE_VALUE`	`NUMBER`
`EMPTY`	`NO_VALUE`	`BIG_DECIMAL`,`LONG`,`MONEY`,`NUMBER`,`PERCENT`,`STRING`,`ENUM`,`KEY`,`DATE`,`DATE_UTC`
`NOT_EMPTY`	`NO_VALUE`	`BIG_DECIMAL`,`LONG`,`MONEY`,`NUMBER`,`PERCENT`,`STRING`,`ENUM`,`KEY`,`DATE`,`DATE_UTC`

Data Types and Examples

Clients

Get all loan transactions for a specific client

POST /api/clients/search
{
   "filterConstraints":[
      {
         "filterSelection":"ID",
         "filterElement":"EQUALS",
         "dataItemType":"CLIENT",
         "value":"197495342"
      }
   ],
   "sortDetails":{
      "sortingColumn":"ID",
      "sortingOrder":"DESCENDING"
   }
}

Filter Selection Parameter	Data Type
`CREDIT_OFFICER_KEY`	`KEY`
`CLIENT_ROLE_KEY`	`KEY`
`BRANCH_KEY`	`KEY`
`CENTRE_KEY`	`KEY`
`GROUP_KEY`	`KEY`
`ENCODED_KEY`	`KEY`
`FULL_NAME`	`STRING`
`FIRST_NAME`	`STRING`
`MIDDLE_NAME`	`STRING`
`LAST_NAME`	`STRING`
`CREATION_DATE`	`DATE_UTC`
`LAST_MODIFIED_DATE`	`DATE_UTC`
`ID`	`STRING`
`DEPOSITS_BALANCE`	`MONEY`
`LOANS_BALANCE`	`MONEY`
`PENDING_LOAN_AMOUNT`	`MONEY`
`APPROVED_LOAN_AMOUNT`	`MONEY`
`TOTAL_BALANCE`	`MONEY`
`TOTAL_DUE`	`MONEY`
`HOME_PHONE_NUMBER`	`STRING`
`MOBILE_PHONE_NUMBER`	`STRING`
`EMAIL_ADDRESS`	`STRING`
`CLIENT_ADDRESS`	`STRING`
`BIRTHDATE`	`DATE`
`GENDER`	`ENUM`
`LOAN_CYCLE`	`NUMBER`
`GROUP_LOAN_CYCLE`	`NUMBER`
`CLIENT_STATE`	`ENUM`
`PORTAL_STATE`	`ENUM`
`PREFERRED_LANGUAGE`	`ENUM`
`GROUP_ID`	`STRING`

Groups

Get all groups created in specific date range

POST /api/groups/search
{
   "filterConstraints":[
      {
         "filterSelection":"CREATION_DATE",
         "filterElement":"BETWEEN",
         "value":"2015-01-01",
         "secondValue":"2015-06-20"
      }
   ]
}

Get all groups that have the custom field definition with the encoded key 8afac14a34d69cd00134d70c0abe00d3 and custom field value test

POST /api/groups/search
{
   "filterConstraints":[
      {
         "filterSelection":"8afac14a34d69cd00134d70c0abe00d3",
         "filterElement":"EQUALS",
         "value":"test",
         "dataFieldType":"CUSTOM"
      }
   ]
}

Filter Selection Parameter	Data Type
`CLIENT_ROLE_KEY`	`KEY`
`BRANCH_KEY`	`KEY`
`CENTRE_KEY`	`KEY`
`CREDIT_OFFICER_KEY`	`KEY`
`ENCODED_KEY`	`KEY`
`GROUP_NAME`	`STRING`
`CREATION_DATE`	`DATE_UTC`
`LAST_MODIFIED_DATE`	`DATE_UTC`
`ID`	`STRING`
`PREFERRED_LANGUAGE`	`ENUM`
`DEPOSITS_BALANCE`	`MONEY`
`LOANS_BALANCE`	`MONEY`
`TOTAL_BALANCE`	`MONEY`
`NUMBER_OF_MEMBERS`	`NUMBER`
`LOAN_CYCLE`	`NUMBER`

Loan Accounts

Get all loans that are in two different products

POST /api/loans/search
{
   "filterConstraints":[
      {
         "filterSelection":"PRODUCT_KEY",
         "filterElement":"IN",
         "values":[
            "ff8080814eaa832d014eaa88e24d034c",
            "ad8080814eaa832d014eaa88e252034e"
         ]
      }
   ]
}

Get all loan accounts created within a date range

POST /api/loans/search
{
   "filterConstraints":[
      {
         "filterSelection":"CREATION_DATE",
         "filterElement":"BETWEEN",
         "value":"2015-06-15",
         "secondValue":"2015-06-20"
      }
   ]
}

Get all loan accounts that have the custom field value test. This custom field definition is of type string and it belongs to a loan entity

POST /api/loans/search
{
   "filterConstraints":[
      {
         "filterSelection":"8a808085507f02b901507f02f59700ea",
         "filterElement":"EQUALS",
         "value":"test"
      },
      {
         "filterSelection":"CREATION_DATE",
         "dataItemType":"CLIENT",
         "filterElement":"ON",
         "value":"2015-10-19"
      }
   ]
}

Filter Selection Parameter	Data Type
`ACCOUNT_HOLDER_KEY`	`KEY`
`PRODUCT_KEY`	`KEY`
`LOAN_RISK_LEVEL_KEY`	`KEY`
`ENCODED_KEY`	`KEY`
`LOAN_NAME`	`STRING`
`ACCOUNT_ID`	`STRING`
`ACCOUNT_HOLDER_ID`	`STRING`
`RECIPIENT`	`STRING`
`CREATION_DATE`	`DATE_UTC`
`APPROVAL_DATE`	`DATE`
`LAST_MODIFIED_DATE`	`DATE_UTC`
`LAST_SET_TO_ARREARS_DATE`	`DATE`
`LAST_LOCKED_DATE`	`DATE`
`CLOSED_DATE`	`DATE`
`DAYS_IN_ARREARS`	`NUMBER`
`DAYS_LATE`	`NUMBER`
`ACCOUNT_SUB_STATE`	`ENUM`
`ACCOUNT_STATE`	`ENUM`
`LOAN_AMOUNT`	`MONEY`
`DISBURSED_TRANCHES_AMOUNT`	`MONEY`
`NUM_INSTALLMENTS`	`NUMBER`
`PRINCIPAL_DUE`	`MONEY`
`PRINCIPAL_PAID`	`MONEY`
`PRINCIPAL_BALANCE`	`MONEY`
`INTEREST_DUE`	`MONEY`
`INTEREST_PAID`	`MONEY`
`INTEREST_BALANCE`	`MONEY`
`INTEREST_ACCRUED`	`MONEY`
`FEES_DUE`	`MONEY`
`FEES_BALANCE`	`MONEY`
`FEES_PAID`	`MONEY`
`PENALTY_CALCULATION_METHOD`	`ENUM`
`PENALTY_DUE`	`MONEY`
`PENALTY_PAID`	`MONEY`
`PENALTY_BALANCE`	`MONEY`
`PENALTY_ACCRUED`	`MONEY`
`PENALTY_RATE`	`BIG_DECIMAL`
`ARREARS_TOLERANCE_PERIOD`	`NUMBER`
`INTEREST_RATE`	`BIG_DECIMAL`
`INTEREST_SPREAD`	`BIG_DECIMAL`
`TOTAL_PAID`	`MONEY`
`TOTAL_BALANCE`	`MONEY`
`TOTAL_DUE`	`MONEY`
`FIRST_REPAYMENT_DATE`	`DATE`
`LAST_PAYMENT_DATE`	`DATE`
`LAST_PAYMENT_AMOUNT`	`MONEY`
`EXPECTED_MATURITY_DATE`	`DATE`
`RESCHEDULED_ACCOUNT_ID`	`STRING`
`REFINANCED_ACCOUNT_ID`	`STRING`
`ORIGINAL_ACCOUNT_ID`	`STRING`
`TAX_RATE`	`BIG_DECIMAL`
`TAX_PAID`	`MONEY`
`TAX_DUE`	`MONEY`
`HAS_SETTLEMENT_ACCOUNT`	`BOOLEAN`
`INTEREST_COMMISSION`	`BIG_DECIMAL`
`FUNDS_AMOUNT`	`MONEY`
`FUNDING_PERCENTAGE`	`BIG_DECIMAL`
`NUMBER_OF_FUNDS`	`NUMBER`
`FUNDS_ENABLED`	`BOOLEAN`
`AVAILABLE_AMOUNT`	`MONEY`
`WAS_RESCHEDULED`	`BOOLEAN`
`WAS_REFINANCED`	`BOOLEAN`
`PREPAYMENTS_RECALCULATION`	`ENUM`
`APPLY_INTEREST_ON_PREPAYMENT_METHOD`	`ENUM`
`LATE_PAYMENT_RECALCULATION_METHOD`	`ENUM`
`REDRAW_BALANCE`	`MONEY`
`EXPECTED_PRINCIPAL_REDRAW`	`MONEY`

Tranches

Get all loan accounts where loan disbursement tranches have been defined but not yet disbursed

POST /api/loans/search
{
   "filterConstraints":[
      {
         "filterSelection":"DISBURSEMENT_TRANSACTION_KEY",
         "dataItemType":"TRANCHE",
         "filterElement":"EMPTY"
      }
   ]
}

Get all loan accounts with a loan disbursement tranche where the amount is 100

POST /api/loans/search
{
   "filterConstraints":[
      {
         "filterSelection":"AMOUNT",
         "dataItemType":"TRANCHE",
         "filterElement":"EQUALS",
         "value":"100"
      }
   ]
}

Filter Selection Parameter	Data Type
`ENCODED_KEY`	`KEY`
`PARENT_ACCOUNT_KEY`	`KEY`
`DISBURSEMENT_TRANSACTION_KEY`	`KEY`
`AMOUNT`	`MONEY`
`EXPECTED_DISRBUSEMENT_DATE`	`DATE`

Disbursement Details

Get all loans disbursed during March 2021

POST /api/loans/search
{
   "filterConstraints":[
      {
         "filterSelection":"DISBURSEMENT_DATE",
         "dataItemType":"DISBURSEMENT_DETAILS",
         "filterElement":"BETWEEN",
         "value":"2021-03-01",
         "secondValue":"2021-03-30"
      }
   ]
}

Filter Selection Parameter	Data Type
`EXPECTED_DISBURSEMENT_DATE`	`DATE`
`DISBURSEMENT_DATE`	`DATE`

Savings Accounts

Get all APPROVED and PENDING_APPROVAL savings accounts

POST /api/savings/search
{
   "filterConstraints":[
      {
         "filterSelection":"ACCOUNT_STATE",
         "filterElement":"IN",
         "values":[
            "PENDING_APPROVAL",
            "APPROVED"
         ]
      }
   ]
}

Filter Selection Parameter	Data Type
`ACCOUNT_HOLDER_KEY`	`KEY`
`PRODUCT_KEY`	`KEY`
`CURRENCY_CODE`	`KEY`
`OVERDRAFT_RISK_LEVEL_KEY`	`KEY`
`ENCODED_KEY`	`KEY`
`ACCOUNT_ID`	`STRING`
`ACCOUNT_HOLDER_ID`	`STRING`
`RECIPIENT`	`STRING`
`CREATION_DATE`	`DATE_UTC`
`APPROVAL_DATE`	`DATE`
`ACTIVATION_DATE`	`DATE`
`LAST_MODIFIED_DATE`	`DATE_UTC`
`MATURITY_DATE`	`DATE`
`CLOSED_DATE`	`DATE`
`ACCOUNT_STATE`	`ENUM`
`ACCOUNT_NAME`	`STRING`
`RECOMENDED_DEPOSIT_AMOUNT`	`MONEY`
`DEPOSIT_AMOUNT`	`MONEY`
`MAX_WITHDRAWAL_AMOUNT`	`MONEY`
`TARGET_AMOUNT`	`MONEY`
`BALANCE`	`MONEY`
`MAX_BALANCE`	`MONEY`
`ACCRUED_INTEREST`	`MONEY`
`INTEREST_RATE`	`BIG_DECIMAL`
`OVERDRAFT_INTEREST_ACCRUED`	`MONEY`
`OVERDRAFT_AMOUNT`	`MONEY`
`OVERDRAFT_EXPIRY_DATE`	`DATE`
`LAST_SET_TO_ARREARS_DATE`	`DATE`
`OVERDRAFT_INTEREST_RATE`	`BIG_DECIMAL`
`OVERDRAFT_INTEREST_SPREAD`	`BIG_DECIMAL`
`OVERDRAFT_LIMIT`	`MONEY`
`OVERDRAFT_AVAILABLE_LIMIT`	`MONEY`
`OVERDRAFT_IN_ARREARS`	`MONEY`
`OVERDRAFT_DAYS_IN_ARREARS`	`NUMBER`
`INTEREST_DUE`	`MONEY`
`FEES_DUE`	`MONEY`
`LENGTH_IN_DAYS`	`NUMBER`
`ACCOUNT_TYPE`	`ENUM`
`CURRENT_INTEREST_TIER_INDEX`	`NUMBER`
`CURRENT_INTEREST_TIER_STARTING_BALANCE`	`MONEY`
`CURRENT_INTEREST_TIER_ENDING_BALANCE`	`MONEY`
`CURRENT_INTEREST_TIER_RATE`	`BIG_DECIMAL`
`CURRENT_OVERDRAFT_INTEREST_TIER_INDEX`	`NUMBER`
`CURRENT_OVERDRAFT_INTEREST_TIER_STARTING_BALANCE`	`MONEY`
`CURRENT_OVERDRAFT_INTEREST_TIER_ENDING_BALANCE`	`MONEY`
`CURRENT_OVERDRAFT_INTEREST_TIER_RATE`	`BIG_DECIMAL`
`TAX_APPLIED`	`MONEY`
`TAX_RATE`	`BIG_DECIMAL`

Transactions

Get the repayments transactions for loans that are more than 10 days in arrears

POST /api/loans/transactions/search
{
   "filterConstraints":[
      {
         "filterSelection":"DAYS_IN_ARREARS",
         "filterElement":"MORE_THAN",
         "dataItemType":"LOANS",
         "value":"10"
      },
      {
         "filterSelection":"EVENT",
         "filterElement":"EQUALS",
         "dataItemType":"LOAN_TRANSACTION",
         "value":"REPAYMENT"
      }
   ]
}

Filter Selection Parameter	Data Type
`PARENT_ACCOUNT_KEY`	`KEY`
`PRODUCT_TYPE_KEY`	`KEY`
`USER_KEY`	`KEY`
`BRANCH_KEY`	`KEY`
`CENTRE_KEY`	`KEY`
`PARENT_ACCOUNT_HOLDER_KEY`	`KEY`
`CURRENCY_CODE`	`KEY`
`PRODUCT_ID`	`STRING`
`WAS_REVERSED`	`BOOLEAN`
`TYPE_IS_REVERSAL`	`BOOLEAN`
`INTERNAL_TRANSFER`	`BOOLEAN`
`TRANSACTION_CHANNEL_KEY`	`KEY`
`ENCODED_KEY`	`KEY`
`TRANSACTION_ID`	`LONG`
`TILL_ID`	`STRING`
`ENTRY_DATE`	`DATE`
`TRANSACTION_DATE`	`DATE_UTC`
`EVENT`	`ENUM`
`AMOUNT`	`MONEY`
`ADVANCE_POSITION`	`MONEY`
`ARREARS_POSITION`	`MONEY`
`EXPECTED_PRINCIPAL_REDRAW`	`MONEY`
`ORIGINAL_AMOUNT`	`MONEY`
`ORIGINAL_AMOUNT_CURRENCY_CODE`	`STRING`
`BALANCE` (Deprecated. Use `TOTAL_BALANCE`)	`MONEY`
`TOTAL_BALANCE`	`MONEY`
`PRINCIPAL_BALANCE`	`MONEY`
`REDRAW_BALANCE`	`MONEY`
`PRINCIPAL_PAID`	`MONEY`
`INTEREST_PAID`	`MONEY`
`DEFERRED_INTEREST`	`MONEY`
`FEES_PAID`	`MONEY`
`FEE_KEY`	`KEY`
`FEE_TYPE`	`ENUM`
`PENALTY_PAID`	`MONEY`
`BRANCH`	`STRING`
`CENTRE`	`STRING`
`PARENT_ACCOUNT`	`STRING`
`PARENT_ACCOUNT_ID`	`STRING`
`PARENT_ACCOUNT_HOLDER`	`STRING`
`PARENT_ACCOUNT_HOLDER_ID`	`STRING`
`TAX_RATE`	`BIG_DECIMAL`
`TAX_AMOUNT`	`MONEY`
`INTEREST_RATE`	`BIG_DECIMAL`
`PRINCIPAL_PAYMENT_FLAT_AMOUNT`	`MONEY`
`PRINCIPAL_PAYMENT_PERCENTAGE`	`BIG_DECIMAL`
`TOTAL_DUE_FLAT_AMOUNT`	`MONEY`
`TOTAL_BALANCE_PERCENTAGE`	`BIG_DECIMAL`
`OVERDRAFT_INTEREST_RATE`	`BIG_DECIMAL`
`OVERDRAFT_LIMIT`	`MONEY`

Notifications

Get all notification messages for LOAN_CREATED notifications

POST /api/notifications/messages/search
{
   "filterConstraints":[
      {
         "filterSelection":"EVENT",
         "filterElement":"EQUALS",
         "value":"LOAN_CREATED"
      }
   ]
}

Filter Selection Parameter	Data Type
`SENDER_KEY`	`KEY`
`RECIPIENT_CLIENT_KEY`	`KEY`
`RECIPIENT_GROUP_KEY`	`KEY`
`RECIPIENT_USER_KEY`	`KEY`
`ENCODED_KEY`	`KEY`
`CREATION_DATE`	`DATE_UTC`
`SENT_DATE`	`DATE_UTC`
`STATE`	`ENUM`
`FAILURE_REASON`	`ENUM`
`DESTINATION`	`STRING`
`TYPE`	`ENUM`
`EVENT`	`ENUM`

General Ledger Journal Entries

Get the journal entry with entry id 1, posted by the user with the encoded key 8a8080a254a9659b0154a965a69a0004

POST /api/gljournalentries/search
{
     "filterConstraints":[
        {
           "filterSelection":"USER_KEY",
           "filterElement":"EQUALS",
           "value":"8a8080a254a9659b0154a965a69a0004"
        },
        {
           "filterSelection":"ENTRY_ID",
           "filterElement":"EQUALS",
           "value":"1"
        }
    ]
}

Filter Selection Parameter	Data Type
`PRODUCT_TYPE`	`ENUM`
`GL_ACCOUNT_KEY`	`KEY`
`USER_KEY`	`KEY`
`ENCODED_KEY`	`STRING`
`ENTRY_ID`	`NUMBER`
`DATE`	`DATE`
`CREATION_DATE`	`DATE`
`TRANSACTION_ID`	`STRING`
`GL_ACCOUNT_ID`	`STRING`
`GL_ACCOUNT_TYPE`	`ENUM`
`SOURCE`	`ENUM`
`DEBIT`	`MONEY`
`CREDIT`	`MONEY`

Lines of Credit

Get all lines of credit identified by state CLOSED

POST /api/linesofcredit/search
{
   "filterConstraints":[
      {
         "filterSelection":"STATE",
         "filterElement":"IN",
         "values":[
            "CLOSED"
         ]
      }
   ]
}

Get all lines of credit identified by exposure limit types APPROVED_AMOUNT and OUTSTANDING_AMOUNT

POST /api/linesofcredit/search
{
   "filterConstraints":[
      {
         "filterSelection":"EXPOSURE_LIMIT_TYPE",
         "filterElement":"IN",
         "values":[
            "APPROVED_AMOUNT","OUTSTANDING_AMOUNT"
         ]
      }
   ]
}

Filter Selection Parameter	Data Type
`ID`	`STRING`
`START_DATE`	`DATE`
`EXPIRY_DATE`	`DATE`
`APPROVAL_DATE`	`DATE`
`STATE`	`ENUM`
`SUBSTATE`	`ENUM`
`EXPOSURE_LIMIT_TYPE`	`ENUM`

Object Search

Search through all object types for the object that might contain john

GET /api/search?query=john&type=[CLIENT,USER]&limit=10

{
  "CLIENT": [
    {
      "selectionType": "CLIENT",
      "displayString": "John Demo",
      "resultID": "517706810",
      "resultKey": "8a42711a4428c1f101442a1bbcbc0009"
    },
    {
      "selectionType": "CLIENT",
      "displayString": "John Master",
      "resultID": "603117506",
      "resultKey": "8a42711a4428c1f101442a1ee710001b"
    }
  ],
  "CREDIT_OFFICER": [
    {
      "selectionType": "CREDIT_OFFICER",
      "displayString": "johnty billingsworth",
      "resultID": "johntybilling",
      "resultKey": "8a19dab474909bc8017490f2fb9006a8"
    }
  ],
  "USER": [
    {
      "selectionType": "USER",
      "displayString": "John Doe",
      "resultID": "61",
      "resultKey": "8a54e5b44449337f01444b03efa3000e"
    }
  ],
  "SAVINGS_ACCOUNT": [],
  "CUSTOM_FIELD_SELECTION": [],
  "CENTRE": [],
  "FILTER_CUSTOM_FIELD_SELECTION": [],
  "BRANCH": [],
  "LOAN_ACCOUNT": [],
  "GROUP": [],
  "LINE_OF_CREDIT": []
}

Object type	Keyword fields
`CLIENT`	first name, middle name, last name, id
`GROUP`	group name, id
`LOAN_ACCOUNT`	account id
`SAVINGS_ACCOUNT`	account id
`USER`	first name, last name, username
`BRANCH`	branch name, branch id
`CENTRE`	centre name, centre id

Custom View Filtering

Custom views are used to define and display specific groups or subsets of clients, users, loan accounts, and other entities. Examples of custom views include:

Listing all clients in an active state.
Listing all loan accounts that are 90 days in arrears.
Listing all the withdrawal transactions higher than USD700,000.

Custom views may be used to configure tabs and reports in the Mambu UI. Once they are defined, they may also be used to filter requests with the Mambu v1 API. Several GET requests allow filtering the returned results with the criteria defined by an existing custom view. This can be a quick and convenient way to easily filter requests.

For more information on using custom views to filter requests, see Custom Views and API v1 in our User Guide. For general infromation, see Custom Views.

Timezone Offsets

Here is how we handle timezone offsets in API v1 calls:

We use the following standard date format: ISO_8601_FORMAT_DATE_TIME = "YYYY-MM-DD'T'hh:mm:ss±hh:mm".
We either save the date as it is or extract the offset value if it contains an offset.
Unlike in API v2, in API v1 we don’t validate the timezone.

Example

Each Mambu tenant has one timezone. Let’s take for example tenants in the East European time zone (UTC+02:00).

Date and time of request	What is saved in the database
2021-03-09T13:37:50	2021-03-09 13:37:50
2021-03-09T13:37:50+02:00	2021-03-09 11:37:50

Please Note

When posting a transaction in the present, the current offset should be used, according to the tenant’s time zone.

When posting a backdated transaction, the offset which was correct for that date and time should be used, according to the tenant’s time zone.

When posting a transaction in the future, the future offset should be used, according to the tenant’s time zone.

If your country uses Daylight Saving Time, posting transactions that occur during 'lost' hours, for example between 02:00:00 a.m. CEST and 2:59:59 a.m. CEST, will be allowed as the timestamp will not be validated, however, this can create timestamps that don’t actually exist, which may lead to unexpected errors if exporting or synchronising data to other systems which do validate timezones and time offsets. We also generally recommend not processing API calls during the minutes leading up to and after the switchover as small differences in clock synchronisation across various systems and services may lead to unexpected errors.

Activities

Allows you to retrieve the activity feed items.

Get all Activities

GET /activities

Get activities

Allows retrieving a list of activities entries within a date range that can be fitered by entity key.

Parameters

Name	Type	Description	In
from (required)	string	From (start) date to retreive activities from.	query
to (required)	string	To (end) date to retreive the activities from.	query
clientID	string	The client key to filter activities on.	query
groupID	string	The group key to filter activities on.	query
centreID	string	The centre key to filter activities on.	query
branchID	string	The branch key to filter activities on.	query
loanProductID	string	The loan product key to filter activities on.	query
savingsProductID	string	The savings product key to filter activities on.	query
loanAccountID	string	The loan account key to filter activities on.	query
savingsAccountID	string	The savings account key to filter activities on.	query
userID	string	The user key to filter activities on.	query
offset	integer	Determines how many records will be skipped before being included in the returned results. The default offset value is 0.	query
limit	integer	The maximum number of records to return.	query

Example Responses

200 : OK
An array of activities

[
  {
    "activity": {
      "encodedKey": "8a54e5b444441eba014445e18c640021",
      "transactionID": 1656,
      "timestamp": "2014-02-18T16:43:33+0000",
      "type": "TASK_DELETED",
      "branchKey": "8a33ae49441c4fe101441c713b36000e",
      "userKey": "8a33ae49441c4fe101441c5fe42f0005",
      "assignedUserKey": "8a33ae49441c4fe101441c5fe42f0005",
      "notes": "Disburse your first loan",
      "fieldChanges": []
    },
    "branchName": "Matola City",
    "userName": "Max Power"
  },
  {
    "activity": {
      "encodedKey": "8a54e5b444441eba0144477140920028",
      "transactionID": 1657,
      "timestamp": "2014-02-19T00:00:08+0000",
      "type": "LOAN_ACCOUNT_SET_TO_IN_ARREARS",
      "clientKey": "8a33ae49441c4fe101441c7149e00102",
      "loanProductKey": "8a33ae494420ac160144210c0be50152",
      "loanAccountKey": "8a42711a4430587d0144307a352d0001",
      "notes": "",
      "fieldChanges": []
    },
    "clientName": "Kwemto Akobundu",
    "loanProductName": "dynamic dbei horizontal",
    "loanAccountName": "dynamic dbei horizontal"
  },
  {
    "activity": {
      "encodedKey": "8a54e5b44449337f014449337f130000",
      "transactionID": 1661,
      "timestamp": "2014-02-19T08:11:54+0000",
      "type": "USER_LOGGED_IN",
      "branchKey": "8a33ae49441c4fe101441c713b36000e",
      "userKey": "8a33ae49441c4fe101441c5fe42f0005",
      "assignedUserKey": "8a33ae49441c4fe101441c5fe42f0005",
      "notes": "",
      "fieldChanges": []
    },
    "branchName": "Matola City",
    "userName": "Max Power"
  },
  {
    "activity": {
      "encodedKey": "8a54e5b44449337f0144498ce4430004",
      "transactionID": 1665,
      "timestamp": "2014-02-19T09:49:34+0000",
      "type": "USER_LOGGED_IN",
      "branchKey": "8a33ae49441c4fe101441c713b36000e",
      "userKey": "8a33ae49441c4fe101441c5fe42f0005",
      "assignedUserKey": "8a33ae49441c4fe101441c5fe42f0005",
      "notes": "",
      "fieldChanges": []
    },
    "branchName": "Matola City",
    "userName": "Max Power"
  },
  {
    "activity": {
      "encodedKey": "8a54e5b44449337f014449a978650005",
      "transactionID": 1666,
      "timestamp": "2014-02-19T10:20:47+0000",
      "type": "CLIENT_EDITED",
      "clientKey": "8a33ae49441c4fe101441c71497200e3",
      "userKey": "8a33ae49441c4fe101441c5fe42f0005",
      "notes": "",
      "fieldChanges": [
        {
          "id": 331,
          "fieldChangeName": "NAME",
          "originalValue": "Adaoha Samuel",
          "newValue": "Adaoha z Samuel"
        }
      ]
    },
    "clientName": "Adaoha z Samuel",
    "userName": "Max Power"
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[activity]	[an activity is an action that has taken place, either initiated by a user or the mambu system]	none
» activity	activity	an activity is an action that has taken place, either initiated by a user or the mambu system	none
»» activity	object	an object containing details about the activity	none
»»» activityChanges	[any]	none	none
»»» assignedCentreKey	string	the encoded key of the centre an account associated with this activity is assigned to	none
»»» assignedUserKey	string	the encoded key of the user assigned to a task or account associated with this activity	none
»»» branchKey	string	the encoded key fo the branch associated with this activity	none
»»» centreKey	string	the encoded key of the centre associated with this activity	none
»»» clientKey	string	the key for the client associated with this activity	none
»»» encodedKey (required)	string	a unique key for this activity	none
»»» fieldChanges	[object]	an array of field changes detailing any fields which were updated or created by this activity	none
»»»» fieldChangeName	string	The name of the field which changed, note that if the field is a custom field definition this field will indicate `CUSTOM_FIELD_VALUE`, in this case the name of the custom field definition will be given on the `fieldDetailName` key.	none
»»»» fieldDetailKey	string	the encoded key of the custom field definition which changed	none
»»»» fieldDetailName	string	the name of the custom field definition that changed	none
»»»» id	integer	an ID for this change	none
»»»» newValue	string	the new value of the field	none
»»»» originalValue	string	the previous value of the field	none
»»» glAccountKey	string	the encoded key of the general ledger account associated with this activity	none
»»» glAccountsClosureKey	string	the encoded key of the accounting closure associated with this activity	none
»»» groupKey	string	the encoded key of the group associated with this activity	none
»»» lineOfCreditKey	string	the encoded key of the line of credit associated with this activity	none
»»» loanAccountKey	string	the encoded key of the loan account associated with this activity	none
»»» loanProductKey	string	the encoded key of the loan product associated with this activity	none
»»» notes	string	some notes about the activity	none
»»» savingsAccountKey	string	the encoded key of the savings account assoicated with this activity	none
»»» savingsProductKey	string	the encoded key of the savings product associated with this activity	none
»»» taskKey	string	the encoded key of the task associated with this activity	none
»»» timestamp (required)	string(timestamp)	the time at which the activity took place	none
»»» transactionID	integer	an ID for this activity	none
»»» type (required)	activityType	The types of activity which are recorded by the system	none
»»» userKey	string	the encoded key of the Mambu user associated with this activity	none
»» branchName	string	the name of the branch the activity concerns	none
»» centreName	string	the name of the centre the activity concerns	none
»» clientName	string	the name of the client the activity concerns	none
»» groupName	string	the name of the group the activity concerns	none
»» loanAccountName	string	the name of the loan account the activity concerns	none
»» loanProductName	string	the name of the loan product the activity concerns	none
»» savingsAccountName	string	the name of the savings account the activity concerns	none
»» savingsProductName	string	the name of the savings product the activity concerns	none
»» taskName	string	the name of the task the activity concerns	none
»» userName	string	the name of the user the activity concerns	none

Enumerated Values

Property	Value
type	`BRANCH_CREATED`
type	`BRANCH_COMMENT_ADDED`
type	`BRANCH_COMMENT_EDITED`
type	`BRANCH_COMMENT_DELETED`
type	`BRANCH_EDITED`
type	`BRANCH_DELETED`
type	`CENTRE_CREATED`
type	`CENTRE_COMMENT_ADDED`
type	`CENTRE_COMMENT_EDITED`
type	`CENTRE_COMMENT_DELETED`
type	`CENTRE_EDITED`
type	`CENTRE_DELETED`
type	`CLIENT_CREATED`
type	`CLIENT_COMMENT_ADDED`
type	`CLIENT_COMMENT_EDITED`
type	`CLIENT_COMMENT_DELETED`
type	`CLIENT_EDITED`
type	`CLIENT_DELETED`
type	`CLIENT_BRANCH_ASSIGNMENT`
type	`CLIENT_BRANCH_UNASSIGNMENT`
type	`CLIENT_CENTRE_ASSIGNMENT`
type	`CLIENT_CENTRE_UNASSIGNMENT`
type	`CLIENT_CREDIT_OFFICER_ASSIGNMENT`
type	`CLIENT_CREDIT_OFFICER_UNASSIGNMENT`
type	`CLIENT_SET_TO_PENDING`
type	`CLIENT_SET_TO_ACTIVE`
type	`CLIENT_SET_TO_INACTIVE`
type	`CLIENT_SET_TO_BLACKLISTED`
type	`CLIENT_SET_TO_REJECTED`
type	`CLIENT_SET_TO_EXITED`
type	`DATA_IMPORTED`
type	`DATA_IMPORT_APPROVED`
type	`DATA_IMPORT_REVERTED`
type	`DOCUMENT_CREATED`
type	`DOCUMENT_EDITED`
type	`DOCUMENT_DELETED`
type	`PRODUCT_DOCUMENT_TEMPLATE_CREATED`
type	`PRODUCT_DOCUMENT_TEMPLATE_DELETED`
type	`PRODUCT_DOCUMENT_TEMPLATE_EDITED`
type	`FEDERATED_AUTHENTICATION_SETTINGS_EDITED`
type	`ENTITY_CREATED`
type	`ENTITY_EDITED`
type	`ENTITY_DELETED`
type	`GLACCOUNT_CREATED`
type	`GLACCOUNT_EDITED`
type	`GLACCOUNT_DELETED`
type	`GLACCOUNTSCLOSURE_EXECUTED`
type	`GLACCOUNTSCLOSURE_UNDONE`
type	`CLIENT_JOINED_GROUP`
type	`CLIENT_LEFT_GROUP`
type	`GROUP_CREATED`
type	`GROUP_COMMENT_ADDED`
type	`GROUP_COMMENT_EDITED`
type	`GROUP_COMMENT_DELETED`
type	`GROUP_EDITED`
type	`GROUP_DELETED`
type	`GROUP_BRANCH_ASSIGNMENT`
type	`GROUP_BRANCH_UNASSIGNMENT`
type	`GROUP_CENTRE_ASSIGNMENT`
type	`GROUP_CENTRE_UNASSIGNMENT`
type	`GROUP_CREDIT_OFFICER_ASSIGNMENT`
type	`GROUP_CREDIT_OFFICER_UNASSIGNMENT`
type	`GROUP_SMS_MESSAGE_SENT`
type	`GROUP_EMAIL_MESSAGE_SENT`
type	`HOLIDAY_SETTINGS_CHANGED`
type	`LINE_OF_CREDIT_CREATED`
type	`LINE_OF_CREDIT_EDITED`
type	`LINE_OF_CREDIT_DELETED`
type	`ACCOUNT_ADDED_TO_LINE_OF_CREDIT`
type	`ACCOUNT_REMOVED_FROM_LINE_OF_CREDIT`
type	`LINE_OF_CREDIT_CLOSED`
type	`LINE_OF_CREDIT_REOPENED`
type	`LINE_OF_CREDIT_APPROVED`
type	`LINE_OF_CREDIT_SET_TO_PENDING_APPROVAL`
type	`LINE_OF_CREDIT_WITHDRAW`
type	`LINE_OF_CREDIT_REJECT`
type	`LOAN_ACCOUNT_CREATED`
type	`LOAN_ACCOUNT_COMMENT_ADDED`
type	`LOAN_ACCOUNT_COMMENT_EDITED`
type	`LOAN_ACCOUNT_COMMENT_DELETED`
type	`LOAN_ACCOUNT_EDITED`
type	`LOAN_ACCOUNT_SET_TO_PARTIAL`
type	`LOAN_ACCOUNT_SET_TO_PENDING_APPROVAL`
type	`LOAN_ACCOUNT_SET_TO_APPROVED`
type	`LOAN_ACCOUNT_SET_TO_CLOSED_CANCELLED`
type	`LOAN_ACCOUNT_SET_TO_CLOSED_REJECTED`
type	`LOAN_ACCOUNT_SET_TO_CLOSED_REFINANCED`
type	`LOAN_ACCOUNT_SET_TO_CLOSED_RESCHEDULED`
type	`LOAN_ACCOUNT_SET_TO_CLOSED_WRITTEN_OFF`
type	`LOAN_ACCOUNT_SET_TO_ACTIVE`
type	`LOAN_ACCOUNT_DISBURSED`
type	`TRANCHE_DISBURSED`
type	`TRANCHE_REVERSED`
type	`LOAN_ACCOUNT_SET_TO_IN_ARREARS`
type	`LOAN_ACCOUNT_DELETED`
type	`LOAN_GROUP_DELETED`
type	`LINKED_LOAN_ACCOUNT`
type	`UNLINKED_LOAN_ACCOUNT`
type	`LOAN_ACCOUNT_PAYED_OFF`
type	`LOAN_ACCOUNT_LOCKED`
type	`LOAN_ACCOUNT_UNLOCKED`
type	`LOAN_ACCOUNT_LOCKED_OPERATIONS_EDITED`
type	`LOAN_ACCOUNT_LOCKED_CAPPING`
type	`LOAN_ACCOUNT_BRANCH_ASSIGNMENT`
type	`LOAN_ACCOUNT_BRANCH_UNASSIGNMENT`
type	`LOAN_ACCOUNT_CENTRE_ASSIGNMENT`
type	`LOAN_ACCOUNT_CENTRE_UNASSIGNMENT`
type	`LOAN_ACCOUNT_CREDIT_OFFICER_ASSIGNMENT`
type	`LOAN_ACCOUNT_CREDIT_OFFICER_UNASSIGNMENT`
type	`LOAN_ACCOUNT_SET_TO_CLOSED_OBLIGATIONS_MET`
type	`LOAN_SCHEDULE_EDITED`
type	`LOAN_PRODUCT_CREATED`
type	`LOAN_PRODUCT_COMMENT_ADDED`
type	`LOAN_PRODUCT_COMMENT_EDITED`
type	`LOAN_PRODUCT_COMMENT_DELETED`
type	`LOAN_PRODUCT_EDITED`
type	`LOAN_PRODUCT_DEACTIVATED`
type	`LOAN_PRODUCT_ACTIVATED`
type	`LOAN_PRODUCT_DELETED`
type	`ORGANIZATION_SETTINGS_CHANGED`
type	`PORTAL_ACTIVATED`
type	`PORTAL_DEACTIVATED`
type	`PORTAL_EDITED`
type	`SAVINGS_PRODUCT_CREATED`
type	`SAVINGS_PRODUCT_COMMENT_ADDED`
type	`SAVINGS_PRODUCT_COMMENT_EDITED`
type	`SAVINGS_PRODUCT_COMMENT_DELETED`
type	`SAVINGS_PRODUCT_EDITED`
type	`SAVINGS_PRODUCT_ACTIVATED`
type	`SAVINGS_PRODUCT_DEACTIVATED`
type	`SAVINGS_PRODUCT_DELETED`
type	`SAVING_ACCOUNT_CREATED`
type	`SAVINGS_ACCOUNT_COMMENT_ADDED`
type	`SAVINGS_ACCOUNT_COMMENT_EDITED`
type	`SAVINGS_ACCOUNT_COMMENT_DELETED`
type	`SAVING_ACCOUNT_EDITED`
type	`SAVINGS_ACCOUNT_APPROVED`
type	`SAVINGS_ACCOUNT_ACTIVATED`
type	`SAVINGS_ACCOUNT_CLOSED_WITHDRAWN`
type	`SAVINGS_ACCOUNT_CLOSED_REJECTED`
type	`SAVINGS_ACCOUNT_CLOSED`
type	`SAVINGS_ACCOUNT_MATURED`
type	`SAVINGS_ACCOUNT_SET_TO_PENDING`
type	`SAVINGS_ACCOUNT_MATURITY_SET`
type	`SAVINGS_ACCOUNT_MATURITY_UNSET`
type	`SAVINGS_ACCOUNT_SET_TO_ARREARS`
type	`SAVINGS_ACCOUNT_WRITEN_OFF`
type	`SAVINGS_ACCOUNT_SET_TO_LOCKED`
type	`SAVINGS_ACCOUNT_DELETED`
type	`SAVINGS_ACCOUNT_SET_TO_DORMANT`
type	`SAVINGS_ACCOUNT_UNDO_DORMANT`
type	`SMS_MESSAGE_SENT`
type	`CLIENT_EMAIL_MESSAGE_SENT`
type	`TASK_CREATED`
type	`TASK_EDITED`
type	`TASK_DELETED`
type	`TASK_COMPLETED`
type	`TASK_UNCOMPLETED`
type	`LOAN_TRANSACTION_EDITED`
type	`SAVINGS_TRANSACTION_EDITED`
type	`USER_CREATED`
type	`USER_EDITED`
type	`USER_DELETED`
type	`USER_COMMENT_ADDED`
type	`USER_COMMENT_EDITED`
type	`USER_COMMENT_DELETED`
type	`USER_LOGGED_IN`
type	`USER_BRANCH_ASSIGNMENT`
type	`USER_BRANCH_UNASSIGNMENT`
type	`USER_LOCKED`

Branches

Allows you to retrieve branches which are being used by an organization. For information about custom field definitions and custom fields sets in branches see Custom Fields API documentation.

Get all Branches

GET /branches

Get all branches

Allows retrieving branches via a paginated list or by using the branch id/key. While using the branch id/key the full details of the branch can be retreived(address, custom field values, holidays). The custom field values can be changed using patch or delete methods.

Parameters

Name	Type	Description	In
offset	integer	Start at index x, for example, if limit is set to 10 and offset is set to 10, you will essentially get page 2 of all records.	query
limit	integer	Max number of records to return.	query
fullDetails	boolean	Whether to load all the nested fields for the branch as well.	query

Example Responses

200 : ok
an array of branches with full details

[
  {
    "encodedKey": "8a193c26722b51b701722d779e7122de",
    "id": "demoBranchId",
    "creationDate": "2020-05-19T15:05:23+0000",
    "lastModifiedDate": "2020-09-07T10:44:32+0000",
    "name": "Maputo Downtown",
    "state": "ACTIVE",
    "phoneNumber": "",
    "emailAddress": "",
    "notes": "Is located in the surroundings of the local market with a <i>lot of potential</i> to reach new clients.",
    "branchHolidays": [
      {
        "encodedKey": "8a19df6972b787fc0172b8c473c00b9c",
        "keyId": 12,
        "name": "only maputo holiday day",
        "dayOfMonth": 30,
        "monthOfYear": 7,
        "year": 2020,
        "isAnnualyRecurring": true,
        "creationDate": "2020-06-15T16:17:01+0000"
      }
    ],
    "customFieldValues": [
      {
        "encodedKey": "8a19cd6f74674df9017467f25aab02c6",
        "parentKey": "8a193c26722b51b701722d779e7122de",
        "customFieldKey": "8a19cd6f74674df9017467ef8e6802af",
        "customField": {
          "encodedKey": "8a19cd6f74674df9017467ef8e6802af",
          "id": "cf_branch",
          "creationDate": "2020-09-07T09:42:33+0000",
          "lastModifiedDate": "2020-09-07T09:42:33+0000",
          "name": "Example Custom Field Definition",
          "type": "BRANCH_INFO",
          "dataType": "CHECKBOX",
          "valueLength": "SHORT",
          "isDefault": false,
          "isRequired": false,
          "description": "an example of a checkbox custom field definition",
          "customFieldSet": {
            "encodedKey": "8a19cd6f74674df9017467ef8e6802ae",
            "id": "_example_branch_custom_field_set",
            "name": "example branch custom field set",
            "notes": "example custom field set",
            "createdDate": "2020-09-07T09:41:50+0000",
            "lastModifiedDate": "2020-09-07T09:41:50+0000",
            "indexInList": 2,
            "type": "BRANCH_INFO",
            "usage": "SINGLE"
          },
          "indexInList": 0,
          "state": "NORMAL",
          "customFieldSelectionOptions": [],
          "viewRights": {
            "encodedKey": "8a19cd6f74674df9017467ef8e6802b0",
            "isAccessibleByAllUsers": false,
            "roles": []
          },
          "editRights": {
            "encodedKey": "8a19cd6f74674df9017467ef8e6802b1",
            "isAccessibleByAllUsers": false,
            "roles": []
          },
          "unique": false,
          "values": [],
          "amounts": {}
        },
        "value": "TRUE",
        "indexInList": -1,
        "customFieldID": "cf_branch",
        "customFieldSetGroupIndex": -1
      },
      {
        "encodedKey": "8a19cd6f74674df9017468019ac00310",
        "parentKey": "8a193c26722b51b701722d779e7122de",
        "customFieldKey": "8a19cd6f74674df9017467f25aab02c9",
        "customField": {
          "encodedKey": "8a19cd6f74674df9017467f25aab02c9",
          "id": "cf_group_field_1",
          "creationDate": "2020-09-07T09:58:33+0000",
          "lastModifiedDate": "2020-09-07T09:58:33+0000",
          "name": "cf group field 1",
          "type": "BRANCH_INFO",
          "dataType": "STRING",
          "valueLength": "SHORT",
          "isDefault": false,
          "isRequired": false,
          "description": "",
          "customFieldSet": {
            "encodedKey": "8a19cd6f74674df9017467f25aab02c8",
            "id": "_branches_grouped_cf_set",
            "name": "Custom Field Group for Branch",
            "notes": "",
            "createdDate": "2020-09-07T09:47:03+0000",
            "lastModifiedDate": "2020-09-07T09:47:03+0000",
            "indexInList": 3,
            "type": "BRANCH_INFO",
            "usage": "GROUPED"
          },
          "indexInList": 0,
          "state": "NORMAL",
          "customFieldSelectionOptions": [],
          "viewRights": {
            "encodedKey": "8a19cd6f74674df9017467f25aab02ca",
            "isAccessibleByAllUsers": true,
            "roles": []
          },
          "editRights": {
            "encodedKey": "8a19cd6f74674df901746800bdb10307",
            "isAccessibleByAllUsers": true,
            "roles": []
          },
          "unique": false,
          "values": [],
          "amounts": {}
        },
        "value": "group field 1",
        "indexInList": -1,
        "customFieldID": "cf_group_field_1",
        "customFieldSetGroupIndex": 0
      },
      {
        "encodedKey": "8a19cd6f74674df90174681f214103cf",
        "parentKey": "8a193c26722b51b701722d779e7122de",
        "customFieldKey": "8a19cd6f74674df901746800bdb10308",
        "customField": {
          "encodedKey": "8a19cd6f74674df901746800bdb10308",
          "id": "cf_group_field_2",
          "creationDate": "2020-09-07T09:59:02+0000",
          "lastModifiedDate": "2020-09-07T09:59:02+0000",
          "name": "cf group field 2",
          "type": "BRANCH_INFO",
          "dataType": "NUMBER",
          "valueLength": "SHORT",
          "isDefault": false,
          "isRequired": false,
          "description": "",
          "customFieldSet": {
            "encodedKey": "8a19cd6f74674df9017467f25aab02c8",
            "id": "_branches_grouped_cf_set",
            "name": "Custom Field Group for Branch",
            "notes": "",
            "createdDate": "2020-09-07T09:47:03+0000",
            "lastModifiedDate": "2020-09-07T09:47:03+0000",
            "indexInList": 3,
            "type": "BRANCH_INFO",
            "usage": "GROUPED"
          },
          "indexInList": 1,
          "state": "NORMAL",
          "customFieldSelectionOptions": [],
          "viewRights": {
            "encodedKey": "8a19cd6f74674df901746800bdb10309",
            "isAccessibleByAllUsers": true,
            "roles": []
          },
          "editRights": {
            "encodedKey": "8a19cd6f74674df901746800bdb1030a",
            "isAccessibleByAllUsers": true,
            "roles": []
          },
          "unique": false,
          "values": [],
          "amounts": {}
        },
        "value": "2",
        "indexInList": -1,
        "customFieldID": "cf_group_field_2",
        "customFieldSetGroupIndex": 0
      },
      {
        "encodedKey": "8a19cd6f74674df90174681f214103d1",
        "parentKey": "8a193c26722b51b701722d779e7122de",
        "customFieldKey": "8a19cd6f74674df901746800bdb10308",
        "customField": {
          "encodedKey": "8a19cd6f74674df901746800bdb10308",
          "id": "cf_group_field_2",
          "creationDate": "2020-09-07T09:59:02+0000",
          "lastModifiedDate": "2020-09-07T09:59:02+0000",
          "name": "cf group field 2",
          "type": "BRANCH_INFO",
          "dataType": "NUMBER",
          "valueLength": "SHORT",
          "isDefault": false,
          "isRequired": false,
          "description": "",
          "customFieldSet": {
            "encodedKey": "8a19cd6f74674df9017467f25aab02c8",
            "id": "_branches_grouped_cf_set",
            "name": "Custom Field Group for Branch",
            "notes": "",
            "createdDate": "2020-09-07T09:47:03+0000",
            "lastModifiedDate": "2020-09-07T09:47:03+0000",
            "indexInList": 3,
            "type": "BRANCH_INFO",
            "usage": "GROUPED"
          },
          "indexInList": 1,
          "state": "NORMAL",
          "customFieldSelectionOptions": [],
          "viewRights": {
            "encodedKey": "8a19cd6f74674df901746800bdb10309",
            "isAccessibleByAllUsers": true,
            "roles": []
          },
          "editRights": {
            "encodedKey": "8a19cd6f74674df901746800bdb1030a",
            "isAccessibleByAllUsers": true,
            "roles": []
          },
          "unique": false,
          "values": [],
          "amounts": {}
        },
        "value": "500",
        "indexInList": -1,
        "customFieldID": "cf_group_field_2",
        "customFieldSetGroupIndex": 1
      }
    ]
  },
  {
    "encodedKey": "8a193c26722b51b701722d779e7122df",
    "id": "2",
    "creationDate": "2020-05-19T15:05:23+0000",
    "lastModifiedDate": "2020-10-08T09:21:51+0000",
    "name": "Matola City",
    "state": "ACTIVE",
    "phoneNumber": "+7534987676",
    "emailAddress": "matola@BofAlg.es",
    "notes": "Is currently under construction to add an extra room that can be used for the meetings.<p></p>Have <b>six new computers</b> for their staff.",
    "branchHolidays": [
      {
        "encodedKey": "8a19df6972b787fc0172b8c50bdb0ba1",
        "keyId": 13,
        "name": "joe matola only day",
        "dayOfMonth": 26,
        "monthOfYear": 8,
        "year": 2020,
        "isAnnualyRecurring": true,
        "creationDate": "2020-06-15T16:17:19+0000"
      }
    ],
    "address": {
      "encodedKey": "8a19aa09750726e001750782ef6f017d",
      "parentKey": "8a193c26722b51b701722d779e7122df",
      "line1": "1 Bank Street",
      "line2": "Old Town",
      "city": "Matola City",
      "region": "Matola",
      "postcode": "10775",
      "country": "Bankistan",
      "indexInList": -1
    },
    "customFieldValues": []
  }
]

200 : ok
an array of branches with basic details

[
  {
    "encodedKey": "402832b43809601c01380963908b0009",
    "id": "2",
    "creationDate": "2012-06-20T12:15:16+0200",
    "lastModifiedDate": "2012-06-20T12:15:16+0200",
    "name": "Matola City"
  },
  {
    "encodedKey": "402832b43809601c01380963907c0008",
    "id": "demoBranchId",
    "creationDate": "2012-06-20T12:15:16+0200",
    "lastModifiedDate": "2012-06-20T12:15:16+0200",
    "name": "Maputo Downtown"
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[BranchFullDetailsApiV1]	none	none
» address	AddressApiV1	none	none
»» addressType	string	the type of the address, eg. home, office. Deprecated.	none
»» city	string	the city	none
»» country	string	the country	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» indexInList	integer	the index of this address when there are multiple addresses assigned for a single entity	none
»» latitude	number	the latitude of the address point	none
»» line1	string	the first line of the address	none
»» line2	string	the second line of the address	none
»» longitude	number	the longitude of the address point	none
»» parentKey	string	the encoded key of the entity to whom this address belongs, for example, the client of group	none
»» postcode	string	the postal (zip) code of the address	none
»» region	string	the region of the address	none
»» toBeDeleted	boolean	whether this address is marked to be deleted	none
» branchHolidays	[HolidayApiV1]	a list of holidays specific to this branch	none
»» creationDate	string	the date and time when this holdiay was created	none
»» dayOfMonth	number	the day of the month on which this holiday falls	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» isAnnualyRecurring	boolean	whether this holiday takes place every year	none
»» keyId	number	none	none
»» monthOfYear	number	the month of the year in which this holiday takes place	none
»» name	string	the name of this holiday	none
»» year	number	the year in which this holiday takes place	none
» creationDate	string	the date on which this branch was created	none
» customFieldValues	[CustomFieldValueApiV1]	none	none
»» amount	number	none	none
»» customField	CustomFieldApiV1	none	none
»»» amounts	object	used when options available for a custom field definition translate to predefined amounts, for example, when the custom field value is used to generate a score	none
»»»» additionalProperties	number	none	none
»»» builtInCustomFieldId	string	if this field is one of the built in custom fiel definitions, this will have a value. These names are reserved and you can not use them for your own custom field definitions	none
»»» creationDate	string	the date on which this custom field definition was created	none
»»» customFieldProductSettings	[CustomFieldLinkApiV1]	none	none
»»»» customFieldEncodedKey	string	the key to the parent custom field definition	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isDefault	boolean	whether this field is displayed by default when creating a new record	none
»»»» isRequired	boolean	whether this field is required when creating a new record	none
»»»» linkType	string	the type of entity this field represents a link to	none
»»»» productKey	string	when the link type is product, this field should contain the encoded key of the linekd product	none
»»» customFieldSelectionOptions	[CustomFieldSelectionApiV1]	[represents a possible selection for select type custom field definitions]	none
»»»» constraint	CustomFilterConstraintApiV1	none	none
»»»»» customFieldKey	string	none	none
»»»»» dataFieldType	string	none	none
»»»»» dataFieldValue	string	none	none
»»»»» dataItemType	string	none	none
»»»»» dataType	string	none	none
»»»»» encodedKey	string	none	none
»»»»» filterElement	string	none	none
»»»»» groupNumber	number	none	none
»»»»» index	number	none	none
»»»»» linkingOperator	string	none	none
»»»»» secondValue	string	none	none
»»»»» value	string	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this selectable item	none
»»»» score	number	the score assigned to this selection	none
»»»» value	string	display name of this option	none
»»» customFieldSet	CustomFieldSetApiV1	none	none
»»»» builtInType	string	if this set is part of the set of built-in custom field sets, its type will be shown here	none
»»»» createdDate	string	the date and time when this custom field set was created	none
»»»» customFields	[CustomFieldApiV1]	an array of custom field definitions included in this custom field set	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this custom field set	none
»»»» indexInList	number	for field sets that can be added to an entity more than once, this number represents the index in the list and is used when changing values	none
»»»» lastModifiedDate	string	the date on which this custom field set was last modified	none
»»»» name	string	the name of this custom field set	none
»»»» notes	string	any notes regarding this custom field set	none
»»»» type	string	the entity type that this custom field definition is attached to	none
»»»» usage	string	whether this custom field set can only be used once, or added multiple times to the same entity	none
»»» dataType	string	the type of custom field definition	none
»»» description	string	a brief description of this custom field definition	none
»»» editRights	UsageRightsApiV1	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isAccessibleByAllUsers	boolean	none	none
»»»» roles	[string]	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» id	string	the ID for this custom field definition	none
»»» indexInList	number	none	none
»»» isDefault	boolean	whether this field will be included by default on new records	none
»»» isRequired	boolean	whether this field is required when creating a new record	none
»»» lastModifiedDate	string	the date on which this custom field definition was last modified	none
»»» name	string	the name of this custom field definition	none
»»» state	string	whether this field is available for use or has been deactivated	none
»»» type	string	the type of data this custom field definition will contain	none
»»» unique	boolean	whether the data in this custom field definition needs to be a unique value	none
»»» validationPattern	string	a user-provided pattern to which data in this custom field definition must conform where @ represents numbers, # represents letters and $ is either a number or letter. Other special characters used as separators are allowed, for example `@@-##-$$$`	none
»»» valueLength	string	whether this field needs to support a large number of characters	none
»»» values	[string]	a list of possible values when the field is a selection field	none
»»» viewRights	UsageRightsApiV1	none	none
»» customFieldID	string	none	none
»» customFieldKey	string	none	none
»» customFieldSetGroupIndex	number	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» indexInList	number	none	none
»» linkedEntityKeyValue	string	none	none
»» parentKey	string	none	none
»» selectionKey	string	none	none
»» value	string	none	none
» emailAddress	string	the email address for this branch	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» id	string	the user provided ID for this branch	none
» lastModifiedDate	string	the date on which the details for this branch were last modified	none
» name	string	the name of this branch	none
» notes	string	notes associated with this branch	none
» phoneNumber	string	the contact telephone number for this branch	none
» state	string	wether this branch is active or not	none

Enumerated Values

Property	Value
builtInCustomFieldId	`MOBILE_PHONE`
builtInCustomFieldId	`EMAIL_ADDRESS`
builtInCustomFieldId	`GENDER`
builtInCustomFieldId	`MIDDLE_NAME`
builtInCustomFieldId	`HOME_PHONE`
builtInCustomFieldId	`BIRTHDATE`
builtInCustomFieldId	`LAST_NAME`
builtInCustomFieldId	`FIRST_NAME`
linkType	`CLIENT_ROLE`
linkType	`CHANNEL`
linkType	`PRODUCT`
dataFieldType	`NATIVE`
dataFieldType	`CUSTOM`
dataItemType	`WRITTEN_OFF_LOANS`
dataItemType	`LINE_OF_CREDIT`
dataItemType	`INVESTOR_FUND`
dataItemType	`TRANSACTION_DETAILS`
dataItemType	`DOCUMENT_TEMPLATE`
dataItemType	`PRODUCT`
dataItemType	`MCC_EXPIRATION`
dataItemType	`CENTRE`
dataItemType	`REPAYMENT_COLLECTION`
dataItemType	`TASK`
dataItemType	`OUTSTANDING_PORTFOLIO_AMOUNTS`
dataItemType	`REVENUE`
dataItemType	`COMPOSED_TRANSACTIONS`
dataItemType	`UNION_TRANSACTIONS`
dataItemType	`PRINCIPAL_PAYMENT_SETTINGS`
dataItemType	`LOANS`
dataItemType	`DISBURSEMENT_DETAILS`
dataItemType	`SAVINGS_TRANSACTION`
dataItemType	`IDENTIFICATION_DOCUMENT`
dataItemType	`LOAN_PRODUCT`
dataItemType	`DISBURSED_LOANS`
dataItemType	`LOAN_GROUP`
dataItemType	`TRANSACTION_CHANNEL`
dataItemType	`CUSTOM_PREDEFINED_FEE`
dataItemType	`JOURNAL_ENTRY`
dataItemType	`ATTACHMENT`
dataItemType	`PREDEFINED_FEE`
dataItemType	`TRANCHE`
dataItemType	`TRANSACTION`
dataItemType	`INDEX_RATE_SOURCE`
dataItemType	`GROUP_ROLE`
dataItemType	`LOAN_TRANSACTION`
dataItemType	`CLIENT_ROLE`
dataItemType	`GROUP`
dataItemType	`NOTIFICATION_MESSAGE`
dataItemType	`OUTSTANDING_PORTFOLIO_ACCOUNTS`
dataItemType	`REPAYMENT`
dataItemType	`LOAN_ACCOUNT_GUARANTY`
dataItemType	`BRANCH`
dataItemType	`CURRENCY`
dataItemType	`CARD_TRANSACTION_REVERSAL`
dataItemType	`INTEREST_PRODUCT_SETTINGS`
dataItemType	`CREATED_ACCOUNTS`
dataItemType	`USER`
dataItemType	`SAVINGS_PRODUCT`
dataItemType	`CLIENT`
dataItemType	`PRODUCT_ARREARS_SETTINGS`
dataItemType	`SAVINGS`
dataItemType	`EXPENSE`
dataItemType	`INDEX_RATE`
dataItemType	`NOTIFICATION_TEMPLATE`
dataItemType	`CUSTOM_FIELD_SELECTION`
dataItemType	`ACTIVITY`
dataType	`ENUM`
dataType	`MONEY`
dataType	`NUMBER`
dataType	`DATE_UTC`
dataType	`JAVA_BLOB`
dataType	`OBJECT`
dataType	`BOOLEAN`
dataType	`DATE`
dataType	`PERCENT`
dataType	`BIG_DECIMAL`
dataType	`STRING`
dataType	`KEY`
dataType	`LONG`
filterElement	`STARTS_WITH_CASE_SENSITIVE`
filterElement	`THIS_WEEK`
filterElement	`EQUALS`
filterElement	`STARTS_WITH`
filterElement	`IN`
filterElement	`TODAY`
filterElement	`THIS_YEAR`
filterElement	`BETWEEN`
filterElement	`AFTER`
filterElement	`LESS_THAN`
filterElement	`DIFFERENT_THAN`
filterElement	`THIS_MONTH`
filterElement	`NOT_EMPTY`
filterElement	`BEFORE`
filterElement	`EQUALS_CASE_SENSITIVE`
filterElement	`LAST_DAYS`
filterElement	`MORE_THAN`
filterElement	`EMPTY`
filterElement	`ON`
linkingOperator	`OR`
linkingOperator	`AND`
builtInType	`DETAILS`
builtInType	`GENERAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
usage	`SINGLE`
usage	`GROUPED`
dataType	`GROUP_LINK`
dataType	`DATE`
dataType	`NUMBER`
dataType	`CHECKBOX`
dataType	`CLIENT_LINK`
dataType	`STRING`
dataType	`USER_LINK`
dataType	`SELECTION`
state	`DEACTIVATED`
state	`NORMAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
valueLength	`SHORT`
valueLength	`LONG`
state	`ACTIVE`
state	`INACTIVE`

Get Branch by ID

GET /branches/{branchId}

Get a branch by ID

Get a specifc branch by its encoded key or ID.

Parameters

Name	Type	Description	In
branchId (required)	string	none	path
fullDetails	boolean	none	query

Example Responses

200 : ok
Full Details for a single branch

{
  "encodedKey": "8a33ae49441c4fe101441c713b36000e",
  "id": "2",
  "creationDate": "2014-02-10T15:36:26+0000",
  "lastModifiedDate": "2014-02-17T11:18:42+0000",
  "name": "Matola City",
  "phoneNumber": "",
  "emailAddress": "",
  "branchHolidays": [
    {
      "encodedKey": "8a54e5b4443e9c9401443fae924b0008",
      "keyId": 31,
      "name": "branch_holiday",
      "dayOfMonth": 17,
      "monthOfYear": 2,
      "year": 2014,
      "isAnnualyRecurring": true
    }
  ],
  "address": {
    "encodedKey": "8a19aa09750726e001750782ef6f017d",
    "parentKey": "8a193c26722b51b701722d779e7122df",
    "line1": "1 Bank Street",
    "line2": "Old Town",
    "city": "Matola City",
    "region": "Matola",
    "postcode": "10775",
    "country": "Bankistan",
    "indexInList": -1
  },
  "customFieldValues": [
    {
      "encodedKey": "8a42711a4428c1f101442be406d20c24",
      "parentKey": "8a33ae49441c4fe101441c713b36000e",
      "customFieldKey": "8a33ae49441c4fe101441c7156c20358",
      "customField": {
        "encodedKey": "8a33ae49441c4fe101441c7156c20358",
        "id": "Clients_Branches",
        "name": "Clients",
        "type": "BRANCH_INFO",
        "dataType": "STRING",
        "valueLength": "SHORT",
        "isDefault": false,
        "isRequired": false,
        "customFieldSet": {
          "encodedKey": "8a33ae49441c4fe101441c71568f034c",
          "name": "Branch Organization",
          "createdDate": "2014-02-10T15:36:33+0000",
          "indexInList": 0,
          "type": "BRANCH_INFO"
        },
        "indexInList": -1,
        "state": "NORMAL"
      },
      "value": "dadsds",
      "indexInList": -1
    },
    {
      "encodedKey": "8a54e5b4443e9c9401443f91c7a20003",
      "parentKey": "8a33ae49441c4fe101441c713b36000e",
      "customFieldKey": "8a33ae49441c4fe101441c7156c5035a",
      "customField": {
        "encodedKey": "8a33ae49441c4fe101441c7156c5035a",
        "id": "Organization_Staff_Branches",
        "name": "Organization Staff",
        "type": "BRANCH_INFO",
        "dataType": "NUMBER",
        "valueLength": "SHORT",
        "isDefault": false,
        "isRequired": false,
        "customFieldSet": {
          "encodedKey": "8a33ae49441c4fe101441c71568f034c",
          "name": "Branch Organization",
          "createdDate": "2014-02-10T15:36:33+0000",
          "indexInList": 0,
          "type": "BRANCH_INFO"
        },
        "indexInList": -1,
        "state": "NORMAL"
      },
      "value": "4",
      "indexInList": -1
    },
    {
      "encodedKey": "8a54e5b4443e9c9401443f91c7b90004",
      "parentKey": "8a33ae49441c4fe101441c713b36000e",
      "customFieldKey": "8a33ae49441c4fe101441c7156c30359",
      "customField": {
        "encodedKey": "8a33ae49441c4fe101441c7156c30359",
        "id": "Province_Branches",
        "name": "Province",
        "type": "BRANCH_INFO",
        "dataType": "SELECTION",
        "valueLength": "SHORT",
        "isDefault": false,
        "isRequired": false,
        "values": [
          "Catamarca",
          "Chaco",
          "Jujuy"
        ],
        "amounts": {
          "Jujuy": "10",
          "Chaco": "1",
          "Catamarca": "0"
        },
        "customFieldSet": {
          "encodedKey": "8a33ae49441c4fe101441c71569a034d",
          "name": "Province",
          "createdDate": "2014-02-10T15:36:33+0000",
          "indexInList": 1,
          "type": "BRANCH_INFO"
        },
        "indexInList": -1,
        "state": "NORMAL"
      },
      "value": "Catamarca",
      "amount": "0",
      "indexInList": -1
    },
    {
      "encodedKey": "8a54e5b4443e9c9401443f91c7b90005",
      "parentKey": "8a33ae49441c4fe101441c713b36000e",
      "customFieldKey": "8a33ae49441c4fe101441c7156c7035b",
      "customField": {
        "encodedKey": "8a33ae49441c4fe101441c7156c7035b",
        "id": "Outside_of_province_Branches",
        "name": "Outside of province",
        "type": "BRANCH_INFO",
        "dataType": "CHECKBOX",
        "valueLength": "SHORT",
        "isDefault": false,
        "isRequired": false,
        "customFieldSet": {
          "encodedKey": "8a33ae49441c4fe101441c71569a034d",
          "name": "Province",
          "createdDate": "2014-02-10T15:36:33+0000",
          "indexInList": 1,
          "type": "BRANCH_INFO"
        },
        "indexInList": -1,
        "state": "NORMAL"
      },
      "value": "FALSE",
      "indexInList": -1
    }
  ]
}

200 : ok
A single branch

{
  "encodedKey": "402832b43809601c01380963908b0009",
  "id": "2",
  "creationDate": "2012-06-20T12:15:16+0200",
  "lastModifiedDate": "2012-06-20T12:15:16+0200",
  "name": "Matola City"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	BranchFullDetailsApiV1

Update Custom Info for Branch

PATCH /branches/{branchId}/custominformation

Update custom field values

Example Requests

Update a single custom field value

{
  "customInformation": [
    {
      "customFieldID": "custom_field_2",
      "value": "3"
    }
  ]
}

Update field in a group

{
  "customInformation": [
    {
      "customFieldID": "cf_grouped_field",
      "value": "new value",
      "customFieldSetGroupIndex": "0"
    }
  ]
}

Update multiple custom field values

{
  "customInformation": [
    {
      "customFieldID": "cf_grouped_field_2",
      "value": "3",
      "customFieldSetGroupIndex": "0"
    },
    {
      "customFieldID": "field_3",
      "value": "divorced"
    }
  ]
}

Parameters

Name	Type	Description	In
customInformation	[object]	none	body
» customFieldID (required)	string	none	body
» value (required)	string	none	body
» customFieldSetGroupIndex	string	Required if field to update is part of a group, if the Field Set Group Index is not set, a new group will be created with the value provided.	body
branchId (required)	string	The ID of the branch	path

Example Responses

200 : OK
success response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Get Custom Info for Branch

GET /branches/{branchId}/custominformation/{customFieldId}

Get a custom field definition for a branch

Allows retrieving a custom field definition for a given branch directly by the ID/key of the branch and the ID/key of the custom field definition.

Parameters

Name	Type	Description	In
branchId (required)	string	The ID of the branch.	path
customFieldId (required)	string	The ID of the custom field definition.	path

Example Responses

200 : OK
A custom field definition

[
  {
    "encodedKey": "8a19cd6f74674df9017467f25aab02c6",
    "parentKey": "8a193c26722b51b701722d779e7122de",
    "customFieldKey": "8a19cd6f74674df9017467ef8e6802af",
    "customField": {
      "encodedKey": "8a19cd6f74674df9017467ef8e6802af",
      "id": "cf_branch",
      "creationDate": "2020-09-07T09:42:33+0000",
      "lastModifiedDate": "2020-09-07T09:42:33+0000",
      "name": "Example Custom Field Definition",
      "type": "BRANCH_INFO",
      "dataType": "CHECKBOX",
      "valueLength": "SHORT",
      "isDefault": false,
      "isRequired": false,
      "description": "an example of a checkbox custom field definition",
      "customFieldSet": {
        "encodedKey": "8a19cd6f74674df9017467ef8e6802ae",
        "id": "_example_branch_custom_field_set",
        "name": "example branch custom field set",
        "notes": "example custom field set",
        "createdDate": "2020-09-07T09:41:50+0000",
        "lastModifiedDate": "2020-09-07T09:41:50+0000",
        "indexInList": 2,
        "type": "BRANCH_INFO",
        "usage": "SINGLE"
      },
      "indexInList": 0,
      "state": "NORMAL",
      "customFieldSelectionOptions": [],
      "viewRights": {
        "encodedKey": "8a19cd6f74674df9017467ef8e6802b0",
        "isAccessibleByAllUsers": false,
        "roles": []
      },
      "editRights": {
        "encodedKey": "8a19cd6f74674df9017467ef8e6802b1",
        "isAccessibleByAllUsers": false,
        "roles": []
      },
      "unique": false,
      "values": [],
      "amounts": {}
    },
    "value": "TRUE",
    "indexInList": -1,
    "customFieldID": "cf_branch",
    "customFieldSetGroupIndex": -1
  }
]

404 : Not Found
not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	CustomFieldApiV1
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Update Custom Field Value for Branch

PATCH /branches/{branchId}/custominformation/{customFieldId}

Update a custom field value for a branch

Update a custom field value for a branch custom field definition

Example Requests

A new custom field value

{
  "value": "New custom field value"
}

Parameters

Name	Type	Description	In
value	string	none	body
branchId (required)	string	The ID of the branch.	path
customFieldId (required)	string	The ID of the custom field definition.	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "string"
}

400 : Bad Request
field is part of a group

{
  "returnCode": 916,
  "returnStatus": "INVALID_CUSTOM_FIELD_GROUP_INDEX",
  "errorSource": "cf_group_field_2"
}

404 : Not Found
not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Delete Custom Info for Branch

DELETE /branches/{branchId}/custominformation/{customFieldId}

Delete a single custom field value

Parameters

Name	Type	Description	In
branchId (required)	string	The ID of the branch.	path
customFieldId (required)	string	The ID of the custom field definition.	path

Example Responses

200 : OK
success response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
field is part of a group

{
  "returnCode": 916,
  "returnStatus": "INVALID_CUSTOM_FIELD_GROUP_INDEX",
  "errorSource": "cf_group_field_2"
}

404 : Not Found
not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Update Custom Info (grouped) for Branch

PATCH /branches/{branchId}/custominformation/{customFieldId}/{customFieldGroupSetIndex}

Update grouped custom field value

Update custom field value, which is part of a group

Example requests

Provide a new custom field value

{
  "value": "Some updated information"
}

Parameters

Name	Type	Description	In
value	string	none	body
branchId (required)	string	The ID of the branch	path
customFieldId (required)	string	The ID of the custom field definition.	path
customFieldGroupSetIndex (required)	string	none	path

Example Responses

200 : OK
success response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
wrong group index provided

{
  "returnCode": 916,
  "returnStatus": "INVALID_CUSTOM_FIELD_GROUP_INDEX",
  "errorSource": "cf_group_field_2"
}

404 : Not Found
field not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Delete Custom Info (grouped) for Branch

DELETE /branches/{branchId}/custominformation/{customFieldId}/{customFieldGroupSetIndex}

Delete grouped custom field value

Delete a custom field value, which is part of a group

Parameters

Name	Type	Description	In
branchId (required)	string	The ID of the branch	path
customFieldId (required)	string	The ID of the custom field definition.	path
customFieldGroupSetIndex (required)	string	none	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Get Branch Comments

GET /branches/{branchId}/comments

Get all branch comments

get all comments for a branch

Parameters

Name	Type	Description	In
limit	string	none	query
offset	string	none	query
branchId (required)	string	the ID of the branch	path

Example Responses

200 : OK
an array of comments

[
  {
    "encodedKey": "8a19b7057471f4af017472dc0fd80470",
    "parentKey": "8a193c26722b51b701722d77c5e423b7",
    "userKey": "8a194075720ece2c017226fced6f005e",
    "creationDate": "2020-09-09T14:24:42+0000",
    "lastModifiedDate": "2020-09-09T14:24:42+0000",
    "text": "aanother afmaefomaef<div><br /></div><div><u>aefaefaf</u></div><div><u><br /></u></div><div><u>afaef</u></div>"
  },
  {
    "encodedKey": "8a193c26722b51b701722d77c8bf25ab",
    "parentKey": "8a193c26722b51b701722d77c5e423b7",
    "creationDate": "2020-05-19T15:05:24+0000",
    "lastModifiedDate": "2020-05-19T15:05:24+0000",
    "text": "Should suggest she apply for the agriculture loan given the nature of their business"
  }
]

400 : Bad Request
bad branch ID

{
  "returnCode": 149,
  "returnStatus": "INVALID_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[CommentApiV1]	none	none
» creationDate	string(date-time)	the date and time at which this comment was added	none
» encodedKey	string	a unique key for this comment	none
» lastModifiedDate	string(date-time)	the date and time at which this comment was last modified	none
» parentKey	string	the unique key of the parent object for this comment, for example, the client or loan account to which it relates	none
» text	string	the text of the comment as a string, must be properly JSON escpaped if it contains special characters	none
» userKey	string	the unique key of the user who created the comment	none

Create Branch Comment

POST /branches/{branchId}/comments

Create a branch Comment

create new comment for a branch

Example Requests

A comment

{
  "comment": "A long text field containing the comment to post. this is a comment with \" \" all kinds of : \\ / non compliant characters & = which have \n been JSON escaped"
}

Parameters

Name	Type	Description	In
comment	string	the comment to be added. if adding complex content make sure it is properly JSON encoded before making your request	body
branchId (required)	string	the ID of the branch	path

Example Responses

200 : OK
a comment

{
  "encodedKey": "8a19c34574720f9e0174734a039f06e2",
  "parentKey": "8a193c26722b51b701722d77c5e423b7",
  "userKey": "8a194075720ece2c017226fced6f005e",
  "creationDate": "2020-09-09T14:39:36+0000",
  "lastModifiedDate": "2020-09-09T14:39:36+0000",
  "text": "this is a comment with \" \" all kinds of : \\ / non compliant stuff & = which has been JSON escaped"
}

400 : Bad Request
extra parameters in the request

{
  "returnCode": 27,
  "returnStatus": "PARAMETER_NOT_ALLOWED"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	CommentApiV1
`400`	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Get Branch Documents

GET /branches/{branchId}/documents

Get documents for Branch

Get all documents for a given branch

Parameters

Name	Type	Description	In
offset	integer	offset results. use with `limit` parameter to achieve paging	query
limit	integer	max number of records to return	query
branchId (required)	string	the ID of the branch	path

Example Responses

200 : ok
an array of documents

[
  {
    "encodedKey": "8a19c035747bf5b901747c5bfb04014b",
    "id": 51,
    "creationDate": "2020-09-11T08:52:48+0000",
    "lastModifiedDate": "2020-09-11T08:52:48+0000",
    "documentHolderKey": "8a193c26722b51b701722d779e7122df",
    "documentHolderType": "BRANCH",
    "name": "covid rules",
    "type": "png",
    "fileSize": 8258,
    "originalFilename": "Screenshot_2020-04-22_at_14.31.29.png",
    "location": "BRSIDSLFBOGAYZKUUKCOGGQEDOSEOD",
    "description": "some guidelines for bank employees regarding covid",
    "createdByUserKey": "8a194075720ece2c017226fced6f005e",
    "userName": "Adrian Doonan"
  },
  {
    "encodedKey": "8a19a3337476f2d00174775b6a3001ae",
    "id": 43,
    "creationDate": "2020-09-10T09:31:54+0000",
    "lastModifiedDate": "2020-09-10T09:31:54+0000",
    "documentHolderKey": "8a193c26722b51b701722d779e7122df",
    "documentHolderType": "BRANCH",
    "name": "bnranch doc",
    "type": "png",
    "fileSize": 32109,
    "originalFilename": "clients_duplicate_id.png",
    "location": "JRTBQGGVXFQRQRBDGBRWQCTXJNRWXP",
    "description": "branch doc desc",
    "createdByUserKey": "8a194075720ece2c017226fced6f005e",
    "userName": "Adrian Doonan"
  }
]

400 : Bad Request
bad branch ID

{
  "returnCode": 4,
  "returnStatus": "INVALID_PARAMETERS",
  "errorSource": "wrong owner id"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[DocumentApiV1]	none	none
» createdByUserKey	string	the encoded key of the user who added this document	none
» creationDate	string	the date and time when this document was created	none
» description	string	a description of this document	none
» documentHolderKey	string	the encoded key of the entity to which this document is attached	none
» documentHolderType	string	the type of entity, eg. client, loan product, to which this document is attached	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» fileSize	number	the size, in bytes, of the attached document	none
» id	number	an ID for this document	none
» lastModifiedDate	string	the date on which this document was last modified	none
» location	string	indicates where the document is saved	none
» name	string	the display name of this document	none
» originalFilename	string	the name of the originally uploaded file	none
» type	string	the file type of the document, eg. png, jpeg, pdf	none
» userName	string	the name of the user who uploaded the document	none

Enumerated Values

Property	Value
documentHolderType	`BRANCH`
documentHolderType	`LOAN_ACCOUNT`
documentHolderType	`GROUP`
documentHolderType	`DEPOSIT_ACCOUNT`
documentHolderType	`LINE_OF_CREDIT`
documentHolderType	`LOAN_PRODUCT`
documentHolderType	`GL_JOURNAL_ENTRY`
documentHolderType	`SAVINGS_PRODUCT`
documentHolderType	`USER`
documentHolderType	`CLIENT`
documentHolderType	`CENTRE`
documentHolderType	`ID_DOCUMENT`

Create Branch Document

POST /branches/{branchId}/documents

Attach new Document to a Branch

Attach a new document to a branch

Example Requests

a document to uplaod

{
  "document": {
    "documentHolderKey": "8a193c26722b51b701722d779e7122df",
    "documentHolderType": "BRANCH",
    "name": "some image",
    "type": "PNG",
    "description": "this is an image file"
  },
  "documentContent": "iVBORw0KGgoAAAANSUhEUgAAAnYAAAF0CAYAAACudHRvAAABQGlDQ1BJQ0MgUHJvZmlsZQAAKJFjYGASS=="
}

Parameters

Name	Type	Description	In
body	CreateDocumentApiV1	a new document to be attached to an entity	body
branchId (required)	string	the ID of the branch	path

Example Responses

201 : Created
uploaded document details

{
  "encodedKey": "8a19c035747bf5b901747c5bfb04014d",
  "id": 52,
  "creationDate": "2020-09-11T08:54:53+0000",
  "lastModifiedDate": "2020-09-11T08:54:53+0000",
  "documentHolderKey": "8a193c26722b51b701722d779e7122df",
  "documentHolderType": "BRANCH",
  "name": "some image",
  "type": "png",
  "fileSize": 32109,
  "originalFilename": "some_image.png",
  "location": "RCPOUIUHJFBYDRURQNNHMOGBEFIOQF",
  "description": "this is an image file",
  "createdByUserKey": "8a194075720ece2c017226fced6f005e"
}

400 : Bad Request
filetype provided does not match actual file type

{
  "returnCode": 973,
  "returnStatus": "INCONSISTENT_EXTENSION_WITH_FILE_CONTENT",
  "errorSource": "Invalid extension with file content"
}

Responses

Status	Meaning	Description	Schema
`201`	Created	Created	DocumentApiV1
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Get Branch Document by ID

GET /branches/{branchId}/documents/{documentId}

Get a Branch Document

Get a specific document attached to a branch

Parameters

Name	Type	Description	In
branchId (required)	string	the ID of the branch	path
documentId (required)	string	the ID of the document	path

Example Responses

200 : OK
base64 encoded document

"iVBORw0KGgoAAAANSUhEUgAAAEAAAAA9CAYAAAAd1W/BAAAMY2lDQ1BJQ0MgUHJvZmlsZQAASImVVwdck0cbv3dkkrACEZAR9hJFZgAZIawIAjIFUQlJIGHEmBBE3NRSBesWUZxoVUTRagWkDkSssyhu6yiKqFRqsYoLle8yoNZ+4/c9v9+993+fe+7/jNzlvQNAr5Mvk+Wj+gAUSAvlCZGhrElp6SzSI4ABU0ADtsCTL1DIOPHxMQDKUP93eX0DIKr+qpuK65/j/1UMhSKFAAAkA=="

400 : Bad Request
bad Document ID

{
  "returnCode": 970,
  "returnStatus": "INVALID_DOCUMENT_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	string
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Delete Branch Document

DELETE /branches/{branchId}/documents/{documentId}

Delete a Branch Document

Delete a document attached to a branch

Parameters

Name	Type	Description	In
branchId (required)	string	the ID of the branch	path
documentId (required)	string	the ID of the document	path

Example Responses

200 : OK
success response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
bad Document ID

{
  "returnCode": 970,
  "returnStatus": "INVALID_DOCUMENT_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	ExecutionStatusApiV1
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Centres

Allows the retrieval of centres which are being used by an organisation. For information about custom field definitions and custom field sets, see Custom Fields API documentation.

Get all Centres

GET /centres

Get all centres

Allows retrieving centres via a paginated list.

Parameters

Name	Type	Description	In
branchID	string	none	query
offset	integer	none	query
limit	integer	none	query
fullDetails	boolean	none	query

Example Responses

200 : ok
an array of centres with basic details

[
  {
    "encodedKey": "8a193c26722b51b701722d779e7122e0",
    "id": "DT1",
    "creationDate": "2020-05-19T15:05:23+0000",
    "lastModifiedDate": "2020-09-23T14:38:14+0000",
    "name": "Down Town",
    "state": "ACTIVE",
    "meetingDay": "FRIDAY",
    "assignedBranchKey": "8a193c26722b51b701722d779e7122de"
  },
  {
    "encodedKey": "8a193c26722b51b701722d779e7122e1",
    "id": "MP1",
    "creationDate": "2020-05-19T15:05:23+0000",
    "lastModifiedDate": "2020-05-19T15:05:23+0000",
    "name": "Market Place",
    "state": "ACTIVE",
    "assignedBranchKey": "8a193c26722b51b701722d779e7122df"
  }
]

200 : ok
an array of centres with full details

[
  {
    "encodedKey": "8a193c26722b51b701722d779e7122e0",
    "id": "DT1",
    "creationDate": "2020-05-19T15:05:23+0000",
    "lastModifiedDate": "2020-09-23T14:38:14+0000",
    "name": "Down Town",
    "state": "ACTIVE",
    "notes": "some rich text notes about this centre",
    "meetingDay": "FRIDAY",
    "assignedBranchKey": "8a193c26722b51b701722d779e7122de",
    "address": {
      "encodedKey": "8a19b63f74b9d6b10174bb3fea5b09b3",
      "parentKey": "8a193c26722b51b701722d779e7122e0",
      "line1": "Chuffington House",
      "line2": "123 Main High Road",
      "city": "Big Town",
      "region": "Big Conglomeration",
      "postcode": "123 456",
      "country": "Countrystan",
      "indexInList": -1
    },
    "customFieldValues": [
      {
        "encodedKey": "8a19b63f74b9d6b10174bb3f856b09a6",
        "parentKey": "8a193c26722b51b701722d779e7122e0",
        "customFieldKey": "8a19b63f74b9d6b10174bb3d56f20974",
        "customField": {
          "encodedKey": "8a19b63f74b9d6b10174bb3d56f20974",
          "id": "centre_cf_1",
          "creationDate": "2020-09-23T13:53:13+0000",
          "lastModifiedDate": "2020-09-23T14:27:10+0000",
          "name": "cf 1",
          "type": "CENTRE_INFO",
          "dataType": "STRING",
          "valueLength": "LONG",
          "isDefault": false,
          "isRequired": false,
          "description": "A text custom field definition for a centre",
          "customFieldSet": {
            "encodedKey": "8a19b63f74b9d6b10174bad54f21066c",
            "id": "_centres_custom_field_set",
            "name": "custom field set",
            "notes": "Custom field definitions for centre",
            "createdDate": "2020-09-23T13:52:45+0000",
            "lastModifiedDate": "2020-09-23T13:52:45+0000",
            "indexInList": 0,
            "type": "CENTRE_INFO",
            "usage": "SINGLE"
          },
          "indexInList": 0,
          "state": "NORMAL",
          "customFieldSelectionOptions": [],
          "validationPattern": "@#$",
          "viewRights": {
            "encodedKey": "8a19b63f74b9d6b10174bb3d56f20975",
            "isAccessibleByAllUsers": true,
            "roles": []
          },
          "editRights": {
            "encodedKey": "8a19b63f74b9d6b10174bb3d56f20976",
            "isAccessibleByAllUsers": false,
            "roles": []
          },
          "unique": true,
          "values": [],
          "amounts": {}
        },
        "value": "custom field value for cf 1",
        "indexInList": -1,
        "customFieldID": "centre_cf_1",
        "customFieldSetGroupIndex": -1
      },
      {
        "encodedKey": "8a19b63f74b9d6b10174bb3f856b09a8",
        "parentKey": "8a193c26722b51b701722d779e7122e0",
        "customFieldKey": "8a19b63f74b9d6b10174bb3d56f20977",
        "customField": {
          "encodedKey": "8a19b63f74b9d6b10174bb3d56f20977",
          "id": "cntr_cf_2",
          "creationDate": "2020-09-23T13:53:41+0000",
          "lastModifiedDate": "2020-09-23T13:53:41+0000",
          "name": "centre cf 2",
          "type": "CENTRE_INFO",
          "dataType": "CHECKBOX",
          "valueLength": "SHORT",
          "isDefault": false,
          "isRequired": false,
          "description": "a checkbox custom field definition for a centre",
          "customFieldSet": {
            "encodedKey": "8a19b63f74b9d6b10174bad54f21066c",
            "id": "_centres_custom_field_set",
            "name": "custom field set",
            "notes": "Custom field definitions for centre",
            "createdDate": "2020-09-23T13:52:45+0000",
            "lastModifiedDate": "2020-09-23T13:52:45+0000",
            "indexInList": 0,
            "type": "CENTRE_INFO",
            "usage": "SINGLE"
          },
          "indexInList": 1,
          "state": "NORMAL",
          "customFieldSelectionOptions": [],
          "viewRights": {
            "encodedKey": "8a19b63f74b9d6b10174bb3d56f20978",
            "isAccessibleByAllUsers": false,
            "roles": []
          },
          "editRights": {
            "encodedKey": "8a19b63f74b9d6b10174bb3dc2b70979",
            "isAccessibleByAllUsers": false,
            "roles": []
          },
          "unique": false,
          "values": [],
          "amounts": {}
        },
        "value": "FALSE",
        "indexInList": -1,
        "customFieldID": "cntr_cf_2",
        "customFieldSetGroupIndex": -1
      },
      {
        "encodedKey": "8a19b63f74b9d6b10174bb3f856b09aa",
        "parentKey": "8a193c26722b51b701722d779e7122e0",
        "customFieldKey": "8a19b63f74b9d6b10174bb3dc2b7097b",
        "customField": {
          "encodedKey": "8a19b63f74b9d6b10174bb3dc2b7097b",
          "id": "cntr_cf_Grp_1",
          "creationDate": "2020-09-23T13:54:31+0000",
          "lastModifiedDate": "2020-09-23T13:54:31+0000",
          "name": "cf grp 1",
          "type": "CENTRE_INFO",
          "dataType": "NUMBER",
          "valueLength": "SHORT",
          "isDefault": false,
          "isRequired": false,
          "description": "a number custom field definition",
          "customFieldSet": {
            "encodedKey": "8a19b63f74b9d6b10174bb3dc2b7097a",
            "id": "_cntr_cf_grp",
            "name": "cf grouped",
            "notes": "grouped centre custom field definitions",
            "createdDate": "2020-09-23T13:54:05+0000",
            "lastModifiedDate": "2020-09-23T13:54:05+0000",
            "indexInList": 1,
            "type": "CENTRE_INFO",
            "usage": "GROUPED"
          },
          "indexInList": 0,
          "state": "NORMAL",
          "customFieldSelectionOptions": [],
          "viewRights": {
            "encodedKey": "8a19b63f74b9d6b10174bb3dc2b7097c",
            "isAccessibleByAllUsers": false,
            "roles": []
          },
          "editRights": {
            "encodedKey": "8a19b63f74b9d6b10174bb3dc2b7097d",
            "isAccessibleByAllUsers": false,
            "roles": []
          },
          "unique": false,
          "values": [],
          "amounts": {}
        },
        "value": "12",
        "indexInList": -1,
        "customFieldID": "cntr_cf_Grp_1",
        "customFieldSetGroupIndex": 0
      },
      {
        "encodedKey": "8a19b63f74b9d6b10174bb3fea5b09b1",
        "parentKey": "8a193c26722b51b701722d779e7122e0",
        "customFieldKey": "8a19b63f74b9d6b10174bb3f17d10992",
        "customField": {
          "encodedKey": "8a19b63f74b9d6b10174bb3f17d10992",
          "id": "cntr_cf_grp_2",
          "creationDate": "2020-09-23T13:55:08+0000",
          "lastModifiedDate": "2020-09-23T13:57:45+0000",
          "name": "centre cf grp 2",
          "type": "CENTRE_INFO",
          "dataType": "SELECTION",
          "valueLength": "SHORT",
          "isDefault": false,
          "isRequired": false,
          "description": "a selection custom field definition for centres",
          "customFieldSet": {
            "encodedKey": "8a19b63f74b9d6b10174bb3dc2b7097a",
            "id": "_cntr_cf_grp",
            "name": "cf grouped",
            "notes": "grouped centre custom field definitions",
            "createdDate": "2020-09-23T13:54:05+0000",
            "lastModifiedDate": "2020-09-23T13:54:05+0000",
            "indexInList": 1,
            "type": "CENTRE_INFO",
            "usage": "GROUPED"
          },
          "indexInList": 1,
          "state": "NORMAL",
          "customFieldSelectionOptions": [
            {
              "encodedKey": "8a19b63f74b9d6b10174bb3f17d10995",
              "id": "1341939373",
              "value": "option 1",
              "score": "10"
            },
            {
              "encodedKey": "8a19b63f74b9d6b10174bb3f17d10996",
              "id": "414828471",
              "value": "option 2",
              "score": "-15"
            }
          ],
          "viewRights": {
            "encodedKey": "8a19b63f74b9d6b10174bb3f17d10993",
            "isAccessibleByAllUsers": true,
            "roles": []
          },
          "editRights": {
            "encodedKey": "8a19b63f74b9d6b10174bb3f17d10994",
            "isAccessibleByAllUsers": true,
            "roles": []
          },
          "unique": false,
          "values": [
            "option 1",
            "option 2"
          ],
          "amounts": {
            "option 1": "10",
            "option 2": "-15"
          }
        },
        "value": "option 2",
        "amount": "-15",
        "indexInList": -1,
        "customFieldID": "cntr_cf_grp_2",
        "customFieldSetGroupIndex": 0
      },
      {
        "encodedKey": "8a19b63f74b9d6b10174bb5405830a67",
        "parentKey": "8a193c26722b51b701722d779e7122e0",
        "customFieldKey": "8a19b63f74b9d6b10174bb5405830a64",
        "customField": {
          "encodedKey": "8a19b63f74b9d6b10174bb5405830a64",
          "id": "cntr_cf_usr_lnk",
          "creationDate": "2020-09-23T14:18:00+0000",
          "lastModifiedDate": "2020-09-23T14:18:00+0000",
          "name": "user link for centre",
          "type": "CENTRE_INFO",
          "dataType": "USER_LINK",
          "valueLength": "SHORT",
          "isDefault": false,
          "isRequired": false,
          "description": "a custom field definition linking to a specific user",
          "customFieldSet": {
            "encodedKey": "8a19b63f74b9d6b10174bad54f21066c",
            "id": "_centres_custom_field_set",
            "name": "custom field set",
            "notes": "Custom field definitions for centre",
            "createdDate": "2020-09-23T13:52:45+0000",
            "lastModifiedDate": "2020-09-23T13:52:45+0000",
            "indexInList": 0,
            "type": "CENTRE_INFO",
            "usage": "SINGLE"
          },
          "indexInList": 2,
          "state": "NORMAL",
          "customFieldSelectionOptions": [],
          "viewRights": {
            "encodedKey": "8a19b63f74b9d6b10174bb5405830a65",
            "isAccessibleByAllUsers": true,
            "roles": []
          },
          "editRights": {
            "encodedKey": "8a19b63f74b9d6b10174bb5405830a66",
            "isAccessibleByAllUsers": false,
            "roles": []
          },
          "unique": false,
          "values": [],
          "amounts": {}
        },
        "linkedEntityKeyValue": "8a19df0e730ee86f01730f4c3cf2074a",
        "indexInList": -1,
        "customFieldID": "cntr_cf_usr_lnk",
        "customFieldSetGroupIndex": -1
      },
      {
        "encodedKey": "8a19b63f74b9d6b10174bb66462a0a7e",
        "parentKey": "8a193c26722b51b701722d779e7122e0",
        "customFieldKey": "8a19b63f74b9d6b10174bb6646250a73",
        "customField": {
          "encodedKey": "8a19b63f74b9d6b10174bb6646250a73",
          "id": "cntr_cf_slct_2",
          "creationDate": "2020-09-23T14:37:56+0000",
          "lastModifiedDate": "2020-09-23T14:37:56+0000",
          "name": "centre cf select 2",
          "type": "CENTRE_INFO",
          "dataType": "SELECTION",
          "valueLength": "LONG",
          "isDefault": false,
          "isRequired": false,
          "description": "a custom field definition in which the options available are dependent on another field",
          "customFieldSet": {
            "encodedKey": "8a19b63f74b9d6b10174bb3dc2b7097a",
            "id": "_cntr_cf_grp",
            "name": "cf grouped",
            "notes": "grouped centre custom field definitions",
            "createdDate": "2020-09-23T13:54:05+0000",
            "lastModifiedDate": "2020-09-23T13:54:05+0000",
            "indexInList": 1,
            "type": "CENTRE_INFO",
            "usage": "GROUPED"
          },
          "indexInList": 2,
          "state": "NORMAL",
          "customFieldSelectionOptions": [
            {
              "encodedKey": "8a19b63f74b9d6b10174bb6646250a76",
              "id": "996554077",
              "value": "dep 1 a",
              "score": "12",
              "constraint": {
                "encodedKey": "8a19b63f74b9d6b10174bb6646250a77",
                "dataFieldType": "CUSTOM",
                "dataItemType": "CENTRE",
                "dataType": "STRING",
                "customFieldKey": "8a19b63f74b9d6b10174bb3f17d10992",
                "filterElement": "EQUALS",
                "value": "8a19b63f74b9d6b10174bb3f17d10995",
                "linkingOperator": "AND",
                "groupNumber": 0
              }
            },
            {
              "encodedKey": "8a19b63f74b9d6b10174bb6646280a78",
              "id": "656383934",
              "value": "dep 1 b",
              "score": "-3",
              "constraint": {
                "encodedKey": "8a19b63f74b9d6b10174bb6646280a79",
                "dataFieldType": "CUSTOM",
                "dataItemType": "CENTRE",
                "dataType": "STRING",
                "customFieldKey": "8a19b63f74b9d6b10174bb3f17d10992",
                "filterElement": "EQUALS",
                "value": "8a19b63f74b9d6b10174bb3f17d10995",
                "linkingOperator": "AND",
                "groupNumber": 0
              }
            },
            {
              "encodedKey": "8a19b63f74b9d6b10174bb6646280a7a",
              "id": "745255722",
              "value": "dep 2 a",
              "score": "10",
              "constraint": {
                "encodedKey": "8a19b63f74b9d6b10174bb6646280a7b",
                "dataFieldType": "CUSTOM",
                "dataItemType": "CENTRE",
                "dataType": "STRING",
                "customFieldKey": "8a19b63f74b9d6b10174bb3f17d10992",
                "filterElement": "EQUALS",
                "value": "8a19b63f74b9d6b10174bb3f17d10996",
                "linkingOperator": "AND",
                "groupNumber": 0
              }
            },
            {
              "encodedKey": "8a19b63f74b9d6b10174bb6646280a7c",
              "id": "2093285980",
              "value": "dep 2 b",
              "score": "-5",
              "constraint": {
                "encodedKey": "8a19b63f74b9d6b10174bb66462a0a7d",
                "dataFieldType": "CUSTOM",
                "dataItemType": "CENTRE",
                "dataType": "STRING",
                "customFieldKey": "8a19b63f74b9d6b10174bb3f17d10992",
                "filterElement": "EQUALS",
                "value": "8a19b63f74b9d6b10174bb3f17d10996",
                "linkingOperator": "AND",
                "groupNumber": 0
              }
            }
          ],
          "viewRights": {
            "encodedKey": "8a19b63f74b9d6b10174bb6646250a74",
            "isAccessibleByAllUsers": true,
            "roles": []
          },
          "editRights": {
            "encodedKey": "8a19b63f74b9d6b10174bb6646250a75",
            "isAccessibleByAllUsers": false,
            "roles": []
          },
          "unique": false
        },
        "value": "dep 2 a",
        "amount": "10",
        "indexInList": -1,
        "customFieldID": "cntr_cf_slct_2",
        "customFieldSetGroupIndex": 0
      }
    ]
  },
  {
    "encodedKey": "8a193c26722b51b701722d779e7122e1",
    "id": "MP1",
    "creationDate": "2020-05-19T15:05:23+0000",
    "lastModifiedDate": "2020-05-19T15:05:23+0000",
    "name": "Market Place",
    "state": "ACTIVE",
    "notes": "All clients and officers gather in the market to discuss loans and savings situation.",
    "assignedBranchKey": "8a193c26722b51b701722d779e7122df",
    "address": {
      "encodedKey": "8a193c26722b51b701722d77c25e22e3",
      "parentKey": "8a193c26722b51b701722d779e7122e1",
      "line1": "Hegyalja út 95.",
      "city": "Debrecen",
      "postcode": "4032",
      "indexInList": -1
    },
    "customFieldValues": []
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[CentreApiV1]	none	none
» address	AddressApiV1	none	none
»» addressType	string	the type of the address, eg. home, office. Deprecated.	none
»» city	string	the city	none
»» country	string	the country	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» indexInList	integer	the index of this address when there are multiple addresses assigned for a single entity	none
»» latitude	number	the latitude of the address point	none
»» line1	string	the first line of the address	none
»» line2	string	the second line of the address	none
»» longitude	number	the longitude of the address point	none
»» parentKey	string	the encoded key of the entity to whom this address belongs, for example, the client of group	none
»» postcode	string	the postal (zip) code of the address	none
»» region	string	the region of the address	none
»» toBeDeleted	boolean	whether this address is marked to be deleted	none
» assignedBranchKey	string	the encoded key of the branch associated with this centre	none
» creationDate	string	the date on which this centre was created	none
» customFieldValues	[CustomFieldValueApiV1]	none	none
»» amount	number	none	none
»» customField	CustomFieldApiV1	none	none
»»» amounts	object	used when options available for a custom field definition translate to predefined amounts, for example, when the custom field value is used to generate a score	none
»»»» additionalProperties	number	none	none
»»» builtInCustomFieldId	string	if this field is one of the built in custom fiel definitions, this will have a value. These names are reserved and you can not use them for your own custom field definitions	none
»»» creationDate	string	the date on which this custom field definition was created	none
»»» customFieldProductSettings	[CustomFieldLinkApiV1]	none	none
»»»» customFieldEncodedKey	string	the key to the parent custom field definition	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isDefault	boolean	whether this field is displayed by default when creating a new record	none
»»»» isRequired	boolean	whether this field is required when creating a new record	none
»»»» linkType	string	the type of entity this field represents a link to	none
»»»» productKey	string	when the link type is product, this field should contain the encoded key of the linekd product	none
»»» customFieldSelectionOptions	[CustomFieldSelectionApiV1]	[represents a possible selection for select type custom field definitions]	none
»»»» constraint	CustomFilterConstraintApiV1	none	none
»»»»» customFieldKey	string	none	none
»»»»» dataFieldType	string	none	none
»»»»» dataFieldValue	string	none	none
»»»»» dataItemType	string	none	none
»»»»» dataType	string	none	none
»»»»» encodedKey	string	none	none
»»»»» filterElement	string	none	none
»»»»» groupNumber	number	none	none
»»»»» index	number	none	none
»»»»» linkingOperator	string	none	none
»»»»» secondValue	string	none	none
»»»»» value	string	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this selectable item	none
»»»» score	number	the score assigned to this selection	none
»»»» value	string	display name of this option	none
»»» customFieldSet	CustomFieldSetApiV1	none	none
»»»» builtInType	string	if this set is part of the set of built-in custom field sets, its type will be shown here	none
»»»» createdDate	string	the date and time when this custom field set was created	none
»»»» customFields	[CustomFieldApiV1]	an array of custom field definitions included in this custom field set	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this custom field set	none
»»»» indexInList	number	for field sets that can be added to an entity more than once, this number represents the index in the list and is used when changing values	none
»»»» lastModifiedDate	string	the date on which this custom field set was last modified	none
»»»» name	string	the name of this custom field set	none
»»»» notes	string	any notes regarding this custom field set	none
»»»» type	string	the entity type that this custom field definition is attached to	none
»»»» usage	string	whether this custom field set can only be used once, or added multiple times to the same entity	none
»»» dataType	string	the type of custom field definition	none
»»» description	string	a brief description of this custom field definition	none
»»» editRights	UsageRightsApiV1	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isAccessibleByAllUsers	boolean	none	none
»»»» roles	[string]	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» id	string	the ID for this custom field definition	none
»»» indexInList	number	none	none
»»» isDefault	boolean	whether this field will be included by default on new records	none
»»» isRequired	boolean	whether this field is required when creating a new record	none
»»» lastModifiedDate	string	the date on which this custom field definition was last modified	none
»»» name	string	the name of this custom field definition	none
»»» state	string	whether this field is available for use or has been deactivated	none
»»» type	string	the type of data this custom field definition will contain	none
»»» unique	boolean	whether the data in this custom field definition needs to be a unique value	none
»»» validationPattern	string	a user-provided pattern to which data in this custom field definition must conform where @ represents numbers, # represents letters and $ is either a number or letter. Other special characters used as separators are allowed, for example `@@-##-$$$`	none
»»» valueLength	string	whether this field needs to support a large number of characters	none
»»» values	[string]	a list of possible values when the field is a selection field	none
»»» viewRights	UsageRightsApiV1	none	none
»» customFieldID	string	none	none
»» customFieldKey	string	none	none
»» customFieldSetGroupIndex	number	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» indexInList	number	none	none
»» linkedEntityKeyValue	string	none	none
»» parentKey	string	none	none
»» selectionKey	string	none	none
»» value	string	none	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» id	string	the user provided ID for this centre	none
» lastModifiedDate	string	the date on which this branch was last modified	none
» meetingDay	string	the day of the week that this centre meets. This may have an impact when calculating repayment days or arrears periods for loans associated with this centre	none
» name	string	the name of the centre	none
» notes	string	notes associated with this centre	none
» state	string	whether this centre is active	none

Enumerated Values

Property	Value
builtInCustomFieldId	`MOBILE_PHONE`
builtInCustomFieldId	`EMAIL_ADDRESS`
builtInCustomFieldId	`GENDER`
builtInCustomFieldId	`MIDDLE_NAME`
builtInCustomFieldId	`HOME_PHONE`
builtInCustomFieldId	`BIRTHDATE`
builtInCustomFieldId	`LAST_NAME`
builtInCustomFieldId	`FIRST_NAME`
linkType	`CLIENT_ROLE`
linkType	`CHANNEL`
linkType	`PRODUCT`
dataFieldType	`NATIVE`
dataFieldType	`CUSTOM`
dataItemType	`WRITTEN_OFF_LOANS`
dataItemType	`LINE_OF_CREDIT`
dataItemType	`INVESTOR_FUND`
dataItemType	`TRANSACTION_DETAILS`
dataItemType	`DOCUMENT_TEMPLATE`
dataItemType	`PRODUCT`
dataItemType	`MCC_EXPIRATION`
dataItemType	`CENTRE`
dataItemType	`REPAYMENT_COLLECTION`
dataItemType	`TASK`
dataItemType	`OUTSTANDING_PORTFOLIO_AMOUNTS`
dataItemType	`REVENUE`
dataItemType	`COMPOSED_TRANSACTIONS`
dataItemType	`UNION_TRANSACTIONS`
dataItemType	`PRINCIPAL_PAYMENT_SETTINGS`
dataItemType	`LOANS`
dataItemType	`DISBURSEMENT_DETAILS`
dataItemType	`SAVINGS_TRANSACTION`
dataItemType	`IDENTIFICATION_DOCUMENT`
dataItemType	`LOAN_PRODUCT`
dataItemType	`DISBURSED_LOANS`
dataItemType	`LOAN_GROUP`
dataItemType	`TRANSACTION_CHANNEL`
dataItemType	`CUSTOM_PREDEFINED_FEE`
dataItemType	`JOURNAL_ENTRY`
dataItemType	`ATTACHMENT`
dataItemType	`PREDEFINED_FEE`
dataItemType	`TRANCHE`
dataItemType	`TRANSACTION`
dataItemType	`INDEX_RATE_SOURCE`
dataItemType	`GROUP_ROLE`
dataItemType	`LOAN_TRANSACTION`
dataItemType	`CLIENT_ROLE`
dataItemType	`GROUP`
dataItemType	`NOTIFICATION_MESSAGE`
dataItemType	`OUTSTANDING_PORTFOLIO_ACCOUNTS`
dataItemType	`REPAYMENT`
dataItemType	`LOAN_ACCOUNT_GUARANTY`
dataItemType	`BRANCH`
dataItemType	`CURRENCY`
dataItemType	`CARD_TRANSACTION_REVERSAL`
dataItemType	`INTEREST_PRODUCT_SETTINGS`
dataItemType	`CREATED_ACCOUNTS`
dataItemType	`USER`
dataItemType	`SAVINGS_PRODUCT`
dataItemType	`CLIENT`
dataItemType	`PRODUCT_ARREARS_SETTINGS`
dataItemType	`SAVINGS`
dataItemType	`EXPENSE`
dataItemType	`INDEX_RATE`
dataItemType	`NOTIFICATION_TEMPLATE`
dataItemType	`CUSTOM_FIELD_SELECTION`
dataItemType	`ACTIVITY`
dataType	`ENUM`
dataType	`MONEY`
dataType	`NUMBER`
dataType	`DATE_UTC`
dataType	`JAVA_BLOB`
dataType	`OBJECT`
dataType	`BOOLEAN`
dataType	`DATE`
dataType	`PERCENT`
dataType	`BIG_DECIMAL`
dataType	`STRING`
dataType	`KEY`
dataType	`LONG`
filterElement	`STARTS_WITH_CASE_SENSITIVE`
filterElement	`THIS_WEEK`
filterElement	`EQUALS`
filterElement	`STARTS_WITH`
filterElement	`IN`
filterElement	`TODAY`
filterElement	`THIS_YEAR`
filterElement	`BETWEEN`
filterElement	`AFTER`
filterElement	`LESS_THAN`
filterElement	`DIFFERENT_THAN`
filterElement	`THIS_MONTH`
filterElement	`NOT_EMPTY`
filterElement	`BEFORE`
filterElement	`EQUALS_CASE_SENSITIVE`
filterElement	`LAST_DAYS`
filterElement	`MORE_THAN`
filterElement	`EMPTY`
filterElement	`ON`
linkingOperator	`OR`
linkingOperator	`AND`
builtInType	`DETAILS`
builtInType	`GENERAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
usage	`SINGLE`
usage	`GROUPED`
dataType	`GROUP_LINK`
dataType	`DATE`
dataType	`NUMBER`
dataType	`CHECKBOX`
dataType	`CLIENT_LINK`
dataType	`STRING`
dataType	`USER_LINK`
dataType	`SELECTION`
state	`DEACTIVATED`
state	`NORMAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
valueLength	`SHORT`
valueLength	`LONG`
meetingDay	`WEDNESDAY`
meetingDay	`MONDAY`
meetingDay	`THURSDAY`
meetingDay	`SUNDAY`
meetingDay	`TUESDAY`
meetingDay	`FRIDAY`
meetingDay	`SATURDAY`
state	`ACTIVE`
state	`INACTIVE`

Get Centre by ID

GET /centres/{centreId}

Get a centre

get details on a specific centre by ID

Parameters

Name	Type	Description	In
centreId (required)	string	none	path
fullDetails	boolean	none	query

Example Responses

200 : ok
a centre with basic details

{
  "encodedKey": "8a193c26722b51b701722d779e7122e1",
  "id": "MP1",
  "creationDate": "2020-05-19T15:05:23+0000",
  "lastModifiedDate": "2020-05-19T15:05:23+0000",
  "name": "Market Place",
  "state": "ACTIVE",
  "assignedBranchKey": "8a193c26722b51b701722d779e7122df"
}

200 : ok
a centre with full details

{
  "encodedKey": "8a193c26722b51b701722d779e7122e0",
  "id": "DT1",
  "creationDate": "2020-05-19T15:05:23+0000",
  "lastModifiedDate": "2020-09-23T14:38:14+0000",
  "name": "Down Town",
  "state": "ACTIVE",
  "notes": "some rich text notes about this centre",
  "meetingDay": "FRIDAY",
  "assignedBranchKey": "8a193c26722b51b701722d779e7122de",
  "address": {
    "encodedKey": "8a19b63f74b9d6b10174bb3fea5b09b3",
    "parentKey": "8a193c26722b51b701722d779e7122e0",
    "line1": "Chuffington House",
    "line2": "123 Main High Road",
    "city": "Big Town",
    "region": "Big Conglomeration",
    "postcode": "123 456",
    "country": "Countrystan",
    "indexInList": -1
  },
  "customFieldValues": [
    {
      "encodedKey": "8a19b63f74b9d6b10174bb3f856b09a6",
      "parentKey": "8a193c26722b51b701722d779e7122e0",
      "customFieldKey": "8a19b63f74b9d6b10174bb3d56f20974",
      "customField": {
        "encodedKey": "8a19b63f74b9d6b10174bb3d56f20974",
        "id": "centre_cf_1",
        "creationDate": "2020-09-23T13:53:13+0000",
        "lastModifiedDate": "2020-09-23T14:27:10+0000",
        "name": "cf 1",
        "type": "CENTRE_INFO",
        "dataType": "STRING",
        "valueLength": "LONG",
        "isDefault": false,
        "isRequired": false,
        "description": "A text custom field definition for a centre",
        "customFieldSet": {
          "encodedKey": "8a19b63f74b9d6b10174bad54f21066c",
          "id": "_centres_custom_field_set",
          "name": "custom field set",
          "notes": "Custom field definitions for centre",
          "createdDate": "2020-09-23T13:52:45+0000",
          "lastModifiedDate": "2020-09-23T13:52:45+0000",
          "indexInList": 0,
          "type": "CENTRE_INFO",
          "usage": "SINGLE"
        },
        "indexInList": 0,
        "state": "NORMAL",
        "customFieldSelectionOptions": [],
        "validationPattern": "@#$",
        "viewRights": {
          "encodedKey": "8a19b63f74b9d6b10174bb3d56f20975",
          "isAccessibleByAllUsers": true,
          "roles": []
        },
        "editRights": {
          "encodedKey": "8a19b63f74b9d6b10174bb3d56f20976",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "unique": true,
        "values": [],
        "amounts": {}
      },
      "value": "custom field value for cf 1",
      "indexInList": -1,
      "customFieldID": "centre_cf_1",
      "customFieldSetGroupIndex": -1
    },
    {
      "encodedKey": "8a19b63f74b9d6b10174bb3f856b09a8",
      "parentKey": "8a193c26722b51b701722d779e7122e0",
      "customFieldKey": "8a19b63f74b9d6b10174bb3d56f20977",
      "customField": {
        "encodedKey": "8a19b63f74b9d6b10174bb3d56f20977",
        "id": "cntr_cf_2",
        "creationDate": "2020-09-23T13:53:41+0000",
        "lastModifiedDate": "2020-09-23T13:53:41+0000",
        "name": "centre cf 2",
        "type": "CENTRE_INFO",
        "dataType": "CHECKBOX",
        "valueLength": "SHORT",
        "isDefault": false,
        "isRequired": false,
        "description": "a checkbox custom field definition for a centre",
        "customFieldSet": {
          "encodedKey": "8a19b63f74b9d6b10174bad54f21066c",
          "id": "_centres_custom_field_set",
          "name": "custom field set",
          "notes": "Custom field definitions for centre",
          "createdDate": "2020-09-23T13:52:45+0000",
          "lastModifiedDate": "2020-09-23T13:52:45+0000",
          "indexInList": 0,
          "type": "CENTRE_INFO",
          "usage": "SINGLE"
        },
        "indexInList": 1,
        "state": "NORMAL",
        "customFieldSelectionOptions": [],
        "viewRights": {
          "encodedKey": "8a19b63f74b9d6b10174bb3d56f20978",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "editRights": {
          "encodedKey": "8a19b63f74b9d6b10174bb3dc2b70979",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "unique": false,
        "values": [],
        "amounts": {}
      },
      "value": "FALSE",
      "indexInList": -1,
      "customFieldID": "cntr_cf_2",
      "customFieldSetGroupIndex": -1
    },
    {
      "encodedKey": "8a19b63f74b9d6b10174bb3f856b09aa",
      "parentKey": "8a193c26722b51b701722d779e7122e0",
      "customFieldKey": "8a19b63f74b9d6b10174bb3dc2b7097b",
      "customField": {
        "encodedKey": "8a19b63f74b9d6b10174bb3dc2b7097b",
        "id": "cntr_cf_Grp_1",
        "creationDate": "2020-09-23T13:54:31+0000",
        "lastModifiedDate": "2020-09-23T13:54:31+0000",
        "name": "cf grp 1",
        "type": "CENTRE_INFO",
        "dataType": "NUMBER",
        "valueLength": "SHORT",
        "isDefault": false,
        "isRequired": false,
        "description": "a number custom field definition",
        "customFieldSet": {
          "encodedKey": "8a19b63f74b9d6b10174bb3dc2b7097a",
          "id": "_cntr_cf_grp",
          "name": "cf grouped",
          "notes": "grouped centre custom field definitions",
          "createdDate": "2020-09-23T13:54:05+0000",
          "lastModifiedDate": "2020-09-23T13:54:05+0000",
          "indexInList": 1,
          "type": "CENTRE_INFO",
          "usage": "GROUPED"
        },
        "indexInList": 0,
        "state": "NORMAL",
        "customFieldSelectionOptions": [],
        "viewRights": {
          "encodedKey": "8a19b63f74b9d6b10174bb3dc2b7097c",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "editRights": {
          "encodedKey": "8a19b63f74b9d6b10174bb3dc2b7097d",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "unique": false,
        "values": [],
        "amounts": {}
      },
      "value": "12",
      "indexInList": -1,
      "customFieldID": "cntr_cf_Grp_1",
      "customFieldSetGroupIndex": 0
    },
    {
      "encodedKey": "8a19b63f74b9d6b10174bb3fea5b09b1",
      "parentKey": "8a193c26722b51b701722d779e7122e0",
      "customFieldKey": "8a19b63f74b9d6b10174bb3f17d10992",
      "customField": {
        "encodedKey": "8a19b63f74b9d6b10174bb3f17d10992",
        "id": "cntr_cf_grp_2",
        "creationDate": "2020-09-23T13:55:08+0000",
        "lastModifiedDate": "2020-09-23T13:57:45+0000",
        "name": "centre cf grp 2",
        "type": "CENTRE_INFO",
        "dataType": "SELECTION",
        "valueLength": "SHORT",
        "isDefault": false,
        "isRequired": false,
        "description": "a selection custom field definition for centres",
        "customFieldSet": {
          "encodedKey": "8a19b63f74b9d6b10174bb3dc2b7097a",
          "id": "_cntr_cf_grp",
          "name": "cf grouped",
          "notes": "grouped centre custom field definitions",
          "createdDate": "2020-09-23T13:54:05+0000",
          "lastModifiedDate": "2020-09-23T13:54:05+0000",
          "indexInList": 1,
          "type": "CENTRE_INFO",
          "usage": "GROUPED"
        },
        "indexInList": 1,
        "state": "NORMAL",
        "customFieldSelectionOptions": [
          {
            "encodedKey": "8a19b63f74b9d6b10174bb3f17d10995",
            "id": "1341939373",
            "value": "option 1",
            "score": "10"
          },
          {
            "encodedKey": "8a19b63f74b9d6b10174bb3f17d10996",
            "id": "414828471",
            "value": "option 2",
            "score": "-15"
          }
        ],
        "viewRights": {
          "encodedKey": "8a19b63f74b9d6b10174bb3f17d10993",
          "isAccessibleByAllUsers": true,
          "roles": []
        },
        "editRights": {
          "encodedKey": "8a19b63f74b9d6b10174bb3f17d10994",
          "isAccessibleByAllUsers": true,
          "roles": []
        },
        "unique": false,
        "values": [
          "option 1",
          "option 2"
        ],
        "amounts": {
          "option 1": "10",
          "option 2": "-15"
        }
      },
      "value": "option 2",
      "amount": "-15",
      "indexInList": -1,
      "customFieldID": "cntr_cf_grp_2",
      "customFieldSetGroupIndex": 0
    },
    {
      "encodedKey": "8a19b63f74b9d6b10174bb5405830a67",
      "parentKey": "8a193c26722b51b701722d779e7122e0",
      "customFieldKey": "8a19b63f74b9d6b10174bb5405830a64",
      "customField": {
        "encodedKey": "8a19b63f74b9d6b10174bb5405830a64",
        "id": "cntr_cf_usr_lnk",
        "creationDate": "2020-09-23T14:18:00+0000",
        "lastModifiedDate": "2020-09-23T14:18:00+0000",
        "name": "user link for centre",
        "type": "CENTRE_INFO",
        "dataType": "USER_LINK",
        "valueLength": "SHORT",
        "isDefault": false,
        "isRequired": false,
        "description": "a custom field definition linking to a specific user",
        "customFieldSet": {
          "encodedKey": "8a19b63f74b9d6b10174bad54f21066c",
          "id": "_centres_custom_field_set",
          "name": "custom field set",
          "notes": "Custom field definitions for centre",
          "createdDate": "2020-09-23T13:52:45+0000",
          "lastModifiedDate": "2020-09-23T13:52:45+0000",
          "indexInList": 0,
          "type": "CENTRE_INFO",
          "usage": "SINGLE"
        },
        "indexInList": 2,
        "state": "NORMAL",
        "customFieldSelectionOptions": [],
        "viewRights": {
          "encodedKey": "8a19b63f74b9d6b10174bb5405830a65",
          "isAccessibleByAllUsers": true,
          "roles": []
        },
        "editRights": {
          "encodedKey": "8a19b63f74b9d6b10174bb5405830a66",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "unique": false,
        "values": [],
        "amounts": {}
      },
      "linkedEntityKeyValue": "8a19df0e730ee86f01730f4c3cf2074a",
      "indexInList": -1,
      "customFieldID": "cntr_cf_usr_lnk",
      "customFieldSetGroupIndex": -1
    },
    {
      "encodedKey": "8a19b63f74b9d6b10174bb66462a0a7e",
      "parentKey": "8a193c26722b51b701722d779e7122e0",
      "customFieldKey": "8a19b63f74b9d6b10174bb6646250a73",
      "customField": {
        "encodedKey": "8a19b63f74b9d6b10174bb6646250a73",
        "id": "cntr_cf_slct_2",
        "creationDate": "2020-09-23T14:37:56+0000",
        "lastModifiedDate": "2020-09-23T14:37:56+0000",
        "name": "centre cf select 2",
        "type": "CENTRE_INFO",
        "dataType": "SELECTION",
        "valueLength": "LONG",
        "isDefault": false,
        "isRequired": false,
        "description": "a custom field definition in which the options available are dependent on another field",
        "customFieldSet": {
          "encodedKey": "8a19b63f74b9d6b10174bb3dc2b7097a",
          "id": "_cntr_cf_grp",
          "name": "cf grouped",
          "notes": "grouped centre custom field definitions",
          "createdDate": "2020-09-23T13:54:05+0000",
          "lastModifiedDate": "2020-09-23T13:54:05+0000",
          "indexInList": 1,
          "type": "CENTRE_INFO",
          "usage": "GROUPED"
        },
        "indexInList": 2,
        "state": "NORMAL",
        "customFieldSelectionOptions": [
          {
            "encodedKey": "8a19b63f74b9d6b10174bb6646250a76",
            "id": "996554077",
            "value": "dep 1 a",
            "score": "12",
            "constraint": {
              "encodedKey": "8a19b63f74b9d6b10174bb6646250a77",
              "dataFieldType": "CUSTOM",
              "dataItemType": "CENTRE",
              "dataType": "STRING",
              "customFieldKey": "8a19b63f74b9d6b10174bb3f17d10992",
              "filterElement": "EQUALS",
              "value": "8a19b63f74b9d6b10174bb3f17d10995",
              "linkingOperator": "AND",
              "groupNumber": 0
            }
          },
          {
            "encodedKey": "8a19b63f74b9d6b10174bb6646280a78",
            "id": "656383934",
            "value": "dep 1 b",
            "score": "-3",
            "constraint": {
              "encodedKey": "8a19b63f74b9d6b10174bb6646280a79",
              "dataFieldType": "CUSTOM",
              "dataItemType": "CENTRE",
              "dataType": "STRING",
              "customFieldKey": "8a19b63f74b9d6b10174bb3f17d10992",
              "filterElement": "EQUALS",
              "value": "8a19b63f74b9d6b10174bb3f17d10995",
              "linkingOperator": "AND",
              "groupNumber": 0
            }
          },
          {
            "encodedKey": "8a19b63f74b9d6b10174bb6646280a7a",
            "id": "745255722",
            "value": "dep 2 a",
            "score": "10",
            "constraint": {
              "encodedKey": "8a19b63f74b9d6b10174bb6646280a7b",
              "dataFieldType": "CUSTOM",
              "dataItemType": "CENTRE",
              "dataType": "STRING",
              "customFieldKey": "8a19b63f74b9d6b10174bb3f17d10992",
              "filterElement": "EQUALS",
              "value": "8a19b63f74b9d6b10174bb3f17d10996",
              "linkingOperator": "AND",
              "groupNumber": 0
            }
          },
          {
            "encodedKey": "8a19b63f74b9d6b10174bb6646280a7c",
            "id": "2093285980",
            "value": "dep 2 b",
            "score": "-5",
            "constraint": {
              "encodedKey": "8a19b63f74b9d6b10174bb66462a0a7d",
              "dataFieldType": "CUSTOM",
              "dataItemType": "CENTRE",
              "dataType": "STRING",
              "customFieldKey": "8a19b63f74b9d6b10174bb3f17d10992",
              "filterElement": "EQUALS",
              "value": "8a19b63f74b9d6b10174bb3f17d10996",
              "linkingOperator": "AND",
              "groupNumber": 0
            }
          }
        ],
        "viewRights": {
          "encodedKey": "8a19b63f74b9d6b10174bb6646250a74",
          "isAccessibleByAllUsers": true,
          "roles": []
        },
        "editRights": {
          "encodedKey": "8a19b63f74b9d6b10174bb6646250a75",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "unique": false
      },
      "value": "dep 2 a",
      "amount": "10",
      "indexInList": -1,
      "customFieldID": "cntr_cf_slct_2",
      "customFieldSetGroupIndex": 0
    }
  ]
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	CentreApiV1

Update Custom Info for Centre

PATCH /centres/{centreId}/custominformation

Update custom field values for a centre

Update custom field values

Example requests

Update a single custom field value

{
  "customInformation": [
    {
      "customFieldID": "custom_field_2",
      "value": "3"
    }
  ]
}

Update a field in a group

{
  "customInformation": [
    {
      "customFieldID": "cf_grouped_field",
      "value": "new value",
      "customFieldSetGroupIndex": "0"
    }
  ]
}

Update multiple custom field values

{
  "customInformation": [
    {
      "customFieldID": "cf_grouped_field_2",
      "value": "3",
      "customFieldSetGroupIndex": "0"
    },
    {
      "customFieldID": "field_3",
      "value": "divorced"
    }
  ]
}

Parameters

Name	Type	Description	In
customInformation	[object]	none	body
» customFieldID (required)	string	none	body
» value (required)	string	none	body
» customFieldSetGroupIndex	string	Required if field to update is part of a group, if the Field Set Group Index is not set, a new group will be created with the value provided.	body
centreId (required)	string	The ID of the centre	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Get Custom Info for Centre

GET /centres/{centreId}/custominformation/{customFieldId}

Get a custom field definition for a centre

Allows retrieving a custom field definition for a given centre directly by the ID/key of the centre and the ID/key of the custom field definition.

Parameters

Name	Type	Description	In
centreId (required)	string	The ID of the centre.	path
customFieldId (required)	string	The ID of the custom field definition.	path

Example Responses

200 : OK
A custom field definition

[
  {
    "encodedKey": "8a19cd6f74674df9017467f25aab02c6",
    "parentKey": "8a193c26722b51b701722d779e7122de",
    "customFieldKey": "8a19cd6f74674df9017467ef8e6802af",
    "customField": {
      "encodedKey": "8a19cd6f74674df9017467ef8e6802af",
      "id": "cf_centre",
      "creationDate": "2020-09-07T09:42:33+0000",
      "lastModifiedDate": "2020-09-07T09:42:33+0000",
      "name": "Example Custom Field Definition",
      "type": "BRANCH_INFO",
      "dataType": "CHECKBOX",
      "valueLength": "SHORT",
      "isDefault": false,
      "isRequired": false,
      "description": "an example of a checkbox custom field definition",
      "customFieldSet": {
        "encodedKey": "8a19cd6f74674df9017467ef8e6802ae",
        "id": "_example_centre_custom_field_set",
        "name": "example centre custom field set",
        "notes": "example custom field set",
        "createdDate": "2020-09-07T09:41:50+0000",
        "lastModifiedDate": "2020-09-07T09:41:50+0000",
        "indexInList": 2,
        "type": "BRANCH_INFO",
        "usage": "SINGLE"
      },
      "indexInList": 0,
      "state": "NORMAL",
      "customFieldSelectionOptions": [],
      "viewRights": {
        "encodedKey": "8a19cd6f74674df9017467ef8e6802b0",
        "isAccessibleByAllUsers": false,
        "roles": []
      },
      "editRights": {
        "encodedKey": "8a19cd6f74674df9017467ef8e6802b1",
        "isAccessibleByAllUsers": false,
        "roles": []
      },
      "unique": false,
      "values": [],
      "amounts": {}
    },
    "value": "TRUE",
    "indexInList": -1,
    "customFieldID": "cf_centre",
    "customFieldSetGroupIndex": -1
  }
]

404 : Not Found
not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	CustomFieldApiV1
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Update Custom Field Value for Centre

PATCH /centres/{centreId}/custominformation/{customFieldId}

Update a custom field value for a centre

Update a custom field value for a centre custom field definition

Example Requests

Update the custom field value

{
  "value": "New custom field value"
}

Parameters

Name	Type	Description	In
value	string	none	body
centreId (required)	string	The ID of the centre.	path
customFieldId (required)	string	The ID of the custom field definition.	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
field is part of a group

{
  "returnCode": 916,
  "returnStatus": "INVALID_CUSTOM_FIELD_GROUP_INDEX",
  "errorSource": "cf_group_field_2"
}

404 : Not Found
not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Delete Custom Field Value for Centre

DELETE /centres/{centreId}/custominformation/{customFieldId}

Delete Custom Field Value

Delete a single custom field value

Parameters

Name	Type	Description	In
centreId (required)	string	The ID of the centre.	path
customFieldId (required)	string	The ID of the custom field definition.	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
field is part of a group

{
  "returnCode": 916,
  "returnStatus": "INVALID_CUSTOM_FIELD_GROUP_INDEX",
  "errorSource": "cf_group_field_2"
}

404 : Not Found
not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Update Custom Info (grouped) for Centre

PATCH /centres/{centreId}/custominformation/{customFieldId}/{customFieldGroupSetIndex}

Update grouped custom field value

Update custom field value, which is part of a group

Example Requests

Update custom field value

{
  "value": "New grouped custom field value"
}

Parameters

Name	Type	Description	In
value	string	none	body
centreId (required)	string	The ID of the centre	path
customFieldId (required)	string	The ID of the custom field definition.	path
customFieldGroupSetIndex (required)	string	none	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
wrong group index provided

{
  "returnCode": 916,
  "returnStatus": "INVALID_CUSTOM_FIELD_GROUP_INDEX",
  "errorSource": "cf_group_field_2"
}

404 : Not Found
field not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Delete Custom Info (grouped) for Centre

DELETE /centres/{centreId}/custominformation/{customFieldId}/{customFieldGroupSetIndex}

Delete grouped custom field value

Delete a custom field value, which is part of a group

Parameters

Name	Type	Description	In
centreId (required)	string	The ID of the centre	path
customFieldId (required)	string	The ID of the custom field definition.	path
customFieldGroupSetIndex (required)	string	none	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Get Comments for Centre

GET /centres/{centreId}/comments

Get all centre comments

get all comments for a centre

Parameters

Name	Type	Description	In
limit	string	none	query
offset	string	none	query
centreId (required)	string	the ID of the centre	path

Example Responses

200 : OK
an array of comments

[
  {
    "encodedKey": "8a19b7057471f4af017472dc0fd80470",
    "parentKey": "8a193c26722b51b701722d77c5e423b7",
    "userKey": "8a194075720ece2c017226fced6f005e",
    "creationDate": "2020-09-09T14:24:42+0000",
    "lastModifiedDate": "2020-09-09T14:24:42+0000",
    "text": "aanother afmaefomaef<div><br /></div><div><u>aefaefaf</u></div><div><u><br /></u></div><div><u>afaef</u></div>"
  },
  {
    "encodedKey": "8a193c26722b51b701722d77c8bf25ab",
    "parentKey": "8a193c26722b51b701722d77c5e423b7",
    "creationDate": "2020-05-19T15:05:24+0000",
    "lastModifiedDate": "2020-05-19T15:05:24+0000",
    "text": "Should suggest she apply for the agriculture loan given the nature of their business"
  }
]

400 : Bad Request
bad centre ID

{
  "returnCode": 149,
  "returnStatus": "INVALID_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[CommentApiV1]	none	none
» creationDate	string(date-time)	the date and time at which this comment was added	none
» encodedKey	string	a unique key for this comment	none
» lastModifiedDate	string(date-time)	the date and time at which this comment was last modified	none
» parentKey	string	the unique key of the parent object for this comment, for example, the client or loan account to which it relates	none
» text	string	the text of the comment as a string, must be properly JSON escpaped if it contains special characters	none
» userKey	string	the unique key of the user who created the comment	none

Create Comment for Centre

POST /centres/{centreId}/comments

Create a centre Comment

create new comment for a centre

Example Requests

a comment

{
  "comment": {
    "text": "this is a comment with \" \" all kinds of : \\ / \"non compliant\" stuff & = which has been JSON escaped"
  }
}

Parameters

Name	Type	Description	In
comment	object	an object contining the comment	body
» text	string	text of the comment to be added. if adding complex content make sure it is properly JSON encoded before making your request	body
centreId (required)	string	the ID of the centre	path

Example Responses

200 : OK
a comment

{
  "encodedKey": "8a19c34574720f9e0174734a039f06e2",
  "parentKey": "8a193c26722b51b701722d77c5e423b7",
  "userKey": "8a194075720ece2c017226fced6f005e",
  "creationDate": "2020-09-09T14:39:36+0000",
  "lastModifiedDate": "2020-09-09T14:39:36+0000",
  "text": "this is a comment with \" \" all kinds of : \\ / non compliant stuff & = which has been JSON escaped"
}

400 : Bad Request
extra parameters in the request

{
  "returnCode": 27,
  "returnStatus": "PARAMETER_NOT_ALLOWED"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	CommentApiV1
`400`	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Get Documents for Centre

GET /centres/{centreId}/documents

Get documents for centre

Get all documents for a given centre

Parameters

Name	Type	Description	In
offset	integer	offset results. use with `limit` parameter to achieve paging	query
limit	integer	max number of records to return	query
centreId (required)	string	The Id of the centre	path

Example Responses

200 : ok
an array of documents

[
  {
    "encodedKey": "8a19c035747bf5b901747c5bfb04014b",
    "id": 51,
    "creationDate": "2020-09-11T08:52:48+0000",
    "lastModifiedDate": "2020-09-11T08:52:48+0000",
    "documentHolderKey": "8a193c26722b51b701722d779e7122df",
    "documentHolderType": "CENTRE",
    "name": "covid rules",
    "type": "png",
    "fileSize": 8258,
    "originalFilename": "Screenshot_2020-04-22_at_14.31.29.png",
    "location": "BRSIDSLFBOGAYZKUUKCOGGQEDOSEOD",
    "description": "some guidelines regarding covid",
    "createdByUserKey": "8a194075720ece2c017226fced6f005e",
    "userName": "big chief"
  },
  {
    "encodedKey": "8a19a3337476f2d00174775b6a3001ae",
    "id": 43,
    "creationDate": "2020-09-10T09:31:54+0000",
    "lastModifiedDate": "2020-09-10T09:31:54+0000",
    "documentHolderKey": "8a193c26722b51b701722d779e7122df",
    "documentHolderType": "CENTRE",
    "name": "centre doc",
    "type": "png",
    "fileSize": 32109,
    "originalFilename": "clients_duplicate_id.png",
    "location": "JRTBQGGVXFQRQRBDGBRWQCTXJNRWXP",
    "description": "centre doc desc",
    "createdByUserKey": "8a194075720ece2c017226fced6f005e",
    "userName": "big chief"
  }
]

400 : Bad Request
bad centre ID

{
  "returnCode": 4,
  "returnStatus": "INVALID_PARAMETERS",
  "errorSource": "wrong owner id"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[DocumentApiV1]	none	none
» createdByUserKey	string	the encoded key of the user who added this document	none
» creationDate	string	the date and time when this document was created	none
» description	string	a description of this document	none
» documentHolderKey	string	the encoded key of the entity to which this document is attached	none
» documentHolderType	string	the type of entity, eg. client, loan product, to which this document is attached	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» fileSize	number	the size, in bytes, of the attached document	none
» id	number	an ID for this document	none
» lastModifiedDate	string	the date on which this document was last modified	none
» location	string	indicates where the document is saved	none
» name	string	the display name of this document	none
» originalFilename	string	the name of the originally uploaded file	none
» type	string	the file type of the document, eg. png, jpeg, pdf	none
» userName	string	the name of the user who uploaded the document	none

Enumerated Values

Property	Value
documentHolderType	`BRANCH`
documentHolderType	`LOAN_ACCOUNT`
documentHolderType	`GROUP`
documentHolderType	`DEPOSIT_ACCOUNT`
documentHolderType	`LINE_OF_CREDIT`
documentHolderType	`LOAN_PRODUCT`
documentHolderType	`GL_JOURNAL_ENTRY`
documentHolderType	`SAVINGS_PRODUCT`
documentHolderType	`USER`
documentHolderType	`CLIENT`
documentHolderType	`CENTRE`
documentHolderType	`ID_DOCUMENT`

Create Document for Centre

POST /centres/{centreId}/documents

Attach new Document to a centre

Attach a new document to a centre

Example Requests

a document to uplaod

{
  "document": {
    "documentHolderKey": "8a193c26722b51b701722d779e7122df",
    "documentHolderType": "CENTRE",
    "name": "some image",
    "type": "png",
    "description": "this is an image file"
  },
  "documentContent": "iVBORw0KGgoAAAANSUhEUgAAAnYAAAF0CAYAAACudHRvAAABQGlDQ1BJQ0MgUHJvZmlsZQAAKJFjYGASS=="
}

Parameters

Name	Type	Description	In
body	CreateDocumentApiV1	a new document to be attached to an entity	body
centreId (required)	string	The Id of the centre	path

Example Responses

201 : Created
uploaded document details

{
  "encodedKey": "8a19c035747bf5b901747c5bfb04014d",
  "id": 52,
  "creationDate": "2020-09-11T08:54:53+0000",
  "lastModifiedDate": "2020-09-11T08:54:53+0000",
  "documentHolderKey": "8a193c26722b51b701722d779e7122df",
  "documentHolderType": "CENTRE",
  "name": "some image",
  "type": "png",
  "fileSize": 32109,
  "originalFilename": "some_image.png",
  "location": "RCPOUIUHJFBYDRURQNNHMOGBEFIOQF",
  "description": "this is an image file",
  "createdByUserKey": "8a194075720ece2c017226fced6f005e"
}

400 : Bad Request
filetype provided does not match actual file type

{
  "returnCode": 973,
  "returnStatus": "INCONSISTENT_EXTENSION_WITH_FILE_CONTENT",
  "errorSource": "Invalid extension with file content"
}

Responses

Status	Meaning	Description	Schema
`201`	Created	Created	DocumentApiV1
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Get Document for Centre by ID

GET /centres/{centreId}/documents/{documentId}

Get a centre Document

Get a specific document attached to a centre

Parameters

Name	Type	Description	In
centreId (required)	string	the ID of the centre	path
documentId (required)	string	the ID of the document	path

Example Responses

200 : OK
base64 encoded document

"iVBORw0KGgoAAAANSUhEUgAAAEAAAAA9CAYAAAAd1W/BAAAMY2lDQ1BJQ0MgUHJvZmlsZQAASImVVwdck0cbv3dkkrACEZAR9hJFZgAZIawIAjIFUQlJIGHEmBBE3NRSBesWUZxoVUTRagWkDkSssyhu6yiKqFRqsYoLle8yoNZ+4/c9v9+993+fe+7/jNzlvQNAr5Mvk+Wj+gAUSAvlCZGhrElp6SzSI4ABU0ADtsCTL1DIOPHxMQDKUP93eX0DIKr+qpuK65/j/1UMhSKFAAAkA=="

400 : Bad Request
bad Document ID

{
  "returnCode": 970,
  "returnStatus": "INVALID_DOCUMENT_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	string
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Delete Document for Centre

DELETE /centres/{centreId}/documents/{documentId}

Delete a centre Document

Delete a document attached to a centre

Parameters

Name	Type	Description	In
centreId (required)	string	the ID of the centre	path
documentId (required)	string	the ID of the document	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
bad Document ID

{
  "returnCode": 970,
  "returnStatus": "INVALID_DOCUMENT_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	ExecutionStatusApiV1
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Client Types

Retrieves all the client types in the organization.

Get Client Types

GET /clienttypes

List client types

Get a list of client types in JSON format.

Parameters

Name	Type	Description	In
for	string	Filters client types.	query

Enumerated Values

Parameter	Value
for	`CLIENTS`
for	`GROUPS`

Example Responses

200 : ok
a list of client types

[
  {
    "encodedKey": "8a3e435149cd61eb0149cd74b1cb003b",
    "name": "Client",
    "id": "client",
    "clientType": "CLIENT",
    "creationDate": "2014-11-20T13:46:57+0000",
    "canOpenAccounts": true,
    "canGuarantee": true,
    "requireID": false,
    "index": -1
  },
  {
    "encodedKey": "8a0ca02a4ba46b0d014ba74fc5a30c00",
    "name": "Power of Attorney holders",
    "id": "Power",
    "clientType": "CLIENT",
    "creationDate": "2015-02-20T14:06:38+0000",
    "createdByUserKey": "8a8603b4497abb2101497b6c59cc0b33",
    "canOpenAccounts": false,
    "canGuarantee": false,
    "requireID": false,
    "index": 2147483647
  },
  {
    "encodedKey": "8a3edf494b25cedc014b2661f6d300b9",
    "name": "Guarantor",
    "id": "Guarantor",
    "clientType": "CLIENT",
    "creationDate": "2015-01-26T13:15:29+0000",
    "createdByUserKey": "8a8603b4497abb2101497b6c59cc0b33",
    "canOpenAccounts": false,
    "canGuarantee": true,
    "requireID": true,
    "index": 2147483647
  },
  {
    "encodedKey": "8a3e435149cd61eb0149cd74b9560044",
    "name": "Group",
    "id": "group",
    "clientType": "GROUP",
    "creationDate": "2014-11-20T13:46:59+0000",
    "canOpenAccounts": true,
    "canGuarantee": false,
    "requireID": false,
    "index": -1
  }
]

400 : Bad Request
bad filter value

{
  "returnCode": 4,
  "returnStatus": "INVALID_PARAMETERS",
  "errorSource": "invalid for parameter"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline
`400`	Bad Request	Bad Request	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[ClientRoleFullApiV1]	[the type of client or group as defined in Mambu in Administration > General Settings > Client Types]	none
» canGuarantee (required)	boolean	whether this client type can guarantee loans	none
» canOpenAccounts (required)	boolean	whether this client type can open accounts	none
» clientType (required)	string	which entity this type is valid for, either `CLIENT` or `GROUP`	none
» createdByUserKey	string	if this client type was not one of the defaults provided by Mambu the encoded key of the user who created it will be displayed here	none
» creationDate (required)	string(date-time)	timestamp of when this group was created	none
» description	string	description of this client type as provided through the Mambu UI	none
» encodedKey (required)	string	a unique ID for this client type	none
» id (required)	string	the machine-readable ID for this client type	none
» idPattern	string	the pattern used to generate IDs for clients of this type, `@` represents a random letter, `#` indicates a random number, `$` represents a random letter or number	none
» index (required)	number	if more than one role is assigned to this client, for example, if they are members of multiple groups, this number represents the index in the list	none
» name (required)	string	the human-readable name of this client type	none
» requireID (required)	boolean	whether ID is required for this client type	none
» useDefaultAddress (required)	boolean	whether an address can be associated with clients of this type	none

Enumerated Values

Property	Value
clientType	`GROUP`
clientType	`CLIENT`

Status Code 400

Name	Type	Description	Restrictions
» returnCode	string	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Clients

Allows you to view, create and update clients. Clients may have associated information such as their address, custom field values, or identification documents. It's also possible to search for clients using information such as as their names or identification documents.

Get Client's Custom Views with basic details

GET /clients?resultType=BASIC&viewfilter={viewfilter}

Get Client's Custom Views with basic details

get view filters for a client with basic details

Parameters

Name	Type	Description	In
branchId	string	none	query
offset	string	none	query
limit	string	none	query
resultType	string	none	query
viewfilter (required)	string	none	path

Example Responses

200 Response

[
  {
    "activationDate": "string",
    "approvedDate": "string",
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "birthDate": "string",
    "clientRole": {
      "encodedKey": "string"
    },
    "closedDate": "string",
    "creationDate": "string",
    "emailAddress": "string",
    "encodedKey": "string",
    "firstName": "string",
    "gender": "MALE",
    "groupLoanCycle": 0,
    "homePhone": "string",
    "id": "string",
    "idPattern": "string",
    "lastModifiedDate": "string",
    "lastName": "string",
    "loanCycle": 0,
    "middleName": "string",
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "mobilePhone1": "string",
    "mobilePhone2": "string",
    "notes": "string",
    "portalPreferences": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "lastLoggedInDate": "string",
      "password": "string",
      "portalState": "DISABLED"
    },
    "preferredLanguage": "PORTUGESE",
    "profilePictureKey": "string",
    "profileSignatureKey": "string",
    "state": "PENDING_APPROVAL"
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[ClientApiV1]	none	none
» activationDate	string	the date when the client was set to active, ie. an active account was created for them	none
» approvedDate	string	the date when the client was approved	none
» assignedBranchKey	string	the encoded key of the client's branch	none
» assignedCentreKey	string	the encoded key of the client's assigned centre	none
» assignedUserKey	string	the encoded key of the Mambu user associated with this client, eg. their credit officer	none
» birthDate	string	the date of birth of this client	none
» clientRole	ClientRoleBasicApiV1	the type of client or group as defined in Mambu in Administration > General Settings > Client Types	none
»» encodedKey	string	the automatically generated encoded ID for this client or group type	none
» closedDate	string	the date when the client was exited or blacklisted	none
» creationDate	string	the date on which this client record was created	none
» emailAddress	string	the email address of the client	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» firstName	string	the first name of the client	none
» gender	string	the client's gender	none
» groupLoanCycle	number	if this client is a member of a group, this number will increase by 1 each time they successfully close a loan as fully paid	none
» homePhone	string	a home contact number for this client	none
» id	string	the ID for this client	none
» idPattern	string	the pattern that is used to generate the client ID	none
» lastModifiedDate	string	the date on which this client record was last modified	none
» lastName	string	the last name of this client	none
» loanCycle	number	the number of loans this client has opened and closed as fully paid as an individual	none
» middleName	string	any middle names for this client	none
» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
»» creationDate	string(date-time)	the date on which the data import was made	none
»» encodedKey	string	the encoded key of this data migration event	none
»» numCentresImported	number	the number of centres which were imported during the data migration	none
»» numClientsImported	number	the number of clients which were imported as part of the data migration	none
»» numGLAccountsImported	number	the number of general ledger accounts which were imported as part of the data migration	none
»» numGroupsImported	number	the number of groups which were imported as part of the data migration	none
»» numLoanRepaymentsImported	number	the number of loan repayment transations which were imported as part of the data migration	none
»» numLoanTransactionsImported	number	the number of loan transactions which were imported as part of the data migration	none
»» numLoansImported	number	the number of loan accounts which were imported as part of the data migration	none
»» numSavingsImported	number	the number of savings accounts which were imported as part of the data migration	none
»» state	string	whether the data import was accepted, is still in a draft state, or was rejected and all data reverted	none
»» type	string	the type of migration event	none
» mobilePhone1	string	a mobile contact number for this client	none
» mobilePhone2	string	another mobile contact number for this client	none
» notes	string	any rich text notes about this client	none
» portalPreferences	PortalPreferencesApiV1	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» lastLoggedInDate	string	none	none
»» password	string	none	none
»» portalState	string	none	none
» preferredLanguage	string	the language which should be used when communicating with this client	none
» profilePictureKey	string	the encoded key of this user's proficle picture	none
» profileSignatureKey	string	the encoded key of the digital copy of this client's signature	none
» state	string	the current state of this client	none

Enumerated Values

Property	Value
gender	`MALE`
gender	`FEMALE`
state	`REVERTED`
state	`DRAFT`
state	`APPROVED`
type	`IMPORT`
type	`EXPORT`
portalState	`DISABLED`
portalState	`ENABLED`
preferredLanguage	`PORTUGESE`
preferredLanguage	`RUSSIAN`
preferredLanguage	`ROMANIAN`
preferredLanguage	`ENGLISH`
preferredLanguage	`SPANISH`
preferredLanguage	`GEORGIAN`
preferredLanguage	`BURMESE`
preferredLanguage	`PHRASE`
preferredLanguage	`CHINESE`
preferredLanguage	`FRENCH`
preferredLanguage	`INDONESIAN`
state	`PENDING_APPROVAL`
state	`ACTIVE`
state	`INACTIVE`
state	`EXITED`
state	`BLACKLISTED`
state	`REJECTED`

Get Client's Custom Views

GET /clients?resultType=FULL_DETAILS&viewfilter={viewfilter}

Get Client's Custom Views

get view filters for a client with full details

Parameters

Name	Type	Description	In
branchId	string	none	query
offset	string	none	query
limit	string	none	query
resultType	string	none	query
viewfilter (required)	string	none	path

Example Responses

200 Response

[
  {
    "addresses": [
      {
        "addressType": "string",
        "city": "string",
        "country": "string",
        "encodedKey": "string",
        "indexInList": 0,
        "latitude": 0,
        "line1": "string",
        "line2": "string",
        "longitude": 0,
        "parentKey": "string",
        "postcode": "string",
        "region": "string",
        "toBeDeleted": true
      }
    ],
    "centreId": "string",
    "client": {
      "activationDate": "string",
      "approvedDate": "string",
      "assignedBranchKey": "string",
      "assignedCentreKey": "string",
      "assignedUserKey": "string",
      "birthDate": "string",
      "clientRole": {
        "encodedKey": "string"
      },
      "closedDate": "string",
      "creationDate": "string",
      "emailAddress": "string",
      "encodedKey": "string",
      "firstName": "string",
      "gender": "MALE",
      "groupLoanCycle": 0,
      "homePhone": "string",
      "id": "string",
      "idPattern": "string",
      "lastModifiedDate": "string",
      "lastName": "string",
      "loanCycle": 0,
      "middleName": "string",
      "migrationEvent": {
        "creationDate": "2019-08-24T14:15:22Z",
        "encodedKey": "string",
        "numCentresImported": 0,
        "numClientsImported": 0,
        "numGLAccountsImported": 0,
        "numGroupsImported": 0,
        "numLoanRepaymentsImported": 0,
        "numLoanTransactionsImported": 0,
        "numLoansImported": 0,
        "numSavingsImported": 0,
        "state": "REVERTED",
        "type": "IMPORT"
      },
      "mobilePhone1": "string",
      "mobilePhone2": "string",
      "notes": "string",
      "portalPreferences": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "lastLoggedInDate": "string",
        "password": "string",
        "portalState": "DISABLED"
      },
      "preferredLanguage": "PORTUGESE",
      "profilePictureKey": "string",
      "profileSignatureKey": "string",
      "state": "PENDING_APPROVAL"
    },
    "clientTypeId": "string",
    "customInformation": [
      {
        "amount": 0,
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "customFieldID": "string",
        "customFieldKey": "string",
        "customFieldSetGroupIndex": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexInList": 0,
        "linkedEntityKeyValue": "string",
        "parentKey": "string",
        "selectionKey": "string",
        "value": "string"
      }
    ],
    "groupKeys": [
      "string"
    ],
    "idDocuments": [
      {
        "clientKey": "string",
        "documentId": "string",
        "documentType": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "identificationDocumentTemplateKey": "string",
        "indexInList": 0,
        "issuingAuthority": "string",
        "toBeDeleted": true,
        "validUntil": "string",
        "validUntilDTOdate": {
          "dayOfMonth": 0,
          "monthOfYear": 0,
          "year": 0
        }
      }
    ],
    "notificationTemplates": [
      {
        "activated": true,
        "authorization": "NO_AUTHORIZATION",
        "contentType": "PLAIN_TEXT",
        "creationDate": "string",
        "customFilter": {
          "customConfigurationInfo": {
            "creationDate": "string",
            "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "shared": true,
            "userKey": "string"
          },
          "encodedKey": "string",
          "filterConstraints": [
            {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            }
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "event": "LOAN_CREATED",
        "isInUse": true,
        "lastModifiedDate": "string",
        "name": "string",
        "option": "OPT_IN",
        "recipient": {
          "customField": {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "groupRole": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "name": "string"
          },
          "recipientType": "CREDIT_OFFICER"
        },
        "requestType": "HEAD",
        "subject": "string",
        "targetType": "LOANS",
        "template": "string",
        "topic": "string",
        "trigger": "AUTOMATIC",
        "triggerDays": 0,
        "type": "EVENT_STREAM",
        "url": "string",
        "username": "string"
      }
    ]
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[ClientExpandedApiV1]	none	none
» addresses	[AddressApiV1]	addresses associated with this client	none
»» addressType	string	the type of the address, eg. home, office. Deprecated.	none
»» city	string	the city	none
»» country	string	the country	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» indexInList	integer	the index of this address when there are multiple addresses assigned for a single entity	none
»» latitude	number	the latitude of the address point	none
»» line1	string	the first line of the address	none
»» line2	string	the second line of the address	none
»» longitude	number	the longitude of the address point	none
»» parentKey	string	the encoded key of the entity to whom this address belongs, for example, the client of group	none
»» postcode	string	the postal (zip) code of the address	none
»» region	string	the region of the address	none
»» toBeDeleted	boolean	whether this address is marked to be deleted	none
» centreId	string	the ID of the centre this client is assigned to	none
» client	ClientApiV1	none	none
»» activationDate	string	the date when the client was set to active, ie. an active account was created for them	none
»» approvedDate	string	the date when the client was approved	none
»» assignedBranchKey	string	the encoded key of the client's branch	none
»» assignedCentreKey	string	the encoded key of the client's assigned centre	none
»» assignedUserKey	string	the encoded key of the Mambu user associated with this client, eg. their credit officer	none
»» birthDate	string	the date of birth of this client	none
»» clientRole	ClientRoleBasicApiV1	the type of client or group as defined in Mambu in Administration > General Settings > Client Types	none
»»» encodedKey	string	the automatically generated encoded ID for this client or group type	none
»» closedDate	string	the date when the client was exited or blacklisted	none
»» creationDate	string	the date on which this client record was created	none
»» emailAddress	string	the email address of the client	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» firstName	string	the first name of the client	none
»» gender	string	the client's gender	none
»» groupLoanCycle	number	if this client is a member of a group, this number will increase by 1 each time they successfully close a loan as fully paid	none
»» homePhone	string	a home contact number for this client	none
»» id	string	the ID for this client	none
»» idPattern	string	the pattern that is used to generate the client ID	none
»» lastModifiedDate	string	the date on which this client record was last modified	none
»» lastName	string	the last name of this client	none
»» loanCycle	number	the number of loans this client has opened and closed as fully paid as an individual	none
»» middleName	string	any middle names for this client	none
»» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
»»» creationDate	string(date-time)	the date on which the data import was made	none
»»» encodedKey	string	the encoded key of this data migration event	none
»»» numCentresImported	number	the number of centres which were imported during the data migration	none
»»» numClientsImported	number	the number of clients which were imported as part of the data migration	none
»»» numGLAccountsImported	number	the number of general ledger accounts which were imported as part of the data migration	none
»»» numGroupsImported	number	the number of groups which were imported as part of the data migration	none
»»» numLoanRepaymentsImported	number	the number of loan repayment transations which were imported as part of the data migration	none
»»» numLoanTransactionsImported	number	the number of loan transactions which were imported as part of the data migration	none
»»» numLoansImported	number	the number of loan accounts which were imported as part of the data migration	none
»»» numSavingsImported	number	the number of savings accounts which were imported as part of the data migration	none
»»» state	string	whether the data import was accepted, is still in a draft state, or was rejected and all data reverted	none
»»» type	string	the type of migration event	none
»» mobilePhone1	string	a mobile contact number for this client	none
»» mobilePhone2	string	another mobile contact number for this client	none
»» notes	string	any rich text notes about this client	none
»» portalPreferences	PortalPreferencesApiV1	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» lastLoggedInDate	string	none	none
»»» password	string	none	none
»»» portalState	string	none	none
»» preferredLanguage	string	the language which should be used when communicating with this client	none
»» profilePictureKey	string	the encoded key of this user's proficle picture	none
»» profileSignatureKey	string	the encoded key of the digital copy of this client's signature	none
»» state	string	the current state of this client	none
» clientTypeId	string	the type of client	none
» customInformation	[CustomFieldValueApiV1]	custom information attached to this client record	none
»» amount	number	none	none
»» customField	CustomFieldApiV1	none	none
»»» amounts	object	used when options available for a custom field definition translate to predefined amounts, for example, when the custom field value is used to generate a score	none
»»»» additionalProperties	number	none	none
»»» builtInCustomFieldId	string	if this field is one of the built in custom fiel definitions, this will have a value. These names are reserved and you can not use them for your own custom field definitions	none
»»» creationDate	string	the date on which this custom field definition was created	none
»»» customFieldProductSettings	[CustomFieldLinkApiV1]	none	none
»»»» customFieldEncodedKey	string	the key to the parent custom field definition	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isDefault	boolean	whether this field is displayed by default when creating a new record	none
»»»» isRequired	boolean	whether this field is required when creating a new record	none
»»»» linkType	string	the type of entity this field represents a link to	none
»»»» productKey	string	when the link type is product, this field should contain the encoded key of the linekd product	none
»»» customFieldSelectionOptions	[CustomFieldSelectionApiV1]	[represents a possible selection for select type custom field definitions]	none
»»»» constraint	CustomFilterConstraintApiV1	none	none
»»»»» customFieldKey	string	none	none
»»»»» dataFieldType	string	none	none
»»»»» dataFieldValue	string	none	none
»»»»» dataItemType	string	none	none
»»»»» dataType	string	none	none
»»»»» encodedKey	string	none	none
»»»»» filterElement	string	none	none
»»»»» groupNumber	number	none	none
»»»»» index	number	none	none
»»»»» linkingOperator	string	none	none
»»»»» secondValue	string	none	none
»»»»» value	string	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this selectable item	none
»»»» score	number	the score assigned to this selection	none
»»»» value	string	display name of this option	none
»»» customFieldSet	CustomFieldSetApiV1	none	none
»»»» builtInType	string	if this set is part of the set of built-in custom field sets, its type will be shown here	none
»»»» createdDate	string	the date and time when this custom field set was created	none
»»»» customFields	[CustomFieldApiV1]	an array of custom field definitions included in this custom field set	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this custom field set	none
»»»» indexInList	number	for field sets that can be added to an entity more than once, this number represents the index in the list and is used when changing values	none
»»»» lastModifiedDate	string	the date on which this custom field set was last modified	none
»»»» name	string	the name of this custom field set	none
»»»» notes	string	any notes regarding this custom field set	none
»»»» type	string	the entity type that this custom field definition is attached to	none
»»»» usage	string	whether this custom field set can only be used once, or added multiple times to the same entity	none
»»» dataType	string	the type of custom field definition	none
»»» description	string	a brief description of this custom field definition	none
»»» editRights	UsageRightsApiV1	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isAccessibleByAllUsers	boolean	none	none
»»»» roles	[string]	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» id	string	the ID for this custom field definition	none
»»» indexInList	number	none	none
»»» isDefault	boolean	whether this field will be included by default on new records	none
»»» isRequired	boolean	whether this field is required when creating a new record	none
»»» lastModifiedDate	string	the date on which this custom field definition was last modified	none
»»» name	string	the name of this custom field definition	none
»»» state	string	whether this field is available for use or has been deactivated	none
»»» type	string	the type of data this custom field definition will contain	none
»»» unique	boolean	whether the data in this custom field definition needs to be a unique value	none
»»» validationPattern	string	a user-provided pattern to which data in this custom field definition must conform where @ represents numbers, # represents letters and $ is either a number or letter. Other special characters used as separators are allowed, for example `@@-##-$$$`	none
»»» valueLength	string	whether this field needs to support a large number of characters	none
»»» values	[string]	a list of possible values when the field is a selection field	none
»»» viewRights	UsageRightsApiV1	none	none
»» customFieldID	string	none	none
»» customFieldKey	string	none	none
»» customFieldSetGroupIndex	number	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» indexInList	number	none	none
»» linkedEntityKeyValue	string	none	none
»» parentKey	string	none	none
»» selectionKey	string	none	none
»» value	string	none	none
» groupKeys	[string]	the encoded keys of any groups this client belongs to	none
» idDocuments	[IdentificationDocumentApiV1]	an array of ID documents this client has provided	none
»» clientKey	string	the encoded key of the client with which this ID document is associated	none
»» documentId	string	the ID	none
»» documentType	string	the type of document, eg. passport, ID card	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» identificationDocumentTemplateKey	string	the ID template associated with this kind of ID	none
»» indexInList	number	if there is more than one ID document attached to a single entity, this number represents the index in the list of this particular document	none
»» issuingAuthority	string	the institution who provided this ID document, eg, Her Majesty's Passport Authority	none
»» toBeDeleted	boolean	whether this ID document is marked for deletion	none
»» validUntil	string	the last day on which this document can be used	none
»» validUntilDTOdate	DateDTOApiV1	none	none
»»» dayOfMonth	number	the day of the month	none
»»» monthOfYear	number	the month	none
»»» year	number	the year	none
» notificationTemplates	[MessageTemplateApiV1]	an array of notification templates which can be used to send messages to this client via email or sms	none
»» activated	boolean	none	none
»» authorization	string	none	none
»» contentType	string	none	none
»» creationDate	string	the date and time when this template was created	none
»» customFilter	CustomFilterApiV1	none	none
»»» customConfigurationInfo	CustomConfigurationInfoApiV1	none	none
»»»» creationDate	string	the date on which this configuration was created	none
»»»» dataViewType	string	the type of entity this configuration is for	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» indexInList	number	if more than one configuration exists for a given type, this is its index in the list	none
»»»» lastModifiedDate	string	the date on which this configuration was last modified	none
»»»» name	string	the name for this configuration	none
»»»» shared	boolean	whether this configuration is private or can be used by other users of the system	none
»»»» userKey	string	the encoded key of the Mambu user who created this configuration	none
»»» encodedKey	string	none	none
»»» filterConstraints	[CustomFilterConstraintApiV1]	none	none
»» encodedKey	string	the automatically generated encoded ID for this notification template	none
»» event	string	none	none
»» isInUse	boolean	none	none
»» lastModifiedDate	string	the date on which this notification template was last modified	none
»» name	string	none	none
»» option	string	none	none
»» recipient	MessageTemplateRecipientApiV1	none	none
»»» customField	CustomFieldApiV1	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» groupRole	GroupRoleNameApiV1	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» name	string	the name of this role	none
»»» recipientType	string	none	none
»» requestType	string	none	none
»» subject	string	none	none
»» targetType	string	none	none
»» template	string	none	none
»» topic	string	none	none
»» trigger	string	none	none
»» triggerDays	number	none	none
»» type	string	none	none
»» url	string	none	none
»» username	string	none	none

Enumerated Values

Property	Value
gender	`MALE`
gender	`FEMALE`
state	`REVERTED`
state	`DRAFT`
state	`APPROVED`
type	`IMPORT`
type	`EXPORT`
portalState	`DISABLED`
portalState	`ENABLED`
preferredLanguage	`PORTUGESE`
preferredLanguage	`RUSSIAN`
preferredLanguage	`ROMANIAN`
preferredLanguage	`ENGLISH`
preferredLanguage	`SPANISH`
preferredLanguage	`GEORGIAN`
preferredLanguage	`BURMESE`
preferredLanguage	`PHRASE`
preferredLanguage	`CHINESE`
preferredLanguage	`FRENCH`
preferredLanguage	`INDONESIAN`
state	`PENDING_APPROVAL`
state	`ACTIVE`
state	`INACTIVE`
state	`EXITED`
state	`BLACKLISTED`
state	`REJECTED`
builtInCustomFieldId	`MOBILE_PHONE`
builtInCustomFieldId	`EMAIL_ADDRESS`
builtInCustomFieldId	`GENDER`
builtInCustomFieldId	`MIDDLE_NAME`
builtInCustomFieldId	`HOME_PHONE`
builtInCustomFieldId	`BIRTHDATE`
builtInCustomFieldId	`LAST_NAME`
builtInCustomFieldId	`FIRST_NAME`
linkType	`CLIENT_ROLE`
linkType	`CHANNEL`
linkType	`PRODUCT`
dataFieldType	`NATIVE`
dataFieldType	`CUSTOM`
dataItemType	`WRITTEN_OFF_LOANS`
dataItemType	`LINE_OF_CREDIT`
dataItemType	`INVESTOR_FUND`
dataItemType	`TRANSACTION_DETAILS`
dataItemType	`DOCUMENT_TEMPLATE`
dataItemType	`PRODUCT`
dataItemType	`MCC_EXPIRATION`
dataItemType	`CENTRE`
dataItemType	`REPAYMENT_COLLECTION`
dataItemType	`TASK`
dataItemType	`OUTSTANDING_PORTFOLIO_AMOUNTS`
dataItemType	`REVENUE`
dataItemType	`COMPOSED_TRANSACTIONS`
dataItemType	`UNION_TRANSACTIONS`
dataItemType	`PRINCIPAL_PAYMENT_SETTINGS`
dataItemType	`LOANS`
dataItemType	`DISBURSEMENT_DETAILS`
dataItemType	`SAVINGS_TRANSACTION`
dataItemType	`IDENTIFICATION_DOCUMENT`
dataItemType	`LOAN_PRODUCT`
dataItemType	`DISBURSED_LOANS`
dataItemType	`LOAN_GROUP`
dataItemType	`TRANSACTION_CHANNEL`
dataItemType	`CUSTOM_PREDEFINED_FEE`
dataItemType	`JOURNAL_ENTRY`
dataItemType	`ATTACHMENT`
dataItemType	`PREDEFINED_FEE`
dataItemType	`TRANCHE`
dataItemType	`TRANSACTION`
dataItemType	`INDEX_RATE_SOURCE`
dataItemType	`GROUP_ROLE`
dataItemType	`LOAN_TRANSACTION`
dataItemType	`CLIENT_ROLE`
dataItemType	`GROUP`
dataItemType	`NOTIFICATION_MESSAGE`
dataItemType	`OUTSTANDING_PORTFOLIO_ACCOUNTS`
dataItemType	`REPAYMENT`
dataItemType	`LOAN_ACCOUNT_GUARANTY`
dataItemType	`BRANCH`
dataItemType	`CURRENCY`
dataItemType	`CARD_TRANSACTION_REVERSAL`
dataItemType	`INTEREST_PRODUCT_SETTINGS`
dataItemType	`CREATED_ACCOUNTS`
dataItemType	`USER`
dataItemType	`SAVINGS_PRODUCT`
dataItemType	`CLIENT`
dataItemType	`PRODUCT_ARREARS_SETTINGS`
dataItemType	`SAVINGS`
dataItemType	`EXPENSE`
dataItemType	`INDEX_RATE`
dataItemType	`NOTIFICATION_TEMPLATE`
dataItemType	`CUSTOM_FIELD_SELECTION`
dataItemType	`ACTIVITY`
dataType	`ENUM`
dataType	`MONEY`
dataType	`NUMBER`
dataType	`DATE_UTC`
dataType	`JAVA_BLOB`
dataType	`OBJECT`
dataType	`BOOLEAN`
dataType	`DATE`
dataType	`PERCENT`
dataType	`BIG_DECIMAL`
dataType	`STRING`
dataType	`KEY`
dataType	`LONG`
filterElement	`STARTS_WITH_CASE_SENSITIVE`
filterElement	`THIS_WEEK`
filterElement	`EQUALS`
filterElement	`STARTS_WITH`
filterElement	`IN`
filterElement	`TODAY`
filterElement	`THIS_YEAR`
filterElement	`BETWEEN`
filterElement	`AFTER`
filterElement	`LESS_THAN`
filterElement	`DIFFERENT_THAN`
filterElement	`THIS_MONTH`
filterElement	`NOT_EMPTY`
filterElement	`BEFORE`
filterElement	`EQUALS_CASE_SENSITIVE`
filterElement	`LAST_DAYS`
filterElement	`MORE_THAN`
filterElement	`EMPTY`
filterElement	`ON`
linkingOperator	`OR`
linkingOperator	`AND`
builtInType	`DETAILS`
builtInType	`GENERAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
usage	`SINGLE`
usage	`GROUPED`
dataType	`GROUP_LINK`
dataType	`DATE`
dataType	`NUMBER`
dataType	`CHECKBOX`
dataType	`CLIENT_LINK`
dataType	`STRING`
dataType	`USER_LINK`
dataType	`SELECTION`
state	`DEACTIVATED`
state	`NORMAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
valueLength	`SHORT`
valueLength	`LONG`
authorization	`NO_AUTHORIZATION`
authorization	`BASIC_AUTHORIZATION`
contentType	`PLAIN_TEXT`
contentType	`APPLICATION_JSON`
contentType	`APPLICATION_XML`
dataViewType	`PORTAL_ACCOUNT_TRANSACTION`
dataViewType	`LOANS_AGING_ANALYSIS`
dataViewType	`CLOSED_ACCOUNTS`
dataViewType	`CLIENT_OVERVIEW`
dataViewType	`ADMIN_CENTRES`
dataViewType	`USER_NOTIFICATION_MESSAGES`
dataViewType	`LINE_OF_CREDIT`
dataViewType	`USER_OVERVIEW`
dataViewType	`CENTRE_OVERVIEW`
dataViewType	`REPAYMENT_REPAYMENTS_COLLECTION`
dataViewType	`GROUP_OVERVIEW`
dataViewType	`ACTIVITIES_LOOKUP`
dataViewType	`TRANSACTION`
dataViewType	`ADMIN_BRANCHES`
dataViewType	`GROUP`
dataViewType	`BRANCH_OVERVIEW`
dataViewType	`NOTIFICATION_MESSAGE`
dataViewType	`PORTFOLIO_REPORTS`
dataViewType	`GROUP_NOTIFICATION_MESSAGES`
dataViewType	`LOAN_ACCOUNT_SECURITIES_OVERVIEW`
dataViewType	`LINE_OF_CREDIT_OVERVIEW`
dataViewType	`CURRENCIES`
dataViewType	`REPAYMENT`
dataViewType	`TILL_TRANSACTIONS`
dataViewType	`ALL_TASKS`
dataViewType	`CENTRE`
dataViewType	`BRANCH`
dataViewType	`INDEX_RATES_LIST`
dataViewType	`USER_TASKS`
dataViewType	`DOCUMENT_TEMPLATES`
dataViewType	`SAVINGS_TRANSACTIONS_LOOKUP`
dataViewType	`LOAN_ACCOUNT_OVERVIEW`
dataViewType	`DEPOSITS_COLLECTION`
dataViewType	`USER`
dataViewType	`ADMIN_USERS`
dataViewType	`GROUP_TASKS`
dataViewType	`CLIENT`
dataViewType	`LOAN_TRANSACTIONS_LOOKUP`
dataViewType	`LOANS`
dataViewType	`LOANS_REPAYMENTS_COLLECTION`
dataViewType	`CLIENT_TASKS`
dataViewType	`OVERDRAFTS_AGING_ANALYSIS`
dataViewType	`LOAN_ACCOUNT_FUNDING_OVERVIEW`
dataViewType	`SAVINGS`
dataViewType	`SAVINGS_OVERVIEW`
dataViewType	`JOURNAL_ENTRY`
dataViewType	`CLIENT_NOTIFICATION_MESSAGES`
event	`LOAN_CREATED`
event	`SAVINGS_ACCOUNT_REJECTION`
event	`SAVINGS_ACCOUNT_ACTIVATED`
event	`DATA_ACCESS_STATE_CHANGED`
event	`REPAYMENT_REMINDER`
event	`LOAN_ANTICIPATED_DISBURSEMENT`
event	`CREDIT_ARRANGEMENT_deleteD`
event	`SAVINGS_APPROVAL`
event	`PORTAL_ACTIVATED`
event	`SAVINGS_DEPOSIT`
event	`PORTAL_PASSWORD_RESET`
event	`CREDIT_ARRANGEMENT_REJECTED`
event	`LOAN_REPAYMENT_REVERSAL`
event	`SAVINGS_ACCOUNT_CLOSURE`
event	`LOAN_ACCOUNT_REJECTION`
event	`LOAN_ACCOUNT_RESCHEDULED`
event	`ACCOUNT_IN_ARREARS`
event	`LOAN_DISBURSEMENT_REVERSAL`
event	`SAVINGS_DEPOSIT_REVERSAL`
event	`CLIENT_APPROVED`
event	`LOAN_REPAYMENT`
event	`LOAN_ACCOUNT_ACTIVITY`
event	`GROUP_CREATED`
event	`LOAN_DISBURSEMENT`
event	`CREDIT_ARRANGEMENT_APPROVED`
event	`MANUAL`
event	`END_OF_DAY_PROCESSING_COMPLETED`
event	`CREDIT_ARRANGEMENT_ACCOUNT_ADDED`
event	`CLIENT_REJECTED`
event	`CLIENT_ACTIVITY`
event	`LOAN_ACCOUNT_REFINANCED`
event	`SAVINGS_CREATED`
event	`CLIENT_CREATED`
event	`LOAN_APPROVAL`
event	`GROUP_ACTIVITY`
event	`LOAN_ACCOUNT_CLOSURE`
event	`SAVINGS_WITHDRAWAL_REVERSAL`
event	`CREDIT_ARRANGEMENT_WITHDRAWN`
event	`CREDIT_ARRANGEMENT_CREATED`
event	`SAVINGS_WITHDRAWAL`
event	`SAVINGS_ACCOUNT_ACTIVITY`
event	`LOAN_ACCOUNT_WRITE_OFF`
event	`CREDIT_ARRANGEMENT_ACCOUNT_REMOVED`
event	`CREDIT_ARRANGEMENT_CLOSED`
option	`OPT_IN`
option	`OPT_OUT`
recipientType	`CREDIT_OFFICER`
recipientType	`CUSTOM_FIELD`
recipientType	`GROUP_ROLE`
recipientType	`CLIENT`
requestType	`HEAD`
requestType	`delete`
requestType	`post`
requestType	`get`
requestType	`put`
requestType	`patch`
targetType	`LOANS`
targetType	`GROUP`
targetType	`SAVINGS`
targetType	`DATA_ACCESS`
targetType	`BACKGROUND_PROCESS`
targetType	`CLIENT`
trigger	`AUTOMATIC`
trigger	`MANUAL`
type	`EVENT_STREAM`
type	`TASK`
type	`SMS`
type	`EMAIL`
type	`WEB_HOOK`

Get Client's Custom Views Summary

GET /clients?resultType=SUMMARY&viewfilter={viewfilter}

Get Client's Custom Views Summary

get view filters for a client with a summary

Parameters

Name	Type	Description	In
branchId	string	none	query
offset	string	none	query
limit	string	none	query
resultType	string	none	query
viewfilter (required)	string	none	path

Example Responses

200 Response

{
  "summary": {
    "count": "string",
    "totals": [
      {
        "customFieldValues": {
          "property1": {},
          "property2": {}
        },
        "dataItemType": "WRITTEN_OFF_LOANS",
        "values": {
          "property1": {},
          "property2": {}
        }
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	JsonCustomViewEntitiesSummaryWrapperApiV1

Get all Clients

GET /clients

List clients

Allows retrieving clients. When retrieving a client, all their associated information such as custom field values, addresses and identification documents may also be returned if requested. An empty list is returned if no clients are found.

Any combinations can be used but note that an AND search will be performed.

Please Note! Lookups by names are case sensitive. If an insensitive lookup is required please use the Objects Search API.

Example Requests

Search for a client using query parameters

GET /api/clients?firstName=Trevor&lastName=Linden

Parameters

Name	Type	Description	In
centreId	string	Looking up clients assigned to a centre using centre id/key	query
branchId	string	Looking up clients assigned to a branch using branch id/key	query
lastName	string	Used for looking up a client by their last name	query
firstName	string	Used for looking up a client by their first name	query
birthdate	string(date)	Looking up a client by their birthdate (format: YYYY-MM-DD)	query
idDocument	string	Looking up a client by their id document number	query
state	string	Looking up a client by their current state	query
creditOfficerUsername	string	Looking up a client by the assigned credit officer username (required if the user making the call has the "Credit Officer" role and the option "Can access other credit officers clients" is not activated)	query

Example Responses

200 : ok
a list of clients

[
  {
    "encodedKey": "8a193c26722b51b701722d77c69e2406",
    "state": "INACTIVE",
    "id": "80",
    "creationDate": "2020-05-19T15:05:24+0000",
    "lastModifiedDate": "2020-05-19T15:05:24+0000",
    "firstName": "Hyiab",
    "lastName": "Longoria",
    "homePhone": "3788731",
    "birthDate": "1972-10-07T15:05:24+0000",
    "gender": "MALE",
    "notes": "The neighbors mentioned that he is an <b>honest and hard working man.</b>",
    "loanCycle": 0,
    "groupLoanCycle": 0,
    "preferredLanguage": "ENGLISH",
    "clientRole": {
      "encodedKey": "8a194075720ece2c017226fcf55e0068"
    }
  },
  {
    "encodedKey": "8a193c26722b51b701722d77c69e2405",
    "state": "INACTIVE",
    "id": "79",
    "creationDate": "2020-05-19T15:05:24+0000",
    "lastModifiedDate": "2020-05-19T15:05:24+0000",
    "firstName": "Buthayna",
    "lastName": "Simon",
    "homePhone": "2379200",
    "birthDate": "1990-08-17T15:05:24+0000",
    "gender": "FEMALE",
    "notes": "Lives with three daughters and old father. The daughters are learning how to paint so that they can sell the paintings and start helping their mother repaying the loan. ",
    "loanCycle": 0,
    "groupLoanCycle": 0,
    "preferredLanguage": "ENGLISH",
    "clientRole": {
      "encodedKey": "8a194075720ece2c017226fcf55e0068"
    }
  },
  {
    "encodedKey": "8a193c26722b51b701722d77c69e2404",
    "state": "INACTIVE",
    "id": "78",
    "creationDate": "2020-05-19T15:05:24+0000",
    "lastModifiedDate": "2020-05-19T15:05:24+0000",
    "firstName": "Uros",
    "lastName": "Kamińska",
    "homePhone": "(73) 161-529",
    "birthDate": "1989-04-03T15:05:24+0000",
    "gender": "FEMALE",
    "notes": "Lives with three daughters and old father. The daughters are learning how to paint so that they can sell the paintings and start helping their mother repaying the loan. ",
    "loanCycle": 0,
    "groupLoanCycle": 0,
    "preferredLanguage": "ENGLISH",
    "clientRole": {
      "encodedKey": "8a194075720ece2c017226fcf55e0068"
    }
  },
  {
    "encodedKey": "8a193c26722b51b701722d77c69b2403",
    "state": "INACTIVE",
    "id": "77",
    "creationDate": "2020-05-19T15:05:24+0000",
    "lastModifiedDate": "2020-05-19T15:05:24+0000",
    "firstName": "اسفندیار",
    "lastName": "Czarnecki",
    "homePhone": "051-043-414",
    "birthDate": "1984-10-27T15:05:24+0000",
    "gender": "FEMALE",
    "notes": "Her business is the only source of income of the household of 4.",
    "loanCycle": 0,
    "groupLoanCycle": 0,
    "preferredLanguage": "ENGLISH",
    "clientRole": {
      "encodedKey": "8a194075720ece2c017226fcf55e0068"
    }
  },
  {
    "encodedKey": "8a193c26722b51b701722d77c69b2402",
    "state": "INACTIVE",
    "id": "76",
    "creationDate": "2020-05-19T15:05:24+0000",
    "lastModifiedDate": "2020-05-19T15:05:24+0000",
    "firstName": "Gilda",
    "lastName": "Nwankwo",
    "homePhone": "(94) 524-867",
    "birthDate": "1974-04-26T15:05:24+0000",
    "gender": "MALE",
    "notes": "Lives with three daughters and old father. The daughters are learning how to paint so that they can sell the paintings and start helping their mother repaying the loan. ",
    "loanCycle": 0,
    "groupLoanCycle": 0,
    "preferredLanguage": "ENGLISH",
    "clientRole": {
      "encodedKey": "8a194075720ece2c017226fcf55e0068"
    }
  },
  {
    "encodedKey": "8a193c26722b51b701722d77c69b2401",
    "state": "INACTIVE",
    "id": "75",
    "creationDate": "2020-05-19T15:05:24+0000",
    "lastModifiedDate": "2020-05-19T15:05:24+0000",
    "firstName": "Marcelina",
    "lastName": "Sawicka",
    "homePhone": "041-831-623",
    "birthDate": "1970-02-02T15:05:24+0000",
    "gender": "FEMALE",
    "notes": "Her business is the only source of income of the household of 4.",
    "loanCycle": 0,
    "groupLoanCycle": 0,
    "preferredLanguage": "ENGLISH",
    "clientRole": {
      "encodedKey": "8a194075720ece2c017226fcf55e0068"
    }
  },
  {
    "encodedKey": "8a193c26722b51b701722d77c69b2400",
    "state": "INACTIVE",
    "id": "74",
    "creationDate": "2020-05-19T15:05:24+0000",
    "lastModifiedDate": "2020-05-19T15:05:24+0000",
    "firstName": "Šimica",
    "lastName": "Tomaszewska",
    "homePhone": "2102191",
    "birthDate": "1963-05-21T15:05:24+0000",
    "gender": "FEMALE",
    "notes": "The neighbors mentioned that he is an <b>honest and hard working man.</b>",
    "loanCycle": 0,
    "groupLoanCycle": 0,
    "preferredLanguage": "ENGLISH",
    "clientRole": {
      "encodedKey": "8a194075720ece2c017226fcf55e0068"
    }
  },
  {
    "encodedKey": "8a193c26722b51b701722d77c69b23ff",
    "state": "INACTIVE",
    "id": "73",
    "creationDate": "2020-05-19T15:05:24+0000",
    "lastModifiedDate": "2020-05-19T15:05:24+0000",
    "firstName": "Carina",
    "lastName": "Jaworski",
    "homePhone": "(20) 318-317",
    "birthDate": "1976-04-20T15:05:24+0000",
    "gender": "MALE",
    "notes": "Her business is the only source of income of the household of 4.",
    "loanCycle": 0,
    "groupLoanCycle": 0,
    "preferredLanguage": "ENGLISH",
    "clientRole": {
      "encodedKey": "8a194075720ece2c017226fcf55e0068"
    }
  },
  {
    "encodedKey": "8a193c26722b51b701722d77c69723fe",
    "state": "INACTIVE",
    "id": "72",
    "creationDate": "2020-05-19T15:05:24+0000",
    "lastModifiedDate": "2020-05-19T15:05:24+0000",
    "firstName": "Sobiesław",
    "lastName": "Medhane",
    "homePhone": "2352426",
    "birthDate": "1961-01-26T15:05:24+0000",
    "gender": "FEMALE",
    "notes": "Lives with three daughters and old father. The daughters are learning how to paint so that they can sell the paintings and start helping their mother repaying the loan. ",
    "loanCycle": 0,
    "groupLoanCycle": 0,
    "preferredLanguage": "ENGLISH",
    "clientRole": {
      "encodedKey": "8a194075720ece2c017226fcf55e0068"
    }
  },
  {
    "encodedKey": "8a193c26722b51b701722d77c69723fd",
    "state": "INACTIVE",
    "id": "71",
    "creationDate": "2020-05-19T15:05:24+0000",
    "lastModifiedDate": "2020-05-19T15:05:24+0000",
    "firstName": "Mara",
    "lastName": "Duvnjak",
    "homePhone": "051-625-096",
    "birthDate": "1974-01-01T15:05:24+0000",
    "gender": "FEMALE",
    "notes": "Generally a very honest, open individual who exudes warmth and trust.",
    "loanCycle": 0,
    "groupLoanCycle": 0,
    "preferredLanguage": "ENGLISH",
    "clientRole": {
      "encodedKey": "8a194075720ece2c017226fcf55e0068"
    }
  },
  {
    "encodedKey": "8a193c26722b51b701722d77c69723fc",
    "state": "INACTIVE",
    "id": "70",
    "creationDate": "2020-05-19T15:05:24+0000",
    "lastModifiedDate": "2020-05-19T15:05:24+0000",
    "firstName": "Mãnh",
    "lastName": "Baba",
    "homePhone": "5438282",
    "birthDate": "1976-08-18T15:05:24+0000",
    "gender": "FEMALE",
    "notes": "The neighbors mentioned that he is an <b>honest and hard working man.</b>",
    "loanCycle": 0,
    "groupLoanCycle": 0,
    "preferredLanguage": "ENGLISH",
    "clientRole": {
      "encodedKey": "8a194075720ece2c017226fcf55e0068"
    }
  },
  {
    "encodedKey": "8a193c26722b51b701722d77c69723fb",
    "state": "INACTIVE",
    "id": "69",
    "creationDate": "2020-05-19T15:05:24+0000",
    "lastModifiedDate": "2020-05-19T15:05:24+0000",
    "firstName": "Asztrik",
    "lastName": "Kasza",
    "homePhone": "2179544",
    "birthDate": "1965-06-10T15:05:24+0000",
    "gender": "MALE",
    "notes": "Lives with three daughters and old father. The daughters are learning how to paint so that they can sell the paintings and start helping their mother repaying the loan. ",
    "loanCycle": 0,
    "groupLoanCycle": 0,
    "preferredLanguage": "ENGLISH",
    "clientRole": {
      "encodedKey": "8a194075720ece2c017226fcf55e0068"
    }
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[ClientApiV1]	none	none
» activationDate	string	the date when the client was set to active, ie. an active account was created for them	none
» approvedDate	string	the date when the client was approved	none
» assignedBranchKey	string	the encoded key of the client's branch	none
» assignedCentreKey	string	the encoded key of the client's assigned centre	none
» assignedUserKey	string	the encoded key of the Mambu user associated with this client, eg. their credit officer	none
» birthDate	string	the date of birth of this client	none
» clientRole	ClientRoleBasicApiV1	the type of client or group as defined in Mambu in Administration > General Settings > Client Types	none
»» encodedKey	string	the automatically generated encoded ID for this client or group type	none
» closedDate	string	the date when the client was exited or blacklisted	none
» creationDate	string	the date on which this client record was created	none
» emailAddress	string	the email address of the client	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» firstName	string	the first name of the client	none
» gender	string	the client's gender	none
» groupLoanCycle	number	if this client is a member of a group, this number will increase by 1 each time they successfully close a loan as fully paid	none
» homePhone	string	a home contact number for this client	none
» id	string	the ID for this client	none
» idPattern	string	the pattern that is used to generate the client ID	none
» lastModifiedDate	string	the date on which this client record was last modified	none
» lastName	string	the last name of this client	none
» loanCycle	number	the number of loans this client has opened and closed as fully paid as an individual	none
» middleName	string	any middle names for this client	none
» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
»» creationDate	string(date-time)	the date on which the data import was made	none
»» encodedKey	string	the encoded key of this data migration event	none
»» numCentresImported	number	the number of centres which were imported during the data migration	none
»» numClientsImported	number	the number of clients which were imported as part of the data migration	none
»» numGLAccountsImported	number	the number of general ledger accounts which were imported as part of the data migration	none
»» numGroupsImported	number	the number of groups which were imported as part of the data migration	none
»» numLoanRepaymentsImported	number	the number of loan repayment transations which were imported as part of the data migration	none
»» numLoanTransactionsImported	number	the number of loan transactions which were imported as part of the data migration	none
»» numLoansImported	number	the number of loan accounts which were imported as part of the data migration	none
»» numSavingsImported	number	the number of savings accounts which were imported as part of the data migration	none
»» state	string	whether the data import was accepted, is still in a draft state, or was rejected and all data reverted	none
»» type	string	the type of migration event	none
» mobilePhone1	string	a mobile contact number for this client	none
» mobilePhone2	string	another mobile contact number for this client	none
» notes	string	any rich text notes about this client	none
» portalPreferences	PortalPreferencesApiV1	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» lastLoggedInDate	string	none	none
»» password	string	none	none
»» portalState	string	none	none
» preferredLanguage	string	the language which should be used when communicating with this client	none
» profilePictureKey	string	the encoded key of this user's proficle picture	none
» profileSignatureKey	string	the encoded key of the digital copy of this client's signature	none
» state	string	the current state of this client	none

Enumerated Values

Property	Value
gender	`MALE`
gender	`FEMALE`
state	`REVERTED`
state	`DRAFT`
state	`APPROVED`
type	`IMPORT`
type	`EXPORT`
portalState	`DISABLED`
portalState	`ENABLED`
preferredLanguage	`PORTUGESE`
preferredLanguage	`RUSSIAN`
preferredLanguage	`ROMANIAN`
preferredLanguage	`ENGLISH`
preferredLanguage	`SPANISH`
preferredLanguage	`GEORGIAN`
preferredLanguage	`BURMESE`
preferredLanguage	`PHRASE`
preferredLanguage	`CHINESE`
preferredLanguage	`FRENCH`
preferredLanguage	`INDONESIAN`
state	`PENDING_APPROVAL`
state	`ACTIVE`
state	`INACTIVE`
state	`EXITED`
state	`BLACKLISTED`
state	`REJECTED`

Create or Update Client

POST /clients

Create or update a client

Mambu allows for creation and updating of client information. This includes client's personal and contact information, custom fields, identification documents and the address. The client is returned as a response.

You can provide some basic information as a request with query parameters and no body, however, if you need to create a client with more complex information, such as custom fields, we recommend posting with a JSON body.

If the "idDocuments":[],"addresses":[], or "customInformation":[] arrays are not provided, only the client information will be updated/stored
For JSON update, the developer must specify the client ID in the path ({/api/clients/{id}} and also provide the encodedKey in the JSON body

{
    client: {
    encodedKey:"someKey"
    }
}

If the encoded key/identifier is invalid, an exception code will be returned

In order to remove all custom fields, identification documents or addresses, you can send an empty array:

{
"client": {
    "encodedKey":"abc",
    //other client information
},
"idDocuments":[],
"addresses":[],
"customInformation":[]
}

If you are updating only one entry in an array (ID document, Custom Information, Addresses) you must also provide the information for the other members of the array otherwise these will be deleted
- For example :if there are 3 custom fields in database and only one provided in the "customInformation" array for update, the other 2 from the database will get deleted and only the one from the POST request will get stored/updated
For custom fields - the matching to determine the difference between an updated and a new field is done using customFieldID
For custom fields - if the custom field ID is invalid or the value is invalid an exception code will be returned
For custom fields - Date custom fields are currently date only, not date-time. Please follow CIF-22 for updates on the development of this functionality.
See Custom Fields API for more information about custom fields and custom fields sets
For identification documents and addresses the encoded key is used for matching
Only one address can be stored/updated in database, if the addresses array contains more than one address, only the first address will get stored/updated
Notifications should be sent when a client is created via APIs (If there are templates added for client creation and the client has email address / mobile phone number)

Example Requests

Create a client with minimal data using query parameters

POST /api/clients?firstName=Trevor&lastName=Linden&emailAddress=trevor.linden%40mambu.com

Create a client with minimal data using JSON

{
   "client":{
      "firstName":"Trevor",
      "lastName":"Linden",
      "middleName":"Good",
      "homePhone":"7899221665",
      "emailAddress":"trevor.linden@mambu.com",
      "mobilePhone1":"211111111",
      "mobilePhone2":"122222222",
      "gender":"MALE",
      "clientRole": {"encodedKey":"d9df8bc78a0234ccc934a845c"}
   }
}

Create a new client with ID documents, an address, and custom field values

{
  "client": {
    "firstName": "Max",
    "lastName": "Alexander",
    "middleName": "Frank",
    "homePhone": "56611235498",
    "emailAddress": "max.alexander@mambu.com",
    "mobilePhone1": "211111111",
    "gender": "MALE"
  },
  "idDocuments": [
    {
      "documentType": "CI",
      "documentId": "23453",
      "issuingAuthority": "Police",
      "validUntil": "2014-09-30T00:00:00+0000",
      "identificationDocumentTemplateKey": "9b0a97094b4cd73f014b5f5ef0e811d2"
    },
    {
      "documentType": "Passport",
      "documentId": "sss332",
      "issuingAuthority": "Passport Agency",
      "validUntil": "2014-09-30T00:00:00+0000",
      "identificationDocumentTemplateKey": "2a0a00a24b4ce72a025c4afefce821e9"
    }
  ],
  "addresses": [
    {
      "line1": "8 Howling Lane",
      "line2": "Hackney",
      "city": "London",
      "region": "London",
      "postcode": "EC1 FB12",
      "country": "United Kingdom"
    }
  ],
  "customInformation": [
    {
      "value": "1",
      "customFieldID": "Family_Members"
    },
    {
      "value": "TRUE",
      "customFieldID": "Has_children"
    },
    {
      "value": "Some Studies",
      "customFieldID": "Studies"
    }
  ]
}

Parameters

Name	Type	Description	In
firstName (required)	string	Client's first name.	query
lastName (required)	string	Client's last name.	query
birthDate	string	The date of birth of the client in the format YYYY-MM-DD.	query
gender	string	The gender of the client, either `MALE` or `FEMALE`.	query
homephone	string	A home contact number for this client.	query
mobilephone	string	A mobile contact number for this client.	query
email	string	The email address for this client.	query
notes	string	Any additional rich text html notes about the clients *	query
clientRole	string	If you have set up client roles, you can provide a role using this field.	query
assignedUserKey	string	The encoded key of a Mmabu user assigned to this client, for example a credit officer.	query
body	CreateOrUpdateClientRequest	none	body

Detailed descriptions

notes: Any additional rich text html notes about the clients *

Example Responses

200 Response

{
  "addresses": [
    {
      "addressType": "string",
      "city": "string",
      "country": "string",
      "encodedKey": "string",
      "indexInList": 0,
      "latitude": 0,
      "line1": "string",
      "line2": "string",
      "longitude": 0,
      "parentKey": "string",
      "postcode": "string",
      "region": "string",
      "toBeDeleted": true
    }
  ],
  "client": {
    "activationDate": "string",
    "approvedDate": "string",
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "birthDate": "string",
    "clientRole": {
      "encodedKey": "string"
    },
    "closedDate": "string",
    "creationDate": "string",
    "emailAddress": "string",
    "encodedKey": "string",
    "firstName": "string",
    "gender": "MALE",
    "groupLoanCycle": 0,
    "homePhone": "string",
    "id": "string",
    "idPattern": "string",
    "lastModifiedDate": "string",
    "lastName": "string",
    "loanCycle": 0,
    "middleName": "string",
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "mobilePhone1": "string",
    "mobilePhone2": "string",
    "notes": "string",
    "portalPreferences": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "lastLoggedInDate": "string",
      "password": "string",
      "portalState": "DISABLED"
    },
    "preferredLanguage": "PORTUGESE",
    "profilePictureKey": "string",
    "profileSignatureKey": "string",
    "state": "PENDING_APPROVAL"
  },
  "customInformation": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "groupKeys": [
    "string"
  ],
  "idDocuments": [
    {
      "clientKey": "string",
      "documentId": "string",
      "documentType": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "identificationDocumentTemplateKey": "string",
      "indexInList": 0,
      "issuingAuthority": "string",
      "toBeDeleted": true,
      "validUntil": "string",
      "validUntilDTOdate": {
        "dayOfMonth": 0,
        "monthOfYear": 0,
        "year": 0
      }
    }
  ]
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	CreateOrUpdateClientResponse

Get Lines of Credit for Client

GET /clients/{clientId}/linesofcredit

Get lines of credit for a Client

Retrieve the associated lines of credit for a client.

Parameters

Name	Type	Description	In
clientId (required)	string	none	path
fullDetails	boolean	Get full object including all nested fields	query

Example Responses

200 : ok
Lines of Credit with basic details

[
  {
    "encodedKey": "8a19b6e4746cc6ed01746cf1436c00c3",
    "id": "JRW117",
    "clientKey": "8a193c26722b51b701722d77c5e423b7",
    "startDate": "2020-09-01T00:00:00+0000",
    "expireDate": "2020-12-31T00:00:00+0000",
    "creationDate": "2020-09-08T08:59:45+0000",
    "approvedDate": "2020-09-08T10:59:45+0000",
    "lastModifiedDate": "2020-09-08T08:59:45+0000",
    "state": "APPROVED",
    "amount": "100",
    "exposureLimitType": "APPROVED_AMOUNT",
    "notes": "adf",
    "availableCreditAmount": "100"
  },
  {
    "encodedKey": "8a19c162746ce3b201746cf0ce24007a",
    "id": "FEP015",
    "clientKey": "8a193c26722b51b701722d77c5e423b7",
    "startDate": "2020-09-01T00:00:00+0000",
    "expireDate": "2020-12-31T00:00:00+0000",
    "creationDate": "2020-09-08T09:00:48+0000",
    "approvedDate": "2020-09-08T11:00:48+0000",
    "lastModifiedDate": "2020-09-08T09:00:48+0000",
    "state": "APPROVED",
    "amount": "10000",
    "exposureLimitType": "OUTSTANDING_AMOUNT",
    "notes": "some fascinating line of credit notes",
    "availableCreditAmount": "10000"
  },
  {
    "encodedKey": "8a19c162746ce3b201746cf0ce24007c",
    "id": "FEP007",
    "clientKey": "8a193c26722b51b701722d77c5e423b7",
    "startDate": "2020-09-01T00:00:00+0000",
    "expireDate": "2021-12-31T00:00:00+0000",
    "creationDate": "2020-09-08T09:01:46+0000",
    "approvedDate": "2020-09-08T11:01:46+0000",
    "lastModifiedDate": "2020-09-08T09:19:41+0000",
    "state": "APPROVED",
    "amount": "10000",
    "exposureLimitType": "OUTSTANDING_AMOUNT",
    "notes": "some fascinating line of credit notes",
    "availableCreditAmount": "10000"
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	LineOfCreditFullApiV1

Search for Clients

POST /clients/search

Search for Clients

search for clients based on some criteria

Example Requests

Get all clients identifying as male and sort by birthdate

{
   "filterConstraints":[
      {
         "filterSelection":"GENDER",
         "filterElement":"EQUALS",
         "value":"MALE"
      }
   ],
   "sortDetails": {
    "sortingColumn": "BIRTHDATE",
    "sortingOrder": "DESC"
  }
}

Get all clients added this month

{
   "filterConstraints":[
      {
         "filterSelection":"CREATION_DATE",
         "filterElement":"THIS_MONTH"
      }
   ]
}

Get all clients with a birth date between a given range

{
  "filterConstraints": [
    {
      "filterSelection": "BIRTHDATE",
      "filterElement": "BETWEEN",
      "value": "1957-01-01",
      "secondValue": "1965-06-20"
    }
  ]
}

Parameters

Name	Type	Description	In
offset	integer	none	query
limit	integer	none	query
fullDetails	boolean	none	query
body	FilterApiV1	none	body

Example Responses

200 Response

[
  {
    "activationDate": "string",
    "approvedDate": "string",
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "birthDate": "string",
    "clientRole": {
      "encodedKey": "string"
    },
    "closedDate": "string",
    "creationDate": "string",
    "emailAddress": "string",
    "encodedKey": "string",
    "firstName": "string",
    "gender": "MALE",
    "groupLoanCycle": 0,
    "homePhone": "string",
    "id": "string",
    "idPattern": "string",
    "lastModifiedDate": "string",
    "lastName": "string",
    "loanCycle": 0,
    "middleName": "string",
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "mobilePhone1": "string",
    "mobilePhone2": "string",
    "notes": "string",
    "portalPreferences": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "lastLoggedInDate": "string",
      "password": "string",
      "portalState": "DISABLED"
    },
    "preferredLanguage": "PORTUGESE",
    "profilePictureKey": "string",
    "profileSignatureKey": "string",
    "state": "PENDING_APPROVAL"
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[ClientApiV1]	none	none
» activationDate	string	the date when the client was set to active, ie. an active account was created for them	none
» approvedDate	string	the date when the client was approved	none
» assignedBranchKey	string	the encoded key of the client's branch	none
» assignedCentreKey	string	the encoded key of the client's assigned centre	none
» assignedUserKey	string	the encoded key of the Mambu user associated with this client, eg. their credit officer	none
» birthDate	string	the date of birth of this client	none
» clientRole	ClientRoleBasicApiV1	the type of client or group as defined in Mambu in Administration > General Settings > Client Types	none
»» encodedKey	string	the automatically generated encoded ID for this client or group type	none
» closedDate	string	the date when the client was exited or blacklisted	none
» creationDate	string	the date on which this client record was created	none
» emailAddress	string	the email address of the client	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» firstName	string	the first name of the client	none
» gender	string	the client's gender	none
» groupLoanCycle	number	if this client is a member of a group, this number will increase by 1 each time they successfully close a loan as fully paid	none
» homePhone	string	a home contact number for this client	none
» id	string	the ID for this client	none
» idPattern	string	the pattern that is used to generate the client ID	none
» lastModifiedDate	string	the date on which this client record was last modified	none
» lastName	string	the last name of this client	none
» loanCycle	number	the number of loans this client has opened and closed as fully paid as an individual	none
» middleName	string	any middle names for this client	none
» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
»» creationDate	string(date-time)	the date on which the data import was made	none
»» encodedKey	string	the encoded key of this data migration event	none
»» numCentresImported	number	the number of centres which were imported during the data migration	none
»» numClientsImported	number	the number of clients which were imported as part of the data migration	none
»» numGLAccountsImported	number	the number of general ledger accounts which were imported as part of the data migration	none
»» numGroupsImported	number	the number of groups which were imported as part of the data migration	none
»» numLoanRepaymentsImported	number	the number of loan repayment transations which were imported as part of the data migration	none
»» numLoanTransactionsImported	number	the number of loan transactions which were imported as part of the data migration	none
»» numLoansImported	number	the number of loan accounts which were imported as part of the data migration	none
»» numSavingsImported	number	the number of savings accounts which were imported as part of the data migration	none
»» state	string	whether the data import was accepted, is still in a draft state, or was rejected and all data reverted	none
»» type	string	the type of migration event	none
» mobilePhone1	string	a mobile contact number for this client	none
» mobilePhone2	string	another mobile contact number for this client	none
» notes	string	any rich text notes about this client	none
» portalPreferences	PortalPreferencesApiV1	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» lastLoggedInDate	string	none	none
»» password	string	none	none
»» portalState	string	none	none
» preferredLanguage	string	the language which should be used when communicating with this client	none
» profilePictureKey	string	the encoded key of this user's proficle picture	none
» profileSignatureKey	string	the encoded key of the digital copy of this client's signature	none
» state	string	the current state of this client	none

Enumerated Values

Property	Value
gender	`MALE`
gender	`FEMALE`
state	`REVERTED`
state	`DRAFT`
state	`APPROVED`
type	`IMPORT`
type	`EXPORT`
portalState	`DISABLED`
portalState	`ENABLED`
preferredLanguage	`PORTUGESE`
preferredLanguage	`RUSSIAN`
preferredLanguage	`ROMANIAN`
preferredLanguage	`ENGLISH`
preferredLanguage	`SPANISH`
preferredLanguage	`GEORGIAN`
preferredLanguage	`BURMESE`
preferredLanguage	`PHRASE`
preferredLanguage	`CHINESE`
preferredLanguage	`FRENCH`
preferredLanguage	`INDONESIAN`
state	`PENDING_APPROVAL`
state	`ACTIVE`
state	`INACTIVE`
state	`EXITED`
state	`BLACKLISTED`
state	`REJECTED`

Get Client by ID

GET /clients/{clientId}

Get Client by ID

get a client by ID or encoded key

Parameters

Name	Type	Description	In
fullDetails	boolean	Whether to also include custom field values	query
clientId (required)	string	The ID or encoded key of a client	path

Example Responses

200 : ok
A client record with basic details

{
  "encodedKey": "8a193c26722b51b701722d77c5e423b7",
  "state": "ACTIVE",
  "id": "1",
  "creationDate": "2020-05-19T15:05:24+0000",
  "lastModifiedDate": "2021-08-02T14:22:42+0000",
  "activationDate": "2020-09-16T11:11:59+0000",
  "firstName": "Odon",
  "lastName": "Lukić",
  "profilePictureKey": "8a19a3337476f2d001747748c6250186",
  "profileSignatureKey": "8a19c19c74783436017478ad13000166",
  "homePhone": "4192425",
  "emailAddress": "odon@odonmail.com",
  "birthDate": "1989-04-29T00:00:00+0000",
  "gender": "FEMALE",
  "loanCycle": 0,
  "groupLoanCycle": 0,
  "preferredLanguage": "ENGLISH",
  "clientRole": {
    "encodedKey": "8a194075720ece2c017226fcf55e0068"
  }
}

200 : ok
A client record with full details

{
  "client": {
    "encodedKey": "8a193c26722b51b701722d77c5e423b7",
    "state": "ACTIVE",
    "id": "1",
    "creationDate": "2020-05-19T15:05:24+0000",
    "lastModifiedDate": "2021-08-02T14:22:42+0000",
    "activationDate": "2020-09-16T11:11:59+0000",
    "firstName": "Odon",
    "lastName": "Lukić",
    "profilePictureKey": "8a19a3337476f2d001747748c6250186",
    "profileSignatureKey": "8a19c19c74783436017478ad13000166",
    "homePhone": "4192425",
    "emailAddress": "odon@odonmail.com",
    "birthDate": "1989-04-29T00:00:00+0000",
    "gender": "FEMALE",
    "notes": "Ideas as how to improve his business seem solid. They include selling more plumbuses ....",
    "loanCycle": 0,
    "groupLoanCycle": 0,
    "preferredLanguage": "ENGLISH",
    "clientRole": {
      "encodedKey": "8a194075720ece2c017226fcf55e0068"
    }
  },
  "addresses": [
    {
      "encodedKey": "8a193c26722b51b701722d77c6ae241b",
      "parentKey": "8a193c26722b51b701722d77c5e423b7",
      "line1": "Ηλίου 161",
      "line2": "line 2 baby",
      "city": "ΛΑΡΝΑΚΑ",
      "region": "",
      "postcode": "6037",
      "country": "",
      "indexInList": 0
    }
  ],
  "customInformation": [
    {
      "encodedKey": "8a19b40b7a041e14017a0ec27a505c58",
      "parentKey": "8a193c26722b51b701722d77c5e423b7",
      "customFieldKey": "8a19b40b7a041e14017a0e96047d5995",
      "customField": {
        "encodedKey": "8a19b40b7a041e14017a0e96047d5995",
        "id": "delete_me",
        "creationDate": "2021-06-15T08:21:04+0000",
        "lastModifiedDate": "2021-06-15T08:21:04+0000",
        "name": "delete me",
        "type": "CLIENT_INFO",
        "dataType": "SELECTION",
        "valueLength": "SHORT",
        "isDefault": false,
        "isRequired": false,
        "description": "",
        "customFieldSet": {
          "encodedKey": "8a193c26722b51b701722d77ccaf2635",
          "id": "_Others_Clients",
          "name": "Others",
          "createdDate": "2020-05-19T15:05:25+0000",
          "lastModifiedDate": "2020-10-23T09:52:21+0000",
          "indexInList": 5,
          "type": "CLIENT_INFO",
          "usage": "SINGLE"
        },
        "indexInList": 4,
        "state": "NORMAL",
        "customFieldSelectionOptions": [
          {
            "encodedKey": "8a19b40b7a041e14017a0ec27a505c56",
            "id": "459047776",
            "value": "labe",
            "score": "69"
          },
          {
            "encodedKey": "8a19b40b7a041e14017a0ec27a505c57",
            "id": "380298933",
            "value": "label 2",
            "score": "420"
          }
        ],
        "viewRights": {
          "encodedKey": "8a19b40b7a041e14017a0e96047d5996",
          "isAccessibleByAllUsers": true,
          "roles": []
        },
        "editRights": {
          "encodedKey": "8a19b40b7a041e14017a0e96047d5997",
          "isAccessibleByAllUsers": true,
          "roles": []
        },
        "unique": false,
        "values": [
          "labe",
          "label 2"
        ],
        "amounts": {
          "labe": "69",
          "label 2": "420"
        }
      },
      "value": "label 2",
      "amount": "420",
      "indexInList": -1,
      "customFieldID": "delete_me",
      "customFieldSetGroupIndex": -1
    },
    {
      "encodedKey": "8a19b40b7a041e14017a0ed02b3b5cd9",
      "parentKey": "8a193c26722b51b701722d77c5e423b7",
      "customFieldKey": "8a19b40b7a041e14017a0ed02b375cd2",
      "customField": {
        "encodedKey": "8a19b40b7a041e14017a0ed02b375cd2",
        "id": "score_2",
        "creationDate": "2021-06-15T08:36:01+0000",
        "lastModifiedDate": "2021-06-15T08:36:01+0000",
        "name": "another score",
        "type": "CLIENT_INFO",
        "dataType": "SELECTION",
        "valueLength": "SHORT",
        "isDefault": false,
        "isRequired": false,
        "description": "",
        "customFieldSet": {
          "encodedKey": "8a193c26722b51b701722d77c55123b1",
          "id": "_Custom_Fields_Clients",
          "name": "Custom Fields",
          "createdDate": "2020-05-19T15:05:24+0000",
          "lastModifiedDate": "2020-10-23T09:52:21+0000",
          "indexInList": 3,
          "type": "CLIENT_INFO",
          "usage": "SINGLE"
        },
        "indexInList": 1,
        "state": "NORMAL",
        "customFieldSelectionOptions": [
          {
            "encodedKey": "8a19b40b7a041e14017a0ed02b3a5cd7",
            "id": "2032458765",
            "value": "adfsgd",
            "score": "12"
          },
          {
            "encodedKey": "8a19b40b7a041e14017a0ed02b3a5cd8",
            "id": "1288411378",
            "value": "wefqas",
            "score": "34"
          }
        ],
        "viewRights": {
          "encodedKey": "8a19b40b7a041e14017a0ed02b375cd3",
          "isAccessibleByAllUsers": true,
          "roles": []
        },
        "editRights": {
          "encodedKey": "8a19b40b7a041e14017a0ed02b375cd4",
          "isAccessibleByAllUsers": true,
          "roles": []
        },
        "unique": false,
        "values": [
          "adfsgd",
          "wefqas"
        ],
        "amounts": {
          "adfsgd": "12",
          "wefqas": "34"
        }
      },
      "value": "wefqas",
      "amount": "34",
      "indexInList": -1,
      "customFieldID": "score_2",
      "customFieldSetGroupIndex": -1
    },
    {
      "encodedKey": "8a193c26722b51b701722d77c6ca247f",
      "parentKey": "8a193c26722b51b701722d77c5e423b7",
      "customFieldKey": "8a193c26722b51b701722d77c55123b2",
      "customField": {
        "encodedKey": "8a193c26722b51b701722d77c55123b2",
        "id": "Position_Clients",
        "creationDate": "2020-09-24T08:34:00+0000",
        "lastModifiedDate": "2021-04-29T11:47:55+0000",
        "name": "Position",
        "type": "CLIENT_INFO",
        "dataType": "STRING",
        "valueLength": "SHORT",
        "isDefault": false,
        "isRequired": false,
        "customFieldSet": {
          "encodedKey": "8a193c26722b51b701722d77c55123b1",
          "id": "_Custom_Fields_Clients",
          "name": "Custom Fields",
          "createdDate": "2020-05-19T15:05:24+0000",
          "lastModifiedDate": "2020-10-23T09:52:21+0000",
          "indexInList": 3,
          "type": "CLIENT_INFO",
          "usage": "SINGLE"
        },
        "indexInList": 0,
        "state": "NORMAL",
        "customFieldSelectionOptions": [],
        "viewRights": {
          "encodedKey": "8a193c26722b51b701722d77c55123b3",
          "isAccessibleByAllUsers": true,
          "roles": []
        },
        "editRights": {
          "encodedKey": "8a193c26722b51b701722d77c5e423b4",
          "isAccessibleByAllUsers": true,
          "roles": []
        },
        "unique": false,
        "values": [],
        "amounts": {}
      },
      "value": "Extruding and forming machine operator",
      "indexInList": 0,
      "customFieldID": "Position_Clients",
      "customFieldSetGroupIndex": -1
    },
    {
      "encodedKey": "8a19d88a74d89f320174d9851c9a72fd",
      "parentKey": "8a193c26722b51b701722d77c5e423b7",
      "customFieldKey": "8a19d88a74d89f320174d9793aac7252",
      "customField": {
        "encodedKey": "8a19d88a74d89f320174d9793aac7252",
        "id": "vrfy_lnk",
        "creationDate": "2020-09-29T10:49:03+0000",
        "lastModifiedDate": "2021-02-10T13:28:50+0000",
        "name": "email verify link",
        "type": "CLIENT_INFO",
        "dataType": "STRING",
        "valueLength": "SHORT",
        "isDefault": false,
        "isRequired": false,
        "description": "link to account verification",
        "customFieldSet": {
          "encodedKey": "8a193c26722b51b701722d77ccaf2635",
          "id": "_Others_Clients",
          "name": "Others",
          "createdDate": "2020-05-19T15:05:25+0000",
          "lastModifiedDate": "2020-10-23T09:52:21+0000",
          "indexInList": 5,
          "type": "CLIENT_INFO",
          "usage": "SINGLE"
        },
        "indexInList": 2,
        "state": "DEACTIVATED",
        "customFieldSelectionOptions": [],
        "viewRights": {
          "encodedKey": "8a19d88a74d89f320174d9793aac7253",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "editRights": {
          "encodedKey": "8a19d88a74d89f320174d9793aac7254",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "unique": false,
        "values": [],
        "amounts": {}
      },
      "value": "http://gohere.com?param=param&from=cf",
      "indexInList": 1,
      "customFieldID": "vrfy_lnk",
      "customFieldSetGroupIndex": -1
    },
    {
      "encodedKey": "8a19d88a74d89f320174d9851c9a72ff",
      "parentKey": "8a193c26722b51b701722d77c5e423b7",
      "customFieldKey": "8a19d88a74d89f320174d97ae1837276",
      "customField": {
        "encodedKey": "8a19d88a74d89f320174d97ae1837276",
        "id": "vrfy_param",
        "creationDate": "2020-09-29T11:00:14+0000",
        "lastModifiedDate": "2021-02-10T13:28:50+0000",
        "name": "verify param",
        "type": "CLIENT_INFO",
        "dataType": "STRING",
        "valueLength": "SHORT",
        "isDefault": false,
        "isRequired": false,
        "description": "a param",
        "customFieldSet": {
          "encodedKey": "8a193c26722b51b701722d77ccaf2635",
          "id": "_Others_Clients",
          "name": "Others",
          "createdDate": "2020-05-19T15:05:25+0000",
          "lastModifiedDate": "2020-10-23T09:52:21+0000",
          "indexInList": 5,
          "type": "CLIENT_INFO",
          "usage": "SINGLE"
        },
        "indexInList": 3,
        "state": "DEACTIVATED",
        "customFieldSelectionOptions": [],
        "viewRights": {
          "encodedKey": "8a19d88a74d89f320174d97ae1837277",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "editRights": {
          "encodedKey": "8a19d88a74d89f320174d97ae1837278",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "unique": false,
        "values": [],
        "amounts": {}
      },
      "value": "123abc",
      "indexInList": 2,
      "customFieldID": "vrfy_param",
      "customFieldSetGroupIndex": -1
    }
  ],
  "idDocuments": [
    {
      "encodedKey": "8a19a68f7b05dc0d017b073218294d01",
      "clientKey": "8a193c26722b51b701722d77c5e423b7",
      "documentType": "pass",
      "documentId": "1234",
      "issuingAuthority": "jiij",
      "validUntil": "2021-09-30T00:00:00+0000",
      "indexInList": 0
    }
  ],
  "notificationTemplates": [
    {
      "encodedKey": "8a19decb737abb3201737b0b7ac3495a",
      "creationDate": "2020-07-23T09:41:30+0000",
      "lastModifiedDate": "2020-07-23T09:41:30+0000",
      "name": "pw reset portal",
      "template": "here's da link {PASSWORD_URL}",
      "type": "EMAIL",
      "targetType": "CLIENT",
      "option": "OPT_OUT",
      "event": "PORTAL_PASSWORD_RESET",
      "subject": "pw reset for portal",
      "authorization": "NO_AUTHORIZATION",
      "activated": true,
      "trigger": "AUTOMATIC",
      "isInUse": false
    },
    {
      "encodedKey": "8a19decb737abb3201737b0b7ac34958",
      "creationDate": "2020-07-23T09:41:00+0000",
      "lastModifiedDate": "2020-07-23T09:41:00+0000",
      "name": "portal activated",
      "template": "{PASSWORD_URL}",
      "type": "EMAIL",
      "targetType": "CLIENT",
      "option": "OPT_IN",
      "event": "PORTAL_ACTIVATED",
      "subject": "portal activated",
      "authorization": "NO_AUTHORIZATION",
      "activated": true,
      "trigger": "AUTOMATIC",
      "isInUse": false
    },
    {
      "encodedKey": "8a19a68f7b05dc0d017b06eb207c486d",
      "creationDate": "2021-08-02T14:08:49+0000",
      "lastModifiedDate": "2021-08-02T14:22:18+0000",
      "name": "test headers",
      "template": "{\n\"test\":\"{RECIPIENT_ID}\"\n}",
      "type": "WEB_HOOK",
      "targetType": "CLIENT",
      "option": "OPT_OUT",
      "event": "CLIENT_ACTIVITY",
      "url": "https://webhook.site/366d22e2-7038-4abc-ab8d-f5bffc017f85",
      "contentType": "APPLICATION_JSON",
      "requestType": "POST",
      "authorization": "NO_AUTHORIZATION",
      "username": "",
      "activated": true,
      "trigger": "AUTOMATIC",
      "isInUse": false
    }
  ],
  "groupKeys": []
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	ClientExpandedApiV1

Patch Client Record

PATCH /clients/{clientId}

Patch Client

update an existing client

Example Requests

Change a client's state to blacklisted

{
  "client": {
    "state": "BLACKLISTED"
  }
}

update a client with additional profile and contact information

{
  "client": {
    "middleName": "Meri",
    "clientRoleId": "client",
    "homePhone": "(77) 159-443",
    "mobilePhone1": "604-271-7041",
    "birthDate": "1987-07-08",
    "gender": null,
    "emailAddress": "test@mambu.com",
    "preferredLanguage": "ENGLISH",
    "notes": "Powered by Mambu"
  }
}

Parameters

Name	Type	Description	In
body	UpdateClientRequest	none	body
clientId (required)	string	The ID or encoded key of a client	path

Example Responses

200 Response

{
  "errorSource": "string",
  "returnCode": 0,
  "returnStatus": "string"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	ExecutionStatusApiV1

Update Client

POST /clients/{clientId}

Update a Client

update a client record

Example Requests

Add details to an existing client

{
    "client":{
      "firstName":"Max",
      "lastName":"Alexander",
      "middleName":"Frank",
      "homePhone":"56611235498",
      "emailAddress":"max.alexander@mambu.com",
      "mobilePhone1":"211111111",
      "gender":"MALE"
   }
}

Update client with encodedKey 8a512236413395270141356dbc9f0025 using JSON and remove all custom field values, addresses and ID Documents

{
   "client":{
      "firstName":"Max",
      "lastName":"Alexander",
      "middleName":"Frank",
      "homePhone":"56611235498",
      "emailAddress":"max.alexander@mambu.com",
      "mobilePhone1":"211111111",
      "gender":"MALE"
   },
   "idDocuments":[ ],
   "addresses":[ ],
   "customInformation":[ ]
}

Update a client using JSON and update custom field values, addresses, and ID documents

{
  "client": {
    "firstName": "Max",
    "lastName": "Alexander",
    "middleName": "Frank",
    "homePhone": "56611235498",
    "emailAddress": "max.alexander@mambu.com",
    "mobilePhone1": "211111111",
    "gender": "MALE"
  },
  "idDocuments": [
    {
      "documentType": "CI",
      "documentId": "23453",
      "issuingAuthority": "Police",
      "validUntil": "2014-09-30T00:00:00+0000",
      "identificationDocumentTemplateKey": "9b0a97094b4cd73f014b5f5ef0e811d2"
    },
    {
      "documentType": "Passport",
      "documentId": "sss332",
      "issuingAuthority": "Passport Agency",
      "validUntil": "2014-09-30T00:00:00+0000",
      "identificationDocumentTemplateKey": "2a0a00a24b4ce72a025c4afefce821e9"
    }
  ],
  "addresses": [
    {
      "line1": "8 Howling Lane",
      "line2": "Hackney",
      "city": "London",
      "region": "London",
      "postcode": "1234554321",
      "country": "United Kingdom"
    }
  ],
  "customInformation": [
    {
      "value": "1",
      "customFieldID": "Family_Members"
    },
    {
      "value": "TRUE",
      "customFieldID": "Has_children"
    },
    {
      "value": "Some Studies",
      "customFieldID": "Studies"
    }
  ]
}

Parameters

Name	Type	Description	In
body	CreateOrUpdateClientRequest	updated client data	body
clientId (required)	string	The ID or encoded key of a client	path

Example Responses

200 Response

{
  "addresses": [
    {
      "addressType": "string",
      "city": "string",
      "country": "string",
      "encodedKey": "string",
      "indexInList": 0,
      "latitude": 0,
      "line1": "string",
      "line2": "string",
      "longitude": 0,
      "parentKey": "string",
      "postcode": "string",
      "region": "string",
      "toBeDeleted": true
    }
  ],
  "client": {
    "activationDate": "string",
    "approvedDate": "string",
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "birthDate": "string",
    "clientRole": {
      "encodedKey": "string"
    },
    "closedDate": "string",
    "creationDate": "string",
    "emailAddress": "string",
    "encodedKey": "string",
    "firstName": "string",
    "gender": "MALE",
    "groupLoanCycle": 0,
    "homePhone": "string",
    "id": "string",
    "idPattern": "string",
    "lastModifiedDate": "string",
    "lastName": "string",
    "loanCycle": 0,
    "middleName": "string",
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "mobilePhone1": "string",
    "mobilePhone2": "string",
    "notes": "string",
    "portalPreferences": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "lastLoggedInDate": "string",
      "password": "string",
      "portalState": "DISABLED"
    },
    "preferredLanguage": "PORTUGESE",
    "profilePictureKey": "string",
    "profileSignatureKey": "string",
    "state": "PENDING_APPROVAL"
  },
  "customInformation": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "groupKeys": [
    "string"
  ],
  "idDocuments": [
    {
      "clientKey": "string",
      "documentId": "string",
      "documentType": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "identificationDocumentTemplateKey": "string",
      "indexInList": 0,
      "issuingAuthority": "string",
      "toBeDeleted": true,
      "validUntil": "string",
      "validUntilDTOdate": {
        "dayOfMonth": 0,
        "monthOfYear": 0,
        "year": 0
      }
    }
  ]
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	CreateOrUpdateClientResponse

Anonymize Client Data

POST /clients/{clientId}/action

Anonymize client

In the context of the GDPR, we wanted to provide an option to easily anonymize a client's identifiable data upon request, as an exited client must now have the 'Right to be forgotten'. To learn more about the legal aspects of this, please see Art. 17 GDPR.

This gives clients in the exited state, the right to request that all identifiable records are removed (or, more precisely, anonymized up to the point where the client is no longer traceable, but the information that the company needs to keep its systems stable can be kept within some legal standards).

Please be aware This action may only be performed on clients in the exited state. Otherwise, Mambu will return error 3760 "CLIENT_DOES_NOT_HAVE_EXITED_STATE"

A user has the permission to run the above call only via API 1.0 only if he has the 'Anonymize Client Data' permission, which can be granted by an Administrator (in User Permissions > Clients), only to users that have API access.

Please note After the anonymization call is run, a new client ID will be generated and the old client ID will be overwritten. As a consequence, calling the API twice with the same client ID will result in the second call returning a Resource Not Found (INVALID_CLIENT_ID) error.

Affected areas

Initially the client is unsubscribed from notifications (client notification requests are deleted). Afterwards the following data is affected:

Client fields:

Obfuscated:
- first name
- last name
Deleted:
- middle name, gender, notes, email address, birth date, home phone, mobile phones, address, assigned branch key, assigned centre key, assigned credit officer key.
- client Identification documents (also corresponding attachments from remote file storage)
- client profile picture and signature picture (from images table)
- client attachments (from remote file storage and documents table)
- client custom field values
- portal preferences
- client comments
- client activities (activities, sub-activities and field change items)

Client loan accounts:

Obfuscated:
- loan name
Deleted:
- notes
- custom field values for client loan accounts
- attachments for client loan accounts (from remote file storage and documents table)
- Client loan accounts transactions
Deleted:
- transaction comments
- transactions custom field values

Client loan accounts guarantees:

Obfuscated:
- asset name
Deleted:
- guarantees custom field values

Client loan repayments:

Deleted:
- repayments notes
- comments for client loan accounts
- client loan accounts activities (activities, sub-activities and field change items)

Client deposit accounts:

Obfuscated:
- account name
Deleted:
- notes
- custom field values for client savings accounts
- attachments for client savings accounts (from remote file storage and documents table)

Client savings accounts transactions:

Deleted:
- transaction comments
- transactions custom field values
- comments for client savings accounts
- client savings accounts activities (activities, sub-activities and field change items)

Client lines of credit:

Deleted:
- notes
- custom field values for client lines of credit
- attachments for client lines of credit (from remote file storage and documents table)
- lines of credit activities (activities, sub-activities and field change items)

Client guarantees (guarantees in which the client is guarantor):

Obfuscated:
- asset name
Deleted:
- guarantees custom field values

Notification messages associated with a client:

Deleted:
- notification messages associated with the client
- notification messages associated with client loan accounts
- notification messages associated with client savings accounts
- Client tasks
Deleted:
- tasks associated with the client

Payment details:

Obfuscated:
- debtor name
- debtor account IBAN
- creditor name
- creditor account IBAN

Client ID

A new client ID will be generated and the old client ID will be overwritten (as a consequence, calling the API twice with the same client ID will result in the second call returning Resource Not Found (INVALID_CLIENT_ID error).

Example Requests

ANONYMIZE client

{
  "action": "ANONYMIZE"
}

Parameters

Name	Type	Description	In
clientId (required)	string	The ID of the client	path
action (required)	string	the action to perform	body

Enumerated Values

Parameter	Value
action	`ANONYMIZE`

Example Responses

200 : ok
Sucess Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
client in wrong state

{
  "returnCode": 3760,
  "returnStatus": "CLIENT_DOES_NOT_HAVE_EXITED_STATE"
}

404 : Not Found
client not found

{
  "returnCode": 301,
  "returnStatus": "INVALID_CLIENT_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	ExecutionStatusApiV1
`400`	Bad Request	Bad Request	ExecutionStatusApiV1
`404`	Not Found	Not Found	ExecutionStatusApiV1

Update Client Custom Field Values

PATCH /clients/{clientId}/custominformation

Update custom field values

Example Requests

Update a single custom field value

{
  "customInformation": [
    {
      "customFieldID": "custom_field_2",
      "value": "3"
    }
  ]
}

Update a field in a group

{
  "customInformation": [
    {
      "customFieldID": "cf_grouped_field",
      "value": "new value",
      "customFieldSetGroupIndex": "0"
    }
  ]
}

Update multiple custom field values

{
  "customInformation": [
    {
      "customFieldID": "cf_grouped_field_2",
      "value": "3",
      "customFieldSetGroupIndex": "0"
    },
    {
      "customFieldID": "field_3",
      "value": "divorced"
    }
  ]
}

Parameters

Name	Type	Description	In
customInformation	[object]	none	body
» customFieldID (required)	string	none	body
» value (required)	string	none	body
» customFieldSetGroupIndex	string	Required if field to update is part of a group, if the Field Set Group Index is not set, a new group will be created with the value provided.	body
clientId (required)	string	The ID of the client	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Get Client Custom Field Definition

GET /clients/{clientId}/custominformation/{customFieldId}

Get a custom field definition for a client

Allows retrieving a custom field definition for a given client directly by the ID/key of the client and the ID/key of the custom field definition.

Parameters

Name	Type	Description	In
clientId (required)	string	The ID of the client.	path
customFieldId (required)	string	The ID of the custom field definition.	path

Example Responses

200 : OK
A custom field definition

[
  {
    "encodedKey": "8a19cd6f74674df9017467f25aab02c6",
    "parentKey": "8a193c26722b51b701722d779e7122de",
    "customFieldKey": "8a19cd6f74674df9017467ef8e6802af",
    "customField": {
      "encodedKey": "8a19cd6f74674df9017467ef8e6802af",
      "id": "cf_client",
      "creationDate": "2020-09-07T09:42:33+0000",
      "lastModifiedDate": "2020-09-07T09:42:33+0000",
      "name": "Example Custom Field Definition",
      "type": "BRANCH_INFO",
      "dataType": "CHECKBOX",
      "valueLength": "SHORT",
      "isDefault": false,
      "isRequired": false,
      "description": "an example of a checkbox custom field definition",
      "customFieldSet": {
        "encodedKey": "8a19cd6f74674df9017467ef8e6802ae",
        "id": "_example_client_custom_field_set",
        "name": "example client custom field set",
        "notes": "example custom field set",
        "createdDate": "2020-09-07T09:41:50+0000",
        "lastModifiedDate": "2020-09-07T09:41:50+0000",
        "indexInList": 2,
        "type": "BRANCH_INFO",
        "usage": "SINGLE"
      },
      "indexInList": 0,
      "state": "NORMAL",
      "customFieldSelectionOptions": [],
      "viewRights": {
        "encodedKey": "8a19cd6f74674df9017467ef8e6802b0",
        "isAccessibleByAllUsers": false,
        "roles": []
      },
      "editRights": {
        "encodedKey": "8a19cd6f74674df9017467ef8e6802b1",
        "isAccessibleByAllUsers": false,
        "roles": []
      },
      "unique": false,
      "values": [],
      "amounts": {}
    },
    "value": "TRUE",
    "indexInList": -1,
    "customFieldID": "cf_client",
    "customFieldSetGroupIndex": -1
  }
]

404 : Not Found
not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	CustomFieldApiV1
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Update Client Custom Field Value

PATCH /clients/{clientId}/custominformation/{customFieldId}

Update a custom field value for a client

Update a client custom field value

Example requests

{
  "value": "string"
}

Parameters

Name	Type	Description	In
value	string	none	body
clientId (required)	string	The ID of the client.	path
customFieldId (required)	string	The ID of the custom field definition.	path

Example Responses

200 : OK
Sucess response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
field is part of a group

{
  "returnCode": 916,
  "returnStatus": "INVALID_CUSTOM_FIELD_GROUP_INDEX",
  "errorSource": "cf_group_field_2"
}

404 : Not Found
not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Delete Client Custom Field Value

DELETE /clients/{clientId}/custominformation/{customFieldId}

Delete Client Custom Field Value

Delete a single custom field value

Parameters

Name	Type	Description	In
clientId (required)	string	The ID of the client.	path
customFieldId (required)	string	The ID of the custom field definition.	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
field is part of a group

{
  "returnCode": 916,
  "returnStatus": "INVALID_CUSTOM_FIELD_GROUP_INDEX",
  "errorSource": "cf_group_field_2"
}

404 : Not Found
not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Update Grouped Client Custom Fields

PATCH /clients/{clientId}/custominformation/{customFieldId}/{customFieldGroupSetIndex}

Update grouped custom field value

Update custom field value, which is part of a group

Example requests

{
  "value": "string"
}

Parameters

Name	Type	Description	In
value	string	none	body
clientId (required)	string	The ID of the client	path
customFieldId (required)	string	The ID of the custom field definition.	path
customFieldGroupSetIndex (required)	string	none	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
wrong group index provided

{
  "returnCode": 916,
  "returnStatus": "INVALID_CUSTOM_FIELD_GROUP_INDEX",
  "errorSource": "cf_group_field_2"
}

404 : Not Found
field not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Delete Grouped Client Custom Fields

DELETE /clients/{clientId}/custominformation/{customFieldId}/{customFieldGroupSetIndex}

Delete grouped custom field value

Delete a custom field value, which is part of a group

Parameters

Name	Type	Description	In
clientId (required)	string	The ID of the client	path
customFieldId (required)	string	The ID of the custom field definition.	path
customFieldGroupSetIndex (required)	string	none	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Get Client Comments

GET /clients/{clientId}/comments

Get all client comments

get all comments for a client

Parameters

Name	Type	Description	In
limit	string	none	query
offset	string	none	query
clientId (required)	string	the ID of the client	path

Example Responses

200 : OK
an array of comments

[
  {
    "encodedKey": "8a19b7057471f4af017472dc0fd80470",
    "parentKey": "8a193c26722b51b701722d77c5e423b7",
    "userKey": "8a194075720ece2c017226fced6f005e",
    "creationDate": "2020-09-09T14:24:42+0000",
    "lastModifiedDate": "2020-09-09T14:24:42+0000",
    "text": "aanother afmaefomaef<div><br /></div><div><u>aefaefaf</u></div><div><u><br /></u></div><div><u>afaef</u></div>"
  },
  {
    "encodedKey": "8a193c26722b51b701722d77c8bf25ab",
    "parentKey": "8a193c26722b51b701722d77c5e423b7",
    "creationDate": "2020-05-19T15:05:24+0000",
    "lastModifiedDate": "2020-05-19T15:05:24+0000",
    "text": "Should suggest she apply for the agriculture loan given the nature of their business"
  }
]

400 : Bad Request
bad client ID

{
  "returnCode": 149,
  "returnStatus": "INVALID_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[CommentApiV1]	none	none
» creationDate	string(date-time)	the date and time at which this comment was added	none
» encodedKey	string	a unique key for this comment	none
» lastModifiedDate	string(date-time)	the date and time at which this comment was last modified	none
» parentKey	string	the unique key of the parent object for this comment, for example, the client or loan account to which it relates	none
» text	string	the text of the comment as a string, must be properly JSON escpaped if it contains special characters	none
» userKey	string	the unique key of the user who created the comment	none

Create Client Comment

POST /clients/{clientId}/comments

Create a Client Comment

create new comment for a client

Example requests

a comment

{
  "comment": {
    "text": "this is a comment with \" \" all kinds of : \\ / \"non compliant\" stuff & = which has been JSON escaped"
  }
}

Parameters

Name	Type	Description	In
comment	object	an object contining the comment	body
» text	string	text of the comment to be added. if adding complex content make sure it is properly JSON encoded before making your request	body
clientId (required)	string	the ID of the client	path

Example Responses

200 : OK
a comment

{
  "encodedKey": "8a19c34574720f9e0174734a039f06e2",
  "parentKey": "8a193c26722b51b701722d77c5e423b7",
  "userKey": "8a194075720ece2c017226fced6f005e",
  "creationDate": "2020-09-09T14:39:36+0000",
  "lastModifiedDate": "2020-09-09T14:39:36+0000",
  "text": "this is a comment with \" \" all kinds of : \\ / non compliant stuff & = which has been JSON escaped"
}

400 : Bad Request
extra parameters in the request

{
  "returnCode": 27,
  "returnStatus": "PARAMETER_NOT_ALLOWED"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	CommentApiV1
`400`	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Get Client Documents

GET /clients/{clientId}/documents

Get Client Documents

get documents for a given client

Parameters

Name	Type	Description	In
clientId (required)	string	the ID of the client	path
offset	integer	none	query
limit	integer	none	query

Example Responses

200 Response

[
  {
    "createdByUserKey": "string",
    "creationDate": "string",
    "description": "string",
    "documentHolderKey": "string",
    "documentHolderType": "BRANCH",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "fileSize": 0,
    "id": 0,
    "lastModifiedDate": "string",
    "location": "string",
    "name": "string",
    "originalFilename": "string",
    "type": "string",
    "userName": "string"
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[DocumentApiV1]	none	none
» createdByUserKey	string	the encoded key of the user who added this document	none
» creationDate	string	the date and time when this document was created	none
» description	string	a description of this document	none
» documentHolderKey	string	the encoded key of the entity to which this document is attached	none
» documentHolderType	string	the type of entity, eg. client, loan product, to which this document is attached	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» fileSize	number	the size, in bytes, of the attached document	none
» id	number	an ID for this document	none
» lastModifiedDate	string	the date on which this document was last modified	none
» location	string	indicates where the document is saved	none
» name	string	the display name of this document	none
» originalFilename	string	the name of the originally uploaded file	none
» type	string	the file type of the document, eg. png, jpeg, pdf	none
» userName	string	the name of the user who uploaded the document	none

Enumerated Values

Property	Value
documentHolderType	`BRANCH`
documentHolderType	`LOAN_ACCOUNT`
documentHolderType	`GROUP`
documentHolderType	`DEPOSIT_ACCOUNT`
documentHolderType	`LINE_OF_CREDIT`
documentHolderType	`LOAN_PRODUCT`
documentHolderType	`GL_JOURNAL_ENTRY`
documentHolderType	`SAVINGS_PRODUCT`
documentHolderType	`USER`
documentHolderType	`CLIENT`
documentHolderType	`CENTRE`
documentHolderType	`ID_DOCUMENT`

Add Client Document

POST /clients/{clientId}/documents

Add new Document

create documents for a given client

Example requests

{
  "document": {
    "description": "string",
    "documentHolderKey": "string",
    "documentHolderType": "CLIENT",
    "name": "string",
    "type": "PDF"
  },
  "documentContent": "string"
}

Parameters

Name	Type	Description	In
clientId (required)	string	the ID of the client	path
body	CreateDocumentApiV1	a new document to be attached to an entity	body

Example Responses

201 Response

{
  "createdByUserKey": "string",
  "creationDate": "string",
  "description": "string",
  "documentHolderKey": "string",
  "documentHolderType": "BRANCH",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "fileSize": 0,
  "id": 0,
  "lastModifiedDate": "string",
  "location": "string",
  "name": "string",
  "originalFilename": "string",
  "type": "string",
  "userName": "string"
}

Responses

Status	Meaning	Description	Schema
`201`	Created	ok	DocumentApiV1

Delete Client Asset

DELETE /clients/{clientID}/documents/PROFILE_PICTURE

delete profile picture on file for a given client

Parameters

Name	Type	Description	In
clientID (required)	string	the ID of the client	path

Example Responses

200 Response

{
  "errorSource": "string",
  "returnCode": 0,
  "returnStatus": "string"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	ExecutionStatusApiV1

Get Client Profile Picture

GET /clients/{clientID}/documents/PROFILE_PICTURE

Get Client Asset

Get the profile picture for a given client. Images for the profile picture and signature are encoded in base 64. This should be read and decoded in order to generate a binary file representing the image. The format of the image is specified at the beginning of the response.

Parameters

Name	Type	Description	In
clientID (required)	string	the ID of the client	path

Example Responses

200 : OK
a base 64 encoded profile picture

"iVBORw0KGgoAAAANSUh=="

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	string

Add Client Profile Picture

POST /clients/{clientID}/documents/PROFILE_PICTURE

Update Client Profile Picture

Add or update the profile picture on file for a given client.

Example requests

client profile picture

{
  "document": {
    "documentHolderKey": "88af35b9ca0933ec72",
    "documentHolderType": "CLIENT",
    "name": "picture",
    "type": "JPG"
  },
  "documentContent": "d2h5IGRpZCB5b3UgYm90aGVyIHRvIGRlY29kZSB0aGlzPw=="
}

Parameters

Name	Type	Description	In
body	CreateDocumentApiV1	a new document to be attached to an entity	body
clientID (required)	string	the ID of the client	path

Example Responses

201 : ok
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
missing required parameter

{
  "returnCode": 4,
  "returnStatus": "INVALID_PARAMETERS",
  "errorSource": "document name is required"
}

Responses

Status	Meaning	Description	Schema
`201`	Created	ok	ExecutionStatusApiV1
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Delete Client Signature

DELETE /clients/{clientID}/documents/SIGNATURE

delete signature on file for a given client

Parameters

Name	Type	Description	In
clientID (required)	string	the ID of the client	path

Example Responses

200 Response

{
  "errorSource": "string",
  "returnCode": 0,
  "returnStatus": "string"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	ExecutionStatusApiV1

Get Client Signature

GET /clients/{clientID}/documents/SIGNATURE

Get Client Signature

get the signaturee for a given client

Parameters

Name	Type	Description	In
clientID (required)	string	the ID of the client	path

Example Responses

200 Response

"\"iVBORw0KGgoAAAANSUh==\""

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	string

Add Client Signature

POST /clients/{clientID}/documents/SIGNATURE

Update Client Signature

add or update the signature on file for a given client

Example requests

a client signature

{
  "document": {
    "documentHolderKey": "88af35b9ca0933ec72",
    "documentHolderType": "CLIENT",
    "name": "signature",
    "type": "PNG"
  },
  "documentContent": "d2h5IGRpZCB5b3UgYm90aGVyIHRvIGRlY29kZSB0aGlzPyBub3RoaW5nIGJldHRlciB0byBkbz8="
}

Parameters

Name	Type	Description	In
body	CreateDocumentApiV1	a new document to be attached to an entity	body
clientID (required)	string	the ID of the client	path

Example Responses

201 : ok
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
missing required parameter

{
  "returnCode": 4,
  "returnStatus": "INVALID_PARAMETERS",
  "errorSource": "document name is required"
}

Responses

Status	Meaning	Description	Schema
`201`	Created	ok	ExecutionStatusApiV1
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Delete Client Document

DELETE /clients/{clientId}/documents/{documentId}

Delete Client Documents

delete a client document by ID

Parameters

Name	Type	Description	In
clientId (required)	string	the id of the client	path
documentId (required)	string	none	path

Example Responses

200 : ok
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
bad Document ID

{
  "returnCode": 970,
  "returnStatus": "INVALID_DOCUMENT_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	ExecutionStatusApiV1
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Get Client Document by ID

GET /clients/{clientId}/documents/{documentId}

Get a Client Document by ID

get a client document by its ID

Parameters

Name	Type	Description	In
clientId (required)	string	the id of the client	path
documentId (required)	string	none	path

Example Responses

200 Response

"string"

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	string

Get Savings Accounts for a Client

GET /clients/{clientId}/savings

Get Savings Accounts for a Client

Get all savings accounts for a client by client id

Parameters

Name	Type	Description	In
clientId (required)	string	none	path
offset	integer	none	query
limit	integer	none	query
fullDetails	boolean	none	query
savingsId (required)	string	none	path

Example Responses

200 Response

[
  {
    "accountHolderKey": "string",
    "accountHolderType": "GROUP",
    "accountState": "WITHDRAWN",
    "accountType": "CURRENT_ACCOUNT",
    "accruedInterest": 0,
    "activationDate": "string",
    "allowOverdraft": true,
    "approvedDate": "string",
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "availableBalance": 0,
    "balance": 0,
    "closedDate": "string",
    "creationDate": "string",
    "currency": {
      "code": "string",
      "creationDate": "string",
      "currencySymbolPosition": "AFTER_NUMBER",
      "digitsAfterDecimal": 0,
      "isBaseCurrency": true,
      "lastModifiedDate": "string",
      "name": "string",
      "symbol": "string"
    },
    "currencyCode": "string",
    "customFieldValues": [
      {
        "amount": 0,
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "customFieldID": "string",
        "customFieldKey": "string",
        "customFieldSetGroupIndex": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexInList": 0,
        "linkedEntityKeyValue": "string",
        "parentKey": "string",
        "selectionKey": "string",
        "value": "string"
      }
    ],
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "feesDue": 0,
    "holdBalance": 0,
    "id": "string",
    "interestDue": 0,
    "interestPaymentDates": [
      {
        "dayOfMonth": 0,
        "monthOfYear": 0,
        "year": 0
      }
    ],
    "interestPaymentPoint": "EVERY_WEEK",
    "interestSettings": {
      "accrueInterestAfterMaturity": true,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestChargeFrequencyCount": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "TIERED_PERIOD",
      "interestRateTiers": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingBalance": 0,
          "endingDay": 0,
          "index": 0,
          "interestRate": 0
        }
      ],
      "interestSpread": 0
    },
    "lastAccountAppraisalDate": "string",
    "lastInterestCalculationDate": "string",
    "lastInterestStoredDate": "string",
    "lastModifiedDate": "string",
    "lastOverdraftInterestReviewDate": "string",
    "lastSetToArrearsDate": "string",
    "lineOfCreditKey": "string",
    "lockedBalance": 0,
    "lockedDate": "string",
    "maturityDate": "string",
    "maxWidthdrawlAmount": 0,
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "name": "string",
    "notes": "string",
    "overdraftAmount": 0,
    "overdraftExpiryDate": "string",
    "overdraftExpiryDateDTO": {
      "dayOfMonth": 0,
      "monthOfYear": 0,
      "year": 0
    },
    "overdraftInterestAccrued": 0,
    "overdraftInterestSettings": {
      "accrueInterestAfterMaturity": true,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestChargeFrequencyCount": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "TIERED_PERIOD",
      "interestRateTiers": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingBalance": 0,
          "endingDay": 0,
          "index": 0,
          "interestRate": 0
        }
      ],
      "interestSpread": 0
    },
    "overdraftLimit": 0,
    "productTypeKey": "string",
    "recommendedDepositAmount": 0,
    "targetAmount": 0,
    "technicalInterestDue": 0,
    "technicalOverdraftAmount": 0,
    "technicalOverdraftInterestAccrued": 0,
    "withholdingTaxSourceKey": "string"
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[SavingsAccountApiV1]	none	none
» accountHolderKey	string	none	none
» accountHolderType	string	none	none
» accountState	string	none	none
» accountType	string	none	none
» accruedInterest	number	none	none
» activationDate	string	none	none
» allowOverdraft	boolean	none	none
» approvedDate	string	none	none
» assignedBranchKey	string	none	none
» assignedCentreKey	string	none	none
» assignedUserKey	string	none	none
» availableBalance	number	none	none
» balance	number	none	none
» closedDate	string	none	none
» creationDate	string	the date and time when this savings account was created	none
» currency	CurrencyApiV1	none	none
»» code	string	the three letter ISO code for this currency	none
»» creationDate	string	the date on which this currency was created	none
»» currencySymbolPosition	string	indicates where the currency symbol should appear in relation to the numeric value	none
»» digitsAfterDecimal	number	indicates how many decimal places are allowed for this currency. For example, a currenncy with 100 minor units to 1 major unit, there will be 2 decimal places.	none
»» isBaseCurrency	boolean	whether this currency is the base currency for your banking institution	none
»» lastModifiedDate	string	the date on which this currency was last modified	none
»» name	string	the name of this currency	none
»» symbol	string	the currency symnbol used for this currency	none
» currencyCode	string	none	none
» customFieldValues	[CustomFieldValueApiV1]	none	none
»» amount	number	none	none
»» customField	CustomFieldApiV1	none	none
»»» amounts	object	used when options available for a custom field definition translate to predefined amounts, for example, when the custom field value is used to generate a score	none
»»»» additionalProperties	number	none	none
»»» builtInCustomFieldId	string	if this field is one of the built in custom fiel definitions, this will have a value. These names are reserved and you can not use them for your own custom field definitions	none
»»» creationDate	string	the date on which this custom field definition was created	none
»»» customFieldProductSettings	[CustomFieldLinkApiV1]	none	none
»»»» customFieldEncodedKey	string	the key to the parent custom field definition	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isDefault	boolean	whether this field is displayed by default when creating a new record	none
»»»» isRequired	boolean	whether this field is required when creating a new record	none
»»»» linkType	string	the type of entity this field represents a link to	none
»»»» productKey	string	when the link type is product, this field should contain the encoded key of the linekd product	none
»»» customFieldSelectionOptions	[CustomFieldSelectionApiV1]	[represents a possible selection for select type custom field definitions]	none
»»»» constraint	CustomFilterConstraintApiV1	none	none
»»»»» customFieldKey	string	none	none
»»»»» dataFieldType	string	none	none
»»»»» dataFieldValue	string	none	none
»»»»» dataItemType	string	none	none
»»»»» dataType	string	none	none
»»»»» encodedKey	string	none	none
»»»»» filterElement	string	none	none
»»»»» groupNumber	number	none	none
»»»»» index	number	none	none
»»»»» linkingOperator	string	none	none
»»»»» secondValue	string	none	none
»»»»» value	string	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this selectable item	none
»»»» score	number	the score assigned to this selection	none
»»»» value	string	display name of this option	none
»»» customFieldSet	CustomFieldSetApiV1	none	none
»»»» builtInType	string	if this set is part of the set of built-in custom field sets, its type will be shown here	none
»»»» createdDate	string	the date and time when this custom field set was created	none
»»»» customFields	[CustomFieldApiV1]	an array of custom field definitions included in this custom field set	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this custom field set	none
»»»» indexInList	number	for field sets that can be added to an entity more than once, this number represents the index in the list and is used when changing values	none
»»»» lastModifiedDate	string	the date on which this custom field set was last modified	none
»»»» name	string	the name of this custom field set	none
»»»» notes	string	any notes regarding this custom field set	none
»»»» type	string	the entity type that this custom field definition is attached to	none
»»»» usage	string	whether this custom field set can only be used once, or added multiple times to the same entity	none
»»» dataType	string	the type of custom field definition	none
»»» description	string	a brief description of this custom field definition	none
»»» editRights	UsageRightsApiV1	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isAccessibleByAllUsers	boolean	none	none
»»»» roles	[string]	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» id	string	the ID for this custom field definition	none
»»» indexInList	number	none	none
»»» isDefault	boolean	whether this field will be included by default on new records	none
»»» isRequired	boolean	whether this field is required when creating a new record	none
»»» lastModifiedDate	string	the date on which this custom field definition was last modified	none
»»» name	string	the name of this custom field definition	none
»»» state	string	whether this field is available for use or has been deactivated	none
»»» type	string	the type of data this custom field definition will contain	none
»»» unique	boolean	whether the data in this custom field definition needs to be a unique value	none
»»» validationPattern	string	a user-provided pattern to which data in this custom field definition must conform where @ represents numbers, # represents letters and $ is either a number or letter. Other special characters used as separators are allowed, for example `@@-##-$$$`	none
»»» valueLength	string	whether this field needs to support a large number of characters	none
»»» values	[string]	a list of possible values when the field is a selection field	none
»»» viewRights	UsageRightsApiV1	none	none
»» customFieldID	string	none	none
»» customFieldKey	string	none	none
»» customFieldSetGroupIndex	number	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» indexInList	number	none	none
»» linkedEntityKeyValue	string	none	none
»» parentKey	string	none	none
»» selectionKey	string	none	none
»» value	string	none	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» feesDue	number	none	none
» holdBalance	number	none	none
» id	string	none	none
» interestDue	number	none	none
» interestPaymentDates	[DateDTOApiV1]	none	none
»» dayOfMonth	number	the day of the month	none
»» monthOfYear	number	the month	none
»» year	number	the year	none
» interestPaymentPoint	string	none	none
» interestSettings	InterestAccountSettingsApiV1	none	none
»» accrueInterestAfterMaturity	boolean	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» interestChargeFrequency	string	none	none
»» interestChargeFrequencyCount	number	none	none
»» interestRate	number	none	none
»» interestRateReviewCount	number	none	none
»» interestRateReviewUnit	string	none	none
»» interestRateSource	string	none	none
»» interestRateTerms	string	none	none
»» interestRateTiers	[InterestRateTierApiV1]	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» endingBalance	number	none	none
»»» endingDay	number	none	none
»»» index	number	none	none
»»» interestRate	number	none	none
»» interestSpread	number	none	none
» lastAccountAppraisalDate	string	none	none
» lastInterestCalculationDate	string	none	none
» lastInterestStoredDate	string	none	none
» lastModifiedDate	string	the date on which this savings account was last modified	none
» lastOverdraftInterestReviewDate	string	none	none
» lastSetToArrearsDate	string	none	none
» lineOfCreditKey	string	none	none
» lockedBalance	number	none	none
» lockedDate	string	none	none
» maturityDate	string	none	none
» maxWidthdrawlAmount	number	none	none
» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
»» creationDate	string(date-time)	the date on which the data import was made	none
»» encodedKey	string	the encoded key of this data migration event	none
»» numCentresImported	number	the number of centres which were imported during the data migration	none
»» numClientsImported	number	the number of clients which were imported as part of the data migration	none
»» numGLAccountsImported	number	the number of general ledger accounts which were imported as part of the data migration	none
»» numGroupsImported	number	the number of groups which were imported as part of the data migration	none
»» numLoanRepaymentsImported	number	the number of loan repayment transations which were imported as part of the data migration	none
»» numLoanTransactionsImported	number	the number of loan transactions which were imported as part of the data migration	none
»» numLoansImported	number	the number of loan accounts which were imported as part of the data migration	none
»» numSavingsImported	number	the number of savings accounts which were imported as part of the data migration	none
»» state	string	whether the data import was accepted, is still in a draft state, or was rejected and all data reverted	none
»» type	string	the type of migration event	none
» name	string	none	none
» notes	string	none	none
» overdraftAmount	number	none	none
» overdraftExpiryDate	string	none	none
» overdraftExpiryDateDTO	DateDTOApiV1	none	none
» overdraftInterestAccrued	number	none	none
» overdraftInterestSettings	InterestAccountSettingsApiV1	none	none
» overdraftLimit	number	none	none
» productTypeKey	string	none	none
» recommendedDepositAmount	number	none	none
» targetAmount	number	none	none
» technicalInterestDue	number	none	none
» technicalOverdraftAmount	number	none	none
» technicalOverdraftInterestAccrued	number	none	none
» withholdingTaxSourceKey	string	none	none

Enumerated Values

Property	Value
accountHolderType	`GROUP`
accountHolderType	`CLIENT`
accountState	`WITHDRAWN`
accountState	`PARTIALLY_DISBURSED`
accountState	`LOCKED`
accountState	`ACTIVE`
accountState	`CLOSED`
accountState	`PARTIAL_APPLICATION`
accountState	`LOCKED_CAPPING`
accountState	`CLOSED_REJECTED`
accountState	`RESCHEDULED`
accountState	`ACTIVE_IN_ARREARS`
accountState	`MATURED`
accountState	`CLOSED_RESCHEDULED`
accountState	`CLOSED_WITHDRAWN`
accountState	`PENDING_APPROVAL`
accountState	`APPROVED`
accountState	`REFINANCED`
accountState	`DORMANT`
accountState	`CLOSED_WRITTEN_OFF`
accountType	`CURRENT_ACCOUNT`
accountType	`REGULAR_SAVINGS`
accountType	`FIXED_DEPOSIT`
accountType	`INVESTOR_ACCOUNT`
accountType	`SAVINGS_PLAN`
currencySymbolPosition	`AFTER_NUMBER`
currencySymbolPosition	`BEFORE_NUMBER`
builtInCustomFieldId	`MOBILE_PHONE`
builtInCustomFieldId	`EMAIL_ADDRESS`
builtInCustomFieldId	`GENDER`
builtInCustomFieldId	`MIDDLE_NAME`
builtInCustomFieldId	`HOME_PHONE`
builtInCustomFieldId	`BIRTHDATE`
builtInCustomFieldId	`LAST_NAME`
builtInCustomFieldId	`FIRST_NAME`
linkType	`CLIENT_ROLE`
linkType	`CHANNEL`
linkType	`PRODUCT`
dataFieldType	`NATIVE`
dataFieldType	`CUSTOM`
dataItemType	`WRITTEN_OFF_LOANS`
dataItemType	`LINE_OF_CREDIT`
dataItemType	`INVESTOR_FUND`
dataItemType	`TRANSACTION_DETAILS`
dataItemType	`DOCUMENT_TEMPLATE`
dataItemType	`PRODUCT`
dataItemType	`MCC_EXPIRATION`
dataItemType	`CENTRE`
dataItemType	`REPAYMENT_COLLECTION`
dataItemType	`TASK`
dataItemType	`OUTSTANDING_PORTFOLIO_AMOUNTS`
dataItemType	`REVENUE`
dataItemType	`COMPOSED_TRANSACTIONS`
dataItemType	`UNION_TRANSACTIONS`
dataItemType	`PRINCIPAL_PAYMENT_SETTINGS`
dataItemType	`LOANS`
dataItemType	`DISBURSEMENT_DETAILS`
dataItemType	`SAVINGS_TRANSACTION`
dataItemType	`IDENTIFICATION_DOCUMENT`
dataItemType	`LOAN_PRODUCT`
dataItemType	`DISBURSED_LOANS`
dataItemType	`LOAN_GROUP`
dataItemType	`TRANSACTION_CHANNEL`
dataItemType	`CUSTOM_PREDEFINED_FEE`
dataItemType	`JOURNAL_ENTRY`
dataItemType	`ATTACHMENT`
dataItemType	`PREDEFINED_FEE`
dataItemType	`TRANCHE`
dataItemType	`TRANSACTION`
dataItemType	`INDEX_RATE_SOURCE`
dataItemType	`GROUP_ROLE`
dataItemType	`LOAN_TRANSACTION`
dataItemType	`CLIENT_ROLE`
dataItemType	`GROUP`
dataItemType	`NOTIFICATION_MESSAGE`
dataItemType	`OUTSTANDING_PORTFOLIO_ACCOUNTS`
dataItemType	`REPAYMENT`
dataItemType	`LOAN_ACCOUNT_GUARANTY`
dataItemType	`BRANCH`
dataItemType	`CURRENCY`
dataItemType	`CARD_TRANSACTION_REVERSAL`
dataItemType	`INTEREST_PRODUCT_SETTINGS`
dataItemType	`CREATED_ACCOUNTS`
dataItemType	`USER`
dataItemType	`SAVINGS_PRODUCT`
dataItemType	`CLIENT`
dataItemType	`PRODUCT_ARREARS_SETTINGS`
dataItemType	`SAVINGS`
dataItemType	`EXPENSE`
dataItemType	`INDEX_RATE`
dataItemType	`NOTIFICATION_TEMPLATE`
dataItemType	`CUSTOM_FIELD_SELECTION`
dataItemType	`ACTIVITY`
dataType	`ENUM`
dataType	`MONEY`
dataType	`NUMBER`
dataType	`DATE_UTC`
dataType	`JAVA_BLOB`
dataType	`OBJECT`
dataType	`BOOLEAN`
dataType	`DATE`
dataType	`PERCENT`
dataType	`BIG_DECIMAL`
dataType	`STRING`
dataType	`KEY`
dataType	`LONG`
filterElement	`STARTS_WITH_CASE_SENSITIVE`
filterElement	`THIS_WEEK`
filterElement	`EQUALS`
filterElement	`STARTS_WITH`
filterElement	`IN`
filterElement	`TODAY`
filterElement	`THIS_YEAR`
filterElement	`BETWEEN`
filterElement	`AFTER`
filterElement	`LESS_THAN`
filterElement	`DIFFERENT_THAN`
filterElement	`THIS_MONTH`
filterElement	`NOT_EMPTY`
filterElement	`BEFORE`
filterElement	`EQUALS_CASE_SENSITIVE`
filterElement	`LAST_DAYS`
filterElement	`MORE_THAN`
filterElement	`EMPTY`
filterElement	`ON`
linkingOperator	`OR`
linkingOperator	`AND`
builtInType	`DETAILS`
builtInType	`GENERAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
usage	`SINGLE`
usage	`GROUPED`
dataType	`GROUP_LINK`
dataType	`DATE`
dataType	`NUMBER`
dataType	`CHECKBOX`
dataType	`CLIENT_LINK`
dataType	`STRING`
dataType	`USER_LINK`
dataType	`SELECTION`
state	`DEACTIVATED`
state	`NORMAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
valueLength	`SHORT`
valueLength	`LONG`
interestPaymentPoint	`EVERY_WEEK`
interestPaymentPoint	`ON_FIXED_DATES`
interestPaymentPoint	`EVERY_MONTH`
interestPaymentPoint	`ON_ACCOUNT_MATURITY`
interestPaymentPoint	`EVERY_3_MONTHS`
interestPaymentPoint	`FIRST_DAY_OF_MONTH`
interestPaymentPoint	`EVERY_OTHER_WEEK`
interestChargeFrequency	`EVERY_WEEK`
interestChargeFrequency	`ANNUALIZED`
interestChargeFrequency	`EVERY_MONTH`
interestChargeFrequency	`EVERY_X_DAYS`
interestChargeFrequency	`EVERY_FOUR_WEEKS`
interestChargeFrequency	`EVERY_DAY`
interestRateReviewUnit	`MONTHS`
interestRateReviewUnit	`WEEKS`
interestRateReviewUnit	`DAYS`
interestRateSource	`FIXED_INTEREST_RATE`
interestRateSource	`INDEX_INTEREST_RATE`
interestRateTerms	`TIERED_PERIOD`
interestRateTerms	`FIXED`
interestRateTerms	`TIERED`
state	`REVERTED`
state	`DRAFT`
state	`APPROVED`
type	`IMPORT`
type	`EXPORT`

Get a Savings Account for a Client

GET /clients/{clientId}/savings/{savingsAccountId}

Get a Savings Account for a Client

Get a specific savings account for a given client by savings account ID

Parameters

Name	Type	Description	In
clientId (required)	string	none	path
fullDetails	boolean	none	query
savingsId (required)	string	none	path
savingsAccountId (required)	string	none	path

Example Responses

200 Response

{
  "accountHolderKey": "string",
  "accountHolderType": "GROUP",
  "accountState": "WITHDRAWN",
  "accountType": "CURRENT_ACCOUNT",
  "accruedInterest": 0,
  "activationDate": "string",
  "allowOverdraft": true,
  "approvedDate": "string",
  "assignedBranchKey": "string",
  "assignedCentreKey": "string",
  "assignedUserKey": "string",
  "availableBalance": 0,
  "balance": 0,
  "closedDate": "string",
  "creationDate": "string",
  "currency": {
    "code": "string",
    "creationDate": "string",
    "currencySymbolPosition": "AFTER_NUMBER",
    "digitsAfterDecimal": 0,
    "isBaseCurrency": true,
    "lastModifiedDate": "string",
    "name": "string",
    "symbol": "string"
  },
  "currencyCode": "string",
  "customFieldValues": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "feesDue": 0,
  "holdBalance": 0,
  "id": "string",
  "interestDue": 0,
  "interestPaymentDates": [
    {
      "dayOfMonth": 0,
      "monthOfYear": 0,
      "year": 0
    }
  ],
  "interestPaymentPoint": "EVERY_WEEK",
  "interestSettings": {
    "accrueInterestAfterMaturity": true,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "interestChargeFrequency": "EVERY_WEEK",
    "interestChargeFrequencyCount": 0,
    "interestRate": 0,
    "interestRateReviewCount": 0,
    "interestRateReviewUnit": "MONTHS",
    "interestRateSource": "FIXED_INTEREST_RATE",
    "interestRateTerms": "TIERED_PERIOD",
    "interestRateTiers": [
      {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "endingBalance": 0,
        "endingDay": 0,
        "index": 0,
        "interestRate": 0
      }
    ],
    "interestSpread": 0
  },
  "lastAccountAppraisalDate": "string",
  "lastInterestCalculationDate": "string",
  "lastInterestStoredDate": "string",
  "lastModifiedDate": "string",
  "lastOverdraftInterestReviewDate": "string",
  "lastSetToArrearsDate": "string",
  "lineOfCreditKey": "string",
  "lockedBalance": 0,
  "lockedDate": "string",
  "maturityDate": "string",
  "maxWidthdrawlAmount": 0,
  "migrationEvent": {
    "creationDate": "2019-08-24T14:15:22Z",
    "encodedKey": "string",
    "numCentresImported": 0,
    "numClientsImported": 0,
    "numGLAccountsImported": 0,
    "numGroupsImported": 0,
    "numLoanRepaymentsImported": 0,
    "numLoanTransactionsImported": 0,
    "numLoansImported": 0,
    "numSavingsImported": 0,
    "state": "REVERTED",
    "type": "IMPORT"
  },
  "name": "string",
  "notes": "string",
  "overdraftAmount": 0,
  "overdraftExpiryDate": "string",
  "overdraftExpiryDateDTO": {
    "dayOfMonth": 0,
    "monthOfYear": 0,
    "year": 0
  },
  "overdraftInterestAccrued": 0,
  "overdraftInterestSettings": {
    "accrueInterestAfterMaturity": true,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "interestChargeFrequency": "EVERY_WEEK",
    "interestChargeFrequencyCount": 0,
    "interestRate": 0,
    "interestRateReviewCount": 0,
    "interestRateReviewUnit": "MONTHS",
    "interestRateSource": "FIXED_INTEREST_RATE",
    "interestRateTerms": "TIERED_PERIOD",
    "interestRateTiers": [
      {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "endingBalance": 0,
        "endingDay": 0,
        "index": 0,
        "interestRate": 0
      }
    ],
    "interestSpread": 0
  },
  "overdraftLimit": 0,
  "productTypeKey": "string",
  "recommendedDepositAmount": 0,
  "targetAmount": 0,
  "technicalInterestDue": 0,
  "technicalOverdraftAmount": 0,
  "technicalOverdraftInterestAccrued": 0,
  "withholdingTaxSourceKey": "string"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	SavingsAccountApiV1

Get all Loan Accounts for a Client

GET /clients/{clientId}/loans/{loanAccountId}

Get all Loan Accounts for a Client

Get details on a specific Loan Account for a specific client.

Parameters

Name	Type	Description	In
fullDetails	boolean	none	query
clientId (required)	string	The ID of the client. The format is determined by your organization.	path
loanAccountId (required)	string	The ID or encoded key of the loan account. The format is determined by your organization.	path

Example Responses

200 : ok
a loan account with full details

{
  "encodedKey": "8a8086c46f7a3258016f7b4d25f50126",
  "id": "XNZR612",
  "accountHolderKey": "8a80877d6f65da00016f6670eb950022",
  "accountHolderType": "CLIENT",
  "creationDate": "2020-01-06T14:43:36+0000",
  "approvedDate": "2020-01-06T15:43:46+0000",
  "lastModifiedDate": "2020-02-06T12:49:13+0000",
  "activationTransactionKey": "8a8086c46f7a3258016f7b4facdb0139",
  "lastAccountAppraisalDate": "2020-02-06T00:00:06+0000",
  "accountState": "ACTIVE",
  "productTypeKey": "8a8086c46f7a3258016f7b4d25d60118",
  "loanName": "review frequency daily",
  "loanAmount": "2500",
  "periodicPayment": "0",
  "tranches": [],
  "principalDue": "207.49",
  "principalPaid": "207.31",
  "principalBalance": "2292.69",
  "redrawBalance": "0",
  "interestDue": "1.97",
  "interestPaid": "2.15",
  "interestFromArrearsBalance": "0",
  "interestFromArrearsDue": "0",
  "interestFromArrearsPaid": "0",
  "interestBalance": "1.97",
  "feesDue": "0",
  "feesPaid": "0",
  "feesBalance": "0",
  "penaltyDue": "0",
  "penaltyPaid": "0",
  "penaltyBalance": "0",
  "scheduleDueDatesMethod": "INTERVAL",
  "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
  "futurePaymentsAcceptance": "NO_FUTURE_PAYMENTS",
  "hasCustomSchedule": false,
  "repaymentPeriodCount": 1,
  "repaymentPeriodUnit": "MONTHS",
  "repaymentInstallments": 12,
  "gracePeriod": 0,
  "gracePeriodType": "NONE",
  "interestRate": "1",
  "customFieldValues": [
    {
      "encodedKey": "8a8086567019cc6c01701a8b30596da2",
      "parentKey": "8a8086c46f7a3258016f7b4d25f50126",
      "customFieldKey": "8a8086567019cc6c01701a869a4a6d81",
      "customField": {
        "encodedKey": "8a8086567019cc6c01701a869a4a6d81",
        "id": "sclt_1",
        "creationDate": "2020-02-06T12:47:32+0000",
        "lastModifiedDate": "2020-02-06T12:47:32+0000",
        "name": "selection 1",
        "type": "LOAN_ACCOUNT_INFO",
        "dataType": "SELECTION",
        "valueLength": "SHORT",
        "isDefault": false,
        "isRequired": false,
        "description": "",
        "customFieldSet": {
          "encodedKey": "8a8086567019cc6c01701a869a4a6d80",
          "id": "_loans_cf_set",
          "name": "loans cf set",
          "notes": "",
          "createdDate": "2020-02-06T12:46:55+0000",
          "lastModifiedDate": "2020-02-06T12:46:55+0000",
          "indexInList": 0,
          "type": "LOAN_ACCOUNT_INFO",
          "usage": "SINGLE"
        },
        "indexInList": 0,
        "state": "NORMAL",
        "customFieldSelectionOptions": [
          {
            "encodedKey": "8a8086567019cc6c01701a8a8c136d91",
            "id": "783728922",
            "value": "option 1",
            "score": "10"
          },
          {
            "encodedKey": "8a8086567019cc6c01701a8a8c1a6d92",
            "id": "672532084",
            "value": "option 2",
            "score": "5"
          },
          {
            "encodedKey": "8a8086567019cc6c01701a8a8c1a6d93",
            "id": "403063097",
            "value": "option 3",
            "score": "1"
          }
        ],
        "viewRights": {
          "encodedKey": "8a8086567019cc6c01701a869a4a6d82",
          "isAccessibleByAllUsers": true,
          "roles": []
        },
        "editRights": {
          "encodedKey": "8a8086567019cc6c01701a8a8c066d88",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "unique": false,
        "values": [
          "option 1",
          "option 2",
          "option 3"
        ],
        "amounts": {
          "option 3": "1",
          "option 1": "10",
          "option 2": "5"
        }
      },
      "value": "option 2",
      "amount": "5",
      "indexInList": -1,
      "customFieldID": "sclt_1",
      "customFieldSetGroupIndex": -1
    },
    {
      "encodedKey": "8a8086567019cc6c01701a8b30596da4",
      "parentKey": "8a8086c46f7a3258016f7b4d25f50126",
      "customFieldKey": "8a8086567019cc6c01701a8a8c1a6d94",
      "customField": {
        "encodedKey": "8a8086567019cc6c01701a8a8c1a6d94",
        "id": "slct_2",
        "creationDate": "2020-02-06T12:48:14+0000",
        "lastModifiedDate": "2020-02-06T12:48:14+0000",
        "name": "selection 2",
        "type": "LOAN_ACCOUNT_INFO",
        "dataType": "SELECTION",
        "valueLength": "SHORT",
        "isDefault": false,
        "isRequired": false,
        "description": "",
        "customFieldSet": {
          "encodedKey": "8a8086567019cc6c01701a869a4a6d80",
          "id": "_loans_cf_set",
          "name": "loans cf set",
          "notes": "",
          "createdDate": "2020-02-06T12:46:55+0000",
          "lastModifiedDate": "2020-02-06T12:46:55+0000",
          "indexInList": 0,
          "type": "LOAN_ACCOUNT_INFO",
          "usage": "SINGLE"
        },
        "indexInList": 1,
        "state": "NORMAL",
        "customFieldSelectionOptions": [
          {
            "encodedKey": "8a8086567019cc6c01701a8b30526d9f",
            "id": "789812737",
            "value": "option a",
            "score": "1"
          },
          {
            "encodedKey": "8a8086567019cc6c01701a8b30526da0",
            "id": "000604002",
            "value": "option b",
            "score": "5"
          },
          {
            "encodedKey": "8a8086567019cc6c01701a8b30596da1",
            "id": "343885651",
            "value": "option c",
            "score": "10"
          }
        ],
        "viewRights": {
          "encodedKey": "8a8086567019cc6c01701a8a8c1a6d95",
          "isAccessibleByAllUsers": true,
          "roles": []
        },
        "editRights": {
          "encodedKey": "8a8086567019cc6c01701a8a8c1a6d96",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "unique": false,
        "values": [
          "option a",
          "option b",
          "option c"
        ],
        "amounts": {
          "option c": "10",
          "option a": "1",
          "option b": "5"
        }
      },
      "value": "option c",
      "amount": "10",
      "indexInList": -1,
      "customFieldID": "slct_2",
      "customFieldSetGroupIndex": -1
    }
  ],
  "interestChargeFrequency": "ANNUALIZED",
  "interestCalculationMethod": "DECLINING_BALANCE_DISCOUNTED",
  "interestType": "SIMPLE_INTEREST",
  "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
  "repaymentScheduleMethod": "DYNAMIC",
  "paymentMethod": "HORIZONTAL",
  "interestApplicationMethod": "ON_REPAYMENT",
  "accrueInterestAfterMaturity": false,
  "assignedBranchKey": "8a8086e96f61bf2c016f65f5192a0271",
  "notes": "",
  "principalRepaymentInterval": 1,
  "interestRateSource": "INDEX_INTEREST_RATE",
  "interestRateReviewUnit": "DAYS",
  "interestRateReviewCount": 1,
  "interestSpread": "1",
  "lastInterestReviewDate": "2020-02-06T00:00:00+0000",
  "accruedInterest": "0.19",
  "interestFromArrearsAccrued": "0.02",
  "lastInterestAppliedDate": "2020-02-03T00:00:00+0000",
  "funds": [],
  "guarantees": [],
  "accruedPenalty": "0",
  "loanPenaltyCalculationMethod": "NONE",
  "disbursementDetails": {
    "encodedKey": "8a8086c46f7a3258016f7b4fac3b0127",
    "expectedDisbursementDate": "2019-12-01T00:00:00+0000",
    "disbursementDate": "2019-12-01T00:00:00+0000",
    "firstRepaymentDate": "2020-01-01T00:00:00+0000",
    "transactionDetails": {
      "encodedKey": "8a8086c46f7a3258016f7b4fac3b0128",
      "transactionChannelKey": "8a80877d6f451a5c016f466bdd120049",
      "internalTransfer": false,
      "transactionChannel": {
        "encodedKey": "8a80877d6f451a5c016f466bdd120049",
        "id": "cash",
        "name": "Cash",
        "creationDate": "2019-12-27T09:14:35+0000",
        "index": 0,
        "activated": true,
        "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
        "savingsConstraints": {
          "encodedKey": "8a80877d6f451a5c016f466bea33004b",
          "filterConstraints": []
        },
        "usageRights": {
          "encodedKey": "8a80877d6f451a5c016f466bdd12004a",
          "isAccessibleByAllUsers": true,
          "roles": []
        }
      }
    },
    "fees": [],
    "customInformation": []
  },
  "arrearsTolerancePeriod": 3,
  "accountArrearsSettings": {
    "tolerancePeriod": 3,
    "encodedKey": "8a8086c46f7a3258016f7b4fac3b0129",
    "toleranceCalculationMethod": "ARREARS_TOLERANCE_PERIOD",
    "dateCalculationMethod": "DATE_ACCOUNT_FIRST_WENT_TO_ARREARS",
    "nonWorkingDaysMethod": "EXCLUDED"
  },
  "paymentPlan": [],
  "interestRoundingVersion": "VERSION_2",
  "prepaymentRecalculationMethod": "NO_RECALCULATION",
  "principalPaidInstallmentStatus": "PARTIALLY_PAID",
  "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
  "applyInterestOnPrepaymentMethod": "AUTOMATIC",
  "allowOffset": false,
  "accrueLateInterest": true,
  "holdBalance": "0",
  "fees": [
    {
      "fee": {
        "encodedKey": "8a8080855283305201528369d0d3001c"
      }
    },
    {
      "fee": {
        "encodedKey": "8a8080855283305201528369d0d3001b"
      },
      "amount": "10"
    },
    {
      "fee": {
        "encodedKey": "8a808085528330520152836c5950002a"
      },
      "amount": "55"
    }
  ]
}

400 : Bad Request
bad loan accont ID

{
  "returnCode": 100,
  "returnStatus": "INVALID_LOAN_ACCOUNT_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	LoanAccountFullDetailsApiV1
`400`	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Description	Restrictions
» returnCode (required)	integer	none	none
» returnStatus (required)	string	none	none
» errorSource	string	none	none

Currencies

Retrieve currency information which the organization is using for its accounts. Can retrieve a list of currencies or a specific one by code.

Get all Currencies

GET /currencies

List all currencies

Retrieves currencies used by the organization. By default only base currencies will be returned.

Parameters

Name	Type	Description	In
includeForeign	boolean	Whether to include foreign currencies supported by the organization	query

Example Responses

200 : ok
a list of currencies including non-base currencies

[
  {
    "code": "USD",
    "name": "United States dollar",
    "symbol": "$",
    "digitsAfterDecimal": 2,
    "currencySymbolPosition": "BEFORE_NUMBER",
    "isBaseCurrency": true,
    "creationDate": "2016-05-24T16:51:12+0000",
    "lastModifiedDate": "2016-05-24T16:51:12+0000"
  },
  {
    "code": "RON",
    "name": "Romanian new leu",
    "symbol": "lei",
    "digitsAfterDecimal": 2,
    "currencySymbolPosition": "BEFORE_NUMBER",
    "isBaseCurrency": false,
    "creationDate": "2016-05-24T14:20:41+0000",
    "lastModifiedDate": "2016-05-24T14:20:41+0000"
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[CurrencyApiV1]	none	none
» code	string	the three letter ISO code for this currency	none
» creationDate	string	the date on which this currency was created	none
» currencySymbolPosition	string	indicates where the currency symbol should appear in relation to the numeric value	none
» digitsAfterDecimal	number	indicates how many decimal places are allowed for this currency. For example, a currenncy with 100 minor units to 1 major unit, there will be 2 decimal places.	none
» isBaseCurrency	boolean	whether this currency is the base currency for your banking institution	none
» lastModifiedDate	string	the date on which this currency was last modified	none
» name	string	the name of this currency	none
» symbol	string	the currency symnbol used for this currency	none

Enumerated Values

Property	Value
currencySymbolPosition	`AFTER_NUMBER`
currencySymbolPosition	`BEFORE_NUMBER`

Get Currency by ISO Code

GET /currencies/{currencyCode}

Get a single currency

get a currency by id

Parameters

Name	Type	Description	In
currencyCode (required)	string	none	path

Example Responses

200 Response

{
  "code": "string",
  "creationDate": "string",
  "currencySymbolPosition": "AFTER_NUMBER",
  "digitsAfterDecimal": 0,
  "isBaseCurrency": true,
  "lastModifiedDate": "string",
  "name": "string",
  "symbol": "string"
}

404 : Not Found
bad currency code

{
  "returnCode": 650,
  "returnStatus": "INVALID_CURRENCY_CODE"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	CurrencyApiV1
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 404

Name	Type	Description	Restrictions
» returnCode	string	none	none
» returnStatus	string	none	none

Get Currency Exchange Rates

GET /currencies/{currencyCode}/rates

List Currency Rates

Retrieves currency's exchange rates. If both from and to parameters are specified, it returns the list of exchange rates that start in/after from date or before(exclusive) to date.

Parameters

Name	Type	Description	In
offset	integer	The start index of the returned exchange rates list.	query
limit	integer	The number of elements to be returned.	query
from	string(date)	From (start) date to retrieve the exchange rates.	query
to	string(date)	To (end) date to retrieve the exchange rates.	query
currencyCode (required)	string	the three letter ISO code of the currency for	path

Example Responses

200 : ok
EUR/ARS exchange rate

[
  {
    "encodedKey": "8a19cd6f74674df90174681f214103d3",
    "userKey": "8a194075720ece2c017226fced6f005e",
    "fromCurrencyCode": "EUR",
    "toCurrencyCode": "ARS",
    "buyRate": "0.0113653",
    "sellRate": "87.9872",
    "startDate": "2020-09-07T15:24:11+0000"
  }
]

400 : Bad Request
buy and sell rate values switched

{
  "returnCode": 656,
  "returnStatus": "BUY_RATE_GREATER_THAN_SELL_RATE"
}

404 : Not Found
bad currency code

{
  "returnCode": 650,
  "returnStatus": "INVALID_CURRENCY_CODE"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline
`400`	Bad Request	Bad Request	Inline
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[ExchangeRateApiV1]	none	none
» buyRate (required)	number	The amount the currency will be bought compared to the base currency.	none
» encodedKey	string	a unique key for this exchange rate	none
» endDate	string(date-time)	the date and time at which this rate was replaced by a newer one	none
» fromCurrencyCode	string	the currency code from which the currency will be exchanged	none
» sellRate (required)	number	The amount the currency will be sold to base currency.	none
» startDate (required)	string(date-time)	The date from which the exchange rate will be valid. Must not be in the future or before the latest exchange rate's (for that currency) start date. If not provided, the organization current date and time will be used.	none
» toCurrencyCode	string	the currency code into which the currency will be exchanged	none
» userKey	string	the encoded key of the user who created the exchange rate	none

Status Code 400

Name	Type	Description	Restrictions
» returnCode	string	none	none
» returnStatus	string	none	none

Status Code 404

Name	Type	Description	Restrictions
» returnCode	string	none	none
» returnStatus	string	none	none

Update Currency Exchange Rate

POST /currencies/{currencyCode}/rates

Set or update exchange rate

Stores a new exchange rate for a given currency.

Example requests

exchange rate

{
  "buyRate": "0.0113420",
  "sellRate": "86.0342"
}

Parameters

Name	Type	Description	In
body	CreateExchangeRateApiV1	Post new currency exchange rate with optional validity start date	body
currencyCode (required)	string	the three letter ISO code of the currency for	path

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	None

Custom Field Sets

Allows you to retrieve the defined custom field sets.

Get Custom Field Sets

GET /customfieldsets

List Custom Field Sets

Allows retrieving of a list custom field sets that can be optionaly filtered by type. If a given type has no fields, an empty array will be returned.

Parameters

Name	Type	Description	In
type	string	Filter by entity type	query

Enumerated Values

Parameter	Value
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`

Example Responses

200 Response

[
  {
    "builtInType": "DETAILS",
    "createdDate": "string",
    "customFields": [
      {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {},
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      }
    ],
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "id": "string",
    "indexInList": 0,
    "lastModifiedDate": "string",
    "name": "string",
    "notes": "string",
    "type": "USER_INFO",
    "usage": "SINGLE"
  }
]

400 : Bad Request
bad type filter

{
  "returnCode": 4,
  "returnStatus": "INVALID_PARAMETERS",
  "errorSource": "there is a problem with the input parameters"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline
`400`	Bad Request	Bad Request	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[CustomFieldSetApiV1]	none	none
» builtInType	string	if this set is part of the set of built-in custom field sets, its type will be shown here	none
» createdDate	string	the date and time when this custom field set was created	none
» customFields	[CustomFieldApiV1]	an array of custom field definitions included in this custom field set	none
»» amounts	object	used when options available for a custom field definition translate to predefined amounts, for example, when the custom field value is used to generate a score	none
»»» additionalProperties	number	none	none
»» builtInCustomFieldId	string	if this field is one of the built in custom fiel definitions, this will have a value. These names are reserved and you can not use them for your own custom field definitions	none
»» creationDate	string	the date on which this custom field definition was created	none
»» customFieldProductSettings	[CustomFieldLinkApiV1]	none	none
»»» customFieldEncodedKey	string	the key to the parent custom field definition	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» isDefault	boolean	whether this field is displayed by default when creating a new record	none
»»» isRequired	boolean	whether this field is required when creating a new record	none
»»» linkType	string	the type of entity this field represents a link to	none
»»» productKey	string	when the link type is product, this field should contain the encoded key of the linekd product	none
»» customFieldSelectionOptions	[CustomFieldSelectionApiV1]	[represents a possible selection for select type custom field definitions]	none
»»» constraint	CustomFilterConstraintApiV1	none	none
»»»» customFieldKey	string	none	none
»»»» dataFieldType	string	none	none
»»»» dataFieldValue	string	none	none
»»»» dataItemType	string	none	none
»»»» dataType	string	none	none
»»»» encodedKey	string	none	none
»»»» filterElement	string	none	none
»»»» groupNumber	number	none	none
»»»» index	number	none	none
»»»» linkingOperator	string	none	none
»»»» secondValue	string	none	none
»»»» value	string	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» id	string	the ID of this selectable item	none
»»» score	number	the score assigned to this selection	none
»»» value	string	display name of this option	none
»» customFieldSet	CustomFieldSetApiV1	none	none
»» dataType	string	the type of custom field definition	none
»» description	string	a brief description of this custom field definition	none
»» editRights	UsageRightsApiV1	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» isAccessibleByAllUsers	boolean	none	none
»»» roles	[string]	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» id	string	the ID for this custom field definition	none
»» indexInList	number	none	none
»» isDefault	boolean	whether this field will be included by default on new records	none
»» isRequired	boolean	whether this field is required when creating a new record	none
»» lastModifiedDate	string	the date on which this custom field definition was last modified	none
»» name	string	the name of this custom field definition	none
»» state	string	whether this field is available for use or has been deactivated	none
»» type	string	the type of data this custom field definition will contain	none
»» unique	boolean	whether the data in this custom field definition needs to be a unique value	none
»» validationPattern	string	a user-provided pattern to which data in this custom field definition must conform where @ represents numbers, # represents letters and $ is either a number or letter. Other special characters used as separators are allowed, for example `@@-##-$$$`	none
»» valueLength	string	whether this field needs to support a large number of characters	none
»» values	[string]	a list of possible values when the field is a selection field	none
»» viewRights	UsageRightsApiV1	none	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» id	string	the ID of this custom field set	none
» indexInList	number	for field sets that can be added to an entity more than once, this number represents the index in the list and is used when changing values	none
» lastModifiedDate	string	the date on which this custom field set was last modified	none
» name	string	the name of this custom field set	none
» notes	string	any notes regarding this custom field set	none
» type	string	the entity type that this custom field definition is attached to	none
» usage	string	whether this custom field set can only be used once, or added multiple times to the same entity	none

Enumerated Values

Property	Value
builtInType	`DETAILS`
builtInType	`GENERAL`
builtInCustomFieldId	`MOBILE_PHONE`
builtInCustomFieldId	`EMAIL_ADDRESS`
builtInCustomFieldId	`GENDER`
builtInCustomFieldId	`MIDDLE_NAME`
builtInCustomFieldId	`HOME_PHONE`
builtInCustomFieldId	`BIRTHDATE`
builtInCustomFieldId	`LAST_NAME`
builtInCustomFieldId	`FIRST_NAME`
linkType	`CLIENT_ROLE`
linkType	`CHANNEL`
linkType	`PRODUCT`
dataFieldType	`NATIVE`
dataFieldType	`CUSTOM`
dataItemType	`WRITTEN_OFF_LOANS`
dataItemType	`LINE_OF_CREDIT`
dataItemType	`INVESTOR_FUND`
dataItemType	`TRANSACTION_DETAILS`
dataItemType	`DOCUMENT_TEMPLATE`
dataItemType	`PRODUCT`
dataItemType	`MCC_EXPIRATION`
dataItemType	`CENTRE`
dataItemType	`REPAYMENT_COLLECTION`
dataItemType	`TASK`
dataItemType	`OUTSTANDING_PORTFOLIO_AMOUNTS`
dataItemType	`REVENUE`
dataItemType	`COMPOSED_TRANSACTIONS`
dataItemType	`UNION_TRANSACTIONS`
dataItemType	`PRINCIPAL_PAYMENT_SETTINGS`
dataItemType	`LOANS`
dataItemType	`DISBURSEMENT_DETAILS`
dataItemType	`SAVINGS_TRANSACTION`
dataItemType	`IDENTIFICATION_DOCUMENT`
dataItemType	`LOAN_PRODUCT`
dataItemType	`DISBURSED_LOANS`
dataItemType	`LOAN_GROUP`
dataItemType	`TRANSACTION_CHANNEL`
dataItemType	`CUSTOM_PREDEFINED_FEE`
dataItemType	`JOURNAL_ENTRY`
dataItemType	`ATTACHMENT`
dataItemType	`PREDEFINED_FEE`
dataItemType	`TRANCHE`
dataItemType	`TRANSACTION`
dataItemType	`INDEX_RATE_SOURCE`
dataItemType	`GROUP_ROLE`
dataItemType	`LOAN_TRANSACTION`
dataItemType	`CLIENT_ROLE`
dataItemType	`GROUP`
dataItemType	`NOTIFICATION_MESSAGE`
dataItemType	`OUTSTANDING_PORTFOLIO_ACCOUNTS`
dataItemType	`REPAYMENT`
dataItemType	`LOAN_ACCOUNT_GUARANTY`
dataItemType	`BRANCH`
dataItemType	`CURRENCY`
dataItemType	`CARD_TRANSACTION_REVERSAL`
dataItemType	`INTEREST_PRODUCT_SETTINGS`
dataItemType	`CREATED_ACCOUNTS`
dataItemType	`USER`
dataItemType	`SAVINGS_PRODUCT`
dataItemType	`CLIENT`
dataItemType	`PRODUCT_ARREARS_SETTINGS`
dataItemType	`SAVINGS`
dataItemType	`EXPENSE`
dataItemType	`INDEX_RATE`
dataItemType	`NOTIFICATION_TEMPLATE`
dataItemType	`CUSTOM_FIELD_SELECTION`
dataItemType	`ACTIVITY`
dataType	`ENUM`
dataType	`MONEY`
dataType	`NUMBER`
dataType	`DATE_UTC`
dataType	`JAVA_BLOB`
dataType	`OBJECT`
dataType	`BOOLEAN`
dataType	`DATE`
dataType	`PERCENT`
dataType	`BIG_DECIMAL`
dataType	`STRING`
dataType	`KEY`
dataType	`LONG`
filterElement	`STARTS_WITH_CASE_SENSITIVE`
filterElement	`THIS_WEEK`
filterElement	`EQUALS`
filterElement	`STARTS_WITH`
filterElement	`IN`
filterElement	`TODAY`
filterElement	`THIS_YEAR`
filterElement	`BETWEEN`
filterElement	`AFTER`
filterElement	`LESS_THAN`
filterElement	`DIFFERENT_THAN`
filterElement	`THIS_MONTH`
filterElement	`NOT_EMPTY`
filterElement	`BEFORE`
filterElement	`EQUALS_CASE_SENSITIVE`
filterElement	`LAST_DAYS`
filterElement	`MORE_THAN`
filterElement	`EMPTY`
filterElement	`ON`
linkingOperator	`OR`
linkingOperator	`AND`
dataType	`GROUP_LINK`
dataType	`DATE`
dataType	`NUMBER`
dataType	`CHECKBOX`
dataType	`CLIENT_LINK`
dataType	`STRING`
dataType	`USER_LINK`
dataType	`SELECTION`
state	`DEACTIVATED`
state	`NORMAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
valueLength	`SHORT`
valueLength	`LONG`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
usage	`SINGLE`
usage	`GROUPED`

Status Code 400

Name	Type	Description	Restrictions
» returnCode	string	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Custom Fields

Allows you to retrieve the defined custom field definitions. A custom field definition can be a member of a custom field set.

Get Custom Field Definition Details

GET /customfields/{customFieldId}

Get details on a custom field definition

Allows retrieving of a custom field definition based on id/key. The custom field definition can be fetched only based on id/key.

Parameters

Name	Type	Description	In
customFieldId (required)	string	none	path

Example Responses

200 : ok
Response containing the custom field definition with ID JOB_TITLE

{
  "encodedKey": "8a54e5b44449337f01444a6db5d40006",
  "id": "JOB_TITLE",
  "name": "Current Job Title",
  "type": "CLIENT_INFO",
  "dataType": "STRING",
  "valueLength": "LONG",
  "isDefault": true,
  "isRequired": true,
  "description": "The current job title for the client.",
  "indexInList": 8,
  "state": "NORMAL"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	CustomFieldApiV1

Database Backups

Allows API users to trigger Mambu database backups and download them once they are ready.

Execution flow example:

Use POST call to request the database backup to be generated and register/define the callback endpoint.
- This call triggers the database copy creation, which is a prerequisite to download a backup.
- The callback parameter is not required but recommended.
If a callback parameter is defined, a callback will be sent to the endpoint, confirming that step 1 has been completed and that the database backup can be downloaded.
- The response to this callback should be OK (200).
- The endpoint is useful to ensure that the creation process has finished and step 3 can be performed.
Use a GET call to request the download of the database backup.
- If an endpoint is defined, it can be triggered immediately after the callback (step 2) is received.
- If there is no endpoint defined, please wait several minutes, up to one hour (depending on the size of your database), to allow Mambu some time to finish the creation of the database from step 1.

Required permissions:

Download Backups for triggering and downloading a database backup

Initiate Database Backup

POST /database/backup

Initiate database backup

Example callback payload

{
    "tenantId":"demo",
    "result":"COMPLETE",
    "domain":"demo.mambu.com",
    "fileName":"demo-MANUAL-DATABASE-BACKUP"
}

Allow the trigger of database backups. The developer can be notified via a callback defined in the POST call when the backup is ready. You can provide the callback either in the JSON body or as a query parameter. After the database backup process is completed, the a payload will be sent to the callback url provided as in the example provided.

Required permission: Download Backups for triggering and downloading a database backup

Please Note:

While a backup is in progress, Mambu will not allow starting another one. If you need to create backups after Mambu's nightly processing, you can setup the "End of Day Processing" / "Accounts Updated" WebHook in Mambu to get notified and then trigger the backup request with this API.

Example requests

Example request using query parameter

https://TENANT_NAME.mambu.com/api/database/backup?callback=https%3A%2F%2Fmy-callback-service.com%2Fsource%3Dmambu%26whatis%3Ddatabse-backup

Example JSON Body with callback

{
  "callback": "https://path.to/myserver?callback.php"
}

Parameters

Name	Type	Description	In
callback	string	URL encoded callback	query
callback	string(uri)	A valid URL. It will receive a WebHook call from Mambu once the backup is available (Optional).	body

Example Responses

200 : OK
Success reponse

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	the code of the response	none
» returnStatus	string	a machine readable explanation of the response	none
» errorSource	string	a human readable description of the response	none

Get Latest Database Backup

GET /database/backup/LATEST

Download latest backup

Download the latest database backup that was triggered via the POST call.

The response headers will contain more information about the backup:

Content-Type: application/zip
Content-Disposition: attachment; filename="demo_tenantMANUALDATABASEBACKUP.zip"
LastModified: the date when the database backup execution finished

Required permission: Download Backups for triggering and downloading a database backup.

Example Responses

400 : No current backup
No current backup

400 Response

{}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	None
`400`	Bad Request	No current backup	Inline

Response Schema

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	the code of the response	none
» returnStatus	string	a machine readable explanation of the response	none
» errorSource	string	a human readable description of the response	none

Response Headers

Status	Header	Type	Description
200	`Content-Disposition`	string	the file name and encoding of the file to be downloaded
200	`Content-Type`	string	the file type of the file to be downloaded
200	`Last Modified`	string	the date when the database backup execution finished

Documents

Allows you to get, post or delete attachments. This endpoint accepts files up to a maximum size of 50MB.

Attach new Document

POST /documents

Add attachment to entity

Allows for adding attachments of up to 50MB to a client or account. The request should include a JSON body containing metadata about the data being pushed, including the documentHolderType (e.g. CLIENT) and documentHolderKey as well as the base64 encoded document content.

Example requests

A user photo

{
  "document": {
    "documentHolderKey": "40288a0c3e3cfb4e013e3d00bbzxcvs",
    "documentHolderType": "USER",
    "name": "john_photo",
    "type": "jpg"
  },
  "documentContent": "[base64encodedString]"
}

Parameters

Name	Type	Description	In
body	CreateDocumentApiV1	a new document	body

Example Responses

200 : OK
Details on an uploaded attachment

{
  "encodedKey": "8aa0f78f444f763601444f7fb89e0001",
  "id": 1,
  "creationDate": "2014-02-20T13:32:54+0000",
  "lastModifiedDate": "2014-02-20T13:32:54+0000",
  "documentHolderKey": "8a33ae49441c4fe101441c7149cb00fe",
  "documentHolderType": "CLIENT",
  "name": "document",
  "type": "doc",
  "fileSize": 14,
  "originalFilename": "document",
  "location": "8aa0f78f444f763601444f7fb89e0001",
  "createdByUserKey": "8a33ae49441c4fe101441c5fe42f0005"
}

400 : Bad Request
Wrong content type specified

{
  "returnCode": 973,
  "returnStatus": "INCONSISTENT_EXTENSION_WITH_FILE_CONTENT",
  "errorSource": "Invalid extension with file content"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	DocumentApiV1
`400`	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Description	Restrictions
» returnCode	string	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Get Documents

GET /documents

Get documents

Allows retrieving a list of documents descriptions based on the owner id/key or type. Documents will be returned as with base64 encoded string. The list of document descriptions can be paginated.

Parameters

Name	Type	Description	In
ownerType (required)	string	The type of entity holding the documents	query
ownerId (required)	string	The ID or encoded key of the entity	query

Enumerated Values

Parameter	Value
ownerType	`CLIENT`
ownerType	`GROUP`
ownerType	`LOAN_ACCOUNT`
ownerType	`SAVINGS_ACCOUNT`
ownerType	`LOAN_PRODUCT`
ownerType	`SAVINGS_PRODUCT`
ownerType	`USER`
ownerType	`CENTRE`
ownerType	`BRANCH`

Example Responses

200 : OK
An array of documents for a loan account

[
  {
    "encodedKey": "8a19c035747bf5b901747d09c578035e",
    "id": 57,
    "creationDate": "2020-09-11T12:30:13+0000",
    "lastModifiedDate": "2020-09-11T12:30:13+0000",
    "documentHolderKey": "8a19b6e4746cc6ed01746cf1436c00c5",
    "documentHolderType": "LOAN_ACCOUNT",
    "name": "texx",
    "type": "txt",
    "fileSize": 14,
    "originalFilename": "test.txt",
    "location": "OZAYCTQRLNPDSDWKMPARVPHLFYHVFO",
    "description": "a text file",
    "createdByUserKey": "8a194075720ece2c017226fced6f005e",
    "userName": "Happy Go Lucky",
    "documentHolder": {
      "type": "LOAN",
      "holderKey": "8a193c26722b51b701722d77c5e423b7",
      "accountHolderType": "CLIENT",
      "encodedKey": "8a19b6e4746cc6ed01746cf1436c00c5",
      "displayName": "BLBE564"
    }
  },
  {
    "encodedKey": "8a19c035747bf5b901747c77d78e01c6",
    "id": 54,
    "creationDate": "2020-09-11T11:51:22+0000",
    "lastModifiedDate": "2020-09-11T11:51:22+0000",
    "documentHolderKey": "8a19b6e4746cc6ed01746cf1436c00c5",
    "documentHolderType": "LOAN_ACCOUNT",
    "name": "some other image",
    "type": "png",
    "fileSize": 32109,
    "originalFilename": "some_other_image.png",
    "location": "NCYBXXEJCZBQVHAEAJTPITEGUBVXRO",
    "description": "this is another image file",
    "createdByUserKey": "8a194075720ece2c017226fced6f005e",
    "userName": "Holly Go Lightly",
    "documentHolder": {
      "type": "LOAN",
      "holderKey": "8a193c26722b51b701722d77c5e423b7",
      "accountHolderType": "CLIENT",
      "encodedKey": "8a19b6e4746cc6ed01746cf1436c00c5",
      "displayName": "BLBE564"
    }
  },
  {
    "encodedKey": "8a19c035747bf5b901747c77d78e01c4",
    "id": 53,
    "creationDate": "2020-09-11T11:39:33+0000",
    "lastModifiedDate": "2020-09-11T11:39:33+0000",
    "documentHolderKey": "8a19b6e4746cc6ed01746cf1436c00c5",
    "documentHolderType": "LOAN_ACCOUNT",
    "name": "file for loan account",
    "type": "png",
    "fileSize": 8258,
    "originalFilename": "Screenshot_2020-04-22_at_14.31.29.png",
    "location": "FCLRPXHUTCXURCALXAIFESFUURNUBR",
    "description": "a file attached to a loan account",
    "createdByUserKey": "8a194075720ece2c017226fced6f005e",
    "userName": "Go Go Gadget",
    "documentHolder": {
      "type": "LOAN",
      "holderKey": "8a193c26722b51b701722d77c5e423b7",
      "accountHolderType": "CLIENT",
      "encodedKey": "8a19b6e4746cc6ed01746cf1436c00c5",
      "displayName": "BLBE564"
    }
  },
  {
    "encodedKey": "8a19a3337476f2d00174775b6a3001b0",
    "id": 44,
    "creationDate": "2020-09-10T09:34:51+0000",
    "lastModifiedDate": "2020-09-10T09:34:51+0000",
    "documentHolderKey": "8a19b6e4746cc6ed01746cf1436c00c5",
    "documentHolderType": "LOAN_ACCOUNT",
    "name": "loan acc doc",
    "type": "png",
    "fileSize": 15028,
    "originalFilename": "additional_reading_callout.png",
    "location": "UTOLWAEQURRYFNBIPNUXXFEXBCPKQR",
    "description": "desc loan acc doc",
    "createdByUserKey": "8a194075720ece2c017226fced6f005e",
    "userName": "Train Go Choo Choo",
    "documentHolder": {
      "type": "LOAN",
      "holderKey": "8a193c26722b51b701722d77c5e423b7",
      "accountHolderType": "CLIENT",
      "encodedKey": "8a19b6e4746cc6ed01746cf1436c00c5",
      "displayName": "BLBE564"
    }
  }
]

400 : Bad Request
bad ID

{
  "returnCode": 4,
  "returnStatus": "INVALID_PARAMETERS",
  "errorSource": "wrong owner id"
}

500 : Internal Server Error
bad value for ownerType parameter

{
  "returnCode": 6,
  "returnStatus": "INTERNAL_ERROR"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	DocumentForAccountApiV1
`400`	Bad Request	Bad Request	ExecutionStatusApiV1
`500`	Internal Server Error	Internal Server Error	ExecutionStatusApiV1

Get Document by ID

GET /documents/{documentId}

Get Document by ID

Allows retrieving the content of a document encoded with base64 based on the document id/key.

Parameters

Name	Type	Description	In
documentId (required)	string	The ID (encoded key) of the document	path

Example Responses

200 : OK
Example base64-encoded document

"dGhhbmtzIGZvciBjaGVja2luZywgd2UncmUgYWxsIGZpbmUgaGVyZQ"

400 : Bad Request
Bad Document ID

{
  "returnCode": 970,
  "returnStatus": "INVALID_DOCUMENT_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	string
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Delete Document

DELETE /documents/{documentId}

Delete a Document

Allows the deletion of attachments based on id/encoded key.

Parameters

Name	Type	Description	In
documentId (required)	string	The ID (encoded key) of the document	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

403 : Forbidden
Account lacks required permissions

{
  "returnCode": 2,
  "returnStatus": "INVALID_CREDENTIALS"
}

404 : Not Found
Bad Document ID

{
  "returnCode": 970,
  "returnStatus": "INVALID_DOCUMENT_ID"
}

503 : Service Unavailable
Account is blocked

{
  "returnCode": 24,
  "returnStatus": "EXCESSIVE_INVALID_REQUESTS"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	ExecutionStatusApiV1
`403`	Forbidden	Forbidden	ExecutionStatusApiV1
`404`	Not Found	Not Found	ExecutionStatusApiV1
`503`	Service Unavailable	Service Unavailable	ExecutionStatusApiV1

General Ledger Accounts

Allows you to retrieve GL (General Ledger) accounts by type or specific GL accounts along with their balance. Balance for the GL accounts can be taken from the current moment or from a date range.

Get all GL Accounts

GET /glaccounts

Get All GL Accounts

Retrieve a list of GL accounts.

Parameters

Name	Type	Description	In
type (required)	string	The type of GL accounts to retrieve. Required if no account id is provided.	query
from	string	From (start) date to compute the account balance on.	query
to	string	To (end) date to compute the account balance on.	query
branchID	string	The branch ID on which to calculate/filter the gl accounts balances.	query

Enumerated Values

Parameter	Value
type	`ASSET`
type	`LIABILITY`
type	`EQUITY`
type	`INCOME`
type	`EXPENSE`

Example Responses

200 : OK
An array of GL Accounts

[
  {
    "encodedKey": "8a193c26722b51b701722d77cd9e26c0",
    "creationDate": "2020-05-19T15:05:26+0000",
    "lastModifiedDate": "2020-05-19T15:05:26+0000",
    "glCode": "11100",
    "type": "ASSET",
    "usage": "DETAIL",
    "name": "Cash on Hand",
    "activated": true,
    "allowManualJournalEntries": true,
    "stripTrailingZeros": true,
    "currency": {
      "code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "digitsAfterDecimal": 2,
      "currencySymbolPosition": "BEFORE_NUMBER",
      "isBaseCurrency": true,
      "creationDate": "2020-05-18T08:53:31+0000",
      "lastModifiedDate": "2020-05-18T08:53:31+0000"
    },
    "balance": "39147.84"
  },
  {
    "encodedKey": "8a193c26722b51b701722d77cdc826d6",
    "creationDate": "2020-05-19T15:05:26+0000",
    "lastModifiedDate": "2020-05-19T15:05:26+0000",
    "glCode": "11400",
    "type": "ASSET",
    "usage": "DETAIL",
    "name": "Client Savings Bank Account",
    "activated": true,
    "allowManualJournalEntries": true,
    "stripTrailingZeros": true,
    "currency": {
      "code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "digitsAfterDecimal": 2,
      "currencySymbolPosition": "BEFORE_NUMBER",
      "isBaseCurrency": true,
      "creationDate": "2020-05-18T08:53:31+0000",
      "lastModifiedDate": "2020-05-18T08:53:31+0000"
    },
    "balance": "4253.21"
  },
  {
    "encodedKey": "8a193c26722b51b701722d77cdb126ca",
    "creationDate": "2020-05-19T15:05:26+0000",
    "lastModifiedDate": "2020-05-19T15:05:26+0000",
    "glCode": "11700",
    "type": "ASSET",
    "usage": "DETAIL",
    "name": "Interest Receivable",
    "activated": true,
    "allowManualJournalEntries": true,
    "stripTrailingZeros": true,
    "currency": {
      "code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "digitsAfterDecimal": 2,
      "currencySymbolPosition": "BEFORE_NUMBER",
      "isBaseCurrency": true,
      "creationDate": "2020-05-18T08:53:31+0000",
      "lastModifiedDate": "2020-05-18T08:53:31+0000"
    },
    "balance": "1305.32"
  }
]

400 : Bad Request
bad account ID

{
  "returnCode": 601,
  "returnStatus": "INVALID_GL_ACCOUNT_TYPE"
}

400 : Bad Request
bad dates

{
  "returnCode": 610,
  "returnStatus": "INVALID_ACCOUNTING_DATE_ORDER",
  "errorSource": "The from date is set after the to date"
}

400 : Bad Request
branch not found

{
  "returnCode": 800,
  "returnStatus": "INVALID_BRANCH_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[GLAccountApiV1]	[A general ledger account]	none
» activated	boolean	whether this general ledger account is in use	none
» allowManualJournalEntries	boolean	whether manual entries are allowed for this general ledger account	none
» balance	number	the current balance of this general ledger account	none
» creationDate	string(date-time)	the date on which this general ledger account was created	read-only
» currency	CurrencyApiV1	none	none
»» code	string	the three letter ISO code for this currency	none
»» creationDate	string	the date on which this currency was created	none
»» currencySymbolPosition	string	indicates where the currency symbol should appear in relation to the numeric value	none
»» digitsAfterDecimal	number	indicates how many decimal places are allowed for this currency. For example, a currenncy with 100 minor units to 1 major unit, there will be 2 decimal places.	none
»» isBaseCurrency	boolean	whether this currency is the base currency for your banking institution	none
»» lastModifiedDate	string	the date on which this currency was last modified	none
»» name	string	the name of this currency	none
»» symbol	string	the currency symnbol used for this currency	none
» description	string	an optional description for this general ledger account	none
» encodedKey	string	the encoded key of this general ledger account	none
» glCode	string	the numeric code for this general ledger account	none
» lastModifiedDate	string(date-time)	the date on which this general ledger account was last modified	read-only
» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
»» creationDate	string(date-time)	the date on which the data import was made	none
»» encodedKey	string	the encoded key of this data migration event	none
»» numCentresImported	number	the number of centres which were imported during the data migration	none
»» numClientsImported	number	the number of clients which were imported as part of the data migration	none
»» numGLAccountsImported	number	the number of general ledger accounts which were imported as part of the data migration	none
»» numGroupsImported	number	the number of groups which were imported as part of the data migration	none
»» numLoanRepaymentsImported	number	the number of loan repayment transations which were imported as part of the data migration	none
»» numLoanTransactionsImported	number	the number of loan transactions which were imported as part of the data migration	none
»» numLoansImported	number	the number of loan accounts which were imported as part of the data migration	none
»» numSavingsImported	number	the number of savings accounts which were imported as part of the data migration	none
»» state	string	whether the data import was accepted, is still in a draft state, or was rejected and all data reverted	none
»» type	string	the type of migration event	none
» name	string	the name of this general ledger account	none
» stripTrailingZeros	boolean	controls how this account is organized into header accounts when there are trailing zeroes, for example, for the account code `1100`, if this field is set to true, only the first two numbers will be recognised	none
» type	string	the type of general ledger account	none
» usage	string	whether this general ledger account is a `DETAIL` account, in which case it will have a value, or a `HEADER` account, in which case its value will be calculated based on the sum of detail accounts under it.	none

Enumerated Values

Property	Value
currencySymbolPosition	`AFTER_NUMBER`
currencySymbolPosition	`BEFORE_NUMBER`
state	`REVERTED`
state	`DRAFT`
state	`APPROVED`
type	`IMPORT`
type	`EXPORT`
type	`INCOME`
type	`EXPENSE`
type	`LIABILITY`
type	`ASSET`
type	`EQUITY`
usage	`HEADER`
usage	`DETAIL`

Status Code 400

Name	Type	Description	Restrictions
» returnCode	string	none	none
» returnStatus	string	none	none

Get GL Account by ID

GET /glaccounts/{glAccountId}

Get single GL Account

Retrieve details on a specific General Ledger Account.

Parameters

Name	Type	Description	In
from	string	From (start) date to compute the account balance on.	query
to	string	To (end) date to compute the account balance on.	query
branchID	string	The branch ID on which to calculate/filter the gl accounts balances.	query
glAccountId (required)	string	The ID of the GL account.	path

Example Responses

200 : OK
example-1

{
  "encodedKey": "8a193c26722b51b701722d77cd9e26c0",
  "creationDate": "2020-05-19T15:05:26+0000",
  "lastModifiedDate": "2020-05-19T15:05:26+0000",
  "glCode": "11100",
  "type": "ASSET",
  "usage": "DETAIL",
  "name": "Cash on Hand",
  "activated": true,
  "allowManualJournalEntries": true,
  "stripTrailingZeros": true,
  "currency": {
    "code": "EUR",
    "name": "Euro",
    "symbol": "€",
    "digitsAfterDecimal": 2,
    "currencySymbolPosition": "BEFORE_NUMBER",
    "isBaseCurrency": true,
    "creationDate": "2020-05-18T08:53:31+0000",
    "lastModifiedDate": "2020-05-18T08:53:31+0000"
  },
  "balance": "-1685.55"
}

400 : Bad Request
bad GL Account ID

{
  "returnCode": 600,
  "returnStatus": "INVALID_GL_ACCOUNT_ID"
}

400 : Bad Request
bad dates

{
  "returnCode": 610,
  "returnStatus": "INVALID_ACCOUNTING_DATE_ORDER",
  "errorSource": "The from date is set after the to date"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	GLAccountApiV1
`400`	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Description	Restrictions
» returnCode	string	none	none
» returnStatus	string	none	none

Get GL Journal Entries for a GL Account

GET /glaccounts/{glAccountId}/gljournalentries

Get GL Journal Entries for a GL Account

Get GL Journal Entries for a given GL Account.

Parameters

Name	Type	Description	In
from (required)	string	Start date - The first booking date you want to retrieve journal entries from.	query
to (required)	string	End date - The last booking date you want to retrieve journal entries from.	query
glAccountId (required)	string	The ID of the GL account.	path

Example Responses

200 : OK
An array of journal entries

[
  {
    "encodedKey": "8a19a207744d899f01744e8893a50800",
    "entryID": 95,
    "creationDate": "2020-09-02T11:50:10+0000",
    "entryDate": "2020-08-10T00:00:00+0000",
    "transactionID": "21",
    "accountKey": "8a19c32b72eac4420172efcb0f176bbd",
    "productKey": "8a193c26722b51b701722d77ca932614",
    "productType": "LOAN",
    "amount": "200",
    "glAccount": {
      "encodedKey": "8a193c26722b51b701722d77cd9e26c0",
      "creationDate": "2020-05-19T15:05:26+0000",
      "lastModifiedDate": "2020-05-19T15:05:26+0000",
      "glCode": "11100",
      "type": "ASSET",
      "usage": "DETAIL",
      "name": "Cash on Hand",
      "activated": true,
      "allowManualJournalEntries": true,
      "stripTrailingZeros": true
    },
    "type": "DEBIT",
    "userKey": "8a194075720ece2c017226fced6f005e",
    "bookingDate": "2020-08-10T00:00:00+0000"
  },
  {
    "encodedKey": "8a19a207744d899f01744e83027507f6",
    "entryID": 92,
    "creationDate": "2020-09-02T11:16:48+0000",
    "entryDate": "2020-06-15T00:00:00+0000",
    "transactionID": "20",
    "accountKey": "8a19c32b72eac4420172efcb0f176bbd",
    "productKey": "8a193c26722b51b701722d77ca932614",
    "productType": "LOAN",
    "amount": "100",
    "glAccount": {
      "encodedKey": "8a193c26722b51b701722d77cd9e26c0",
      "creationDate": "2020-05-19T15:05:26+0000",
      "lastModifiedDate": "2020-05-19T15:05:26+0000",
      "glCode": "11100",
      "type": "ASSET",
      "usage": "DETAIL",
      "name": "Cash on Hand",
      "activated": true,
      "allowManualJournalEntries": true,
      "stripTrailingZeros": true
    },
    "type": "DEBIT",
    "userKey": "8a194075720ece2c017226fced6f005e",
    "bookingDate": "2020-06-15T00:00:00+0000"
  }
]

400 : Bad Request
Bad GL Account ID

{
  "returnCode": 600,
  "returnStatus": "INVALID_GL_ACCOUNT_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[GLJournalEntryApiV1]	none	none
» accountKey	string	the encoded key of the loan or savings account that this journal entry relates to	none
» amount	number	the amount of the journal entry	none
» assignedBranchKey	string	the encoded key of the branch that this journal entry is associated with	none
» bookingDate	string	the booking date of this journal entry	none
» creationDate	string	the date and time when the transaction that caused this journal entry was created	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» entryDate	string	the date on which this journal entry was entered into the ledger	none
» entryID	number	a unique, incremental ID for ledger entries	none
» glAccount	GLAccountApiV1	A general ledger account	none
»» activated	boolean	whether this general ledger account is in use	none
»» allowManualJournalEntries	boolean	whether manual entries are allowed for this general ledger account	none
»» balance	number	the current balance of this general ledger account	none
»» creationDate	string(date-time)	the date on which this general ledger account was created	read-only
»» currency	CurrencyApiV1	none	none
»»» code	string	the three letter ISO code for this currency	none
»»» creationDate	string	the date on which this currency was created	none
»»» currencySymbolPosition	string	indicates where the currency symbol should appear in relation to the numeric value	none
»»» digitsAfterDecimal	number	indicates how many decimal places are allowed for this currency. For example, a currenncy with 100 minor units to 1 major unit, there will be 2 decimal places.	none
»»» isBaseCurrency	boolean	whether this currency is the base currency for your banking institution	none
»»» lastModifiedDate	string	the date on which this currency was last modified	none
»»» name	string	the name of this currency	none
»»» symbol	string	the currency symnbol used for this currency	none
»» description	string	an optional description for this general ledger account	none
»» encodedKey	string	the encoded key of this general ledger account	none
»» glCode	string	the numeric code for this general ledger account	none
»» lastModifiedDate	string(date-time)	the date on which this general ledger account was last modified	read-only
»» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
»»» creationDate	string(date-time)	the date on which the data import was made	none
»»» encodedKey	string	the encoded key of this data migration event	none
»»» numCentresImported	number	the number of centres which were imported during the data migration	none
»»» numClientsImported	number	the number of clients which were imported as part of the data migration	none
»»» numGLAccountsImported	number	the number of general ledger accounts which were imported as part of the data migration	none
»»» numGroupsImported	number	the number of groups which were imported as part of the data migration	none
»»» numLoanRepaymentsImported	number	the number of loan repayment transations which were imported as part of the data migration	none
»»» numLoanTransactionsImported	number	the number of loan transactions which were imported as part of the data migration	none
»»» numLoansImported	number	the number of loan accounts which were imported as part of the data migration	none
»»» numSavingsImported	number	the number of savings accounts which were imported as part of the data migration	none
»»» state	string	whether the data import was accepted, is still in a draft state, or was rejected and all data reverted	none
»»» type	string	the type of migration event	none
»» name	string	the name of this general ledger account	none
»» stripTrailingZeros	boolean	controls how this account is organized into header accounts when there are trailing zeroes, for example, for the account code `1100`, if this field is set to true, only the first two numbers will be recognised	none
»» type	string	the type of general ledger account	none
»» usage	string	whether this general ledger account is a `DETAIL` account, in which case it will have a value, or a `HEADER` account, in which case its value will be calculated based on the sum of detail accounts under it.	none
» notes	string	any notes relating to this journal entry	none
» productKey	string	the product associated with this journal entry	none
» productType	string	the type of product associated with this journal entry	none
» reversalEntryKey	string	if this entry was subsequently revered by another journal entry, this field contains the encoded key of that journal entry	none
» transactionID	string	the transaction ID that caused this journal entry. Please note, multiple journal entries can have the same transaction ID, for example, when a repayment goes to cover fees, princial, taxes etc.	none
» type	string	whether this journal entry represents funds coming in or going out	none
» userKey	string	the encoded key of the user who created this journal entry, if it was created manually	none

Enumerated Values

Property	Value
currencySymbolPosition	`AFTER_NUMBER`
currencySymbolPosition	`BEFORE_NUMBER`
state	`REVERTED`
state	`DRAFT`
state	`APPROVED`
type	`IMPORT`
type	`EXPORT`
type	`INCOME`
type	`EXPENSE`
type	`LIABILITY`
type	`ASSET`
type	`EQUITY`
usage	`HEADER`
usage	`DETAIL`
productType	`LOAN`
productType	`SAVINGS`
type	`CREDIT`
type	`DEBIT`

Status Code 400

Name	Type	Description	Restrictions
» returnCode	string	none	none
» returnStatus	string	none	none

Group Role Names

Get group role names configured for your organization.

Get Group Role Names

GET /grouprolenames

Get Group Role Names

Get group role names

Example Responses

200 : OK
A list of group roles

[
  {
    "encodedKey": "8a193c26722b51b701722d77c25e22e6",
    "name": "President"
  },
  {
    "encodedKey": "8a193c26722b51b701722d77c3c922e7",
    "name": "Secretary"
  },
  {
    "encodedKey": "8a193c26722b51b701722d77c3c922e8",
    "name": "Treasurer"
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» encodedKey	string	A unique key for this role.	none
» name	string	The name of this group role.	none

Groups

Allows you to retrieve groups. Groups may have associated information such as their custom field values. The custom field values for groups can be changed using patch or delete methods.

Get all Groups

GET /groups

List Groups

Allows retrieving group directly by a group ID or by looking up a client. When retrieving a group, all his associated information such as their custom field values and addresses may also be returned if requested. An empty list is returned if no groups are found.

Example Requests

Get all groups assigned to the branch with id DB

GET /api/groups/?branchId=DB

Get all groups assigned to the centre with id DB and provide full details

GET /api/groups/?centreId=DC&fullDetails=true

Parameters

Name	Type	Description	In
centreID	string	Looking up a group assigned to a centre using branch ID/key	query
branchID	string	Looking up a group assigned to a branch using branch ID/key.	query
offset	integer	Start at index for pagination.	query
limit	integer	Max results to return.	query
creditOfficerUsername	string	Looking up by the username of a specific credit officer, required if the user making the call has the "Credit Officer" role and the option "Can access other credit officers clients" is not activated.	query
fullDetails	boolean	Whether to load all the nested fields for the groups as well.	query

Example Responses

200 : ok
Array of groups and their basic details

[
  {
    "encodedKey": "8a193c26722b51b701722d77c969260e",
    "id": "237716573",
    "creationDate": "2020-05-19T15:05:25+0000",
    "lastModifiedDate": "2020-09-07T16:22:43+0000",
    "groupName": "Portanica",
    "loanCycle": 0,
    "preferredLanguage": "SPANISH",
    "clientRole": {
      "encodedKey": "8a194075720ece2c017226fcf7130069"
    }
  },
  {
    "encodedKey": "8a193c26722b51b701722d77ca932611",
    "id": "040693245",
    "creationDate": "2020-05-19T15:05:25+0000",
    "lastModifiedDate": "2020-05-19T15:05:25+0000",
    "groupName": "Apache",
    "loanCycle": 0,
    "preferredLanguage": "ENGLISH",
    "clientRole": {
      "encodedKey": "8a194075720ece2c017226fcf7130069"
    }
  }
]

200 : ok
array of groups, full details

[
  {
    "theGroup": {
      "encodedKey": "8a193c26722b51b701722d77c969260e",
      "id": "237716573",
      "creationDate": "2020-05-19T15:05:25+0000",
      "lastModifiedDate": "2020-09-07T16:22:43+0000",
      "groupName": "Portanica",
      "loanCycle": 0,
      "preferredLanguage": "SPANISH",
      "clientRole": {
        "encodedKey": "8a194075720ece2c017226fcf7130069"
      }
    },
    "addresses": [],
    "customInformation": [],
    "groupRoles": [
      {
        "encodedKey": "8a19b592746765a501746960758307e0",
        "groupKey": "8a193c26722b51b701722d77c969260e",
        "groupRoleNameKey": "8a193c26722b51b701722d77c3c922e7",
        "clientKey": "8a193c26722b51b701722d77c67d23d6",
        "roleName": "Secretary",
        "indexInList": 0
      }
    ],
    "groupMembers": [
      {
        "encodedKey": "8a19b592746765a501746960758307df",
        "groupKey": "8a193c26722b51b701722d77c969260e",
        "clientKey": "8a193c26722b51b701722d77c67d23d6",
        "creationDate": "2020-09-07T16:22:43+0000",
        "indexInList": 0
      }
    ]
  },
  {
    "theGroup": {
      "encodedKey": "8a193c26722b51b701722d77ca932611",
      "id": "040693245",
      "creationDate": "2020-05-19T15:05:25+0000",
      "lastModifiedDate": "2020-09-24T10:25:39+0000",
      "groupName": "Apache",
      "notes": "some <i>rich</i> notes about this <b>amazing</b> <u>group</u>",
      "assignedUserKey": "8a19dab474909bc8017490f2fb9006a8",
      "assignedBranchKey": "8a193c26722b51b701722d779e7122de",
      "loanCycle": 0,
      "assignedCentreKey": "8a193c26722b51b701722d779e7122e0",
      "emailAddress": "apachegroup@yougotma.il",
      "mobilePhone1": "+35131429818014",
      "homePhone": "+350305551155",
      "preferredLanguage": "ENGLISH",
      "clientRole": {
        "encodedKey": "8a194075720ece2c017226fcf7130069"
      }
    },
    "addresses": [
      {
        "encodedKey": "8a19a3cc74beb0eb0174bf3f6fe80312",
        "parentKey": "8a193c26722b51b701722d77ca932611",
        "line1": "5a Group Lane",
        "line2": "",
        "city": "Big Smoke",
        "region": "Big Sky County",
        "postcode": "126 GV4",
        "country": "Countrystan",
        "indexInList": 0
      }
    ],
    "customInformation": [
      {
        "encodedKey": "8a19a3cc74beb0eb0174bf3f6fe80313",
        "parentKey": "8a193c26722b51b701722d77ca932611",
        "customFieldKey": "8a193c26722b51b701722d77cd292664",
        "customField": {
          "encodedKey": "8a193c26722b51b701722d77cd292664",
          "id": "Central_Office_Groups",
          "name": "Central Office",
          "type": "GROUP_INFO",
          "dataType": "SELECTION",
          "valueLength": "SHORT",
          "isDefault": false,
          "isRequired": false,
          "customFieldSet": {
            "encodedKey": "8a193c26722b51b701722d77ccaf2638",
            "id": "_Office_Groups",
            "name": "Office",
            "createdDate": "2020-05-19T15:05:25+0000",
            "lastModifiedDate": "2020-05-19T15:05:25+0000",
            "indexInList": 0,
            "type": "GROUP_INFO",
            "usage": "SINGLE"
          },
          "indexInList": -1,
          "state": "NORMAL",
          "customFieldSelectionOptions": [
            {
              "encodedKey": "8a193c26722b51b701722d77cd2d2668",
              "id": "620330172",
              "value": "Catamarca",
              "score": "0"
            },
            {
              "encodedKey": "8a193c26722b51b701722d77cd2d2669",
              "id": "433019118",
              "value": "Chaco",
              "score": "1"
            },
            {
              "encodedKey": "8a193c26722b51b701722d77cd2d266a",
              "id": "077431565",
              "value": "Jujuy",
              "score": "10"
            }
          ],
          "viewRights": {
            "encodedKey": "8a193c26722b51b701722d77cd292665",
            "isAccessibleByAllUsers": true,
            "roles": []
          },
          "editRights": {
            "encodedKey": "8a193c26722b51b701722d77cd2d2666",
            "isAccessibleByAllUsers": true,
            "roles": []
          },
          "unique": false,
          "values": [
            "Catamarca",
            "Chaco",
            "Jujuy"
          ],
          "amounts": {
            "Catamarca": "0",
            "Chaco": "1",
            "Jujuy": "10"
          }
        },
        "value": "Chaco",
        "amount": "1",
        "indexInList": 0,
        "customFieldID": "Central_Office_Groups",
        "customFieldSetGroupIndex": -1
      },
      {
        "encodedKey": "8a19a3cc74beb0eb0174bf3f6fe80314",
        "parentKey": "8a193c26722b51b701722d77ca932611",
        "customFieldKey": "8a193c26722b51b701722d77cd32266f",
        "customField": {
          "encodedKey": "8a193c26722b51b701722d77cd32266f",
          "id": "Has_Many_Members_Groups",
          "name": "Has Many Members",
          "type": "GROUP_INFO",
          "dataType": "CHECKBOX",
          "valueLength": "SHORT",
          "isDefault": false,
          "isRequired": false,
          "customFieldSet": {
            "encodedKey": "8a193c26722b51b701722d77ccd72639",
            "id": "_Members_Groups",
            "name": "Members",
            "createdDate": "2020-05-19T15:05:25+0000",
            "lastModifiedDate": "2020-05-19T15:05:25+0000",
            "indexInList": 1,
            "type": "GROUP_INFO",
            "usage": "SINGLE"
          },
          "indexInList": -1,
          "state": "NORMAL",
          "customFieldSelectionOptions": [],
          "viewRights": {
            "encodedKey": "8a193c26722b51b701722d77cd3a2670",
            "isAccessibleByAllUsers": true,
            "roles": []
          },
          "editRights": {
            "encodedKey": "8a193c26722b51b701722d77cd3a2671",
            "isAccessibleByAllUsers": true,
            "roles": []
          },
          "unique": false,
          "values": [],
          "amounts": {}
        },
        "value": "TRUE",
        "indexInList": 1,
        "customFieldID": "Has_Many_Members_Groups",
        "customFieldSetGroupIndex": -1
      },
      {
        "encodedKey": "8a19a3cc74beb0eb0174bf3f6fe80315",
        "parentKey": "8a193c26722b51b701722d77ca932611",
        "customFieldKey": "8a193c26722b51b701722d77cd32266b",
        "customField": {
          "encodedKey": "8a193c26722b51b701722d77cd32266b",
          "id": "Group_Members_Groups",
          "name": "Group Members",
          "type": "GROUP_INFO",
          "dataType": "NUMBER",
          "valueLength": "SHORT",
          "isDefault": false,
          "isRequired": false,
          "customFieldSet": {
            "encodedKey": "8a193c26722b51b701722d77ccd72639",
            "id": "_Members_Groups",
            "name": "Members",
            "createdDate": "2020-05-19T15:05:25+0000",
            "lastModifiedDate": "2020-05-19T15:05:25+0000",
            "indexInList": 1,
            "type": "GROUP_INFO",
            "usage": "SINGLE"
          },
          "indexInList": -1,
          "state": "NORMAL",
          "customFieldSelectionOptions": [],
          "viewRights": {
            "encodedKey": "8a193c26722b51b701722d77cd32266c",
            "isAccessibleByAllUsers": true,
            "roles": []
          },
          "editRights": {
            "encodedKey": "8a193c26722b51b701722d77cd32266d",
            "isAccessibleByAllUsers": true,
            "roles": []
          },
          "unique": false,
          "values": [],
          "amounts": {}
        },
        "value": "17",
        "indexInList": 2,
        "customFieldID": "Group_Members_Groups",
        "customFieldSetGroupIndex": -1
      }
    ],
    "groupRoles": [
      {
        "encodedKey": "8a19a3cc74beb0eb0174bfa492ae04d3",
        "groupKey": "8a193c26722b51b701722d77ca932611",
        "groupRoleNameKey": "8a193c26722b51b701722d77c25e22e6",
        "clientKey": "8a193c26722b51b701722d77c66d23b9",
        "roleName": "President",
        "indexInList": 0
      },
      {
        "encodedKey": "8a19a3cc74beb0eb0174bfa492ae04d4",
        "groupKey": "8a193c26722b51b701722d77ca932611",
        "groupRoleNameKey": "8a193c26722b51b701722d77c3c922e7",
        "clientKey": "8a193c26722b51b701722d77c66d23bc",
        "roleName": "Secretary",
        "indexInList": 1
      }
    ],
    "groupMembers": [
      {
        "encodedKey": "8a193c26722b51b701722d77ca932612",
        "groupKey": "8a193c26722b51b701722d77ca932611",
        "clientKey": "8a193c26722b51b701722d77c66d23b9",
        "creationDate": "2020-05-19T15:05:25+0000",
        "indexInList": 0
      },
      {
        "encodedKey": "8a193c26722b51b701722d77ca932613",
        "groupKey": "8a193c26722b51b701722d77ca932611",
        "clientKey": "8a193c26722b51b701722d77c66d23bc",
        "creationDate": "2020-05-19T15:05:25+0000",
        "indexInList": 1
      }
    ]
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	GroupExpandedApiV1

Create new Group

POST /groups

Create a group

Allows the creation and update of groups programatically. This method allows creating a group with address information and custom field values.

This method can also be used for editing groups. In order to do so, the encodedKey of the group needs to be provided.

Example requests

A new group with an address and custom field values

{
  "group": {
    "id": "995577000",
    "creationDate": "2014-12-17T11:38:00+0000",
    "lastModifiedDate": "2014-12-17T15:55:00+0000",
    "groupName": "Secret Group",
    "notes": "This group will not be normally available",
    "assignedUserKey": "8904193be1b047f9a94202c8bec9b9ef",
    "assignedCentreKey": "2a9d604a381a4e10b2da8a4968aa6363",
    "assignedBranchKey": "7bd2a83f-b3844729b90ff531a59f3dc4",
    "clientRole": {
      "encodedKey": "8a34356cf78600abc2ef799123"
    }
  },
  "addresses": [
    {
      "line1": "The Tea Building",
      "line2": "56 Shoreditch High Street",
      "city": "London",
      "region": "England",
      "postcode": "E1 6JJ",
      "country": "United Kingdom",
      "indexInList": 0
    }
  ],
  "customInformation": [
    {
      "value": "60000",
      "customFieldID": "Income"
    },
    {
      "value": "TRUE",
      "customFieldID": "Newsletter"
    }
  ],
  "groupMembers": [
    {
      "clientKey": "0a57a959a9354e97a8df11c083efdece",
      "creationDate": "2014-12-17T11:38:00+0000"
    },
    {
      "clientKey": "5a3932bfecc84cc5a6c1e495bf4748ed",
      "creationDate": "2014-12-17T11:38:00+0000"
    }
  ],
  "groupRoles": [
    {
      "groupRoleNameKey": "e8927b8c01b24936ba806a91872e9652",
      "clientKey": "5d1d0328eaf14f718013d9ead2687984"
    }
  ]
}

Parameters

Name	Type	Description	In
body	GroupApiV1	A group object	body

Example Responses

200 Response

{
  "assignedBranchKey": "string",
  "assignedCentreKey": "string",
  "assignedUserKey": "string",
  "clientRole": {
    "encodedKey": "string"
  },
  "creationDate": "2019-08-24T14:15:22Z",
  "emailAddress": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "groupName": "string",
  "homePhone": "string",
  "id": "string",
  "idPattern": "string",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "loanCycle": 0,
  "migrationEvent": {
    "creationDate": "2019-08-24T14:15:22Z",
    "encodedKey": "string",
    "numCentresImported": 0,
    "numClientsImported": 0,
    "numGLAccountsImported": 0,
    "numGroupsImported": 0,
    "numLoanRepaymentsImported": 0,
    "numLoanTransactionsImported": 0,
    "numLoansImported": 0,
    "numSavingsImported": 0,
    "state": "REVERTED",
    "type": "IMPORT"
  },
  "mobilePhone1": "string",
  "preferredLanguage": "PORTUGESE"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	GroupApiV1

Search for Groups

POST /groups/search

Search for Groups

Allows you to retrieve groups using dynamic custom filters.

Available group filter values

Filter Selection Parameter	Data Type
CLIENT_ROLE_KEY	KEY
BRANCH_KEY	KEY
CENTRE_KEY	KEY
CREDIT_OFFICER_KEY	KEY
ENCODED_KEY	KEY
GROUP_NAME	STRING
CREATION_DATE	DATE_UTC
LAST_MODIFIED_DATE	DATE_UTC
ID	STRING
PREFERRED_LANGUAGE	ENUM
DEPOSITS_BALANCE	MONEY
LOANS_BALANCE	MONEY
TOTAL_BALANCE	MONEY
NUMBER_OF_MEMBERS	NUMBER
LOAN_CYCLE	NUMBER

Filter Element	Number Of affected values	Available for
EQUALS	ONE_VALUE	BIG_DECIMAL,BOOLEAN,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY
MORE_THAN	ONE_VALUE	BIG_DECIMAL,NUMBER,MONEY
LESS_THAN	ONE_VALUE	BIG_DECIMAL,NUMBER,MONEY
BETWEEN	TWO_VALUES	BIG_DECIMAL,NUMBER,MONEY,DATE,DATE_UTC
ON	ONE_VALUE	DATE,DATE_UTC
AFTER	ONE_VALUE	DATE,DATE_UTC
BEFORE	ONE_VALUE	DATE,DATE_UTC
STARTS_WITH	ONE_VALUE	STRING
IN	LIST	ENUM,KEY
TODAY	NO_VALUE	DATE,DATE_UTC
THIS_WEEK	NO_VALUE	DATE,DATE_UTC
THIS_MONTH	NO_VALUE	DATE,DATE_UTC
THIS_YEAR	NO_VALUE	DATE,DATE_UTC
LAST_DAYS	ONE_VALUE	DATE,DATE_UTC
EMPTY	NO_VALUE	BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_UTC
NOT_EMPTY	NO_VALUE	BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_UTC

Example requests

A search

{
  "filterConstraints": [
    {
      "dataFieldType": "string",
      "dataItemType": "string",
      "filterElement": "string",
      "filterSelection": "string",
      "secondValue": "string",
      "value": "string",
      "values": [
        "string"
      ]
    }
  ],
  "sortDetails": {
    "dataFieldType": "string",
    "dataItemType": "string",
    "sortingColumn": "string",
    "sortingOrder": "string"
  }
}

Parameters

Name	Type	Description	In
offset	integer	none	query
limit	integer	none	query
body	FilterApiV1	none	body

Example Responses

200 Response

[
  {
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "clientRole": {
      "encodedKey": "string"
    },
    "creationDate": "2019-08-24T14:15:22Z",
    "emailAddress": "string",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "groupName": "string",
    "homePhone": "string",
    "id": "string",
    "idPattern": "string",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "loanCycle": 0,
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "mobilePhone1": "string",
    "preferredLanguage": "PORTUGESE"
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[GroupApiV1]	[A group object]	none
» assignedBranchKey	string	the encoded key of the branch to which this group is assigned	none
» assignedCentreKey	string	the encoded key of the centre to which this group is assigned	none
» assignedUserKey	string	the encoded key of the Mambu user to which this group is assigned	none
» clientRole	ClientRoleBasicApiV1	the type of client or group as defined in Mambu in Administration > General Settings > Client Types	none
»» encodedKey	string	the automatically generated encoded ID for this client or group type	none
» creationDate	string(date-time)	the date and time when this group was created	read-only
» emailAddress	string	the email address for this group. This address will be used for automated and manually sent email notifications	none
» encodedKey	string	the automatically generated encoded ID for this group	none
» groupName	string	the name of the group	none
» homePhone	string	the primary landline contact number for this group	none
» id	string	the ID for this group	none
» idPattern	string	the pattern used to generate IDs	none
» lastModifiedDate	string(date-time)	the date on which this group was last modified	read-only
» loanCycle	number	this number will increment each time this group takes out and fully pays back a loan	none
» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
»» creationDate	string(date-time)	the date on which the data import was made	none
»» encodedKey	string	the encoded key of this data migration event	none
»» numCentresImported	number	the number of centres which were imported during the data migration	none
»» numClientsImported	number	the number of clients which were imported as part of the data migration	none
»» numGLAccountsImported	number	the number of general ledger accounts which were imported as part of the data migration	none
»» numGroupsImported	number	the number of groups which were imported as part of the data migration	none
»» numLoanRepaymentsImported	number	the number of loan repayment transations which were imported as part of the data migration	none
»» numLoanTransactionsImported	number	the number of loan transactions which were imported as part of the data migration	none
»» numLoansImported	number	the number of loan accounts which were imported as part of the data migration	none
»» numSavingsImported	number	the number of savings accounts which were imported as part of the data migration	none
»» state	string	whether the data import was accepted, is still in a draft state, or was rejected and all data reverted	none
»» type	string	the type of migration event	none
» mobilePhone1	string	the primiary mobile contact number for this group	none
» preferredLanguage	string	the language which shoudl ideally be used when communicating with this group	none

Enumerated Values

Property	Value
state	`REVERTED`
state	`DRAFT`
state	`APPROVED`
type	`IMPORT`
type	`EXPORT`
preferredLanguage	`PORTUGESE`
preferredLanguage	`RUSSIAN`
preferredLanguage	`ROMANIAN`
preferredLanguage	`ENGLISH`
preferredLanguage	`SPANISH`
preferredLanguage	`GEORGIAN`
preferredLanguage	`BURMESE`
preferredLanguage	`PHRASE`
preferredLanguage	`CHINESE`
preferredLanguage	`FRENCH`
preferredLanguage	`INDONESIAN`

Get Group by ID

GET /groups/{groupId}

Get Group by ID

Allows you to retrieve a group directly by its group ID.

Parameters

Name	Type	Description	In
fullDetails	boolean	none	query
groupId (required)	string	none	path

Example Responses

200 : ok
A single group

{
  "encodedKey": "8a193c26722b51b701722d77ca932611",
  "id": "040693245",
  "creationDate": "2020-05-19T15:05:25+0000",
  "lastModifiedDate": "2020-09-24T10:25:39+0000",
  "groupName": "Apache",
  "assignedUserKey": "8a19dab474909bc8017490f2fb9006a8",
  "assignedBranchKey": "8a193c26722b51b701722d779e7122de",
  "loanCycle": 0,
  "assignedCentreKey": "8a193c26722b51b701722d779e7122e0",
  "emailAddress": "apachegroup@yougotma.il",
  "mobilePhone1": "+35131429818014",
  "homePhone": "+350305551155",
  "preferredLanguage": "ENGLISH",
  "clientRole": {
    "encodedKey": "8a194075720ece2c017226fcf7130069"
  }
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	GroupApiV1

Update Group info

PATCH /groups/{groupId}

Update Group Information

Information for a group can be added/edited using the PATCH method.

To remove all members and/or roles, provide an empty array for these fields.

Example requests

Updated group information

{
  "group": {
    "id": "445076768",
    "groupName": "Village group update",
    "notes": "some_notes after update",
    "assignedUserKey": "40288a164c31ebec014c31ebf7200004",
    "assignedCentreKey": "40288a164c31eca9014c31ef7e510005",
    "assignedBranchKey": "40288a164c31eca9014c31ef7e4f0003"
  },
  "groupMembers": [
    {
      "clientKey": "40288a164c31eca9014c31ef817100d9"
    }
  ],
  "groupRoles": [
    {
      "groupRoleNameKey": "40288a164c31eca9014c31ef8006000b",
      "clientKey": "40288a164c31eca9014c31ef819200da"
    }
  ]
}

Parameters

Name	Type	Description	In
group	object	none	body
» id	string	ID of the group. If not provided Mambu will generate one.	body
» groupName	string	A string with the name of the group.	body
» notes	string	Free text with notes about the group.	body
» assignedUserKey	string	Encoded key or ID of the assigned user.	body
» assignedCentreKey	string	Encoded key or ID of the assigned centre	body
» assignedBranchKey	string	Encoded key or ID of the assigned branch.	body
» emailAddress	string	E-mail address associated with the group.	body
» mobilePhone1	string	Mobile phone associated with the group.	body
» homePhone	string	Phone associated with the group.	body
groupMembers	[object]	an array of group members	body
» clientKey (required)	string	A string with the encoded key or id of the client being assigned to the group.	body
groupRoles	[object]	an array of group members and their associated roles	body
» groupRoleNameKey (required)	string	The encoded key of a group role.	body
» clientKey (required)	string	A valid encoded key of a client available as a member of the group.	body
groupId (required)	string	none	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
Bad Client ID

{
  "returnCode": 301,
  "returnStatus": "INVALID_CLIENT_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Get Group Comments

GET /groups/{groupId}/comments

Get all group comments

Get all comments for a group.

Parameters

Name	Type	Description	In
limit	string	none	query
offset	string	none	query
groupId (required)	string	the ID of the group	path

Example Responses

200 : OK
An array of comments

[
  {
    "encodedKey": "8a19b7057471f4af017472dc0fd80470",
    "parentKey": "8a193c26722b51b701722d77c5e423b7",
    "userKey": "8a194075720ece2c017226fced6f005e",
    "creationDate": "2020-09-09T14:24:42+0000",
    "lastModifiedDate": "2020-09-09T14:24:42+0000",
    "text": "He might  prefer a <div><br /></div><div><u>personal</u></div><div><u><br /></u></div><div><u>loan</u></div>"
  },
  {
    "encodedKey": "8a193c26722b51b701722d77c8bf25ab",
    "parentKey": "8a193c26722b51b701722d77c5e423b7",
    "creationDate": "2020-05-19T15:05:24+0000",
    "lastModifiedDate": "2020-05-19T15:05:24+0000",
    "text": "Should suggest she apply for the agriculture loan given the nature of their business"
  }
]

400 : Bad Request
Bad Group ID

{
  "returnCode": 149,
  "returnStatus": "INVALID_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[CommentApiV1]	none	none
» creationDate	string(date-time)	the date and time at which this comment was added	none
» encodedKey	string	a unique key for this comment	none
» lastModifiedDate	string(date-time)	the date and time at which this comment was last modified	none
» parentKey	string	the unique key of the parent object for this comment, for example, the client or loan account to which it relates	none
» text	string	the text of the comment as a string, must be properly JSON escpaped if it contains special characters	none
» userKey	string	the unique key of the user who created the comment	none

Create new Group Comment

POST /groups/{groupId}/comments

Create a group Comment

Create new comment for a group.

Example requests

A comment

{
  "comment": {
    "text": "this is a comment with \" \" all kinds of : \\ / \"non compliant\" stuff & = which has been JSON escaped"
  }
}

Parameters

Name	Type	Description	In
comment	object	an object contining the comment	body
» text	string	text of the comment to be added. if adding complex content make sure it is properly JSON encoded before making your request	body
groupId (required)	string	the ID of the group	path

Example Responses

200 : OK
A comment

{
  "encodedKey": "8a19c34574720f9e0174734a039f06e2",
  "parentKey": "8a193c26722b51b701722d77c5e423b7",
  "userKey": "8a194075720ece2c017226fced6f005e",
  "creationDate": "2020-09-09T14:39:36+0000",
  "lastModifiedDate": "2020-09-09T14:39:36+0000",
  "text": "this is a comment with \" \" all kinds of : \\ / non compliant stuff & = which has been JSON escaped"
}

400 : Bad Request
Extra parameters in the request

{
  "returnCode": 27,
  "returnStatus": "PARAMETER_NOT_ALLOWED"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	CommentApiV1
`400`	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Update Group Custom Field Values

PATCH /groups/{groupId}/custominformation

Update custom field values

Update custom field values

Example Requests

Update a single custom field value

{
  "customInformation": [
    {
      "customFieldID": "custom_field_2",
      "value": "3"
    }
  ]
}

Update a field in a group

{
  "customInformation": [
    {
      "customFieldID": "cf_grouped_field",
      "value": "new value",
      "customFieldSetGroupIndex": "0"
    }
  ]
}

Update multiple custom field values

{
  "customInformation": [
    {
      "customFieldID": "cf_grouped_field_2",
      "value": "3",
      "customFieldSetGroupIndex": "0"
    },
    {
      "customFieldID": "field_3",
      "value": "divorced"
    }
  ]
}

Parameters

Name	Type	Description	In
customInformation	[object]	none	body
» customFieldID (required)	string	none	body
» value (required)	string	none	body
» customFieldSetGroupIndex	string	Required if field to update is part of a group, if the Field Set Group Index is not set, a new group will be created with the value provided.	body
groupId (required)	string	The ID of the group	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Get Group Custom Info

GET /groups/{groupId}/custominformation/{customFieldId}

Get a custom field definition for a group

Allows retrieving a custom field definition for a given group directly by the ID/key of the group and the ID/key of the custom field definition.

Parameters

Name	Type	Description	In
groupId (required)	string	The ID of the group.	path
customFieldId (required)	string	The ID of the custom field definition.	path

Example Responses

200 : OK
A custom field definition

[
  {
    "encodedKey": "8a19cd6f74674df9017467f25aab02c6",
    "parentKey": "8a193c26722b51b701722d779e7122de",
    "customFieldKey": "8a19cd6f74674df9017467ef8e6802af",
    "customField": {
      "encodedKey": "8a19cd6f74674df9017467ef8e6802af",
      "id": "cf_group",
      "creationDate": "2020-09-07T09:42:33+0000",
      "lastModifiedDate": "2020-09-07T09:42:33+0000",
      "name": "Example Custom Field Definition",
      "type": "BRANCH_INFO",
      "dataType": "CHECKBOX",
      "valueLength": "SHORT",
      "isDefault": false,
      "isRequired": false,
      "description": "an example of a checkbox custom field definition",
      "customFieldSet": {
        "encodedKey": "8a19cd6f74674df9017467ef8e6802ae",
        "id": "_example_group_custom_field_set",
        "name": "example group custom field set",
        "notes": "example custom field set",
        "createdDate": "2020-09-07T09:41:50+0000",
        "lastModifiedDate": "2020-09-07T09:41:50+0000",
        "indexInList": 2,
        "type": "BRANCH_INFO",
        "usage": "SINGLE"
      },
      "indexInList": 0,
      "state": "NORMAL",
      "customFieldSelectionOptions": [],
      "viewRights": {
        "encodedKey": "8a19cd6f74674df9017467ef8e6802b0",
        "isAccessibleByAllUsers": false,
        "roles": []
      },
      "editRights": {
        "encodedKey": "8a19cd6f74674df9017467ef8e6802b1",
        "isAccessibleByAllUsers": false,
        "roles": []
      },
      "unique": false,
      "values": [],
      "amounts": {}
    },
    "value": "TRUE",
    "indexInList": -1,
    "customFieldID": "cf_group",
    "customFieldSetGroupIndex": -1
  }
]

404 : Not Found
Not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	CustomFieldApiV1
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Update Group Custom Field Value

PATCH /groups/{groupId}/custominformation/{customFieldId}

Update a custom field value for a group

Update a group custom field value

Example requests

Providing a new custom field value

{
  "value": "new custom field value"
}

Parameters

Name	Type	Description	In
value	string	none	body
groupId (required)	string	The ID of the group.	path
customFieldId (required)	string	The ID of the custom field definition.	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
Field is part of a group

{
  "returnCode": 916,
  "returnStatus": "INVALID_CUSTOM_FIELD_GROUP_INDEX",
  "errorSource": "cf_group_field_2"
}

404 : Not Found
Not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Delete Group Custom Field Value

DELETE /groups/{groupId}/custominformation/{customFieldId}

Delete Group Custom Field Value

Delete a single custom field value

Parameters

Name	Type	Description	In
groupId (required)	string	The ID of the group.	path
customFieldId (required)	string	The ID of the custom field definition.	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
Field is part of a group

{
  "returnCode": 916,
  "returnStatus": "INVALID_CUSTOM_FIELD_GROUP_INDEX",
  "errorSource": "cf_group_field_2"
}

404 : Not Found
Not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Update Group Custom Field Value (grouped)

PATCH /groups/{groupId}/custominformation/{customFieldId}/{customFieldGroupSetIndex}

Update grouped custom field value

Update custom field value, which is part of a group

Example requests

A new custom field value

{
  "value": "new custom field value"
}

Parameters

Name	Type	Description	In
value	string	none	body
groupId (required)	string	The ID of the group	path
customFieldId (required)	string	The ID of the custom field definition.	path
customFieldGroupSetIndex (required)	string	none	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
Wrong group index provided

{
  "returnCode": 916,
  "returnStatus": "INVALID_CUSTOM_FIELD_GROUP_INDEX",
  "errorSource": "cf_group_field_2"
}

404 : Not Found
Field not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Delete Group Custom Field Value (grouped)

DELETE /groups/{groupId}/custominformation/{customFieldId}/{customFieldGroupSetIndex}

Delete grouped custom field value

Delete a custom field value, which is part of a group

Parameters

Name	Type	Description	In
groupId (required)	string	The ID of the group	path
customFieldId (required)	string	The ID of the custom field definition.	path
customFieldGroupSetIndex (required)	string	none	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Get Documents for a Group

GET /groups/{groupId}/documents

Get documents for group

Get all documents for a given group

Parameters

Name	Type	Description	In
offset	integer	offset results. use with `limit` parameter to achieve paging	query
limit	integer	max number of records to return	query
groupId (required)	string	The ID of the group	path

Example Responses

200 : ok
An array of documents

[
  {
    "encodedKey": "8a19c035747bf5b901747c5bfb04014b",
    "id": 51,
    "creationDate": "2020-09-11T08:52:48+0000",
    "lastModifiedDate": "2020-09-11T08:52:48+0000",
    "documentHolderKey": "8a193c26722b51b701722d779e7122df",
    "documentHolderType": "GROUP",
    "name": "covid rules",
    "type": "png",
    "fileSize": 8258,
    "originalFilename": "Screenshot_2020-04-22_at_14.31.29.png",
    "location": "BRSIDSLFBOGAYZKUUKCOGGQEDOSEOD",
    "description": "some guidelines regarding covid",
    "createdByUserKey": "8a194075720ece2c017226fced6f005e",
    "userName": "big chief"
  },
  {
    "encodedKey": "8a19a3337476f2d00174775b6a3001ae",
    "id": 43,
    "creationDate": "2020-09-10T09:31:54+0000",
    "lastModifiedDate": "2020-09-10T09:31:54+0000",
    "documentHolderKey": "8a193c26722b51b701722d779e7122df",
    "documentHolderType": "GROUP",
    "name": "group doc",
    "type": "png",
    "fileSize": 32109,
    "originalFilename": "clients_duplicate_id.png",
    "location": "JRTBQGGVXFQRQRBDGBRWQCTXJNRWXP",
    "description": "group doc desc",
    "createdByUserKey": "8a194075720ece2c017226fced6f005e",
    "userName": "big chief"
  }
]

400 : Bad Request
Bad Group ID

{
  "returnCode": 4,
  "returnStatus": "INVALID_PARAMETERS",
  "errorSource": "wrong owner id"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[DocumentApiV1]	none	none
» createdByUserKey	string	the encoded key of the user who added this document	none
» creationDate	string	the date and time when this document was created	none
» description	string	a description of this document	none
» documentHolderKey	string	the encoded key of the entity to which this document is attached	none
» documentHolderType	string	the type of entity, eg. client, loan product, to which this document is attached	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» fileSize	number	the size, in bytes, of the attached document	none
» id	number	an ID for this document	none
» lastModifiedDate	string	the date on which this document was last modified	none
» location	string	indicates where the document is saved	none
» name	string	the display name of this document	none
» originalFilename	string	the name of the originally uploaded file	none
» type	string	the file type of the document, eg. png, jpeg, pdf	none
» userName	string	the name of the user who uploaded the document	none

Enumerated Values

Property	Value
documentHolderType	`BRANCH`
documentHolderType	`LOAN_ACCOUNT`
documentHolderType	`GROUP`
documentHolderType	`DEPOSIT_ACCOUNT`
documentHolderType	`LINE_OF_CREDIT`
documentHolderType	`LOAN_PRODUCT`
documentHolderType	`GL_JOURNAL_ENTRY`
documentHolderType	`SAVINGS_PRODUCT`
documentHolderType	`USER`
documentHolderType	`CLIENT`
documentHolderType	`CENTRE`
documentHolderType	`ID_DOCUMENT`

Attach Document for a Group

POST /groups/{groupId}/documents

Attach new Document to a group

Attach a new document to a group

Example requests

A document to upload

{
  "document": {
    "documentHolderKey": "8a193c26722b51b701722d779e7122df",
    "documentHolderType": "GROUP",
    "name": "some image",
    "type": "PNG",
    "description": "this is an image file"
  },
  "documentContent": "iVBORw0KGgoAAAANSUhEUgAAAnYAAAF0CAYAAACudHRvAAABQGlDQ1BJQ0MgUHJvZmlsZQAAKJFjYGASS=="
}

Parameters

Name	Type	Description	In
body	CreateDocumentApiV1	a new document to be attached to an entity	body
groupId (required)	string	The ID of the group	path

Example Responses

201 : Created
Uploaded document details

{
  "encodedKey": "8a19c035747bf5b901747c5bfb04014d",
  "id": 52,
  "creationDate": "2020-09-11T08:54:53+0000",
  "lastModifiedDate": "2020-09-11T08:54:53+0000",
  "documentHolderKey": "8a193c26722b51b701722d779e7122df",
  "documentHolderType": "GROUP",
  "name": "some image",
  "type": "png",
  "fileSize": 32109,
  "originalFilename": "some_image.png",
  "location": "RCPOUIUHJFBYDRURQNNHMOGBEFIOQF",
  "description": "this is an image file",
  "createdByUserKey": "8a194075720ece2c017226fced6f005e"
}

400 : Bad Request
Provided file type does not match actual file uploaded

{
  "returnCode": 973,
  "returnStatus": "INCONSISTENT_EXTENSION_WITH_FILE_CONTENT",
  "errorSource": "Invalid extension with file content"
}

Responses

Status	Meaning	Description	Schema
`201`	Created	Created	DocumentApiV1
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Get Group Document

GET /groups/{groupId}/documents/{documentId}

Get a group Document

Get a specific document attached to a group

Parameters

Name	Type	Description	In
groupId (required)	string	The ID of the group	path
documentId (required)	string	The ID of the document	path

Example Responses

200 : OK
Base64-encoded document

"iVBORw0KGgoAAAANSUhEUgAAAEAAAAA9CAYAAAAd1W/BAAAMY2lDQ1BJQ0MgUHJvZmlsZQAASImVVwdck0cbv3dkkrACEZAR9hJFZgAZIawIAjIFUQlJIGHEmBBE3NRSBesWUZxoVUTRagWkDkSssyhu6yiKqFRqsYoLle8yoNZ+4/c9v9+993+fe+7/jNzlvQNAr5Mvk+Wj+gAUSAvlCZGhrElp6SzSI4ABU0ADtsCTL1DIOPHxMQDKUP93eX0DIKr+qpuK65/j/1UMhSKFAAAkA=="

400 : Bad Request
Bad Document ID

{
  "returnCode": 970,
  "returnStatus": "INVALID_DOCUMENT_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	string
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Delete Group Document

DELETE /groups/{groupId}/documents/{documentId}

Delete a group Document

Delete a document attached to a group

Parameters

Name	Type	Description	In
groupId (required)	string	The ID of the group	path
documentId (required)	string	The ID of the document	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
Bad Document ID

{
  "returnCode": 970,
  "returnStatus": "INVALID_DOCUMENT_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	ExecutionStatusApiV1
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Get Lines of Credit for a Group

GET /groups/{groupId}/linesofcredit

Get Lines of Credit for a Group

Get lines of credit for a client in a group

Parameters

Name	Type	Description	In
fullDetails	boolean	none	query
groupId (required)	string	none	path

Example Responses

200 : ok
A line of credit for a group and the basic details

[
  {
    "encodedKey": "8a19a3cc74beb0eb0174bfa5562b04dc",
    "id": "ZCS816",
    "groupKey": "8a193c26722b51b701722d77ca932611",
    "startDate": "2020-09-01T00:00:00+0000",
    "expireDate": "2021-09-30T00:00:00+0000",
    "creationDate": "2020-09-24T10:35:16+0000",
    "approvedDate": "2020-09-24T12:35:16+0000",
    "lastModifiedDate": "2020-09-24T10:35:16+0000",
    "state": "APPROVED",
    "amount": "15000",
    "exposureLimitType": "APPROVED_AMOUNT",
    "notes": "a line of credit for the apache group",
    "availableCreditAmount": "15000"
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	LineOfCreditFullApiV1

Images

Allows you to retrieve images of client profiles/signatures and any other images via api calls.

Get Image by ID

GET /images/{imageId}

Get Image by ID

Allows retrieving images of client profiles/signatures or any other images via api calls. The iamge ID can be found by, for example, making a GET request for the client.

Images will be returned as a base64 encoded string.

Parameters

Name	Type	Description	In
size	string	Image size to be returned.	query
imageId (required)	string	none	path

Enumerated Values

Parameter	Value
size	`LARGE`
size	`MEDIUM`
size	`SMALL_THUMB`
size	`TINY_THUMB`

Example Responses

200 : OK
base 64 encoded string

"bW92ZSBvbiwgbm90aGluZyB0byBzZWUgaGVyZSAuLi4="

400 : Bad Request
Missing Image ID

{
  "errorSource": "picture key is required",
  "returnCode": 4,
  "returnStatus": "INVALID_PARAMETERS"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	string
`400`	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Description	Restrictions
» errorSource	string	none	none
» returnCode	integer	none	none
» returnStatus	string	none	none

Index Rates

Update index rates on the system. For example EURIBOR is updated monthly and this can be automated using this endpoint.

Create or update Index Rates

POST /indexratesources/{indexRateSourceId}/indexrates

Update an Index Rate Source

Updates an index rate source. A valid index source ID is required.

Example requests

An index rate

{
  "indexRate": {
    "startDate": "2020-04-16",
    "rate": "-0.03256",
    "notes": "Euribor Apr 2020"
  }
}

Parameters

Name	Type	Description	In
indexRate	object	none	body
» notes	string	Optional notes about the rate	body
» rate (required)	string	A number with the interest rate	body
» startDate (required)	string(date)	Date of the start of the new interest rate	body
indexRateSourceId (required)	string	none	path

Example Responses

200 Response

{
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "notes": "string",
  "rate": 0,
  "rateSource": {
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "name": "string",
    "notes": "string",
    "type": "TAX_RATE"
  },
  "startDate": "string",
  "userKey": "string"
}

200 : OK
response

400 : Bad Request
Bad start date

{
  "returnCode": 1302,
  "returnStatus": "INVALID_INDEX_RATE_START_DATE"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	IndexRateApiV1
`400`	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Indicators

Retrieve various performance indicators for the organization. Performance indicator descriptions can be found in our user guide.

Possible indicators to use include:

Clients

NUM_CLIENTS

NUM_ACTIVE_CLIENTS

NUM_INACTIVE_CLIENTS

NUM_OPEN_CLIENTS

NUM_CLOSED_CLIENTS

NUM_EXITED_CLIENTS

NUM_PENDING_APPROVAL_CLIENTS

Active Pure Groups

NUM_GROUPS_BORROWING

AVERAGE_GROUP_SIZE

NUM_GROUP_BORROWERS

NUM_INDIVIDUAL_BORROWERS

PERCENTAGE_OF_FEMALE_BORROWERS

NUM_GROUPS_SAVING

NUM_INDIVIDUAL_SAVERS

NUM_GROUP_SAVERS

NUM_GROUPS

NUM_HYBRID_GROUPS_BORROWING

NUM_HYBRID_GROUP_BORROWERS

Deposits

NUM_ACTIVE_SAVINGS_ACCOUNTS

TOTAL_DEPOSITS

INTEREST_PAYABLE

Loan Portfolio

NUM_LOANS_OUTSTANDING

NUM_LOANS_PENDING_DISBURSAL

NUM_LOANS_IN_ARREARS

NUM_LOANS_AWAITING_APPROVAL

PORTFOLIO_PENDING_DISBURSAL

GROSS_LOAN_PORTFOLIO

AVERAGE_LOAN_BALANCE

TOTAL_DISBURSED_ACTIVE_LOANS

PROJECTED_LOAN_INTEREST_EARNINGS

Loan Transaction

TOTAL_LOANS_DISBURSED

Risk and Aging

PORTFOLIO_PERCENT_AT_RISK

PORTFOLIO_VALUE_AT_RISK

PAR_7_DAYS

PAR_15_DAYS

PAR_30_DAYS

PAR_90_DAYS

PAR_7_30_DAYS

PAR_30_90_DAYS

PAR_90_180_DAYS

PAR_180_360_DAYS

VAR_7_DAYS

VAR_15_DAYS

VAR_30_DAYS

VAR_90_DAYS

INTEREST_IN_SUSPENSE

Organization Indicators

NUM_BRANCHES

NUM_CREDIT_OFFICERS

NUM_LOANS_PER_BRANCH

NUM_LOANS_PER_CREDIT_OFFICER

NUM_LOAN_ACCOUNTS

NUM_USERS

Get KPIs

GET /indicators/{INDICATOR}

Get Indicator

Retrieves the result of computing an indicator by it's unique name. Response is a map of the indicator name to its value, which may be an integer or a decimal depending on the indicator. These indicators could be used to power a dashboard or feed data to a report.

Example Requests

Get the total number of clients

GET /api/indicators/NUM_CLIENTS

Parameters

Name	Type	Description	In
INDICATOR (required)	string	none	path

Enumerated Values

Parameter	Value
INDICATOR	`NUM_CLIENTS`
INDICATOR	`NUM_ACTIVE_CLIENTS`
INDICATOR	`NUM_INACTIVE_CLIENTS`
INDICATOR	`NUM_OPEN_CLIENTS`
INDICATOR	`NUM_CLOSED_CLIENTS`
INDICATOR	`NUM_EXITED_CLIENTS`
INDICATOR	`NUM_PENDING_APPROVAL_CLIENTS`
INDICATOR	`NUM_GROUPS_BORROWING`
INDICATOR	`AVERAGE_GROUP_SIZE`
INDICATOR	`NUM_GROUP_BORROWERS`
INDICATOR	`NUM_INDIVIDUAL_BORROWERS`
INDICATOR	`PERCENTAGE_OF_FEMALE_BORROWERS`
INDICATOR	`NUM_GROUPS_SAVING`
INDICATOR	`NUM_INDIVIDUAL_SAVERS`
INDICATOR	`NUM_GROUP_SAVERS`
INDICATOR	`NUM_GROUPS`
INDICATOR	`NUM_HYBRID_GROUPS_BORROWING`
INDICATOR	`NUM_HYBRID_GROUP_BORROWERS`
INDICATOR	`NUM_ACTIVE_SAVINGS_ACCOUNTS`
INDICATOR	`TOTAL_DEPOSITS`
INDICATOR	`INTEREST_PAYABLE`
INDICATOR	`NUM_LOANS_OUTSTANDING`
INDICATOR	`NUM_LOANS_PENDING_DISBURSAL`
INDICATOR	`NUM_LOANS_IN_ARREARS`
INDICATOR	`NUM_LOANS_AWAITING_APPROVAL`
INDICATOR	`PORTFOLIO_PENDING_DISBURSAL`
INDICATOR	`GROSS_LOAN_PORTFOLIO`
INDICATOR	`AVERAGE_LOAN_BALANCE`
INDICATOR	`TOTAL_DISBURSED_ACTIVE_LOANS`
INDICATOR	`PROJECTED_LOAN_INTEREST_EARNINGS`
INDICATOR	`TOTAL_LOANS_DISBURSED`
INDICATOR	`PORTFOLIO_PERCENT_AT_RISK`
INDICATOR	`PORTFOLIO_VALUE_AT_RISK`
INDICATOR	`PAR_7_DAYS`
INDICATOR	`PAR_15_DAYS`
INDICATOR	`PAR_30_DAYS`
INDICATOR	`PAR_90_DAYS`
INDICATOR	`PAR_7_30_DAYS`
INDICATOR	`PAR_30_90_DAYS`
INDICATOR	`PAR_90_180_DAYS`
INDICATOR	`PAR_180_360_DAYS`
INDICATOR	`VAR_7_DAYS`
INDICATOR	`VAR_15_DAYS`
INDICATOR	`VAR_30_DAYS`
INDICATOR	`VAR_90_DAYS`
INDICATOR	`INTEREST_IN_SUSPENSE`
INDICATOR	`NUM_BRANCHES`
INDICATOR	`NUM_CREDIT_OFFICERS`
INDICATOR	`NUM_LOANS_PER_BRANCH`
INDICATOR	`NUM_LOANS_PER_CREDIT_OFFICER`
INDICATOR	`NUM_LOAN_ACCOUNTS`
INDICATOR	`NUM_USERS`

Example Responses

200 : OK
Number of total clients

{
  "NUM_CLIENTS": "10200"
}

200 : OK
Success Response

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» {indicator_name}	string	none	none

Lines of Credit

Allows you to retrieve the lines of credit by a specific client or group, add and remove accounts from lines of credit.

Get all Lines of Credit

GET /linesofcredit

Get all lines of credit

Get all lines of credit

Parameters

Name	Type	Description	In
fullDetails	boolean	Whether to include custom field values	query

Example Responses

200 : ok
Array of lines of credit with basic details

[
  {
    "encodedKey": "8a8080c84c2d590b014c2d59e9e80001",
    "id": "WTF118",
    "groupKey": "8a8080c84c085ddf014c085e27a7032f",
    "startDate": "2016-03-18T00:00:00+0000",
    "expireDate": "2017-03-22T00:00:00+0000",
    "creationDate": "2015-03-18T14:46:49+0000",
    "lastModifiedDate": "2015-03-18T14:46:49+0000",
    "amount": "11111",
    "availableCreditAmount": "5000",
    "notes": ""
  },
  {
    "encodedKey": "40288a7d4c2d441f014c2d45d2e70003",
    "id": "CAO277",
    "clientKey": "8a8080c84c085ddf014c085e1ecb00dd",
    "startDate": "2015-03-31T00:00:00+0000",
    "expireDate": "2015-04-02T00:00:00+0000",
    "creationDate": "2015-03-18T14:24:52+0000",
    "lastModifiedDate": "2015-03-18T14:24:52+0000",
    "amount": "1111",
    "availableCreditAmount": "200",
    "notes": ""
  },
  {
    "encodedKey": "40288a7d4c2d441f014c2d4581fe0001",
    "id": "EPG351",
    "clientKey": "8a8080c84c085ddf014c085e1e9200d7",
    "startDate": "2015-03-23T00:00:00+0000",
    "expireDate": "2015-03-30T00:00:00+0000",
    "creationDate": "2015-03-18T14:24:32+0000",
    "lastModifiedDate": "2015-03-18T14:24:32+0000",
    "amount": "1111",
    "availableCreditAmount": "400",
    "notes": ""
  }
]

200 : ok
Array of lines of credit with full details

[
  {
    "encodedKey": "402880b858d95c8e0158d95f0379048a",
    "id": "QCE677",
    "clientKey": "402880b858d95c8e0158d95ce07b00f3",
    "startDate": "2016-12-01T00:00:00+0000",
    "expireDate": "2016-12-30T00:00:00+0000",
    "creationDate": "2016-12-07T13:01:36+0000",
    "lastModifiedDate": "2016-12-07T13:01:36+0000",
    "state": "ACTIVE",
    "amount": "1000",
    "notes": "",
    "availableCreditAmount": "1000",
    "customInformation": [
      {
        "encodedKey": "402880b858d95c8e0158d95f0379048b",
        "parentKey": "402880b858d95c8e0158d95f0379048a",
        "customFieldKey": "402880b858d95c8e0158d95dd4a40484",
        "customField": {
          "encodedKey": "402880b858d95c8e0158d95dd4a40484",
          "id": "loccf2",
          "creationDate": "2016-12-07T13:00:01+0000",
          "lastModifiedDate": "2016-12-07T13:00:01+0000",
          "name": "LoC CF Req",
          "type": "LINE_OF_CREDIT",
          "dataType": "STRING",
          "valueLength": "SHORT",
          "isDefault": true,
          "isRequired": true,
          "description": "",
          "customFieldSet": {
            "encodedKey": "402880b858d95c8e0158d95cfe4b0480",
            "name": "LoC CF Set",
            "notes": "",
            "createdDate": "2016-12-07T12:58:39+0000",
            "indexInList": 0,
            "type": "LINE_OF_CREDIT",
            "usage": "SINGLE"
          },
          "indexInList": 1,
          "state": "NORMAL",
          "customFieldSelectionOptions": [],
          "viewRights": {
            "encodedKey": "402880b858d95c8e0158d95dd4a40485",
            "isAccessibleByAllUsers": false,
            "roles": []
          },
          "editRights": {
            "encodedKey": "402880b858d95c8e0158d95dd4a40486",
            "isAccessibleByAllUsers": false,
            "roles": []
          },
          "unique": false,
          "values": [],
          "amounts": {}
        },
        "value": "asd",
        "indexInList": -1,
        "customFieldID": "loccf2",
        "customFieldSetGroupIndex": -1
      },
      {
        "encodedKey": "402880b858d95c8e0158d95f0379048c",
        "parentKey": "402880b858d95c8e0158d95f0379048a",
        "customFieldKey": "402880b858d95c8e0158d95cfe4b0481",
        "customField": {
          "encodedKey": "402880b858d95c8e0158d95cfe4b0481",
          "id": "loccf1",
          "creationDate": "2016-12-07T12:59:15+0000",
          "lastModifiedDate": "2016-12-07T14:48:17+0000",
          "name": "LoC CF",
          "type": "LINE_OF_CREDIT",
          "dataType": "STRING",
          "valueLength": "SHORT",
          "isDefault": false,
          "isRequired": false,
          "description": "",
          "customFieldSet": {
            "encodedKey": "402880b858d95c8e0158d95cfe4b0480",
            "name": "LoC CF Set",
            "notes": "",
            "createdDate": "2016-12-07T12:58:39+0000",
            "indexInList": 0,
            "type": "LINE_OF_CREDIT",
            "usage": "SINGLE"
          },
          "indexInList": 0,
          "state": "NORMAL",
          "customFieldSelectionOptions": [],
          "viewRights": {
            "encodedKey": "402880b858d95c8e0158d95cfe4b0482",
            "isAccessibleByAllUsers": true,
            "roles": []
          },
          "editRights": {
            "encodedKey": "402880b858d95c8e0158d95dd4a40483",
            "isAccessibleByAllUsers": true,
            "roles": []
          },
          "unique": false,
          "values": [],
          "amounts": {}
        },
        "value": "123",
        "indexInList": -1,
        "customFieldID": "loccf1",
        "customFieldSetGroupIndex": -1
      },
      {
        "encodedKey": "402880b858d95c8e0158d95ffb37048d",
        "parentKey": "402880b858d95c8e0158d95f0379048a",
        "customFieldKey": "402880b858d95c8e0158d95dd4a40487",
        "customField": {
          "encodedKey": "402880b858d95c8e0158d95dd4a40487",
          "id": "loccf3",
          "creationDate": "2016-12-07T13:00:33+0000",
          "lastModifiedDate": "2016-12-07T14:50:51+0000",
          "name": "LoC CF Role View",
          "type": "LINE_OF_CREDIT",
          "dataType": "STRING",
          "valueLength": "SHORT",
          "isDefault": true,
          "isRequired": false,
          "description": "",
          "customFieldSet": {
            "encodedKey": "402880b858d95c8e0158d95cfe4b0480",
            "name": "LoC CF Set",
            "notes": "",
            "createdDate": "2016-12-07T12:58:39+0000",
            "indexInList": 0,
            "type": "LINE_OF_CREDIT",
            "usage": "SINGLE"
          },
          "indexInList": 2,
          "state": "NORMAL",
          "customFieldSelectionOptions": [],
          "viewRights": {
            "encodedKey": "402880b858d95c8e0158d95f03790488",
            "isAccessibleByAllUsers": true,
            "roles": []
          },
          "editRights": {
            "encodedKey": "402880b858d95c8e0158d95f03790489",
            "isAccessibleByAllUsers": false,
            "roles": []
          },
          "unique": false,
          "values": [],
          "amounts": {}
        },
        "value": "role",
        "indexInList": -1,
        "customFieldID": "loccf3",
        "customFieldSetGroupIndex": -1
      }
    ]
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	None

Response Schema

Create Line of Credit

POST /linesofcredit

Create a line of credit

Create a new line of credit for a client or group

Example requests

A line of credit for a client with custom information

{
  "lineOfCredit": {
    "id": "FEP015",
    "clientKey": "4028808a58d348710158d3490d0500f1",
    "startDate": "2016-06-01T00:00:00+0000",
    "expireDate": "2016-06-30T00:00:00+0000",
    "amount": "10000",
    "exposureLimitType": "APPROVED_AMOUNT",
    "notes": "some fascinating line of credit notes",
    "customInformation": [
      {
        "value": "Pending",
        "customFieldID": "cf1"
      },
      {
        "value": "3",
        "customFieldID": "cf2"
      }
    ]
  }
}

Parameters

Name	Type	Description	In
body	CreateLineOfCreditApiV1	none	body

Example Responses

200 Response

{
  "amount": 0,
  "approvedDate": "string",
  "availableCreditAmount": 0,
  "clientKey": "string",
  "closedDate": "string",
  "creationDate": "string",
  "customInformation": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "expireDate": "string",
  "exposureLimitType": "APPROVED_AMOUNT",
  "groupKey": "string",
  "id": "string",
  "idPattern": "string",
  "lastModifiedDate": "string",
  "notes": "string",
  "startDate": "string",
  "state": "WITHDRAWN",
  "subState": "WITHDRAWN"
}

400 : Bad Request
Malformatted JSON/missing required field

{
  "returnCode": 30,
  "returnStatus": "MISSING_ENTITY_JSON"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	LineOfCreditFullApiV1
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Search for Lines of Credit

POST /linesofcredit/search

Search Lines of Credit

Search for lines of credit based on some given criteria

Example requests

Get all lines of credit approved this month

{
  "filterConstraints": [
    {
      "filterSelection": "APPROVAL_DATE",
      "filterElement": "THIS_MONTH"
    }
  ]
}

Get all lines of credit that are in a specific substate

{
  "filterConstraints": [
    {
      "filterSelection": "SUBSTATE",
      "filterElement": "IN",
      "values": [
        "WITHDRAWN",
        "REJECTED"
      ]
    }
  ]
}

Parameters

Name	Type	Description	In
body	FilterApiV1	none	body

Example Responses

200 Response

[
  {
    "amount": 0,
    "approvedDate": "string",
    "availableCreditAmount": 0,
    "clientKey": "string",
    "closedDate": "string",
    "creationDate": "string",
    "customInformation": [
      {
        "amount": 0,
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "customFieldID": "string",
        "customFieldKey": "string",
        "customFieldSetGroupIndex": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexInList": 0,
        "linkedEntityKeyValue": "string",
        "parentKey": "string",
        "selectionKey": "string",
        "value": "string"
      }
    ],
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "expireDate": "string",
    "exposureLimitType": "APPROVED_AMOUNT",
    "groupKey": "string",
    "id": "string",
    "idPattern": "string",
    "lastModifiedDate": "string",
    "notes": "string",
    "startDate": "string",
    "state": "WITHDRAWN",
    "subState": "WITHDRAWN"
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[LineOfCreditFullApiV1]	none	none
» amount	number	none	none
» approvedDate	string	none	none
» availableCreditAmount	number	none	none
» clientKey	string	none	none
» closedDate	string	none	none
» creationDate	string	the date and time when this line of credit was created	none
» customInformation	[CustomFieldValueApiV1]	none	none
»» amount	number	none	none
»» customField	CustomFieldApiV1	none	none
»»» amounts	object	used when options available for a custom field definition translate to predefined amounts, for example, when the custom field value is used to generate a score	none
»»»» additionalProperties	number	none	none
»»» builtInCustomFieldId	string	if this field is one of the built in custom fiel definitions, this will have a value. These names are reserved and you can not use them for your own custom field definitions	none
»»» creationDate	string	the date on which this custom field definition was created	none
»»» customFieldProductSettings	[CustomFieldLinkApiV1]	none	none
»»»» customFieldEncodedKey	string	the key to the parent custom field definition	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isDefault	boolean	whether this field is displayed by default when creating a new record	none
»»»» isRequired	boolean	whether this field is required when creating a new record	none
»»»» linkType	string	the type of entity this field represents a link to	none
»»»» productKey	string	when the link type is product, this field should contain the encoded key of the linekd product	none
»»» customFieldSelectionOptions	[CustomFieldSelectionApiV1]	[represents a possible selection for select type custom field definitions]	none
»»»» constraint	CustomFilterConstraintApiV1	none	none
»»»»» customFieldKey	string	none	none
»»»»» dataFieldType	string	none	none
»»»»» dataFieldValue	string	none	none
»»»»» dataItemType	string	none	none
»»»»» dataType	string	none	none
»»»»» encodedKey	string	none	none
»»»»» filterElement	string	none	none
»»»»» groupNumber	number	none	none
»»»»» index	number	none	none
»»»»» linkingOperator	string	none	none
»»»»» secondValue	string	none	none
»»»»» value	string	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this selectable item	none
»»»» score	number	the score assigned to this selection	none
»»»» value	string	display name of this option	none
»»» customFieldSet	CustomFieldSetApiV1	none	none
»»»» builtInType	string	if this set is part of the set of built-in custom field sets, its type will be shown here	none
»»»» createdDate	string	the date and time when this custom field set was created	none
»»»» customFields	[CustomFieldApiV1]	an array of custom field definitions included in this custom field set	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this custom field set	none
»»»» indexInList	number	for field sets that can be added to an entity more than once, this number represents the index in the list and is used when changing values	none
»»»» lastModifiedDate	string	the date on which this custom field set was last modified	none
»»»» name	string	the name of this custom field set	none
»»»» notes	string	any notes regarding this custom field set	none
»»»» type	string	the entity type that this custom field definition is attached to	none
»»»» usage	string	whether this custom field set can only be used once, or added multiple times to the same entity	none
»»» dataType	string	the type of custom field definition	none
»»» description	string	a brief description of this custom field definition	none
»»» editRights	UsageRightsApiV1	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isAccessibleByAllUsers	boolean	none	none
»»»» roles	[string]	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» id	string	the ID for this custom field definition	none
»»» indexInList	number	none	none
»»» isDefault	boolean	whether this field will be included by default on new records	none
»»» isRequired	boolean	whether this field is required when creating a new record	none
»»» lastModifiedDate	string	the date on which this custom field definition was last modified	none
»»» name	string	the name of this custom field definition	none
»»» state	string	whether this field is available for use or has been deactivated	none
»»» type	string	the type of data this custom field definition will contain	none
»»» unique	boolean	whether the data in this custom field definition needs to be a unique value	none
»»» validationPattern	string	a user-provided pattern to which data in this custom field definition must conform where @ represents numbers, # represents letters and $ is either a number or letter. Other special characters used as separators are allowed, for example `@@-##-$$$`	none
»»» valueLength	string	whether this field needs to support a large number of characters	none
»»» values	[string]	a list of possible values when the field is a selection field	none
»»» viewRights	UsageRightsApiV1	none	none
»» customFieldID	string	none	none
»» customFieldKey	string	none	none
»» customFieldSetGroupIndex	number	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» indexInList	number	none	none
»» linkedEntityKeyValue	string	none	none
»» parentKey	string	none	none
»» selectionKey	string	none	none
»» value	string	none	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» expireDate	string	none	none
» exposureLimitType	string	none	none
» groupKey	string	none	none
» id	string	none	none
» idPattern	string	none	none
» lastModifiedDate	string	the date on which this line of credit was last modified	none
» notes	string	none	none
» startDate	string	none	none
» state	string	none	none
» subState	string	none	none

Enumerated Values

Property	Value
builtInCustomFieldId	`MOBILE_PHONE`
builtInCustomFieldId	`EMAIL_ADDRESS`
builtInCustomFieldId	`GENDER`
builtInCustomFieldId	`MIDDLE_NAME`
builtInCustomFieldId	`HOME_PHONE`
builtInCustomFieldId	`BIRTHDATE`
builtInCustomFieldId	`LAST_NAME`
builtInCustomFieldId	`FIRST_NAME`
linkType	`CLIENT_ROLE`
linkType	`CHANNEL`
linkType	`PRODUCT`
dataFieldType	`NATIVE`
dataFieldType	`CUSTOM`
dataItemType	`WRITTEN_OFF_LOANS`
dataItemType	`LINE_OF_CREDIT`
dataItemType	`INVESTOR_FUND`
dataItemType	`TRANSACTION_DETAILS`
dataItemType	`DOCUMENT_TEMPLATE`
dataItemType	`PRODUCT`
dataItemType	`MCC_EXPIRATION`
dataItemType	`CENTRE`
dataItemType	`REPAYMENT_COLLECTION`
dataItemType	`TASK`
dataItemType	`OUTSTANDING_PORTFOLIO_AMOUNTS`
dataItemType	`REVENUE`
dataItemType	`COMPOSED_TRANSACTIONS`
dataItemType	`UNION_TRANSACTIONS`
dataItemType	`PRINCIPAL_PAYMENT_SETTINGS`
dataItemType	`LOANS`
dataItemType	`DISBURSEMENT_DETAILS`
dataItemType	`SAVINGS_TRANSACTION`
dataItemType	`IDENTIFICATION_DOCUMENT`
dataItemType	`LOAN_PRODUCT`
dataItemType	`DISBURSED_LOANS`
dataItemType	`LOAN_GROUP`
dataItemType	`TRANSACTION_CHANNEL`
dataItemType	`CUSTOM_PREDEFINED_FEE`
dataItemType	`JOURNAL_ENTRY`
dataItemType	`ATTACHMENT`
dataItemType	`PREDEFINED_FEE`
dataItemType	`TRANCHE`
dataItemType	`TRANSACTION`
dataItemType	`INDEX_RATE_SOURCE`
dataItemType	`GROUP_ROLE`
dataItemType	`LOAN_TRANSACTION`
dataItemType	`CLIENT_ROLE`
dataItemType	`GROUP`
dataItemType	`NOTIFICATION_MESSAGE`
dataItemType	`OUTSTANDING_PORTFOLIO_ACCOUNTS`
dataItemType	`REPAYMENT`
dataItemType	`LOAN_ACCOUNT_GUARANTY`
dataItemType	`BRANCH`
dataItemType	`CURRENCY`
dataItemType	`CARD_TRANSACTION_REVERSAL`
dataItemType	`INTEREST_PRODUCT_SETTINGS`
dataItemType	`CREATED_ACCOUNTS`
dataItemType	`USER`
dataItemType	`SAVINGS_PRODUCT`
dataItemType	`CLIENT`
dataItemType	`PRODUCT_ARREARS_SETTINGS`
dataItemType	`SAVINGS`
dataItemType	`EXPENSE`
dataItemType	`INDEX_RATE`
dataItemType	`NOTIFICATION_TEMPLATE`
dataItemType	`CUSTOM_FIELD_SELECTION`
dataItemType	`ACTIVITY`
dataType	`ENUM`
dataType	`MONEY`
dataType	`NUMBER`
dataType	`DATE_UTC`
dataType	`JAVA_BLOB`
dataType	`OBJECT`
dataType	`BOOLEAN`
dataType	`DATE`
dataType	`PERCENT`
dataType	`BIG_DECIMAL`
dataType	`STRING`
dataType	`KEY`
dataType	`LONG`
filterElement	`STARTS_WITH_CASE_SENSITIVE`
filterElement	`THIS_WEEK`
filterElement	`EQUALS`
filterElement	`STARTS_WITH`
filterElement	`IN`
filterElement	`TODAY`
filterElement	`THIS_YEAR`
filterElement	`BETWEEN`
filterElement	`AFTER`
filterElement	`LESS_THAN`
filterElement	`DIFFERENT_THAN`
filterElement	`THIS_MONTH`
filterElement	`NOT_EMPTY`
filterElement	`BEFORE`
filterElement	`EQUALS_CASE_SENSITIVE`
filterElement	`LAST_DAYS`
filterElement	`MORE_THAN`
filterElement	`EMPTY`
filterElement	`ON`
linkingOperator	`OR`
linkingOperator	`AND`
builtInType	`DETAILS`
builtInType	`GENERAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
usage	`SINGLE`
usage	`GROUPED`
dataType	`GROUP_LINK`
dataType	`DATE`
dataType	`NUMBER`
dataType	`CHECKBOX`
dataType	`CLIENT_LINK`
dataType	`STRING`
dataType	`USER_LINK`
dataType	`SELECTION`
state	`DEACTIVATED`
state	`NORMAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
valueLength	`SHORT`
valueLength	`LONG`
exposureLimitType	`APPROVED_AMOUNT`
exposureLimitType	`OUTSTANDING_AMOUNT`
state	`WITHDRAWN`
state	`PENDING_APPROVAL`
state	`ACTIVE`
state	`CLOSED`
state	`APPROVED`
state	`REJECTED`
subState	`WITHDRAWN`
subState	`PENDING_APPROVAL`
subState	`ACTIVE`
subState	`CLOSED`
subState	`APPROVED`
subState	`REJECTED`

Get Line of Credit by ID

GET /linesofcredit/{lineOfCreditId}

Get single Line of Credit

Get a line of credit by ID.

Example Requests

Get a single line of credit with Full Details

GET /api/linesofcredit/ID001?fullDetails=true

Parameters

Name	Type	Description	In
fullDetails	boolean	none	query
lineOfCreditId (required)	string	The ID of the Line of Credit	path

Example Responses

200 : ok
Line of credit with full details

{
  "encodedKey": "402880b858d95c8e0158d95f0379048a",
  "id": "QCE677",
  "clientKey": "402880b858d95c8e0158d95ce07b00f3",
  "startDate": "2016-12-01T00:00:00+0000",
  "expireDate": "2016-12-30T00:00:00+0000",
  "creationDate": "2016-12-07T13:01:36+0000",
  "lastModifiedDate": "2016-12-07T13:01:36+0000",
  "state": "ACTIVE",
  "amount": "1000",
  "notes": "",
  "availableCreditAmount": "1000",
  "customInformation": [
    {
      "encodedKey": "402880b858d95c8e0158d95f0379048b",
      "parentKey": "402880b858d95c8e0158d95f0379048a",
      "customFieldKey": "402880b858d95c8e0158d95dd4a40484",
      "customField": {
        "encodedKey": "402880b858d95c8e0158d95dd4a40484",
        "id": "loccf2",
        "creationDate": "2016-12-07T13:00:01+0000",
        "lastModifiedDate": "2016-12-07T13:00:01+0000",
        "name": "LoC CF Req",
        "type": "LINE_OF_CREDIT",
        "dataType": "STRING",
        "valueLength": "SHORT",
        "isDefault": true,
        "isRequired": true,
        "description": "",
        "customFieldSet": {
          "encodedKey": "402880b858d95c8e0158d95cfe4b0480",
          "name": "LoC CF Set",
          "notes": "",
          "createdDate": "2016-12-07T12:58:39+0000",
          "indexInList": 0,
          "type": "LINE_OF_CREDIT",
          "usage": "SINGLE"
        },
        "indexInList": 1,
        "state": "NORMAL",
        "customFieldSelectionOptions": [],
        "viewRights": {
          "encodedKey": "402880b858d95c8e0158d95dd4a40485",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "editRights": {
          "encodedKey": "402880b858d95c8e0158d95dd4a40486",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "unique": false,
        "values": [],
        "amounts": {}
      },
      "value": "asd",
      "indexInList": -1,
      "customFieldID": "loccf2",
      "customFieldSetGroupIndex": -1
    },
    {
      "encodedKey": "402880b858d95c8e0158d95f0379048c",
      "parentKey": "402880b858d95c8e0158d95f0379048a",
      "customFieldKey": "402880b858d95c8e0158d95cfe4b0481",
      "customField": {
        "encodedKey": "402880b858d95c8e0158d95cfe4b0481",
        "id": "loccf1",
        "creationDate": "2016-12-07T12:59:15+0000",
        "lastModifiedDate": "2016-12-07T14:48:17+0000",
        "name": "LoC CF",
        "type": "LINE_OF_CREDIT",
        "dataType": "STRING",
        "valueLength": "SHORT",
        "isDefault": false,
        "isRequired": false,
        "description": "",
        "customFieldSet": {
          "encodedKey": "402880b858d95c8e0158d95cfe4b0480",
          "name": "LoC CF Set",
          "notes": "",
          "createdDate": "2016-12-07T12:58:39+0000",
          "indexInList": 0,
          "type": "LINE_OF_CREDIT",
          "usage": "SINGLE"
        },
        "indexInList": 0,
        "state": "NORMAL",
        "customFieldSelectionOptions": [],
        "viewRights": {
          "encodedKey": "402880b858d95c8e0158d95cfe4b0482",
          "isAccessibleByAllUsers": true,
          "roles": []
        },
        "editRights": {
          "encodedKey": "402880b858d95c8e0158d95dd4a40483",
          "isAccessibleByAllUsers": true,
          "roles": []
        },
        "unique": false,
        "values": [],
        "amounts": {}
      },
      "value": "123",
      "indexInList": -1,
      "customFieldID": "loccf1",
      "customFieldSetGroupIndex": -1
    },
    {
      "encodedKey": "402880b858d95c8e0158d95ffb37048d",
      "parentKey": "402880b858d95c8e0158d95f0379048a",
      "customFieldKey": "402880b858d95c8e0158d95dd4a40487",
      "customField": {
        "encodedKey": "402880b858d95c8e0158d95dd4a40487",
        "id": "loccf3",
        "creationDate": "2016-12-07T13:00:33+0000",
        "lastModifiedDate": "2016-12-07T14:50:51+0000",
        "name": "LoC CF Role View",
        "type": "LINE_OF_CREDIT",
        "dataType": "STRING",
        "valueLength": "SHORT",
        "isDefault": true,
        "isRequired": false,
        "description": "",
        "customFieldSet": {
          "encodedKey": "402880b858d95c8e0158d95cfe4b0480",
          "name": "LoC CF Set",
          "notes": "",
          "createdDate": "2016-12-07T12:58:39+0000",
          "indexInList": 0,
          "type": "LINE_OF_CREDIT",
          "usage": "SINGLE"
        },
        "indexInList": 2,
        "state": "NORMAL",
        "customFieldSelectionOptions": [],
        "viewRights": {
          "encodedKey": "402880b858d95c8e0158d95f03790488",
          "isAccessibleByAllUsers": true,
          "roles": []
        },
        "editRights": {
          "encodedKey": "402880b858d95c8e0158d95f03790489",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "unique": false,
        "values": [],
        "amounts": {}
      },
      "value": "role",
      "indexInList": -1,
      "customFieldID": "loccf3",
      "customFieldSetGroupIndex": -1
    }
  ]
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	LineOfCreditFullApiV1

Update Line of Credit

PATCH /linesofcredit/{lineOfCreditId}

Update existing Line of Credit

Update an existing line of credit

Example Requests

Update a line of credit

{
  "lineOfCredit": {
    "id": "string",
    "clientKey": "string",
    "groupKey": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "expireDate": "2019-08-24T14:15:22Z",
    "amount": "string",
    "notes": "string",
    "customInformation": [
      {
        "customFieldID": "string",
        "value": "string"
      }
    ],
    "exposureLimitType": "OUTSTANDING_AMOUNT"
  }
}

Parameters

Name	Type	Description	In
body	CreateLineOfCreditApiV1	none	body
lineOfCreditId (required)	string	The ID of the Line of Credit	path

Example Responses

200 : ok
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
Bad ID

{
  "returnCode": 1409,
  "returnStatus": "INVALID_LINE_OF_CREDIT_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	ExecutionStatusApiV1
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Get Accounts under Line of Credit

GET /linesofcredit/{lineOfCreditId}/accounts

Get Accounts under a line of credit

Get accounts which are under a given line of credit

Parameters

Name	Type	Description	In
lineOfCreditId (required)	string	none	path

Example Responses

200 Response

{
  "loanAccounts": [
    {
      "accountArrearsSettings": {
        "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
        "encodedKey": "string",
        "monthlyToleranceDay": 0,
        "nonWorkingDaysMethod": "EXCLUDED",
        "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY",
        "toleranceFloorAmount": 0,
        "tolerancePercentageOfOutstandingPrincipal": 0,
        "tolerancePeriod": 0
      },
      "accountHolderKey": "string",
      "accountHolderType": "GROUP",
      "accountState": "WITHDRAWN",
      "accountSubState": "WITHDRAWN",
      "accrueInterestAfterMaturity": true,
      "accrueLateInterest": true,
      "accruedInterest": 0,
      "accruedPenalty": 0,
      "activationTransactionKey": "string",
      "allowOffset": true,
      "applyInterestOnPrepaymentMethod": "AUTOMATIC",
      "approvedDate": "string",
      "arrearsTolerancePeriod": 0,
      "assignedBranchKey": "string",
      "assignedCentreKey": "string",
      "assignedUserKey": "string",
      "closedDate": "string",
      "creationDate": "string",
      "customFieldValues": [
        {
          "amount": 0,
          "customField": {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "customFieldID": "string",
          "customFieldKey": "string",
          "customFieldSetGroupIndex": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "linkedEntityKeyValue": "string",
          "parentKey": "string",
          "selectionKey": "string",
          "value": "string"
        }
      ],
      "daysInArrears": 0,
      "defaultFirstRepaymentDueDateOffset": 0,
      "disbursementDetails": {
        "customInformation": [
          {
            "amount": 0,
            "customField": {
              "amounts": {
                "property1": 0,
                "property2": 0
              },
              "builtInCustomFieldId": "MOBILE_PHONE",
              "creationDate": "string",
              "customFieldProductSettings": [
                {
                  "customFieldEncodedKey": "string",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isDefault": true,
                  "isRequired": true,
                  "linkType": "CLIENT_ROLE",
                  "productKey": "string"
                }
              ],
              "customFieldSelectionOptions": [
                {
                  "constraint": {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "score": 0,
                  "value": "string"
                }
              ],
              "customFieldSet": {
                "builtInType": "DETAILS",
                "createdDate": "string",
                "customFields": [
                  {}
                ],
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "notes": "string",
                "type": "USER_INFO",
                "usage": "SINGLE"
              },
              "dataType": "GROUP_LINK",
              "description": "string",
              "editRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "isDefault": true,
              "isRequired": true,
              "lastModifiedDate": "string",
              "name": "string",
              "state": "DEACTIVATED",
              "type": "USER_INFO",
              "unique": true,
              "validationPattern": "string",
              "valueLength": "SHORT",
              "values": [
                "string"
              ],
              "viewRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "customFieldID": "string",
            "customFieldKey": "string",
            "customFieldSetGroupIndex": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "linkedEntityKeyValue": "string",
            "parentKey": "string",
            "selectionKey": "string",
            "value": "string"
          }
        ],
        "disbursementDate": "string",
        "encodedKey": "string",
        "expectedDisbursementDate": "string",
        "fees": [
          {
            "amount": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "fee": {
              "active": true,
              "amortizationIntervalSettings": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
                "intervalCount": 0,
                "intervalType": "FULL_TERM",
                "periodCount": 0,
                "periodUnit": "MONTHS"
              },
              "amortizationProfile": "STRAIGHT_LINE",
              "amount": 0,
              "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
              "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
              "creationDate": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
              "feeApplication": "OPTIONAL",
              "feeProductRules": [
                {
                  "account": {
                    "activated": true,
                    "allowManualJournalEntries": true,
                    "balance": 0,
                    "creationDate": "2019-08-24T14:15:22Z",
                    "currency": {},
                    "description": "string",
                    "encodedKey": "string",
                    "glCode": "string",
                    "lastModifiedDate": "2019-08-24T14:15:22Z",
                    "migrationEvent": {},
                    "name": "string",
                    "stripTrailingZeros": true,
                    "type": "INCOME",
                    "usage": "HEADER"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "financialResource": "FEE_RECEIVABLE",
                  "index": 0,
                  "predefinedFeeKey": "string",
                  "productKey": "string",
                  "productType": "LOAN",
                  "transactionChannelKey": "string"
                }
              ],
              "name": "string",
              "percentageAmount": 0,
              "trigger": "DISBURSEMENT"
            }
          }
        ],
        "firstRepaymentDate": "string",
        "transactionDetails": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "internalTransfer": true,
          "targetSavingsAccountKey": "string",
          "transactionChannel": {
            "activated": true,
            "createdByUserKey": "string",
            "creationDate": "string",
            "customFields": [
              {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              }
            ],
            "encodedKey": "string",
            "id": "string",
            "index": 0,
            "loanConstraints": {
              "customConfigurationInfo": {
                "creationDate": "string",
                "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "shared": true,
                "userKey": "string"
              },
              "encodedKey": "string",
              "filterConstraints": [
                {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                }
              ]
            },
            "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
            "name": "string",
            "savingsConstraints": {
              "customConfigurationInfo": {
                "creationDate": "string",
                "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "shared": true,
                "userKey": "string"
              },
              "encodedKey": "string",
              "filterConstraints": [
                {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                }
              ]
            },
            "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
            "transactionChannelAccountingRule": {
              "account": {
                "activated": true,
                "allowManualJournalEntries": true,
                "balance": 0,
                "creationDate": "2019-08-24T14:15:22Z",
                "currency": {
                  "code": "string",
                  "creationDate": "string",
                  "currencySymbolPosition": "AFTER_NUMBER",
                  "digitsAfterDecimal": 0,
                  "isBaseCurrency": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "symbol": "string"
                },
                "description": "string",
                "encodedKey": "string",
                "glCode": "string",
                "lastModifiedDate": "2019-08-24T14:15:22Z",
                "migrationEvent": {
                  "creationDate": "2019-08-24T14:15:22Z",
                  "encodedKey": "string",
                  "numCentresImported": 0,
                  "numClientsImported": 0,
                  "numGLAccountsImported": 0,
                  "numGroupsImported": 0,
                  "numLoanRepaymentsImported": 0,
                  "numLoanTransactionsImported": 0,
                  "numLoansImported": 0,
                  "numSavingsImported": 0,
                  "state": "REVERTED",
                  "type": "IMPORT"
                },
                "name": "string",
                "stripTrailingZeros": true,
                "type": "INCOME",
                "usage": "HEADER"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "financialResource": "FEE_RECEIVABLE",
              "index": 0,
              "predefinedFeeKey": "string",
              "productKey": "string",
              "productType": "LOAN",
              "transactionChannelKey": "string"
            },
            "usageRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "transactionChannelKey": "string"
        }
      },
      "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "feesBalance": 0,
      "feesDue": 0,
      "feesPaid": 0,
      "fixedDaysOfMonth": [
        0
      ],
      "funds": [
        {
          "amount": 0,
          "assetName": "string",
          "customFieldValues": [
            {
              "amount": 0,
              "customField": {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              },
              "customFieldID": "string",
              "customFieldKey": "string",
              "customFieldSetGroupIndex": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "linkedEntityKeyValue": "string",
              "parentKey": "string",
              "selectionKey": "string",
              "value": "string"
            }
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "guarantorKey": "string",
          "guarantorType": "GROUP",
          "id": "string",
          "interestCommission": 0,
          "investmentPercentage": 0,
          "savingsAccountKey": "string",
          "type": "GUARANTOR"
        }
      ],
      "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
      "gracePeriod": 0,
      "gracePeriodType": "PAY_INTEREST_ONLY",
      "guarantees": [
        {
          "amount": 0,
          "assetName": "string",
          "customFieldValues": [
            {
              "amount": 0,
              "customField": {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              },
              "customFieldID": "string",
              "customFieldKey": "string",
              "customFieldSetGroupIndex": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "linkedEntityKeyValue": "string",
              "parentKey": "string",
              "selectionKey": "string",
              "value": "string"
            }
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "guarantorKey": "string",
          "guarantorType": "GROUP",
          "savingsAccountKey": "string",
          "type": "GUARANTOR"
        }
      ],
      "hasCustomSchedule": true,
      "holdBalance": 0,
      "id": "string",
      "interestApplicationMethod": "ON_REPAYMENT",
      "interestBalance": 0,
      "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
      "interestCalculationMethod": "DECLINING_BALANCE",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestCommission": 0,
      "interestDue": 0,
      "interestFromArrearsAccrued": 0,
      "interestFromArrearsBalance": 0,
      "interestFromArrearsDue": 0,
      "interestFromArrearsPaid": 0,
      "interestPaid": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRoundingVersion": "VERSION_2",
      "interestSpread": 0,
      "interestType": "CAPITALIZED_INTEREST",
      "lastAccountAppraisalDate": "string",
      "lastInterestAppliedDate": "string",
      "lastInterestReviewDate": "string",
      "lastLockedDate": "string",
      "lastModifiedDate": "string",
      "lastSetToArrearsDate": "string",
      "lastTaxRateReviewDate": "string",
      "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
      "lineOfCreditKey": "string",
      "loanAmount": 0,
      "loanGroup": {
        "accounts": [
          {}
        ],
        "creationDate": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "group": {
          "assignedBranchKey": "string",
          "assignedCentreKey": "string",
          "assignedUserKey": "string",
          "clientRole": {
            "encodedKey": "string"
          },
          "creationDate": "2019-08-24T14:15:22Z",
          "emailAddress": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "groupName": "string",
          "homePhone": "string",
          "id": "string",
          "idPattern": "string",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "loanCycle": 0,
          "migrationEvent": {
            "creationDate": "2019-08-24T14:15:22Z",
            "encodedKey": "string",
            "numCentresImported": 0,
            "numClientsImported": 0,
            "numGLAccountsImported": 0,
            "numGroupsImported": 0,
            "numLoanRepaymentsImported": 0,
            "numLoanTransactionsImported": 0,
            "numLoansImported": 0,
            "numSavingsImported": 0,
            "state": "REVERTED",
            "type": "IMPORT"
          },
          "mobilePhone1": "string",
          "preferredLanguage": "PORTUGESE"
        },
        "lastModifiedDate": "string",
        "name": "string",
        "notes": "string"
      },
      "loanName": "string",
      "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
      "lockedOperations": [
        "APPLY_FEES"
      ],
      "migrationEvent": {
        "creationDate": "2019-08-24T14:15:22Z",
        "encodedKey": "string",
        "numCentresImported": 0,
        "numClientsImported": 0,
        "numGLAccountsImported": 0,
        "numGroupsImported": 0,
        "numLoanRepaymentsImported": 0,
        "numLoanTransactionsImported": 0,
        "numLoansImported": 0,
        "numSavingsImported": 0,
        "state": "REVERTED",
        "type": "IMPORT"
      },
      "notes": "string",
      "originalAccountKey": "string",
      "paymentMethod": "VERTICAL",
      "paymentPlan": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingInstallmentPosition": 0,
          "index": 0,
          "loanAccountEncodedKey": "string",
          "pmt": 0
        }
      ],
      "penaltyBalance": 0,
      "penaltyDue": 0,
      "penaltyPaid": 0,
      "penaltyRate": 0,
      "periodicPayment": 0,
      "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
      "prepaymentRecalculationMethod": "NO_RECALCULATION",
      "principalBalance": 0,
      "principalDue": 0,
      "principalPaid": 0,
      "principalPaidInstallmentStatus": "PARTIALLY_PAID",
      "principalPaymentSettings": {
        "amount": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "includeFeesInFloorAmount": true,
        "includeInterestInFloorAmount": true,
        "percentage": 0,
        "principalCeilingValue": 0,
        "principalFloorValue": 0,
        "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
      },
      "principalRepaymentInterval": 0,
      "productTypeKey": "string",
      "redrawBalance": 0,
      "redrawSettings": {
        "account": {},
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "restrictNextDueWithdrawal": true
      },
      "repaymentInstallments": 0,
      "repaymentPeriodCount": 0,
      "repaymentPeriodUnit": "MONTHS",
      "repaymentScheduleMethod": "FIXED",
      "rescheduledAccountKey": "string",
      "scheduleDueDatesMethod": "INTERVAL",
      "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
      "taxRate": 0,
      "tranches": [
        {
          "amount": 0,
          "disbursementTransactionKey": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "expectedDisbursementDate": "string",
          "index": 0
        }
      ]
    }
  ],
  "savingsAccounts": [
    {
      "accountHolderKey": "string",
      "accountHolderType": "GROUP",
      "accountState": "WITHDRAWN",
      "accountType": "CURRENT_ACCOUNT",
      "accruedInterest": 0,
      "activationDate": "string",
      "allowOverdraft": true,
      "approvedDate": "string",
      "assignedBranchKey": "string",
      "assignedCentreKey": "string",
      "assignedUserKey": "string",
      "availableBalance": 0,
      "balance": 0,
      "closedDate": "string",
      "creationDate": "string",
      "currency": {
        "code": "string",
        "creationDate": "string",
        "currencySymbolPosition": "AFTER_NUMBER",
        "digitsAfterDecimal": 0,
        "isBaseCurrency": true,
        "lastModifiedDate": "string",
        "name": "string",
        "symbol": "string"
      },
      "currencyCode": "string",
      "customFieldValues": [
        {
          "amount": 0,
          "customField": {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "customFieldID": "string",
          "customFieldKey": "string",
          "customFieldSetGroupIndex": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "linkedEntityKeyValue": "string",
          "parentKey": "string",
          "selectionKey": "string",
          "value": "string"
        }
      ],
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "feesDue": 0,
      "holdBalance": 0,
      "id": "string",
      "interestDue": 0,
      "interestPaymentDates": [
        {
          "dayOfMonth": 0,
          "monthOfYear": 0,
          "year": 0
        }
      ],
      "interestPaymentPoint": "EVERY_WEEK",
      "interestSettings": {
        "accrueInterestAfterMaturity": true,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "interestChargeFrequency": "EVERY_WEEK",
        "interestChargeFrequencyCount": 0,
        "interestRate": 0,
        "interestRateReviewCount": 0,
        "interestRateReviewUnit": "MONTHS",
        "interestRateSource": "FIXED_INTEREST_RATE",
        "interestRateTerms": "TIERED_PERIOD",
        "interestRateTiers": [
          {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "endingBalance": 0,
            "endingDay": 0,
            "index": 0,
            "interestRate": 0
          }
        ],
        "interestSpread": 0
      },
      "lastAccountAppraisalDate": "string",
      "lastInterestCalculationDate": "string",
      "lastInterestStoredDate": "string",
      "lastModifiedDate": "string",
      "lastOverdraftInterestReviewDate": "string",
      "lastSetToArrearsDate": "string",
      "lineOfCreditKey": "string",
      "lockedBalance": 0,
      "lockedDate": "string",
      "maturityDate": "string",
      "maxWidthdrawlAmount": 0,
      "migrationEvent": {
        "creationDate": "2019-08-24T14:15:22Z",
        "encodedKey": "string",
        "numCentresImported": 0,
        "numClientsImported": 0,
        "numGLAccountsImported": 0,
        "numGroupsImported": 0,
        "numLoanRepaymentsImported": 0,
        "numLoanTransactionsImported": 0,
        "numLoansImported": 0,
        "numSavingsImported": 0,
        "state": "REVERTED",
        "type": "IMPORT"
      },
      "name": "string",
      "notes": "string",
      "overdraftAmount": 0,
      "overdraftExpiryDate": "string",
      "overdraftExpiryDateDTO": {
        "dayOfMonth": 0,
        "monthOfYear": 0,
        "year": 0
      },
      "overdraftInterestAccrued": 0,
      "overdraftInterestSettings": {
        "accrueInterestAfterMaturity": true,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "interestChargeFrequency": "EVERY_WEEK",
        "interestChargeFrequencyCount": 0,
        "interestRate": 0,
        "interestRateReviewCount": 0,
        "interestRateReviewUnit": "MONTHS",
        "interestRateSource": "FIXED_INTEREST_RATE",
        "interestRateTerms": "TIERED_PERIOD",
        "interestRateTiers": [
          {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "endingBalance": 0,
            "endingDay": 0,
            "index": 0,
            "interestRate": 0
          }
        ],
        "interestSpread": 0
      },
      "overdraftLimit": 0,
      "productTypeKey": "string",
      "recommendedDepositAmount": 0,
      "targetAmount": 0,
      "technicalInterestDue": 0,
      "technicalOverdraftAmount": 0,
      "technicalOverdraftInterestAccrued": 0,
      "withholdingTaxSourceKey": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	AccountsFromLineOfCreditApiV1

Update Line of Credit Custom Information

PATCH /linesofcredit/{lineOfCreditId}/custominformation

Modify custom information for a line of credit

Update custom information for a line of credit

Example Requests

Update a single custom field value

{
  "customInformation": [
    {
      "customFieldID": "custom_field_2",
      "value": "3"
    }
  ]
}

Update a field in a group

{
  "customInformation": [
    {
      "customFieldID": "cf_grouped_field",
      "value": "new value",
      "customFieldSetGroupIndex": "0"
    }
  ]
}

Update multiple custom field values

{
  "customInformation": [
    {
      "customFieldID": "example_custom_field",
      "customFieldSetGroupIndex": 0,
      "value": "New Value"
    },
    {
      "customFieldID": "custom_number",
      "customFieldSetGroupIndex": 1,
      "value": "42"
    }
  ]
}

Parameters

Name	Type	Description	In
lineOfCreditId (required)	string	none	path
body	UpdateCustomInformationRequest	none	body

Example Responses

200 Response

{
  "errorSource": "string",
  "returnCode": 0,
  "returnStatus": "string"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	ExecutionStatusApiV1

Delete Line of Credit Custom Field Value

DELETE /linesofcredit/{lineOfCreditId}/custominformation/{customFieldId}

Delete custom field value for a line of credit

Delete custom information for a given field and line of credit

Parameters

Name	Type	Description	In
lineOfCreditId (required)	string	none	path
customFieldId (required)	string	none	path

Example Responses

200 Response

{
  "errorSource": "string",
  "returnCode": 0,
  "returnStatus": "string"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	ExecutionStatusApiV1

Get Line of Credit Custom Field Definition Info

GET /linesofcredit/{lineOfCreditId}/custominformation/{customFieldId}

Get custom information for a line of credit

Get custom info for a given line of credit custom field definition

Parameters

Name	Type	Description	In
lineOfCreditId (required)	string	none	path
customFieldId (required)	string	none	path

Example Responses

200 Response

[
  {
    "amount": 0,
    "customField": {
      "amounts": {
        "property1": 0,
        "property2": 0
      },
      "builtInCustomFieldId": "MOBILE_PHONE",
      "creationDate": "string",
      "customFieldProductSettings": [
        {
          "customFieldEncodedKey": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isDefault": true,
          "isRequired": true,
          "linkType": "CLIENT_ROLE",
          "productKey": "string"
        }
      ],
      "customFieldSelectionOptions": [
        {
          "constraint": {
            "customFieldKey": "string",
            "dataFieldType": "NATIVE",
            "dataFieldValue": "string",
            "dataItemType": "WRITTEN_OFF_LOANS",
            "dataType": "ENUM",
            "encodedKey": "string",
            "filterElement": "STARTS_WITH_CASE_SENSITIVE",
            "groupNumber": 0,
            "index": 0,
            "linkingOperator": "OR",
            "secondValue": "string",
            "value": "string"
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "score": 0,
          "value": "string"
        }
      ],
      "customFieldSet": {
        "builtInType": "DETAILS",
        "createdDate": "string",
        "customFields": [
          {}
        ],
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "lastModifiedDate": "string",
        "name": "string",
        "notes": "string",
        "type": "USER_INFO",
        "usage": "SINGLE"
      },
      "dataType": "GROUP_LINK",
      "description": "string",
      "editRights": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "isAccessibleByAllUsers": true,
        "roles": [
          "string"
        ]
      },
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "id": "string",
      "indexInList": 0,
      "isDefault": true,
      "isRequired": true,
      "lastModifiedDate": "string",
      "name": "string",
      "state": "DEACTIVATED",
      "type": "USER_INFO",
      "unique": true,
      "validationPattern": "string",
      "valueLength": "SHORT",
      "values": [
        "string"
      ],
      "viewRights": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "isAccessibleByAllUsers": true,
        "roles": [
          "string"
        ]
      }
    },
    "customFieldID": "string",
    "customFieldKey": "string",
    "customFieldSetGroupIndex": 0,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "indexInList": 0,
    "linkedEntityKeyValue": "string",
    "parentKey": "string",
    "selectionKey": "string",
    "value": "string"
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[CustomFieldValueApiV1]	none	none
» amount	number	none	none
» customField	CustomFieldApiV1	none	none
»» amounts	object	used when options available for a custom field definition translate to predefined amounts, for example, when the custom field value is used to generate a score	none
»»» additionalProperties	number	none	none
»» builtInCustomFieldId	string	if this field is one of the built in custom fiel definitions, this will have a value. These names are reserved and you can not use them for your own custom field definitions	none
»» creationDate	string	the date on which this custom field definition was created	none
»» customFieldProductSettings	[CustomFieldLinkApiV1]	none	none
»»» customFieldEncodedKey	string	the key to the parent custom field definition	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» isDefault	boolean	whether this field is displayed by default when creating a new record	none
»»» isRequired	boolean	whether this field is required when creating a new record	none
»»» linkType	string	the type of entity this field represents a link to	none
»»» productKey	string	when the link type is product, this field should contain the encoded key of the linekd product	none
»» customFieldSelectionOptions	[CustomFieldSelectionApiV1]	[represents a possible selection for select type custom field definitions]	none
»»» constraint	CustomFilterConstraintApiV1	none	none
»»»» customFieldKey	string	none	none
»»»» dataFieldType	string	none	none
»»»» dataFieldValue	string	none	none
»»»» dataItemType	string	none	none
»»»» dataType	string	none	none
»»»» encodedKey	string	none	none
»»»» filterElement	string	none	none
»»»» groupNumber	number	none	none
»»»» index	number	none	none
»»»» linkingOperator	string	none	none
»»»» secondValue	string	none	none
»»»» value	string	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» id	string	the ID of this selectable item	none
»»» score	number	the score assigned to this selection	none
»»» value	string	display name of this option	none
»» customFieldSet	CustomFieldSetApiV1	none	none
»»» builtInType	string	if this set is part of the set of built-in custom field sets, its type will be shown here	none
»»» createdDate	string	the date and time when this custom field set was created	none
»»» customFields	[CustomFieldApiV1]	an array of custom field definitions included in this custom field set	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» id	string	the ID of this custom field set	none
»»» indexInList	number	for field sets that can be added to an entity more than once, this number represents the index in the list and is used when changing values	none
»»» lastModifiedDate	string	the date on which this custom field set was last modified	none
»»» name	string	the name of this custom field set	none
»»» notes	string	any notes regarding this custom field set	none
»»» type	string	the entity type that this custom field definition is attached to	none
»»» usage	string	whether this custom field set can only be used once, or added multiple times to the same entity	none
»» dataType	string	the type of custom field definition	none
»» description	string	a brief description of this custom field definition	none
»» editRights	UsageRightsApiV1	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» isAccessibleByAllUsers	boolean	none	none
»»» roles	[string]	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» id	string	the ID for this custom field definition	none
»» indexInList	number	none	none
»» isDefault	boolean	whether this field will be included by default on new records	none
»» isRequired	boolean	whether this field is required when creating a new record	none
»» lastModifiedDate	string	the date on which this custom field definition was last modified	none
»» name	string	the name of this custom field definition	none
»» state	string	whether this field is available for use or has been deactivated	none
»» type	string	the type of data this custom field definition will contain	none
»» unique	boolean	whether the data in this custom field definition needs to be a unique value	none
»» validationPattern	string	a user-provided pattern to which data in this custom field definition must conform where @ represents numbers, # represents letters and $ is either a number or letter. Other special characters used as separators are allowed, for example `@@-##-$$$`	none
»» valueLength	string	whether this field needs to support a large number of characters	none
»» values	[string]	a list of possible values when the field is a selection field	none
»» viewRights	UsageRightsApiV1	none	none
» customFieldID	string	none	none
» customFieldKey	string	none	none
» customFieldSetGroupIndex	number	none	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» indexInList	number	none	none
» linkedEntityKeyValue	string	none	none
» parentKey	string	none	none
» selectionKey	string	none	none
» value	string	none	none

Enumerated Values

Property	Value
builtInCustomFieldId	`MOBILE_PHONE`
builtInCustomFieldId	`EMAIL_ADDRESS`
builtInCustomFieldId	`GENDER`
builtInCustomFieldId	`MIDDLE_NAME`
builtInCustomFieldId	`HOME_PHONE`
builtInCustomFieldId	`BIRTHDATE`
builtInCustomFieldId	`LAST_NAME`
builtInCustomFieldId	`FIRST_NAME`
linkType	`CLIENT_ROLE`
linkType	`CHANNEL`
linkType	`PRODUCT`
dataFieldType	`NATIVE`
dataFieldType	`CUSTOM`
dataItemType	`WRITTEN_OFF_LOANS`
dataItemType	`LINE_OF_CREDIT`
dataItemType	`INVESTOR_FUND`
dataItemType	`TRANSACTION_DETAILS`
dataItemType	`DOCUMENT_TEMPLATE`
dataItemType	`PRODUCT`
dataItemType	`MCC_EXPIRATION`
dataItemType	`CENTRE`
dataItemType	`REPAYMENT_COLLECTION`
dataItemType	`TASK`
dataItemType	`OUTSTANDING_PORTFOLIO_AMOUNTS`
dataItemType	`REVENUE`
dataItemType	`COMPOSED_TRANSACTIONS`
dataItemType	`UNION_TRANSACTIONS`
dataItemType	`PRINCIPAL_PAYMENT_SETTINGS`
dataItemType	`LOANS`
dataItemType	`DISBURSEMENT_DETAILS`
dataItemType	`SAVINGS_TRANSACTION`
dataItemType	`IDENTIFICATION_DOCUMENT`
dataItemType	`LOAN_PRODUCT`
dataItemType	`DISBURSED_LOANS`
dataItemType	`LOAN_GROUP`
dataItemType	`TRANSACTION_CHANNEL`
dataItemType	`CUSTOM_PREDEFINED_FEE`
dataItemType	`JOURNAL_ENTRY`
dataItemType	`ATTACHMENT`
dataItemType	`PREDEFINED_FEE`
dataItemType	`TRANCHE`
dataItemType	`TRANSACTION`
dataItemType	`INDEX_RATE_SOURCE`
dataItemType	`GROUP_ROLE`
dataItemType	`LOAN_TRANSACTION`
dataItemType	`CLIENT_ROLE`
dataItemType	`GROUP`
dataItemType	`NOTIFICATION_MESSAGE`
dataItemType	`OUTSTANDING_PORTFOLIO_ACCOUNTS`
dataItemType	`REPAYMENT`
dataItemType	`LOAN_ACCOUNT_GUARANTY`
dataItemType	`BRANCH`
dataItemType	`CURRENCY`
dataItemType	`CARD_TRANSACTION_REVERSAL`
dataItemType	`INTEREST_PRODUCT_SETTINGS`
dataItemType	`CREATED_ACCOUNTS`
dataItemType	`USER`
dataItemType	`SAVINGS_PRODUCT`
dataItemType	`CLIENT`
dataItemType	`PRODUCT_ARREARS_SETTINGS`
dataItemType	`SAVINGS`
dataItemType	`EXPENSE`
dataItemType	`INDEX_RATE`
dataItemType	`NOTIFICATION_TEMPLATE`
dataItemType	`CUSTOM_FIELD_SELECTION`
dataItemType	`ACTIVITY`
dataType	`ENUM`
dataType	`MONEY`
dataType	`NUMBER`
dataType	`DATE_UTC`
dataType	`JAVA_BLOB`
dataType	`OBJECT`
dataType	`BOOLEAN`
dataType	`DATE`
dataType	`PERCENT`
dataType	`BIG_DECIMAL`
dataType	`STRING`
dataType	`KEY`
dataType	`LONG`
filterElement	`STARTS_WITH_CASE_SENSITIVE`
filterElement	`THIS_WEEK`
filterElement	`EQUALS`
filterElement	`STARTS_WITH`
filterElement	`IN`
filterElement	`TODAY`
filterElement	`THIS_YEAR`
filterElement	`BETWEEN`
filterElement	`AFTER`
filterElement	`LESS_THAN`
filterElement	`DIFFERENT_THAN`
filterElement	`THIS_MONTH`
filterElement	`NOT_EMPTY`
filterElement	`BEFORE`
filterElement	`EQUALS_CASE_SENSITIVE`
filterElement	`LAST_DAYS`
filterElement	`MORE_THAN`
filterElement	`EMPTY`
filterElement	`ON`
linkingOperator	`OR`
linkingOperator	`AND`
builtInType	`DETAILS`
builtInType	`GENERAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
usage	`SINGLE`
usage	`GROUPED`
dataType	`GROUP_LINK`
dataType	`DATE`
dataType	`NUMBER`
dataType	`CHECKBOX`
dataType	`CLIENT_LINK`
dataType	`STRING`
dataType	`USER_LINK`
dataType	`SELECTION`
state	`DEACTIVATED`
state	`NORMAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
valueLength	`SHORT`
valueLength	`LONG`

Update Line of Credit Custom Field Value

PATCH /linesofcredit/{lineOfCreditId}/custominformation/{customFieldId}

Update custom field value for a line of credit

Update custom information for a given field for a given line of credit

Example Requests

Update the custom field value

{
  "value": "new custom field value"
}

Parameters

Name	Type	Description	In
lineOfCreditId (required)	string	none	path
customFieldId (required)	string	none	path
body	CustomFieldOnUpdate	none	body

Example Responses

200 Response

{
  "errorSource": "string",
  "returnCode": 0,
  "returnStatus": "string"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	ExecutionStatusApiV1

Delete Line of Credit Custom Field Value (grouped)

DELETE /linesofcredit/{lineOfCreditId}/custominformation/{customFieldId}/{customFieldSetGroupIndex}

Delete grouped custom field value for a line of credit

Delete custom field value in a grouped custom field set

Parameters

Name	Type	Description	In
lineOfCreditId (required)	string	none	path
customFieldSetGroupIndex (required)	integer	none	path
customFieldId (required)	string	none	path

Example Responses

200 Response

{
  "errorSource": "string",
  "returnCode": 0,
  "returnStatus": "string"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	ExecutionStatusApiV1

Remove Loan Account from Line of Credit

DELETE /linesofcredit/{lineOfCreditId}/loans/{loanAccountId}

Remove loan account from Line of Credit

Remove a loan account from a line of credit

Example Requests

Remove a savings account from a line of credit

DELETE /api/linesofcredit/ID001/loans/DA123

Parameters

Name	Type	Description	In
lineOfCreditId (required)	string	none	path
loanAccountId (required)	string	none	path

Example Responses

200 : ok
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
account is not under line of credit

{
  "returnCode": 1412,
  "returnStatus": "ACCOUNT_IS_NOT_PART_OF_LINE_OF_CREDIT"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	ExecutionStatusApiV1
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Add Loan Account to Line of Credit

POST /linesofcredit/{lineOfCreditId}/loans/{loanAccountId}

Add a loan account to a line of credit

Assign a loan account to a line of credit

Example Requests

POST /api/linesofcredit/LINR836/loans/LOAN019

Parameters

Name	Type	Description	In
lineOfCreditId (required)	string	none	path
loanAccountId (required)	string	none	path

Example Responses

200 Response

{
  "accountArrearsSettings": {
    "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
    "encodedKey": "string",
    "monthlyToleranceDay": 0,
    "nonWorkingDaysMethod": "EXCLUDED",
    "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY",
    "toleranceFloorAmount": 0,
    "tolerancePercentageOfOutstandingPrincipal": 0,
    "tolerancePeriod": 0
  },
  "accountHolderKey": "string",
  "accountHolderType": "GROUP",
  "accountState": "WITHDRAWN",
  "accountSubState": "WITHDRAWN",
  "accrueInterestAfterMaturity": true,
  "accrueLateInterest": true,
  "accruedInterest": 0,
  "accruedPenalty": 0,
  "activationTransactionKey": "string",
  "allowOffset": true,
  "applyInterestOnPrepaymentMethod": "AUTOMATIC",
  "approvedDate": "string",
  "arrearsTolerancePeriod": 0,
  "assignedBranchKey": "string",
  "assignedCentreKey": "string",
  "assignedUserKey": "string",
  "closedDate": "string",
  "creationDate": "string",
  "customFieldValues": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "daysInArrears": 0,
  "defaultFirstRepaymentDueDateOffset": 0,
  "disbursementDetails": {
    "customInformation": [
      {
        "amount": 0,
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "customFieldID": "string",
        "customFieldKey": "string",
        "customFieldSetGroupIndex": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexInList": 0,
        "linkedEntityKeyValue": "string",
        "parentKey": "string",
        "selectionKey": "string",
        "value": "string"
      }
    ],
    "disbursementDate": "string",
    "encodedKey": "string",
    "expectedDisbursementDate": "string",
    "fees": [
      {
        "amount": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "fee": {
          "active": true,
          "amortizationIntervalSettings": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
            "intervalCount": 0,
            "intervalType": "FULL_TERM",
            "periodCount": 0,
            "periodUnit": "MONTHS"
          },
          "amortizationProfile": "STRAIGHT_LINE",
          "amount": 0,
          "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
          "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
          "creationDate": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
          "feeApplication": "OPTIONAL",
          "feeProductRules": [
            {
              "account": {
                "activated": true,
                "allowManualJournalEntries": true,
                "balance": 0,
                "creationDate": "2019-08-24T14:15:22Z",
                "currency": {
                  "code": "string",
                  "creationDate": "string",
                  "currencySymbolPosition": "AFTER_NUMBER",
                  "digitsAfterDecimal": 0,
                  "isBaseCurrency": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "symbol": "string"
                },
                "description": "string",
                "encodedKey": "string",
                "glCode": "string",
                "lastModifiedDate": "2019-08-24T14:15:22Z",
                "migrationEvent": {
                  "creationDate": "2019-08-24T14:15:22Z",
                  "encodedKey": "string",
                  "numCentresImported": 0,
                  "numClientsImported": 0,
                  "numGLAccountsImported": 0,
                  "numGroupsImported": 0,
                  "numLoanRepaymentsImported": 0,
                  "numLoanTransactionsImported": 0,
                  "numLoansImported": 0,
                  "numSavingsImported": 0,
                  "state": "REVERTED",
                  "type": "IMPORT"
                },
                "name": "string",
                "stripTrailingZeros": true,
                "type": "INCOME",
                "usage": "HEADER"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "financialResource": "FEE_RECEIVABLE",
              "index": 0,
              "predefinedFeeKey": "string",
              "productKey": "string",
              "productType": "LOAN",
              "transactionChannelKey": "string"
            }
          ],
          "name": "string",
          "percentageAmount": 0,
          "trigger": "DISBURSEMENT"
        }
      }
    ],
    "firstRepaymentDate": "string",
    "transactionDetails": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "internalTransfer": true,
      "targetSavingsAccountKey": "string",
      "transactionChannel": {
        "activated": true,
        "createdByUserKey": "string",
        "creationDate": "string",
        "customFields": [
          {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          }
        ],
        "encodedKey": "string",
        "id": "string",
        "index": 0,
        "loanConstraints": {
          "customConfigurationInfo": {
            "creationDate": "string",
            "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "shared": true,
            "userKey": "string"
          },
          "encodedKey": "string",
          "filterConstraints": [
            {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            }
          ]
        },
        "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
        "name": "string",
        "savingsConstraints": {
          "customConfigurationInfo": {
            "creationDate": "string",
            "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "shared": true,
            "userKey": "string"
          },
          "encodedKey": "string",
          "filterConstraints": [
            {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            }
          ]
        },
        "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
        "transactionChannelAccountingRule": {
          "account": {
            "activated": true,
            "allowManualJournalEntries": true,
            "balance": 0,
            "creationDate": "2019-08-24T14:15:22Z",
            "currency": {
              "code": "string",
              "creationDate": "string",
              "currencySymbolPosition": "AFTER_NUMBER",
              "digitsAfterDecimal": 0,
              "isBaseCurrency": true,
              "lastModifiedDate": "string",
              "name": "string",
              "symbol": "string"
            },
            "description": "string",
            "encodedKey": "string",
            "glCode": "string",
            "lastModifiedDate": "2019-08-24T14:15:22Z",
            "migrationEvent": {
              "creationDate": "2019-08-24T14:15:22Z",
              "encodedKey": "string",
              "numCentresImported": 0,
              "numClientsImported": 0,
              "numGLAccountsImported": 0,
              "numGroupsImported": 0,
              "numLoanRepaymentsImported": 0,
              "numLoanTransactionsImported": 0,
              "numLoansImported": 0,
              "numSavingsImported": 0,
              "state": "REVERTED",
              "type": "IMPORT"
            },
            "name": "string",
            "stripTrailingZeros": true,
            "type": "INCOME",
            "usage": "HEADER"
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "financialResource": "FEE_RECEIVABLE",
          "index": 0,
          "predefinedFeeKey": "string",
          "productKey": "string",
          "productType": "LOAN",
          "transactionChannelKey": "string"
        },
        "usageRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "transactionChannelKey": "string"
    }
  },
  "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "feesBalance": 0,
  "feesDue": 0,
  "feesPaid": 0,
  "fixedDaysOfMonth": [
    0
  ],
  "funds": [
    {
      "amount": 0,
      "assetName": "string",
      "customFieldValues": [
        {
          "amount": 0,
          "customField": {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "customFieldID": "string",
          "customFieldKey": "string",
          "customFieldSetGroupIndex": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "linkedEntityKeyValue": "string",
          "parentKey": "string",
          "selectionKey": "string",
          "value": "string"
        }
      ],
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "guarantorKey": "string",
      "guarantorType": "GROUP",
      "id": "string",
      "interestCommission": 0,
      "investmentPercentage": 0,
      "savingsAccountKey": "string",
      "type": "GUARANTOR"
    }
  ],
  "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
  "gracePeriod": 0,
  "gracePeriodType": "PAY_INTEREST_ONLY",
  "guarantees": [
    {
      "amount": 0,
      "assetName": "string",
      "customFieldValues": [
        {
          "amount": 0,
          "customField": {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "customFieldID": "string",
          "customFieldKey": "string",
          "customFieldSetGroupIndex": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "linkedEntityKeyValue": "string",
          "parentKey": "string",
          "selectionKey": "string",
          "value": "string"
        }
      ],
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "guarantorKey": "string",
      "guarantorType": "GROUP",
      "savingsAccountKey": "string",
      "type": "GUARANTOR"
    }
  ],
  "hasCustomSchedule": true,
  "holdBalance": 0,
  "id": "string",
  "interestApplicationMethod": "ON_REPAYMENT",
  "interestBalance": 0,
  "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
  "interestCalculationMethod": "DECLINING_BALANCE",
  "interestChargeFrequency": "EVERY_WEEK",
  "interestCommission": 0,
  "interestDue": 0,
  "interestFromArrearsAccrued": 0,
  "interestFromArrearsBalance": 0,
  "interestFromArrearsDue": 0,
  "interestFromArrearsPaid": 0,
  "interestPaid": 0,
  "interestRate": 0,
  "interestRateReviewCount": 0,
  "interestRateReviewUnit": "MONTHS",
  "interestRateSource": "FIXED_INTEREST_RATE",
  "interestRoundingVersion": "VERSION_2",
  "interestSpread": 0,
  "interestType": "CAPITALIZED_INTEREST",
  "lastAccountAppraisalDate": "string",
  "lastInterestAppliedDate": "string",
  "lastInterestReviewDate": "string",
  "lastLockedDate": "string",
  "lastModifiedDate": "string",
  "lastSetToArrearsDate": "string",
  "lastTaxRateReviewDate": "string",
  "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
  "lineOfCreditKey": "string",
  "loanAmount": 0,
  "loanGroup": {
    "accounts": [
      {
        "accountArrearsSettings": {
          "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
          "encodedKey": "string",
          "monthlyToleranceDay": 0,
          "nonWorkingDaysMethod": "EXCLUDED",
          "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY",
          "toleranceFloorAmount": 0,
          "tolerancePercentageOfOutstandingPrincipal": 0,
          "tolerancePeriod": 0
        },
        "accountHolderKey": "string",
        "accountHolderType": "GROUP",
        "accountState": "WITHDRAWN",
        "accountSubState": "WITHDRAWN",
        "accrueInterestAfterMaturity": true,
        "accrueLateInterest": true,
        "accruedInterest": 0,
        "accruedPenalty": 0,
        "activationTransactionKey": "string",
        "allowOffset": true,
        "applyInterestOnPrepaymentMethod": "AUTOMATIC",
        "approvedDate": "string",
        "arrearsTolerancePeriod": 0,
        "assignedBranchKey": "string",
        "assignedCentreKey": "string",
        "assignedUserKey": "string",
        "closedDate": "string",
        "creationDate": "string",
        "customFieldValues": [
          {
            "amount": 0,
            "customField": {
              "amounts": {
                "property1": 0,
                "property2": 0
              },
              "builtInCustomFieldId": "MOBILE_PHONE",
              "creationDate": "string",
              "customFieldProductSettings": [
                {
                  "customFieldEncodedKey": "string",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isDefault": true,
                  "isRequired": true,
                  "linkType": "CLIENT_ROLE",
                  "productKey": "string"
                }
              ],
              "customFieldSelectionOptions": [
                {
                  "constraint": {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "score": 0,
                  "value": "string"
                }
              ],
              "customFieldSet": {
                "builtInType": "DETAILS",
                "createdDate": "string",
                "customFields": [
                  {}
                ],
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "notes": "string",
                "type": "USER_INFO",
                "usage": "SINGLE"
              },
              "dataType": "GROUP_LINK",
              "description": "string",
              "editRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "isDefault": true,
              "isRequired": true,
              "lastModifiedDate": "string",
              "name": "string",
              "state": "DEACTIVATED",
              "type": "USER_INFO",
              "unique": true,
              "validationPattern": "string",
              "valueLength": "SHORT",
              "values": [
                "string"
              ],
              "viewRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "customFieldID": "string",
            "customFieldKey": "string",
            "customFieldSetGroupIndex": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "linkedEntityKeyValue": "string",
            "parentKey": "string",
            "selectionKey": "string",
            "value": "string"
          }
        ],
        "daysInArrears": 0,
        "defaultFirstRepaymentDueDateOffset": 0,
        "disbursementDetails": {
          "customInformation": [
            {
              "amount": 0,
              "customField": {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              },
              "customFieldID": "string",
              "customFieldKey": "string",
              "customFieldSetGroupIndex": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "linkedEntityKeyValue": "string",
              "parentKey": "string",
              "selectionKey": "string",
              "value": "string"
            }
          ],
          "disbursementDate": "string",
          "encodedKey": "string",
          "expectedDisbursementDate": "string",
          "fees": [
            {
              "amount": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "fee": {
                "active": true,
                "amortizationIntervalSettings": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
                  "intervalCount": 0,
                  "intervalType": "FULL_TERM",
                  "periodCount": 0,
                  "periodUnit": "MONTHS"
                },
                "amortizationProfile": "STRAIGHT_LINE",
                "amount": 0,
                "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
                "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
                "creationDate": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
                "feeApplication": "OPTIONAL",
                "feeProductRules": [
                  {
                    "account": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "financialResource": "FEE_RECEIVABLE",
                    "index": 0,
                    "predefinedFeeKey": "string",
                    "productKey": "string",
                    "productType": "LOAN",
                    "transactionChannelKey": "string"
                  }
                ],
                "name": "string",
                "percentageAmount": 0,
                "trigger": "DISBURSEMENT"
              }
            }
          ],
          "firstRepaymentDate": "string",
          "transactionDetails": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "internalTransfer": true,
            "targetSavingsAccountKey": "string",
            "transactionChannel": {
              "activated": true,
              "createdByUserKey": "string",
              "creationDate": "string",
              "customFields": [
                {
                  "amounts": {
                    "property1": 0,
                    "property2": 0
                  },
                  "builtInCustomFieldId": "MOBILE_PHONE",
                  "creationDate": "string",
                  "customFieldProductSettings": [
                    {}
                  ],
                  "customFieldSelectionOptions": [
                    {}
                  ],
                  "customFieldSet": {
                    "builtInType": "DETAILS",
                    "createdDate": "string",
                    "customFields": [],
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "indexInList": 0,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "notes": "string",
                    "type": "USER_INFO",
                    "usage": "SINGLE"
                  },
                  "dataType": "GROUP_LINK",
                  "description": "string",
                  "editRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "isDefault": true,
                  "isRequired": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "state": "DEACTIVATED",
                  "type": "USER_INFO",
                  "unique": true,
                  "validationPattern": "string",
                  "valueLength": "SHORT",
                  "values": [
                    "string"
                  ],
                  "viewRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  }
                }
              ],
              "encodedKey": "string",
              "id": "string",
              "index": 0,
              "loanConstraints": {
                "customConfigurationInfo": {
                  "creationDate": "string",
                  "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "shared": true,
                  "userKey": "string"
                },
                "encodedKey": "string",
                "filterConstraints": [
                  {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  }
                ]
              },
              "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
              "name": "string",
              "savingsConstraints": {
                "customConfigurationInfo": {
                  "creationDate": "string",
                  "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "shared": true,
                  "userKey": "string"
                },
                "encodedKey": "string",
                "filterConstraints": [
                  {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  }
                ]
              },
              "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
              "transactionChannelAccountingRule": {
                "account": {
                  "activated": true,
                  "allowManualJournalEntries": true,
                  "balance": 0,
                  "creationDate": "2019-08-24T14:15:22Z",
                  "currency": {
                    "code": "string",
                    "creationDate": "string",
                    "currencySymbolPosition": "AFTER_NUMBER",
                    "digitsAfterDecimal": 0,
                    "isBaseCurrency": true,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "symbol": "string"
                  },
                  "description": "string",
                  "encodedKey": "string",
                  "glCode": "string",
                  "lastModifiedDate": "2019-08-24T14:15:22Z",
                  "migrationEvent": {
                    "creationDate": "2019-08-24T14:15:22Z",
                    "encodedKey": "string",
                    "numCentresImported": 0,
                    "numClientsImported": 0,
                    "numGLAccountsImported": 0,
                    "numGroupsImported": 0,
                    "numLoanRepaymentsImported": 0,
                    "numLoanTransactionsImported": 0,
                    "numLoansImported": 0,
                    "numSavingsImported": 0,
                    "state": "REVERTED",
                    "type": "IMPORT"
                  },
                  "name": "string",
                  "stripTrailingZeros": true,
                  "type": "INCOME",
                  "usage": "HEADER"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "financialResource": "FEE_RECEIVABLE",
                "index": 0,
                "predefinedFeeKey": "string",
                "productKey": "string",
                "productType": "LOAN",
                "transactionChannelKey": "string"
              },
              "usageRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "transactionChannelKey": "string"
          }
        },
        "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "feesBalance": 0,
        "feesDue": 0,
        "feesPaid": 0,
        "fixedDaysOfMonth": [
          0
        ],
        "funds": [
          {
            "amount": 0,
            "assetName": "string",
            "customFieldValues": [
              {
                "amount": 0,
                "customField": {
                  "amounts": {
                    "property1": 0,
                    "property2": 0
                  },
                  "builtInCustomFieldId": "MOBILE_PHONE",
                  "creationDate": "string",
                  "customFieldProductSettings": [
                    {}
                  ],
                  "customFieldSelectionOptions": [
                    {}
                  ],
                  "customFieldSet": {
                    "builtInType": "DETAILS",
                    "createdDate": "string",
                    "customFields": [],
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "indexInList": 0,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "notes": "string",
                    "type": "USER_INFO",
                    "usage": "SINGLE"
                  },
                  "dataType": "GROUP_LINK",
                  "description": "string",
                  "editRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "isDefault": true,
                  "isRequired": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "state": "DEACTIVATED",
                  "type": "USER_INFO",
                  "unique": true,
                  "validationPattern": "string",
                  "valueLength": "SHORT",
                  "values": [
                    "string"
                  ],
                  "viewRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  }
                },
                "customFieldID": "string",
                "customFieldKey": "string",
                "customFieldSetGroupIndex": 0,
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "linkedEntityKeyValue": "string",
                "parentKey": "string",
                "selectionKey": "string",
                "value": "string"
              }
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "guarantorKey": "string",
            "guarantorType": "GROUP",
            "id": "string",
            "interestCommission": 0,
            "investmentPercentage": 0,
            "savingsAccountKey": "string",
            "type": "GUARANTOR"
          }
        ],
        "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
        "gracePeriod": 0,
        "gracePeriodType": "PAY_INTEREST_ONLY",
        "guarantees": [
          {
            "amount": 0,
            "assetName": "string",
            "customFieldValues": [
              {
                "amount": 0,
                "customField": {
                  "amounts": {
                    "property1": 0,
                    "property2": 0
                  },
                  "builtInCustomFieldId": "MOBILE_PHONE",
                  "creationDate": "string",
                  "customFieldProductSettings": [
                    {}
                  ],
                  "customFieldSelectionOptions": [
                    {}
                  ],
                  "customFieldSet": {
                    "builtInType": "DETAILS",
                    "createdDate": "string",
                    "customFields": [],
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "indexInList": 0,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "notes": "string",
                    "type": "USER_INFO",
                    "usage": "SINGLE"
                  },
                  "dataType": "GROUP_LINK",
                  "description": "string",
                  "editRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "isDefault": true,
                  "isRequired": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "state": "DEACTIVATED",
                  "type": "USER_INFO",
                  "unique": true,
                  "validationPattern": "string",
                  "valueLength": "SHORT",
                  "values": [
                    "string"
                  ],
                  "viewRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  }
                },
                "customFieldID": "string",
                "customFieldKey": "string",
                "customFieldSetGroupIndex": 0,
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "linkedEntityKeyValue": "string",
                "parentKey": "string",
                "selectionKey": "string",
                "value": "string"
              }
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "guarantorKey": "string",
            "guarantorType": "GROUP",
            "savingsAccountKey": "string",
            "type": "GUARANTOR"
          }
        ],
        "hasCustomSchedule": true,
        "holdBalance": 0,
        "id": "string",
        "interestApplicationMethod": "ON_REPAYMENT",
        "interestBalance": 0,
        "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
        "interestCalculationMethod": "DECLINING_BALANCE",
        "interestChargeFrequency": "EVERY_WEEK",
        "interestCommission": 0,
        "interestDue": 0,
        "interestFromArrearsAccrued": 0,
        "interestFromArrearsBalance": 0,
        "interestFromArrearsDue": 0,
        "interestFromArrearsPaid": 0,
        "interestPaid": 0,
        "interestRate": 0,
        "interestRateReviewCount": 0,
        "interestRateReviewUnit": "MONTHS",
        "interestRateSource": "FIXED_INTEREST_RATE",
        "interestRoundingVersion": "VERSION_2",
        "interestSpread": 0,
        "interestType": "CAPITALIZED_INTEREST",
        "lastAccountAppraisalDate": "string",
        "lastInterestAppliedDate": "string",
        "lastInterestReviewDate": "string",
        "lastLockedDate": "string",
        "lastModifiedDate": "string",
        "lastSetToArrearsDate": "string",
        "lastTaxRateReviewDate": "string",
        "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
        "lineOfCreditKey": "string",
        "loanAmount": 0,
        "loanGroup": {},
        "loanName": "string",
        "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
        "lockedOperations": [
          "APPLY_FEES"
        ],
        "migrationEvent": {
          "creationDate": "2019-08-24T14:15:22Z",
          "encodedKey": "string",
          "numCentresImported": 0,
          "numClientsImported": 0,
          "numGLAccountsImported": 0,
          "numGroupsImported": 0,
          "numLoanRepaymentsImported": 0,
          "numLoanTransactionsImported": 0,
          "numLoansImported": 0,
          "numSavingsImported": 0,
          "state": "REVERTED",
          "type": "IMPORT"
        },
        "notes": "string",
        "originalAccountKey": "string",
        "paymentMethod": "VERTICAL",
        "paymentPlan": [
          {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "endingInstallmentPosition": 0,
            "index": 0,
            "loanAccountEncodedKey": "string",
            "pmt": 0
          }
        ],
        "penaltyBalance": 0,
        "penaltyDue": 0,
        "penaltyPaid": 0,
        "penaltyRate": 0,
        "periodicPayment": 0,
        "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
        "prepaymentRecalculationMethod": "NO_RECALCULATION",
        "principalBalance": 0,
        "principalDue": 0,
        "principalPaid": 0,
        "principalPaidInstallmentStatus": "PARTIALLY_PAID",
        "principalPaymentSettings": {
          "amount": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "includeFeesInFloorAmount": true,
          "includeInterestInFloorAmount": true,
          "percentage": 0,
          "principalCeilingValue": 0,
          "principalFloorValue": 0,
          "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
        },
        "principalRepaymentInterval": 0,
        "productTypeKey": "string",
        "redrawBalance": 0,
        "redrawSettings": {
          "account": {},
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "restrictNextDueWithdrawal": true
        },
        "repaymentInstallments": 0,
        "repaymentPeriodCount": 0,
        "repaymentPeriodUnit": "MONTHS",
        "repaymentScheduleMethod": "FIXED",
        "rescheduledAccountKey": "string",
        "scheduleDueDatesMethod": "INTERVAL",
        "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
        "taxRate": 0,
        "tranches": [
          {
            "amount": 0,
            "disbursementTransactionKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "expectedDisbursementDate": "string",
            "index": 0
          }
        ]
      }
    ],
    "creationDate": "string",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "group": {
      "assignedBranchKey": "string",
      "assignedCentreKey": "string",
      "assignedUserKey": "string",
      "clientRole": {
        "encodedKey": "string"
      },
      "creationDate": "2019-08-24T14:15:22Z",
      "emailAddress": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "groupName": "string",
      "homePhone": "string",
      "id": "string",
      "idPattern": "string",
      "lastModifiedDate": "2019-08-24T14:15:22Z",
      "loanCycle": 0,
      "migrationEvent": {
        "creationDate": "2019-08-24T14:15:22Z",
        "encodedKey": "string",
        "numCentresImported": 0,
        "numClientsImported": 0,
        "numGLAccountsImported": 0,
        "numGroupsImported": 0,
        "numLoanRepaymentsImported": 0,
        "numLoanTransactionsImported": 0,
        "numLoansImported": 0,
        "numSavingsImported": 0,
        "state": "REVERTED",
        "type": "IMPORT"
      },
      "mobilePhone1": "string",
      "preferredLanguage": "PORTUGESE"
    },
    "lastModifiedDate": "string",
    "name": "string",
    "notes": "string"
  },
  "loanName": "string",
  "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
  "lockedOperations": [
    "APPLY_FEES"
  ],
  "migrationEvent": {
    "creationDate": "2019-08-24T14:15:22Z",
    "encodedKey": "string",
    "numCentresImported": 0,
    "numClientsImported": 0,
    "numGLAccountsImported": 0,
    "numGroupsImported": 0,
    "numLoanRepaymentsImported": 0,
    "numLoanTransactionsImported": 0,
    "numLoansImported": 0,
    "numSavingsImported": 0,
    "state": "REVERTED",
    "type": "IMPORT"
  },
  "notes": "string",
  "originalAccountKey": "string",
  "paymentMethod": "VERTICAL",
  "paymentPlan": [
    {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "endingInstallmentPosition": 0,
      "index": 0,
      "loanAccountEncodedKey": "string",
      "pmt": 0
    }
  ],
  "penaltyBalance": 0,
  "penaltyDue": 0,
  "penaltyPaid": 0,
  "penaltyRate": 0,
  "periodicPayment": 0,
  "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
  "prepaymentRecalculationMethod": "NO_RECALCULATION",
  "principalBalance": 0,
  "principalDue": 0,
  "principalPaid": 0,
  "principalPaidInstallmentStatus": "PARTIALLY_PAID",
  "principalPaymentSettings": {
    "amount": 0,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "includeFeesInFloorAmount": true,
    "includeInterestInFloorAmount": true,
    "percentage": 0,
    "principalCeilingValue": 0,
    "principalFloorValue": 0,
    "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
  },
  "principalRepaymentInterval": 0,
  "productTypeKey": "string",
  "redrawBalance": 0,
  "redrawSettings": {
    "account": {
      "accountArrearsSettings": {
        "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
        "encodedKey": "string",
        "monthlyToleranceDay": 0,
        "nonWorkingDaysMethod": "EXCLUDED",
        "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY",
        "toleranceFloorAmount": 0,
        "tolerancePercentageOfOutstandingPrincipal": 0,
        "tolerancePeriod": 0
      },
      "accountHolderKey": "string",
      "accountHolderType": "GROUP",
      "accountState": "WITHDRAWN",
      "accountSubState": "WITHDRAWN",
      "accrueInterestAfterMaturity": true,
      "accrueLateInterest": true,
      "accruedInterest": 0,
      "accruedPenalty": 0,
      "activationTransactionKey": "string",
      "allowOffset": true,
      "applyInterestOnPrepaymentMethod": "AUTOMATIC",
      "approvedDate": "string",
      "arrearsTolerancePeriod": 0,
      "assignedBranchKey": "string",
      "assignedCentreKey": "string",
      "assignedUserKey": "string",
      "closedDate": "string",
      "creationDate": "string",
      "customFieldValues": [
        {
          "amount": 0,
          "customField": {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "customFieldID": "string",
          "customFieldKey": "string",
          "customFieldSetGroupIndex": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "linkedEntityKeyValue": "string",
          "parentKey": "string",
          "selectionKey": "string",
          "value": "string"
        }
      ],
      "daysInArrears": 0,
      "defaultFirstRepaymentDueDateOffset": 0,
      "disbursementDetails": {
        "customInformation": [
          {
            "amount": 0,
            "customField": {
              "amounts": {
                "property1": 0,
                "property2": 0
              },
              "builtInCustomFieldId": "MOBILE_PHONE",
              "creationDate": "string",
              "customFieldProductSettings": [
                {
                  "customFieldEncodedKey": "string",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isDefault": true,
                  "isRequired": true,
                  "linkType": "CLIENT_ROLE",
                  "productKey": "string"
                }
              ],
              "customFieldSelectionOptions": [
                {
                  "constraint": {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "score": 0,
                  "value": "string"
                }
              ],
              "customFieldSet": {
                "builtInType": "DETAILS",
                "createdDate": "string",
                "customFields": [
                  {}
                ],
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "notes": "string",
                "type": "USER_INFO",
                "usage": "SINGLE"
              },
              "dataType": "GROUP_LINK",
              "description": "string",
              "editRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "isDefault": true,
              "isRequired": true,
              "lastModifiedDate": "string",
              "name": "string",
              "state": "DEACTIVATED",
              "type": "USER_INFO",
              "unique": true,
              "validationPattern": "string",
              "valueLength": "SHORT",
              "values": [
                "string"
              ],
              "viewRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "customFieldID": "string",
            "customFieldKey": "string",
            "customFieldSetGroupIndex": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "linkedEntityKeyValue": "string",
            "parentKey": "string",
            "selectionKey": "string",
            "value": "string"
          }
        ],
        "disbursementDate": "string",
        "encodedKey": "string",
        "expectedDisbursementDate": "string",
        "fees": [
          {
            "amount": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "fee": {
              "active": true,
              "amortizationIntervalSettings": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
                "intervalCount": 0,
                "intervalType": "FULL_TERM",
                "periodCount": 0,
                "periodUnit": "MONTHS"
              },
              "amortizationProfile": "STRAIGHT_LINE",
              "amount": 0,
              "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
              "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
              "creationDate": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
              "feeApplication": "OPTIONAL",
              "feeProductRules": [
                {
                  "account": {
                    "activated": true,
                    "allowManualJournalEntries": true,
                    "balance": 0,
                    "creationDate": "2019-08-24T14:15:22Z",
                    "currency": {},
                    "description": "string",
                    "encodedKey": "string",
                    "glCode": "string",
                    "lastModifiedDate": "2019-08-24T14:15:22Z",
                    "migrationEvent": {},
                    "name": "string",
                    "stripTrailingZeros": true,
                    "type": "INCOME",
                    "usage": "HEADER"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "financialResource": "FEE_RECEIVABLE",
                  "index": 0,
                  "predefinedFeeKey": "string",
                  "productKey": "string",
                  "productType": "LOAN",
                  "transactionChannelKey": "string"
                }
              ],
              "name": "string",
              "percentageAmount": 0,
              "trigger": "DISBURSEMENT"
            }
          }
        ],
        "firstRepaymentDate": "string",
        "transactionDetails": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "internalTransfer": true,
          "targetSavingsAccountKey": "string",
          "transactionChannel": {
            "activated": true,
            "createdByUserKey": "string",
            "creationDate": "string",
            "customFields": [
              {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              }
            ],
            "encodedKey": "string",
            "id": "string",
            "index": 0,
            "loanConstraints": {
              "customConfigurationInfo": {
                "creationDate": "string",
                "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "shared": true,
                "userKey": "string"
              },
              "encodedKey": "string",
              "filterConstraints": [
                {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                }
              ]
            },
            "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
            "name": "string",
            "savingsConstraints": {
              "customConfigurationInfo": {
                "creationDate": "string",
                "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "shared": true,
                "userKey": "string"
              },
              "encodedKey": "string",
              "filterConstraints": [
                {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                }
              ]
            },
            "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
            "transactionChannelAccountingRule": {
              "account": {
                "activated": true,
                "allowManualJournalEntries": true,
                "balance": 0,
                "creationDate": "2019-08-24T14:15:22Z",
                "currency": {
                  "code": "string",
                  "creationDate": "string",
                  "currencySymbolPosition": "AFTER_NUMBER",
                  "digitsAfterDecimal": 0,
                  "isBaseCurrency": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "symbol": "string"
                },
                "description": "string",
                "encodedKey": "string",
                "glCode": "string",
                "lastModifiedDate": "2019-08-24T14:15:22Z",
                "migrationEvent": {
                  "creationDate": "2019-08-24T14:15:22Z",
                  "encodedKey": "string",
                  "numCentresImported": 0,
                  "numClientsImported": 0,
                  "numGLAccountsImported": 0,
                  "numGroupsImported": 0,
                  "numLoanRepaymentsImported": 0,
                  "numLoanTransactionsImported": 0,
                  "numLoansImported": 0,
                  "numSavingsImported": 0,
                  "state": "REVERTED",
                  "type": "IMPORT"
                },
                "name": "string",
                "stripTrailingZeros": true,
                "type": "INCOME",
                "usage": "HEADER"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "financialResource": "FEE_RECEIVABLE",
              "index": 0,
              "predefinedFeeKey": "string",
              "productKey": "string",
              "productType": "LOAN",
              "transactionChannelKey": "string"
            },
            "usageRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "transactionChannelKey": "string"
        }
      },
      "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "feesBalance": 0,
      "feesDue": 0,
      "feesPaid": 0,
      "fixedDaysOfMonth": [
        0
      ],
      "funds": [
        {
          "amount": 0,
          "assetName": "string",
          "customFieldValues": [
            {
              "amount": 0,
              "customField": {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              },
              "customFieldID": "string",
              "customFieldKey": "string",
              "customFieldSetGroupIndex": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "linkedEntityKeyValue": "string",
              "parentKey": "string",
              "selectionKey": "string",
              "value": "string"
            }
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "guarantorKey": "string",
          "guarantorType": "GROUP",
          "id": "string",
          "interestCommission": 0,
          "investmentPercentage": 0,
          "savingsAccountKey": "string",
          "type": "GUARANTOR"
        }
      ],
      "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
      "gracePeriod": 0,
      "gracePeriodType": "PAY_INTEREST_ONLY",
      "guarantees": [
        {
          "amount": 0,
          "assetName": "string",
          "customFieldValues": [
            {
              "amount": 0,
              "customField": {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              },
              "customFieldID": "string",
              "customFieldKey": "string",
              "customFieldSetGroupIndex": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "linkedEntityKeyValue": "string",
              "parentKey": "string",
              "selectionKey": "string",
              "value": "string"
            }
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "guarantorKey": "string",
          "guarantorType": "GROUP",
          "savingsAccountKey": "string",
          "type": "GUARANTOR"
        }
      ],
      "hasCustomSchedule": true,
      "holdBalance": 0,
      "id": "string",
      "interestApplicationMethod": "ON_REPAYMENT",
      "interestBalance": 0,
      "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
      "interestCalculationMethod": "DECLINING_BALANCE",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestCommission": 0,
      "interestDue": 0,
      "interestFromArrearsAccrued": 0,
      "interestFromArrearsBalance": 0,
      "interestFromArrearsDue": 0,
      "interestFromArrearsPaid": 0,
      "interestPaid": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRoundingVersion": "VERSION_2",
      "interestSpread": 0,
      "interestType": "CAPITALIZED_INTEREST",
      "lastAccountAppraisalDate": "string",
      "lastInterestAppliedDate": "string",
      "lastInterestReviewDate": "string",
      "lastLockedDate": "string",
      "lastModifiedDate": "string",
      "lastSetToArrearsDate": "string",
      "lastTaxRateReviewDate": "string",
      "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
      "lineOfCreditKey": "string",
      "loanAmount": 0,
      "loanGroup": {
        "accounts": [
          {}
        ],
        "creationDate": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "group": {
          "assignedBranchKey": "string",
          "assignedCentreKey": "string",
          "assignedUserKey": "string",
          "clientRole": {
            "encodedKey": "string"
          },
          "creationDate": "2019-08-24T14:15:22Z",
          "emailAddress": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "groupName": "string",
          "homePhone": "string",
          "id": "string",
          "idPattern": "string",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "loanCycle": 0,
          "migrationEvent": {
            "creationDate": "2019-08-24T14:15:22Z",
            "encodedKey": "string",
            "numCentresImported": 0,
            "numClientsImported": 0,
            "numGLAccountsImported": 0,
            "numGroupsImported": 0,
            "numLoanRepaymentsImported": 0,
            "numLoanTransactionsImported": 0,
            "numLoansImported": 0,
            "numSavingsImported": 0,
            "state": "REVERTED",
            "type": "IMPORT"
          },
          "mobilePhone1": "string",
          "preferredLanguage": "PORTUGESE"
        },
        "lastModifiedDate": "string",
        "name": "string",
        "notes": "string"
      },
      "loanName": "string",
      "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
      "lockedOperations": [
        "APPLY_FEES"
      ],
      "migrationEvent": {
        "creationDate": "2019-08-24T14:15:22Z",
        "encodedKey": "string",
        "numCentresImported": 0,
        "numClientsImported": 0,
        "numGLAccountsImported": 0,
        "numGroupsImported": 0,
        "numLoanRepaymentsImported": 0,
        "numLoanTransactionsImported": 0,
        "numLoansImported": 0,
        "numSavingsImported": 0,
        "state": "REVERTED",
        "type": "IMPORT"
      },
      "notes": "string",
      "originalAccountKey": "string",
      "paymentMethod": "VERTICAL",
      "paymentPlan": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingInstallmentPosition": 0,
          "index": 0,
          "loanAccountEncodedKey": "string",
          "pmt": 0
        }
      ],
      "penaltyBalance": 0,
      "penaltyDue": 0,
      "penaltyPaid": 0,
      "penaltyRate": 0,
      "periodicPayment": 0,
      "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
      "prepaymentRecalculationMethod": "NO_RECALCULATION",
      "principalBalance": 0,
      "principalDue": 0,
      "principalPaid": 0,
      "principalPaidInstallmentStatus": "PARTIALLY_PAID",
      "principalPaymentSettings": {
        "amount": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "includeFeesInFloorAmount": true,
        "includeInterestInFloorAmount": true,
        "percentage": 0,
        "principalCeilingValue": 0,
        "principalFloorValue": 0,
        "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
      },
      "principalRepaymentInterval": 0,
      "productTypeKey": "string",
      "redrawBalance": 0,
      "redrawSettings": {},
      "repaymentInstallments": 0,
      "repaymentPeriodCount": 0,
      "repaymentPeriodUnit": "MONTHS",
      "repaymentScheduleMethod": "FIXED",
      "rescheduledAccountKey": "string",
      "scheduleDueDatesMethod": "INTERVAL",
      "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
      "taxRate": 0,
      "tranches": [
        {
          "amount": 0,
          "disbursementTransactionKey": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "expectedDisbursementDate": "string",
          "index": 0
        }
      ]
    },
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "restrictNextDueWithdrawal": true
  },
  "repaymentInstallments": 0,
  "repaymentPeriodCount": 0,
  "repaymentPeriodUnit": "MONTHS",
  "repaymentScheduleMethod": "FIXED",
  "rescheduledAccountKey": "string",
  "scheduleDueDatesMethod": "INTERVAL",
  "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
  "taxRate": 0,
  "tranches": [
    {
      "amount": 0,
      "disbursementTransactionKey": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "expectedDisbursementDate": "string",
      "index": 0
    }
  ]
}

400 : Bad Request
Line of Credit does not cover full period of loan

{
  "returnCode": 1402,
  "returnStatus": "MATURITY_DATE_AFTER_LINE_OF_CREDIT_END_DATE",
  "errorSource": "Thu Dec 31 00:00:00 UTC 2020"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	LoanAccountApiV1
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Remove Savings Account from Line of Credit

DELETE /linesofcredit/{lineOfCreditId}/savings/{savingsAccountId}

Remove savings account from Line of Credit

Remove a savings account from a line of credit

Example Requests

Remove a savings account from a line of credit

DELETE /api/linesofcredit/ID001/savings/DA123

Parameters

Name	Type	Description	In
lineOfCreditId (required)	string	none	path
savingsAccountId (required)	string	none	path

Example Responses

200 Response

{
  "errorSource": "string",
  "returnCode": 0,
  "returnStatus": "string"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	ExecutionStatusApiV1

Add Savings Account to Line of Credit

POST /linesofcredit/{lineOfCreditId}/savings/{savingsAccountId}

Add savings account to Line of Credit

Assign a savings account to a line of credit

Example Requests

POST /api/linesofcredit/LINR836/savings/LOAN019

Parameters

Name	Type	Description	In
lineOfCreditId (required)	string	none	path
savingsAccountId (required)	string	none	path

Example Responses

200 Response

{
  "accountHolderKey": "string",
  "accountHolderType": "GROUP",
  "accountState": "WITHDRAWN",
  "accountType": "CURRENT_ACCOUNT",
  "accruedInterest": 0,
  "activationDate": "string",
  "allowOverdraft": true,
  "approvedDate": "string",
  "assignedBranchKey": "string",
  "assignedCentreKey": "string",
  "assignedUserKey": "string",
  "availableBalance": 0,
  "balance": 0,
  "closedDate": "string",
  "creationDate": "string",
  "currency": {
    "code": "string",
    "creationDate": "string",
    "currencySymbolPosition": "AFTER_NUMBER",
    "digitsAfterDecimal": 0,
    "isBaseCurrency": true,
    "lastModifiedDate": "string",
    "name": "string",
    "symbol": "string"
  },
  "currencyCode": "string",
  "customFieldValues": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "feesDue": 0,
  "holdBalance": 0,
  "id": "string",
  "interestDue": 0,
  "interestPaymentDates": [
    {
      "dayOfMonth": 0,
      "monthOfYear": 0,
      "year": 0
    }
  ],
  "interestPaymentPoint": "EVERY_WEEK",
  "interestSettings": {
    "accrueInterestAfterMaturity": true,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "interestChargeFrequency": "EVERY_WEEK",
    "interestChargeFrequencyCount": 0,
    "interestRate": 0,
    "interestRateReviewCount": 0,
    "interestRateReviewUnit": "MONTHS",
    "interestRateSource": "FIXED_INTEREST_RATE",
    "interestRateTerms": "TIERED_PERIOD",
    "interestRateTiers": [
      {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "endingBalance": 0,
        "endingDay": 0,
        "index": 0,
        "interestRate": 0
      }
    ],
    "interestSpread": 0
  },
  "lastAccountAppraisalDate": "string",
  "lastInterestCalculationDate": "string",
  "lastInterestStoredDate": "string",
  "lastModifiedDate": "string",
  "lastOverdraftInterestReviewDate": "string",
  "lastSetToArrearsDate": "string",
  "lineOfCreditKey": "string",
  "lockedBalance": 0,
  "lockedDate": "string",
  "maturityDate": "string",
  "maxWidthdrawlAmount": 0,
  "migrationEvent": {
    "creationDate": "2019-08-24T14:15:22Z",
    "encodedKey": "string",
    "numCentresImported": 0,
    "numClientsImported": 0,
    "numGLAccountsImported": 0,
    "numGroupsImported": 0,
    "numLoanRepaymentsImported": 0,
    "numLoanTransactionsImported": 0,
    "numLoansImported": 0,
    "numSavingsImported": 0,
    "state": "REVERTED",
    "type": "IMPORT"
  },
  "name": "string",
  "notes": "string",
  "overdraftAmount": 0,
  "overdraftExpiryDate": "string",
  "overdraftExpiryDateDTO": {
    "dayOfMonth": 0,
    "monthOfYear": 0,
    "year": 0
  },
  "overdraftInterestAccrued": 0,
  "overdraftInterestSettings": {
    "accrueInterestAfterMaturity": true,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "interestChargeFrequency": "EVERY_WEEK",
    "interestChargeFrequencyCount": 0,
    "interestRate": 0,
    "interestRateReviewCount": 0,
    "interestRateReviewUnit": "MONTHS",
    "interestRateSource": "FIXED_INTEREST_RATE",
    "interestRateTerms": "TIERED_PERIOD",
    "interestRateTiers": [
      {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "endingBalance": 0,
        "endingDay": 0,
        "index": 0,
        "interestRate": 0
      }
    ],
    "interestSpread": 0
  },
  "overdraftLimit": 0,
  "productTypeKey": "string",
  "recommendedDepositAmount": 0,
  "targetAmount": 0,
  "technicalInterestDue": 0,
  "technicalOverdraftAmount": 0,
  "technicalOverdraftInterestAccrued": 0,
  "withholdingTaxSourceKey": "string"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	SavingsAccountApiV1

Loan Accounts

Allows you to retrieve and create/update new loan accounts for clients or groups. It's possible to look up loans by their state, by a branch or by a credit officer to which the loans are assigned to. Loans may be retrieved directly or from a client or group to which they belong.

Actions that can be made to loan accounts:

Create a loan account
Refinance a loan account
Reschedule a loan account
Delete loan account
Edit a loan account
Edit custom field values
Search for loan accounts
Set settlement account for a loan account
Remove settlement account from a loan account
Get populated document for loan account

Please be Aware The Loan Transactions API manages all actions made on loans, such as the ones listed below:

Approve loan account
Disburse loan account
Apply accrued interest
Make repayment
Apply fee
Close loan account

Get Repayments for a Loan Account

GET /loans/{loanAccountId}/repayments

Allows retrieving repayment schedules for a loan account. The full repayment schedule is returned including details about the state of the repayments as well as amounts that have been paid (based on transactions logged).

Parameters

Name	Type	Description	In
feesDetails	boolean	none	query
offset	integer	none	query
limit	integer	none	query
loanAccountId (required)	string	the ID of the loan account that you want to get the repayments of	path

Example Responses

200 Response

[
  {
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "customSettings": [
      {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "loanTransactionKey": "string",
        "source": "CENTRE_MEETING_DAY_CHANGED",
        "type": "CUSTOM_ADDED_INSTALLMENT"
      }
    ],
    "dueDate": "string",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "feesAppliedDue": 0,
    "feesDue": 0,
    "feesPaid": 0,
    "feesUnappliedDue": 0,
    "fundersInterestDue": 0,
    "index": 0,
    "interestDue": 0,
    "interestPaid": 0,
    "lastPaidDate": "string",
    "lastPenaltyAppliedDate": "string",
    "notes": "string",
    "organizationCommissionDue": 0,
    "parentAccountKey": "string",
    "penaltyDue": 0,
    "penaltyPaid": 0,
    "principalDue": 0,
    "principalPaid": 0,
    "repaidDate": "string",
    "repaymentUnappliedFeeDetails": [
      {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "feeDue": 0,
        "indexInList": 0,
        "predefinedFeeKey": "string",
        "repaymentKey": "string",
        "taxOnFeeDue": 0
      }
    ],
    "state": "PARTIALLY_PAID",
    "taxFeesDue": 0,
    "taxFeesPaid": 0,
    "taxInterestDue": 0,
    "taxInterestPaid": 0,
    "taxPenaltyDue": 0,
    "taxPenaltyPaid": 0
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[RepaymentApiV1]	none	none
» assignedBranchKey	string	none	none
» assignedCentreKey	string	none	none
» assignedUserKey	string	none	none
» customSettings	[CustomRepaymentSettingsApiV1]	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» loanTransactionKey	string	the encoded key of the transaction that used these custom settings	none
»» source	string	the reason for these custom settings being created	none
»» type	string	the settings which were customised	none
» dueDate	string	none	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» feesAppliedDue	number	none	none
» feesDue	number	none	none
» feesPaid	number	none	none
» feesUnappliedDue	number	none	none
» fundersInterestDue	number	none	none
» index	number	none	none
» interestDue	number	none	none
» interestPaid	number	none	none
» lastPaidDate	string	none	none
» lastPenaltyAppliedDate	string	none	none
» notes	string	none	none
» organizationCommissionDue	number	none	none
» parentAccountKey	string	none	none
» penaltyDue	number	none	none
» penaltyPaid	number	none	none
» principalDue	number	none	none
» principalPaid	number	none	none
» repaidDate	string	none	none
» repaymentUnappliedFeeDetails	[RepaymentUnappliedFeeDetailsApiV1]	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» feeDue	number	none	none
»» indexInList	number	none	none
»» predefinedFeeKey	string	none	none
»» repaymentKey	string	none	none
»» taxOnFeeDue	number	none	none
» state	string	none	none
» taxFeesDue	number	none	none
» taxFeesPaid	number	none	none
» taxInterestDue	number	none	none
» taxInterestPaid	number	none	none
» taxPenaltyDue	number	none	none
» taxPenaltyPaid	number	none	none

Enumerated Values

Property	Value
source	`CENTRE_MEETING_DAY_CHANGED`
source	`INTEREST_APPLIED`
source	`INSTALLMENT_GRACED_NON_NATIVELY`
source	`INSTALLMENT_PAID`
source	`USER_INPUT`
type	`CUSTOM_ADDED_INSTALLMENT`
type	`CUSTOM_PRINCIPAL`
type	`CUSTOM_DUE_DATE`
state	`PARTIALLY_PAID`
state	`LATE`
state	`GRACE`
state	`PAID`
state	`PENDING`

Update Loan Repayments

PATCH /loans/{loanAccountId}/repayments

Allows you to alter the repayment schedule for fixed or dynamic accounts. You can edit either a single instalment or the whole schedule by specifying the encoded key(s) of the instalment(s). When additional instalments are required, leave out the encoded key parameter and Mambu will add an instalment.

Example Requests

{
  "repayments": [
    {
      "dueDate": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "feesDue": 0,
      "feesUnappliedDue": 0,
      "interestDue": 0,
      "isPaymentHoliday": true,
      "parentAccountKey": "string",
      "penaltyDue": 0,
      "principalDue": 0
    }
  ]
}

Parameters

Name	Type	Description	In
body	JSONLoanRepaymentsApiV1	none	body
loanAccountId (required)	string	the ID of the loan account that you want to get the repayments of	path

Example Responses

200 : ok
Update two instalments

{
  "repayments": [
    {
      "encodedKey": "ff80808148ac95ce0148acc5f4bd0022",
      "principalDue": "189",
      "dueDate": "2014-10-02",
      "interestDue": "25.4500000000",
      "parentAccountKey": "ff80808148ac95ce0148aca9853c0001"
    },
    {
      "encodedKey": "ff80808148ac95ce0148acc5f4d40023",
      "principalDue": "224",
      "interestDue": "20.3600000000",
      "dueDate": "2014-11-27",
      "parentAccountKey": "ff80808148ac95ce0148aca9853c0001"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[RepaymentApiV1]	none	none
» assignedBranchKey	string	none	none
» assignedCentreKey	string	none	none
» assignedUserKey	string	none	none
» customSettings	[CustomRepaymentSettingsApiV1]	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» loanTransactionKey	string	the encoded key of the transaction that used these custom settings	none
»» source	string	the reason for these custom settings being created	none
»» type	string	the settings which were customised	none
» dueDate	string	none	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» feesAppliedDue	number	none	none
» feesDue	number	none	none
» feesPaid	number	none	none
» feesUnappliedDue	number	none	none
» fundersInterestDue	number	none	none
» index	number	none	none
» interestDue	number	none	none
» interestPaid	number	none	none
» lastPaidDate	string	none	none
» lastPenaltyAppliedDate	string	none	none
» notes	string	none	none
» organizationCommissionDue	number	none	none
» parentAccountKey	string	none	none
» penaltyDue	number	none	none
» penaltyPaid	number	none	none
» principalDue	number	none	none
» principalPaid	number	none	none
» repaidDate	string	none	none
» repaymentUnappliedFeeDetails	[RepaymentUnappliedFeeDetailsApiV1]	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» feeDue	number	none	none
»» indexInList	number	none	none
»» predefinedFeeKey	string	none	none
»» repaymentKey	string	none	none
»» taxOnFeeDue	number	none	none
» state	string	none	none
» taxFeesDue	number	none	none
» taxFeesPaid	number	none	none
» taxInterestDue	number	none	none
» taxInterestPaid	number	none	none
» taxPenaltyDue	number	none	none
» taxPenaltyPaid	number	none	none

Enumerated Values

Property	Value
source	`CENTRE_MEETING_DAY_CHANGED`
source	`INTEREST_APPLIED`
source	`INSTALLMENT_GRACED_NON_NATIVELY`
source	`INSTALLMENT_PAID`
source	`USER_INPUT`
type	`CUSTOM_ADDED_INSTALLMENT`
type	`CUSTOM_PRINCIPAL`
type	`CUSTOM_DUE_DATE`
state	`PARTIALLY_PAID`
state	`LATE`
state	`GRACE`
state	`PAID`
state	`PENDING`

Get all Loan Accounts

GET /loans

Get all loans

Retrieve all Loan Accounts or look up loans based on a filter.

Parameters

Name	Type	Description	In
centreID	string	The ID of the centre to which the loan accounts are assigned to	query
accountState	string	The desired state of the accounts to filter on	query
branchID	string	The ID of the branch to which the loan accounts are assigned to	query
clientID	string	The ID of the client for whom you would like to get loan accounts	query
offset	integer	start at this index number when limiting results	query
groupID	string	The ID of the group to which the loan acconts are assigned	query
limit	integer	max number of records to return	query
fullDetails	boolean	Whether the full details of the loan account (such as custom field values or savings account settlement accounts) are retrieved.	query
creditOfficerUsername	string	The username of the credit officer to whom the loans are assigned. Required if the user making the call has the"Credit Officer" role and the option "Can access other credit officers clients" is not activated.	query

Enumerated Values

Parameter	Value
accountState	`WITHDRAWN`
accountState	`PARTIALLY_DISBURSED`
accountState	`LOCKED`
accountState	`ACTIVE`
accountState	`CLOSED`
accountState	`PARTIAL_APPLICATION`
accountState	`LOCKED_CAPPING`
accountState	`CLOSED_REJECTED`
accountState	`RESCHEDULED`
accountState	`ACTIVE_IN_ARREARS`
accountState	`MATURED`
accountState	`CLOSED_RESCHEDULED`
accountState	`CLOSED_WITHDRAWN`
accountState	`PENDING_APPROVAL`
accountState	`APPROVED`
accountState	`REFINANCED`
accountState	`DORMANT`
accountState	`CLOSED_WRITTEN_OFF`

Example Responses

200 : ok
a loan account with full details

{
  "encodedKey": "8a8086c46f7a3258016f7b4d25f50126",
  "id": "XNZR612",
  "accountHolderKey": "8a80877d6f65da00016f6670eb950022",
  "accountHolderType": "CLIENT",
  "creationDate": "2020-01-06T14:43:36+0000",
  "approvedDate": "2020-01-06T15:43:46+0000",
  "lastModifiedDate": "2020-02-06T12:49:13+0000",
  "activationTransactionKey": "8a8086c46f7a3258016f7b4facdb0139",
  "lastAccountAppraisalDate": "2020-02-06T00:00:06+0000",
  "accountState": "ACTIVE",
  "productTypeKey": "8a8086c46f7a3258016f7b4d25d60118",
  "loanName": "review frequency daily",
  "loanAmount": "2500",
  "periodicPayment": "0",
  "tranches": [],
  "principalDue": "207.49",
  "principalPaid": "207.31",
  "principalBalance": "2292.69",
  "redrawBalance": "0",
  "interestDue": "1.97",
  "interestPaid": "2.15",
  "interestFromArrearsBalance": "0",
  "interestFromArrearsDue": "0",
  "interestFromArrearsPaid": "0",
  "interestBalance": "1.97",
  "feesDue": "0",
  "feesPaid": "0",
  "feesBalance": "0",
  "penaltyDue": "0",
  "penaltyPaid": "0",
  "penaltyBalance": "0",
  "scheduleDueDatesMethod": "INTERVAL",
  "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
  "futurePaymentsAcceptance": "NO_FUTURE_PAYMENTS",
  "hasCustomSchedule": false,
  "repaymentPeriodCount": 1,
  "repaymentPeriodUnit": "MONTHS",
  "repaymentInstallments": 12,
  "gracePeriod": 0,
  "gracePeriodType": "NONE",
  "interestRate": "1",
  "customFieldValues": [
    {
      "encodedKey": "8a8086567019cc6c01701a8b30596da2",
      "parentKey": "8a8086c46f7a3258016f7b4d25f50126",
      "customFieldKey": "8a8086567019cc6c01701a869a4a6d81",
      "customField": {
        "encodedKey": "8a8086567019cc6c01701a869a4a6d81",
        "id": "sclt_1",
        "creationDate": "2020-02-06T12:47:32+0000",
        "lastModifiedDate": "2020-02-06T12:47:32+0000",
        "name": "selection 1",
        "type": "LOAN_ACCOUNT_INFO",
        "dataType": "SELECTION",
        "valueLength": "SHORT",
        "isDefault": false,
        "isRequired": false,
        "description": "",
        "customFieldSet": {
          "encodedKey": "8a8086567019cc6c01701a869a4a6d80",
          "id": "_loans_cf_set",
          "name": "loans cf set",
          "notes": "",
          "createdDate": "2020-02-06T12:46:55+0000",
          "lastModifiedDate": "2020-02-06T12:46:55+0000",
          "indexInList": 0,
          "type": "LOAN_ACCOUNT_INFO",
          "usage": "SINGLE"
        },
        "indexInList": 0,
        "state": "NORMAL",
        "customFieldSelectionOptions": [
          {
            "encodedKey": "8a8086567019cc6c01701a8a8c136d91",
            "id": "783728922",
            "value": "option 1",
            "score": "10"
          },
          {
            "encodedKey": "8a8086567019cc6c01701a8a8c1a6d92",
            "id": "672532084",
            "value": "option 2",
            "score": "5"
          },
          {
            "encodedKey": "8a8086567019cc6c01701a8a8c1a6d93",
            "id": "403063097",
            "value": "option 3",
            "score": "1"
          }
        ],
        "viewRights": {
          "encodedKey": "8a8086567019cc6c01701a869a4a6d82",
          "isAccessibleByAllUsers": true,
          "roles": []
        },
        "editRights": {
          "encodedKey": "8a8086567019cc6c01701a8a8c066d88",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "unique": false,
        "values": [
          "option 1",
          "option 2",
          "option 3"
        ],
        "amounts": {
          "option 3": "1",
          "option 1": "10",
          "option 2": "5"
        }
      },
      "value": "option 2",
      "amount": "5",
      "indexInList": -1,
      "customFieldID": "sclt_1",
      "customFieldSetGroupIndex": -1
    },
    {
      "encodedKey": "8a8086567019cc6c01701a8b30596da4",
      "parentKey": "8a8086c46f7a3258016f7b4d25f50126",
      "customFieldKey": "8a8086567019cc6c01701a8a8c1a6d94",
      "customField": {
        "encodedKey": "8a8086567019cc6c01701a8a8c1a6d94",
        "id": "slct_2",
        "creationDate": "2020-02-06T12:48:14+0000",
        "lastModifiedDate": "2020-02-06T12:48:14+0000",
        "name": "selection 2",
        "type": "LOAN_ACCOUNT_INFO",
        "dataType": "SELECTION",
        "valueLength": "SHORT",
        "isDefault": false,
        "isRequired": false,
        "description": "",
        "customFieldSet": {
          "encodedKey": "8a8086567019cc6c01701a869a4a6d80",
          "id": "_loans_cf_set",
          "name": "loans cf set",
          "notes": "",
          "createdDate": "2020-02-06T12:46:55+0000",
          "lastModifiedDate": "2020-02-06T12:46:55+0000",
          "indexInList": 0,
          "type": "LOAN_ACCOUNT_INFO",
          "usage": "SINGLE"
        },
        "indexInList": 1,
        "state": "NORMAL",
        "customFieldSelectionOptions": [
          {
            "encodedKey": "8a8086567019cc6c01701a8b30526d9f",
            "id": "789812737",
            "value": "option a",
            "score": "1"
          },
          {
            "encodedKey": "8a8086567019cc6c01701a8b30526da0",
            "id": "000604002",
            "value": "option b",
            "score": "5"
          },
          {
            "encodedKey": "8a8086567019cc6c01701a8b30596da1",
            "id": "343885651",
            "value": "option c",
            "score": "10"
          }
        ],
        "viewRights": {
          "encodedKey": "8a8086567019cc6c01701a8a8c1a6d95",
          "isAccessibleByAllUsers": true,
          "roles": []
        },
        "editRights": {
          "encodedKey": "8a8086567019cc6c01701a8a8c1a6d96",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "unique": false,
        "values": [
          "option a",
          "option b",
          "option c"
        ],
        "amounts": {
          "option c": "10",
          "option a": "1",
          "option b": "5"
        }
      },
      "value": "option c",
      "amount": "10",
      "indexInList": -1,
      "customFieldID": "slct_2",
      "customFieldSetGroupIndex": -1
    }
  ],
  "interestChargeFrequency": "ANNUALIZED",
  "interestCalculationMethod": "DECLINING_BALANCE_DISCOUNTED",
  "interestType": "SIMPLE_INTEREST",
  "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
  "repaymentScheduleMethod": "DYNAMIC",
  "paymentMethod": "HORIZONTAL",
  "interestApplicationMethod": "ON_REPAYMENT",
  "accrueInterestAfterMaturity": false,
  "assignedBranchKey": "8a8086e96f61bf2c016f65f5192a0271",
  "notes": "",
  "principalRepaymentInterval": 1,
  "interestRateSource": "INDEX_INTEREST_RATE",
  "interestRateReviewUnit": "DAYS",
  "interestRateReviewCount": 1,
  "interestSpread": "1",
  "lastInterestReviewDate": "2020-02-06T00:00:00+0000",
  "accruedInterest": "0.19",
  "interestFromArrearsAccrued": "0.02",
  "lastInterestAppliedDate": "2020-02-03T00:00:00+0000",
  "funds": [],
  "guarantees": [],
  "accruedPenalty": "0",
  "loanPenaltyCalculationMethod": "NONE",
  "disbursementDetails": {
    "encodedKey": "8a8086c46f7a3258016f7b4fac3b0127",
    "expectedDisbursementDate": "2019-12-01T00:00:00+0000",
    "disbursementDate": "2019-12-01T00:00:00+0000",
    "firstRepaymentDate": "2020-01-01T00:00:00+0000",
    "transactionDetails": {
      "encodedKey": "8a8086c46f7a3258016f7b4fac3b0128",
      "transactionChannelKey": "8a80877d6f451a5c016f466bdd120049",
      "internalTransfer": false,
      "transactionChannel": {
        "encodedKey": "8a80877d6f451a5c016f466bdd120049",
        "id": "cash",
        "name": "Cash",
        "creationDate": "2019-12-27T09:14:35+0000",
        "index": 0,
        "activated": true,
        "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
        "savingsConstraints": {
          "encodedKey": "8a80877d6f451a5c016f466bea33004b",
          "filterConstraints": []
        },
        "usageRights": {
          "encodedKey": "8a80877d6f451a5c016f466bdd12004a",
          "isAccessibleByAllUsers": true,
          "roles": []
        }
      }
    },
    "fees": [],
    "customInformation": []
  },
  "arrearsTolerancePeriod": 3,
  "accountArrearsSettings": {
    "tolerancePeriod": 3,
    "encodedKey": "8a8086c46f7a3258016f7b4fac3b0129",
    "toleranceCalculationMethod": "ARREARS_TOLERANCE_PERIOD",
    "dateCalculationMethod": "DATE_ACCOUNT_FIRST_WENT_TO_ARREARS",
    "nonWorkingDaysMethod": "EXCLUDED"
  },
  "paymentPlan": [],
  "interestRoundingVersion": "VERSION_2",
  "prepaymentRecalculationMethod": "NO_RECALCULATION",
  "principalPaidInstallmentStatus": "PARTIALLY_PAID",
  "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
  "applyInterestOnPrepaymentMethod": "AUTOMATIC",
  "allowOffset": false,
  "accrueLateInterest": true,
  "holdBalance": "0",
  "fees": [
    {
      "fee": {
        "encodedKey": "8a8080855283305201528369d0d3001c"
      }
    },
    {
      "fee": {
        "encodedKey": "8a8080855283305201528369d0d3001b"
      },
      "amount": "10"
    },
    {
      "fee": {
        "encodedKey": "8a808085528330520152836c5950002a"
      },
      "amount": "55"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	LoanAccountFullDetailsApiV1

Create a new Loan Account

POST /loans

Create a loan account

Create basic loan accounts for individual clients and update the custom field values. The loan account details must be connected to a specific active product.

Details can be provided either by query parameters or as a JSON body.

For JSON POST, if the identifier or encoded key is provided, an update will be executed (for now, only the custom fields can be updated via JSON).

See Custom Fields API for more information about custom fields and custom fields sets.

Example Requests

create a loan account with custom information

{
  "loanAccount": {
    "id": "Custom_ID",
    "accountHolderKey": "40288a13437b71d201437b87aa6300e1",
    "accountHolderType": "CLIENT",
    "creationDate": "2014-01-13T15:00:11+0200",
    "lastModifiedDate": "2014-01-13T15:00:11+0200",
    "accountState": "PENDING_APPROVAL",
    "productTypeKey": "40288a13437b71d201437b87af7d033f",
    "loanName": "Agriculture Loan",
    "loanAmount": "950",
    "principalDue": "0",
    "principalPaid": "0",
    "principalBalance": "0",
    "interestDue": "0",
    "interestPaid": "0",
    "interestBalance": "0",
    "feesDue": "0",
    "feesPaid": "0",
    "feesBalance": "0",
    "penaltyDue": "0",
    "penaltyPaid": "0",
    "penaltyBalance": "0",
    "scheduleDueDatesMethod": "INTERVAL",
    "repaymentPeriodCount": 1,
    "repaymentPeriodUnit": "MONTHS",
    "repaymentInstallments": 5,
    "gracePeriod": 0,
    "gracePeriodType": "NONE",
    "interestRate": "2.5",
    "interestChargeFrequency": "EVERY_FOUR_WEEKS",
    "interestCalculationMethod": "DECLINING_BALANCE",
    "repaymentScheduleMethod": "FIXED",
    "paymentMethod": "HORIZONTAL",
    "interestApplicationMethod": "ON_DISBURSEMENT",
    "notes": "some_notes",
    "principalRepaymentInterval": 1,
    "interestRateSource": "FIXED_INTEREST_RATE",
    "interestAdjustment": "0",
    "accruedInterest": "0",
    "arrearsTolerancePeriod": 10,
    "guarantees": [
      {
        "guarantorKey": "40288a5d4f3fbac9014f3fd02745001d",
        "guarantorType": "CLIENT",
        "amount": "50",
        "type": "GUARANTOR",
        "customFieldValues": [
          {
            "customFieldID": "Employement_status",
            "value": "Self-employed"
          }
        ]
      }
    ],
    "funds": [
      {
        "guarantorKey": "GUARANTOR_KEY",
        "savingsAccountKey": "SAVINGS_ACC_KEY",
        "amount": "500",
        "interestCommission": "4"
      }
    ],
    "disbursementDetails": {
      "expectedDisbursementDate": "2016-01-08",
      "firstRepaymentDate": "2016-02-08",
      "transactionDetails": {
        "transactionChannel": {
          "id": "RECEIPT",
          "encodedKey": "8a8080855281ef57015281ef9bc20436"
        },
        "receiptNumber": "1146",
        "bankNumber": "bank1146"
      },
      "fees": [
        {
          "fee": {
            "encodedKey": "8a8080855283305201528369d0d3001c"
          }
        },
        {
          "fee": {
            "encodedKey": "8a8080855283305201528369d0d3001b"
          },
          "amount": "10"
        },
        {
          "fee": {
            "encodedKey": "8a808085528330520152836c5950002a"
          },
          "amount": "55"
        }
      ]
    }
  },
  "customInformation": [
    {
      "value": "None",
      "customFieldID": "Special_Installements_Loan_Accounts"
    },
    {
      "value": "2",
      "customFieldID": "Family_Members_Loan_Accounts"
    }
  ]
}

Parameters

Name	Type	Description	In
interestRate (required)	number	none	query
notes	string	none	query
clientID (required)	string	none	query
productID (required)	string	none	query
installments (required)	integer	none	query
repaymentInterval	string	none	query
repaymentPeriodCount	integer	none	query
graceLength	integer	none	query
loanAmount (required)	number	none	query
body	LoanAccountApiV1Wrapper	none	body

Example Responses

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	LoanAccountApiV1Wrapper

Search for Loan Accounts

POST /loans/search

Search for loan accounts

Retrieve Loan Accounts using dynamic custom filters.

Example Requests

example filter

{
  "filterConstraints": [
    {
      "filterSelection": "AMOUNT",
      "dataItemType": "TRANCHE",
      "filterElement": "EQUALS",
      "value": "100"
    },
    {
      "filterSelection": "CREATION_DATE",
      "filterElement": "THIS_MONTH"
    }
  ]
}

Parameters

Name	Type	Description	In
offset	integer	none	query
limit	integer	none	query
body	FilterApiV1	none	body

Example Responses

200 : ok
search for a loan account

[
  {
    "accountArrearsSettings": {
      "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
      "encodedKey": "string",
      "monthlyToleranceDay": 0,
      "nonWorkingDaysMethod": "EXCLUDED",
      "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY",
      "toleranceFloorAmount": 0,
      "tolerancePercentageOfOutstandingPrincipal": 0,
      "tolerancePeriod": 0
    },
    "accountHolderKey": "string",
    "accountHolderType": "GROUP",
    "accountState": "WITHDRAWN",
    "accountSubState": "WITHDRAWN",
    "accrueInterestAfterMaturity": true,
    "accrueLateInterest": true,
    "accruedInterest": 0,
    "accruedPenalty": 0,
    "activationTransactionKey": "string",
    "allowOffset": true,
    "applyInterestOnPrepaymentMethod": "AUTOMATIC",
    "approvedDate": "string",
    "arrearsTolerancePeriod": 0,
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "closedDate": "string",
    "creationDate": "string",
    "customFieldValues": [
      {
        "amount": 0,
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "string",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "string",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "string",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "string",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "string",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "string",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "customFieldID": "string",
        "customFieldKey": "string",
        "customFieldSetGroupIndex": 0,
        "encodedKey": "string",
        "indexInList": 0,
        "linkedEntityKeyValue": "string",
        "parentKey": "string",
        "selectionKey": "string",
        "value": "string"
      }
    ],
    "daysInArrears": 0,
    "defaultFirstRepaymentDueDateOffset": 0,
    "disbursementDetails": {
      "customInformation": [
        {
          "amount": 0,
          "customField": {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "string",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "string",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "string",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "string",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "string",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "string",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "customFieldID": "string",
          "customFieldKey": "string",
          "customFieldSetGroupIndex": 0,
          "encodedKey": "string",
          "indexInList": 0,
          "linkedEntityKeyValue": "string",
          "parentKey": "string",
          "selectionKey": "string",
          "value": "string"
        }
      ],
      "disbursementDate": "string",
      "encodedKey": "string",
      "expectedDisbursementDate": "string",
      "fees": [
        {
          "amount": 0,
          "encodedKey": "string",
          "fee": {
            "active": true,
            "amortizationIntervalSettings": {
              "encodedKey": "string",
              "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
              "intervalCount": 0,
              "intervalType": "FULL_TERM",
              "periodCount": 0,
              "periodUnit": "MONTHS"
            },
            "amortizationProfile": "STRAIGHT_LINE",
            "amount": 0,
            "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
            "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
            "creationDate": "string",
            "encodedKey": "string",
            "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
            "feeApplication": "OPTIONAL",
            "feeProductRules": [
              {
                "account": {
                  "activated": true,
                  "allowManualJournalEntries": true,
                  "balance": 0,
                  "creationDate": "string",
                  "currency": {
                    "code": "string",
                    "creationDate": "string",
                    "currencySymbolPosition": "AFTER_NUMBER",
                    "digitsAfterDecimal": 0,
                    "isBaseCurrency": true,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "symbol": "string"
                  },
                  "description": "string",
                  "encodedKey": "string",
                  "glCode": "string",
                  "lastModifiedDate": "string",
                  "migrationEvent": {
                    "creationDate": "string",
                    "encodedKey": "string",
                    "numCentresImported": 0,
                    "numClientsImported": 0,
                    "numGLAccountsImported": 0,
                    "numGroupsImported": 0,
                    "numLoanRepaymentsImported": 0,
                    "numLoanTransactionsImported": 0,
                    "numLoansImported": 0,
                    "numSavingsImported": 0,
                    "state": "REVERTED",
                    "type": "IMPORT"
                  },
                  "name": "string",
                  "stripTrailingZeros": true,
                  "type": "INCOME",
                  "usage": "HEADER"
                },
                "encodedKey": "string",
                "financialResource": "FEE_RECEIVABLE",
                "index": 0,
                "predefinedFeeKey": "string",
                "productKey": "string",
                "productType": "LOAN",
                "transactionChannelKey": "string"
              }
            ],
            "name": "string",
            "percentageAmount": 0,
            "trigger": "DISBURSEMENT"
          }
        }
      ],
      "firstRepaymentDate": "string",
      "transactionDetails": {
        "encodedKey": "string",
        "internalTransfer": true,
        "targetSavingsAccountKey": "string",
        "transactionChannel": {
          "activated": true,
          "createdByUserKey": "string",
          "creationDate": "string",
          "customFields": [
            {
              "amounts": {
                "property1": 0,
                "property2": 0
              },
              "builtInCustomFieldId": "MOBILE_PHONE",
              "creationDate": "string",
              "customFieldProductSettings": [
                {
                  "customFieldEncodedKey": "string",
                  "encodedKey": "string",
                  "isDefault": true,
                  "isRequired": true,
                  "linkType": "CLIENT_ROLE",
                  "productKey": "string"
                }
              ],
              "customFieldSelectionOptions": [
                {
                  "constraint": {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  },
                  "encodedKey": "string",
                  "id": "string",
                  "score": 0,
                  "value": "string"
                }
              ],
              "customFieldSet": {
                "builtInType": "DETAILS",
                "createdDate": "string",
                "customFields": [
                  {}
                ],
                "encodedKey": "string",
                "id": "string",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "notes": "string",
                "type": "USER_INFO",
                "usage": "SINGLE"
              },
              "dataType": "GROUP_LINK",
              "description": "string",
              "editRights": {
                "encodedKey": "string",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              },
              "encodedKey": "string",
              "id": "string",
              "indexInList": 0,
              "isDefault": true,
              "isRequired": true,
              "lastModifiedDate": "string",
              "name": "string",
              "state": "DEACTIVATED",
              "type": "USER_INFO",
              "unique": true,
              "validationPattern": "string",
              "valueLength": "SHORT",
              "values": [
                "string"
              ],
              "viewRights": {
                "encodedKey": "string",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            }
          ],
          "encodedKey": "string",
          "id": "string",
          "index": 0,
          "name": "string",
          "savingsConstraints": {
            "customConfigurationInfo": {
              "creationDate": "string",
              "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
              "encodedKey": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "shared": true,
              "userKey": "string"
            },
            "encodedKey": "string",
            "filterConstraints": [
              {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              }
            ]
          },
          "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
          "transactionChannelAccountingRule": {
            "account": {
              "activated": true,
              "allowManualJournalEntries": true,
              "balance": 0,
              "creationDate": "string",
              "currency": {
                "code": "string",
                "creationDate": "string",
                "currencySymbolPosition": "AFTER_NUMBER",
                "digitsAfterDecimal": 0,
                "isBaseCurrency": true,
                "lastModifiedDate": "string",
                "name": "string",
                "symbol": "string"
              },
              "description": "string",
              "encodedKey": "string",
              "glCode": "string",
              "lastModifiedDate": "string",
              "migrationEvent": {
                "creationDate": "string",
                "encodedKey": "string",
                "numCentresImported": 0,
                "numClientsImported": 0,
                "numGLAccountsImported": 0,
                "numGroupsImported": 0,
                "numLoanRepaymentsImported": 0,
                "numLoanTransactionsImported": 0,
                "numLoansImported": 0,
                "numSavingsImported": 0,
                "state": "REVERTED",
                "type": "IMPORT"
              },
              "name": "string",
              "stripTrailingZeros": true,
              "type": "INCOME",
              "usage": "HEADER"
            },
            "encodedKey": "string",
            "financialResource": "FEE_RECEIVABLE",
            "index": 0,
            "predefinedFeeKey": "string",
            "productKey": "string",
            "productType": "LOAN",
            "transactionChannelKey": "string"
          },
          "usageRights": {
            "encodedKey": "string",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "transactionChannelKey": "string"
      }
    },
    "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
    "encodedKey": "string",
    "feesBalance": 0,
    "feesDue": 0,
    "feesPaid": 0,
    "fixedDaysOfMonth": [
      0
    ],
    "funds": [
      {
        "amount": 0,
        "assetName": "string",
        "customFieldValues": [
          {
            "amount": 0,
            "customField": {
              "amounts": {
                "property1": 0,
                "property2": 0
              },
              "builtInCustomFieldId": "MOBILE_PHONE",
              "creationDate": "string",
              "customFieldProductSettings": [
                {
                  "customFieldEncodedKey": "string",
                  "encodedKey": "string",
                  "isDefault": true,
                  "isRequired": true,
                  "linkType": "CLIENT_ROLE",
                  "productKey": "string"
                }
              ],
              "customFieldSelectionOptions": [
                {
                  "constraint": {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  },
                  "encodedKey": "string",
                  "id": "string",
                  "score": 0,
                  "value": "string"
                }
              ],
              "customFieldSet": {
                "builtInType": "DETAILS",
                "createdDate": "string",
                "customFields": [
                  {}
                ],
                "encodedKey": "string",
                "id": "string",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "notes": "string",
                "type": "USER_INFO",
                "usage": "SINGLE"
              },
              "dataType": "GROUP_LINK",
              "description": "string",
              "editRights": {
                "encodedKey": "string",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              },
              "encodedKey": "string",
              "id": "string",
              "indexInList": 0,
              "isDefault": true,
              "isRequired": true,
              "lastModifiedDate": "string",
              "name": "string",
              "state": "DEACTIVATED",
              "type": "USER_INFO",
              "unique": true,
              "validationPattern": "string",
              "valueLength": "SHORT",
              "values": [
                "string"
              ],
              "viewRights": {
                "encodedKey": "string",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "customFieldID": "string",
            "customFieldKey": "string",
            "customFieldSetGroupIndex": 0,
            "encodedKey": "string",
            "indexInList": 0,
            "linkedEntityKeyValue": "string",
            "parentKey": "string",
            "selectionKey": "string",
            "value": "string"
          }
        ],
        "encodedKey": "string",
        "guarantorKey": "string",
        "guarantorType": "GROUP",
        "id": "string",
        "interestCommission": 0,
        "investmentPercentage": 0,
        "savingsAccountKey": "string",
        "type": "GUARANTOR"
      }
    ],
    "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
    "gracePeriod": 0,
    "gracePeriodType": "PAY_INTEREST_ONLY",
    "guarantees": [
      {
        "amount": 0,
        "assetName": "string",
        "customFieldValues": [
          {
            "amount": 0,
            "customField": {
              "amounts": {
                "property1": 0,
                "property2": 0
              },
              "builtInCustomFieldId": "MOBILE_PHONE",
              "creationDate": "string",
              "customFieldProductSettings": [
                {
                  "customFieldEncodedKey": "string",
                  "encodedKey": "string",
                  "isDefault": true,
                  "isRequired": true,
                  "linkType": "CLIENT_ROLE",
                  "productKey": "string"
                }
              ],
              "customFieldSelectionOptions": [
                {
                  "constraint": {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  },
                  "encodedKey": "string",
                  "id": "string",
                  "score": 0,
                  "value": "string"
                }
              ],
              "customFieldSet": {
                "builtInType": "DETAILS",
                "createdDate": "string",
                "customFields": [
                  {}
                ],
                "encodedKey": "string",
                "id": "string",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "notes": "string",
                "type": "USER_INFO",
                "usage": "SINGLE"
              },
              "dataType": "GROUP_LINK",
              "description": "string",
              "editRights": {
                "encodedKey": "string",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              },
              "encodedKey": "string",
              "id": "string",
              "indexInList": 0,
              "isDefault": true,
              "isRequired": true,
              "lastModifiedDate": "string",
              "name": "string",
              "state": "DEACTIVATED",
              "type": "USER_INFO",
              "unique": true,
              "validationPattern": "string",
              "valueLength": "SHORT",
              "values": [
                "string"
              ],
              "viewRights": {
                "encodedKey": "string",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "customFieldID": "string",
            "customFieldKey": "string",
            "customFieldSetGroupIndex": 0,
            "encodedKey": "string",
            "indexInList": 0,
            "linkedEntityKeyValue": "string",
            "parentKey": "string",
            "selectionKey": "string",
            "value": "string"
          }
        ],
        "encodedKey": "string",
        "guarantorKey": "string",
        "guarantorType": "GROUP",
        "savingsAccountKey": "string",
        "type": "GUARANTOR"
      }
    ],
    "hasCustomSchedule": true,
    "holdBalance": 0,
    "id": "string",
    "interestApplicationMethod": "ON_REPAYMENT",
    "interestBalance": 0,
    "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
    "interestCalculationMethod": "DECLINING_BALANCE",
    "interestChargeFrequency": "EVERY_WEEK",
    "interestCommission": 0,
    "interestDue": 0,
    "interestFromArrearsAccrued": 0,
    "interestFromArrearsBalance": 0,
    "interestFromArrearsDue": 0,
    "interestFromArrearsPaid": 0,
    "interestPaid": 0,
    "interestRate": 0,
    "interestRateReviewCount": 0,
    "interestRateReviewUnit": "MONTHS",
    "interestRateSource": "FIXED_INTEREST_RATE",
    "interestRoundingVersion": "VERSION_2",
    "interestSpread": 0,
    "interestType": "CAPITALIZED_INTEREST",
    "lastAccountAppraisalDate": "string",
    "lastInterestAppliedDate": "string",
    "lastInterestReviewDate": "string",
    "lastLockedDate": "string",
    "lastModifiedDate": "string",
    "lastSetToArrearsDate": "string",
    "lastTaxRateReviewDate": "string",
    "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
    "lineOfCreditKey": "string",
    "loanAmount": 0,
    "loanGroup": {
      "accounts": [
        {}
      ],
      "creationDate": "string",
      "encodedKey": "string",
      "group": {
        "assignedBranchKey": "string",
        "assignedCentreKey": "string",
        "assignedUserKey": "string",
        "clientRole": {
          "encodedKey": "string"
        },
        "creationDate": "string",
        "emailAddress": "string",
        "encodedKey": "string",
        "groupName": "string",
        "homePhone": "string",
        "id": "string",
        "idPattern": "string",
        "lastModifiedDate": "string",
        "loanCycle": 0,
        "migrationEvent": {
          "creationDate": "string",
          "encodedKey": "string",
          "numCentresImported": 0,
          "numClientsImported": 0,
          "numGLAccountsImported": 0,
          "numGroupsImported": 0,
          "numLoanRepaymentsImported": 0,
          "numLoanTransactionsImported": 0,
          "numLoansImported": 0,
          "numSavingsImported": 0,
          "state": "REVERTED",
          "type": "IMPORT"
        },
        "mobilePhone1": "string",
        "notes": "string",
        "preferredLanguage": "PORTUGESE"
      },
      "lastModifiedDate": "string",
      "name": "string",
      "notes": "string"
    },
    "loanName": "string",
    "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
    "lockedOperations": [
      "APPLY_FEES"
    ],
    "migrationEvent": {
      "creationDate": "string",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "notes": "string",
    "originalAccountKey": "string",
    "paymentMethod": "VERTICAL",
    "paymentPlan": [
      {
        "encodedKey": "string",
        "endingInstallmentPosition": 0,
        "index": 0,
        "loanAccountEncodedKey": "string",
        "pmt": 0
      }
    ],
    "penaltyBalance": 0,
    "penaltyDue": 0,
    "penaltyPaid": 0,
    "penaltyRate": 0,
    "periodicPayment": 0,
    "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
    "prepaymentRecalculationMethod": "NO_RECALCULATION",
    "principalBalance": 0,
    "principalDue": 0,
    "principalPaid": 0,
    "principalPaidInstallmentStatus": "PARTIALLY_PAID",
    "principalPaymentSettings": {
      "amount": 0,
      "encodedKey": "string",
      "includeFeesInFloorAmount": true,
      "includeInterestInFloorAmount": true,
      "percentage": 0,
      "principalCeilingValue": 0,
      "principalFloorValue": 0,
      "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
    },
    "principalRepaymentInterval": 0,
    "productTypeKey": "string",
    "redrawBalance": 0,
    "redrawSettings": {
      "account": {},
      "encodedKey": "string",
      "restrictNextDueWithdrawal": true
    },
    "repaymentInstallments": 0,
    "repaymentPeriodCount": 0,
    "repaymentPeriodUnit": "MONTHS",
    "repaymentScheduleMethod": "FIXED",
    "rescheduledAccountKey": "string",
    "scheduleDueDatesMethod": "INTERVAL",
    "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
    "taxRate": 0,
    "tranches": [
      {
        "amount": 0,
        "disbursementTransactionKey": "string",
        "encodedKey": "string",
        "expectedDisbursementDate": "string",
        "index": 0
      }
    ]
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[LoanAccountApiV1]	none	none
» accountArrearsSettings	AccountArrearsSettingsApiV1	none	none
»» dateCalculationMethod	string	the method used to calculate arrears for an account	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» monthlyToleranceDay	number	none	none
»» nonWorkingDaysMethod	string	whether non-working days, such as holidays are included when calculating the number of days in arrears	none
»» toleranceCalculationMethod	string	none	none
»» toleranceFloorAmount	number	Used with the `tolerancePercentageOfOutstandingPrincipal` to set a minimum threshold that must be reached before an account will be set to 'in arrears'	none
»» tolerancePercentageOfOutstandingPrincipal	number	This setting will cause an account to automatically go into arrears if the amount due exceeds a given percentage of the loan amount remaining. Only available for fixed and dynamic term loans.	none
»» tolerancePeriod	number	the number of days a loan repayment can be late before the account will be automatically set to 'in arrears'.	none
» accountHolderKey	string	none	none
» accountHolderType	string	none	none
» accountState	string	none	none
» accountSubState	string	none	none
» accrueInterestAfterMaturity	boolean	none	none
» accrueLateInterest	boolean	none	none
» accruedInterest	number	none	none
» accruedPenalty	number	none	none
» activationTransactionKey	string	none	none
» allowOffset	boolean	none	none
» applyInterestOnPrepaymentMethod	string	none	none
» approvedDate	string	none	none
» arrearsTolerancePeriod	number	none	none
» assignedBranchKey	string	none	none
» assignedCentreKey	string	none	none
» assignedUserKey	string	none	none
» closedDate	string	none	none
» creationDate	string	the date and time when this loan account was created	none
» customFieldValues	[CustomFieldValueApiV1]	none	none
»» amount	number	none	none
»» customField	CustomFieldApiV1	none	none
»»» amounts	object	used when options available for a custom field definition translate to predefined amounts, for example, when the custom field value is used to generate a score	none
»»»» additionalProperties	number	none	none
»»» builtInCustomFieldId	string	if this field is one of the built in custom fiel definitions, this will have a value. These names are reserved and you can not use them for your own custom field definitions	none
»»» creationDate	string	the date on which this custom field definition was created	none
»»» customFieldProductSettings	[CustomFieldLinkApiV1]	none	none
»»»» customFieldEncodedKey	string	the key to the parent custom field definition	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isDefault	boolean	whether this field is displayed by default when creating a new record	none
»»»» isRequired	boolean	whether this field is required when creating a new record	none
»»»» linkType	string	the type of entity this field represents a link to	none
»»»» productKey	string	when the link type is product, this field should contain the encoded key of the linekd product	none
»»» customFieldSelectionOptions	[CustomFieldSelectionApiV1]	[represents a possible selection for select type custom field definitions]	none
»»»» constraint	CustomFilterConstraintApiV1	none	none
»»»»» customFieldKey	string	none	none
»»»»» dataFieldType	string	none	none
»»»»» dataFieldValue	string	none	none
»»»»» dataItemType	string	none	none
»»»»» dataType	string	none	none
»»»»» encodedKey	string	none	none
»»»»» filterElement	string	none	none
»»»»» groupNumber	number	none	none
»»»»» index	number	none	none
»»»»» linkingOperator	string	none	none
»»»»» secondValue	string	none	none
»»»»» value	string	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this selectable item	none
»»»» score	number	the score assigned to this selection	none
»»»» value	string	display name of this option	none
»»» customFieldSet	CustomFieldSetApiV1	none	none
»»»» builtInType	string	if this set is part of the set of built-in custom field sets, its type will be shown here	none
»»»» createdDate	string	the date and time when this custom field set was created	none
»»»» customFields	[CustomFieldApiV1]	an array of custom field definitions included in this custom field set	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this custom field set	none
»»»» indexInList	number	for field sets that can be added to an entity more than once, this number represents the index in the list and is used when changing values	none
»»»» lastModifiedDate	string	the date on which this custom field set was last modified	none
»»»» name	string	the name of this custom field set	none
»»»» notes	string	any notes regarding this custom field set	none
»»»» type	string	the entity type that this custom field definition is attached to	none
»»»» usage	string	whether this custom field set can only be used once, or added multiple times to the same entity	none
»»» dataType	string	the type of custom field definition	none
»»» description	string	a brief description of this custom field definition	none
»»» editRights	UsageRightsApiV1	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isAccessibleByAllUsers	boolean	none	none
»»»» roles	[string]	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» id	string	the ID for this custom field definition	none
»»» indexInList	number	none	none
»»» isDefault	boolean	whether this field will be included by default on new records	none
»»» isRequired	boolean	whether this field is required when creating a new record	none
»»» lastModifiedDate	string	the date on which this custom field definition was last modified	none
»»» name	string	the name of this custom field definition	none
»»» state	string	whether this field is available for use or has been deactivated	none
»»» type	string	the type of data this custom field definition will contain	none
»»» unique	boolean	whether the data in this custom field definition needs to be a unique value	none
»»» validationPattern	string	a user-provided pattern to which data in this custom field definition must conform where @ represents numbers, # represents letters and $ is either a number or letter. Other special characters used as separators are allowed, for example `@@-##-$$$`	none
»»» valueLength	string	whether this field needs to support a large number of characters	none
»»» values	[string]	a list of possible values when the field is a selection field	none
»»» viewRights	UsageRightsApiV1	none	none
»» customFieldID	string	none	none
»» customFieldKey	string	none	none
»» customFieldSetGroupIndex	number	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» indexInList	number	none	none
»» linkedEntityKeyValue	string	none	none
»» parentKey	string	none	none
»» selectionKey	string	none	none
»» value	string	none	none
» daysInArrears	number	none	none
» defaultFirstRepaymentDueDateOffset	number	none	none
» disbursementDetails	DisbursementDetailsApiV1	none	none
»» customInformation	[CustomFieldValueApiV1]	custom field definitions associated with this disbursement	none
»» disbursementDate	string	the date on which the loan was disbursed	none
»» encodedKey	string	the automatically generated ID for this disbursement	none
»» expectedDisbursementDate	string	the date on which this disbursement is expected to take place	none
»» fees	[CustomPredefinedFeeApiV1]	a list of fees associated with the disbursement	none
»»» amount	number	the amount of this fee	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» fee	PredefinedFeeApiV1	none	none
»»»» active	boolean	none	none
»»»» amortizationIntervalSettings	PeriodIntervalSettingsApiV1	none	none
»»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»»» frequency	string	none	none
»»»»» intervalCount	number	none	none
»»»»» intervalType	string	none	none
»»»»» periodCount	number	none	none
»»»»» periodUnit	string	none	none
»»»» amortizationProfile	string	none	none
»»»» amount	number	none	none
»»»» amountCalculationMethod	string	none	none
»»»» applyDateMethod	string	none	none
»»»» creationDate	string	the date and time when this fee was created	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» feeAmortizationUponRescheduleOption	string	none	none
»»»» feeApplication	string	none	none
»»»» feeProductRules	[GLAccountingRuleApiV1]	none	none
»»»»» account	GLAccountApiV1	A general ledger account	none
»»»»»» activated	boolean	whether this general ledger account is in use	none
»»»»»» allowManualJournalEntries	boolean	whether manual entries are allowed for this general ledger account	none
»»»»»» balance	number	the current balance of this general ledger account	none
»»»»»» creationDate	string(date-time)	the date on which this general ledger account was created	read-only
»»»»»» currency	CurrencyApiV1	none	none
»»»»»»» code	string	the three letter ISO code for this currency	none
»»»»»»» creationDate	string	the date on which this currency was created	none
»»»»»»» currencySymbolPosition	string	indicates where the currency symbol should appear in relation to the numeric value	none
»»»»»»» digitsAfterDecimal	number	indicates how many decimal places are allowed for this currency. For example, a currenncy with 100 minor units to 1 major unit, there will be 2 decimal places.	none
»»»»»»» isBaseCurrency	boolean	whether this currency is the base currency for your banking institution	none
»»»»»»» lastModifiedDate	string	the date on which this currency was last modified	none
»»»»»»» name	string	the name of this currency	none
»»»»»»» symbol	string	the currency symnbol used for this currency	none
»»»»»» description	string	an optional description for this general ledger account	none
»»»»»» encodedKey	string	the encoded key of this general ledger account	none
»»»»»» glCode	string	the numeric code for this general ledger account	none
»»»»»» lastModifiedDate	string(date-time)	the date on which this general ledger account was last modified	read-only
»»»»»» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
»»»»»»» creationDate	string(date-time)	the date on which the data import was made	none
»»»»»»» encodedKey	string	the encoded key of this data migration event	none
»»»»»»» numCentresImported	number	the number of centres which were imported during the data migration	none
»»»»»»» numClientsImported	number	the number of clients which were imported as part of the data migration	none
»»»»»»» numGLAccountsImported	number	the number of general ledger accounts which were imported as part of the data migration	none
»»»»»»» numGroupsImported	number	the number of groups which were imported as part of the data migration	none
»»»»»»» numLoanRepaymentsImported	number	the number of loan repayment transations which were imported as part of the data migration	none
»»»»»»» numLoanTransactionsImported	number	the number of loan transactions which were imported as part of the data migration	none
»»»»»»» numLoansImported	number	the number of loan accounts which were imported as part of the data migration	none
»»»»»»» numSavingsImported	number	the number of savings accounts which were imported as part of the data migration	none
»»»»»»» state	string	whether the data import was accepted, is still in a draft state, or was rejected and all data reverted	none
»»»»»»» type	string	the type of migration event	none
»»»»»» name	string	the name of this general ledger account	none
»»»»»» stripTrailingZeros	boolean	controls how this account is organized into header accounts when there are trailing zeroes, for example, for the account code `1100`, if this field is set to true, only the first two numbers will be recognised	none
»»»»»» type	string	the type of general ledger account	none
»»»»»» usage	string	whether this general ledger account is a `DETAIL` account, in which case it will have a value, or a `HEADER` account, in which case its value will be calculated based on the sum of detail accounts under it.	none
»»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»»» financialResource	string	the type of transaction governed by this rule	none
»»»»» index	number	the index in list when there are multiple rules for the same type of transaction	none
»»»»» predefinedFeeKey	string	the encoded key of the predefined key this rule relates to	none
»»»»» productKey	string	the encoded key of the product this rule relates to	none
»»»»» productType	string	the type of account this rule relates to	none
»»»»» transactionChannelKey	string	the encoded key of the transaction channel that this rule relates to	none
»»»» name	string	none	none
»»»» percentageAmount	number	none	none
»»»» trigger	string	none	none
»» firstRepaymentDate	string	the date of the first repayment for the loan	none
»» transactionDetails	TransactionDetailsApiV1	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» internalTransfer	boolean	none	none
»»» targetSavingsAccountKey	string	none	none
»»» transactionChannel	TransactionChannelInTransactionDetailsApiV1	none	none
»»»» activated	boolean	whether this transaction channel is enabled	none
»»»» createdByUserKey	string	the encoded key of the user who created this transaction channel	none
»»»» creationDate	string	the date on which this transaction channel was created	none
»»»» customFields	[CustomFieldApiV1]	none	none
»»»» encodedKey	string	the encoded key for this transaction channel	none
»»»» id	string	the user specified ID for this transaction channel	none
»»»» index	number	none	none
»»»» loanConstraints	CustomFilterApiV1	none	none
»»»»» customConfigurationInfo	CustomConfigurationInfoApiV1	none	none
»»»»»» creationDate	string	the date on which this configuration was created	none
»»»»»» dataViewType	string	the type of entity this configuration is for	none
»»»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»»»» indexInList	number	if more than one configuration exists for a given type, this is its index in the list	none
»»»»»» lastModifiedDate	string	the date on which this configuration was last modified	none
»»»»»» name	string	the name for this configuration	none
»»»»»» shared	boolean	whether this configuration is private or can be used by other users of the system	none
»»»»»» userKey	string	the encoded key of the Mambu user who created this configuration	none
»»»»» encodedKey	string	none	none
»»»»» filterConstraints	[CustomFilterConstraintApiV1]	none	none
»»»» loanConstraintsUsage	string	whether there are any rules regarding usage of this transaction channel with loan accounts	none
»»»» name	string	the name of this transaction channel	none
»»»» savingsConstraints	CustomFilterApiV1	none	none
»»»» savingsConstraintsUsage	string	whether there are any rules regarding usage of this transaction channel with savings accounts	none
»»»» transactionChannelAccountingRule	GLAccountingRuleApiV1	none	none
»»»» usageRights	UsageRightsApiV1	none	none
»»» transactionChannelKey	string	none	none
» elementsRecalculationMethod	string	none	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» feesBalance	number	none	none
» feesDue	number	none	none
» feesPaid	number	none	none
» fixedDaysOfMonth	[number]	none	none
» funds	[InvestorFundApiV1]	[An object containing information about people who may be acting as guarantor for a loan or collatoral being used, for more information please consult our p2p lending support article.]	none
»» amount	number	the amount being funded	none
»» assetName	string	the name of an asset being used as collatoral	none
»» customFieldValues	[CustomFieldValueApiV1]	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» guarantorKey	string	the encoded key of the client who is acting as guarantor	none
»» guarantorType	string	the type of guarantor, either a private individual or a group	none
»» id	string	the ID for this funding action	none
»» interestCommission	number	how much this funder shares in the interest generated by the loan	none
»» investmentPercentage	number	when the type of funding is `investor`, the percentage which will go back to them when repayments are made	none
»» savingsAccountKey	string	the savings account ID of the account being used to back a loan	none
»» type	string	the type of funder, either another client of the bank who is acting as guarantor, an asset being used as collatoral or an investor who shares in the interest generated by the loan	none
» futurePaymentsAcceptance	string	none	none
» gracePeriod	number	none	none
» gracePeriodType	string	none	none
» guarantees	[GuarantyApiV1]	none	none
»» amount	number	the amount being guaranteed	none
»» assetName	string	the name of the asset being used as a guranty	none
»» customFieldValues	[CustomFieldValueApiV1]	a list of custom information for this guranty	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» guarantorKey	string	the encoded key of the client acting as guarantor	none
»» guarantorType	string	the type of entity acting as gurantor, either client or group	none
»» savingsAccountKey	string	the encoded key of the savings account guranteeing the loan	none
»» type	string	the type of guarantor, either asset backed, an investor or private gurantor	none
» hasCustomSchedule	boolean	none	none
» holdBalance	number	none	none
» id	string	none	none
» interestApplicationMethod	string	none	none
» interestBalance	number	none	none
» interestBalanceCalculationMethod	string	none	none
» interestCalculationMethod	string	none	none
» interestChargeFrequency	string	none	none
» interestCommission	number	none	none
» interestDue	number	none	none
» interestFromArrearsAccrued	number	none	none
» interestFromArrearsBalance	number	none	none
» interestFromArrearsDue	number	none	none
» interestFromArrearsPaid	number	none	none
» interestPaid	number	none	none
» interestRate	number	none	none
» interestRateReviewCount	number	none	none
» interestRateReviewUnit	string	none	none
» interestRateSource	string	none	none
» interestRoundingVersion	string	none	none
» interestSpread	number	none	none
» interestType	string	none	none
» lastAccountAppraisalDate	string	none	none
» lastInterestAppliedDate	string	none	none
» lastInterestReviewDate	string	none	none
» lastLockedDate	string	none	none
» lastModifiedDate	string	the date on which this loan account was last modified	none
» lastSetToArrearsDate	string	none	none
» lastTaxRateReviewDate	string	none	none
» latePaymentsRecalculationMethod	string	none	none
» lineOfCreditKey	string	none	none
» loanAmount	number	none	none
» loanGroup	LoanGroupApiV1	none	none
»» accounts	[LoanAccountApiV1]	none	none
»» creationDate	string	the date and time when this group was created	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» group	GroupApiV1	A group object	none
»»» assignedBranchKey	string	the encoded key of the branch to which this group is assigned	none
»»» assignedCentreKey	string	the encoded key of the centre to which this group is assigned	none
»»» assignedUserKey	string	the encoded key of the Mambu user to which this group is assigned	none
»»» clientRole	ClientRoleBasicApiV1	the type of client or group as defined in Mambu in Administration > General Settings > Client Types	none
»»»» encodedKey	string	the automatically generated encoded ID for this client or group type	none
»»» creationDate	string(date-time)	the date and time when this group was created	read-only
»»» emailAddress	string	the email address for this group. This address will be used for automated and manually sent email notifications	none
»»» encodedKey	string	the automatically generated encoded ID for this group	none
»»» groupName	string	the name of the group	none
»»» homePhone	string	the primary landline contact number for this group	none
»»» id	string	the ID for this group	none
»»» idPattern	string	the pattern used to generate IDs	none
»»» lastModifiedDate	string(date-time)	the date on which this group was last modified	read-only
»»» loanCycle	number	this number will increment each time this group takes out and fully pays back a loan	none
»»» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
»»» mobilePhone1	string	the primiary mobile contact number for this group	none
»»» preferredLanguage	string	the language which shoudl ideally be used when communicating with this group	none
»» lastModifiedDate	string	the date on which this group was last modified	none
»» name	string	none	none
»» notes	string	none	none
» loanName	string	none	none
» loanPenaltyCalculationMethod	string	none	none
» lockedOperations	[string]	none	none
» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
» notes	string	none	none
» originalAccountKey	string	none	none
» paymentMethod	string	none	none
» paymentPlan	[PeriodicPaymentApiV1]	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» endingInstallmentPosition	number	none	none
»» index	number	none	none
»» loanAccountEncodedKey	string	none	none
»» pmt	number	none	none
» penaltyBalance	number	none	none
» penaltyDue	number	none	none
» penaltyPaid	number	none	none
» penaltyRate	number	none	none
» periodicPayment	number	none	none
» prepaymentAcceptance	string	none	none
» prepaymentRecalculationMethod	string	none	none
» principalBalance	number	none	none
» principalDue	number	none	none
» principalPaid	number	none	none
» principalPaidInstallmentStatus	string	none	none
» principalPaymentSettings	PrincipalPaymentAccountSettingsApiV1	none	none
»» amount	number	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» includeFeesInFloorAmount	boolean	none	none
»» includeInterestInFloorAmount	boolean	none	none
»» percentage	number	none	none
»» principalCeilingValue	number	none	none
»» principalFloorValue	number	none	none
»» principalPaymentMethod	string	none	none
» principalRepaymentInterval	number	none	none
» productTypeKey	string	none	none
» redrawBalance	number	none	none
» redrawSettings	LoanAccountRedrawSettingsApiV1	none	none
»» account	LoanAccountApiV1	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» restrictNextDueWithdrawal	boolean	none	none
» repaymentInstallments	number	none	none
» repaymentPeriodCount	number	none	none
» repaymentPeriodUnit	string	none	none
» repaymentScheduleMethod	string	none	none
» rescheduledAccountKey	string	none	none
» scheduleDueDatesMethod	string	none	none
» shortMonthHandlingMethod	string	none	none
» taxRate	number	none	none
» tranches	[LoanTrancheApiV1]	none	none
»» amount	number	none	none
»» disbursementTransactionKey	string	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» expectedDisbursementDate	string	none	none
»» index	number	none	none

Enumerated Values

Property	Value
dateCalculationMethod	`DATE_OF_LAST_LATE_REPAYMENT`
dateCalculationMethod	`DATE_ACCOUNT_FIRST_WENT_TO_ARREARS`
nonWorkingDaysMethod	`EXCLUDED`
nonWorkingDaysMethod	`INCLUDED`
toleranceCalculationMethod	`MONTHLY_ARREARS_TOLERANCE_DAY`
toleranceCalculationMethod	`ARREARS_TOLERANCE_PERIOD`
accountHolderType	`GROUP`
accountHolderType	`CLIENT`
accountState	`WITHDRAWN`
accountState	`PARTIALLY_DISBURSED`
accountState	`LOCKED`
accountState	`ACTIVE`
accountState	`CLOSED`
accountState	`PARTIAL_APPLICATION`
accountState	`LOCKED_CAPPING`
accountState	`CLOSED_REJECTED`
accountState	`RESCHEDULED`
accountState	`ACTIVE_IN_ARREARS`
accountState	`MATURED`
accountState	`CLOSED_RESCHEDULED`
accountState	`CLOSED_WITHDRAWN`
accountState	`PENDING_APPROVAL`
accountState	`APPROVED`
accountState	`REFINANCED`
accountState	`DORMANT`
accountState	`CLOSED_WRITTEN_OFF`
accountSubState	`WITHDRAWN`
accountSubState	`PARTIALLY_DISBURSED`
accountSubState	`LOCKED`
accountSubState	`ACTIVE`
accountSubState	`CLOSED`
accountSubState	`PARTIAL_APPLICATION`
accountSubState	`LOCKED_CAPPING`
accountSubState	`CLOSED_REJECTED`
accountSubState	`RESCHEDULED`
accountSubState	`ACTIVE_IN_ARREARS`
accountSubState	`MATURED`
accountSubState	`CLOSED_RESCHEDULED`
accountSubState	`CLOSED_WITHDRAWN`
accountSubState	`PENDING_APPROVAL`
accountSubState	`APPROVED`
accountSubState	`REFINANCED`
accountSubState	`DORMANT`
accountSubState	`CLOSED_WRITTEN_OFF`
applyInterestOnPrepaymentMethod	`AUTOMATIC`
applyInterestOnPrepaymentMethod	`MANUAL`
builtInCustomFieldId	`MOBILE_PHONE`
builtInCustomFieldId	`EMAIL_ADDRESS`
builtInCustomFieldId	`GENDER`
builtInCustomFieldId	`MIDDLE_NAME`
builtInCustomFieldId	`HOME_PHONE`
builtInCustomFieldId	`BIRTHDATE`
builtInCustomFieldId	`LAST_NAME`
builtInCustomFieldId	`FIRST_NAME`
linkType	`CLIENT_ROLE`
linkType	`CHANNEL`
linkType	`PRODUCT`
dataFieldType	`NATIVE`
dataFieldType	`CUSTOM`
dataItemType	`WRITTEN_OFF_LOANS`
dataItemType	`LINE_OF_CREDIT`
dataItemType	`INVESTOR_FUND`
dataItemType	`TRANSACTION_DETAILS`
dataItemType	`DOCUMENT_TEMPLATE`
dataItemType	`PRODUCT`
dataItemType	`MCC_EXPIRATION`
dataItemType	`CENTRE`
dataItemType	`REPAYMENT_COLLECTION`
dataItemType	`TASK`
dataItemType	`OUTSTANDING_PORTFOLIO_AMOUNTS`
dataItemType	`REVENUE`
dataItemType	`COMPOSED_TRANSACTIONS`
dataItemType	`UNION_TRANSACTIONS`
dataItemType	`PRINCIPAL_PAYMENT_SETTINGS`
dataItemType	`LOANS`
dataItemType	`DISBURSEMENT_DETAILS`
dataItemType	`SAVINGS_TRANSACTION`
dataItemType	`IDENTIFICATION_DOCUMENT`
dataItemType	`LOAN_PRODUCT`
dataItemType	`DISBURSED_LOANS`
dataItemType	`LOAN_GROUP`
dataItemType	`TRANSACTION_CHANNEL`
dataItemType	`CUSTOM_PREDEFINED_FEE`
dataItemType	`JOURNAL_ENTRY`
dataItemType	`ATTACHMENT`
dataItemType	`PREDEFINED_FEE`
dataItemType	`TRANCHE`
dataItemType	`TRANSACTION`
dataItemType	`INDEX_RATE_SOURCE`
dataItemType	`GROUP_ROLE`
dataItemType	`LOAN_TRANSACTION`
dataItemType	`CLIENT_ROLE`
dataItemType	`GROUP`
dataItemType	`NOTIFICATION_MESSAGE`
dataItemType	`OUTSTANDING_PORTFOLIO_ACCOUNTS`
dataItemType	`REPAYMENT`
dataItemType	`LOAN_ACCOUNT_GUARANTY`
dataItemType	`BRANCH`
dataItemType	`CURRENCY`
dataItemType	`CARD_TRANSACTION_REVERSAL`
dataItemType	`INTEREST_PRODUCT_SETTINGS`
dataItemType	`CREATED_ACCOUNTS`
dataItemType	`USER`
dataItemType	`SAVINGS_PRODUCT`
dataItemType	`CLIENT`
dataItemType	`PRODUCT_ARREARS_SETTINGS`
dataItemType	`SAVINGS`
dataItemType	`EXPENSE`
dataItemType	`INDEX_RATE`
dataItemType	`NOTIFICATION_TEMPLATE`
dataItemType	`CUSTOM_FIELD_SELECTION`
dataItemType	`ACTIVITY`
dataType	`ENUM`
dataType	`MONEY`
dataType	`NUMBER`
dataType	`DATE_UTC`
dataType	`JAVA_BLOB`
dataType	`OBJECT`
dataType	`BOOLEAN`
dataType	`DATE`
dataType	`PERCENT`
dataType	`BIG_DECIMAL`
dataType	`STRING`
dataType	`KEY`
dataType	`LONG`
filterElement	`STARTS_WITH_CASE_SENSITIVE`
filterElement	`THIS_WEEK`
filterElement	`EQUALS`
filterElement	`STARTS_WITH`
filterElement	`IN`
filterElement	`TODAY`
filterElement	`THIS_YEAR`
filterElement	`BETWEEN`
filterElement	`AFTER`
filterElement	`LESS_THAN`
filterElement	`DIFFERENT_THAN`
filterElement	`THIS_MONTH`
filterElement	`NOT_EMPTY`
filterElement	`BEFORE`
filterElement	`EQUALS_CASE_SENSITIVE`
filterElement	`LAST_DAYS`
filterElement	`MORE_THAN`
filterElement	`EMPTY`
filterElement	`ON`
linkingOperator	`OR`
linkingOperator	`AND`
builtInType	`DETAILS`
builtInType	`GENERAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
usage	`SINGLE`
usage	`GROUPED`
dataType	`GROUP_LINK`
dataType	`DATE`
dataType	`NUMBER`
dataType	`CHECKBOX`
dataType	`CLIENT_LINK`
dataType	`STRING`
dataType	`USER_LINK`
dataType	`SELECTION`
state	`DEACTIVATED`
state	`NORMAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
valueLength	`SHORT`
valueLength	`LONG`
frequency	`ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING`
frequency	`ACCOUNT_INSTALLMENTS_DUE_DATES`
frequency	`CUSTOM_INTERVAL`
intervalType	`FULL_TERM`
intervalType	`PREDEFINED_INTERVALS`
periodUnit	`MONTHS`
periodUnit	`YEARS`
periodUnit	`WEEKS`
periodUnit	`DAYS`
amortizationProfile	`STRAIGHT_LINE`
amortizationProfile	`SUM_OF_YEARS_DIGITS`
amortizationProfile	`EFFECTIVE_INTEREST_RATE`
amortizationProfile	`NONE`
amountCalculationMethod	`LOAN_AMOUNT_PERCENTAGE`
amountCalculationMethod	`LOAN_AMOUNT_PERCENTAGE_NUMBER_OF_INSTALLMENTS`
amountCalculationMethod	`REPAYMENT_PRINCIPAL_AMOUNT_PERCENTAGE`
amountCalculationMethod	`FLAT_NUMBER_OF_INSTALLMENTS`
amountCalculationMethod	`FLAT`
applyDateMethod	`MONTHLY_FROM_ACTIVATION`
applyDateMethod	`FIRST_OF_EVERY_MONTH`
feeAmortizationUponRescheduleOption	`CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT`
feeAmortizationUponRescheduleOption	`END_AMORTIZATION_ON_THE_ORIGINAL_ACCOUNT`
feeApplication	`OPTIONAL`
feeApplication	`REQUIRED`
currencySymbolPosition	`AFTER_NUMBER`
currencySymbolPosition	`BEFORE_NUMBER`
state	`REVERTED`
state	`DRAFT`
state	`APPROVED`
type	`IMPORT`
type	`EXPORT`
type	`INCOME`
type	`EXPENSE`
type	`LIABILITY`
type	`ASSET`
type	`EQUITY`
usage	`HEADER`
usage	`DETAIL`
financialResource	`FEE_RECEIVABLE`
financialResource	`OVERDRAFT_INTEREST_INCOME`
financialResource	`OVERDRAFT_INTEREST_RECEIVABLE`
financialResource	`FEE_INCOME`
financialResource	`INTEREST_PAYABLE`
financialResource	`INTEREST_EXPENSE`
financialResource	`PENALTY_RECEIVABLE`
financialResource	`INTEREST_INCOME`
financialResource	`DEFERRED_TAXES`
financialResource	`DEFERRED_FEE_INCOME`
financialResource	`PORTFOLIO_CONTROL`
financialResource	`DEFERRED_INTERESTS_INCOME`
financialResource	`OVERDRAFT_WRITE_OFF_EXPENSE`
financialResource	`PENALTY_INCOME`
financialResource	`OVERDRAFT_PORTFOLIO_CONTROL`
financialResource	`SAVINGS_CONTROL`
financialResource	`TAXES_RECEIVABLE`
financialResource	`INTEREST_RECEIVABLE`
financialResource	`INTER_BRANCH_TRANSFER`
financialResource	`FUND_SOURCE`
financialResource	`WRITE_OFF_EXPENSE`
financialResource	`DEPOSIT_REFERENCE`
financialResource	`TAXES_PAYABLE`
productType	`LOAN`
productType	`SAVINGS`
trigger	`DISBURSEMENT`
trigger	`ARBITRARY`
trigger	`CAPITALIZED_DISBURSEMENT`
trigger	`MONTHLY_FEE`
trigger	`UPFRONT_DISBURSEMENT`
trigger	`LATE_REPAYMENT`
trigger	`MANUAL`
trigger	`PAYMENT_DUE`
trigger	`PAYMENT_DUE_APPLIED_ON_DUE_DATES`
dataViewType	`PORTAL_ACCOUNT_TRANSACTION`
dataViewType	`LOANS_AGING_ANALYSIS`
dataViewType	`CLOSED_ACCOUNTS`
dataViewType	`CLIENT_OVERVIEW`
dataViewType	`ADMIN_CENTRES`
dataViewType	`USER_NOTIFICATION_MESSAGES`
dataViewType	`LINE_OF_CREDIT`
dataViewType	`USER_OVERVIEW`
dataViewType	`CENTRE_OVERVIEW`
dataViewType	`REPAYMENT_REPAYMENTS_COLLECTION`
dataViewType	`GROUP_OVERVIEW`
dataViewType	`ACTIVITIES_LOOKUP`
dataViewType	`TRANSACTION`
dataViewType	`ADMIN_BRANCHES`
dataViewType	`GROUP`
dataViewType	`BRANCH_OVERVIEW`
dataViewType	`NOTIFICATION_MESSAGE`
dataViewType	`PORTFOLIO_REPORTS`
dataViewType	`GROUP_NOTIFICATION_MESSAGES`
dataViewType	`LOAN_ACCOUNT_SECURITIES_OVERVIEW`
dataViewType	`LINE_OF_CREDIT_OVERVIEW`
dataViewType	`CURRENCIES`
dataViewType	`REPAYMENT`
dataViewType	`TILL_TRANSACTIONS`
dataViewType	`ALL_TASKS`
dataViewType	`CENTRE`
dataViewType	`BRANCH`
dataViewType	`INDEX_RATES_LIST`
dataViewType	`USER_TASKS`
dataViewType	`DOCUMENT_TEMPLATES`
dataViewType	`SAVINGS_TRANSACTIONS_LOOKUP`
dataViewType	`LOAN_ACCOUNT_OVERVIEW`
dataViewType	`DEPOSITS_COLLECTION`
dataViewType	`USER`
dataViewType	`ADMIN_USERS`
dataViewType	`GROUP_TASKS`
dataViewType	`CLIENT`
dataViewType	`LOAN_TRANSACTIONS_LOOKUP`
dataViewType	`LOANS`
dataViewType	`LOANS_REPAYMENTS_COLLECTION`
dataViewType	`CLIENT_TASKS`
dataViewType	`OVERDRAFTS_AGING_ANALYSIS`
dataViewType	`LOAN_ACCOUNT_FUNDING_OVERVIEW`
dataViewType	`SAVINGS`
dataViewType	`SAVINGS_OVERVIEW`
dataViewType	`JOURNAL_ENTRY`
dataViewType	`CLIENT_NOTIFICATION_MESSAGES`
loanConstraintsUsage	`UNCONSTRAINED_USAGE`
loanConstraintsUsage	`LIMITED_USAGE`
savingsConstraintsUsage	`UNCONSTRAINED_USAGE`
savingsConstraintsUsage	`LIMITED_USAGE`
elementsRecalculationMethod	`FIXED_PRINCIPAL_EXPECTED`
elementsRecalculationMethod	`FIXED_TOTAL_EXPECTED`
guarantorType	`GROUP`
guarantorType	`CLIENT`
type	`GUARANTOR`
type	`INVESTOR`
type	`ASSET`
futurePaymentsAcceptance	`ACCEPT_OVERPAYMENTS`
futurePaymentsAcceptance	`NO_FUTURE_PAYMENTS`
futurePaymentsAcceptance	`ACCEPT_FUTURE_PAYMENTS`
gracePeriodType	`PAY_INTEREST_ONLY`
gracePeriodType	`NONE`
gracePeriodType	`INTEREST_FORGIVENESS`
guarantorType	`GROUP`
guarantorType	`CLIENT`
type	`GUARANTOR`
type	`INVESTOR`
type	`ASSET`
interestApplicationMethod	`ON_REPAYMENT`
interestApplicationMethod	`ON_DISBURSEMENT`
interestBalanceCalculationMethod	`PRINCIPAL_ONLY`
interestBalanceCalculationMethod	`PRINCIPAL_AND_INTEREST`
interestCalculationMethod	`DECLINING_BALANCE`
interestCalculationMethod	`DECLINING_BALANCE_DISCOUNTED`
interestCalculationMethod	`FLAT`
interestChargeFrequency	`EVERY_WEEK`
interestChargeFrequency	`ANNUALIZED`
interestChargeFrequency	`EVERY_MONTH`
interestChargeFrequency	`EVERY_X_DAYS`
interestChargeFrequency	`EVERY_FOUR_WEEKS`
interestChargeFrequency	`EVERY_DAY`
interestRateReviewUnit	`MONTHS`
interestRateReviewUnit	`WEEKS`
interestRateReviewUnit	`DAYS`
interestRateSource	`FIXED_INTEREST_RATE`
interestRateSource	`INDEX_INTEREST_RATE`
interestRoundingVersion	`VERSION_2`
interestRoundingVersion	`VERSION_1`
interestRoundingVersion	`VERSION_3`
interestType	`CAPITALIZED_INTEREST`
interestType	`SIMPLE_INTEREST`
latePaymentsRecalculationMethod	`INCREASE_OVERDUE_INSTALLMENTS`
latePaymentsRecalculationMethod	`INCREASE_LAST_INSTALLMENT`
preferredLanguage	`PORTUGESE`
preferredLanguage	`RUSSIAN`
preferredLanguage	`ROMANIAN`
preferredLanguage	`ENGLISH`
preferredLanguage	`SPANISH`
preferredLanguage	`GEORGIAN`
preferredLanguage	`BURMESE`
preferredLanguage	`PHRASE`
preferredLanguage	`CHINESE`
preferredLanguage	`FRENCH`
preferredLanguage	`INDONESIAN`
loanPenaltyCalculationMethod	`OVERDUE_BALANCE_AND_INTEREST`
loanPenaltyCalculationMethod	`OUTSTANDING_PRINCIPAL`
loanPenaltyCalculationMethod	`OVERDUE_BALANCE`
loanPenaltyCalculationMethod	`NONE`
paymentMethod	`VERTICAL`
paymentMethod	`HORIZONTAL`
prepaymentAcceptance	`ACCEPT_PREPAYMENTS`
prepaymentAcceptance	`NO_PREPAYMENTS`
prepaymentRecalculationMethod	`NO_RECALCULATION`
prepaymentRecalculationMethod	`RECALCULATE_SCHEDULE_KEEP_SAME_NUMBER_OF_TERMS`
prepaymentRecalculationMethod	`REDUCE_AMOUNT_PER_INSTALLMENT`
prepaymentRecalculationMethod	`REDUCE_NUMBER_OF_INSTALLMENTS_NEW`
prepaymentRecalculationMethod	`REDUCE_NUMBER_OF_INSTALLMENTS`
prepaymentRecalculationMethod	`RESCHEDULE_REMAINING_REPAYMENTS`
prepaymentRecalculationMethod	`RECALCULATE_SCHEDULE_KEEP_SAME_TOTAL_REPAYMENT_AMOUNT`
prepaymentRecalculationMethod	`RECALCULATE_SCHEDULE_KEEP_SAME_PRINCIPAL_AMOUNT`
principalPaidInstallmentStatus	`PARTIALLY_PAID`
principalPaidInstallmentStatus	`ORIGINAL_TOTAL_EXPECTED_PAID`
principalPaidInstallmentStatus	`PAID`
principalPaymentMethod	`OUTSTANDING_PRINCIPAL_PERCENTAGE`
principalPaymentMethod	`FLAT`
principalPaymentMethod	`TOTAL_BALANCE_PERCENTAGE`
repaymentPeriodUnit	`MONTHS`
repaymentPeriodUnit	`YEARS`
repaymentPeriodUnit	`WEEKS`
repaymentPeriodUnit	`DAYS`
repaymentScheduleMethod	`FIXED`
repaymentScheduleMethod	`NONE`
repaymentScheduleMethod	`DYNAMIC`
scheduleDueDatesMethod	`INTERVAL`
scheduleDueDatesMethod	`FIXED_DAYS_OF_MONTH`
shortMonthHandlingMethod	`LAST_DAY_IN_MONTH`
shortMonthHandlingMethod	`FIRST_DAY_OF_NEXT_MONTH`

Get populated Document for a Loan Account

GET /loans/{loanAccountId}/templates/{templateId}

Get the raw HTML, as a string, of any document template associated with this savings deposit product with all placeholders populated with data for this account.

You can get the ID for templates available for a loan product by calling the Savings Products API. The ID is retuned as encoded key in the templates array. Supported templates for this operation will be of the type ACCOUNT or ACCOUNT_WITH_TRANSACTIONS.

As ACCOUNT_WITH_TRANSACTIONS templates include placeholders for Transaction History you must supply a start and end date for your request. Note that any transcations between 00:00:00 on the start date and 23:59:59 of the end date will be considered when populating the template.

Parameters

Name	Type	Description	In
endDate	string(date)	The last date to consider when the document contains a list of transactions. Required when documents contain a transaction history.	query
startDate	string(date)	The first date to consider when the document contains a list of transcations. Required when documents contain a transaction history.	query
loanAccountId (required)	string	The ID of the loan account. The format is determined by your organization.	path
templateId (required)	string	The ID of the document template.	path

Enumerated Values

Parameter	Value
templateId	`ACCOUNT`
templateId	`ACCOUNT_WITH_TRANSACTIONS`

Example Responses

200 Response

"string"

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	string

Delete a Loan Account

DELETE /loans/{loanAccountId}

Delete an existing loan account.

Parameters

Name	Type	Description	In
loanAccountId (required)	string	The ID of the loan account. The format is determined by your organization.	path

Example Responses

200 Response

{
  "errorSource": "string",
  "returnCode": 0,
  "returnStatus": "string"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	ExecutionStatusApiV1

Get a Loan Account by ID

GET /loans/{loanAccountId}

Get a loan account by ID.

Parameters

Name	Type	Description	In
fullDetails	boolean	none	query
loanAccountId (required)	string	The ID of the loan account. The format is determined by your organization.	path

Example Responses

200 Response

{
  "accountArrearsSettings": {
    "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
    "encodedKey": "string",
    "monthlyToleranceDay": 0,
    "nonWorkingDaysMethod": "EXCLUDED",
    "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY",
    "toleranceFloorAmount": 0,
    "tolerancePercentageOfOutstandingPrincipal": 0,
    "tolerancePeriod": 0
  },
  "accountHolderKey": "string",
  "accountHolderType": "GROUP",
  "accountState": "WITHDRAWN",
  "accountSubState": "WITHDRAWN",
  "accrueInterestAfterMaturity": true,
  "accrueLateInterest": true,
  "accruedInterest": 0,
  "accruedPenalty": 0,
  "activationTransactionKey": "string",
  "allowOffset": true,
  "applyInterestOnPrepaymentMethod": "AUTOMATIC",
  "approvedDate": "string",
  "arrearsTolerancePeriod": 0,
  "assignedBranchKey": "string",
  "assignedCentreKey": "string",
  "assignedUserKey": "string",
  "closedDate": "string",
  "creationDate": "string",
  "customFieldValues": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "daysInArrears": 0,
  "defaultFirstRepaymentDueDateOffset": 0,
  "disbursementDetails": {
    "customInformation": [
      {
        "amount": 0,
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "customFieldID": "string",
        "customFieldKey": "string",
        "customFieldSetGroupIndex": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexInList": 0,
        "linkedEntityKeyValue": "string",
        "parentKey": "string",
        "selectionKey": "string",
        "value": "string"
      }
    ],
    "disbursementDate": "string",
    "encodedKey": "string",
    "expectedDisbursementDate": "string",
    "fees": [
      {
        "amount": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "fee": {
          "active": true,
          "amortizationIntervalSettings": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
            "intervalCount": 0,
            "intervalType": "FULL_TERM",
            "periodCount": 0,
            "periodUnit": "MONTHS"
          },
          "amortizationProfile": "STRAIGHT_LINE",
          "amount": 0,
          "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
          "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
          "creationDate": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
          "feeApplication": "OPTIONAL",
          "feeProductRules": [
            {
              "account": {
                "activated": true,
                "allowManualJournalEntries": true,
                "balance": 0,
                "creationDate": "2019-08-24T14:15:22Z",
                "currency": {
                  "code": "string",
                  "creationDate": "string",
                  "currencySymbolPosition": "AFTER_NUMBER",
                  "digitsAfterDecimal": 0,
                  "isBaseCurrency": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "symbol": "string"
                },
                "description": "string",
                "encodedKey": "string",
                "glCode": "string",
                "lastModifiedDate": "2019-08-24T14:15:22Z",
                "migrationEvent": {
                  "creationDate": "2019-08-24T14:15:22Z",
                  "encodedKey": "string",
                  "numCentresImported": 0,
                  "numClientsImported": 0,
                  "numGLAccountsImported": 0,
                  "numGroupsImported": 0,
                  "numLoanRepaymentsImported": 0,
                  "numLoanTransactionsImported": 0,
                  "numLoansImported": 0,
                  "numSavingsImported": 0,
                  "state": "REVERTED",
                  "type": "IMPORT"
                },
                "name": "string",
                "stripTrailingZeros": true,
                "type": "INCOME",
                "usage": "HEADER"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "financialResource": "FEE_RECEIVABLE",
              "index": 0,
              "predefinedFeeKey": "string",
              "productKey": "string",
              "productType": "LOAN",
              "transactionChannelKey": "string"
            }
          ],
          "name": "string",
          "percentageAmount": 0,
          "trigger": "DISBURSEMENT"
        }
      }
    ],
    "firstRepaymentDate": "string",
    "transactionDetails": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "internalTransfer": true,
      "targetSavingsAccountKey": "string",
      "transactionChannel": {
        "activated": true,
        "createdByUserKey": "string",
        "creationDate": "string",
        "customFields": [
          {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          }
        ],
        "encodedKey": "string",
        "id": "string",
        "index": 0,
        "loanConstraints": {
          "customConfigurationInfo": {
            "creationDate": "string",
            "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "shared": true,
            "userKey": "string"
          },
          "encodedKey": "string",
          "filterConstraints": [
            {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            }
          ]
        },
        "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
        "name": "string",
        "savingsConstraints": {
          "customConfigurationInfo": {
            "creationDate": "string",
            "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "shared": true,
            "userKey": "string"
          },
          "encodedKey": "string",
          "filterConstraints": [
            {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            }
          ]
        },
        "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
        "transactionChannelAccountingRule": {
          "account": {
            "activated": true,
            "allowManualJournalEntries": true,
            "balance": 0,
            "creationDate": "2019-08-24T14:15:22Z",
            "currency": {
              "code": "string",
              "creationDate": "string",
              "currencySymbolPosition": "AFTER_NUMBER",
              "digitsAfterDecimal": 0,
              "isBaseCurrency": true,
              "lastModifiedDate": "string",
              "name": "string",
              "symbol": "string"
            },
            "description": "string",
            "encodedKey": "string",
            "glCode": "string",
            "lastModifiedDate": "2019-08-24T14:15:22Z",
            "migrationEvent": {
              "creationDate": "2019-08-24T14:15:22Z",
              "encodedKey": "string",
              "numCentresImported": 0,
              "numClientsImported": 0,
              "numGLAccountsImported": 0,
              "numGroupsImported": 0,
              "numLoanRepaymentsImported": 0,
              "numLoanTransactionsImported": 0,
              "numLoansImported": 0,
              "numSavingsImported": 0,
              "state": "REVERTED",
              "type": "IMPORT"
            },
            "name": "string",
            "stripTrailingZeros": true,
            "type": "INCOME",
            "usage": "HEADER"
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "financialResource": "FEE_RECEIVABLE",
          "index": 0,
          "predefinedFeeKey": "string",
          "productKey": "string",
          "productType": "LOAN",
          "transactionChannelKey": "string"
        },
        "usageRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "transactionChannelKey": "string"
    }
  },
  "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "feesBalance": 0,
  "feesDue": 0,
  "feesPaid": 0,
  "fixedDaysOfMonth": [
    0
  ],
  "funds": [
    {
      "amount": 0,
      "assetName": "string",
      "customFieldValues": [
        {
          "amount": 0,
          "customField": {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "customFieldID": "string",
          "customFieldKey": "string",
          "customFieldSetGroupIndex": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "linkedEntityKeyValue": "string",
          "parentKey": "string",
          "selectionKey": "string",
          "value": "string"
        }
      ],
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "guarantorKey": "string",
      "guarantorType": "GROUP",
      "id": "string",
      "interestCommission": 0,
      "investmentPercentage": 0,
      "savingsAccountKey": "string",
      "type": "GUARANTOR"
    }
  ],
  "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
  "gracePeriod": 0,
  "gracePeriodType": "PAY_INTEREST_ONLY",
  "guarantees": [
    {
      "amount": 0,
      "assetName": "string",
      "customFieldValues": [
        {
          "amount": 0,
          "customField": {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "customFieldID": "string",
          "customFieldKey": "string",
          "customFieldSetGroupIndex": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "linkedEntityKeyValue": "string",
          "parentKey": "string",
          "selectionKey": "string",
          "value": "string"
        }
      ],
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "guarantorKey": "string",
      "guarantorType": "GROUP",
      "savingsAccountKey": "string",
      "type": "GUARANTOR"
    }
  ],
  "hasCustomSchedule": true,
  "holdBalance": 0,
  "id": "string",
  "interestApplicationMethod": "ON_REPAYMENT",
  "interestBalance": 0,
  "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
  "interestCalculationMethod": "DECLINING_BALANCE",
  "interestChargeFrequency": "EVERY_WEEK",
  "interestCommission": 0,
  "interestDue": 0,
  "interestFromArrearsAccrued": 0,
  "interestFromArrearsBalance": 0,
  "interestFromArrearsDue": 0,
  "interestFromArrearsPaid": 0,
  "interestPaid": 0,
  "interestRate": 0,
  "interestRateReviewCount": 0,
  "interestRateReviewUnit": "MONTHS",
  "interestRateSource": "FIXED_INTEREST_RATE",
  "interestRoundingVersion": "VERSION_2",
  "interestSpread": 0,
  "interestType": "CAPITALIZED_INTEREST",
  "lastAccountAppraisalDate": "string",
  "lastInterestAppliedDate": "string",
  "lastInterestReviewDate": "string",
  "lastLockedDate": "string",
  "lastModifiedDate": "string",
  "lastSetToArrearsDate": "string",
  "lastTaxRateReviewDate": "string",
  "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
  "lineOfCreditKey": "string",
  "loanAmount": 0,
  "loanGroup": {
    "accounts": [
      {
        "accountArrearsSettings": {
          "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
          "encodedKey": "string",
          "monthlyToleranceDay": 0,
          "nonWorkingDaysMethod": "EXCLUDED",
          "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY",
          "toleranceFloorAmount": 0,
          "tolerancePercentageOfOutstandingPrincipal": 0,
          "tolerancePeriod": 0
        },
        "accountHolderKey": "string",
        "accountHolderType": "GROUP",
        "accountState": "WITHDRAWN",
        "accountSubState": "WITHDRAWN",
        "accrueInterestAfterMaturity": true,
        "accrueLateInterest": true,
        "accruedInterest": 0,
        "accruedPenalty": 0,
        "activationTransactionKey": "string",
        "allowOffset": true,
        "applyInterestOnPrepaymentMethod": "AUTOMATIC",
        "approvedDate": "string",
        "arrearsTolerancePeriod": 0,
        "assignedBranchKey": "string",
        "assignedCentreKey": "string",
        "assignedUserKey": "string",
        "closedDate": "string",
        "creationDate": "string",
        "customFieldValues": [
          {
            "amount": 0,
            "customField": {
              "amounts": {
                "property1": 0,
                "property2": 0
              },
              "builtInCustomFieldId": "MOBILE_PHONE",
              "creationDate": "string",
              "customFieldProductSettings": [
                {
                  "customFieldEncodedKey": "string",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isDefault": true,
                  "isRequired": true,
                  "linkType": "CLIENT_ROLE",
                  "productKey": "string"
                }
              ],
              "customFieldSelectionOptions": [
                {
                  "constraint": {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "score": 0,
                  "value": "string"
                }
              ],
              "customFieldSet": {
                "builtInType": "DETAILS",
                "createdDate": "string",
                "customFields": [
                  {}
                ],
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "notes": "string",
                "type": "USER_INFO",
                "usage": "SINGLE"
              },
              "dataType": "GROUP_LINK",
              "description": "string",
              "editRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "isDefault": true,
              "isRequired": true,
              "lastModifiedDate": "string",
              "name": "string",
              "state": "DEACTIVATED",
              "type": "USER_INFO",
              "unique": true,
              "validationPattern": "string",
              "valueLength": "SHORT",
              "values": [
                "string"
              ],
              "viewRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "customFieldID": "string",
            "customFieldKey": "string",
            "customFieldSetGroupIndex": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "linkedEntityKeyValue": "string",
            "parentKey": "string",
            "selectionKey": "string",
            "value": "string"
          }
        ],
        "daysInArrears": 0,
        "defaultFirstRepaymentDueDateOffset": 0,
        "disbursementDetails": {
          "customInformation": [
            {
              "amount": 0,
              "customField": {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              },
              "customFieldID": "string",
              "customFieldKey": "string",
              "customFieldSetGroupIndex": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "linkedEntityKeyValue": "string",
              "parentKey": "string",
              "selectionKey": "string",
              "value": "string"
            }
          ],
          "disbursementDate": "string",
          "encodedKey": "string",
          "expectedDisbursementDate": "string",
          "fees": [
            {
              "amount": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "fee": {
                "active": true,
                "amortizationIntervalSettings": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
                  "intervalCount": 0,
                  "intervalType": "FULL_TERM",
                  "periodCount": 0,
                  "periodUnit": "MONTHS"
                },
                "amortizationProfile": "STRAIGHT_LINE",
                "amount": 0,
                "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
                "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
                "creationDate": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
                "feeApplication": "OPTIONAL",
                "feeProductRules": [
                  {
                    "account": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "financialResource": "FEE_RECEIVABLE",
                    "index": 0,
                    "predefinedFeeKey": "string",
                    "productKey": "string",
                    "productType": "LOAN",
                    "transactionChannelKey": "string"
                  }
                ],
                "name": "string",
                "percentageAmount": 0,
                "trigger": "DISBURSEMENT"
              }
            }
          ],
          "firstRepaymentDate": "string",
          "transactionDetails": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "internalTransfer": true,
            "targetSavingsAccountKey": "string",
            "transactionChannel": {
              "activated": true,
              "createdByUserKey": "string",
              "creationDate": "string",
              "customFields": [
                {
                  "amounts": {
                    "property1": 0,
                    "property2": 0
                  },
                  "builtInCustomFieldId": "MOBILE_PHONE",
                  "creationDate": "string",
                  "customFieldProductSettings": [
                    {}
                  ],
                  "customFieldSelectionOptions": [
                    {}
                  ],
                  "customFieldSet": {
                    "builtInType": "DETAILS",
                    "createdDate": "string",
                    "customFields": [],
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "indexInList": 0,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "notes": "string",
                    "type": "USER_INFO",
                    "usage": "SINGLE"
                  },
                  "dataType": "GROUP_LINK",
                  "description": "string",
                  "editRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "isDefault": true,
                  "isRequired": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "state": "DEACTIVATED",
                  "type": "USER_INFO",
                  "unique": true,
                  "validationPattern": "string",
                  "valueLength": "SHORT",
                  "values": [
                    "string"
                  ],
                  "viewRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  }
                }
              ],
              "encodedKey": "string",
              "id": "string",
              "index": 0,
              "loanConstraints": {
                "customConfigurationInfo": {
                  "creationDate": "string",
                  "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "shared": true,
                  "userKey": "string"
                },
                "encodedKey": "string",
                "filterConstraints": [
                  {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  }
                ]
              },
              "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
              "name": "string",
              "savingsConstraints": {
                "customConfigurationInfo": {
                  "creationDate": "string",
                  "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "shared": true,
                  "userKey": "string"
                },
                "encodedKey": "string",
                "filterConstraints": [
                  {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  }
                ]
              },
              "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
              "transactionChannelAccountingRule": {
                "account": {
                  "activated": true,
                  "allowManualJournalEntries": true,
                  "balance": 0,
                  "creationDate": "2019-08-24T14:15:22Z",
                  "currency": {
                    "code": "string",
                    "creationDate": "string",
                    "currencySymbolPosition": "AFTER_NUMBER",
                    "digitsAfterDecimal": 0,
                    "isBaseCurrency": true,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "symbol": "string"
                  },
                  "description": "string",
                  "encodedKey": "string",
                  "glCode": "string",
                  "lastModifiedDate": "2019-08-24T14:15:22Z",
                  "migrationEvent": {
                    "creationDate": "2019-08-24T14:15:22Z",
                    "encodedKey": "string",
                    "numCentresImported": 0,
                    "numClientsImported": 0,
                    "numGLAccountsImported": 0,
                    "numGroupsImported": 0,
                    "numLoanRepaymentsImported": 0,
                    "numLoanTransactionsImported": 0,
                    "numLoansImported": 0,
                    "numSavingsImported": 0,
                    "state": "REVERTED",
                    "type": "IMPORT"
                  },
                  "name": "string",
                  "stripTrailingZeros": true,
                  "type": "INCOME",
                  "usage": "HEADER"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "financialResource": "FEE_RECEIVABLE",
                "index": 0,
                "predefinedFeeKey": "string",
                "productKey": "string",
                "productType": "LOAN",
                "transactionChannelKey": "string"
              },
              "usageRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "transactionChannelKey": "string"
          }
        },
        "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "feesBalance": 0,
        "feesDue": 0,
        "feesPaid": 0,
        "fixedDaysOfMonth": [
          0
        ],
        "funds": [
          {
            "amount": 0,
            "assetName": "string",
            "customFieldValues": [
              {
                "amount": 0,
                "customField": {
                  "amounts": {
                    "property1": 0,
                    "property2": 0
                  },
                  "builtInCustomFieldId": "MOBILE_PHONE",
                  "creationDate": "string",
                  "customFieldProductSettings": [
                    {}
                  ],
                  "customFieldSelectionOptions": [
                    {}
                  ],
                  "customFieldSet": {
                    "builtInType": "DETAILS",
                    "createdDate": "string",
                    "customFields": [],
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "indexInList": 0,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "notes": "string",
                    "type": "USER_INFO",
                    "usage": "SINGLE"
                  },
                  "dataType": "GROUP_LINK",
                  "description": "string",
                  "editRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "isDefault": true,
                  "isRequired": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "state": "DEACTIVATED",
                  "type": "USER_INFO",
                  "unique": true,
                  "validationPattern": "string",
                  "valueLength": "SHORT",
                  "values": [
                    "string"
                  ],
                  "viewRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  }
                },
                "customFieldID": "string",
                "customFieldKey": "string",
                "customFieldSetGroupIndex": 0,
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "linkedEntityKeyValue": "string",
                "parentKey": "string",
                "selectionKey": "string",
                "value": "string"
              }
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "guarantorKey": "string",
            "guarantorType": "GROUP",
            "id": "string",
            "interestCommission": 0,
            "investmentPercentage": 0,
            "savingsAccountKey": "string",
            "type": "GUARANTOR"
          }
        ],
        "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
        "gracePeriod": 0,
        "gracePeriodType": "PAY_INTEREST_ONLY",
        "guarantees": [
          {
            "amount": 0,
            "assetName": "string",
            "customFieldValues": [
              {
                "amount": 0,
                "customField": {
                  "amounts": {
                    "property1": 0,
                    "property2": 0
                  },
                  "builtInCustomFieldId": "MOBILE_PHONE",
                  "creationDate": "string",
                  "customFieldProductSettings": [
                    {}
                  ],
                  "customFieldSelectionOptions": [
                    {}
                  ],
                  "customFieldSet": {
                    "builtInType": "DETAILS",
                    "createdDate": "string",
                    "customFields": [],
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "indexInList": 0,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "notes": "string",
                    "type": "USER_INFO",
                    "usage": "SINGLE"
                  },
                  "dataType": "GROUP_LINK",
                  "description": "string",
                  "editRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "isDefault": true,
                  "isRequired": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "state": "DEACTIVATED",
                  "type": "USER_INFO",
                  "unique": true,
                  "validationPattern": "string",
                  "valueLength": "SHORT",
                  "values": [
                    "string"
                  ],
                  "viewRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  }
                },
                "customFieldID": "string",
                "customFieldKey": "string",
                "customFieldSetGroupIndex": 0,
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "linkedEntityKeyValue": "string",
                "parentKey": "string",
                "selectionKey": "string",
                "value": "string"
              }
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "guarantorKey": "string",
            "guarantorType": "GROUP",
            "savingsAccountKey": "string",
            "type": "GUARANTOR"
          }
        ],
        "hasCustomSchedule": true,
        "holdBalance": 0,
        "id": "string",
        "interestApplicationMethod": "ON_REPAYMENT",
        "interestBalance": 0,
        "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
        "interestCalculationMethod": "DECLINING_BALANCE",
        "interestChargeFrequency": "EVERY_WEEK",
        "interestCommission": 0,
        "interestDue": 0,
        "interestFromArrearsAccrued": 0,
        "interestFromArrearsBalance": 0,
        "interestFromArrearsDue": 0,
        "interestFromArrearsPaid": 0,
        "interestPaid": 0,
        "interestRate": 0,
        "interestRateReviewCount": 0,
        "interestRateReviewUnit": "MONTHS",
        "interestRateSource": "FIXED_INTEREST_RATE",
        "interestRoundingVersion": "VERSION_2",
        "interestSpread": 0,
        "interestType": "CAPITALIZED_INTEREST",
        "lastAccountAppraisalDate": "string",
        "lastInterestAppliedDate": "string",
        "lastInterestReviewDate": "string",
        "lastLockedDate": "string",
        "lastModifiedDate": "string",
        "lastSetToArrearsDate": "string",
        "lastTaxRateReviewDate": "string",
        "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
        "lineOfCreditKey": "string",
        "loanAmount": 0,
        "loanGroup": {},
        "loanName": "string",
        "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
        "lockedOperations": [
          "APPLY_FEES"
        ],
        "migrationEvent": {
          "creationDate": "2019-08-24T14:15:22Z",
          "encodedKey": "string",
          "numCentresImported": 0,
          "numClientsImported": 0,
          "numGLAccountsImported": 0,
          "numGroupsImported": 0,
          "numLoanRepaymentsImported": 0,
          "numLoanTransactionsImported": 0,
          "numLoansImported": 0,
          "numSavingsImported": 0,
          "state": "REVERTED",
          "type": "IMPORT"
        },
        "notes": "string",
        "originalAccountKey": "string",
        "paymentMethod": "VERTICAL",
        "paymentPlan": [
          {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "endingInstallmentPosition": 0,
            "index": 0,
            "loanAccountEncodedKey": "string",
            "pmt": 0
          }
        ],
        "penaltyBalance": 0,
        "penaltyDue": 0,
        "penaltyPaid": 0,
        "penaltyRate": 0,
        "periodicPayment": 0,
        "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
        "prepaymentRecalculationMethod": "NO_RECALCULATION",
        "principalBalance": 0,
        "principalDue": 0,
        "principalPaid": 0,
        "principalPaidInstallmentStatus": "PARTIALLY_PAID",
        "principalPaymentSettings": {
          "amount": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "includeFeesInFloorAmount": true,
          "includeInterestInFloorAmount": true,
          "percentage": 0,
          "principalCeilingValue": 0,
          "principalFloorValue": 0,
          "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
        },
        "principalRepaymentInterval": 0,
        "productTypeKey": "string",
        "redrawBalance": 0,
        "redrawSettings": {
          "account": {},
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "restrictNextDueWithdrawal": true
        },
        "repaymentInstallments": 0,
        "repaymentPeriodCount": 0,
        "repaymentPeriodUnit": "MONTHS",
        "repaymentScheduleMethod": "FIXED",
        "rescheduledAccountKey": "string",
        "scheduleDueDatesMethod": "INTERVAL",
        "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
        "taxRate": 0,
        "tranches": [
          {
            "amount": 0,
            "disbursementTransactionKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "expectedDisbursementDate": "string",
            "index": 0
          }
        ]
      }
    ],
    "creationDate": "string",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "group": {
      "assignedBranchKey": "string",
      "assignedCentreKey": "string",
      "assignedUserKey": "string",
      "clientRole": {
        "encodedKey": "string"
      },
      "creationDate": "2019-08-24T14:15:22Z",
      "emailAddress": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "groupName": "string",
      "homePhone": "string",
      "id": "string",
      "idPattern": "string",
      "lastModifiedDate": "2019-08-24T14:15:22Z",
      "loanCycle": 0,
      "migrationEvent": {
        "creationDate": "2019-08-24T14:15:22Z",
        "encodedKey": "string",
        "numCentresImported": 0,
        "numClientsImported": 0,
        "numGLAccountsImported": 0,
        "numGroupsImported": 0,
        "numLoanRepaymentsImported": 0,
        "numLoanTransactionsImported": 0,
        "numLoansImported": 0,
        "numSavingsImported": 0,
        "state": "REVERTED",
        "type": "IMPORT"
      },
      "mobilePhone1": "string",
      "preferredLanguage": "PORTUGESE"
    },
    "lastModifiedDate": "string",
    "name": "string",
    "notes": "string"
  },
  "loanName": "string",
  "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
  "lockedOperations": [
    "APPLY_FEES"
  ],
  "migrationEvent": {
    "creationDate": "2019-08-24T14:15:22Z",
    "encodedKey": "string",
    "numCentresImported": 0,
    "numClientsImported": 0,
    "numGLAccountsImported": 0,
    "numGroupsImported": 0,
    "numLoanRepaymentsImported": 0,
    "numLoanTransactionsImported": 0,
    "numLoansImported": 0,
    "numSavingsImported": 0,
    "state": "REVERTED",
    "type": "IMPORT"
  },
  "notes": "string",
  "originalAccountKey": "string",
  "paymentMethod": "VERTICAL",
  "paymentPlan": [
    {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "endingInstallmentPosition": 0,
      "index": 0,
      "loanAccountEncodedKey": "string",
      "pmt": 0
    }
  ],
  "penaltyBalance": 0,
  "penaltyDue": 0,
  "penaltyPaid": 0,
  "penaltyRate": 0,
  "periodicPayment": 0,
  "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
  "prepaymentRecalculationMethod": "NO_RECALCULATION",
  "principalBalance": 0,
  "principalDue": 0,
  "principalPaid": 0,
  "principalPaidInstallmentStatus": "PARTIALLY_PAID",
  "principalPaymentSettings": {
    "amount": 0,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "includeFeesInFloorAmount": true,
    "includeInterestInFloorAmount": true,
    "percentage": 0,
    "principalCeilingValue": 0,
    "principalFloorValue": 0,
    "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
  },
  "principalRepaymentInterval": 0,
  "productTypeKey": "string",
  "redrawBalance": 0,
  "redrawSettings": {
    "account": {
      "accountArrearsSettings": {
        "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
        "encodedKey": "string",
        "monthlyToleranceDay": 0,
        "nonWorkingDaysMethod": "EXCLUDED",
        "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY",
        "toleranceFloorAmount": 0,
        "tolerancePercentageOfOutstandingPrincipal": 0,
        "tolerancePeriod": 0
      },
      "accountHolderKey": "string",
      "accountHolderType": "GROUP",
      "accountState": "WITHDRAWN",
      "accountSubState": "WITHDRAWN",
      "accrueInterestAfterMaturity": true,
      "accrueLateInterest": true,
      "accruedInterest": 0,
      "accruedPenalty": 0,
      "activationTransactionKey": "string",
      "allowOffset": true,
      "applyInterestOnPrepaymentMethod": "AUTOMATIC",
      "approvedDate": "string",
      "arrearsTolerancePeriod": 0,
      "assignedBranchKey": "string",
      "assignedCentreKey": "string",
      "assignedUserKey": "string",
      "closedDate": "string",
      "creationDate": "string",
      "customFieldValues": [
        {
          "amount": 0,
          "customField": {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "customFieldID": "string",
          "customFieldKey": "string",
          "customFieldSetGroupIndex": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "linkedEntityKeyValue": "string",
          "parentKey": "string",
          "selectionKey": "string",
          "value": "string"
        }
      ],
      "daysInArrears": 0,
      "defaultFirstRepaymentDueDateOffset": 0,
      "disbursementDetails": {
        "customInformation": [
          {
            "amount": 0,
            "customField": {
              "amounts": {
                "property1": 0,
                "property2": 0
              },
              "builtInCustomFieldId": "MOBILE_PHONE",
              "creationDate": "string",
              "customFieldProductSettings": [
                {
                  "customFieldEncodedKey": "string",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isDefault": true,
                  "isRequired": true,
                  "linkType": "CLIENT_ROLE",
                  "productKey": "string"
                }
              ],
              "customFieldSelectionOptions": [
                {
                  "constraint": {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "score": 0,
                  "value": "string"
                }
              ],
              "customFieldSet": {
                "builtInType": "DETAILS",
                "createdDate": "string",
                "customFields": [
                  {}
                ],
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "notes": "string",
                "type": "USER_INFO",
                "usage": "SINGLE"
              },
              "dataType": "GROUP_LINK",
              "description": "string",
              "editRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "isDefault": true,
              "isRequired": true,
              "lastModifiedDate": "string",
              "name": "string",
              "state": "DEACTIVATED",
              "type": "USER_INFO",
              "unique": true,
              "validationPattern": "string",
              "valueLength": "SHORT",
              "values": [
                "string"
              ],
              "viewRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "customFieldID": "string",
            "customFieldKey": "string",
            "customFieldSetGroupIndex": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "linkedEntityKeyValue": "string",
            "parentKey": "string",
            "selectionKey": "string",
            "value": "string"
          }
        ],
        "disbursementDate": "string",
        "encodedKey": "string",
        "expectedDisbursementDate": "string",
        "fees": [
          {
            "amount": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "fee": {
              "active": true,
              "amortizationIntervalSettings": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
                "intervalCount": 0,
                "intervalType": "FULL_TERM",
                "periodCount": 0,
                "periodUnit": "MONTHS"
              },
              "amortizationProfile": "STRAIGHT_LINE",
              "amount": 0,
              "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
              "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
              "creationDate": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
              "feeApplication": "OPTIONAL",
              "feeProductRules": [
                {
                  "account": {
                    "activated": true,
                    "allowManualJournalEntries": true,
                    "balance": 0,
                    "creationDate": "2019-08-24T14:15:22Z",
                    "currency": {},
                    "description": "string",
                    "encodedKey": "string",
                    "glCode": "string",
                    "lastModifiedDate": "2019-08-24T14:15:22Z",
                    "migrationEvent": {},
                    "name": "string",
                    "stripTrailingZeros": true,
                    "type": "INCOME",
                    "usage": "HEADER"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "financialResource": "FEE_RECEIVABLE",
                  "index": 0,
                  "predefinedFeeKey": "string",
                  "productKey": "string",
                  "productType": "LOAN",
                  "transactionChannelKey": "string"
                }
              ],
              "name": "string",
              "percentageAmount": 0,
              "trigger": "DISBURSEMENT"
            }
          }
        ],
        "firstRepaymentDate": "string",
        "transactionDetails": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "internalTransfer": true,
          "targetSavingsAccountKey": "string",
          "transactionChannel": {
            "activated": true,
            "createdByUserKey": "string",
            "creationDate": "string",
            "customFields": [
              {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              }
            ],
            "encodedKey": "string",
            "id": "string",
            "index": 0,
            "loanConstraints": {
              "customConfigurationInfo": {
                "creationDate": "string",
                "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "shared": true,
                "userKey": "string"
              },
              "encodedKey": "string",
              "filterConstraints": [
                {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                }
              ]
            },
            "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
            "name": "string",
            "savingsConstraints": {
              "customConfigurationInfo": {
                "creationDate": "string",
                "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "shared": true,
                "userKey": "string"
              },
              "encodedKey": "string",
              "filterConstraints": [
                {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                }
              ]
            },
            "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
            "transactionChannelAccountingRule": {
              "account": {
                "activated": true,
                "allowManualJournalEntries": true,
                "balance": 0,
                "creationDate": "2019-08-24T14:15:22Z",
                "currency": {
                  "code": "string",
                  "creationDate": "string",
                  "currencySymbolPosition": "AFTER_NUMBER",
                  "digitsAfterDecimal": 0,
                  "isBaseCurrency": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "symbol": "string"
                },
                "description": "string",
                "encodedKey": "string",
                "glCode": "string",
                "lastModifiedDate": "2019-08-24T14:15:22Z",
                "migrationEvent": {
                  "creationDate": "2019-08-24T14:15:22Z",
                  "encodedKey": "string",
                  "numCentresImported": 0,
                  "numClientsImported": 0,
                  "numGLAccountsImported": 0,
                  "numGroupsImported": 0,
                  "numLoanRepaymentsImported": 0,
                  "numLoanTransactionsImported": 0,
                  "numLoansImported": 0,
                  "numSavingsImported": 0,
                  "state": "REVERTED",
                  "type": "IMPORT"
                },
                "name": "string",
                "stripTrailingZeros": true,
                "type": "INCOME",
                "usage": "HEADER"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "financialResource": "FEE_RECEIVABLE",
              "index": 0,
              "predefinedFeeKey": "string",
              "productKey": "string",
              "productType": "LOAN",
              "transactionChannelKey": "string"
            },
            "usageRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "transactionChannelKey": "string"
        }
      },
      "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "feesBalance": 0,
      "feesDue": 0,
      "feesPaid": 0,
      "fixedDaysOfMonth": [
        0
      ],
      "funds": [
        {
          "amount": 0,
          "assetName": "string",
          "customFieldValues": [
            {
              "amount": 0,
              "customField": {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              },
              "customFieldID": "string",
              "customFieldKey": "string",
              "customFieldSetGroupIndex": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "linkedEntityKeyValue": "string",
              "parentKey": "string",
              "selectionKey": "string",
              "value": "string"
            }
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "guarantorKey": "string",
          "guarantorType": "GROUP",
          "id": "string",
          "interestCommission": 0,
          "investmentPercentage": 0,
          "savingsAccountKey": "string",
          "type": "GUARANTOR"
        }
      ],
      "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
      "gracePeriod": 0,
      "gracePeriodType": "PAY_INTEREST_ONLY",
      "guarantees": [
        {
          "amount": 0,
          "assetName": "string",
          "customFieldValues": [
            {
              "amount": 0,
              "customField": {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              },
              "customFieldID": "string",
              "customFieldKey": "string",
              "customFieldSetGroupIndex": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "linkedEntityKeyValue": "string",
              "parentKey": "string",
              "selectionKey": "string",
              "value": "string"
            }
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "guarantorKey": "string",
          "guarantorType": "GROUP",
          "savingsAccountKey": "string",
          "type": "GUARANTOR"
        }
      ],
      "hasCustomSchedule": true,
      "holdBalance": 0,
      "id": "string",
      "interestApplicationMethod": "ON_REPAYMENT",
      "interestBalance": 0,
      "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
      "interestCalculationMethod": "DECLINING_BALANCE",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestCommission": 0,
      "interestDue": 0,
      "interestFromArrearsAccrued": 0,
      "interestFromArrearsBalance": 0,
      "interestFromArrearsDue": 0,
      "interestFromArrearsPaid": 0,
      "interestPaid": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRoundingVersion": "VERSION_2",
      "interestSpread": 0,
      "interestType": "CAPITALIZED_INTEREST",
      "lastAccountAppraisalDate": "string",
      "lastInterestAppliedDate": "string",
      "lastInterestReviewDate": "string",
      "lastLockedDate": "string",
      "lastModifiedDate": "string",
      "lastSetToArrearsDate": "string",
      "lastTaxRateReviewDate": "string",
      "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
      "lineOfCreditKey": "string",
      "loanAmount": 0,
      "loanGroup": {
        "accounts": [
          {}
        ],
        "creationDate": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "group": {
          "assignedBranchKey": "string",
          "assignedCentreKey": "string",
          "assignedUserKey": "string",
          "clientRole": {
            "encodedKey": "string"
          },
          "creationDate": "2019-08-24T14:15:22Z",
          "emailAddress": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "groupName": "string",
          "homePhone": "string",
          "id": "string",
          "idPattern": "string",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "loanCycle": 0,
          "migrationEvent": {
            "creationDate": "2019-08-24T14:15:22Z",
            "encodedKey": "string",
            "numCentresImported": 0,
            "numClientsImported": 0,
            "numGLAccountsImported": 0,
            "numGroupsImported": 0,
            "numLoanRepaymentsImported": 0,
            "numLoanTransactionsImported": 0,
            "numLoansImported": 0,
            "numSavingsImported": 0,
            "state": "REVERTED",
            "type": "IMPORT"
          },
          "mobilePhone1": "string",
          "preferredLanguage": "PORTUGESE"
        },
        "lastModifiedDate": "string",
        "name": "string",
        "notes": "string"
      },
      "loanName": "string",
      "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
      "lockedOperations": [
        "APPLY_FEES"
      ],
      "migrationEvent": {
        "creationDate": "2019-08-24T14:15:22Z",
        "encodedKey": "string",
        "numCentresImported": 0,
        "numClientsImported": 0,
        "numGLAccountsImported": 0,
        "numGroupsImported": 0,
        "numLoanRepaymentsImported": 0,
        "numLoanTransactionsImported": 0,
        "numLoansImported": 0,
        "numSavingsImported": 0,
        "state": "REVERTED",
        "type": "IMPORT"
      },
      "notes": "string",
      "originalAccountKey": "string",
      "paymentMethod": "VERTICAL",
      "paymentPlan": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingInstallmentPosition": 0,
          "index": 0,
          "loanAccountEncodedKey": "string",
          "pmt": 0
        }
      ],
      "penaltyBalance": 0,
      "penaltyDue": 0,
      "penaltyPaid": 0,
      "penaltyRate": 0,
      "periodicPayment": 0,
      "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
      "prepaymentRecalculationMethod": "NO_RECALCULATION",
      "principalBalance": 0,
      "principalDue": 0,
      "principalPaid": 0,
      "principalPaidInstallmentStatus": "PARTIALLY_PAID",
      "principalPaymentSettings": {
        "amount": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "includeFeesInFloorAmount": true,
        "includeInterestInFloorAmount": true,
        "percentage": 0,
        "principalCeilingValue": 0,
        "principalFloorValue": 0,
        "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
      },
      "principalRepaymentInterval": 0,
      "productTypeKey": "string",
      "redrawBalance": 0,
      "redrawSettings": {},
      "repaymentInstallments": 0,
      "repaymentPeriodCount": 0,
      "repaymentPeriodUnit": "MONTHS",
      "repaymentScheduleMethod": "FIXED",
      "rescheduledAccountKey": "string",
      "scheduleDueDatesMethod": "INTERVAL",
      "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
      "taxRate": 0,
      "tranches": [
        {
          "amount": 0,
          "disbursementTransactionKey": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "expectedDisbursementDate": "string",
          "index": 0
        }
      ]
    },
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "restrictNextDueWithdrawal": true
  },
  "repaymentInstallments": 0,
  "repaymentPeriodCount": 0,
  "repaymentPeriodUnit": "MONTHS",
  "repaymentScheduleMethod": "FIXED",
  "rescheduledAccountKey": "string",
  "scheduleDueDatesMethod": "INTERVAL",
  "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
  "taxRate": 0,
  "tranches": [
    {
      "amount": 0,
      "disbursementTransactionKey": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "expectedDisbursementDate": "string",
      "index": 0
    }
  ]
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	LoanAccountApiV1

Update a Loan Account

PATCH /loans/{loanAccountId}

Update an existing loan account.

Example Requests

change the number of repayments

{
  "loanAccount": {
    "loanAmount": "1000",
    "repaymentPeriodCount": "10"
  }
}

Parameters

Name	Type	Description	In
body	LoanAccountPatchRequest	none	body
loanAccountId (required)	string	The ID of the loan account. The format is determined by your organization.	path

Example Responses

200 Response

{
  "errorSource": "string",
  "returnCode": 0,
  "returnStatus": "string"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	ExecutionStatusApiV1

Update custom field values (loan account)

PATCH /loans/{loanAccountId}/custominformation

Update custom field values in a custom field set for a given loan account.

Example Requests

Update a single custom field value

{
  "customInformation": [
    {
      "customFieldID": "custom_field_2",
      "value": "3"
    }
  ]
}

Update a field in a group

{
  "customInformation": [
    {
      "customFieldID": "cf_grouped_field",
      "value": "new value",
      "customFieldSetGroupIndex": "0"
    }
  ]
}

Update mutliple custom field values

{
  "customInformation": [
    {
      "customFieldID": "custom_field",
      "customFieldSetGroupIndex": 1,
      "value": "Harrow"
    },
    {
      "customFieldId": "another_field",
      "value": "TRUE"
    }
  ]
}

Parameters

Name	Type	Description	In
body	UpdateCustomInformationRequest	none	body
loanAccountId (required)	string	The ID of the loan account. The format is determined by your organization.	path

Example Responses

200 Response

{
  "errorSource": "string",
  "returnCode": 0,
  "returnStatus": "string"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	ExecutionStatusApiV1

Delete custom information (loan account)

DELETE /loans/{loanAccountId}/custominformation/{customFieldId}

Delete some custom information associated with a loan account.

Parameters

Name	Type	Description	In
loanAccountId (required)	string	The ID of the loan account. The format is determined by your organization.	path
customFieldId (required)	string	The ID of the custom field definition. The format is determined by your organization.	path

Example Responses

200 Response

{
  "errorSource": "string",
  "returnCode": 0,
  "returnStatus": "string"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	ExecutionStatusApiV1

Get custom information (loan account)

GET /loans/{loanAccountId}/custominformation/{customFieldId}

Get custom information for a custom field definition associated with a loan account.

Parameters

Name	Type	Description	In
loanAccountId (required)	string	The ID of the loan account. The format is determined by your organization.	path
customFieldId (required)	string	The ID of the custom field definition. The format is determined by your organization.	path

Example Responses

200 Response

[
  {
    "amount": 0,
    "customField": {
      "amounts": {
        "property1": 0,
        "property2": 0
      },
      "builtInCustomFieldId": "MOBILE_PHONE",
      "creationDate": "string",
      "customFieldProductSettings": [
        {
          "customFieldEncodedKey": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isDefault": true,
          "isRequired": true,
          "linkType": "CLIENT_ROLE",
          "productKey": "string"
        }
      ],
      "customFieldSelectionOptions": [
        {
          "constraint": {
            "customFieldKey": "string",
            "dataFieldType": "NATIVE",
            "dataFieldValue": "string",
            "dataItemType": "WRITTEN_OFF_LOANS",
            "dataType": "ENUM",
            "encodedKey": "string",
            "filterElement": "STARTS_WITH_CASE_SENSITIVE",
            "groupNumber": 0,
            "index": 0,
            "linkingOperator": "OR",
            "secondValue": "string",
            "value": "string"
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "score": 0,
          "value": "string"
        }
      ],
      "customFieldSet": {
        "builtInType": "DETAILS",
        "createdDate": "string",
        "customFields": [
          {}
        ],
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "lastModifiedDate": "string",
        "name": "string",
        "notes": "string",
        "type": "USER_INFO",
        "usage": "SINGLE"
      },
      "dataType": "GROUP_LINK",
      "description": "string",
      "editRights": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "isAccessibleByAllUsers": true,
        "roles": [
          "string"
        ]
      },
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "id": "string",
      "indexInList": 0,
      "isDefault": true,
      "isRequired": true,
      "lastModifiedDate": "string",
      "name": "string",
      "state": "DEACTIVATED",
      "type": "USER_INFO",
      "unique": true,
      "validationPattern": "string",
      "valueLength": "SHORT",
      "values": [
        "string"
      ],
      "viewRights": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "isAccessibleByAllUsers": true,
        "roles": [
          "string"
        ]
      }
    },
    "customFieldID": "string",
    "customFieldKey": "string",
    "customFieldSetGroupIndex": 0,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "indexInList": 0,
    "linkedEntityKeyValue": "string",
    "parentKey": "string",
    "selectionKey": "string",
    "value": "string"
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[CustomFieldValueApiV1]	none	none
» amount	number	none	none
» customField	CustomFieldApiV1	none	none
»» amounts	object	used when options available for a custom field definition translate to predefined amounts, for example, when the custom field value is used to generate a score	none
»»» additionalProperties	number	none	none
»» builtInCustomFieldId	string	if this field is one of the built in custom fiel definitions, this will have a value. These names are reserved and you can not use them for your own custom field definitions	none
»» creationDate	string	the date on which this custom field definition was created	none
»» customFieldProductSettings	[CustomFieldLinkApiV1]	none	none
»»» customFieldEncodedKey	string	the key to the parent custom field definition	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» isDefault	boolean	whether this field is displayed by default when creating a new record	none
»»» isRequired	boolean	whether this field is required when creating a new record	none
»»» linkType	string	the type of entity this field represents a link to	none
»»» productKey	string	when the link type is product, this field should contain the encoded key of the linekd product	none
»» customFieldSelectionOptions	[CustomFieldSelectionApiV1]	[represents a possible selection for select type custom field definitions]	none
»»» constraint	CustomFilterConstraintApiV1	none	none
»»»» customFieldKey	string	none	none
»»»» dataFieldType	string	none	none
»»»» dataFieldValue	string	none	none
»»»» dataItemType	string	none	none
»»»» dataType	string	none	none
»»»» encodedKey	string	none	none
»»»» filterElement	string	none	none
»»»» groupNumber	number	none	none
»»»» index	number	none	none
»»»» linkingOperator	string	none	none
»»»» secondValue	string	none	none
»»»» value	string	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» id	string	the ID of this selectable item	none
»»» score	number	the score assigned to this selection	none
»»» value	string	display name of this option	none
»» customFieldSet	CustomFieldSetApiV1	none	none
»»» builtInType	string	if this set is part of the set of built-in custom field sets, its type will be shown here	none
»»» createdDate	string	the date and time when this custom field set was created	none
»»» customFields	[CustomFieldApiV1]	an array of custom field definitions included in this custom field set	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» id	string	the ID of this custom field set	none
»»» indexInList	number	for field sets that can be added to an entity more than once, this number represents the index in the list and is used when changing values	none
»»» lastModifiedDate	string	the date on which this custom field set was last modified	none
»»» name	string	the name of this custom field set	none
»»» notes	string	any notes regarding this custom field set	none
»»» type	string	the entity type that this custom field definition is attached to	none
»»» usage	string	whether this custom field set can only be used once, or added multiple times to the same entity	none
»» dataType	string	the type of custom field definition	none
»» description	string	a brief description of this custom field definition	none
»» editRights	UsageRightsApiV1	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» isAccessibleByAllUsers	boolean	none	none
»»» roles	[string]	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» id	string	the ID for this custom field definition	none
»» indexInList	number	none	none
»» isDefault	boolean	whether this field will be included by default on new records	none
»» isRequired	boolean	whether this field is required when creating a new record	none
»» lastModifiedDate	string	the date on which this custom field definition was last modified	none
»» name	string	the name of this custom field definition	none
»» state	string	whether this field is available for use or has been deactivated	none
»» type	string	the type of data this custom field definition will contain	none
»» unique	boolean	whether the data in this custom field definition needs to be a unique value	none
»» validationPattern	string	a user-provided pattern to which data in this custom field definition must conform where @ represents numbers, # represents letters and $ is either a number or letter. Other special characters used as separators are allowed, for example `@@-##-$$$`	none
»» valueLength	string	whether this field needs to support a large number of characters	none
»» values	[string]	a list of possible values when the field is a selection field	none
»» viewRights	UsageRightsApiV1	none	none
» customFieldID	string	none	none
» customFieldKey	string	none	none
» customFieldSetGroupIndex	number	none	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» indexInList	number	none	none
» linkedEntityKeyValue	string	none	none
» parentKey	string	none	none
» selectionKey	string	none	none
» value	string	none	none

Enumerated Values

Property	Value
builtInCustomFieldId	`MOBILE_PHONE`
builtInCustomFieldId	`EMAIL_ADDRESS`
builtInCustomFieldId	`GENDER`
builtInCustomFieldId	`MIDDLE_NAME`
builtInCustomFieldId	`HOME_PHONE`
builtInCustomFieldId	`BIRTHDATE`
builtInCustomFieldId	`LAST_NAME`
builtInCustomFieldId	`FIRST_NAME`
linkType	`CLIENT_ROLE`
linkType	`CHANNEL`
linkType	`PRODUCT`
dataFieldType	`NATIVE`
dataFieldType	`CUSTOM`
dataItemType	`WRITTEN_OFF_LOANS`
dataItemType	`LINE_OF_CREDIT`
dataItemType	`INVESTOR_FUND`
dataItemType	`TRANSACTION_DETAILS`
dataItemType	`DOCUMENT_TEMPLATE`
dataItemType	`PRODUCT`
dataItemType	`MCC_EXPIRATION`
dataItemType	`CENTRE`
dataItemType	`REPAYMENT_COLLECTION`
dataItemType	`TASK`
dataItemType	`OUTSTANDING_PORTFOLIO_AMOUNTS`
dataItemType	`REVENUE`
dataItemType	`COMPOSED_TRANSACTIONS`
dataItemType	`UNION_TRANSACTIONS`
dataItemType	`PRINCIPAL_PAYMENT_SETTINGS`
dataItemType	`LOANS`
dataItemType	`DISBURSEMENT_DETAILS`
dataItemType	`SAVINGS_TRANSACTION`
dataItemType	`IDENTIFICATION_DOCUMENT`
dataItemType	`LOAN_PRODUCT`
dataItemType	`DISBURSED_LOANS`
dataItemType	`LOAN_GROUP`
dataItemType	`TRANSACTION_CHANNEL`
dataItemType	`CUSTOM_PREDEFINED_FEE`
dataItemType	`JOURNAL_ENTRY`
dataItemType	`ATTACHMENT`
dataItemType	`PREDEFINED_FEE`
dataItemType	`TRANCHE`
dataItemType	`TRANSACTION`
dataItemType	`INDEX_RATE_SOURCE`
dataItemType	`GROUP_ROLE`
dataItemType	`LOAN_TRANSACTION`
dataItemType	`CLIENT_ROLE`
dataItemType	`GROUP`
dataItemType	`NOTIFICATION_MESSAGE`
dataItemType	`OUTSTANDING_PORTFOLIO_ACCOUNTS`
dataItemType	`REPAYMENT`
dataItemType	`LOAN_ACCOUNT_GUARANTY`
dataItemType	`BRANCH`
dataItemType	`CURRENCY`
dataItemType	`CARD_TRANSACTION_REVERSAL`
dataItemType	`INTEREST_PRODUCT_SETTINGS`
dataItemType	`CREATED_ACCOUNTS`
dataItemType	`USER`
dataItemType	`SAVINGS_PRODUCT`
dataItemType	`CLIENT`
dataItemType	`PRODUCT_ARREARS_SETTINGS`
dataItemType	`SAVINGS`
dataItemType	`EXPENSE`
dataItemType	`INDEX_RATE`
dataItemType	`NOTIFICATION_TEMPLATE`
dataItemType	`CUSTOM_FIELD_SELECTION`
dataItemType	`ACTIVITY`
dataType	`ENUM`
dataType	`MONEY`
dataType	`NUMBER`
dataType	`DATE_UTC`
dataType	`JAVA_BLOB`
dataType	`OBJECT`
dataType	`BOOLEAN`
dataType	`DATE`
dataType	`PERCENT`
dataType	`BIG_DECIMAL`
dataType	`STRING`
dataType	`KEY`
dataType	`LONG`
filterElement	`STARTS_WITH_CASE_SENSITIVE`
filterElement	`THIS_WEEK`
filterElement	`EQUALS`
filterElement	`STARTS_WITH`
filterElement	`IN`
filterElement	`TODAY`
filterElement	`THIS_YEAR`
filterElement	`BETWEEN`
filterElement	`AFTER`
filterElement	`LESS_THAN`
filterElement	`DIFFERENT_THAN`
filterElement	`THIS_MONTH`
filterElement	`NOT_EMPTY`
filterElement	`BEFORE`
filterElement	`EQUALS_CASE_SENSITIVE`
filterElement	`LAST_DAYS`
filterElement	`MORE_THAN`
filterElement	`EMPTY`
filterElement	`ON`
linkingOperator	`OR`
linkingOperator	`AND`
builtInType	`DETAILS`
builtInType	`GENERAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
usage	`SINGLE`
usage	`GROUPED`
dataType	`GROUP_LINK`
dataType	`DATE`
dataType	`NUMBER`
dataType	`CHECKBOX`
dataType	`CLIENT_LINK`
dataType	`STRING`
dataType	`USER_LINK`
dataType	`SELECTION`
state	`DEACTIVATED`
state	`NORMAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
valueLength	`SHORT`
valueLength	`LONG`

Update custom information (loan account)

PATCH /loans/{loanAccountId}/custominformation/{customFieldId}

Update custom information for a specified custom field definition and a specified loan account.

Example Requests

provide a new custom field value

{
  "value": "new custom field value"
}

Parameters

Name	Type	Description	In
body	CustomFieldOnUpdate	none	body
loanAccountId (required)	string	The ID of the loan account. The format is determined by your organization.	path
customFieldId (required)	string	The ID of the custom field definition. The format is determined by your organization.	path

Example Responses

200 Response

{
  "errorSource": "string",
  "returnCode": 0,
  "returnStatus": "string"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	ExecutionStatusApiV1

Update custom info from grouped set (loan account)

DELETE /loans/{loanAccountId}/custominformation/{customFieldId}/{groupSetIndex}

Delete custom information that is part of a custom field set for a loan account.

Parameters

Name	Type	Description	In
loanAccountId (required)	string	The ID of the loan account. The format is determined by your organization.	path
customFieldId (required)	string	none	path
groupSetIndex (required)	string	none	path

Example Responses

200 Response

{
  "errorSource": "string",
  "returnCode": 0,
  "returnStatus": "string"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	ExecutionStatusApiV1

Get comments for a Loan Account

GET /loans/{loanAccountId}/comments

Get all loan account comments

Get all comments for a loan account.

Parameters

Name	Type	Description	In
limit	string	none	query
offset	string	none	query
loanAccountId (required)	string	The ID of the loan account. The format is determined by your organization.	path

Example Responses

200 : OK
an array of comments

[
  {
    "encodedKey": "8a19b7057471f4af017472dc0fd80470",
    "parentKey": "8a193c26722b51b701722d77c5e423b7",
    "userKey": "8a194075720ece2c017226fced6f005e",
    "creationDate": "2020-09-09T14:24:42+0000",
    "lastModifiedDate": "2020-09-09T14:24:42+0000",
    "text": "aanother afmaefomaef<div><br /></div><div><u>aefaefaf</u></div><div><u><br /></u></div><div><u>afaef</u></div>"
  },
  {
    "encodedKey": "8a193c26722b51b701722d77c8bf25ab",
    "parentKey": "8a193c26722b51b701722d77c5e423b7",
    "creationDate": "2020-05-19T15:05:24+0000",
    "lastModifiedDate": "2020-05-19T15:05:24+0000",
    "text": "Should suggest she apply for the agriculture loan given the nature of their business"
  }
]

400 : Bad Request
bad loan ID

{
  "returnCode": 149,
  "returnStatus": "INVALID_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[CommentApiV1]	none	none
» creationDate	string(date-time)	the date and time at which this comment was added	none
» encodedKey	string	a unique key for this comment	none
» lastModifiedDate	string(date-time)	the date and time at which this comment was last modified	none
» parentKey	string	the unique key of the parent object for this comment, for example, the client or loan account to which it relates	none
» text	string	the text of the comment as a string, must be properly JSON escpaped if it contains special characters	none
» userKey	string	the unique key of the user who created the comment	none

Create comment for a Loan Account

POST /loans/{loanAccountId}/comments

Create a loan Comment

create new comment for a loan

Example Requests

a comment

{
  "comment": {
    "text": "this is a comment with \" \" all kinds of : \\ / \"non compliant\" stuff & = which has been JSON escaped"
  }
}

Parameters

Name	Type	Description	In
comment	object	an object contining the comment	body
» text	string	text of the comment to be added. if adding complex content make sure it is properly JSON encoded before making your request	body
loanAccountId (required)	string	The ID of the loan account. The format is determined by your organization.	path

Example Responses

200 : OK
a comment

{
  "encodedKey": "8a19c34574720f9e0174734a039f06e2",
  "parentKey": "8a193c26722b51b701722d77c5e423b7",
  "userKey": "8a194075720ece2c017226fced6f005e",
  "creationDate": "2020-09-09T14:39:36+0000",
  "lastModifiedDate": "2020-09-09T14:39:36+0000",
  "text": "this is a comment with \" \" all kinds of : \\ / non compliant stuff & = which has been JSON escaped"
}

400 : Bad Request
extra parameters in the request

{
  "returnCode": 27,
  "returnStatus": "PARAMETER_NOT_ALLOWED"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	CommentApiV1
`400`	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Get documents for a Loan Account

GET /loans/{loanAccountId}/documents

Get all Loan Account Documents

Get all documents relating to a specified loan account.

Parameters

Name	Type	Description	In
offset	integer	start at index x. use with `limit` parameter to achieve pagination	query
limit	integer	max number of results to return	query
loanAccountId (required)	string	The ID of the loan account. The format is determined by your organization.	path

Example Responses

200 : ok
an array of documents

[
  {
    "encodedKey": "8a19c035747bf5b901747c77d78e01c4",
    "id": 53,
    "creationDate": "2020-09-11T11:39:33+0000",
    "lastModifiedDate": "2020-09-11T11:39:33+0000",
    "documentHolderKey": "8a19b6e4746cc6ed01746cf1436c00c5",
    "documentHolderType": "LOAN_ACCOUNT",
    "name": "file for loan account",
    "type": "png",
    "fileSize": 8258,
    "originalFilename": "Screenshot_2020-04-22_at_14.31.29.png",
    "location": "FCLRPXHUTCXURCALXAIFESFUURNUBR",
    "description": "a file attached to a loan account",
    "createdByUserKey": "8a194075720ece2c017226fced6f005e",
    "userName": "big chief",
    "documentHolder": {
      "type": "LOAN",
      "holderKey": "8a193c26722b51b701722d77c5e423b7",
      "accountHolderType": "CLIENT",
      "encodedKey": "8a19b6e4746cc6ed01746cf1436c00c5",
      "displayName": "BLBE564"
    }
  },
  {
    "encodedKey": "8a19a3337476f2d00174775b6a3001b0",
    "id": 44,
    "creationDate": "2020-09-10T09:34:51+0000",
    "lastModifiedDate": "2020-09-10T09:34:51+0000",
    "documentHolderKey": "8a19b6e4746cc6ed01746cf1436c00c5",
    "documentHolderType": "LOAN_ACCOUNT",
    "name": "loan acc doc",
    "type": "png",
    "fileSize": 15028,
    "originalFilename": "additional_reading_callout.png",
    "location": "UTOLWAEQURRYFNBIPNUXXFEXBCPKQR",
    "description": "desc loan acc doc",
    "createdByUserKey": "8a194075720ece2c017226fced6f005e",
    "userName": "mayor mcbacon",
    "documentHolder": {
      "type": "LOAN",
      "holderKey": "8a193c26722b51b701722d77c5e423b7",
      "accountHolderType": "CLIENT",
      "encodedKey": "8a19b6e4746cc6ed01746cf1436c00c5",
      "displayName": "BLBE564"
    }
  }
]

400 : Bad Request
Bad Loan Account ID

{
  "returnCode": 4,
  "returnStatus": "INVALID_PARAMETERS",
  "errorSource": "wrong owner id"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[DocumentForAccountApiV1]	none	none
» DocumentForAccountApiV1	DocumentForAccountApiV1	none	none
»» createdByUserKey	string	the encoded key of the Mambu user who added the document	none
»» creationDate	string	the date and time when this document was created	none
»» description	string	a description of this document	none
»» documentHolder	DocumentHolderAccountApiV1	none	none
»»» accountHolderType	string	the type of entity that owns the document	none
»»» displayName	string	the ID of the account to which the document relates	none
»»» encodedKey	string	the encoded key of the account to which the document relates	none
»»» holderkey	string	the encoded key of the document owner	none
»»» type	string	the type of account that the document belongs to	none
»» documentHolderKey	string	the encoded key of the owner of this document, for exmaple, the client or group	none
»» documentHolderType	string	the type of entity to which this document belongs, ie savings or loan account	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» fileSize	string	the size, in bytes, of this document	none
»» id	string	the document ID	none
»» lastModifiedDate	string	the date on which this document was last modified	none
»» location	string	the location where this document is stored	none
»» name	string	the name of the document, if provided	none
»» originalFilename	string	the original name of the uploaded file	none
»» type	string	the file type of the document, eg. PDF, PNG, JPEG	none
»» userName	string	the name of the Mambu user who originally uploaded the document	none

Enumerated Values

Property	Value
accountHolderType	`CLIENT`
accountHolderType	`GROUP`
type	`LOAN`
type	`SAVINGS`
documentHolderType	`SAVINGS_ACCOUNT`
documentHolderType	`LOAN_ACCOUNT`

Attach document to a Loan Account

POST /loans/{loanAccountId}/documents

Attach new Document to Loan Account

Attach a new document to a loan account.

Example Requests

example-1

{
  "document": {
    "documentHolderKey": "BRANCH",
    "documentHolderType": "CLIENT",
    "name": "string",
    "type": "PDF",
    "description": "string"
  },
  "documentContent": "{base64-encoded-string}"
}

Parameters

Name	Type	Description	In
body	CreateDocumentApiV1	a new document to be attached to an entity	body
loanAccountId (required)	string	The ID of the loan account. The format is determined by your organization.	path

Example Responses

201 : Created
uploaded document details

{
  "encodedKey": "8a19c035747bf5b901747c77d78e01c6",
  "id": 54,
  "creationDate": "2020-09-11T11:51:21+0000",
  "lastModifiedDate": "2020-09-11T11:51:21+0000",
  "documentHolderKey": "8a19b6e4746cc6ed01746cf1436c00c5",
  "documentHolderType": "LOAN_ACCOUNT",
  "name": "some other image",
  "type": "png",
  "fileSize": 32109,
  "originalFilename": "some_other_image.png",
  "location": "NCYBXXEJCZBQVHAEAJTPITEGUBVXRO",
  "description": "this is another image file",
  "createdByUserKey": "8a194075720ece2c017226fced6f005e"
}

400 : Bad Request
file type does not match content

{
  "returnCode": 973,
  "returnStatus": "INCONSISTENT_EXTENSION_WITH_FILE_CONTENT",
  "errorSource": "Invalid extension with file content"
}

404 : Not Found
documentHolderKey does not point to a real Account

{
  "returnCode": 29,
  "returnStatus": "OBJECT_NOT_FOUND",
  "errorSource": "Could not find object"
}

Responses

Status	Meaning	Description	Schema
`201`	Created	Created	DocumentApiV1
`400`	Bad Request	Bad Request	ExecutionStatusApiV1
`404`	Not Found	Not Found	ExecutionStatusApiV1

Get Loan Account Document by ID

GET /loans/{loanAccountId}/documents/{documentId}

Get a Loan Account Document

Get a document attached to a loan account by its ID.

Parameters

Name	Type	Description	In
loanAccountId (required)	string	The ID of the loan account. The format is determined by your organization.	path
documentId (required)	string	The ID of the document.	path

Example Responses

200 : OK
a base64 encoded document

"iVBORw0KGgoAAAANSUhEUgAAAnYAAAF0CAYAAACudHRvAAABQGlDQ1BJQ0MgUHJvZmlsZQAAKJFjYGASSCwoyGFhYGDIzSspCnJ3UoiIjFJgf8zAzcDGwMmgyqCZmFxc4BgQ4ANUwgCjUcG3awyMIPqyLsisf+0bZndFf1ridW7vst321p2Y6lEAV0pqcTKQ/gPEickFRSUMDIwJQLZyeUkBiN0CZIsUAR0FZM8AsdMh7DUgdhKEfQCsJiTIGci=="

400 : Bad Request
bad document ID

{
  "returnCode": 970,
  "returnStatus": "INVALID_DOCUMENT_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	string
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Delete Loan Account Document

DELETE /loans/{loanAccountId}/documents/{documentId}

Delete Loan Account Document

Delete a loan account document

Parameters

Name	Type	Description	In
loanAccountId (required)	string	The ID of the loan account. The format is determined by your organization.	path
documentId (required)	string	The ID of the document.	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

404 : Not Found
bad Document ID

{
  "returnCode": 970,
  "returnStatus": "INVALID_DOCUMENT_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	ExecutionStatusApiV1
`404`	Not Found	Not Found	ExecutionStatusApiV1

Remove Settlement Account from Loan Account

DELETE /loans/{loanAccountId}/settlementaccounts/{settlementAccountId}

Remove Settlement Account from Loan Account

Remove a settlement account link from a loan account specified by the loan account ID and the savings ID.

Parameters

Name	Type	Description	In
loanAccountId (required)	string	The loan account ID or encoded key.	path
settlementAccountId (required)	string	The savings account to be used as the settlement account for the loan (ID or encoded key).	path

Example Responses

200 : ok
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	ExecutionStatusApiV1

Set Settlement Account for Loan Account

POST /loans/{loanAccountId}/settlementaccounts/{settlementAccountId}

Set Settlement Account for Loan Account

Set a settlement account for a loan account based on the loan and savings IDs.

Example Requests

POST api/loans/LOAN_ID/settlementAccounts/SAVINGS_ID

Parameters

Name	Type	Description	In
loanAccountId (required)	string	The loan account ID or encoded key.	path
settlementAccountId (required)	string	The savings account to be used as the settlement account for the loan (ID or encoded key).	path

Example Responses

200 : ok
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	ExecutionStatusApiV1

Get Transactions for Loan Account

GET /loans/{loanAccountId}/transactions

Get Transaction for a Loan Account

Retrieve savings transactions for a specific account. Transactions are returned sorted by most recent to oldest.

Parameters

Name	Type	Description	In
offset	integer	none	query
limit	integer	none	query
fullDetails	boolean	none	query
loanAccountId (required)	string	The ID of the loan account. The format is determined by your organization.	path

Example Responses

200 Response

[
  {
    "advancePosition": 0,
    "amount": 0,
    "arrearsPosition": 0,
    "balance": 0,
    "bookingDate": "string",
    "branchKey": "string",
    "centreKey": "string",
    "comment": "string",
    "creationDate": "string",
    "customInformation": [
      {
        "amount": 0,
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "customFieldID": "string",
        "customFieldKey": "string",
        "customFieldSetGroupIndex": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexInList": 0,
        "linkedEntityKeyValue": "string",
        "parentKey": "string",
        "selectionKey": "string",
        "value": "string"
      }
    ],
    "customPaymentAmounts": [
      {
        "amount": 0,
        "customPaymentAmountType": "PAYMENT_DUE_FEE",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "index": 0,
        "loanTransactionKey": "string",
        "taxOnAmount": 0
      }
    ],
    "deferredInterestAmount": 0,
    "deferredTaxOnInterestAmount": 0,
    "details": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "internalTransfer": true,
      "targetSavingsAccountKey": "string",
      "transactionChannel": {
        "activated": true,
        "createdByUserKey": "string",
        "creationDate": "string",
        "customFields": [
          {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          }
        ],
        "encodedKey": "string",
        "id": "string",
        "index": 0,
        "loanConstraints": {
          "customConfigurationInfo": {
            "creationDate": "string",
            "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "shared": true,
            "userKey": "string"
          },
          "encodedKey": "string",
          "filterConstraints": [
            {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            }
          ]
        },
        "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
        "name": "string",
        "savingsConstraints": {
          "customConfigurationInfo": {
            "creationDate": "string",
            "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "shared": true,
            "userKey": "string"
          },
          "encodedKey": "string",
          "filterConstraints": [
            {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            }
          ]
        },
        "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
        "transactionChannelAccountingRule": {
          "account": {
            "activated": true,
            "allowManualJournalEntries": true,
            "balance": 0,
            "creationDate": "2019-08-24T14:15:22Z",
            "currency": {
              "code": "string",
              "creationDate": "string",
              "currencySymbolPosition": "AFTER_NUMBER",
              "digitsAfterDecimal": 0,
              "isBaseCurrency": true,
              "lastModifiedDate": "string",
              "name": "string",
              "symbol": "string"
            },
            "description": "string",
            "encodedKey": "string",
            "glCode": "string",
            "lastModifiedDate": "2019-08-24T14:15:22Z",
            "migrationEvent": {
              "creationDate": "2019-08-24T14:15:22Z",
              "encodedKey": "string",
              "numCentresImported": 0,
              "numClientsImported": 0,
              "numGLAccountsImported": 0,
              "numGroupsImported": 0,
              "numLoanRepaymentsImported": 0,
              "numLoanTransactionsImported": 0,
              "numLoansImported": 0,
              "numSavingsImported": 0,
              "state": "REVERTED",
              "type": "IMPORT"
            },
            "name": "string",
            "stripTrailingZeros": true,
            "type": "INCOME",
            "usage": "HEADER"
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "financialResource": "FEE_RECEIVABLE",
          "index": 0,
          "predefinedFeeKey": "string",
          "productKey": "string",
          "productType": "LOAN",
          "transactionChannelKey": "string"
        },
        "usageRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "transactionChannelKey": "string"
    },
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "entryDate": "string",
    "expectedPrincipalRedraw": 0,
    "feesPaid": 0,
    "fundersInterestAmount": 0,
    "indexInterestRate": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "notes": "string",
      "rate": 0,
      "rateSource": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "name": "string",
        "notes": "string",
        "type": "TAX_RATE"
      },
      "startDate": "string",
      "userKey": "string"
    },
    "interestFromArrearsAmount": 0,
    "interestPaid": 0,
    "interestRate": 0,
    "loanPredefinedFeeAmounts": [
      {
        "amortizedAmounts": [
          {
            "amount": 0,
            "branchKey": "string",
            "centreKey": "string",
            "creationDate": "string",
            "encodedKey": "string",
            "entryDate": "string",
            "reversalAmountKey": "string",
            "taxAmount": 0,
            "type": "AMORTIZATION_ADJUSTMENT"
          }
        ],
        "amount": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "fee": {
          "active": true,
          "amortizationIntervalSettings": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
            "intervalCount": 0,
            "intervalType": "FULL_TERM",
            "periodCount": 0,
            "periodUnit": "MONTHS"
          },
          "amortizationProfile": "STRAIGHT_LINE",
          "amount": 0,
          "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
          "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
          "creationDate": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
          "feeApplication": "OPTIONAL",
          "feeProductRules": [
            {
              "account": {
                "activated": true,
                "allowManualJournalEntries": true,
                "balance": 0,
                "creationDate": "2019-08-24T14:15:22Z",
                "currency": {
                  "code": "string",
                  "creationDate": "string",
                  "currencySymbolPosition": "AFTER_NUMBER",
                  "digitsAfterDecimal": 0,
                  "isBaseCurrency": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "symbol": "string"
                },
                "description": "string",
                "encodedKey": "string",
                "glCode": "string",
                "lastModifiedDate": "2019-08-24T14:15:22Z",
                "migrationEvent": {
                  "creationDate": "2019-08-24T14:15:22Z",
                  "encodedKey": "string",
                  "numCentresImported": 0,
                  "numClientsImported": 0,
                  "numGLAccountsImported": 0,
                  "numGroupsImported": 0,
                  "numLoanRepaymentsImported": 0,
                  "numLoanTransactionsImported": 0,
                  "numLoansImported": 0,
                  "numSavingsImported": 0,
                  "state": "REVERTED",
                  "type": "IMPORT"
                },
                "name": "string",
                "stripTrailingZeros": true,
                "type": "INCOME",
                "usage": "HEADER"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "financialResource": "FEE_RECEIVABLE",
              "index": 0,
              "predefinedFeeKey": "string",
              "productKey": "string",
              "productType": "LOAN",
              "transactionChannelKey": "string"
            }
          ],
          "name": "string",
          "percentageAmount": 0,
          "trigger": "DISBURSEMENT"
        },
        "taxAmount": 0,
        "transactionId": 0
      }
    ],
    "loanTransactionTerms": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "principalPaymentAmount": 0,
      "principalPaymentPercentage": 0
    },
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "organizationCommissionAmount": 0,
    "originalAmount": 0,
    "originalCurrencyCode": "string",
    "parentAccountKey": "string",
    "parentLoanTransactionKey": "string",
    "penaltyPaid": 0,
    "principalBalance": 0,
    "principalPaid": 0,
    "productTypeKey": "string",
    "redrawBalance": 0,
    "reversalTransactionKey": "string",
    "taxOnFeesAmount": 0,
    "taxOnInterestFromArrearsAmount": 0,
    "taxOnInterestPaid": 0,
    "taxOnPenaltyAmount": 0,
    "taxRate": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "notes": "string",
      "rate": 0,
      "rateSource": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "name": "string",
        "notes": "string",
        "type": "TAX_RATE"
      },
      "startDate": "string",
      "userKey": "string"
    },
    "tillKey": "string",
    "transactionId": 0,
    "type": "PENALTY_UNLOCKED",
    "userKey": "string",
    "valueDate": "string"
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[LoanTransactionApiV1]	none	none
» advancePosition	number	none	none
» amount	number	none	none
» arrearsPosition	number	none	none
» balance	number	none	none
» bookingDate	string	none	none
» branchKey	string	none	none
» centreKey	string	none	none
» comment	string	none	none
» creationDate	string	the date and time when this loan transaction was created	none
» customInformation	[CustomFieldValueApiV1]	none	none
»» amount	number	none	none
»» customField	CustomFieldApiV1	none	none
»»» amounts	object	used when options available for a custom field definition translate to predefined amounts, for example, when the custom field value is used to generate a score	none
»»»» additionalProperties	number	none	none
»»» builtInCustomFieldId	string	if this field is one of the built in custom fiel definitions, this will have a value. These names are reserved and you can not use them for your own custom field definitions	none
»»» creationDate	string	the date on which this custom field definition was created	none
»»» customFieldProductSettings	[CustomFieldLinkApiV1]	none	none
»»»» customFieldEncodedKey	string	the key to the parent custom field definition	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isDefault	boolean	whether this field is displayed by default when creating a new record	none
»»»» isRequired	boolean	whether this field is required when creating a new record	none
»»»» linkType	string	the type of entity this field represents a link to	none
»»»» productKey	string	when the link type is product, this field should contain the encoded key of the linekd product	none
»»» customFieldSelectionOptions	[CustomFieldSelectionApiV1]	[represents a possible selection for select type custom field definitions]	none
»»»» constraint	CustomFilterConstraintApiV1	none	none
»»»»» customFieldKey	string	none	none
»»»»» dataFieldType	string	none	none
»»»»» dataFieldValue	string	none	none
»»»»» dataItemType	string	none	none
»»»»» dataType	string	none	none
»»»»» encodedKey	string	none	none
»»»»» filterElement	string	none	none
»»»»» groupNumber	number	none	none
»»»»» index	number	none	none
»»»»» linkingOperator	string	none	none
»»»»» secondValue	string	none	none
»»»»» value	string	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this selectable item	none
»»»» score	number	the score assigned to this selection	none
»»»» value	string	display name of this option	none
»»» customFieldSet	CustomFieldSetApiV1	none	none
»»»» builtInType	string	if this set is part of the set of built-in custom field sets, its type will be shown here	none
»»»» createdDate	string	the date and time when this custom field set was created	none
»»»» customFields	[CustomFieldApiV1]	an array of custom field definitions included in this custom field set	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this custom field set	none
»»»» indexInList	number	for field sets that can be added to an entity more than once, this number represents the index in the list and is used when changing values	none
»»»» lastModifiedDate	string	the date on which this custom field set was last modified	none
»»»» name	string	the name of this custom field set	none
»»»» notes	string	any notes regarding this custom field set	none
»»»» type	string	the entity type that this custom field definition is attached to	none
»»»» usage	string	whether this custom field set can only be used once, or added multiple times to the same entity	none
»»» dataType	string	the type of custom field definition	none
»»» description	string	a brief description of this custom field definition	none
»»» editRights	UsageRightsApiV1	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isAccessibleByAllUsers	boolean	none	none
»»»» roles	[string]	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» id	string	the ID for this custom field definition	none
»»» indexInList	number	none	none
»»» isDefault	boolean	whether this field will be included by default on new records	none
»»» isRequired	boolean	whether this field is required when creating a new record	none
»»» lastModifiedDate	string	the date on which this custom field definition was last modified	none
»»» name	string	the name of this custom field definition	none
»»» state	string	whether this field is available for use or has been deactivated	none
»»» type	string	the type of data this custom field definition will contain	none
»»» unique	boolean	whether the data in this custom field definition needs to be a unique value	none
»»» validationPattern	string	a user-provided pattern to which data in this custom field definition must conform where @ represents numbers, # represents letters and $ is either a number or letter. Other special characters used as separators are allowed, for example `@@-##-$$$`	none
»»» valueLength	string	whether this field needs to support a large number of characters	none
»»» values	[string]	a list of possible values when the field is a selection field	none
»»» viewRights	UsageRightsApiV1	none	none
»» customFieldID	string	none	none
»» customFieldKey	string	none	none
»» customFieldSetGroupIndex	number	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» indexInList	number	none	none
»» linkedEntityKeyValue	string	none	none
»» parentKey	string	none	none
»» selectionKey	string	none	none
»» value	string	none	none
» customPaymentAmounts	[CustomPaymentAmountApiV1]	none	none
»» amount	number	the amount of this custom payment	none
»» customPaymentAmountType	string	the type of this custom payment	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» index	number	index in list when this is part of a custom payment of which parts are allocated to different types of charge, for example, a single payment that goes towards loan principal, a late payment fee and a penalty	none
»» loanTransactionKey	string	the encoded key of the loan transaction this custom payment is part of	none
»» taxOnAmount	number	the amount of tax charged for this payment	none
» deferredInterestAmount	number	none	none
» deferredTaxOnInterestAmount	number	none	none
» details	TransactionDetailsApiV1	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» internalTransfer	boolean	none	none
»» targetSavingsAccountKey	string	none	none
»» transactionChannel	TransactionChannelInTransactionDetailsApiV1	none	none
»»» activated	boolean	whether this transaction channel is enabled	none
»»» createdByUserKey	string	the encoded key of the user who created this transaction channel	none
»»» creationDate	string	the date on which this transaction channel was created	none
»»» customFields	[CustomFieldApiV1]	none	none
»»» encodedKey	string	the encoded key for this transaction channel	none
»»» id	string	the user specified ID for this transaction channel	none
»»» index	number	none	none
»»» loanConstraints	CustomFilterApiV1	none	none
»»»» customConfigurationInfo	CustomConfigurationInfoApiV1	none	none
»»»»» creationDate	string	the date on which this configuration was created	none
»»»»» dataViewType	string	the type of entity this configuration is for	none
»»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»»» indexInList	number	if more than one configuration exists for a given type, this is its index in the list	none
»»»»» lastModifiedDate	string	the date on which this configuration was last modified	none
»»»»» name	string	the name for this configuration	none
»»»»» shared	boolean	whether this configuration is private or can be used by other users of the system	none
»»»»» userKey	string	the encoded key of the Mambu user who created this configuration	none
»»»» encodedKey	string	none	none
»»»» filterConstraints	[CustomFilterConstraintApiV1]	none	none
»»» loanConstraintsUsage	string	whether there are any rules regarding usage of this transaction channel with loan accounts	none
»»» name	string	the name of this transaction channel	none
»»» savingsConstraints	CustomFilterApiV1	none	none
»»» savingsConstraintsUsage	string	whether there are any rules regarding usage of this transaction channel with savings accounts	none
»»» transactionChannelAccountingRule	GLAccountingRuleApiV1	none	none
»»»» account	GLAccountApiV1	A general ledger account	none
»»»»» activated	boolean	whether this general ledger account is in use	none
»»»»» allowManualJournalEntries	boolean	whether manual entries are allowed for this general ledger account	none
»»»»» balance	number	the current balance of this general ledger account	none
»»»»» creationDate	string(date-time)	the date on which this general ledger account was created	read-only
»»»»» currency	CurrencyApiV1	none	none
»»»»»» code	string	the three letter ISO code for this currency	none
»»»»»» creationDate	string	the date on which this currency was created	none
»»»»»» currencySymbolPosition	string	indicates where the currency symbol should appear in relation to the numeric value	none
»»»»»» digitsAfterDecimal	number	indicates how many decimal places are allowed for this currency. For example, a currenncy with 100 minor units to 1 major unit, there will be 2 decimal places.	none
»»»»»» isBaseCurrency	boolean	whether this currency is the base currency for your banking institution	none
»»»»»» lastModifiedDate	string	the date on which this currency was last modified	none
»»»»»» name	string	the name of this currency	none
»»»»»» symbol	string	the currency symnbol used for this currency	none
»»»»» description	string	an optional description for this general ledger account	none
»»»»» encodedKey	string	the encoded key of this general ledger account	none
»»»»» glCode	string	the numeric code for this general ledger account	none
»»»»» lastModifiedDate	string(date-time)	the date on which this general ledger account was last modified	read-only
»»»»» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
»»»»»» creationDate	string(date-time)	the date on which the data import was made	none
»»»»»» encodedKey	string	the encoded key of this data migration event	none
»»»»»» numCentresImported	number	the number of centres which were imported during the data migration	none
»»»»»» numClientsImported	number	the number of clients which were imported as part of the data migration	none
»»»»»» numGLAccountsImported	number	the number of general ledger accounts which were imported as part of the data migration	none
»»»»»» numGroupsImported	number	the number of groups which were imported as part of the data migration	none
»»»»»» numLoanRepaymentsImported	number	the number of loan repayment transations which were imported as part of the data migration	none
»»»»»» numLoanTransactionsImported	number	the number of loan transactions which were imported as part of the data migration	none
»»»»»» numLoansImported	number	the number of loan accounts which were imported as part of the data migration	none
»»»»»» numSavingsImported	number	the number of savings accounts which were imported as part of the data migration	none
»»»»»» state	string	whether the data import was accepted, is still in a draft state, or was rejected and all data reverted	none
»»»»»» type	string	the type of migration event	none
»»»»» name	string	the name of this general ledger account	none
»»»»» stripTrailingZeros	boolean	controls how this account is organized into header accounts when there are trailing zeroes, for example, for the account code `1100`, if this field is set to true, only the first two numbers will be recognised	none
»»»»» type	string	the type of general ledger account	none
»»»»» usage	string	whether this general ledger account is a `DETAIL` account, in which case it will have a value, or a `HEADER` account, in which case its value will be calculated based on the sum of detail accounts under it.	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» financialResource	string	the type of transaction governed by this rule	none
»»»» index	number	the index in list when there are multiple rules for the same type of transaction	none
»»»» predefinedFeeKey	string	the encoded key of the predefined key this rule relates to	none
»»»» productKey	string	the encoded key of the product this rule relates to	none
»»»» productType	string	the type of account this rule relates to	none
»»»» transactionChannelKey	string	the encoded key of the transaction channel that this rule relates to	none
»»» usageRights	UsageRightsApiV1	none	none
»» transactionChannelKey	string	none	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» entryDate	string	none	none
» expectedPrincipalRedraw	number	none	none
» feesPaid	number	none	none
» fundersInterestAmount	number	none	none
» indexInterestRate	IndexRateApiV1	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» notes	string	any notes relating to this index rate	none
»» rate	number	the percentage rate for this tax or interest rate	none
»» rateSource	IndexRateSourceApiV1	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» name	string	the name of this index rate source, eg. LIBOR	none
»»» notes	string	any notes relating to this index rate	none
»»» type	string	what kind of rate this source provides, eg. tax, interest, withholding tax	none
»» startDate	string	the first day on which this rate is considered valid	none
»» userKey	string	the encoded key of the user who added this index rate	none
» interestFromArrearsAmount	number	none	none
» interestPaid	number	none	none
» interestRate	number	none	none
» loanPredefinedFeeAmounts	[PredefinedFeeAmountApiV1]	none	none
»» amortizedAmounts	[AmortizationAmountApiV1]	none	none
»»» amount	number	the amount to be amortized	none
»»» branchKey	string	the encoded key of the branch owning the amount	none
»»» centreKey	string	the encoded key of the centre owning the amount	none
»»» creationDate	string	the date on which the amortization amount was created	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» entryDate	string	the date when this amount was recognised as amortized (in organization time)	none
»»» reversalAmountKey	string	if the amount was reversed, this field will contain the encoded key of the reversal record	none
»»» taxAmount	number	the amount of tax included in the amortized amount	none
»»» type	string	the type of entry represented by this object	none
»» amount	number	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» fee	PredefinedFeeApiV1	none	none
»»» active	boolean	none	none
»»» amortizationIntervalSettings	PeriodIntervalSettingsApiV1	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» frequency	string	none	none
»»»» intervalCount	number	none	none
»»»» intervalType	string	none	none
»»»» periodCount	number	none	none
»»»» periodUnit	string	none	none
»»» amortizationProfile	string	none	none
»»» amount	number	none	none
»»» amountCalculationMethod	string	none	none
»»» applyDateMethod	string	none	none
»»» creationDate	string	the date and time when this fee was created	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» feeAmortizationUponRescheduleOption	string	none	none
»»» feeApplication	string	none	none
»»» feeProductRules	[GLAccountingRuleApiV1]	none	none
»»» name	string	none	none
»»» percentageAmount	number	none	none
»»» trigger	string	none	none
»» taxAmount	number	none	none
»» transactionId	number	none	none
» loanTransactionTerms	LoanTransactionTermsApiV1	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» principalPaymentAmount	number	none	none
»» principalPaymentPercentage	number	none	none
» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
» organizationCommissionAmount	number	none	none
» originalAmount	number	none	none
» originalCurrencyCode	string	none	none
» parentAccountKey	string	none	none
» parentLoanTransactionKey	string	none	none
» penaltyPaid	number	none	none
» principalBalance	number	none	none
» principalPaid	number	none	none
» productTypeKey	string	none	none
» redrawBalance	number	none	none
» reversalTransactionKey	string	none	none
» taxOnFeesAmount	number	none	none
» taxOnInterestFromArrearsAmount	number	none	none
» taxOnInterestPaid	number	none	none
» taxOnPenaltyAmount	number	none	none
» taxRate	IndexRateApiV1	none	none
» tillKey	string	none	none
» transactionId	number	none	none
» type	string	none	none
» userKey	string	none	none
» valueDate	string	none	none

Enumerated Values

Property	Value
builtInCustomFieldId	`MOBILE_PHONE`
builtInCustomFieldId	`EMAIL_ADDRESS`
builtInCustomFieldId	`GENDER`
builtInCustomFieldId	`MIDDLE_NAME`
builtInCustomFieldId	`HOME_PHONE`
builtInCustomFieldId	`BIRTHDATE`
builtInCustomFieldId	`LAST_NAME`
builtInCustomFieldId	`FIRST_NAME`
linkType	`CLIENT_ROLE`
linkType	`CHANNEL`
linkType	`PRODUCT`
dataFieldType	`NATIVE`
dataFieldType	`CUSTOM`
dataItemType	`WRITTEN_OFF_LOANS`
dataItemType	`LINE_OF_CREDIT`
dataItemType	`INVESTOR_FUND`
dataItemType	`TRANSACTION_DETAILS`
dataItemType	`DOCUMENT_TEMPLATE`
dataItemType	`PRODUCT`
dataItemType	`MCC_EXPIRATION`
dataItemType	`CENTRE`
dataItemType	`REPAYMENT_COLLECTION`
dataItemType	`TASK`
dataItemType	`OUTSTANDING_PORTFOLIO_AMOUNTS`
dataItemType	`REVENUE`
dataItemType	`COMPOSED_TRANSACTIONS`
dataItemType	`UNION_TRANSACTIONS`
dataItemType	`PRINCIPAL_PAYMENT_SETTINGS`
dataItemType	`LOANS`
dataItemType	`DISBURSEMENT_DETAILS`
dataItemType	`SAVINGS_TRANSACTION`
dataItemType	`IDENTIFICATION_DOCUMENT`
dataItemType	`LOAN_PRODUCT`
dataItemType	`DISBURSED_LOANS`
dataItemType	`LOAN_GROUP`
dataItemType	`TRANSACTION_CHANNEL`
dataItemType	`CUSTOM_PREDEFINED_FEE`
dataItemType	`JOURNAL_ENTRY`
dataItemType	`ATTACHMENT`
dataItemType	`PREDEFINED_FEE`
dataItemType	`TRANCHE`
dataItemType	`TRANSACTION`
dataItemType	`INDEX_RATE_SOURCE`
dataItemType	`GROUP_ROLE`
dataItemType	`LOAN_TRANSACTION`
dataItemType	`CLIENT_ROLE`
dataItemType	`GROUP`
dataItemType	`NOTIFICATION_MESSAGE`
dataItemType	`OUTSTANDING_PORTFOLIO_ACCOUNTS`
dataItemType	`REPAYMENT`
dataItemType	`LOAN_ACCOUNT_GUARANTY`
dataItemType	`BRANCH`
dataItemType	`CURRENCY`
dataItemType	`CARD_TRANSACTION_REVERSAL`
dataItemType	`INTEREST_PRODUCT_SETTINGS`
dataItemType	`CREATED_ACCOUNTS`
dataItemType	`USER`
dataItemType	`SAVINGS_PRODUCT`
dataItemType	`CLIENT`
dataItemType	`PRODUCT_ARREARS_SETTINGS`
dataItemType	`SAVINGS`
dataItemType	`EXPENSE`
dataItemType	`INDEX_RATE`
dataItemType	`NOTIFICATION_TEMPLATE`
dataItemType	`CUSTOM_FIELD_SELECTION`
dataItemType	`ACTIVITY`
dataType	`ENUM`
dataType	`MONEY`
dataType	`NUMBER`
dataType	`DATE_UTC`
dataType	`JAVA_BLOB`
dataType	`OBJECT`
dataType	`BOOLEAN`
dataType	`DATE`
dataType	`PERCENT`
dataType	`BIG_DECIMAL`
dataType	`STRING`
dataType	`KEY`
dataType	`LONG`
filterElement	`STARTS_WITH_CASE_SENSITIVE`
filterElement	`THIS_WEEK`
filterElement	`EQUALS`
filterElement	`STARTS_WITH`
filterElement	`IN`
filterElement	`TODAY`
filterElement	`THIS_YEAR`
filterElement	`BETWEEN`
filterElement	`AFTER`
filterElement	`LESS_THAN`
filterElement	`DIFFERENT_THAN`
filterElement	`THIS_MONTH`
filterElement	`NOT_EMPTY`
filterElement	`BEFORE`
filterElement	`EQUALS_CASE_SENSITIVE`
filterElement	`LAST_DAYS`
filterElement	`MORE_THAN`
filterElement	`EMPTY`
filterElement	`ON`
linkingOperator	`OR`
linkingOperator	`AND`
builtInType	`DETAILS`
builtInType	`GENERAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
usage	`SINGLE`
usage	`GROUPED`
dataType	`GROUP_LINK`
dataType	`DATE`
dataType	`NUMBER`
dataType	`CHECKBOX`
dataType	`CLIENT_LINK`
dataType	`STRING`
dataType	`USER_LINK`
dataType	`SELECTION`
state	`DEACTIVATED`
state	`NORMAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
valueLength	`SHORT`
valueLength	`LONG`
customPaymentAmountType	`PAYMENT_DUE_FEE`
customPaymentAmountType	`PENALTY`
customPaymentAmountType	`MANUAL_FEE`
customPaymentAmountType	`PRINCIPAL`
customPaymentAmountType	`UPFRONT_DISBURSEMENT_FEE`
customPaymentAmountType	`LATE_REPAYMENT_FEE`
customPaymentAmountType	`INTEREST`
dataViewType	`PORTAL_ACCOUNT_TRANSACTION`
dataViewType	`LOANS_AGING_ANALYSIS`
dataViewType	`CLOSED_ACCOUNTS`
dataViewType	`CLIENT_OVERVIEW`
dataViewType	`ADMIN_CENTRES`
dataViewType	`USER_NOTIFICATION_MESSAGES`
dataViewType	`LINE_OF_CREDIT`
dataViewType	`USER_OVERVIEW`
dataViewType	`CENTRE_OVERVIEW`
dataViewType	`REPAYMENT_REPAYMENTS_COLLECTION`
dataViewType	`GROUP_OVERVIEW`
dataViewType	`ACTIVITIES_LOOKUP`
dataViewType	`TRANSACTION`
dataViewType	`ADMIN_BRANCHES`
dataViewType	`GROUP`
dataViewType	`BRANCH_OVERVIEW`
dataViewType	`NOTIFICATION_MESSAGE`
dataViewType	`PORTFOLIO_REPORTS`
dataViewType	`GROUP_NOTIFICATION_MESSAGES`
dataViewType	`LOAN_ACCOUNT_SECURITIES_OVERVIEW`
dataViewType	`LINE_OF_CREDIT_OVERVIEW`
dataViewType	`CURRENCIES`
dataViewType	`REPAYMENT`
dataViewType	`TILL_TRANSACTIONS`
dataViewType	`ALL_TASKS`
dataViewType	`CENTRE`
dataViewType	`BRANCH`
dataViewType	`INDEX_RATES_LIST`
dataViewType	`USER_TASKS`
dataViewType	`DOCUMENT_TEMPLATES`
dataViewType	`SAVINGS_TRANSACTIONS_LOOKUP`
dataViewType	`LOAN_ACCOUNT_OVERVIEW`
dataViewType	`DEPOSITS_COLLECTION`
dataViewType	`USER`
dataViewType	`ADMIN_USERS`
dataViewType	`GROUP_TASKS`
dataViewType	`CLIENT`
dataViewType	`LOAN_TRANSACTIONS_LOOKUP`
dataViewType	`LOANS`
dataViewType	`LOANS_REPAYMENTS_COLLECTION`
dataViewType	`CLIENT_TASKS`
dataViewType	`OVERDRAFTS_AGING_ANALYSIS`
dataViewType	`LOAN_ACCOUNT_FUNDING_OVERVIEW`
dataViewType	`SAVINGS`
dataViewType	`SAVINGS_OVERVIEW`
dataViewType	`JOURNAL_ENTRY`
dataViewType	`CLIENT_NOTIFICATION_MESSAGES`
loanConstraintsUsage	`UNCONSTRAINED_USAGE`
loanConstraintsUsage	`LIMITED_USAGE`
savingsConstraintsUsage	`UNCONSTRAINED_USAGE`
savingsConstraintsUsage	`LIMITED_USAGE`
currencySymbolPosition	`AFTER_NUMBER`
currencySymbolPosition	`BEFORE_NUMBER`
state	`REVERTED`
state	`DRAFT`
state	`APPROVED`
type	`IMPORT`
type	`EXPORT`
type	`INCOME`
type	`EXPENSE`
type	`LIABILITY`
type	`ASSET`
type	`EQUITY`
usage	`HEADER`
usage	`DETAIL`
financialResource	`FEE_RECEIVABLE`
financialResource	`OVERDRAFT_INTEREST_INCOME`
financialResource	`OVERDRAFT_INTEREST_RECEIVABLE`
financialResource	`FEE_INCOME`
financialResource	`INTEREST_PAYABLE`
financialResource	`INTEREST_EXPENSE`
financialResource	`PENALTY_RECEIVABLE`
financialResource	`INTEREST_INCOME`
financialResource	`DEFERRED_TAXES`
financialResource	`DEFERRED_FEE_INCOME`
financialResource	`PORTFOLIO_CONTROL`
financialResource	`DEFERRED_INTERESTS_INCOME`
financialResource	`OVERDRAFT_WRITE_OFF_EXPENSE`
financialResource	`PENALTY_INCOME`
financialResource	`OVERDRAFT_PORTFOLIO_CONTROL`
financialResource	`SAVINGS_CONTROL`
financialResource	`TAXES_RECEIVABLE`
financialResource	`INTEREST_RECEIVABLE`
financialResource	`INTER_BRANCH_TRANSFER`
financialResource	`FUND_SOURCE`
financialResource	`WRITE_OFF_EXPENSE`
financialResource	`DEPOSIT_REFERENCE`
financialResource	`TAXES_PAYABLE`
productType	`LOAN`
productType	`SAVINGS`
type	`TAX_RATE`
type	`INTEREST_RATE`
type	`WITHHOLDING_TAX_RATE`
type	`AMORTIZATION_ADJUSTMENT`
type	`AMORTIZATION_CORRECTION`
type	`AMORTIZATION`
frequency	`ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING`
frequency	`ACCOUNT_INSTALLMENTS_DUE_DATES`
frequency	`CUSTOM_INTERVAL`
intervalType	`FULL_TERM`
intervalType	`PREDEFINED_INTERVALS`
periodUnit	`MONTHS`
periodUnit	`YEARS`
periodUnit	`WEEKS`
periodUnit	`DAYS`
amortizationProfile	`STRAIGHT_LINE`
amortizationProfile	`SUM_OF_YEARS_DIGITS`
amortizationProfile	`EFFECTIVE_INTEREST_RATE`
amortizationProfile	`NONE`
amountCalculationMethod	`LOAN_AMOUNT_PERCENTAGE`
amountCalculationMethod	`LOAN_AMOUNT_PERCENTAGE_NUMBER_OF_INSTALLMENTS`
amountCalculationMethod	`REPAYMENT_PRINCIPAL_AMOUNT_PERCENTAGE`
amountCalculationMethod	`FLAT_NUMBER_OF_INSTALLMENTS`
amountCalculationMethod	`FLAT`
applyDateMethod	`MONTHLY_FROM_ACTIVATION`
applyDateMethod	`FIRST_OF_EVERY_MONTH`
feeAmortizationUponRescheduleOption	`CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT`
feeAmortizationUponRescheduleOption	`END_AMORTIZATION_ON_THE_ORIGINAL_ACCOUNT`
feeApplication	`OPTIONAL`
feeApplication	`REQUIRED`
trigger	`DISBURSEMENT`
trigger	`ARBITRARY`
trigger	`CAPITALIZED_DISBURSEMENT`
trigger	`MONTHLY_FEE`
trigger	`UPFRONT_DISBURSEMENT`
trigger	`LATE_REPAYMENT`
trigger	`MANUAL`
trigger	`PAYMENT_DUE`
trigger	`PAYMENT_DUE_APPLIED_ON_DUE_DATES`
type	`PENALTY_UNLOCKED`
type	`INTEREST_UNLOCKED`
type	`INTEREST_LOCKED`
type	`DISBURSMENT`
type	`INTEREST_APPLIED`
type	`DISBURSMENT_ADJUSTMENT`
type	`FEE`
type	`INTEREST_APPLIED_ADJUSTMENT`
type	`FEE_ADJUSTMENT`
type	`REPAYMENT_ADJUSTMENT`
type	`PENALTY_LOCKED`
type	`REPAYMENT`
type	`WRITE_OFF`
type	`FEE_CHARGED`
type	`PENALTY_APPLIED`
type	`PENALTY_ADJUSTMENT`
type	`INTEREST_RATE_CHANGED`

Loan Products

Allows you to retrieve one individual loan product by id/key or a list of paginated products.

Get all Loan Products

GET /loanproducts

Get all Loan Products

Get all loan products

Parameters

Name	Type	Description	In
offset	integer	start at index x when the limit paramter has been used	query
limit	integer	max number of records to return	query

Example Responses

200 : ok
a single loan product

[
  {
    "encodedKey": "8a193c26722b51b701722d77ca932614",
    "id": "AGL",
    "creationDate": "2020-05-19T15:05:25+0000",
    "lastModifiedDate": "2020-06-15T10:22:41+0000",
    "productName": "Agriculture Loan",
    "productDescription": "Its main purpose is to help clients who need financial help to buy fertilizers and seeds to grow their crops with the purpose of selling. <p>Eligible clients would be <b>local farmers</b>, whose income depends on the crops that they grow and sell. </p>",
    "loanProductType": "FIXED_TERM_LOAN",
    "defaultLoanAmount": "950",
    "minLoanAmount": "750",
    "maxLoanAmount": "1150",
    "maxNumberOfDisbursementTranches": 1,
    "idGeneratorType": "RANDOM_PATTERN",
    "idPattern": "@@@@###",
    "accountInitialState": "PENDING_APPROVAL",
    "activated": true,
    "repaymentScheduleMethod": "FIXED",
    "scheduleDueDatesMethod": "INTERVAL",
    "defaultRepaymentPeriodCount": 1,
    "repaymentPeriodUnit": "MONTHS",
    "fixedDaysOfMonth": [],
    "defaultNumInstallments": 5,
    "minNumInstallments": 3,
    "maxNumInstallments": 6,
    "gracePeriodType": "NONE",
    "defaultPrincipalRepaymentInterval": 1,
    "roundingRepaymentScheduleMethod": "ROUND_REMAINDER_INTO_LAST_REPAYMENT",
    "repaymentCurrencyRounding": "NO_ROUNDING",
    "repaymentElementsRoundingMethod": "NO_ROUNDING",
    "paymentMethod": "HORIZONTAL",
    "amortizationMethod": "STANDARD_PAYMENTS",
    "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
    "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
    "futurePaymentsAcceptance": "NO_FUTURE_PAYMENTS",
    "repaymentAllocationOrder": [
      "FEE",
      "PENALTY",
      "INTEREST",
      "PRINCIPAL"
    ],
    "allowCustomRepaymentAllocation": false,
    "interestCalculationMethod": "DECLINING_BALANCE",
    "interestRateSettings": {
      "defaultInterestRate": "2.5",
      "minInterestRate": "2",
      "encodedKey": "8a193c26722b51b701722d77ca932615",
      "interestChargeFrequency": "EVERY_FOUR_WEEKS",
      "interestChargeFrequencyCount": 1,
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "FIXED",
      "interestRateTiers": [],
      "accrueInterestAfterMaturity": false
    },
    "interestType": "SIMPLE_INTEREST",
    "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
    "interestApplicationMethod": "ON_DISBURSEMENT",
    "daysInYear": "E30_360",
    "scheduleInterestDaysCountMethod": "USING_REPAYMENT_PERIODICITY",
    "loanPenaltyCalculationMethod": "NONE",
    "arrearsSettings": {
      "defaultTolerancePeriod": 50,
      "minTolerancePeriod": 10,
      "maxTolerancePeriod": 100,
      "encodedKey": "8a193c26722b51b701722d77cb632616",
      "toleranceCalculationMethod": "ARREARS_TOLERANCE_PERIOD",
      "dateCalculationMethod": "DATE_ACCOUNT_FIRST_WENT_TO_ARREARS",
      "nonWorkingDaysMethod": "EXCLUDED"
    },
    "loanFees": [
      {
        "encodedKey": "8a193c26722b51b701722d77cc752620",
        "name": "Card Lost",
        "amount": "120.9",
        "amountCalculationMethod": "FLAT",
        "trigger": "MANUAL",
        "feeApplication": "REQUIRED",
        "active": true,
        "creationDate": "2020-06-15T10:17:45+0000",
        "amortizationProfile": "NONE",
        "feeAmortizationUponRescheduleOption": "END_AMORTIZATION_ON_THE_ORIGINAL_ACCOUNT",
        "feeProductRules": []
      }
    ],
    "allowArbitraryFees": false,
    "accountingMethod": "ACCRUAL",
    "loanProductRules": [],
    "interestAccruedAccountingMethod": "NONE",
    "interestAccrualCalculation": "NONE",
    "accountLinkingEnabled": true,
    "autoLinkAccounts": false,
    "autoCreateLinkedAccounts": false,
    "settlementOptions": "FULL_DUE_AMOUNTS",
    "repaymentScheduleEditOptions": [
      "ADJUST_PAYMENT_HOLIDAYS"
    ],
    "taxesOnInterestEnabled": false,
    "taxesOnFeesEnabled": false,
    "taxesOnPenaltyEnabled": false,
    "cappingApplyAccruedChargesBeforeLocking": false,
    "lineOfCreditRequirement": "OPTIONAL",
    "templates": [
      {
        "encodedKey": "8a193c26722b51b701722d77cc812625",
        "name": "Contract",
        "creationDate": "2020-05-19T15:05:25+0000",
        "lastModifiedDate": "2020-05-19T15:05:25+0000",
        "type": "ACCOUNT"
      },
      {
        "encodedKey": "8a193c26722b51b701722d77cc812626",
        "name": "Statement",
        "creationDate": "2020-05-19T15:05:25+0000",
        "lastModifiedDate": "2020-05-19T15:05:25+0000",
        "type": "ACCOUNT_WITH_TRANSACTIONS"
      },
      {
        "encodedKey": "8a193c26722b51b701722d77cc812627",
        "name": "Receipt",
        "creationDate": "2020-05-19T15:05:25+0000",
        "lastModifiedDate": "2020-05-19T15:05:25+0000",
        "type": "TRANSACTION"
      }
    ],
    "productSecuritySettings": {
      "encodedKey": "8a19a5e472b747bd0172b77d0bd500d9",
      "isGuarantorsEnabled": false,
      "isCollateralEnabled": false,
      "isInvestorFundsEnabled": false
    },
    "forIndividuals": true,
    "forPureGroups": false,
    "forHybridGroups": false,
    "forAllBranches": true,
    "availableProductBranches": [],
    "repaymentReschedulingMethod": "NEXT_WORKING_DAY",
    "accrueLateInterest": true
  },
  {
    "encodedKey": "8a193c26722b51b701722d77cb632617",
    "id": "FGL",
    "creationDate": "2020-05-19T15:05:25+0000",
    "lastModifiedDate": "2020-05-19T15:05:25+0000",
    "productName": "Fishermen Group Loan",
    "productDescription": "For groups of fishermen who need to finance a new boat to improve their fishing activities ",
    "loanProductType": "FIXED_TERM_LOAN",
    "defaultLoanAmount": "1500",
    "minLoanAmount": "1500",
    "maxLoanAmount": "2000",
    "maxNumberOfDisbursementTranches": 1,
    "idGeneratorType": "RANDOM_PATTERN",
    "idPattern": "@@@@###",
    "accountInitialState": "PENDING_APPROVAL",
    "activated": true,
    "repaymentScheduleMethod": "FIXED",
    "scheduleDueDatesMethod": "INTERVAL",
    "defaultRepaymentPeriodCount": 1,
    "repaymentPeriodUnit": "MONTHS",
    "defaultNumInstallments": 10,
    "minNumInstallments": 5,
    "maxNumInstallments": 12,
    "gracePeriodType": "NONE",
    "defaultPrincipalRepaymentInterval": 1,
    "roundingRepaymentScheduleMethod": "ROUND_REMAINDER_INTO_LAST_REPAYMENT",
    "repaymentCurrencyRounding": "NO_ROUNDING",
    "repaymentElementsRoundingMethod": "NO_ROUNDING",
    "paymentMethod": "HORIZONTAL",
    "amortizationMethod": "STANDARD_PAYMENTS",
    "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
    "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
    "futurePaymentsAcceptance": "NO_FUTURE_PAYMENTS",
    "repaymentAllocationOrder": [
      "FEE",
      "PENALTY",
      "INTEREST",
      "PRINCIPAL"
    ],
    "allowCustomRepaymentAllocation": false,
    "interestCalculationMethod": "FLAT",
    "interestRateSettings": {
      "defaultInterestRate": "25.5",
      "minInterestRate": "21",
      "encodedKey": "8a193c26722b51b701722d77cb632618",
      "interestChargeFrequency": "ANNUALIZED",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "FIXED",
      "interestRateTiers": [],
      "accrueInterestAfterMaturity": false
    },
    "interestType": "SIMPLE_INTEREST",
    "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
    "interestApplicationMethod": "ON_DISBURSEMENT",
    "daysInYear": "ACTUAL_365_FIXED",
    "scheduleInterestDaysCountMethod": "USING_ACTUAL_DAYS_COUNT",
    "loanPenaltyCalculationMethod": "NONE",
    "loanPenaltyGracePeriod": 0,
    "arrearsSettings": {
      "encodedKey": "8a193c26722b51b701722d77cb632619",
      "toleranceCalculationMethod": "ARREARS_TOLERANCE_PERIOD",
      "dateCalculationMethod": "DATE_ACCOUNT_FIRST_WENT_TO_ARREARS",
      "nonWorkingDaysMethod": "EXCLUDED"
    },
    "loanFees": [
      {
        "encodedKey": "8a193c26722b51b701722d77cc752621",
        "name": "Card Lost",
        "amount": "120.9",
        "amountCalculationMethod": "FLAT",
        "trigger": "MANUAL",
        "feeApplication": "REQUIRED",
        "active": true,
        "amortizationProfile": "NONE",
        "feeAmortizationUponRescheduleOption": "END_AMORTIZATION_ON_THE_ORIGINAL_ACCOUNT",
        "feeProductRules": []
      }
    ],
    "allowArbitraryFees": false,
    "accountingMethod": "CASH",
    "loanProductRules": [],
    "interestAccruedAccountingMethod": "NONE",
    "interestAccrualCalculation": "NONE",
    "accountLinkingEnabled": false,
    "autoLinkAccounts": false,
    "autoCreateLinkedAccounts": false,
    "settlementOptions": "FULL_DUE_AMOUNTS",
    "repaymentScheduleEditOptions": [],
    "taxesOnInterestEnabled": false,
    "taxesOnFeesEnabled": false,
    "taxesOnPenaltyEnabled": false,
    "cappingApplyAccruedChargesBeforeLocking": false,
    "lineOfCreditRequirement": "OPTIONAL",
    "templates": [
      {
        "encodedKey": "8a193c26722b51b701722d77cc812628",
        "name": "Contract",
        "creationDate": "2020-05-19T15:05:25+0000",
        "lastModifiedDate": "2020-05-19T15:05:25+0000",
        "type": "ACCOUNT"
      },
      {
        "encodedKey": "8a193c26722b51b701722d77cc812629",
        "name": "Statement",
        "creationDate": "2020-05-19T15:05:25+0000",
        "lastModifiedDate": "2020-05-19T15:05:25+0000",
        "type": "ACCOUNT_WITH_TRANSACTIONS"
      },
      {
        "encodedKey": "8a193c26722b51b701722d77cc96262a",
        "name": "Receipt",
        "creationDate": "2020-05-19T15:05:25+0000",
        "lastModifiedDate": "2020-05-19T15:05:25+0000",
        "type": "TRANSACTION"
      }
    ],
    "forIndividuals": false,
    "forPureGroups": false,
    "forHybridGroups": true,
    "forAllBranches": true,
    "availableProductBranches": [],
    "repaymentReschedulingMethod": "NEXT_WORKING_DAY",
    "accrueLateInterest": true
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[LoanProductApiV1]	none	none
» accountInitialState	string	none	none
» accountLinkingEnabled	boolean	none	none
» accountingMethod	string	none	none
» accrueLateInterest	boolean	none	none
» activated	boolean	none	none
» allowArbitraryFees	boolean	none	none
» allowCustomRepaymentAllocation	boolean	none	none
» amortizationMethod	string	none	none
» applyInterestOnPrepaymentMethod	string	none	none
» arrearsSettings	ProductArrearsSettingsApiV1	none	none
»» dateCalculationMethod	string	none	none
»» defaultTolerancePeriod	number	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» maxTolerancePeriod	number	none	none
»» minTolerancePeriod	number	none	none
»» monthlyToleranceDay	number	none	none
»» nonWorkingDaysMethod	string	none	none
»» toleranceCalculationMethod	string	none	none
» autoCreateLinkedAccounts	boolean	none	none
» autoLinkAccounts	boolean	none	none
» availableProductBranches	[LoanProductBranchApiV1]	none	none
»» branchKey	string	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» product	LoanProductApiV1	none	none
» cappingApplyAccruedChargesBeforeLocking	boolean	none	none
» cappingConstraintType	string	none	none
» cappingMethod	string	none	none
» cappingPercentage	number	none	none
» creationDate	string	the date and time when this loan product was created	none
» daysInYear	string	none	none
» defaultFirstRepaymentDueDateOffset	number	none	none
» defaultGracePeriod	number	none	none
» defaultLoanAmount	number	none	none
» defaultNumInstallments	number	none	none
» defaultPenaltyRate	number	none	none
» defaultPrincipalRepaymentInterval	number	none	none
» defaultRepaymentPeriodCount	number	none	none
» dormancyPeriodDays	number	none	none
» elementsRecalculationMethod	string	none	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» fixedDaysOfMonth	[number]	none	none
» forAllBranches	boolean	none	none
» forHybridGroups	boolean	none	none
» forIndividuals	boolean	none	none
» forPureGroups	boolean	none	none
» futurePaymentsAcceptance	string	none	none
» gracePeriodType	string	none	none
» id	string	none	none
» idGeneratorType	string	none	none
» idPattern	string	none	none
» interestAccrualCalculation	string	none	none
» interestAccruedAccountingMethod	string	none	none
» interestApplicationMethod	string	none	none
» interestBalanceCalculationMethod	string	none	none
» interestCalculationMethod	string	none	none
» interestRateSettings	InterestProductSettingsApiV1	none	none
»» accrueInterestAfterMaturity	boolean	none	none
»» defaultInterestRate	number	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» indexSourceKey	string	none	none
»» interestChargeFrequency	string	none	none
»» interestChargeFrequencyCount	number	none	none
»» interestRateCeilingValue	number	none	none
»» interestRateFloorValue	number	none	none
»» interestRateReviewCount	number	none	none
»» interestRateReviewUnit	string	none	none
»» interestRateSource	string	none	none
»» interestRateTerms	string	none	none
»» interestRateTiers	[InterestRateTierApiV1]	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» endingBalance	number	none	none
»»» endingDay	number	none	none
»»» index	number	none	none
»»» interestRate	number	none	none
»» maxInterestRate	number	none	none
»» minInterestRate	number	none	none
» interestType	string	none	none
» lastModifiedDate	string	the date on which this loan product was last modified	none
» latePaymentsRecalculationMethod	string	none	none
» lineOfCreditRequirement	string	none	none
» linkableSavingsProductKey	string	none	none
» loanFees	[PredefinedFeeApiV1]	none	none
»» active	boolean	none	none
»» amortizationIntervalSettings	PeriodIntervalSettingsApiV1	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» frequency	string	none	none
»»» intervalCount	number	none	none
»»» intervalType	string	none	none
»»» periodCount	number	none	none
»»» periodUnit	string	none	none
»» amortizationProfile	string	none	none
»» amount	number	none	none
»» amountCalculationMethod	string	none	none
»» applyDateMethod	string	none	none
»» creationDate	string	the date and time when this fee was created	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» feeAmortizationUponRescheduleOption	string	none	none
»» feeApplication	string	none	none
»» feeProductRules	[GLAccountingRuleApiV1]	none	none
»»» account	GLAccountApiV1	A general ledger account	none
»»»» activated	boolean	whether this general ledger account is in use	none
»»»» allowManualJournalEntries	boolean	whether manual entries are allowed for this general ledger account	none
»»»» balance	number	the current balance of this general ledger account	none
»»»» creationDate	string(date-time)	the date on which this general ledger account was created	read-only
»»»» currency	CurrencyApiV1	none	none
»»»»» code	string	the three letter ISO code for this currency	none
»»»»» creationDate	string	the date on which this currency was created	none
»»»»» currencySymbolPosition	string	indicates where the currency symbol should appear in relation to the numeric value	none
»»»»» digitsAfterDecimal	number	indicates how many decimal places are allowed for this currency. For example, a currenncy with 100 minor units to 1 major unit, there will be 2 decimal places.	none
»»»»» isBaseCurrency	boolean	whether this currency is the base currency for your banking institution	none
»»»»» lastModifiedDate	string	the date on which this currency was last modified	none
»»»»» name	string	the name of this currency	none
»»»»» symbol	string	the currency symnbol used for this currency	none
»»»» description	string	an optional description for this general ledger account	none
»»»» encodedKey	string	the encoded key of this general ledger account	none
»»»» glCode	string	the numeric code for this general ledger account	none
»»»» lastModifiedDate	string(date-time)	the date on which this general ledger account was last modified	read-only
»»»» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
»»»»» creationDate	string(date-time)	the date on which the data import was made	none
»»»»» encodedKey	string	the encoded key of this data migration event	none
»»»»» numCentresImported	number	the number of centres which were imported during the data migration	none
»»»»» numClientsImported	number	the number of clients which were imported as part of the data migration	none
»»»»» numGLAccountsImported	number	the number of general ledger accounts which were imported as part of the data migration	none
»»»»» numGroupsImported	number	the number of groups which were imported as part of the data migration	none
»»»»» numLoanRepaymentsImported	number	the number of loan repayment transations which were imported as part of the data migration	none
»»»»» numLoanTransactionsImported	number	the number of loan transactions which were imported as part of the data migration	none
»»»»» numLoansImported	number	the number of loan accounts which were imported as part of the data migration	none
»»»»» numSavingsImported	number	the number of savings accounts which were imported as part of the data migration	none
»»»»» state	string	whether the data import was accepted, is still in a draft state, or was rejected and all data reverted	none
»»»»» type	string	the type of migration event	none
»»»» name	string	the name of this general ledger account	none
»»»» stripTrailingZeros	boolean	controls how this account is organized into header accounts when there are trailing zeroes, for example, for the account code `1100`, if this field is set to true, only the first two numbers will be recognised	none
»»»» type	string	the type of general ledger account	none
»»»» usage	string	whether this general ledger account is a `DETAIL` account, in which case it will have a value, or a `HEADER` account, in which case its value will be calculated based on the sum of detail accounts under it.	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» financialResource	string	the type of transaction governed by this rule	none
»»» index	number	the index in list when there are multiple rules for the same type of transaction	none
»»» predefinedFeeKey	string	the encoded key of the predefined key this rule relates to	none
»»» productKey	string	the encoded key of the product this rule relates to	none
»»» productType	string	the type of account this rule relates to	none
»»» transactionChannelKey	string	the encoded key of the transaction channel that this rule relates to	none
»» name	string	none	none
»» percentageAmount	number	none	none
»» trigger	string	none	none
» loanPenaltyCalculationMethod	string	none	none
» loanPenaltyGracePeriod	number	none	none
» loanProductRules	[GLAccountingRuleApiV1]	none	none
» loanProductType	string	none	none
» lockPeriodDays	number	none	none
» maxFirstRepaymentDueDateOffset	number	none	none
» maxGracePeriod	number	none	none
» maxLoanAmount	number	none	none
» maxNumInstallments	number	none	none
» maxNumberOfDisbursementTranches	number	none	none
» maxPenaltyRate	number	none	none
» minFirstRepaymentDueDateOffset	number	none	none
» minGracePeriod	number	none	none
» minLoanAmount	number	none	none
» minNumInstallments	number	none	none
» minPenaltyRate	number	none	none
» offsetPercentage	number	none	none
» offsetSettings	ProductOffsetSettingsApiV1	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» isOffsetEnabled	boolean	none	none
»» loanProduct	LoanProductApiV1	none	none
» paymentMethod	string	none	none
» prepaymentAcceptance	string	none	none
» prepaymentRecalculationMethod	string	none	none
» principalPaidInstallmentStatus	string	none	none
» principalPaymentSettings	PrincipalPaymentProductSettingsApiV1	none	none
»» defaultAmount	number	none	none
»» defaultPercentage	number	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» includeFeesInFloorAmount	boolean	none	none
»» includeInterestInFloorAmount	boolean	none	none
»» maxAmount	number	none	none
»» maxPercentage	number	none	none
»» minAmount	number	none	none
»» minPercentage	number	none	none
»» principalCeilingValue	number	none	none
»» principalFloorValue	number	none	none
»» principalPaymentMethod	string	none	none
» productDescription	string	none	none
» productName	string	none	none
» productSecuritySettings	ProductSecuritySettingsApiV1	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» funderInterestCommission	DecimalIntervalConstraintsApiV1	none	none
»»» defaultValue	number	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» maxValue	number	none	none
»»» minValue	number	none	none
»» funderInterestCommissionAllocationType	string	none	none
»» isCollateralEnabled	boolean	none	none
»» isGuarantorsEnabled	boolean	none	none
»» isInvestorFundsEnabled	boolean	none	none
»» lockFundsAtApproval	boolean	none	none
»» organizationInterestCommission	DecimalIntervalConstraintsApiV1	none	none
»» requiredGuaranties	number	none	none
»» requiredInvestorFunds	number	none	none
» redrawSettings	ProductRedrawSettingsApiV1	none	none
»» allowRedraw	boolean	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
» repaymentAllocationOrder	[string]	none	none
» repaymentCurrencyRounding	string	none	none
» repaymentElementsRoundingMethod	string	none	none
» repaymentPeriodUnit	string	none	none
» repaymentReschedulingMethod	string	none	none
» repaymentScheduleEditOptions	[string]	none	none
» repaymentScheduleMethod	string	none	none
» roundingRepaymentScheduleMethod	string	none	none
» scheduleDueDatesMethod	string	none	none
» scheduleInterestDaysCountMethod	string	none	none
» settlementOptions	string	none	none
» shortMonthHandlingMethod	string	none	none
» taxCalculationMethod	string	none	none
» taxSourceKey	string	none	none
» taxesOnFeesEnabled	boolean	none	none
» taxesOnInterestEnabled	boolean	none	none
» taxesOnPenaltyEnabled	boolean	none	none
» templates	[DocumentTemplateApiV1]	none	none
»» creationDate	string	the date and time when this document was created	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» lastModifiedDate	string	the date on which this document template was last modified	none
»» name	string	the name of the document template	none
»» type	string	the type of template, this will have an impact on what data is available to the template as placeholders	none

Enumerated Values

Property	Value
accountInitialState	`WITHDRAWN`
accountInitialState	`PARTIALLY_DISBURSED`
accountInitialState	`LOCKED`
accountInitialState	`ACTIVE`
accountInitialState	`CLOSED`
accountInitialState	`PARTIAL_APPLICATION`
accountInitialState	`LOCKED_CAPPING`
accountInitialState	`CLOSED_REJECTED`
accountInitialState	`RESCHEDULED`
accountInitialState	`ACTIVE_IN_ARREARS`
accountInitialState	`MATURED`
accountInitialState	`CLOSED_RESCHEDULED`
accountInitialState	`CLOSED_WITHDRAWN`
accountInitialState	`PENDING_APPROVAL`
accountInitialState	`APPROVED`
accountInitialState	`REFINANCED`
accountInitialState	`DORMANT`
accountInitialState	`CLOSED_WRITTEN_OFF`
accountingMethod	`NONE`
accountingMethod	`CASH`
accountingMethod	`ACCRUAL`
amortizationMethod	`PAYMENT_PLAN`
amortizationMethod	`BALLOON_PAYMENTS`
amortizationMethod	`STANDARD_PAYMENTS`
amortizationMethod	`OPTIMIZED_PAYMENTS`
applyInterestOnPrepaymentMethod	`AUTOMATIC`
applyInterestOnPrepaymentMethod	`MANUAL`
dateCalculationMethod	`DATE_OF_LAST_LATE_REPAYMENT`
dateCalculationMethod	`DATE_ACCOUNT_FIRST_WENT_TO_ARREARS`
nonWorkingDaysMethod	`EXCLUDED`
nonWorkingDaysMethod	`INCLUDED`
toleranceCalculationMethod	`MONTHLY_ARREARS_TOLERANCE_DAY`
toleranceCalculationMethod	`ARREARS_TOLERANCE_PERIOD`
cappingConstraintType	`SOFT_CAP`
cappingConstraintType	`HARD_CAP`
cappingMethod	`OUTSTANDING_PRINCIPAL_PERCENTAGE`
cappingMethod	`ORIGINAL_PRINCIPAL_PERCENTAGE`
daysInYear	`E30_42_365`
daysInYear	`ACTUAL_365_FIXED`
daysInYear	`ACTUAL_360`
daysInYear	`E30_360`
daysInYear	`ACTUAL_364`
daysInYear	`ACTUAL_ACTUAL_ISDA`
elementsRecalculationMethod	`FIXED_PRINCIPAL_EXPECTED`
elementsRecalculationMethod	`FIXED_TOTAL_EXPECTED`
futurePaymentsAcceptance	`ACCEPT_OVERPAYMENTS`
futurePaymentsAcceptance	`NO_FUTURE_PAYMENTS`
futurePaymentsAcceptance	`ACCEPT_FUTURE_PAYMENTS`
gracePeriodType	`PAY_INTEREST_ONLY`
gracePeriodType	`NONE`
gracePeriodType	`INTEREST_FORGIVENESS`
idGeneratorType	`INCREMENTAL_NUMBER`
idGeneratorType	`RANDOM_PATTERN`
interestAccrualCalculation	`BREAKDOWN_PER_ACCOUNT`
interestAccrualCalculation	`AGGREGATED_AMOUNT`
interestAccrualCalculation	`NONE`
interestAccruedAccountingMethod	`DAILY`
interestAccruedAccountingMethod	`END_OF_MONTH`
interestAccruedAccountingMethod	`NONE`
interestApplicationMethod	`ON_REPAYMENT`
interestApplicationMethod	`ON_DISBURSEMENT`
interestBalanceCalculationMethod	`PRINCIPAL_ONLY`
interestBalanceCalculationMethod	`PRINCIPAL_AND_INTEREST`
interestCalculationMethod	`DECLINING_BALANCE`
interestCalculationMethod	`DECLINING_BALANCE_DISCOUNTED`
interestCalculationMethod	`FLAT`
interestChargeFrequency	`EVERY_WEEK`
interestChargeFrequency	`ANNUALIZED`
interestChargeFrequency	`EVERY_MONTH`
interestChargeFrequency	`EVERY_X_DAYS`
interestChargeFrequency	`EVERY_FOUR_WEEKS`
interestChargeFrequency	`EVERY_DAY`
interestRateReviewUnit	`MONTHS`
interestRateReviewUnit	`WEEKS`
interestRateReviewUnit	`DAYS`
interestRateSource	`FIXED_INTEREST_RATE`
interestRateSource	`INDEX_INTEREST_RATE`
interestRateTerms	`TIERED_PERIOD`
interestRateTerms	`FIXED`
interestRateTerms	`TIERED`
interestType	`CAPITALIZED_INTEREST`
interestType	`SIMPLE_INTEREST`
latePaymentsRecalculationMethod	`INCREASE_OVERDUE_INSTALLMENTS`
latePaymentsRecalculationMethod	`INCREASE_LAST_INSTALLMENT`
lineOfCreditRequirement	`OPTIONAL`
lineOfCreditRequirement	`NOT_REQUIRED`
lineOfCreditRequirement	`REQUIRED`
frequency	`ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING`
frequency	`ACCOUNT_INSTALLMENTS_DUE_DATES`
frequency	`CUSTOM_INTERVAL`
intervalType	`FULL_TERM`
intervalType	`PREDEFINED_INTERVALS`
periodUnit	`MONTHS`
periodUnit	`YEARS`
periodUnit	`WEEKS`
periodUnit	`DAYS`
amortizationProfile	`STRAIGHT_LINE`
amortizationProfile	`SUM_OF_YEARS_DIGITS`
amortizationProfile	`EFFECTIVE_INTEREST_RATE`
amortizationProfile	`NONE`
amountCalculationMethod	`LOAN_AMOUNT_PERCENTAGE`
amountCalculationMethod	`LOAN_AMOUNT_PERCENTAGE_NUMBER_OF_INSTALLMENTS`
amountCalculationMethod	`REPAYMENT_PRINCIPAL_AMOUNT_PERCENTAGE`
amountCalculationMethod	`FLAT_NUMBER_OF_INSTALLMENTS`
amountCalculationMethod	`FLAT`
applyDateMethod	`MONTHLY_FROM_ACTIVATION`
applyDateMethod	`FIRST_OF_EVERY_MONTH`
feeAmortizationUponRescheduleOption	`CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT`
feeAmortizationUponRescheduleOption	`END_AMORTIZATION_ON_THE_ORIGINAL_ACCOUNT`
feeApplication	`OPTIONAL`
feeApplication	`REQUIRED`
currencySymbolPosition	`AFTER_NUMBER`
currencySymbolPosition	`BEFORE_NUMBER`
state	`REVERTED`
state	`DRAFT`
state	`APPROVED`
type	`IMPORT`
type	`EXPORT`
type	`INCOME`
type	`EXPENSE`
type	`LIABILITY`
type	`ASSET`
type	`EQUITY`
usage	`HEADER`
usage	`DETAIL`
financialResource	`FEE_RECEIVABLE`
financialResource	`OVERDRAFT_INTEREST_INCOME`
financialResource	`OVERDRAFT_INTEREST_RECEIVABLE`
financialResource	`FEE_INCOME`
financialResource	`INTEREST_PAYABLE`
financialResource	`INTEREST_EXPENSE`
financialResource	`PENALTY_RECEIVABLE`
financialResource	`INTEREST_INCOME`
financialResource	`DEFERRED_TAXES`
financialResource	`DEFERRED_FEE_INCOME`
financialResource	`PORTFOLIO_CONTROL`
financialResource	`DEFERRED_INTERESTS_INCOME`
financialResource	`OVERDRAFT_WRITE_OFF_EXPENSE`
financialResource	`PENALTY_INCOME`
financialResource	`OVERDRAFT_PORTFOLIO_CONTROL`
financialResource	`SAVINGS_CONTROL`
financialResource	`TAXES_RECEIVABLE`
financialResource	`INTEREST_RECEIVABLE`
financialResource	`INTER_BRANCH_TRANSFER`
financialResource	`FUND_SOURCE`
financialResource	`WRITE_OFF_EXPENSE`
financialResource	`DEPOSIT_REFERENCE`
financialResource	`TAXES_PAYABLE`
productType	`LOAN`
productType	`SAVINGS`
trigger	`DISBURSEMENT`
trigger	`ARBITRARY`
trigger	`CAPITALIZED_DISBURSEMENT`
trigger	`MONTHLY_FEE`
trigger	`UPFRONT_DISBURSEMENT`
trigger	`LATE_REPAYMENT`
trigger	`MANUAL`
trigger	`PAYMENT_DUE`
trigger	`PAYMENT_DUE_APPLIED_ON_DUE_DATES`
loanPenaltyCalculationMethod	`OVERDUE_BALANCE_AND_INTEREST`
loanPenaltyCalculationMethod	`OUTSTANDING_PRINCIPAL`
loanPenaltyCalculationMethod	`OVERDUE_BALANCE`
loanPenaltyCalculationMethod	`NONE`
loanProductType	`INTEREST_FREE_LOAN`
loanProductType	`DYNAMIC_TERM_LOAN`
loanProductType	`FIXED_TERM_LOAN`
loanProductType	`REVOLVING_CREDIT`
loanProductType	`TRANCHED_LOAN`
paymentMethod	`VERTICAL`
paymentMethod	`HORIZONTAL`
prepaymentAcceptance	`ACCEPT_PREPAYMENTS`
prepaymentAcceptance	`NO_PREPAYMENTS`
prepaymentRecalculationMethod	`NO_RECALCULATION`
prepaymentRecalculationMethod	`RECALCULATE_SCHEDULE_KEEP_SAME_NUMBER_OF_TERMS`
prepaymentRecalculationMethod	`REDUCE_AMOUNT_PER_INSTALLMENT`
prepaymentRecalculationMethod	`REDUCE_NUMBER_OF_INSTALLMENTS_NEW`
prepaymentRecalculationMethod	`REDUCE_NUMBER_OF_INSTALLMENTS`
prepaymentRecalculationMethod	`RESCHEDULE_REMAINING_REPAYMENTS`
prepaymentRecalculationMethod	`RECALCULATE_SCHEDULE_KEEP_SAME_TOTAL_REPAYMENT_AMOUNT`
prepaymentRecalculationMethod	`RECALCULATE_SCHEDULE_KEEP_SAME_PRINCIPAL_AMOUNT`
principalPaidInstallmentStatus	`PARTIALLY_PAID`
principalPaidInstallmentStatus	`ORIGINAL_TOTAL_EXPECTED_PAID`
principalPaidInstallmentStatus	`PAID`
principalPaymentMethod	`OUTSTANDING_PRINCIPAL_PERCENTAGE`
principalPaymentMethod	`FLAT`
principalPaymentMethod	`TOTAL_BALANCE_PERCENTAGE`
funderInterestCommissionAllocationType	`PERCENTAGE_OF_LOAN_FUNDING`
funderInterestCommissionAllocationType	`FIXED_INTEREST_COMMISSIONS`
repaymentCurrencyRounding	`ROUND_UP_TO_NEAREST_WHOLE_UNIT`
repaymentCurrencyRounding	`NO_ROUNDING`
repaymentCurrencyRounding	`ROUND_TO_NEAREST_WHOLE_UNIT`
repaymentElementsRoundingMethod	`NO_ROUNDING`
repaymentElementsRoundingMethod	`PAYMENT_DUE`
repaymentElementsRoundingMethod	`ROUND_ALL`
repaymentPeriodUnit	`MONTHS`
repaymentPeriodUnit	`YEARS`
repaymentPeriodUnit	`WEEKS`
repaymentPeriodUnit	`DAYS`
repaymentReschedulingMethod	`PREVIOUS_WORKING_DAY`
repaymentReschedulingMethod	`NEXT_WORKING_DAY`
repaymentReschedulingMethod	`NONE`
repaymentReschedulingMethod	`EXTEND_SCHEDULE`
repaymentScheduleMethod	`FIXED`
repaymentScheduleMethod	`NONE`
repaymentScheduleMethod	`DYNAMIC`
roundingRepaymentScheduleMethod	`ROUND_PRINCIPAL_AND_INTEREST_REMAINDER_INTO_LAST_REPAYMENT`
roundingRepaymentScheduleMethod	`NO_ROUNDING`
roundingRepaymentScheduleMethod	`ROUND_REMAINDER_INTO_LAST_REPAYMENT`
scheduleDueDatesMethod	`INTERVAL`
scheduleDueDatesMethod	`FIXED_DAYS_OF_MONTH`
scheduleInterestDaysCountMethod	`USING_REPAYMENT_PERIODICITY`
scheduleInterestDaysCountMethod	`USING_ACTUAL_DAYS_COUNT`
settlementOptions	`NO_AUTOMATED_TRANSFERS`
settlementOptions	`PARTIAL_DUE_AMOUNTS`
settlementOptions	`FULL_DUE_AMOUNTS`
shortMonthHandlingMethod	`LAST_DAY_IN_MONTH`
shortMonthHandlingMethod	`FIRST_DAY_OF_NEXT_MONTH`
taxCalculationMethod	`EXCLUSIVE`
taxCalculationMethod	`INCLUSIVE`
type	`ACCOUNT`
type	`ACCOUNT_WITH_TRANSACTIONS`
type	`TRANSACTION`

Get Loan Product by ID

GET /loanproducts/{loanProductId}

Get Loan Product by ID

Get loan product by ID

Parameters

Name	Type	Description	In
loanProductId (required)	string	The ID of the loan product. The format is determined by your organization.	path

Example Responses

200 : ok
a loan product

{
  "encodedKey": "8a19df6972b787fc0172b8b74c710b8b",
  "id": "guar",
  "creationDate": "2020-06-15T16:02:00+0000",
  "lastModifiedDate": "2020-06-15T19:59:29+0000",
  "productName": "guaranty",
  "productDescription": "",
  "loanProductType": "FIXED_TERM_LOAN",
  "defaultLoanAmount": "5000",
  "maxNumberOfDisbursementTranches": 1,
  "idGeneratorType": "RANDOM_PATTERN",
  "idPattern": "@@@@###",
  "accountInitialState": "PENDING_APPROVAL",
  "activated": true,
  "repaymentScheduleMethod": "FIXED",
  "scheduleDueDatesMethod": "INTERVAL",
  "defaultRepaymentPeriodCount": 1,
  "repaymentPeriodUnit": "MONTHS",
  "fixedDaysOfMonth": [],
  "gracePeriodType": "NONE",
  "defaultPrincipalRepaymentInterval": 1,
  "roundingRepaymentScheduleMethod": "ROUND_REMAINDER_INTO_LAST_REPAYMENT",
  "repaymentCurrencyRounding": "NO_ROUNDING",
  "repaymentElementsRoundingMethod": "NO_ROUNDING",
  "paymentMethod": "HORIZONTAL",
  "amortizationMethod": "STANDARD_PAYMENTS",
  "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
  "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
  "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
  "repaymentAllocationOrder": [
    "FEE",
    "PENALTY",
    "INTEREST",
    "PRINCIPAL"
  ],
  "allowCustomRepaymentAllocation": false,
  "interestCalculationMethod": "FLAT",
  "interestRateSettings": {
    "defaultInterestRate": "5",
    "encodedKey": "8a19df6972b787fc0172b8b74c710b8e",
    "interestChargeFrequency": "ANNUALIZED",
    "interestChargeFrequencyCount": 1,
    "interestRateSource": "FIXED_INTEREST_RATE",
    "interestRateTerms": "FIXED",
    "interestRateTiers": [],
    "accrueInterestAfterMaturity": false
  },
  "interestType": "SIMPLE_INTEREST",
  "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
  "interestApplicationMethod": "ON_DISBURSEMENT",
  "daysInYear": "E30_360",
  "scheduleInterestDaysCountMethod": "USING_REPAYMENT_PERIODICITY",
  "defaultPenaltyRate": "6",
  "minPenaltyRate": "3",
  "maxPenaltyRate": "9",
  "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
  "loanPenaltyGracePeriod": 3,
  "arrearsSettings": {
    "defaultTolerancePeriod": 5,
    "minTolerancePeriod": 1,
    "maxTolerancePeriod": 10,
    "encodedKey": "8a19df6972b787fc0172b8b74c710b8f",
    "toleranceCalculationMethod": "ARREARS_TOLERANCE_PERIOD",
    "dateCalculationMethod": "DATE_ACCOUNT_FIRST_WENT_TO_ARREARS",
    "nonWorkingDaysMethod": "EXCLUDED"
  },
  "loanFees": [
    {
      "encodedKey": "8a19df6972b787fc0172b9908ea20c39",
      "name": "feeeeeee",
      "amount": "44",
      "amountCalculationMethod": "FLAT",
      "trigger": "MANUAL",
      "feeApplication": "REQUIRED",
      "active": true,
      "creationDate": "2020-06-15T19:57:53+0000",
      "amortizationProfile": "STRAIGHT_LINE",
      "feeAmortizationUponRescheduleOption": "END_AMORTIZATION_ON_THE_ORIGINAL_ACCOUNT",
      "amortizationIntervalSettings": {
        "encodedKey": "8a19df6972b787fc0172b990b8c80c3a",
        "frequency": "CUSTOM_INTERVAL",
        "periodUnit": "WEEKS",
        "periodCount": 3,
        "intervalType": "FULL_TERM"
      },
      "feeProductRules": []
    }
  ],
  "allowArbitraryFees": false,
  "accountingMethod": "ACCRUAL",
  "loanProductRules": [
    {
      "encodedKey": "8a19df6972b787fc0172b990b8c80c3b",
      "productKey": "8a19df6972b787fc0172b8b74c710b8b",
      "productType": "LOAN",
      "financialResource": "FUND_SOURCE",
      "account": {
        "encodedKey": "8a193c26722b51b701722d77cd9e26c0",
        "creationDate": "2020-05-19T15:05:26+0000",
        "lastModifiedDate": "2020-05-19T15:05:26+0000",
        "glCode": "11100",
        "type": "ASSET",
        "usage": "DETAIL",
        "name": "Cash on Hand",
        "activated": true,
        "allowManualJournalEntries": true,
        "stripTrailingZeros": true,
        "currency": {
          "code": "EUR",
          "name": "Euro",
          "symbol": "€",
          "digitsAfterDecimal": 2,
          "currencySymbolPosition": "BEFORE_NUMBER",
          "isBaseCurrency": true,
          "creationDate": "2020-05-18T08:53:31+0000",
          "lastModifiedDate": "2020-05-18T08:53:31+0000"
        }
      },
      "index": 0
    },
    {
      "encodedKey": "8a19df6972b787fc0172b990b8c80c3c",
      "productKey": "8a19df6972b787fc0172b8b74c710b8b",
      "productType": "LOAN",
      "financialResource": "WRITE_OFF_EXPENSE",
      "account": {
        "encodedKey": "8a193c26722b51b701722d77cdaa26c8",
        "creationDate": "2020-05-19T15:05:26+0000",
        "lastModifiedDate": "2020-05-19T15:05:26+0000",
        "glCode": "67000",
        "type": "EXPENSE",
        "usage": "DETAIL",
        "name": "Losses Written Off",
        "activated": true,
        "allowManualJournalEntries": true,
        "stripTrailingZeros": true,
        "currency": {
          "code": "EUR",
          "name": "Euro",
          "symbol": "€",
          "digitsAfterDecimal": 2,
          "currencySymbolPosition": "BEFORE_NUMBER",
          "isBaseCurrency": true,
          "creationDate": "2020-05-18T08:53:31+0000",
          "lastModifiedDate": "2020-05-18T08:53:31+0000"
        }
      },
      "index": 1
    },
    {
      "encodedKey": "8a19df6972b787fc0172b990b8c80c3d",
      "productKey": "8a19df6972b787fc0172b8b74c710b8b",
      "productType": "LOAN",
      "financialResource": "INTEREST_RECEIVABLE",
      "account": {
        "encodedKey": "8a193c26722b51b701722d77cdb126ca",
        "creationDate": "2020-05-19T15:05:26+0000",
        "lastModifiedDate": "2020-05-19T15:05:26+0000",
        "glCode": "11700",
        "type": "ASSET",
        "usage": "DETAIL",
        "name": "Interest Receivable",
        "activated": true,
        "allowManualJournalEntries": true,
        "stripTrailingZeros": true,
        "currency": {
          "code": "EUR",
          "name": "Euro",
          "symbol": "€",
          "digitsAfterDecimal": 2,
          "currencySymbolPosition": "BEFORE_NUMBER",
          "isBaseCurrency": true,
          "creationDate": "2020-05-18T08:53:31+0000",
          "lastModifiedDate": "2020-05-18T08:53:31+0000"
        }
      },
      "index": 2
    },
    {
      "encodedKey": "8a19df6972b787fc0172b990b8c80c3e",
      "productKey": "8a19df6972b787fc0172b8b74c710b8b",
      "productType": "LOAN",
      "financialResource": "FEE_RECEIVABLE",
      "account": {
        "encodedKey": "8a193c26722b51b701722d77cdb126cc",
        "creationDate": "2020-05-19T15:05:26+0000",
        "lastModifiedDate": "2020-05-19T15:05:26+0000",
        "glCode": "11900",
        "type": "ASSET",
        "usage": "DETAIL",
        "name": "Fees Receivable",
        "activated": true,
        "allowManualJournalEntries": true,
        "stripTrailingZeros": true,
        "currency": {
          "code": "EUR",
          "name": "Euro",
          "symbol": "€",
          "digitsAfterDecimal": 2,
          "currencySymbolPosition": "BEFORE_NUMBER",
          "isBaseCurrency": true,
          "creationDate": "2020-05-18T08:53:31+0000",
          "lastModifiedDate": "2020-05-18T08:53:31+0000"
        }
      },
      "index": 3
    },
    {
      "encodedKey": "8a19df6972b787fc0172b990b8dc0c3f",
      "productKey": "8a19df6972b787fc0172b8b74c710b8b",
      "productType": "LOAN",
      "financialResource": "PENALTY_RECEIVABLE",
      "account": {
        "encodedKey": "8a193c26722b51b701722d77cdb126ce",
        "creationDate": "2020-05-19T15:05:26+0000",
        "lastModifiedDate": "2020-05-19T15:05:26+0000",
        "glCode": "11800",
        "type": "ASSET",
        "usage": "DETAIL",
        "name": "Penalties & Fines Receivable",
        "activated": true,
        "allowManualJournalEntries": true,
        "stripTrailingZeros": true,
        "currency": {
          "code": "EUR",
          "name": "Euro",
          "symbol": "€",
          "digitsAfterDecimal": 2,
          "currencySymbolPosition": "BEFORE_NUMBER",
          "isBaseCurrency": true,
          "creationDate": "2020-05-18T08:53:31+0000",
          "lastModifiedDate": "2020-05-18T08:53:31+0000"
        }
      },
      "index": 4
    },
    {
      "encodedKey": "8a19df6972b787fc0172b990b8dc0c40",
      "productKey": "8a19df6972b787fc0172b8b74c710b8b",
      "productType": "LOAN",
      "financialResource": "DEFERRED_FEE_INCOME",
      "account": {
        "encodedKey": "8a193c26722b51b701722d77cdc826d4",
        "creationDate": "2020-05-19T15:05:26+0000",
        "lastModifiedDate": "2020-05-19T15:05:26+0000",
        "glCode": "22000",
        "type": "LIABILITY",
        "usage": "DETAIL",
        "name": "Client Savings",
        "activated": true,
        "allowManualJournalEntries": true,
        "stripTrailingZeros": true,
        "currency": {
          "code": "EUR",
          "name": "Euro",
          "symbol": "€",
          "digitsAfterDecimal": 2,
          "currencySymbolPosition": "BEFORE_NUMBER",
          "isBaseCurrency": true,
          "creationDate": "2020-05-18T08:53:31+0000",
          "lastModifiedDate": "2020-05-18T08:53:31+0000"
        }
      },
      "index": 5
    },
    {
      "encodedKey": "8a19df6972b787fc0172b990b8dc0c41",
      "productKey": "8a19df6972b787fc0172b8b74c710b8b",
      "productType": "LOAN",
      "financialResource": "FEE_INCOME",
      "account": {
        "encodedKey": "8a193c26722b51b701722d77cdb126cc",
        "creationDate": "2020-05-19T15:05:26+0000",
        "lastModifiedDate": "2020-05-19T15:05:26+0000",
        "glCode": "11900",
        "type": "ASSET",
        "usage": "DETAIL",
        "name": "Fees Receivable",
        "activated": true,
        "allowManualJournalEntries": true,
        "stripTrailingZeros": true,
        "currency": {
          "code": "EUR",
          "name": "Euro",
          "symbol": "€",
          "digitsAfterDecimal": 2,
          "currencySymbolPosition": "BEFORE_NUMBER",
          "isBaseCurrency": true,
          "creationDate": "2020-05-18T08:53:31+0000",
          "lastModifiedDate": "2020-05-18T08:53:31+0000"
        }
      },
      "index": 6
    },
    {
      "encodedKey": "8a19df6972b787fc0172b990b8dc0c42",
      "productKey": "8a19df6972b787fc0172b8b74c710b8b",
      "productType": "LOAN",
      "financialResource": "INTEREST_INCOME",
      "account": {
        "encodedKey": "8a193c26722b51b701722d77cdce26dc",
        "creationDate": "2020-05-19T15:05:26+0000",
        "lastModifiedDate": "2020-05-19T15:05:26+0000",
        "glCode": "51900",
        "type": "INCOME",
        "usage": "DETAIL",
        "name": "Interest from Overdrafts",
        "activated": true,
        "allowManualJournalEntries": true,
        "stripTrailingZeros": true,
        "currency": {
          "code": "EUR",
          "name": "Euro",
          "symbol": "€",
          "digitsAfterDecimal": 2,
          "currencySymbolPosition": "BEFORE_NUMBER",
          "isBaseCurrency": true,
          "creationDate": "2020-05-18T08:53:31+0000",
          "lastModifiedDate": "2020-05-18T08:53:31+0000"
        }
      },
      "index": 7
    },
    {
      "encodedKey": "8a19df6972b787fc0172b990b8dc0c43",
      "productKey": "8a19df6972b787fc0172b8b74c710b8b",
      "productType": "LOAN",
      "financialResource": "PENALTY_INCOME",
      "account": {
        "encodedKey": "8a193c26722b51b701722d77cdaa26c6",
        "creationDate": "2020-05-19T15:05:26+0000",
        "lastModifiedDate": "2020-05-19T15:05:26+0000",
        "glCode": "52100",
        "type": "INCOME",
        "usage": "DETAIL",
        "name": "Penalties & Fines",
        "activated": true,
        "allowManualJournalEntries": true,
        "stripTrailingZeros": true,
        "currency": {
          "code": "EUR",
          "name": "Euro",
          "symbol": "€",
          "digitsAfterDecimal": 2,
          "currencySymbolPosition": "BEFORE_NUMBER",
          "isBaseCurrency": true,
          "creationDate": "2020-05-18T08:53:31+0000",
          "lastModifiedDate": "2020-05-18T08:53:31+0000"
        }
      },
      "index": 8
    },
    {
      "encodedKey": "8a19df6972b787fc0172b990b8df0c44",
      "productKey": "8a19df6972b787fc0172b8b74c710b8b",
      "predefinedFeeKey": "8a19df6972b787fc0172b9908ea20c39",
      "productType": "LOAN",
      "financialResource": "DEFERRED_FEE_INCOME",
      "account": {
        "encodedKey": "8a193c26722b51b701722d77cdc826d4",
        "creationDate": "2020-05-19T15:05:26+0000",
        "lastModifiedDate": "2020-05-19T15:05:26+0000",
        "glCode": "22000",
        "type": "LIABILITY",
        "usage": "DETAIL",
        "name": "Client Savings",
        "activated": true,
        "allowManualJournalEntries": true,
        "stripTrailingZeros": true,
        "currency": {
          "code": "EUR",
          "name": "Euro",
          "symbol": "€",
          "digitsAfterDecimal": 2,
          "currencySymbolPosition": "BEFORE_NUMBER",
          "isBaseCurrency": true,
          "creationDate": "2020-05-18T08:53:31+0000",
          "lastModifiedDate": "2020-05-18T08:53:31+0000"
        }
      },
      "index": 9
    }
  ],
  "interestAccruedAccountingMethod": "NONE",
  "interestAccrualCalculation": "NONE",
  "accountLinkingEnabled": false,
  "autoLinkAccounts": false,
  "autoCreateLinkedAccounts": false,
  "settlementOptions": "FULL_DUE_AMOUNTS",
  "repaymentScheduleEditOptions": [
    "ADJUST_PAYMENT_DATES",
    "ADJUST_PRINCIPAL_PAYMENT_SCHEDULE"
  ],
  "taxesOnInterestEnabled": false,
  "taxesOnFeesEnabled": false,
  "taxesOnPenaltyEnabled": false,
  "cappingApplyAccruedChargesBeforeLocking": false,
  "lineOfCreditRequirement": "OPTIONAL",
  "templates": [
    {
      "encodedKey": "8a0aa3874e25265c014e253529d801e5",
      "name": "30 e 360 - Contract Template",
      "creationDate": "2015-06-24T10:55:18+0000",
      "lastModifiedDate": "2015-06-24T10:55:18+0000",
      "type": "ACCOUNT"
    },
    {
      "encodedKey": "8a0aa8494e84f2ac014e869b361c046d",
      "name": "Contract",
      "creationDate": "2015-07-13T08:49:56+0000",
      "lastModifiedDate": "2015-07-13T08:49:56+0000",
      "type": "ACCOUNT"
    }
  ],
  "productSecuritySettings": {
    "encodedKey": "8a19df6972b787fc0172b8b74c710b8c",
    "isGuarantorsEnabled": true,
    "isCollateralEnabled": true,
    "isInvestorFundsEnabled": true,
    "requiredGuaranties": "25",
    "requiredInvestorFunds": "100",
    "funderInterestCommissionAllocationType": "PERCENTAGE_OF_LOAN_FUNDING",
    "organizationInterestCommission": {
      "encodedKey": "8a19df6972b787fc0172b8b74c710b8d",
      "minValue": "7",
      "maxValue": "20",
      "defaultValue": "12"
    },
    "lockFundsAtApproval": false
  },
  "forIndividuals": true,
  "forPureGroups": false,
  "forHybridGroups": false,
  "forAllBranches": true,
  "availableProductBranches": [],
  "repaymentReschedulingMethod": "NEXT_WORKING_DAY",
  "accrueLateInterest": true
}

400 : Bad Request
bad ID

{
  "returnCode": 505,
  "returnStatus": "INVALID_PRODUCT_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	LoanProductApiV1
`400`	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Description	Restrictions
» returnCode	string	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Get Schedule Preview for Loan Product

GET /loanproducts/{loanProductId}/schedule

Preview possible repayment schedule

Get a preview of the schedule by providing product configuration by query parameters. You will need to provide any settings where there is no defined product default.

Parameters

Name	Type	Description	In
loanAmount (required)	string	Amount validated against the minimum / maximum constraints.	query
firstRepaymentDate (required)	string(date)	Due date of the first instalment	query
anticipatedDisbursement (required)	string(date)	Expected disbursement date	query
repaymentInstallments	string	Number of instalments. Required if no default specified in the product.	query
interestRate	string	Interest rate in full numbers (e.g. 2.6, not 0.026). Required if no default specified in the product.	query
fixedDaysOfMonth	string	If the loan is to be paid back on fixed days of the month provide these as comma separated values. Required if no default set for the product	query
periodicPayment	string	The amount per periodic payment. This is mandatory for ballon payments.	query
organizationCommission	string	The commision rate for the lending organization.	query
gracePeriod	string	Number of instalments in grace period. Required if no default specified in the product.	query
repaymentPeriodUnit	string	Units used for repaymentPeriodCount (DAYS, WEEKS, MONTHS, YEARS). Required if no default specified in the product.	query
repaymentPeriodCount	string	Number of repaymentPeriodUnit's are in a instalment. Required if no default specified in the product.	query
principalRepaymentInterval	string	How many repayments to pay the principal. Required if no default specified in the product.	query
loanProductId (required)	string	The ID of the loan product. The format is determined by your organization.	path

Detailed descriptions

organizationCommission: The commision rate for the lending organization.

Required if no default specified in product
Optional if a default is specified
Must be a postive, decimal value and may not be greater than the interest rate.
Allowed if the loan has a funding source.

Enumerated Values

Parameter	Value
repaymentPeriodUnit	`DAYS`
repaymentPeriodUnit	`WEEKS`
repaymentPeriodUnit	`MONTHS`
repaymentPeriodUnit	`YEARS`

Example Responses

200 : OK
a repayments schedule

{
  "repayments": [
    {
      "dueDate": "2020-11-02T00:00:00+0000",
      "principalDue": "326.67",
      "principalPaid": "0",
      "interestDue": "4.08",
      "organizationCommissionDue": "9.79",
      "fundersInterestDue": "-5.71",
      "interestPaid": "0",
      "feesDue": "0",
      "feesPaid": "0",
      "penaltyDue": "0",
      "penaltyPaid": "0",
      "state": "PENDING",
      "taxInterestDue": "0",
      "taxInterestPaid": "0",
      "taxFeesDue": "0",
      "taxFeesPaid": "0",
      "taxPenaltyDue": "0",
      "taxPenaltyPaid": "0",
      "repaymentUnappliedFeeDetails": []
    },
    {
      "dueDate": "2020-12-01T00:00:00+0000",
      "principalDue": "326.67",
      "principalPaid": "0",
      "interestDue": "4.08",
      "organizationCommissionDue": "9.79",
      "fundersInterestDue": "-5.71",
      "interestPaid": "0",
      "feesDue": "0",
      "feesPaid": "0",
      "penaltyDue": "0",
      "penaltyPaid": "0",
      "state": "PENDING",
      "taxInterestDue": "0",
      "taxInterestPaid": "0",
      "taxFeesDue": "0",
      "taxFeesPaid": "0",
      "taxPenaltyDue": "0",
      "taxPenaltyPaid": "0",
      "repaymentUnappliedFeeDetails": []
    },
    {
      "dueDate": "2021-01-01T00:00:00+0000",
      "principalDue": "326.66",
      "principalPaid": "0",
      "interestDue": "4.08",
      "organizationCommissionDue": "9.79",
      "fundersInterestDue": "-5.71",
      "interestPaid": "0",
      "feesDue": "0",
      "feesPaid": "0",
      "penaltyDue": "0",
      "penaltyPaid": "0",
      "state": "PENDING",
      "taxInterestDue": "0",
      "taxInterestPaid": "0",
      "taxFeesDue": "0",
      "taxFeesPaid": "0",
      "taxPenaltyDue": "0",
      "taxPenaltyPaid": "0",
      "repaymentUnappliedFeeDetails": []
    }
  ],
  "customSchedule": false,
  "newPaymentHolidaysAddedForFixedAccounts": false
}

400 : Bad Request
provided values out of range

{
  "returnCode": 184,
  "returnStatus": "PARAMS_INCONSISTENT_WITH_PRODUCT_RULES"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» repayments	[LoanRepaymentApiV1]	none	none
»» LoanRepaymentApiV1	LoanRepaymentApiV1	none	none
»»» dueDate	string(date-time)	none	none
»»» feesDue	string	none	none
»»» feesPaid	string	none	none
»»» fundersInterestDue	string	none	none
»»» interestDue	string	none	none
»»» interestPaid	string	none	none
»»» organizationCommissionDue	string	none	none
»»» penaltyDue	string	none	none
»»» penaltyPaid	string	none	none
»»» principalDue	string	none	none
»»» principalPaid	string	none	none
»»» repaymentUnappliedFeeDetails	[object]	none	none
»»» state	string	none	none
»»» taxFeesDue	string	none	none
»»» taxFeesPaid	string	none	none
»»» taxInterestDue	string	none	none
»»» taxInterestPaid	string	none	none
»»» taxPenaltyDue	string	none	none
»»» taxPenaltyPaid	string	none	none
» customSchedule	boolean	none	none
» newPaymentHolidaysAddedForFixedAccounts	boolean	none	none

Enumerated Values

Property	Value
state	`PENDING`
state	`PARTIALLY_PAID`
state	`LATE`
state	`PAID`
state	`GRACE`

Status Code 400

Name	Type	Description	Restrictions
» returnCode (required)	string	none	none
» returnStatus (required)	string	none	none
» errorSource	string	none	none

Get Loan Product Documents

GET /loanproducts/{loanProductId}/documents

Get documents for a loan product

Get all documents for a given loan product.

Parameters

Name	Type	Description	In
offset	integer	offset results. use with `limit` parameter to achieve paging	query
limit	integer	max number of records to return	query
loanProductId (required)	string	The ID of the loan productThe ID of the loan product. The format is determined by your organization.	path

Example Responses

200 : ok
an array of documents

[
  {
    "encodedKey": "8a19c035747bf5b901747c5bfb04014b",
    "id": 51,
    "creationDate": "2020-09-11T08:52:48+0000",
    "lastModifiedDate": "2020-09-11T08:52:48+0000",
    "documentHolderKey": "8a193c26722b51b701722d779e7122df",
    "documentHolderType": "LOAN_PRODUCT",
    "name": "covid rules",
    "type": "png",
    "fileSize": 8258,
    "originalFilename": "Screenshot_2020-04-22_at_14.31.29.png",
    "location": "BRSIDSLFBOGAYZKUUKCOGGQEDOSEOD",
    "description": "some guidelines regarding covid",
    "createdByUserKey": "8a194075720ece2c017226fced6f005e",
    "userName": "big chief"
  },
  {
    "encodedKey": "8a19a3337476f2d00174775b6a3001ae",
    "id": 43,
    "creationDate": "2020-09-10T09:31:54+0000",
    "lastModifiedDate": "2020-09-10T09:31:54+0000",
    "documentHolderKey": "8a193c26722b51b701722d779e7122df",
    "documentHolderType": "LOAN_PRODUCT",
    "name": "loan product doc",
    "type": "png",
    "fileSize": 32109,
    "originalFilename": "clients_duplicate_id.png",
    "location": "JRTBQGGVXFQRQRBDGBRWQCTXJNRWXP",
    "description": "loan product doc desc",
    "createdByUserKey": "8a194075720ece2c017226fced6f005e",
    "userName": "big chief"
  }
]

400 : Bad Request
bad loan product ID

{
  "returnCode": 4,
  "returnStatus": "INVALID_PARAMETERS",
  "errorSource": "wrong owner id"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[DocumentApiV1]	none	none
» createdByUserKey	string	the encoded key of the user who added this document	none
» creationDate	string	the date and time when this document was created	none
» description	string	a description of this document	none
» documentHolderKey	string	the encoded key of the entity to which this document is attached	none
» documentHolderType	string	the type of entity, eg. client, loan product, to which this document is attached	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» fileSize	number	the size, in bytes, of the attached document	none
» id	number	an ID for this document	none
» lastModifiedDate	string	the date on which this document was last modified	none
» location	string	indicates where the document is saved	none
» name	string	the display name of this document	none
» originalFilename	string	the name of the originally uploaded file	none
» type	string	the file type of the document, eg. png, jpeg, pdf	none
» userName	string	the name of the user who uploaded the document	none

Enumerated Values

Property	Value
documentHolderType	`BRANCH`
documentHolderType	`LOAN_ACCOUNT`
documentHolderType	`GROUP`
documentHolderType	`DEPOSIT_ACCOUNT`
documentHolderType	`LINE_OF_CREDIT`
documentHolderType	`LOAN_PRODUCT`
documentHolderType	`GL_JOURNAL_ENTRY`
documentHolderType	`SAVINGS_PRODUCT`
documentHolderType	`USER`
documentHolderType	`CLIENT`
documentHolderType	`CENTRE`
documentHolderType	`ID_DOCUMENT`

Attach new Loan Product Document

POST /loanproducts/{loanProductId}/documents

Attach new Document to a loan product

Attach a new document to a Savings Product.

Example Requests

a document to uplaod

{
  "document": {
    "documentHolderKey": "8a193c26722b51b701722d779e7122df",
    "documentHolderType": "LOAN_PRODUCT",
    "name": "some image",
    "type": "png",
    "description": "this is an image file"
  },
  "documentContent": "iVBORw0KGgoAAAANSUhEUgAAAnYAAAF0CAYAAACudHRvAAABQGlDQ1BJQ0MgUHJvZmlsZQAAKJFjYGASS=="
}

Parameters

Name	Type	Description	In
body	CreateDocumentApiV1	a new document to be attached to an entity	body
loanProductId (required)	string	The ID of the loan productThe ID of the loan product. The format is determined by your organization.	path

Example Responses

201 : Created
uploaded document details

{
  "encodedKey": "8a19c035747bf5b901747c5bfb04014d",
  "id": 52,
  "creationDate": "2020-09-11T08:54:53+0000",
  "lastModifiedDate": "2020-09-11T08:54:53+0000",
  "documentHolderKey": "8a193c26722b51b701722d779e7122df",
  "documentHolderType": "LOAN_PRODUCT",
  "name": "some image",
  "type": "png",
  "fileSize": 32109,
  "originalFilename": "some_image.png",
  "location": "RCPOUIUHJFBYDRURQNNHMOGBEFIOQF",
  "description": "this is an image file",
  "createdByUserKey": "8a194075720ece2c017226fced6f005e"
}

400 : Bad Request
filetype provided does not match actual file type

{
  "returnCode": 973,
  "returnStatus": "INCONSISTENT_EXTENSION_WITH_FILE_CONTENT",
  "errorSource": "Invalid extension with file content"
}

Responses

Status	Meaning	Description	Schema
`201`	Created	Created	DocumentApiV1
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Get Loan Product Attachment

GET /loanproducts/{loanProductId}/documents/{documentId}

Get a loan product Document

Get a specific document attached to a Loan Product.

Parameters

Name	Type	Description	In
loanProductId (required)	string	The ID of the loan product. The format is determined by your organization.	path
documentId (required)	string	The ID of the document. The format is determined by your organization.	path

Example Responses

200 : OK
base64 encoded document

"iVBORw0KGgoAAAANSUhEUgAAAEAAAAA9CAYAAAAd1W/BAAAMY2lDQ1BJQ0MgUHJvZmlsZQAASImVVwdck0cbv3dkkrACEZAR9hJFZgAZIawIAjIFUQlJIGHEmBBE3NRSBesWUZxoVUTRagWkDkSssyhu6yiKqFRqsYoLle8yoNZ+4/c9v9+993+fe+7/jNzlvQNAr5Mvk+Wj+gAUSAvlCZGhrElp6SzSI4ABU0ADtsCTL1DIOPHxMQDKUP93eX0DIKr+qpuK65/j/1UMhSKFAAAkA=="

400 : Bad Request
bad Document ID

{
  "returnCode": 970,
  "returnStatus": "INVALID_DOCUMENT_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	string
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Delete Attachment from Loan Product

DELETE /loanproducts/{loanProductId}/documents/{documentId}

Delete a loan product Document

Delete a document attached to a Loan Product.

Parameters

Name	Type	Description	In
loanProductId (required)	string	The ID of the loan product. The format is determined by your organization.	path
documentId (required)	string	The ID of the document. The format is determined by your organization.	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
bad Document ID

{
  "returnCode": 970,
  "returnStatus": "INVALID_DOCUMENT_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	ExecutionStatusApiV1
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Get Loan Product Comments

GET /loanproducts/{loanProductId}/comments

Get all Loan Product comments

Get all comments for a Loan Product.

Parameters

Name	Type	Description	In
limit	string	none	query
offset	string	none	query
loanProductId (required)	string	The ID of the loan product. The format is determined by your organization.	path

Example Responses

200 : OK
an array of comments

[
  {
    "encodedKey": "8a19b7057471f4af017472dc0fd80470",
    "parentKey": "8a193c26722b51b701722d77c5e423b7",
    "userKey": "8a194075720ece2c017226fced6f005e",
    "creationDate": "2020-09-09T14:24:42+0000",
    "lastModifiedDate": "2020-09-09T14:24:42+0000",
    "text": "aanother afmaefomaef<div><br /></div><div><u>aefaefaf</u></div><div><u><br /></u></div><div><u>afaef</u></div>"
  },
  {
    "encodedKey": "8a193c26722b51b701722d77c8bf25ab",
    "parentKey": "8a193c26722b51b701722d77c5e423b7",
    "creationDate": "2020-05-19T15:05:24+0000",
    "lastModifiedDate": "2020-05-19T15:05:24+0000",
    "text": "Should suggest she apply for the agriculture loan given the nature of their business"
  }
]

400 : Bad Request
bad Loan Product ID

{
  "returnCode": 149,
  "returnStatus": "INVALID_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[CommentApiV1]	none	none
» creationDate	string(date-time)	the date and time at which this comment was added	none
» encodedKey	string	a unique key for this comment	none
» lastModifiedDate	string(date-time)	the date and time at which this comment was last modified	none
» parentKey	string	the unique key of the parent object for this comment, for example, the client or loan account to which it relates	none
» text	string	the text of the comment as a string, must be properly JSON escpaped if it contains special characters	none
» userKey	string	the unique key of the user who created the comment	none

Create new Comment for Loan Product

POST /loanproducts/{loanProductId}/comments

Create a Loan Product Comment

Create new comment for a Loan Product.

Example Requests

a comment

{
  "comment": {
    "text": "this is a comment with \" \" all kinds of : \\ / \"non compliant\" stuff & = which has been JSON escaped"
  }
}

Parameters

Name	Type	Description	In
comment	object	an object contining the comment	body
» text	string	text of the comment to be added. if adding complex content make sure it is properly JSON encoded before making your request	body
loanProductId (required)	string	The ID of the loan product. The format is determined by your organization.	path

Example Responses

200 : OK
a comment

{
  "encodedKey": "8a19c34574720f9e0174734a039f06e2",
  "parentKey": "8a193c26722b51b701722d77c5e423b7",
  "userKey": "8a194075720ece2c017226fced6f005e",
  "creationDate": "2020-09-09T14:39:36+0000",
  "lastModifiedDate": "2020-09-09T14:39:36+0000",
  "text": "this is a comment with \" \" all kinds of : \\ / non compliant stuff & = which has been JSON escaped"
}

400 : Bad Request
extra parameters in the request

{
  "returnCode": 27,
  "returnStatus": "PARAMETER_NOT_ALLOWED"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	CommentApiV1
`400`	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Description	Restrictions
» returnCode	string	none	none
» returnStatus	string	none	none

Loan Transactions

Allows you to retrieve and post transactions for a loan account. Various transactions can be posted, including:

Approving a loan account
Undo approving a loan account
Disbursing a loan account
Undo disbursing a loan account
Manually applying interest
Applying a repayment
Applying a payment made
Undo applying a repayment
Applying a fee
Undo applying a fee
Applying a penalty
Undo applying a penalty
Closing a loan account
Writing Off a loan account
Reversing the write-off of a loan account
Undo closing a loan account
Lock a loan account
Unlock a Loan account
Undo applying a payment made

Search Loan Transactions

POST /loans/transactions/search

Search Loan Transactions

Retrieve transactions using dynamic custom filters.

Parameters

Parameter	Value
filterConstraints	A JSON array of constraints.
filterSelection	The field on which the constraint will be applied. Available transaction filter selections can be found below.
filterElement	The constraint operator. Available filter elements can be found below.
value	The constraint value. Required for filter elements with one or two values.
secondValue	The constraint second value. Required for filter elements with two values.
dataItemType	The entity where the field on which to apply the constraint is located. If the field is located in the same entity with the entity being searched, this field is optional.

Available transaction filter values

Filter Selection Parameter	Data Type
PARENT_ACCOUNT_KEY	KEY
PRODUCT_TYPE_KEY	KEY
USER_KEY	KEY
BRANCH_KEY	KEY
CENTRE_KEY	KEY
PARENT_ACCOUNT_HOLDER_KEY	KEY
CURRENCY_CODE	KEY
PRODUCT_ID	STRING
WAS_REVERSED	BOOLEAN
TYPE_IS_REVERSAL	BOOLEAN
INTERNAL_TRANSFER	BOOLEAN
TRANSACTION_CHANNEL_KEY	KEY
ENCODED_KEY	KEY
TRANSACTION_ID	LONG
TILL_ID	STRING
ENTRY_DATE	DATE
TRANSACTION_DATE	DATE_UTC
EVENT	ENUM
AMOUNT	MONEY
ADVANCE_POSITION	MONEY
ARREARS_POSITION	MONEY
EXPECTED_PRINCIPAL_REDRAW	MONEY
ORIGINAL_AMOUNT	MONEY
ORIGINAL_AMOUNT_CURRENCY_CODE	STRING
BALANCE (Deprecated. Use TOTAL_BALANCE)	MONEY
TOTAL_BALANCE	MONEY
PRINCIPAL_BALANCE	MONEY
REDRAW_BALANCE	MONEY
PRINCIPAL_PAID	MONEY
INTEREST_PAID	MONEY
DEFERRED_INTEREST	MONEY
FEES_PAID	MONEY
FEE_KEY	KEY
FEE_TYPE	ENUM
PENALTY_PAID	MONEY
BRANCH	STRING
CENTRE	STRING
PARENT_ACCOUNT	STRING
PARENT_ACCOUNT_ID	STRING
PARENT_ACCOUNT_HOLDER	STRING
PARENT_ACCOUNT_HOLDER_ID	STRING
TAX_RATE	BIG_DECIMAL
TAX_AMOUNT	MONEY
INTEREST_RATE	BIG_DECIMAL
PRINCIPAL_PAYMENT_FLAT_AMOUNT	MONEY
PRINCIPAL_PAYMENT_PERCENTAGE	BIG_DECIMAL

Filter Element	Number Of affected values	Available for
EQUALS	ONE_VALUE	BIG_DECIMAL,BOOLEAN,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY
MORE_THAN	ONE_VALUE	BIG_DECIMAL,NUMBER,MONEY
LESS_THAN	ONE_VALUE	BIG_DECIMAL,NUMBER,MONEY
BETWEEN	TWO_VALUES	BIG_DECIMAL,NUMBER,MONEY,DATE,DATE_UTC
ON	ONE_VALUE	DATE,DATE_UTC
AFTER	ONE_VALUE	DATE,DATE_UTC
BEFORE	ONE_VALUE	DATE,DATE_UTC
STARTS_WITH	ONE_VALUE	STRING
IN	LIST	ENUM,KEY
TODAY	NO_VALUE	DATE,DATE_UTC
THIS_WEEK	NO_VALUE	DATE,DATE_UTC
THIS_MONTH	NO_VALUE	DATE,DATE_UTC
THIS_YEAR	NO_VALUE	DATE,DATE_UTC
LAST_DAYS	ONE_VALUE	DATE,DATE_UTC
EMPTY	NO_VALUE	BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_UTC
NOT_EMPTY	NO_VALUE	BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_UTC

Example Requests

Find a loan transaction by ID

{
  "filterConstraints": [
    {
      "filterSelection": "TRANSACTION_ID",
      "filterElement": "EQUALS",
      "value": "58"
    }
  ]
}

Parameters

Name	Type	Description	In
offset	integer	none	query
limit	integer	none	query
body	FilterApiV1	none	body

Example Responses

200 Response

[
  {
    "advancePosition": 0,
    "amount": 0,
    "arrearsPosition": 0,
    "balance": 0,
    "bookingDate": "string",
    "branchKey": "string",
    "centreKey": "string",
    "comment": "string",
    "creationDate": "string",
    "customInformation": [
      {
        "amount": 0,
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "customFieldID": "string",
        "customFieldKey": "string",
        "customFieldSetGroupIndex": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexInList": 0,
        "linkedEntityKeyValue": "string",
        "parentKey": "string",
        "selectionKey": "string",
        "value": "string"
      }
    ],
    "customPaymentAmounts": [
      {
        "amount": 0,
        "customPaymentAmountType": "PAYMENT_DUE_FEE",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "index": 0,
        "loanTransactionKey": "string",
        "taxOnAmount": 0
      }
    ],
    "deferredInterestAmount": 0,
    "deferredTaxOnInterestAmount": 0,
    "details": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "internalTransfer": true,
      "targetSavingsAccountKey": "string",
      "transactionChannel": {
        "activated": true,
        "createdByUserKey": "string",
        "creationDate": "string",
        "customFields": [
          {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          }
        ],
        "encodedKey": "string",
        "id": "string",
        "index": 0,
        "loanConstraints": {
          "customConfigurationInfo": {
            "creationDate": "string",
            "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "shared": true,
            "userKey": "string"
          },
          "encodedKey": "string",
          "filterConstraints": [
            {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            }
          ]
        },
        "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
        "name": "string",
        "savingsConstraints": {
          "customConfigurationInfo": {
            "creationDate": "string",
            "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "shared": true,
            "userKey": "string"
          },
          "encodedKey": "string",
          "filterConstraints": [
            {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            }
          ]
        },
        "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
        "transactionChannelAccountingRule": {
          "account": {
            "activated": true,
            "allowManualJournalEntries": true,
            "balance": 0,
            "creationDate": "2019-08-24T14:15:22Z",
            "currency": {
              "code": "string",
              "creationDate": "string",
              "currencySymbolPosition": "AFTER_NUMBER",
              "digitsAfterDecimal": 0,
              "isBaseCurrency": true,
              "lastModifiedDate": "string",
              "name": "string",
              "symbol": "string"
            },
            "description": "string",
            "encodedKey": "string",
            "glCode": "string",
            "lastModifiedDate": "2019-08-24T14:15:22Z",
            "migrationEvent": {
              "creationDate": "2019-08-24T14:15:22Z",
              "encodedKey": "string",
              "numCentresImported": 0,
              "numClientsImported": 0,
              "numGLAccountsImported": 0,
              "numGroupsImported": 0,
              "numLoanRepaymentsImported": 0,
              "numLoanTransactionsImported": 0,
              "numLoansImported": 0,
              "numSavingsImported": 0,
              "state": "REVERTED",
              "type": "IMPORT"
            },
            "name": "string",
            "stripTrailingZeros": true,
            "type": "INCOME",
            "usage": "HEADER"
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "financialResource": "FEE_RECEIVABLE",
          "index": 0,
          "predefinedFeeKey": "string",
          "productKey": "string",
          "productType": "LOAN",
          "transactionChannelKey": "string"
        },
        "usageRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "transactionChannelKey": "string"
    },
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "entryDate": "string",
    "expectedPrincipalRedraw": 0,
    "feesPaid": 0,
    "fundersInterestAmount": 0,
    "indexInterestRate": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "notes": "string",
      "rate": 0,
      "rateSource": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "name": "string",
        "notes": "string",
        "type": "TAX_RATE"
      },
      "startDate": "string",
      "userKey": "string"
    },
    "interestFromArrearsAmount": 0,
    "interestPaid": 0,
    "interestRate": 0,
    "loanPredefinedFeeAmounts": [
      {
        "amortizedAmounts": [
          {
            "amount": 0,
            "branchKey": "string",
            "centreKey": "string",
            "creationDate": "string",
            "encodedKey": "string",
            "entryDate": "string",
            "reversalAmountKey": "string",
            "taxAmount": 0,
            "type": "AMORTIZATION_ADJUSTMENT"
          }
        ],
        "amount": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "fee": {
          "active": true,
          "amortizationIntervalSettings": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
            "intervalCount": 0,
            "intervalType": "FULL_TERM",
            "periodCount": 0,
            "periodUnit": "MONTHS"
          },
          "amortizationProfile": "STRAIGHT_LINE",
          "amount": 0,
          "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
          "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
          "creationDate": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
          "feeApplication": "OPTIONAL",
          "feeProductRules": [
            {
              "account": {
                "activated": true,
                "allowManualJournalEntries": true,
                "balance": 0,
                "creationDate": "2019-08-24T14:15:22Z",
                "currency": {
                  "code": "string",
                  "creationDate": "string",
                  "currencySymbolPosition": "AFTER_NUMBER",
                  "digitsAfterDecimal": 0,
                  "isBaseCurrency": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "symbol": "string"
                },
                "description": "string",
                "encodedKey": "string",
                "glCode": "string",
                "lastModifiedDate": "2019-08-24T14:15:22Z",
                "migrationEvent": {
                  "creationDate": "2019-08-24T14:15:22Z",
                  "encodedKey": "string",
                  "numCentresImported": 0,
                  "numClientsImported": 0,
                  "numGLAccountsImported": 0,
                  "numGroupsImported": 0,
                  "numLoanRepaymentsImported": 0,
                  "numLoanTransactionsImported": 0,
                  "numLoansImported": 0,
                  "numSavingsImported": 0,
                  "state": "REVERTED",
                  "type": "IMPORT"
                },
                "name": "string",
                "stripTrailingZeros": true,
                "type": "INCOME",
                "usage": "HEADER"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "financialResource": "FEE_RECEIVABLE",
              "index": 0,
              "predefinedFeeKey": "string",
              "productKey": "string",
              "productType": "LOAN",
              "transactionChannelKey": "string"
            }
          ],
          "name": "string",
          "percentageAmount": 0,
          "trigger": "DISBURSEMENT"
        },
        "taxAmount": 0,
        "transactionId": 0
      }
    ],
    "loanTransactionTerms": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "principalPaymentAmount": 0,
      "principalPaymentPercentage": 0
    },
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "organizationCommissionAmount": 0,
    "originalAmount": 0,
    "originalCurrencyCode": "string",
    "parentAccountKey": "string",
    "parentLoanTransactionKey": "string",
    "penaltyPaid": 0,
    "principalBalance": 0,
    "principalPaid": 0,
    "productTypeKey": "string",
    "redrawBalance": 0,
    "reversalTransactionKey": "string",
    "taxOnFeesAmount": 0,
    "taxOnInterestFromArrearsAmount": 0,
    "taxOnInterestPaid": 0,
    "taxOnPenaltyAmount": 0,
    "taxRate": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "notes": "string",
      "rate": 0,
      "rateSource": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "name": "string",
        "notes": "string",
        "type": "TAX_RATE"
      },
      "startDate": "string",
      "userKey": "string"
    },
    "tillKey": "string",
    "transactionId": 0,
    "type": "PENALTY_UNLOCKED",
    "userKey": "string",
    "valueDate": "string"
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[LoanTransactionApiV1]	none	none
» advancePosition	number	none	none
» amount	number	none	none
» arrearsPosition	number	none	none
» balance	number	none	none
» bookingDate	string	none	none
» branchKey	string	none	none
» centreKey	string	none	none
» comment	string	none	none
» creationDate	string	the date and time when this loan transaction was created	none
» customInformation	[CustomFieldValueApiV1]	none	none
»» amount	number	none	none
»» customField	CustomFieldApiV1	none	none
»»» amounts	object	used when options available for a custom field definition translate to predefined amounts, for example, when the custom field value is used to generate a score	none
»»»» additionalProperties	number	none	none
»»» builtInCustomFieldId	string	if this field is one of the built in custom fiel definitions, this will have a value. These names are reserved and you can not use them for your own custom field definitions	none
»»» creationDate	string	the date on which this custom field definition was created	none
»»» customFieldProductSettings	[CustomFieldLinkApiV1]	none	none
»»»» customFieldEncodedKey	string	the key to the parent custom field definition	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isDefault	boolean	whether this field is displayed by default when creating a new record	none
»»»» isRequired	boolean	whether this field is required when creating a new record	none
»»»» linkType	string	the type of entity this field represents a link to	none
»»»» productKey	string	when the link type is product, this field should contain the encoded key of the linekd product	none
»»» customFieldSelectionOptions	[CustomFieldSelectionApiV1]	[represents a possible selection for select type custom field definitions]	none
»»»» constraint	CustomFilterConstraintApiV1	none	none
»»»»» customFieldKey	string	none	none
»»»»» dataFieldType	string	none	none
»»»»» dataFieldValue	string	none	none
»»»»» dataItemType	string	none	none
»»»»» dataType	string	none	none
»»»»» encodedKey	string	none	none
»»»»» filterElement	string	none	none
»»»»» groupNumber	number	none	none
»»»»» index	number	none	none
»»»»» linkingOperator	string	none	none
»»»»» secondValue	string	none	none
»»»»» value	string	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this selectable item	none
»»»» score	number	the score assigned to this selection	none
»»»» value	string	display name of this option	none
»»» customFieldSet	CustomFieldSetApiV1	none	none
»»»» builtInType	string	if this set is part of the set of built-in custom field sets, its type will be shown here	none
»»»» createdDate	string	the date and time when this custom field set was created	none
»»»» customFields	[CustomFieldApiV1]	an array of custom field definitions included in this custom field set	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this custom field set	none
»»»» indexInList	number	for field sets that can be added to an entity more than once, this number represents the index in the list and is used when changing values	none
»»»» lastModifiedDate	string	the date on which this custom field set was last modified	none
»»»» name	string	the name of this custom field set	none
»»»» notes	string	any notes regarding this custom field set	none
»»»» type	string	the entity type that this custom field definition is attached to	none
»»»» usage	string	whether this custom field set can only be used once, or added multiple times to the same entity	none
»»» dataType	string	the type of custom field definition	none
»»» description	string	a brief description of this custom field definition	none
»»» editRights	UsageRightsApiV1	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isAccessibleByAllUsers	boolean	none	none
»»»» roles	[string]	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» id	string	the ID for this custom field definition	none
»»» indexInList	number	none	none
»»» isDefault	boolean	whether this field will be included by default on new records	none
»»» isRequired	boolean	whether this field is required when creating a new record	none
»»» lastModifiedDate	string	the date on which this custom field definition was last modified	none
»»» name	string	the name of this custom field definition	none
»»» state	string	whether this field is available for use or has been deactivated	none
»»» type	string	the type of data this custom field definition will contain	none
»»» unique	boolean	whether the data in this custom field definition needs to be a unique value	none
»»» validationPattern	string	a user-provided pattern to which data in this custom field definition must conform where @ represents numbers, # represents letters and $ is either a number or letter. Other special characters used as separators are allowed, for example `@@-##-$$$`	none
»»» valueLength	string	whether this field needs to support a large number of characters	none
»»» values	[string]	a list of possible values when the field is a selection field	none
»»» viewRights	UsageRightsApiV1	none	none
»» customFieldID	string	none	none
»» customFieldKey	string	none	none
»» customFieldSetGroupIndex	number	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» indexInList	number	none	none
»» linkedEntityKeyValue	string	none	none
»» parentKey	string	none	none
»» selectionKey	string	none	none
»» value	string	none	none
» customPaymentAmounts	[CustomPaymentAmountApiV1]	none	none
»» amount	number	the amount of this custom payment	none
»» customPaymentAmountType	string	the type of this custom payment	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» index	number	index in list when this is part of a custom payment of which parts are allocated to different types of charge, for example, a single payment that goes towards loan principal, a late payment fee and a penalty	none
»» loanTransactionKey	string	the encoded key of the loan transaction this custom payment is part of	none
»» taxOnAmount	number	the amount of tax charged for this payment	none
» deferredInterestAmount	number	none	none
» deferredTaxOnInterestAmount	number	none	none
» details	TransactionDetailsApiV1	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» internalTransfer	boolean	none	none
»» targetSavingsAccountKey	string	none	none
»» transactionChannel	TransactionChannelInTransactionDetailsApiV1	none	none
»»» activated	boolean	whether this transaction channel is enabled	none
»»» createdByUserKey	string	the encoded key of the user who created this transaction channel	none
»»» creationDate	string	the date on which this transaction channel was created	none
»»» customFields	[CustomFieldApiV1]	none	none
»»» encodedKey	string	the encoded key for this transaction channel	none
»»» id	string	the user specified ID for this transaction channel	none
»»» index	number	none	none
»»» loanConstraints	CustomFilterApiV1	none	none
»»»» customConfigurationInfo	CustomConfigurationInfoApiV1	none	none
»»»»» creationDate	string	the date on which this configuration was created	none
»»»»» dataViewType	string	the type of entity this configuration is for	none
»»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»»» indexInList	number	if more than one configuration exists for a given type, this is its index in the list	none
»»»»» lastModifiedDate	string	the date on which this configuration was last modified	none
»»»»» name	string	the name for this configuration	none
»»»»» shared	boolean	whether this configuration is private or can be used by other users of the system	none
»»»»» userKey	string	the encoded key of the Mambu user who created this configuration	none
»»»» encodedKey	string	none	none
»»»» filterConstraints	[CustomFilterConstraintApiV1]	none	none
»»» loanConstraintsUsage	string	whether there are any rules regarding usage of this transaction channel with loan accounts	none
»»» name	string	the name of this transaction channel	none
»»» savingsConstraints	CustomFilterApiV1	none	none
»»» savingsConstraintsUsage	string	whether there are any rules regarding usage of this transaction channel with savings accounts	none
»»» transactionChannelAccountingRule	GLAccountingRuleApiV1	none	none
»»»» account	GLAccountApiV1	A general ledger account	none
»»»»» activated	boolean	whether this general ledger account is in use	none
»»»»» allowManualJournalEntries	boolean	whether manual entries are allowed for this general ledger account	none
»»»»» balance	number	the current balance of this general ledger account	none
»»»»» creationDate	string(date-time)	the date on which this general ledger account was created	read-only
»»»»» currency	CurrencyApiV1	none	none
»»»»»» code	string	the three letter ISO code for this currency	none
»»»»»» creationDate	string	the date on which this currency was created	none
»»»»»» currencySymbolPosition	string	indicates where the currency symbol should appear in relation to the numeric value	none
»»»»»» digitsAfterDecimal	number	indicates how many decimal places are allowed for this currency. For example, a currenncy with 100 minor units to 1 major unit, there will be 2 decimal places.	none
»»»»»» isBaseCurrency	boolean	whether this currency is the base currency for your banking institution	none
»»»»»» lastModifiedDate	string	the date on which this currency was last modified	none
»»»»»» name	string	the name of this currency	none
»»»»»» symbol	string	the currency symnbol used for this currency	none
»»»»» description	string	an optional description for this general ledger account	none
»»»»» encodedKey	string	the encoded key of this general ledger account	none
»»»»» glCode	string	the numeric code for this general ledger account	none
»»»»» lastModifiedDate	string(date-time)	the date on which this general ledger account was last modified	read-only
»»»»» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
»»»»»» creationDate	string(date-time)	the date on which the data import was made	none
»»»»»» encodedKey	string	the encoded key of this data migration event	none
»»»»»» numCentresImported	number	the number of centres which were imported during the data migration	none
»»»»»» numClientsImported	number	the number of clients which were imported as part of the data migration	none
»»»»»» numGLAccountsImported	number	the number of general ledger accounts which were imported as part of the data migration	none
»»»»»» numGroupsImported	number	the number of groups which were imported as part of the data migration	none
»»»»»» numLoanRepaymentsImported	number	the number of loan repayment transations which were imported as part of the data migration	none
»»»»»» numLoanTransactionsImported	number	the number of loan transactions which were imported as part of the data migration	none
»»»»»» numLoansImported	number	the number of loan accounts which were imported as part of the data migration	none
»»»»»» numSavingsImported	number	the number of savings accounts which were imported as part of the data migration	none
»»»»»» state	string	whether the data import was accepted, is still in a draft state, or was rejected and all data reverted	none
»»»»»» type	string	the type of migration event	none
»»»»» name	string	the name of this general ledger account	none
»»»»» stripTrailingZeros	boolean	controls how this account is organized into header accounts when there are trailing zeroes, for example, for the account code `1100`, if this field is set to true, only the first two numbers will be recognised	none
»»»»» type	string	the type of general ledger account	none
»»»»» usage	string	whether this general ledger account is a `DETAIL` account, in which case it will have a value, or a `HEADER` account, in which case its value will be calculated based on the sum of detail accounts under it.	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» financialResource	string	the type of transaction governed by this rule	none
»»»» index	number	the index in list when there are multiple rules for the same type of transaction	none
»»»» predefinedFeeKey	string	the encoded key of the predefined key this rule relates to	none
»»»» productKey	string	the encoded key of the product this rule relates to	none
»»»» productType	string	the type of account this rule relates to	none
»»»» transactionChannelKey	string	the encoded key of the transaction channel that this rule relates to	none
»»» usageRights	UsageRightsApiV1	none	none
»» transactionChannelKey	string	none	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» entryDate	string	none	none
» expectedPrincipalRedraw	number	none	none
» feesPaid	number	none	none
» fundersInterestAmount	number	none	none
» indexInterestRate	IndexRateApiV1	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» notes	string	any notes relating to this index rate	none
»» rate	number	the percentage rate for this tax or interest rate	none
»» rateSource	IndexRateSourceApiV1	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» name	string	the name of this index rate source, eg. LIBOR	none
»»» notes	string	any notes relating to this index rate	none
»»» type	string	what kind of rate this source provides, eg. tax, interest, withholding tax	none
»» startDate	string	the first day on which this rate is considered valid	none
»» userKey	string	the encoded key of the user who added this index rate	none
» interestFromArrearsAmount	number	none	none
» interestPaid	number	none	none
» interestRate	number	none	none
» loanPredefinedFeeAmounts	[PredefinedFeeAmountApiV1]	none	none
»» amortizedAmounts	[AmortizationAmountApiV1]	none	none
»»» amount	number	the amount to be amortized	none
»»» branchKey	string	the encoded key of the branch owning the amount	none
»»» centreKey	string	the encoded key of the centre owning the amount	none
»»» creationDate	string	the date on which the amortization amount was created	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» entryDate	string	the date when this amount was recognised as amortized (in organization time)	none
»»» reversalAmountKey	string	if the amount was reversed, this field will contain the encoded key of the reversal record	none
»»» taxAmount	number	the amount of tax included in the amortized amount	none
»»» type	string	the type of entry represented by this object	none
»» amount	number	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» fee	PredefinedFeeApiV1	none	none
»»» active	boolean	none	none
»»» amortizationIntervalSettings	PeriodIntervalSettingsApiV1	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» frequency	string	none	none
»»»» intervalCount	number	none	none
»»»» intervalType	string	none	none
»»»» periodCount	number	none	none
»»»» periodUnit	string	none	none
»»» amortizationProfile	string	none	none
»»» amount	number	none	none
»»» amountCalculationMethod	string	none	none
»»» applyDateMethod	string	none	none
»»» creationDate	string	the date and time when this fee was created	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» feeAmortizationUponRescheduleOption	string	none	none
»»» feeApplication	string	none	none
»»» feeProductRules	[GLAccountingRuleApiV1]	none	none
»»» name	string	none	none
»»» percentageAmount	number	none	none
»»» trigger	string	none	none
»» taxAmount	number	none	none
»» transactionId	number	none	none
» loanTransactionTerms	LoanTransactionTermsApiV1	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» principalPaymentAmount	number	none	none
»» principalPaymentPercentage	number	none	none
» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
» organizationCommissionAmount	number	none	none
» originalAmount	number	none	none
» originalCurrencyCode	string	none	none
» parentAccountKey	string	none	none
» parentLoanTransactionKey	string	none	none
» penaltyPaid	number	none	none
» principalBalance	number	none	none
» principalPaid	number	none	none
» productTypeKey	string	none	none
» redrawBalance	number	none	none
» reversalTransactionKey	string	none	none
» taxOnFeesAmount	number	none	none
» taxOnInterestFromArrearsAmount	number	none	none
» taxOnInterestPaid	number	none	none
» taxOnPenaltyAmount	number	none	none
» taxRate	IndexRateApiV1	none	none
» tillKey	string	none	none
» transactionId	number	none	none
» type	string	none	none
» userKey	string	none	none
» valueDate	string	none	none

Enumerated Values

Property	Value
builtInCustomFieldId	`MOBILE_PHONE`
builtInCustomFieldId	`EMAIL_ADDRESS`
builtInCustomFieldId	`GENDER`
builtInCustomFieldId	`MIDDLE_NAME`
builtInCustomFieldId	`HOME_PHONE`
builtInCustomFieldId	`BIRTHDATE`
builtInCustomFieldId	`LAST_NAME`
builtInCustomFieldId	`FIRST_NAME`
linkType	`CLIENT_ROLE`
linkType	`CHANNEL`
linkType	`PRODUCT`
dataFieldType	`NATIVE`
dataFieldType	`CUSTOM`
dataItemType	`WRITTEN_OFF_LOANS`
dataItemType	`LINE_OF_CREDIT`
dataItemType	`INVESTOR_FUND`
dataItemType	`TRANSACTION_DETAILS`
dataItemType	`DOCUMENT_TEMPLATE`
dataItemType	`PRODUCT`
dataItemType	`MCC_EXPIRATION`
dataItemType	`CENTRE`
dataItemType	`REPAYMENT_COLLECTION`
dataItemType	`TASK`
dataItemType	`OUTSTANDING_PORTFOLIO_AMOUNTS`
dataItemType	`REVENUE`
dataItemType	`COMPOSED_TRANSACTIONS`
dataItemType	`UNION_TRANSACTIONS`
dataItemType	`PRINCIPAL_PAYMENT_SETTINGS`
dataItemType	`LOANS`
dataItemType	`DISBURSEMENT_DETAILS`
dataItemType	`SAVINGS_TRANSACTION`
dataItemType	`IDENTIFICATION_DOCUMENT`
dataItemType	`LOAN_PRODUCT`
dataItemType	`DISBURSED_LOANS`
dataItemType	`LOAN_GROUP`
dataItemType	`TRANSACTION_CHANNEL`
dataItemType	`CUSTOM_PREDEFINED_FEE`
dataItemType	`JOURNAL_ENTRY`
dataItemType	`ATTACHMENT`
dataItemType	`PREDEFINED_FEE`
dataItemType	`TRANCHE`
dataItemType	`TRANSACTION`
dataItemType	`INDEX_RATE_SOURCE`
dataItemType	`GROUP_ROLE`
dataItemType	`LOAN_TRANSACTION`
dataItemType	`CLIENT_ROLE`
dataItemType	`GROUP`
dataItemType	`NOTIFICATION_MESSAGE`
dataItemType	`OUTSTANDING_PORTFOLIO_ACCOUNTS`
dataItemType	`REPAYMENT`
dataItemType	`LOAN_ACCOUNT_GUARANTY`
dataItemType	`BRANCH`
dataItemType	`CURRENCY`
dataItemType	`CARD_TRANSACTION_REVERSAL`
dataItemType	`INTEREST_PRODUCT_SETTINGS`
dataItemType	`CREATED_ACCOUNTS`
dataItemType	`USER`
dataItemType	`SAVINGS_PRODUCT`
dataItemType	`CLIENT`
dataItemType	`PRODUCT_ARREARS_SETTINGS`
dataItemType	`SAVINGS`
dataItemType	`EXPENSE`
dataItemType	`INDEX_RATE`
dataItemType	`NOTIFICATION_TEMPLATE`
dataItemType	`CUSTOM_FIELD_SELECTION`
dataItemType	`ACTIVITY`
dataType	`ENUM`
dataType	`MONEY`
dataType	`NUMBER`
dataType	`DATE_UTC`
dataType	`JAVA_BLOB`
dataType	`OBJECT`
dataType	`BOOLEAN`
dataType	`DATE`
dataType	`PERCENT`
dataType	`BIG_DECIMAL`
dataType	`STRING`
dataType	`KEY`
dataType	`LONG`
filterElement	`STARTS_WITH_CASE_SENSITIVE`
filterElement	`THIS_WEEK`
filterElement	`EQUALS`
filterElement	`STARTS_WITH`
filterElement	`IN`
filterElement	`TODAY`
filterElement	`THIS_YEAR`
filterElement	`BETWEEN`
filterElement	`AFTER`
filterElement	`LESS_THAN`
filterElement	`DIFFERENT_THAN`
filterElement	`THIS_MONTH`
filterElement	`NOT_EMPTY`
filterElement	`BEFORE`
filterElement	`EQUALS_CASE_SENSITIVE`
filterElement	`LAST_DAYS`
filterElement	`MORE_THAN`
filterElement	`EMPTY`
filterElement	`ON`
linkingOperator	`OR`
linkingOperator	`AND`
builtInType	`DETAILS`
builtInType	`GENERAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
usage	`SINGLE`
usage	`GROUPED`
dataType	`GROUP_LINK`
dataType	`DATE`
dataType	`NUMBER`
dataType	`CHECKBOX`
dataType	`CLIENT_LINK`
dataType	`STRING`
dataType	`USER_LINK`
dataType	`SELECTION`
state	`DEACTIVATED`
state	`NORMAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
valueLength	`SHORT`
valueLength	`LONG`
customPaymentAmountType	`PAYMENT_DUE_FEE`
customPaymentAmountType	`PENALTY`
customPaymentAmountType	`MANUAL_FEE`
customPaymentAmountType	`PRINCIPAL`
customPaymentAmountType	`UPFRONT_DISBURSEMENT_FEE`
customPaymentAmountType	`LATE_REPAYMENT_FEE`
customPaymentAmountType	`INTEREST`
dataViewType	`PORTAL_ACCOUNT_TRANSACTION`
dataViewType	`LOANS_AGING_ANALYSIS`
dataViewType	`CLOSED_ACCOUNTS`
dataViewType	`CLIENT_OVERVIEW`
dataViewType	`ADMIN_CENTRES`
dataViewType	`USER_NOTIFICATION_MESSAGES`
dataViewType	`LINE_OF_CREDIT`
dataViewType	`USER_OVERVIEW`
dataViewType	`CENTRE_OVERVIEW`
dataViewType	`REPAYMENT_REPAYMENTS_COLLECTION`
dataViewType	`GROUP_OVERVIEW`
dataViewType	`ACTIVITIES_LOOKUP`
dataViewType	`TRANSACTION`
dataViewType	`ADMIN_BRANCHES`
dataViewType	`GROUP`
dataViewType	`BRANCH_OVERVIEW`
dataViewType	`NOTIFICATION_MESSAGE`
dataViewType	`PORTFOLIO_REPORTS`
dataViewType	`GROUP_NOTIFICATION_MESSAGES`
dataViewType	`LOAN_ACCOUNT_SECURITIES_OVERVIEW`
dataViewType	`LINE_OF_CREDIT_OVERVIEW`
dataViewType	`CURRENCIES`
dataViewType	`REPAYMENT`
dataViewType	`TILL_TRANSACTIONS`
dataViewType	`ALL_TASKS`
dataViewType	`CENTRE`
dataViewType	`BRANCH`
dataViewType	`INDEX_RATES_LIST`
dataViewType	`USER_TASKS`
dataViewType	`DOCUMENT_TEMPLATES`
dataViewType	`SAVINGS_TRANSACTIONS_LOOKUP`
dataViewType	`LOAN_ACCOUNT_OVERVIEW`
dataViewType	`DEPOSITS_COLLECTION`
dataViewType	`USER`
dataViewType	`ADMIN_USERS`
dataViewType	`GROUP_TASKS`
dataViewType	`CLIENT`
dataViewType	`LOAN_TRANSACTIONS_LOOKUP`
dataViewType	`LOANS`
dataViewType	`LOANS_REPAYMENTS_COLLECTION`
dataViewType	`CLIENT_TASKS`
dataViewType	`OVERDRAFTS_AGING_ANALYSIS`
dataViewType	`LOAN_ACCOUNT_FUNDING_OVERVIEW`
dataViewType	`SAVINGS`
dataViewType	`SAVINGS_OVERVIEW`
dataViewType	`JOURNAL_ENTRY`
dataViewType	`CLIENT_NOTIFICATION_MESSAGES`
loanConstraintsUsage	`UNCONSTRAINED_USAGE`
loanConstraintsUsage	`LIMITED_USAGE`
savingsConstraintsUsage	`UNCONSTRAINED_USAGE`
savingsConstraintsUsage	`LIMITED_USAGE`
currencySymbolPosition	`AFTER_NUMBER`
currencySymbolPosition	`BEFORE_NUMBER`
state	`REVERTED`
state	`DRAFT`
state	`APPROVED`
type	`IMPORT`
type	`EXPORT`
type	`INCOME`
type	`EXPENSE`
type	`LIABILITY`
type	`ASSET`
type	`EQUITY`
usage	`HEADER`
usage	`DETAIL`
financialResource	`FEE_RECEIVABLE`
financialResource	`OVERDRAFT_INTEREST_INCOME`
financialResource	`OVERDRAFT_INTEREST_RECEIVABLE`
financialResource	`FEE_INCOME`
financialResource	`INTEREST_PAYABLE`
financialResource	`INTEREST_EXPENSE`
financialResource	`PENALTY_RECEIVABLE`
financialResource	`INTEREST_INCOME`
financialResource	`DEFERRED_TAXES`
financialResource	`DEFERRED_FEE_INCOME`
financialResource	`PORTFOLIO_CONTROL`
financialResource	`DEFERRED_INTERESTS_INCOME`
financialResource	`OVERDRAFT_WRITE_OFF_EXPENSE`
financialResource	`PENALTY_INCOME`
financialResource	`OVERDRAFT_PORTFOLIO_CONTROL`
financialResource	`SAVINGS_CONTROL`
financialResource	`TAXES_RECEIVABLE`
financialResource	`INTEREST_RECEIVABLE`
financialResource	`INTER_BRANCH_TRANSFER`
financialResource	`FUND_SOURCE`
financialResource	`WRITE_OFF_EXPENSE`
financialResource	`DEPOSIT_REFERENCE`
financialResource	`TAXES_PAYABLE`
productType	`LOAN`
productType	`SAVINGS`
type	`TAX_RATE`
type	`INTEREST_RATE`
type	`WITHHOLDING_TAX_RATE`
type	`AMORTIZATION_ADJUSTMENT`
type	`AMORTIZATION_CORRECTION`
type	`AMORTIZATION`
frequency	`ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING`
frequency	`ACCOUNT_INSTALLMENTS_DUE_DATES`
frequency	`CUSTOM_INTERVAL`
intervalType	`FULL_TERM`
intervalType	`PREDEFINED_INTERVALS`
periodUnit	`MONTHS`
periodUnit	`YEARS`
periodUnit	`WEEKS`
periodUnit	`DAYS`
amortizationProfile	`STRAIGHT_LINE`
amortizationProfile	`SUM_OF_YEARS_DIGITS`
amortizationProfile	`EFFECTIVE_INTEREST_RATE`
amortizationProfile	`NONE`
amountCalculationMethod	`LOAN_AMOUNT_PERCENTAGE`
amountCalculationMethod	`LOAN_AMOUNT_PERCENTAGE_NUMBER_OF_INSTALLMENTS`
amountCalculationMethod	`REPAYMENT_PRINCIPAL_AMOUNT_PERCENTAGE`
amountCalculationMethod	`FLAT_NUMBER_OF_INSTALLMENTS`
amountCalculationMethod	`FLAT`
applyDateMethod	`MONTHLY_FROM_ACTIVATION`
applyDateMethod	`FIRST_OF_EVERY_MONTH`
feeAmortizationUponRescheduleOption	`CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT`
feeAmortizationUponRescheduleOption	`END_AMORTIZATION_ON_THE_ORIGINAL_ACCOUNT`
feeApplication	`OPTIONAL`
feeApplication	`REQUIRED`
trigger	`DISBURSEMENT`
trigger	`ARBITRARY`
trigger	`CAPITALIZED_DISBURSEMENT`
trigger	`MONTHLY_FEE`
trigger	`UPFRONT_DISBURSEMENT`
trigger	`LATE_REPAYMENT`
trigger	`MANUAL`
trigger	`PAYMENT_DUE`
trigger	`PAYMENT_DUE_APPLIED_ON_DUE_DATES`
type	`PENALTY_UNLOCKED`
type	`INTEREST_UNLOCKED`
type	`INTEREST_LOCKED`
type	`DISBURSMENT`
type	`INTEREST_APPLIED`
type	`DISBURSMENT_ADJUSTMENT`
type	`FEE`
type	`INTEREST_APPLIED_ADJUSTMENT`
type	`FEE_ADJUSTMENT`
type	`REPAYMENT_ADJUSTMENT`
type	`PENALTY_LOCKED`
type	`REPAYMENT`
type	`WRITE_OFF`
type	`FEE_CHARGED`
type	`PENALTY_APPLIED`
type	`PENALTY_ADJUSTMENT`
type	`INTEREST_RATE_CHANGED`

Create Loan Transaction

POST /loans/{loanAccountId}/transactions

Create Loan Transaction

Post transactions to the loan account. Transactions may affect the balance (such as a repayment or disbursal) or just the state of the account (such as approving it).

You can create transactions either by supplying data via query parameters or a JSON body.

Transaction Types

type

Type of the transaction. Required.

REPAYMENT - Make a repayment.
REPAYMENT_ADJUSTMENT - Reversing a transaction with the type REPAYMENT.
PAYMENT_MADE - Make a payment which will be stored at loan account level as a Redrawable balance.
PAYMENT_MADE_ADJUSTMENT - Reversing a transaction with the type PAYMENT_MADE.
DISBURSEMENT - Disburse the loan account.
DISBURSMENT_ADJUSTMENT - Undo the last disbursement.
Please Note: the parameter for the disbursement adjustment call is currently misspelt (i.e. DISBURSMENT_ADJUSTMENT instead of DISBURSEMENT_ADJUSTMENT.
This will be corrected in the near future and documentation updated accordingly.
APPROVAL - Change the account state to approve.
UNDO_APPROVAL - Undo the account state from approved to pending approval.
FEE - Apply fee.
FEE_ADJUSTMENT - Reversing a transaction with the type FEE.
INTEREST_APPLIED - Manually apply interest.
INTEREST_APPLIED_ADJUSTMENT - Reversing a transaction with the type INTEREST_APPLIED.
INTEREST_RATE_CHANGED - Apply an interest rate change transaction.
WITHDRAW - Change the account state to withdrawn.
UNDO_WITHDRAWN - Undo the account state from WITHDRAWN
REJECT - Change the account state to rejected.
UNDO_REJECT - Undo the account state from REJECTED
LOCK - Change the account state to locked.
UNLOCK - Unlock the account.
PENDING_APPROVAL - Transitioning the state of the account to Pending Approval.
PENALTY_ADJUSTMENT - Reversing a transaction with the type PENALTY_APPLIED.
WRITE_OFF - Writing off the loan.
WRITE_OFF_ADJUSTMENT - Undo the account state from CLOSED (Written-off) and reverse the write-off transaction
CLOSE - Close the loan account with all obligations met. Requires the account to have 0 principal balance and to be Active(or In Arrears) state.
UNDO_CLOSE - Undo the account state from CLOSE (all obligations met)

Example Requests

{
  "amount": 0,
  "bookingDate": "string",
  "currencyCode": "string",
  "customInformation": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "date": "string",
  "fees": [
    {
      "amount": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472"
    }
  ],
  "firstRepaymentDate": "string",
  "method": "string",
  "notes": "string",
  "originalTransactionId": "string",
  "rate": 0,
  "type": "string",
  "valueDate": "string"
}

Parameters

Name	Type	Description	In
type (required)	string	the type of transaction you wish to create	query
amount	string	The amount in the local currency of the transaction. Required for balance-changing transactions.	query
date	string	Deprecated - please use `valueDate`	query
valueDate	string	The date of the transaction - used for backdating transactions. Can have the following date formats: `yyyy-MM-dd` - date format, example: 2017-01-15; `yyyy-MM-dd'T'HH:mm:ss` - UTC date time format, example: 2017-01-15T00:01:59; yyyy-`MM-dd'T'HH:mm:ss'Z'` UTC with timezone, example: 2017-01-15T00:01:59+01:00. Please note that we do not support backdating TRANSFER transactions.	query
bookingDate	string	The date of the corresponding Journal Entry. Can have the same formats as date of the transaction. It is allowed for the following transactions types: `DISBURSEMENT`, `PAYMENT_MADE`, `PAYMENT_MADE_ADJUSTMENT`, `REPAYMENT`, `REPAYMENT_ADJUSTMENT`, `FEE`, `FEE_ADJUSTMENT`	query
repayment	string	The repayment number to use (when applying a fee to a repayment, for example).	query
firstRepaymentDate	string	Specifying the date of the first repayment for the loan account.	query
method	string	The transaction channel id/key of method use for the transaction. If none provided the default one will be used.	query
identifier	string	Unique optional identifier. There can't be more than one transaction (loan or savings) posted with the same identifier.	query
rate	string	The rate to set (It can be any rate: interest rate, penalty rate, interest spread, etc)	query
notes	string	Optional notes to record for this transaction.	query
originalTransactionId	string	The ID or encodedKey used for the original `PENALTY_APPLIED` transaction. Used when adjusting a penalty applied.	query
fees	string	The fees that should be applied with the disbursement transaction.Optional - if not specified the required fees from the product will be applied.	query
body	JSONTransactionRequestApiV1	none	body
loanAccountId (required)	string	The ID of the loan account. The format is determined by your organization.	path

Enumerated Values

Parameter	Value
type	`APPROVAL`
type	`CLOSE`
type	`DISBURSEMENT`
type	`DISBURSMENT_ADJUSTMENT`
type	`FEE`
type	`FEE_ADJUSTMENT`
type	`INTEREST_APPLIED`
type	`INTEREST_APPLIED_ADJUSTMENT`
type	`INTEREST_RATE_CHANGED`
type	`LOCK`
type	`PAYMENT_MADE`
type	`PAYMENT_MADE_ADJUSTMENT`
type	`PENALTY_ADJUSTMENT`
type	`PENDING_APPROVAL`
type	`REJECT`
type	`REPAYMENT`
type	`REPAYMENT_ADJUSTMENT`
type	`UNDO_APPROVAL`
type	`UNDO_CLOSE`
type	`UNDO_REJECT`
type	`UNDO_WITHDRAWN`
type	`UNLOCK`
type	`WITHDRAW`
type	`WRITE_OFF`
type	`WRITE_OFF_ADJUSTMENT`

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	None

Get Populated Document for a Loan Transaction

GET /loans/{loanAccountId}/transactions/{transactionId}/templates/{templateId}

Get Populated Document for a Loan Transaction

Allows you to get the raw HTML, as a string, of any document template associated with this loan transaction - with all placeholders populated.

You can get the ID for templates available for a loan product by calling the Loan Products API. The ID is returned as encoded key in the templates array. Supported templates for this operation will be of the type TRANSACTION.

Parameters

Name	Type	Description	In
loanAccountId (required)	string	The ID of the loan account. The format is determined by your organization.	path
transactionId (required)	string	The ID of the transaction.	path
templateId (required)	string	The ID of the template you want use to generate your Document.	path

Example Responses

200 : OK
Populated document

"Hi Terry Test Testington,<div><br /></div><div>just to confirm we have received and processed a payment of 12,000.00 € for your loan.</div><div><br /></div><div>You now have an outstanding balance of 88,004.17 €.</div><div><br /></div><div>Cheers,</div><div></div>"

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	string

Update custom field values (loan transaction)

PATCH /loans/{loanAccountId}/transactions/{transactionId}/custominformation

Update custom field values

Update custom field values.

Example Requests

Update a single custom field value

{
  "customInformation": [
    {
      "customFieldID": "custom_field_2",
      "value": "3"
    }
  ]
}

Update a field in a group

{
  "customInformation": [
    {
      "customFieldID": "cf_grouped_field",
      "value": "new value",
      "customFieldSetGroupIndex": "0"
    }
  ]
}

Update multiple custom field values

{
  "customInformation": [
    {
      "customFieldID": "cf_grouped_field_2",
      "value": "3",
      "customFieldSetGroupIndex": "0"
    },
    {
      "customFieldID": "marriage_status",
      "value": "divorced"
    }
  ]
}

Parameters

Name	Type	Description	In
customInformation	[object]	none	body
» customFieldID (required)	string	none	body
» value (required)	string	none	body
» customFieldSetGroupIndex	string	Required if field to update is part of a group, if the Field Set Group Index is not set, a new group will be created with the value provided.	body
loanAccountId (required)	string	The ID of the loan account. The format is determined by your organization.	path
transactionId (required)	undefined	The ID or encoded key of the transaction.	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Get custom info (loan transaction)

GET /loans/{loanAccountId}/transactions/{transactionId}/custominformation/{customFieldId}

Get a custom field definition for a Loan Account

Allows retrieving a custom field definition for a given Loan Account directly by the ID/key of the Loan Account and the ID/key of the custom field definition.

Parameters

Name	Type	Description	In
loanAccountId (required)	string	The ID of the loan account. The format is determined by your organization.	path
transactionId (required)	undefined	The ID or encoded key of the transaction.	path
customFieldId (required)	string	The ID of the custom field definition.	path

Example Responses

200 : OK
A custom field definition

[
  {
    "encodedKey": "8a19cd6f74674df9017467f25aab02c6",
    "parentKey": "8a193c26722b51b701722d779e7122de",
    "customFieldKey": "8a19cd6f74674df9017467ef8e6802af",
    "customField": {
      "encodedKey": "8a19cd6f74674df9017467ef8e6802af",
      "id": "cf_loanAccount",
      "creationDate": "2020-09-07T09:42:33+0000",
      "lastModifiedDate": "2020-09-07T09:42:33+0000",
      "name": "Example Custom Field Definition",
      "type": "BRANCH_INFO",
      "dataType": "CHECKBOX",
      "valueLength": "SHORT",
      "isDefault": false,
      "isRequired": false,
      "description": "an example of a checkbox custom field definition",
      "customFieldSet": {
        "encodedKey": "8a19cd6f74674df9017467ef8e6802ae",
        "id": "_example_loanAccount_custom_field_set",
        "name": "example Loan Account custom field set",
        "notes": "example custom field set",
        "createdDate": "2020-09-07T09:41:50+0000",
        "lastModifiedDate": "2020-09-07T09:41:50+0000",
        "indexInList": 2,
        "type": "BRANCH_INFO",
        "usage": "SINGLE"
      },
      "indexInList": 0,
      "state": "NORMAL",
      "customFieldSelectionOptions": [],
      "viewRights": {
        "encodedKey": "8a19cd6f74674df9017467ef8e6802b0",
        "isAccessibleByAllUsers": false,
        "roles": []
      },
      "editRights": {
        "encodedKey": "8a19cd6f74674df9017467ef8e6802b1",
        "isAccessibleByAllUsers": false,
        "roles": []
      },
      "unique": false,
      "values": [],
      "amounts": {}
    },
    "value": "TRUE",
    "indexInList": -1,
    "customFieldID": "cf_loanAccount",
    "customFieldSetGroupIndex": -1
  }
]

404 : Not Found
Not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	CustomFieldApiV1
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Update custom info (loan transaction)

PATCH /loans/{loanAccountId}/transactions/{transactionId}/custominformation/{customFieldId}

Update a custom field value for a Loan Account

Update a custom field value for a Loan Account.

Example Requests

{
  "value": "string"
}

Parameters

Name	Type	Description	In
value	string	none	body
loanAccountId (required)	string	The ID of the loan account. The format is determined by your organization.	path
transactionId (required)	undefined	The ID or encoded key of the transaction.	path
customFieldId (required)	string	The ID of the custom field definition.	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
Field is part of a group

{
  "returnCode": 916,
  "returnStatus": "INVALID_CUSTOM_FIELD_GROUP_INDEX",
  "errorSource": "cf_group_field_2"
}

404 : Not Found
Not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Delete custom info

DELETE /loans/{loanAccountId}/transactions/{transactionId}/custominformation/{customFieldId}

Delete a single custom field value.

Parameters

Name	Type	Description	In
loanAccountId (required)	string	The ID of the loan account. The format is determined by your organization.	path
transactionId (required)	undefined	The ID or encoded key of the transaction.	path
customFieldId (required)	string	The ID of the custom field definition.	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
Field is part of a group

{
  "returnCode": 916,
  "returnStatus": "INVALID_CUSTOM_FIELD_GROUP_INDEX",
  "errorSource": "cf_group_field_2"
}

404 : Not Found
Not Found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Update grouped custom field value

PATCH /loans/{loanAccountId}/transactions/{transactionId}/custominformation/{customFieldId}/{customFieldGroupSetIndex}

Update grouped custom field value

Update custom field value, which is part of a group.

Example Requests

{
  "value": "string"
}

Parameters

Name	Type	Description	In
value	string	none	body
loanAccountId (required)	string	The ID of the loan account. The format is determined by your organization.	path
transactionId (required)	undefined	The ID or encoded key of the transaction.	path
customFieldId (required)	string	The ID of the custom field definition.	path
customFieldGroupSetIndex (required)	string	none	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
Wrong group index provided

{
  "returnCode": 916,
  "returnStatus": "INVALID_CUSTOM_FIELD_GROUP_INDEX",
  "errorSource": "cf_group_field_2"
}

404 : Not Found
Field not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Delete grouped custom field value (loan transaction)

DELETE /loans/{loanAccountId}/transactions/{transactionId}/custominformation/{customFieldId}/{customFieldGroupSetIndex}

Delete grouped custom field value

Delete a custom field value, which is part of a group.

Parameters

Name	Type	Description	In
loanAccountId (required)	string	The ID of the loan account. The format is determined by your organization.	path
transactionId (required)	undefined	The ID or encoded key of the transaction.	path
customFieldId (required)	string	The ID of the custom field definition.	path
customFieldGroupSetIndex (required)	string	none	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Notifications

Allows you to get the communications history via API and re-send failed notification messages via API.

Resend Notifications

POST /notifications/messages

Resend Notifications

Re-send failed notification messages of any type (SMS/Email/WebHook) for the specified notification message encoded keys. It allows posting one notification or bulk notifications in the same API call.

Please Note The user requires the Resend Failed Messages permission in order to send the failed notifications.

Example Requests

resend a set of notifications

{
  "action": "resend",
  "identifiers": [
    "8a80808a5317de22015317de5b94034c",
    "8a80806852f38c860152f38de0ad0019",
    "8a80806852f38c860152f38de0ad0023"
  ]
}

Parameters

Name	Type	Description	In
action (required)	string	The action type of this API call. Its value should be `resend`.	body
identifiers (required)	[string]	By this parameter you can specify an array of one or more encoded keys to re-send of failed notification messages. Duplicated encoded keys are not allowed.	body

Enumerated Values

Parameter	Value
action	`resend`

Example Responses

200 : OK
Success Response

{
  "returnCode": 200,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
notifications not found

{
  "returnCode": 2607,
  "returnStatus": "NO_MESSAGE_FOUND",
  "errorSource": "No matching messages were found in the database"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Enumerated Values

Property	Value
returnCode	`200`
returnStatus	`SUCCESS`

Status Code 400

Name	Type	Description	Restrictions
» returnCode	number	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Search Notifications

POST /notifications/messages/search

Search Notifications

Get the communications history by the specified filter.

Please Note The waiting reason will be displayed only for notifications that have the WAITING status. The possible values for the WAITING_REASON parameter are: READY_TO_BE_SENT, WAIT_FOR_CLOSE_CIRCUIT, or SENDING.

Example Requests

{
  "filterConstraints": [
    {
      "dataFieldType": "string",
      "dataItemType": "string",
      "filterElement": "string",
      "filterSelection": "string",
      "secondValue": "string",
      "value": "string"
    }
  ]
}

Parameters

Name	Type	Description	In
filterConstraints	[filters]	[A filter based on an element of a notification, an operator, and a value.	body
» filters	filters	A filter based on an element of a notification, an operator, and a value.	body
»» dataFieldType	string	`NATIVE`(default)/`CUSTOM` for custom field searches	body
»» dataItemType	string	The entity where the field on which to apply the constraint is located. If the field is located in the same entity with the entity being searched, this field is optional.	body
»» filterElement	string	The constraint operator. Available filter elements can be found above.	body
»» filterSelection	string	The field on which the constraint will be applied. For custom fields, the custom field definition encoded key must be provided.	body
»» secondValue	string	The constraint second value. Required for filter elements with two values.	body
»» value	string	The constraint value. Required for filter elements with one or two values.	body

Detailed descriptions

filterConstraints: [A filter based on an element of a notification, an operator, and a value.

Filterable Elements

Filter Selection Parameter	Data Type
SENDER_KEY	KEY
RECIPIENT_CLIENT_KEY	KEY
RECIPIENT_GROUP_KEY	KEY
RECIPIENT_USER_KEY	KEY
ENCODED_KEY	KEY
CREATION_DATE	DATE_UTC
SENT_DATE	DATE_UTC
STATE	ENUM
FAILURE_REASON	ENUM
DESTINATION	STRING
TYPE	ENUM
EVENT	ENUM
WAITING_REASON	ENUM

@(Info)(Please Note)(The waiting reason will be displayed only for notifications that have the WAITING status. The possible values for the WAITING_REASON parameter are: READY_TO_BE_SENT, WAIT_FOR_CLOSE_CIRCUIT, or SENDING. )

Filter Operators

Filter Element	Number Of affected values	Available for
EQUALS	ONE_VALUE	BIG_DECIMAL,BOOLEAN,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY
MORE_THAN	ONE_VALUE	BIG_DECIMAL,NUMBER,MONEY
LESS_THAN	ONE_VALUE	BIG_DECIMAL,NUMBER,MONEY
BETWEEN	TWO_VALUES	BIG_DECIMAL,NUMBER,MONEY,DATE,DATE_UTC
ON	ONE_VALUE	DATE,DATE_UTC
AFTER	ONE_VALUE	DATE,DATE_UTC
BEFORE	ONE_VALUE	DATE,DATE_UTC
STARTS_WITH	ONE_VALUE	STRING
IN	LIST	ENUM,KEY
TODAY	NO_VALUE	DATE,DATE_UTC
THIS_WEEK	NO_VALUE	DATE,DATE_UTC
THIS_MONTH	NO_VALUE	DATE,DATE_UTC
THIS_YEAR	NO_VALUE	DATE,DATE_UTC
LAST_DAYS	ONE_VALUE	DATE,DATE_UTC
EMPTY	NO_VALUE	BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_UTC
NOT_EMPTY	NO_VALUE	BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_UTC

]

» filters: A filter based on an element of a notification, an operator, and a value.

Filterable Elements

Filter Selection Parameter	Data Type
SENDER_KEY	KEY
RECIPIENT_CLIENT_KEY	KEY
RECIPIENT_GROUP_KEY	KEY
RECIPIENT_USER_KEY	KEY
ENCODED_KEY	KEY
CREATION_DATE	DATE_UTC
SENT_DATE	DATE_UTC
STATE	ENUM
FAILURE_REASON	ENUM
DESTINATION	STRING
TYPE	ENUM
EVENT	ENUM
WAITING_REASON	ENUM

Filter Operators

Filter Element	Number Of affected values	Available for
EQUALS	ONE_VALUE	BIG_DECIMAL,BOOLEAN,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY
MORE_THAN	ONE_VALUE	BIG_DECIMAL,NUMBER,MONEY
LESS_THAN	ONE_VALUE	BIG_DECIMAL,NUMBER,MONEY
BETWEEN	TWO_VALUES	BIG_DECIMAL,NUMBER,MONEY,DATE,DATE_UTC
ON	ONE_VALUE	DATE,DATE_UTC
AFTER	ONE_VALUE	DATE,DATE_UTC
BEFORE	ONE_VALUE	DATE,DATE_UTC
STARTS_WITH	ONE_VALUE	STRING
IN	LIST	ENUM,KEY
TODAY	NO_VALUE	DATE,DATE_UTC
THIS_WEEK	NO_VALUE	DATE,DATE_UTC
THIS_MONTH	NO_VALUE	DATE,DATE_UTC
THIS_YEAR	NO_VALUE	DATE,DATE_UTC
LAST_DAYS	ONE_VALUE	DATE,DATE_UTC
EMPTY	NO_VALUE	BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_UTC
NOT_EMPTY	NO_VALUE	BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_UTC

Example Responses

200 : OK
an array of notifications

[
  {
    "encodedKey": "8a0991f14de54ed1014de768d4a40c18",
    "creationDate": "2015-06-12T10:55:16+0000",
    "sendDate": "2015-06-12T10:55:17+0000",
    "type": "WEB_HOOK",
    "state": "SENT",
    "destination": "http://requestbin.com/r0sdq1r0",
    "event": "LOAN_CREATED",
    "body": "Demo body content"
  },
  {
    "encodedKey": "8a09babc4d9d34b9014d9f35a9580530",
    "creationDate": "2015-05-29T10:26:43+0000",
    "sendDate": "2015-05-29T10:26:44+0000",
    "type": "WEB_HOOK",
    "state": "SENT",
    "destination": "https://example.com/webhook",
    "event": "LOAN_CREATED",
    "body": "Demo body content"
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[notification]	[A notification object.]	none
» notification	notification	A notification object.	none
»» body	string	the actual content of the notification	none
»» clientKey	string	the encoded key of the client for whom the notification was intended	none
»» creationDate	string(date-time)	the date and time when this notification was created	none
»» destination	string	the target of the notification. for webhooks this will contain the destination endpoint URL, for emails, the email address of the recipient	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» event	string	the event which triggered the notification, eg. `CLIENT_CREATED`, only for automated notifications	none
»» failureCause	string	if the message failed to send this will contain the http response code and message body, formatted as a JSON encoded string, received by the system.	none
»» failureReason	string	in cases of failure, this field will contain a reason derived from the http response, eg `INVALID_HTTP_RESPONSE`	none
»» numRetries	integer	the count of retries if the notifaction failed to be sent	none
»» sendDate	string(date-time)	the timestamp of when the notification was sent	none
»» state	string	indicates the status of the notification	none
»» templateKey	string	the encoded key of the template which was used to construct this notification	none
»» type	string	indicates which messaging channel was used for the notification, eg. `EMAIL`, `SMS`	none

Enumerated Values

Property	Value
state	`SENT`
state	`QUEUED`
state	`QUEUED_FOR_STREAM`
state	`SENDING_ASYNC`
state	`FAILED`
type	`EMAIL`
type	`SMS`
type	`WEB_HOOK`
type	`EVENT_STREAM`
type	`TASK`

Object Search

Search for different objects based on keywords.

The following fields will be searched for each object type:

Object type	Keyword fields
`CLIENT`	first name, middle name, last name, id
`GROUP`	group name, id
`LOAN_ACCOUNT`	account id
`SAVINGS_ACCOUNT`	account id
`USER`	first name, last name, username
`BRANCH`	branch name, branch id
`CENTRE`	centre name, centre id

Search for Objects

GET /search

Search for Objects

Search for different object types using keywords. The search can also include an optional list of object types to search for using a 'type' parameter. If there are no results for a given type of entity, an empty array will be returned.

Example Requests

Search for clients or users called John, return the first 10 results

GET /api/search?query=john&type=[CLIENT,USER]&limit=10

Parameters

Name	Type	Description	In
query (required)	string	The keyword to search for.	query
type	array[string]	Type of object to search for. The search can contain multiple types as a list, eg, [CLIENT,USER]. Available types; `CLIENT`, `GROUP`, `LOAN_ACCOUNT`, `SAVINGS_ACCOUNT`, `USER`, `BRANCH`, `CENTRE`.	query
limit	integer	max number of results to return.	query

Enumerated Values

Parameter	Value
type	`CLIENT`
type	`GROUP`
type	`LOAN_ACCOUNT`
type	`SAVINGS_ACCOUNT`
type	`USER`
type	`BRANCH`
type	`CENTRE`

Example Responses

200 : OK
an array of search results

{
  "CLIENT": [
    {
      "selectionType": "CLIENT",
      "displayString": "John Demo",
      "resultID": "517706810",
      "resultKey": "8a42711a4428c1f101442a1bbcbc0009"
    },
    {
      "selectionType": "CLIENT",
      "displayString": "John Master",
      "resultID": "603117506",
      "resultKey": "8a42711a4428c1f101442a1ee710001b"
    }
  ],
  "CREDIT_OFFICER": [
    {
      "selectionType": "CREDIT_OFFICER",
      "displayString": "johnty billingsworth",
      "resultID": "johntybilling",
      "resultKey": "8a19dab474909bc8017490f2fb9006a8"
    }
  ],
  "USER": [
    {
      "selectionType": "USER",
      "displayString": "John Doe",
      "resultID": "61",
      "resultKey": "8a54e5b44449337f01444b03efa3000e"
    }
  ],
  "SAVINGS_ACCOUNT": [],
  "CUSTOM_FIELD_SELECTION": [],
  "CENTRE": [],
  "FILTER_CUSTOM_FIELD_SELECTION": [],
  "BRANCH": [],
  "LOAN_ACCOUNT": [],
  "GROUP": [],
  "LINE_OF_CREDIT": []
}

200 : OK
response

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» {type}	[search-result]	none	none
»» search-result	search-result	none	none
»»» displayString	string	none	none
»»» resultID	string	none	none
»»» resultKey	string	none	none
»»» selectionType	string	none	none

Repayments

Allows you to retrieve all outstanding repayments (based on transactions logged).

Get all Repayments

GET /repayments

Get all Repayments

Retrieves repayment schedules.

Repayment states

PAID	The repayment has been paid – not returned by this endpoint.
PARTIALLY_PAID	The repayment was only paid partially.
PENDING	The repayment has not been paid yet (future repayments).
LATE	The repayment has not been paid and its due date has already passed.
GRACE	This repayment is part of a grace period.
RESCHEDULED	The repayment balances have been rescheduled into other repayments.

Parameters

dueFrom	Starting due date to filter repayments on (YYYY-MM-DD)
dueTo	End due date to filter repayment on (YYYY-MM-DD)

Parameters

Name	Type	Description	In
offset	integer	Start at index X. Use with limit parameter to achieve paging.	query
dueTo	DateTime	End due date to filter repayment on (YYYY-MM-DD)	query
dueFrom	DateTime	Starting due date to filter repayments on (YYYY-MM-DD)	query
limit	integer	Max number of records to return	query

Example Responses

200 Response

[
  {
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "customSettings": [
      {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "loanTransactionKey": "string",
        "source": "CENTRE_MEETING_DAY_CHANGED",
        "type": "CUSTOM_ADDED_INSTALLMENT"
      }
    ],
    "dueDate": "string",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "feesAppliedDue": 0,
    "feesDue": 0,
    "feesPaid": 0,
    "feesUnappliedDue": 0,
    "fundersInterestDue": 0,
    "index": 0,
    "interestDue": 0,
    "interestPaid": 0,
    "lastPaidDate": "string",
    "lastPenaltyAppliedDate": "string",
    "notes": "string",
    "organizationCommissionDue": 0,
    "parentAccountKey": "string",
    "penaltyDue": 0,
    "penaltyPaid": 0,
    "principalDue": 0,
    "principalPaid": 0,
    "repaidDate": "string",
    "repaymentUnappliedFeeDetails": [
      {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "feeDue": 0,
        "indexInList": 0,
        "predefinedFeeKey": "string",
        "repaymentKey": "string",
        "taxOnFeeDue": 0
      }
    ],
    "state": "PARTIALLY_PAID",
    "taxFeesDue": 0,
    "taxFeesPaid": 0,
    "taxInterestDue": 0,
    "taxInterestPaid": 0,
    "taxPenaltyDue": 0,
    "taxPenaltyPaid": 0
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[RepaymentApiV1]	none	none
» assignedBranchKey	string	none	none
» assignedCentreKey	string	none	none
» assignedUserKey	string	none	none
» customSettings	[CustomRepaymentSettingsApiV1]	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» loanTransactionKey	string	the encoded key of the transaction that used these custom settings	none
»» source	string	the reason for these custom settings being created	none
»» type	string	the settings which were customised	none
» dueDate	string	none	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» feesAppliedDue	number	none	none
» feesDue	number	none	none
» feesPaid	number	none	none
» feesUnappliedDue	number	none	none
» fundersInterestDue	number	none	none
» index	number	none	none
» interestDue	number	none	none
» interestPaid	number	none	none
» lastPaidDate	string	none	none
» lastPenaltyAppliedDate	string	none	none
» notes	string	none	none
» organizationCommissionDue	number	none	none
» parentAccountKey	string	none	none
» penaltyDue	number	none	none
» penaltyPaid	number	none	none
» principalDue	number	none	none
» principalPaid	number	none	none
» repaidDate	string	none	none
» repaymentUnappliedFeeDetails	[RepaymentUnappliedFeeDetailsApiV1]	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» feeDue	number	none	none
»» indexInList	number	none	none
»» predefinedFeeKey	string	none	none
»» repaymentKey	string	none	none
»» taxOnFeeDue	number	none	none
» state	string	none	none
» taxFeesDue	number	none	none
» taxFeesPaid	number	none	none
» taxInterestDue	number	none	none
» taxInterestPaid	number	none	none
» taxPenaltyDue	number	none	none
» taxPenaltyPaid	number	none	none

Enumerated Values

Property	Value
source	`CENTRE_MEETING_DAY_CHANGED`
source	`INTEREST_APPLIED`
source	`INSTALLMENT_GRACED_NON_NATIVELY`
source	`INSTALLMENT_PAID`
source	`USER_INPUT`
type	`CUSTOM_ADDED_INSTALLMENT`
type	`CUSTOM_PRINCIPAL`
type	`CUSTOM_DUE_DATE`
state	`PARTIALLY_PAID`
state	`LATE`
state	`GRACE`
state	`PAID`
state	`PENDING`

Savings Accounts

Allows you to retrieve and update savings (deposit) accounts for clients or groups.

Get all Savings Accounts

GET /savings

Get all savings accounts

Parameters

Name	Type	Description	In
accountState	string	none	query
centreID	string	none	query
branchID	string	none	query
offset	integer	none	query
limit	integer	none	query
fullDetails	boolean	none	query
creditOfficerUsername	string	none	query

Enumerated Values

Parameter	Value
accountState	`WITHDRAWN`
accountState	`PARTIALLY_DISBURSED`
accountState	`LOCKED`
accountState	`ACTIVE`
accountState	`CLOSED`
accountState	`PARTIAL_APPLICATION`
accountState	`LOCKED_CAPPING`
accountState	`CLOSED_REJECTED`
accountState	`RESCHEDULED`
accountState	`ACTIVE_IN_ARREARS`
accountState	`MATURED`
accountState	`CLOSED_RESCHEDULED`
accountState	`CLOSED_WITHDRAWN`
accountState	`PENDING_APPROVAL`
accountState	`APPROVED`
accountState	`REFINANCED`
accountState	`DORMANT`
accountState	`CLOSED_WRITTEN_OFF`

Example Responses

200 Response

[
  {
    "accountHolderKey": "string",
    "accountHolderType": "GROUP",
    "accountState": "WITHDRAWN",
    "accountType": "CURRENT_ACCOUNT",
    "accruedInterest": 0,
    "activationDate": "string",
    "allowOverdraft": true,
    "approvedDate": "string",
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "availableBalance": 0,
    "balance": 0,
    "closedDate": "string",
    "creationDate": "string",
    "currency": {
      "code": "string",
      "creationDate": "string",
      "currencySymbolPosition": "AFTER_NUMBER",
      "digitsAfterDecimal": 0,
      "isBaseCurrency": true,
      "lastModifiedDate": "string",
      "name": "string",
      "symbol": "string"
    },
    "currencyCode": "string",
    "customFieldValues": [
      {
        "amount": 0,
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "customFieldID": "string",
        "customFieldKey": "string",
        "customFieldSetGroupIndex": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexInList": 0,
        "linkedEntityKeyValue": "string",
        "parentKey": "string",
        "selectionKey": "string",
        "value": "string"
      }
    ],
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "feesDue": 0,
    "holdBalance": 0,
    "id": "string",
    "interestDue": 0,
    "interestPaymentDates": [
      {
        "dayOfMonth": 0,
        "monthOfYear": 0,
        "year": 0
      }
    ],
    "interestPaymentPoint": "EVERY_WEEK",
    "interestSettings": {
      "accrueInterestAfterMaturity": true,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestChargeFrequencyCount": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "TIERED_PERIOD",
      "interestRateTiers": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingBalance": 0,
          "endingDay": 0,
          "index": 0,
          "interestRate": 0
        }
      ],
      "interestSpread": 0
    },
    "lastAccountAppraisalDate": "string",
    "lastInterestCalculationDate": "string",
    "lastInterestStoredDate": "string",
    "lastModifiedDate": "string",
    "lastOverdraftInterestReviewDate": "string",
    "lastSetToArrearsDate": "string",
    "lineOfCreditKey": "string",
    "lockedBalance": 0,
    "lockedDate": "string",
    "maturityDate": "string",
    "maxWidthdrawlAmount": 0,
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "name": "string",
    "notes": "string",
    "overdraftAmount": 0,
    "overdraftExpiryDate": "string",
    "overdraftExpiryDateDTO": {
      "dayOfMonth": 0,
      "monthOfYear": 0,
      "year": 0
    },
    "overdraftInterestAccrued": 0,
    "overdraftInterestSettings": {
      "accrueInterestAfterMaturity": true,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestChargeFrequencyCount": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "TIERED_PERIOD",
      "interestRateTiers": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingBalance": 0,
          "endingDay": 0,
          "index": 0,
          "interestRate": 0
        }
      ],
      "interestSpread": 0
    },
    "overdraftLimit": 0,
    "productTypeKey": "string",
    "recommendedDepositAmount": 0,
    "targetAmount": 0,
    "technicalInterestDue": 0,
    "technicalOverdraftAmount": 0,
    "technicalOverdraftInterestAccrued": 0,
    "withholdingTaxSourceKey": "string"
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[SavingsAccountApiV1]	none	none
» accountHolderKey	string	none	none
» accountHolderType	string	none	none
» accountState	string	none	none
» accountType	string	none	none
» accruedInterest	number	none	none
» activationDate	string	none	none
» allowOverdraft	boolean	none	none
» approvedDate	string	none	none
» assignedBranchKey	string	none	none
» assignedCentreKey	string	none	none
» assignedUserKey	string	none	none
» availableBalance	number	none	none
» balance	number	none	none
» closedDate	string	none	none
» creationDate	string	the date and time when this savings account was created	none
» currency	CurrencyApiV1	none	none
»» code	string	the three letter ISO code for this currency	none
»» creationDate	string	the date on which this currency was created	none
»» currencySymbolPosition	string	indicates where the currency symbol should appear in relation to the numeric value	none
»» digitsAfterDecimal	number	indicates how many decimal places are allowed for this currency. For example, a currenncy with 100 minor units to 1 major unit, there will be 2 decimal places.	none
»» isBaseCurrency	boolean	whether this currency is the base currency for your banking institution	none
»» lastModifiedDate	string	the date on which this currency was last modified	none
»» name	string	the name of this currency	none
»» symbol	string	the currency symnbol used for this currency	none
» currencyCode	string	none	none
» customFieldValues	[CustomFieldValueApiV1]	none	none
»» amount	number	none	none
»» customField	CustomFieldApiV1	none	none
»»» amounts	object	used when options available for a custom field definition translate to predefined amounts, for example, when the custom field value is used to generate a score	none
»»»» additionalProperties	number	none	none
»»» builtInCustomFieldId	string	if this field is one of the built in custom fiel definitions, this will have a value. These names are reserved and you can not use them for your own custom field definitions	none
»»» creationDate	string	the date on which this custom field definition was created	none
»»» customFieldProductSettings	[CustomFieldLinkApiV1]	none	none
»»»» customFieldEncodedKey	string	the key to the parent custom field definition	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isDefault	boolean	whether this field is displayed by default when creating a new record	none
»»»» isRequired	boolean	whether this field is required when creating a new record	none
»»»» linkType	string	the type of entity this field represents a link to	none
»»»» productKey	string	when the link type is product, this field should contain the encoded key of the linekd product	none
»»» customFieldSelectionOptions	[CustomFieldSelectionApiV1]	[represents a possible selection for select type custom field definitions]	none
»»»» constraint	CustomFilterConstraintApiV1	none	none
»»»»» customFieldKey	string	none	none
»»»»» dataFieldType	string	none	none
»»»»» dataFieldValue	string	none	none
»»»»» dataItemType	string	none	none
»»»»» dataType	string	none	none
»»»»» encodedKey	string	none	none
»»»»» filterElement	string	none	none
»»»»» groupNumber	number	none	none
»»»»» index	number	none	none
»»»»» linkingOperator	string	none	none
»»»»» secondValue	string	none	none
»»»»» value	string	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this selectable item	none
»»»» score	number	the score assigned to this selection	none
»»»» value	string	display name of this option	none
»»» customFieldSet	CustomFieldSetApiV1	none	none
»»»» builtInType	string	if this set is part of the set of built-in custom field sets, its type will be shown here	none
»»»» createdDate	string	the date and time when this custom field set was created	none
»»»» customFields	[CustomFieldApiV1]	an array of custom field definitions included in this custom field set	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this custom field set	none
»»»» indexInList	number	for field sets that can be added to an entity more than once, this number represents the index in the list and is used when changing values	none
»»»» lastModifiedDate	string	the date on which this custom field set was last modified	none
»»»» name	string	the name of this custom field set	none
»»»» notes	string	any notes regarding this custom field set	none
»»»» type	string	the entity type that this custom field definition is attached to	none
»»»» usage	string	whether this custom field set can only be used once, or added multiple times to the same entity	none
»»» dataType	string	the type of custom field definition	none
»»» description	string	a brief description of this custom field definition	none
»»» editRights	UsageRightsApiV1	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isAccessibleByAllUsers	boolean	none	none
»»»» roles	[string]	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» id	string	the ID for this custom field definition	none
»»» indexInList	number	none	none
»»» isDefault	boolean	whether this field will be included by default on new records	none
»»» isRequired	boolean	whether this field is required when creating a new record	none
»»» lastModifiedDate	string	the date on which this custom field definition was last modified	none
»»» name	string	the name of this custom field definition	none
»»» state	string	whether this field is available for use or has been deactivated	none
»»» type	string	the type of data this custom field definition will contain	none
»»» unique	boolean	whether the data in this custom field definition needs to be a unique value	none
»»» validationPattern	string	a user-provided pattern to which data in this custom field definition must conform where @ represents numbers, # represents letters and $ is either a number or letter. Other special characters used as separators are allowed, for example `@@-##-$$$`	none
»»» valueLength	string	whether this field needs to support a large number of characters	none
»»» values	[string]	a list of possible values when the field is a selection field	none
»»» viewRights	UsageRightsApiV1	none	none
»» customFieldID	string	none	none
»» customFieldKey	string	none	none
»» customFieldSetGroupIndex	number	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» indexInList	number	none	none
»» linkedEntityKeyValue	string	none	none
»» parentKey	string	none	none
»» selectionKey	string	none	none
»» value	string	none	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» feesDue	number	none	none
» holdBalance	number	none	none
» id	string	none	none
» interestDue	number	none	none
» interestPaymentDates	[DateDTOApiV1]	none	none
»» dayOfMonth	number	the day of the month	none
»» monthOfYear	number	the month	none
»» year	number	the year	none
» interestPaymentPoint	string	none	none
» interestSettings	InterestAccountSettingsApiV1	none	none
»» accrueInterestAfterMaturity	boolean	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» interestChargeFrequency	string	none	none
»» interestChargeFrequencyCount	number	none	none
»» interestRate	number	none	none
»» interestRateReviewCount	number	none	none
»» interestRateReviewUnit	string	none	none
»» interestRateSource	string	none	none
»» interestRateTerms	string	none	none
»» interestRateTiers	[InterestRateTierApiV1]	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» endingBalance	number	none	none
»»» endingDay	number	none	none
»»» index	number	none	none
»»» interestRate	number	none	none
»» interestSpread	number	none	none
» lastAccountAppraisalDate	string	none	none
» lastInterestCalculationDate	string	none	none
» lastInterestStoredDate	string	none	none
» lastModifiedDate	string	the date on which this savings account was last modified	none
» lastOverdraftInterestReviewDate	string	none	none
» lastSetToArrearsDate	string	none	none
» lineOfCreditKey	string	none	none
» lockedBalance	number	none	none
» lockedDate	string	none	none
» maturityDate	string	none	none
» maxWidthdrawlAmount	number	none	none
» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
»» creationDate	string(date-time)	the date on which the data import was made	none
»» encodedKey	string	the encoded key of this data migration event	none
»» numCentresImported	number	the number of centres which were imported during the data migration	none
»» numClientsImported	number	the number of clients which were imported as part of the data migration	none
»» numGLAccountsImported	number	the number of general ledger accounts which were imported as part of the data migration	none
»» numGroupsImported	number	the number of groups which were imported as part of the data migration	none
»» numLoanRepaymentsImported	number	the number of loan repayment transations which were imported as part of the data migration	none
»» numLoanTransactionsImported	number	the number of loan transactions which were imported as part of the data migration	none
»» numLoansImported	number	the number of loan accounts which were imported as part of the data migration	none
»» numSavingsImported	number	the number of savings accounts which were imported as part of the data migration	none
»» state	string	whether the data import was accepted, is still in a draft state, or was rejected and all data reverted	none
»» type	string	the type of migration event	none
» name	string	none	none
» notes	string	none	none
» overdraftAmount	number	none	none
» overdraftExpiryDate	string	none	none
» overdraftExpiryDateDTO	DateDTOApiV1	none	none
» overdraftInterestAccrued	number	none	none
» overdraftInterestSettings	InterestAccountSettingsApiV1	none	none
» overdraftLimit	number	none	none
» productTypeKey	string	none	none
» recommendedDepositAmount	number	none	none
» targetAmount	number	none	none
» technicalInterestDue	number	none	none
» technicalOverdraftAmount	number	none	none
» technicalOverdraftInterestAccrued	number	none	none
» withholdingTaxSourceKey	string	none	none

Enumerated Values

Property	Value
accountHolderType	`GROUP`
accountHolderType	`CLIENT`
accountState	`WITHDRAWN`
accountState	`PARTIALLY_DISBURSED`
accountState	`LOCKED`
accountState	`ACTIVE`
accountState	`CLOSED`
accountState	`PARTIAL_APPLICATION`
accountState	`LOCKED_CAPPING`
accountState	`CLOSED_REJECTED`
accountState	`RESCHEDULED`
accountState	`ACTIVE_IN_ARREARS`
accountState	`MATURED`
accountState	`CLOSED_RESCHEDULED`
accountState	`CLOSED_WITHDRAWN`
accountState	`PENDING_APPROVAL`
accountState	`APPROVED`
accountState	`REFINANCED`
accountState	`DORMANT`
accountState	`CLOSED_WRITTEN_OFF`
accountType	`CURRENT_ACCOUNT`
accountType	`REGULAR_SAVINGS`
accountType	`FIXED_DEPOSIT`
accountType	`INVESTOR_ACCOUNT`
accountType	`SAVINGS_PLAN`
currencySymbolPosition	`AFTER_NUMBER`
currencySymbolPosition	`BEFORE_NUMBER`
builtInCustomFieldId	`MOBILE_PHONE`
builtInCustomFieldId	`EMAIL_ADDRESS`
builtInCustomFieldId	`GENDER`
builtInCustomFieldId	`MIDDLE_NAME`
builtInCustomFieldId	`HOME_PHONE`
builtInCustomFieldId	`BIRTHDATE`
builtInCustomFieldId	`LAST_NAME`
builtInCustomFieldId	`FIRST_NAME`
linkType	`CLIENT_ROLE`
linkType	`CHANNEL`
linkType	`PRODUCT`
dataFieldType	`NATIVE`
dataFieldType	`CUSTOM`
dataItemType	`WRITTEN_OFF_LOANS`
dataItemType	`LINE_OF_CREDIT`
dataItemType	`INVESTOR_FUND`
dataItemType	`TRANSACTION_DETAILS`
dataItemType	`DOCUMENT_TEMPLATE`
dataItemType	`PRODUCT`
dataItemType	`MCC_EXPIRATION`
dataItemType	`CENTRE`
dataItemType	`REPAYMENT_COLLECTION`
dataItemType	`TASK`
dataItemType	`OUTSTANDING_PORTFOLIO_AMOUNTS`
dataItemType	`REVENUE`
dataItemType	`COMPOSED_TRANSACTIONS`
dataItemType	`UNION_TRANSACTIONS`
dataItemType	`PRINCIPAL_PAYMENT_SETTINGS`
dataItemType	`LOANS`
dataItemType	`DISBURSEMENT_DETAILS`
dataItemType	`SAVINGS_TRANSACTION`
dataItemType	`IDENTIFICATION_DOCUMENT`
dataItemType	`LOAN_PRODUCT`
dataItemType	`DISBURSED_LOANS`
dataItemType	`LOAN_GROUP`
dataItemType	`TRANSACTION_CHANNEL`
dataItemType	`CUSTOM_PREDEFINED_FEE`
dataItemType	`JOURNAL_ENTRY`
dataItemType	`ATTACHMENT`
dataItemType	`PREDEFINED_FEE`
dataItemType	`TRANCHE`
dataItemType	`TRANSACTION`
dataItemType	`INDEX_RATE_SOURCE`
dataItemType	`GROUP_ROLE`
dataItemType	`LOAN_TRANSACTION`
dataItemType	`CLIENT_ROLE`
dataItemType	`GROUP`
dataItemType	`NOTIFICATION_MESSAGE`
dataItemType	`OUTSTANDING_PORTFOLIO_ACCOUNTS`
dataItemType	`REPAYMENT`
dataItemType	`LOAN_ACCOUNT_GUARANTY`
dataItemType	`BRANCH`
dataItemType	`CURRENCY`
dataItemType	`CARD_TRANSACTION_REVERSAL`
dataItemType	`INTEREST_PRODUCT_SETTINGS`
dataItemType	`CREATED_ACCOUNTS`
dataItemType	`USER`
dataItemType	`SAVINGS_PRODUCT`
dataItemType	`CLIENT`
dataItemType	`PRODUCT_ARREARS_SETTINGS`
dataItemType	`SAVINGS`
dataItemType	`EXPENSE`
dataItemType	`INDEX_RATE`
dataItemType	`NOTIFICATION_TEMPLATE`
dataItemType	`CUSTOM_FIELD_SELECTION`
dataItemType	`ACTIVITY`
dataType	`ENUM`
dataType	`MONEY`
dataType	`NUMBER`
dataType	`DATE_UTC`
dataType	`JAVA_BLOB`
dataType	`OBJECT`
dataType	`BOOLEAN`
dataType	`DATE`
dataType	`PERCENT`
dataType	`BIG_DECIMAL`
dataType	`STRING`
dataType	`KEY`
dataType	`LONG`
filterElement	`STARTS_WITH_CASE_SENSITIVE`
filterElement	`THIS_WEEK`
filterElement	`EQUALS`
filterElement	`STARTS_WITH`
filterElement	`IN`
filterElement	`TODAY`
filterElement	`THIS_YEAR`
filterElement	`BETWEEN`
filterElement	`AFTER`
filterElement	`LESS_THAN`
filterElement	`DIFFERENT_THAN`
filterElement	`THIS_MONTH`
filterElement	`NOT_EMPTY`
filterElement	`BEFORE`
filterElement	`EQUALS_CASE_SENSITIVE`
filterElement	`LAST_DAYS`
filterElement	`MORE_THAN`
filterElement	`EMPTY`
filterElement	`ON`
linkingOperator	`OR`
linkingOperator	`AND`
builtInType	`DETAILS`
builtInType	`GENERAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
usage	`SINGLE`
usage	`GROUPED`
dataType	`GROUP_LINK`
dataType	`DATE`
dataType	`NUMBER`
dataType	`CHECKBOX`
dataType	`CLIENT_LINK`
dataType	`STRING`
dataType	`USER_LINK`
dataType	`SELECTION`
state	`DEACTIVATED`
state	`NORMAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
valueLength	`SHORT`
valueLength	`LONG`
interestPaymentPoint	`EVERY_WEEK`
interestPaymentPoint	`ON_FIXED_DATES`
interestPaymentPoint	`EVERY_MONTH`
interestPaymentPoint	`ON_ACCOUNT_MATURITY`
interestPaymentPoint	`EVERY_3_MONTHS`
interestPaymentPoint	`FIRST_DAY_OF_MONTH`
interestPaymentPoint	`EVERY_OTHER_WEEK`
interestChargeFrequency	`EVERY_WEEK`
interestChargeFrequency	`ANNUALIZED`
interestChargeFrequency	`EVERY_MONTH`
interestChargeFrequency	`EVERY_X_DAYS`
interestChargeFrequency	`EVERY_FOUR_WEEKS`
interestChargeFrequency	`EVERY_DAY`
interestRateReviewUnit	`MONTHS`
interestRateReviewUnit	`WEEKS`
interestRateReviewUnit	`DAYS`
interestRateSource	`FIXED_INTEREST_RATE`
interestRateSource	`INDEX_INTEREST_RATE`
interestRateTerms	`TIERED_PERIOD`
interestRateTerms	`FIXED`
interestRateTerms	`TIERED`
state	`REVERTED`
state	`DRAFT`
state	`APPROVED`
type	`IMPORT`
type	`EXPORT`

Create Savings Account

POST /savings

Create a savings account

Example Requests

{
  "customInformation": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "savingsAccount": {
    "accountHolderKey": "string",
    "accountHolderType": "GROUP",
    "accountState": "WITHDRAWN",
    "accountType": "CURRENT_ACCOUNT",
    "accruedInterest": 0,
    "activationDate": "string",
    "allowOverdraft": true,
    "approvedDate": "string",
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "availableBalance": 0,
    "balance": 0,
    "closedDate": "string",
    "creationDate": "string",
    "currency": {
      "code": "string",
      "creationDate": "string",
      "currencySymbolPosition": "AFTER_NUMBER",
      "digitsAfterDecimal": 0,
      "isBaseCurrency": true,
      "lastModifiedDate": "string",
      "name": "string",
      "symbol": "string"
    },
    "currencyCode": "string",
    "customFieldValues": [
      {
        "amount": 0,
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "customFieldID": "string",
        "customFieldKey": "string",
        "customFieldSetGroupIndex": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexInList": 0,
        "linkedEntityKeyValue": "string",
        "parentKey": "string",
        "selectionKey": "string",
        "value": "string"
      }
    ],
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "feesDue": 0,
    "holdBalance": 0,
    "id": "string",
    "interestDue": 0,
    "interestPaymentDates": [
      {
        "dayOfMonth": 0,
        "monthOfYear": 0,
        "year": 0
      }
    ],
    "interestPaymentPoint": "EVERY_WEEK",
    "interestSettings": {
      "accrueInterestAfterMaturity": true,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestChargeFrequencyCount": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "TIERED_PERIOD",
      "interestRateTiers": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingBalance": 0,
          "endingDay": 0,
          "index": 0,
          "interestRate": 0
        }
      ],
      "interestSpread": 0
    },
    "lastAccountAppraisalDate": "string",
    "lastInterestCalculationDate": "string",
    "lastInterestStoredDate": "string",
    "lastModifiedDate": "string",
    "lastOverdraftInterestReviewDate": "string",
    "lastSetToArrearsDate": "string",
    "lineOfCreditKey": "string",
    "lockedBalance": 0,
    "lockedDate": "string",
    "maturityDate": "string",
    "maxWidthdrawlAmount": 0,
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "name": "string",
    "notes": "string",
    "overdraftAmount": 0,
    "overdraftExpiryDate": "string",
    "overdraftExpiryDateDTO": {
      "dayOfMonth": 0,
      "monthOfYear": 0,
      "year": 0
    },
    "overdraftInterestAccrued": 0,
    "overdraftInterestSettings": {
      "accrueInterestAfterMaturity": true,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestChargeFrequencyCount": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "TIERED_PERIOD",
      "interestRateTiers": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingBalance": 0,
          "endingDay": 0,
          "index": 0,
          "interestRate": 0
        }
      ],
      "interestSpread": 0
    },
    "overdraftLimit": 0,
    "productTypeKey": "string",
    "recommendedDepositAmount": 0,
    "targetAmount": 0,
    "technicalInterestDue": 0,
    "technicalOverdraftAmount": 0,
    "technicalOverdraftInterestAccrued": 0,
    "withholdingTaxSourceKey": "string"
  }
}

Parameters

Name	Type	Description	In
body	JSONSavingsAccountApiV1	none	body

Example Responses

200 Response

{
  "customInformation": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "savingsAccount": {
    "accountHolderKey": "string",
    "accountHolderType": "GROUP",
    "accountState": "WITHDRAWN",
    "accountType": "CURRENT_ACCOUNT",
    "accruedInterest": 0,
    "activationDate": "string",
    "allowOverdraft": true,
    "approvedDate": "string",
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "availableBalance": 0,
    "balance": 0,
    "closedDate": "string",
    "creationDate": "string",
    "currency": {
      "code": "string",
      "creationDate": "string",
      "currencySymbolPosition": "AFTER_NUMBER",
      "digitsAfterDecimal": 0,
      "isBaseCurrency": true,
      "lastModifiedDate": "string",
      "name": "string",
      "symbol": "string"
    },
    "currencyCode": "string",
    "customFieldValues": [
      {
        "amount": 0,
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "customFieldID": "string",
        "customFieldKey": "string",
        "customFieldSetGroupIndex": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexInList": 0,
        "linkedEntityKeyValue": "string",
        "parentKey": "string",
        "selectionKey": "string",
        "value": "string"
      }
    ],
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "feesDue": 0,
    "holdBalance": 0,
    "id": "string",
    "interestDue": 0,
    "interestPaymentDates": [
      {
        "dayOfMonth": 0,
        "monthOfYear": 0,
        "year": 0
      }
    ],
    "interestPaymentPoint": "EVERY_WEEK",
    "interestSettings": {
      "accrueInterestAfterMaturity": true,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestChargeFrequencyCount": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "TIERED_PERIOD",
      "interestRateTiers": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingBalance": 0,
          "endingDay": 0,
          "index": 0,
          "interestRate": 0
        }
      ],
      "interestSpread": 0
    },
    "lastAccountAppraisalDate": "string",
    "lastInterestCalculationDate": "string",
    "lastInterestStoredDate": "string",
    "lastModifiedDate": "string",
    "lastOverdraftInterestReviewDate": "string",
    "lastSetToArrearsDate": "string",
    "lineOfCreditKey": "string",
    "lockedBalance": 0,
    "lockedDate": "string",
    "maturityDate": "string",
    "maxWidthdrawlAmount": 0,
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "name": "string",
    "notes": "string",
    "overdraftAmount": 0,
    "overdraftExpiryDate": "string",
    "overdraftExpiryDateDTO": {
      "dayOfMonth": 0,
      "monthOfYear": 0,
      "year": 0
    },
    "overdraftInterestAccrued": 0,
    "overdraftInterestSettings": {
      "accrueInterestAfterMaturity": true,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestChargeFrequencyCount": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "TIERED_PERIOD",
      "interestRateTiers": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingBalance": 0,
          "endingDay": 0,
          "index": 0,
          "interestRate": 0
        }
      ],
      "interestSpread": 0
    },
    "overdraftLimit": 0,
    "productTypeKey": "string",
    "recommendedDepositAmount": 0,
    "targetAmount": 0,
    "technicalInterestDue": 0,
    "technicalOverdraftAmount": 0,
    "technicalOverdraftInterestAccrued": 0,
    "withholdingTaxSourceKey": "string"
  }
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	JSONSavingsAccountApiV1

Search Savings Accounts

POST /savings/search

Search for savings accounts based on some criteria

Example Requests

{
  "filterConstraints": [
    {
      "dataFieldType": "string",
      "dataItemType": "string",
      "filterElement": "string",
      "filterSelection": "string",
      "secondValue": "string",
      "value": "string",
      "values": [
        "string"
      ]
    }
  ],
  "sortDetails": {
    "dataFieldType": "string",
    "dataItemType": "string",
    "sortingColumn": "string",
    "sortingOrder": "string"
  }
}

Parameters

Name	Type	Description	In
offset	integer	none	query
limit	integer	none	query
body	FilterApiV1	none	body

Example Responses

200 Response

[
  {
    "accountHolderKey": "string",
    "accountHolderType": "GROUP",
    "accountState": "WITHDRAWN",
    "accountType": "CURRENT_ACCOUNT",
    "accruedInterest": 0,
    "activationDate": "string",
    "allowOverdraft": true,
    "approvedDate": "string",
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "availableBalance": 0,
    "balance": 0,
    "closedDate": "string",
    "creationDate": "string",
    "currency": {
      "code": "string",
      "creationDate": "string",
      "currencySymbolPosition": "AFTER_NUMBER",
      "digitsAfterDecimal": 0,
      "isBaseCurrency": true,
      "lastModifiedDate": "string",
      "name": "string",
      "symbol": "string"
    },
    "currencyCode": "string",
    "customFieldValues": [
      {
        "amount": 0,
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "customFieldID": "string",
        "customFieldKey": "string",
        "customFieldSetGroupIndex": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexInList": 0,
        "linkedEntityKeyValue": "string",
        "parentKey": "string",
        "selectionKey": "string",
        "value": "string"
      }
    ],
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "feesDue": 0,
    "holdBalance": 0,
    "id": "string",
    "interestDue": 0,
    "interestPaymentDates": [
      {
        "dayOfMonth": 0,
        "monthOfYear": 0,
        "year": 0
      }
    ],
    "interestPaymentPoint": "EVERY_WEEK",
    "interestSettings": {
      "accrueInterestAfterMaturity": true,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestChargeFrequencyCount": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "TIERED_PERIOD",
      "interestRateTiers": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingBalance": 0,
          "endingDay": 0,
          "index": 0,
          "interestRate": 0
        }
      ],
      "interestSpread": 0
    },
    "lastAccountAppraisalDate": "string",
    "lastInterestCalculationDate": "string",
    "lastInterestStoredDate": "string",
    "lastModifiedDate": "string",
    "lastOverdraftInterestReviewDate": "string",
    "lastSetToArrearsDate": "string",
    "lineOfCreditKey": "string",
    "lockedBalance": 0,
    "lockedDate": "string",
    "maturityDate": "string",
    "maxWidthdrawlAmount": 0,
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "name": "string",
    "notes": "string",
    "overdraftAmount": 0,
    "overdraftExpiryDate": "string",
    "overdraftExpiryDateDTO": {
      "dayOfMonth": 0,
      "monthOfYear": 0,
      "year": 0
    },
    "overdraftInterestAccrued": 0,
    "overdraftInterestSettings": {
      "accrueInterestAfterMaturity": true,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestChargeFrequencyCount": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "TIERED_PERIOD",
      "interestRateTiers": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingBalance": 0,
          "endingDay": 0,
          "index": 0,
          "interestRate": 0
        }
      ],
      "interestSpread": 0
    },
    "overdraftLimit": 0,
    "productTypeKey": "string",
    "recommendedDepositAmount": 0,
    "targetAmount": 0,
    "technicalInterestDue": 0,
    "technicalOverdraftAmount": 0,
    "technicalOverdraftInterestAccrued": 0,
    "withholdingTaxSourceKey": "string"
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[SavingsAccountApiV1]	none	none
» accountHolderKey	string	none	none
» accountHolderType	string	none	none
» accountState	string	none	none
» accountType	string	none	none
» accruedInterest	number	none	none
» activationDate	string	none	none
» allowOverdraft	boolean	none	none
» approvedDate	string	none	none
» assignedBranchKey	string	none	none
» assignedCentreKey	string	none	none
» assignedUserKey	string	none	none
» availableBalance	number	none	none
» balance	number	none	none
» closedDate	string	none	none
» creationDate	string	the date and time when this savings account was created	none
» currency	CurrencyApiV1	none	none
»» code	string	the three letter ISO code for this currency	none
»» creationDate	string	the date on which this currency was created	none
»» currencySymbolPosition	string	indicates where the currency symbol should appear in relation to the numeric value	none
»» digitsAfterDecimal	number	indicates how many decimal places are allowed for this currency. For example, a currenncy with 100 minor units to 1 major unit, there will be 2 decimal places.	none
»» isBaseCurrency	boolean	whether this currency is the base currency for your banking institution	none
»» lastModifiedDate	string	the date on which this currency was last modified	none
»» name	string	the name of this currency	none
»» symbol	string	the currency symnbol used for this currency	none
» currencyCode	string	none	none
» customFieldValues	[CustomFieldValueApiV1]	none	none
»» amount	number	none	none
»» customField	CustomFieldApiV1	none	none
»»» amounts	object	used when options available for a custom field definition translate to predefined amounts, for example, when the custom field value is used to generate a score	none
»»»» additionalProperties	number	none	none
»»» builtInCustomFieldId	string	if this field is one of the built in custom fiel definitions, this will have a value. These names are reserved and you can not use them for your own custom field definitions	none
»»» creationDate	string	the date on which this custom field definition was created	none
»»» customFieldProductSettings	[CustomFieldLinkApiV1]	none	none
»»»» customFieldEncodedKey	string	the key to the parent custom field definition	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isDefault	boolean	whether this field is displayed by default when creating a new record	none
»»»» isRequired	boolean	whether this field is required when creating a new record	none
»»»» linkType	string	the type of entity this field represents a link to	none
»»»» productKey	string	when the link type is product, this field should contain the encoded key of the linekd product	none
»»» customFieldSelectionOptions	[CustomFieldSelectionApiV1]	[represents a possible selection for select type custom field definitions]	none
»»»» constraint	CustomFilterConstraintApiV1	none	none
»»»»» customFieldKey	string	none	none
»»»»» dataFieldType	string	none	none
»»»»» dataFieldValue	string	none	none
»»»»» dataItemType	string	none	none
»»»»» dataType	string	none	none
»»»»» encodedKey	string	none	none
»»»»» filterElement	string	none	none
»»»»» groupNumber	number	none	none
»»»»» index	number	none	none
»»»»» linkingOperator	string	none	none
»»»»» secondValue	string	none	none
»»»»» value	string	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this selectable item	none
»»»» score	number	the score assigned to this selection	none
»»»» value	string	display name of this option	none
»»» customFieldSet	CustomFieldSetApiV1	none	none
»»»» builtInType	string	if this set is part of the set of built-in custom field sets, its type will be shown here	none
»»»» createdDate	string	the date and time when this custom field set was created	none
»»»» customFields	[CustomFieldApiV1]	an array of custom field definitions included in this custom field set	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this custom field set	none
»»»» indexInList	number	for field sets that can be added to an entity more than once, this number represents the index in the list and is used when changing values	none
»»»» lastModifiedDate	string	the date on which this custom field set was last modified	none
»»»» name	string	the name of this custom field set	none
»»»» notes	string	any notes regarding this custom field set	none
»»»» type	string	the entity type that this custom field definition is attached to	none
»»»» usage	string	whether this custom field set can only be used once, or added multiple times to the same entity	none
»»» dataType	string	the type of custom field definition	none
»»» description	string	a brief description of this custom field definition	none
»»» editRights	UsageRightsApiV1	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isAccessibleByAllUsers	boolean	none	none
»»»» roles	[string]	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» id	string	the ID for this custom field definition	none
»»» indexInList	number	none	none
»»» isDefault	boolean	whether this field will be included by default on new records	none
»»» isRequired	boolean	whether this field is required when creating a new record	none
»»» lastModifiedDate	string	the date on which this custom field definition was last modified	none
»»» name	string	the name of this custom field definition	none
»»» state	string	whether this field is available for use or has been deactivated	none
»»» type	string	the type of data this custom field definition will contain	none
»»» unique	boolean	whether the data in this custom field definition needs to be a unique value	none
»»» validationPattern	string	a user-provided pattern to which data in this custom field definition must conform where @ represents numbers, # represents letters and $ is either a number or letter. Other special characters used as separators are allowed, for example `@@-##-$$$`	none
»»» valueLength	string	whether this field needs to support a large number of characters	none
»»» values	[string]	a list of possible values when the field is a selection field	none
»»» viewRights	UsageRightsApiV1	none	none
»» customFieldID	string	none	none
»» customFieldKey	string	none	none
»» customFieldSetGroupIndex	number	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» indexInList	number	none	none
»» linkedEntityKeyValue	string	none	none
»» parentKey	string	none	none
»» selectionKey	string	none	none
»» value	string	none	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» feesDue	number	none	none
» holdBalance	number	none	none
» id	string	none	none
» interestDue	number	none	none
» interestPaymentDates	[DateDTOApiV1]	none	none
»» dayOfMonth	number	the day of the month	none
»» monthOfYear	number	the month	none
»» year	number	the year	none
» interestPaymentPoint	string	none	none
» interestSettings	InterestAccountSettingsApiV1	none	none
»» accrueInterestAfterMaturity	boolean	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» interestChargeFrequency	string	none	none
»» interestChargeFrequencyCount	number	none	none
»» interestRate	number	none	none
»» interestRateReviewCount	number	none	none
»» interestRateReviewUnit	string	none	none
»» interestRateSource	string	none	none
»» interestRateTerms	string	none	none
»» interestRateTiers	[InterestRateTierApiV1]	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» endingBalance	number	none	none
»»» endingDay	number	none	none
»»» index	number	none	none
»»» interestRate	number	none	none
»» interestSpread	number	none	none
» lastAccountAppraisalDate	string	none	none
» lastInterestCalculationDate	string	none	none
» lastInterestStoredDate	string	none	none
» lastModifiedDate	string	the date on which this savings account was last modified	none
» lastOverdraftInterestReviewDate	string	none	none
» lastSetToArrearsDate	string	none	none
» lineOfCreditKey	string	none	none
» lockedBalance	number	none	none
» lockedDate	string	none	none
» maturityDate	string	none	none
» maxWidthdrawlAmount	number	none	none
» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
»» creationDate	string(date-time)	the date on which the data import was made	none
»» encodedKey	string	the encoded key of this data migration event	none
»» numCentresImported	number	the number of centres which were imported during the data migration	none
»» numClientsImported	number	the number of clients which were imported as part of the data migration	none
»» numGLAccountsImported	number	the number of general ledger accounts which were imported as part of the data migration	none
»» numGroupsImported	number	the number of groups which were imported as part of the data migration	none
»» numLoanRepaymentsImported	number	the number of loan repayment transations which were imported as part of the data migration	none
»» numLoanTransactionsImported	number	the number of loan transactions which were imported as part of the data migration	none
»» numLoansImported	number	the number of loan accounts which were imported as part of the data migration	none
»» numSavingsImported	number	the number of savings accounts which were imported as part of the data migration	none
»» state	string	whether the data import was accepted, is still in a draft state, or was rejected and all data reverted	none
»» type	string	the type of migration event	none
» name	string	none	none
» notes	string	none	none
» overdraftAmount	number	none	none
» overdraftExpiryDate	string	none	none
» overdraftExpiryDateDTO	DateDTOApiV1	none	none
» overdraftInterestAccrued	number	none	none
» overdraftInterestSettings	InterestAccountSettingsApiV1	none	none
» overdraftLimit	number	none	none
» productTypeKey	string	none	none
» recommendedDepositAmount	number	none	none
» targetAmount	number	none	none
» technicalInterestDue	number	none	none
» technicalOverdraftAmount	number	none	none
» technicalOverdraftInterestAccrued	number	none	none
» withholdingTaxSourceKey	string	none	none

Enumerated Values

Property	Value
accountHolderType	`GROUP`
accountHolderType	`CLIENT`
accountState	`WITHDRAWN`
accountState	`PARTIALLY_DISBURSED`
accountState	`LOCKED`
accountState	`ACTIVE`
accountState	`CLOSED`
accountState	`PARTIAL_APPLICATION`
accountState	`LOCKED_CAPPING`
accountState	`CLOSED_REJECTED`
accountState	`RESCHEDULED`
accountState	`ACTIVE_IN_ARREARS`
accountState	`MATURED`
accountState	`CLOSED_RESCHEDULED`
accountState	`CLOSED_WITHDRAWN`
accountState	`PENDING_APPROVAL`
accountState	`APPROVED`
accountState	`REFINANCED`
accountState	`DORMANT`
accountState	`CLOSED_WRITTEN_OFF`
accountType	`CURRENT_ACCOUNT`
accountType	`REGULAR_SAVINGS`
accountType	`FIXED_DEPOSIT`
accountType	`INVESTOR_ACCOUNT`
accountType	`SAVINGS_PLAN`
currencySymbolPosition	`AFTER_NUMBER`
currencySymbolPosition	`BEFORE_NUMBER`
builtInCustomFieldId	`MOBILE_PHONE`
builtInCustomFieldId	`EMAIL_ADDRESS`
builtInCustomFieldId	`GENDER`
builtInCustomFieldId	`MIDDLE_NAME`
builtInCustomFieldId	`HOME_PHONE`
builtInCustomFieldId	`BIRTHDATE`
builtInCustomFieldId	`LAST_NAME`
builtInCustomFieldId	`FIRST_NAME`
linkType	`CLIENT_ROLE`
linkType	`CHANNEL`
linkType	`PRODUCT`
dataFieldType	`NATIVE`
dataFieldType	`CUSTOM`
dataItemType	`WRITTEN_OFF_LOANS`
dataItemType	`LINE_OF_CREDIT`
dataItemType	`INVESTOR_FUND`
dataItemType	`TRANSACTION_DETAILS`
dataItemType	`DOCUMENT_TEMPLATE`
dataItemType	`PRODUCT`
dataItemType	`MCC_EXPIRATION`
dataItemType	`CENTRE`
dataItemType	`REPAYMENT_COLLECTION`
dataItemType	`TASK`
dataItemType	`OUTSTANDING_PORTFOLIO_AMOUNTS`
dataItemType	`REVENUE`
dataItemType	`COMPOSED_TRANSACTIONS`
dataItemType	`UNION_TRANSACTIONS`
dataItemType	`PRINCIPAL_PAYMENT_SETTINGS`
dataItemType	`LOANS`
dataItemType	`DISBURSEMENT_DETAILS`
dataItemType	`SAVINGS_TRANSACTION`
dataItemType	`IDENTIFICATION_DOCUMENT`
dataItemType	`LOAN_PRODUCT`
dataItemType	`DISBURSED_LOANS`
dataItemType	`LOAN_GROUP`
dataItemType	`TRANSACTION_CHANNEL`
dataItemType	`CUSTOM_PREDEFINED_FEE`
dataItemType	`JOURNAL_ENTRY`
dataItemType	`ATTACHMENT`
dataItemType	`PREDEFINED_FEE`
dataItemType	`TRANCHE`
dataItemType	`TRANSACTION`
dataItemType	`INDEX_RATE_SOURCE`
dataItemType	`GROUP_ROLE`
dataItemType	`LOAN_TRANSACTION`
dataItemType	`CLIENT_ROLE`
dataItemType	`GROUP`
dataItemType	`NOTIFICATION_MESSAGE`
dataItemType	`OUTSTANDING_PORTFOLIO_ACCOUNTS`
dataItemType	`REPAYMENT`
dataItemType	`LOAN_ACCOUNT_GUARANTY`
dataItemType	`BRANCH`
dataItemType	`CURRENCY`
dataItemType	`CARD_TRANSACTION_REVERSAL`
dataItemType	`INTEREST_PRODUCT_SETTINGS`
dataItemType	`CREATED_ACCOUNTS`
dataItemType	`USER`
dataItemType	`SAVINGS_PRODUCT`
dataItemType	`CLIENT`
dataItemType	`PRODUCT_ARREARS_SETTINGS`
dataItemType	`SAVINGS`
dataItemType	`EXPENSE`
dataItemType	`INDEX_RATE`
dataItemType	`NOTIFICATION_TEMPLATE`
dataItemType	`CUSTOM_FIELD_SELECTION`
dataItemType	`ACTIVITY`
dataType	`ENUM`
dataType	`MONEY`
dataType	`NUMBER`
dataType	`DATE_UTC`
dataType	`JAVA_BLOB`
dataType	`OBJECT`
dataType	`BOOLEAN`
dataType	`DATE`
dataType	`PERCENT`
dataType	`BIG_DECIMAL`
dataType	`STRING`
dataType	`KEY`
dataType	`LONG`
filterElement	`STARTS_WITH_CASE_SENSITIVE`
filterElement	`THIS_WEEK`
filterElement	`EQUALS`
filterElement	`STARTS_WITH`
filterElement	`IN`
filterElement	`TODAY`
filterElement	`THIS_YEAR`
filterElement	`BETWEEN`
filterElement	`AFTER`
filterElement	`LESS_THAN`
filterElement	`DIFFERENT_THAN`
filterElement	`THIS_MONTH`
filterElement	`NOT_EMPTY`
filterElement	`BEFORE`
filterElement	`EQUALS_CASE_SENSITIVE`
filterElement	`LAST_DAYS`
filterElement	`MORE_THAN`
filterElement	`EMPTY`
filterElement	`ON`
linkingOperator	`OR`
linkingOperator	`AND`
builtInType	`DETAILS`
builtInType	`GENERAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
usage	`SINGLE`
usage	`GROUPED`
dataType	`GROUP_LINK`
dataType	`DATE`
dataType	`NUMBER`
dataType	`CHECKBOX`
dataType	`CLIENT_LINK`
dataType	`STRING`
dataType	`USER_LINK`
dataType	`SELECTION`
state	`DEACTIVATED`
state	`NORMAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
valueLength	`SHORT`
valueLength	`LONG`
interestPaymentPoint	`EVERY_WEEK`
interestPaymentPoint	`ON_FIXED_DATES`
interestPaymentPoint	`EVERY_MONTH`
interestPaymentPoint	`ON_ACCOUNT_MATURITY`
interestPaymentPoint	`EVERY_3_MONTHS`
interestPaymentPoint	`FIRST_DAY_OF_MONTH`
interestPaymentPoint	`EVERY_OTHER_WEEK`
interestChargeFrequency	`EVERY_WEEK`
interestChargeFrequency	`ANNUALIZED`
interestChargeFrequency	`EVERY_MONTH`
interestChargeFrequency	`EVERY_X_DAYS`
interestChargeFrequency	`EVERY_FOUR_WEEKS`
interestChargeFrequency	`EVERY_DAY`
interestRateReviewUnit	`MONTHS`
interestRateReviewUnit	`WEEKS`
interestRateReviewUnit	`DAYS`
interestRateSource	`FIXED_INTEREST_RATE`
interestRateSource	`INDEX_INTEREST_RATE`
interestRateTerms	`TIERED_PERIOD`
interestRateTerms	`FIXED`
interestRateTerms	`TIERED`
state	`REVERTED`
state	`DRAFT`
state	`APPROVED`
type	`IMPORT`
type	`EXPORT`

Delete Savings Account

DELETE /savings/{savingsAccountId}

Delete an existing savings account

Parameters

Name	Type	Description	In
id (required)	string	none	path
savingsAccountId (required)	string	none	path

Example Responses

200 Response

{
  "errorSource": "string",
  "returnCode": 0,
  "returnStatus": "string"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	ExecutionStatusApiV1

Get Savings Account by ID

GET /savings/{savingsAccountId}

Get a savings account by ID

Parameters

Name	Type	Description	In
clientID	string	none	query
groupID	string	none	query
id (required)	string	none	path
fullDetails	boolean	none	query
savingsAccountId (required)	string	none	path

Example Responses

200 Response

{
  "accountHolderKey": "string",
  "accountHolderType": "GROUP",
  "accountState": "WITHDRAWN",
  "accountType": "CURRENT_ACCOUNT",
  "accruedInterest": 0,
  "activationDate": "string",
  "allowOverdraft": true,
  "approvedDate": "string",
  "assignedBranchKey": "string",
  "assignedCentreKey": "string",
  "assignedUserKey": "string",
  "availableBalance": 0,
  "balance": 0,
  "closedDate": "string",
  "creationDate": "string",
  "currency": {
    "code": "string",
    "creationDate": "string",
    "currencySymbolPosition": "AFTER_NUMBER",
    "digitsAfterDecimal": 0,
    "isBaseCurrency": true,
    "lastModifiedDate": "string",
    "name": "string",
    "symbol": "string"
  },
  "currencyCode": "string",
  "customFieldValues": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "feesDue": 0,
  "holdBalance": 0,
  "id": "string",
  "interestDue": 0,
  "interestPaymentDates": [
    {
      "dayOfMonth": 0,
      "monthOfYear": 0,
      "year": 0
    }
  ],
  "interestPaymentPoint": "EVERY_WEEK",
  "interestSettings": {
    "accrueInterestAfterMaturity": true,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "interestChargeFrequency": "EVERY_WEEK",
    "interestChargeFrequencyCount": 0,
    "interestRate": 0,
    "interestRateReviewCount": 0,
    "interestRateReviewUnit": "MONTHS",
    "interestRateSource": "FIXED_INTEREST_RATE",
    "interestRateTerms": "TIERED_PERIOD",
    "interestRateTiers": [
      {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "endingBalance": 0,
        "endingDay": 0,
        "index": 0,
        "interestRate": 0
      }
    ],
    "interestSpread": 0
  },
  "lastAccountAppraisalDate": "string",
  "lastInterestCalculationDate": "string",
  "lastInterestStoredDate": "string",
  "lastModifiedDate": "string",
  "lastOverdraftInterestReviewDate": "string",
  "lastSetToArrearsDate": "string",
  "lineOfCreditKey": "string",
  "lockedBalance": 0,
  "lockedDate": "string",
  "maturityDate": "string",
  "maxWidthdrawlAmount": 0,
  "migrationEvent": {
    "creationDate": "2019-08-24T14:15:22Z",
    "encodedKey": "string",
    "numCentresImported": 0,
    "numClientsImported": 0,
    "numGLAccountsImported": 0,
    "numGroupsImported": 0,
    "numLoanRepaymentsImported": 0,
    "numLoanTransactionsImported": 0,
    "numLoansImported": 0,
    "numSavingsImported": 0,
    "state": "REVERTED",
    "type": "IMPORT"
  },
  "name": "string",
  "notes": "string",
  "overdraftAmount": 0,
  "overdraftExpiryDate": "string",
  "overdraftExpiryDateDTO": {
    "dayOfMonth": 0,
    "monthOfYear": 0,
    "year": 0
  },
  "overdraftInterestAccrued": 0,
  "overdraftInterestSettings": {
    "accrueInterestAfterMaturity": true,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "interestChargeFrequency": "EVERY_WEEK",
    "interestChargeFrequencyCount": 0,
    "interestRate": 0,
    "interestRateReviewCount": 0,
    "interestRateReviewUnit": "MONTHS",
    "interestRateSource": "FIXED_INTEREST_RATE",
    "interestRateTerms": "TIERED_PERIOD",
    "interestRateTiers": [
      {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "endingBalance": 0,
        "endingDay": 0,
        "index": 0,
        "interestRate": 0
      }
    ],
    "interestSpread": 0
  },
  "overdraftLimit": 0,
  "productTypeKey": "string",
  "recommendedDepositAmount": 0,
  "targetAmount": 0,
  "technicalInterestDue": 0,
  "technicalOverdraftAmount": 0,
  "technicalOverdraftInterestAccrued": 0,
  "withholdingTaxSourceKey": "string"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	SavingsAccountApiV1

Update existing Savings Account

PATCH /savings/{savingsAccountId}

Update an existing savings account

Example Requests

{
  "customInformation": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "savingsAccount": {
    "accountHolderKey": "string",
    "accountHolderType": "GROUP",
    "accountState": "WITHDRAWN",
    "accountType": "CURRENT_ACCOUNT",
    "accruedInterest": 0,
    "activationDate": "string",
    "allowOverdraft": true,
    "approvedDate": "string",
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "availableBalance": 0,
    "balance": 0,
    "closedDate": "string",
    "creationDate": "string",
    "currency": {
      "code": "string",
      "creationDate": "string",
      "currencySymbolPosition": "AFTER_NUMBER",
      "digitsAfterDecimal": 0,
      "isBaseCurrency": true,
      "lastModifiedDate": "string",
      "name": "string",
      "symbol": "string"
    },
    "currencyCode": "string",
    "customFieldValues": [
      {
        "amount": 0,
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "customFieldID": "string",
        "customFieldKey": "string",
        "customFieldSetGroupIndex": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexInList": 0,
        "linkedEntityKeyValue": "string",
        "parentKey": "string",
        "selectionKey": "string",
        "value": "string"
      }
    ],
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "feesDue": 0,
    "holdBalance": 0,
    "id": "string",
    "interestDue": 0,
    "interestPaymentDates": [
      {
        "dayOfMonth": 0,
        "monthOfYear": 0,
        "year": 0
      }
    ],
    "interestPaymentPoint": "EVERY_WEEK",
    "interestSettings": {
      "accrueInterestAfterMaturity": true,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestChargeFrequencyCount": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "TIERED_PERIOD",
      "interestRateTiers": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingBalance": 0,
          "endingDay": 0,
          "index": 0,
          "interestRate": 0
        }
      ],
      "interestSpread": 0
    },
    "lastAccountAppraisalDate": "string",
    "lastInterestCalculationDate": "string",
    "lastInterestStoredDate": "string",
    "lastModifiedDate": "string",
    "lastOverdraftInterestReviewDate": "string",
    "lastSetToArrearsDate": "string",
    "lineOfCreditKey": "string",
    "lockedBalance": 0,
    "lockedDate": "string",
    "maturityDate": "string",
    "maxWidthdrawlAmount": 0,
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "name": "string",
    "notes": "string",
    "overdraftAmount": 0,
    "overdraftExpiryDate": "string",
    "overdraftExpiryDateDTO": {
      "dayOfMonth": 0,
      "monthOfYear": 0,
      "year": 0
    },
    "overdraftInterestAccrued": 0,
    "overdraftInterestSettings": {
      "accrueInterestAfterMaturity": true,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestChargeFrequencyCount": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "TIERED_PERIOD",
      "interestRateTiers": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingBalance": 0,
          "endingDay": 0,
          "index": 0,
          "interestRate": 0
        }
      ],
      "interestSpread": 0
    },
    "overdraftLimit": 0,
    "productTypeKey": "string",
    "recommendedDepositAmount": 0,
    "targetAmount": 0,
    "technicalInterestDue": 0,
    "technicalOverdraftAmount": 0,
    "technicalOverdraftInterestAccrued": 0,
    "withholdingTaxSourceKey": "string"
  }
}

Parameters

Name	Type	Description	In
body	JSONSavingsAccountApiV1	none	body
savingsAccountId (required)	string	none	path

Example Responses

200 Response

{
  "errorSource": "string",
  "returnCode": 0,
  "returnStatus": "string"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	ExecutionStatusApiV1

Edit existing Savings Account

POST /savings/{savingsAccountId}

Update or create a savings account

Example Requests

{
  "customInformation": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "savingsAccount": {
    "accountHolderKey": "string",
    "accountHolderType": "GROUP",
    "accountState": "WITHDRAWN",
    "accountType": "CURRENT_ACCOUNT",
    "accruedInterest": 0,
    "activationDate": "string",
    "allowOverdraft": true,
    "approvedDate": "string",
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "availableBalance": 0,
    "balance": 0,
    "closedDate": "string",
    "creationDate": "string",
    "currency": {
      "code": "string",
      "creationDate": "string",
      "currencySymbolPosition": "AFTER_NUMBER",
      "digitsAfterDecimal": 0,
      "isBaseCurrency": true,
      "lastModifiedDate": "string",
      "name": "string",
      "symbol": "string"
    },
    "currencyCode": "string",
    "customFieldValues": [
      {
        "amount": 0,
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "customFieldID": "string",
        "customFieldKey": "string",
        "customFieldSetGroupIndex": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexInList": 0,
        "linkedEntityKeyValue": "string",
        "parentKey": "string",
        "selectionKey": "string",
        "value": "string"
      }
    ],
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "feesDue": 0,
    "holdBalance": 0,
    "id": "string",
    "interestDue": 0,
    "interestPaymentDates": [
      {
        "dayOfMonth": 0,
        "monthOfYear": 0,
        "year": 0
      }
    ],
    "interestPaymentPoint": "EVERY_WEEK",
    "interestSettings": {
      "accrueInterestAfterMaturity": true,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestChargeFrequencyCount": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "TIERED_PERIOD",
      "interestRateTiers": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingBalance": 0,
          "endingDay": 0,
          "index": 0,
          "interestRate": 0
        }
      ],
      "interestSpread": 0
    },
    "lastAccountAppraisalDate": "string",
    "lastInterestCalculationDate": "string",
    "lastInterestStoredDate": "string",
    "lastModifiedDate": "string",
    "lastOverdraftInterestReviewDate": "string",
    "lastSetToArrearsDate": "string",
    "lineOfCreditKey": "string",
    "lockedBalance": 0,
    "lockedDate": "string",
    "maturityDate": "string",
    "maxWidthdrawlAmount": 0,
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "name": "string",
    "notes": "string",
    "overdraftAmount": 0,
    "overdraftExpiryDate": "string",
    "overdraftExpiryDateDTO": {
      "dayOfMonth": 0,
      "monthOfYear": 0,
      "year": 0
    },
    "overdraftInterestAccrued": 0,
    "overdraftInterestSettings": {
      "accrueInterestAfterMaturity": true,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestChargeFrequencyCount": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "TIERED_PERIOD",
      "interestRateTiers": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingBalance": 0,
          "endingDay": 0,
          "index": 0,
          "interestRate": 0
        }
      ],
      "interestSpread": 0
    },
    "overdraftLimit": 0,
    "productTypeKey": "string",
    "recommendedDepositAmount": 0,
    "targetAmount": 0,
    "technicalInterestDue": 0,
    "technicalOverdraftAmount": 0,
    "technicalOverdraftInterestAccrued": 0,
    "withholdingTaxSourceKey": "string"
  }
}

Parameters

Name	Type	Description	In
body	JSONSavingsAccountApiV1	none	body
savingsAccountId (required)	string	none	path

Example Responses

200 Response

{
  "customInformation": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "savingsAccount": {
    "accountHolderKey": "string",
    "accountHolderType": "GROUP",
    "accountState": "WITHDRAWN",
    "accountType": "CURRENT_ACCOUNT",
    "accruedInterest": 0,
    "activationDate": "string",
    "allowOverdraft": true,
    "approvedDate": "string",
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "availableBalance": 0,
    "balance": 0,
    "closedDate": "string",
    "creationDate": "string",
    "currency": {
      "code": "string",
      "creationDate": "string",
      "currencySymbolPosition": "AFTER_NUMBER",
      "digitsAfterDecimal": 0,
      "isBaseCurrency": true,
      "lastModifiedDate": "string",
      "name": "string",
      "symbol": "string"
    },
    "currencyCode": "string",
    "customFieldValues": [
      {
        "amount": 0,
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "customFieldID": "string",
        "customFieldKey": "string",
        "customFieldSetGroupIndex": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexInList": 0,
        "linkedEntityKeyValue": "string",
        "parentKey": "string",
        "selectionKey": "string",
        "value": "string"
      }
    ],
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "feesDue": 0,
    "holdBalance": 0,
    "id": "string",
    "interestDue": 0,
    "interestPaymentDates": [
      {
        "dayOfMonth": 0,
        "monthOfYear": 0,
        "year": 0
      }
    ],
    "interestPaymentPoint": "EVERY_WEEK",
    "interestSettings": {
      "accrueInterestAfterMaturity": true,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestChargeFrequencyCount": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "TIERED_PERIOD",
      "interestRateTiers": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingBalance": 0,
          "endingDay": 0,
          "index": 0,
          "interestRate": 0
        }
      ],
      "interestSpread": 0
    },
    "lastAccountAppraisalDate": "string",
    "lastInterestCalculationDate": "string",
    "lastInterestStoredDate": "string",
    "lastModifiedDate": "string",
    "lastOverdraftInterestReviewDate": "string",
    "lastSetToArrearsDate": "string",
    "lineOfCreditKey": "string",
    "lockedBalance": 0,
    "lockedDate": "string",
    "maturityDate": "string",
    "maxWidthdrawlAmount": 0,
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "name": "string",
    "notes": "string",
    "overdraftAmount": 0,
    "overdraftExpiryDate": "string",
    "overdraftExpiryDateDTO": {
      "dayOfMonth": 0,
      "monthOfYear": 0,
      "year": 0
    },
    "overdraftInterestAccrued": 0,
    "overdraftInterestSettings": {
      "accrueInterestAfterMaturity": true,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestChargeFrequencyCount": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "TIERED_PERIOD",
      "interestRateTiers": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingBalance": 0,
          "endingDay": 0,
          "index": 0,
          "interestRate": 0
        }
      ],
      "interestSpread": 0
    },
    "overdraftLimit": 0,
    "productTypeKey": "string",
    "recommendedDepositAmount": 0,
    "targetAmount": 0,
    "technicalInterestDue": 0,
    "technicalOverdraftAmount": 0,
    "technicalOverdraftInterestAccrued": 0,
    "withholdingTaxSourceKey": "string"
  }
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	JSONSavingsAccountApiV1

patch-savings-savingsAccountId-custominformation

PATCH /savings/{savingsAccountId}/custominformation

Update custom field values

Update custom field values.

Example Requests

Update a single custom field value

{
  "customInformation": [
    {
      "customFieldID": "custom_field_2",
      "value": "3"
    }
  ]
}

Update a field in a group

{
  "customInformation": [
    {
      "customFieldID": "cf_grouped_field",
      "value": "new value",
      "customFieldSetGroupIndex": "0"
    }
  ]
}

Update multiple custom field values

{
  "customInformation": [
    {
      "customFieldID": "cf_grouped_field_2",
      "value": "3",
      "customFieldSetGroupIndex": "0"
    },
    {
      "customFieldID": "field_3",
      "value": "divorced"
    }
  ]
}

Parameters

Name	Type	Description	In
customInformation	[object]	none	body
» customFieldID (required)	string	none	body
» value (required)	string	none	body
» customFieldSetGroupIndex	string	Required if field to update is part of a group, if the Field Set Group Index is not set, a new group will be created with the value provided.	body
savingsAccountId (required)	string	The ID of the savingsAccount	path

Example Responses

200 : OK
success response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

get-savings-savingsAccountId-custominformation-customFieldId

GET /savings/{savingsAccountId}/custominformation/{customFieldId}

Get a custom field definition for a savings account

Allows retrieving a custom field definition for a given savings account directly by the ID/key of the savingsAccount and the ID/key of the custom field definition.

Parameters

Name	Type	Description	In
savingsAccountId (required)	string	The ID of the savingsAccount.	path
customFieldId (required)	string	The ID of the custom field definition.	path

Example Responses

200 : OK
A custom field definition

[
  {
    "encodedKey": "8a19cd6f74674df9017467f25aab02c6",
    "parentKey": "8a193c26722b51b701722d779e7122de",
    "customFieldKey": "8a19cd6f74674df9017467ef8e6802af",
    "customField": {
      "encodedKey": "8a19cd6f74674df9017467ef8e6802af",
      "id": "cf_savingsAccount",
      "creationDate": "2020-09-07T09:42:33+0000",
      "lastModifiedDate": "2020-09-07T09:42:33+0000",
      "name": "Example Custom Field Definition",
      "type": "BRANCH_INFO",
      "dataType": "CHECKBOX",
      "valueLength": "SHORT",
      "isDefault": false,
      "isRequired": false,
      "description": "an example of a checkbox custom field definition",
      "customFieldSet": {
        "encodedKey": "8a19cd6f74674df9017467ef8e6802ae",
        "id": "_example_savingsAccount_custom_field_set",
        "name": "example savingsAccount custom field set",
        "notes": "example custom field set",
        "createdDate": "2020-09-07T09:41:50+0000",
        "lastModifiedDate": "2020-09-07T09:41:50+0000",
        "indexInList": 2,
        "type": "BRANCH_INFO",
        "usage": "SINGLE"
      },
      "indexInList": 0,
      "state": "NORMAL",
      "customFieldSelectionOptions": [],
      "viewRights": {
        "encodedKey": "8a19cd6f74674df9017467ef8e6802b0",
        "isAccessibleByAllUsers": false,
        "roles": []
      },
      "editRights": {
        "encodedKey": "8a19cd6f74674df9017467ef8e6802b1",
        "isAccessibleByAllUsers": false,
        "roles": []
      },
      "unique": false,
      "values": [],
      "amounts": {}
    },
    "value": "TRUE",
    "indexInList": -1,
    "customFieldID": "cf_savingsAccount",
    "customFieldSetGroupIndex": -1
  }
]

404 : Not Found
not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	CustomFieldApiV1
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

patch-savings-savingsAccountId-custominformation-customFieldId

PATCH /savings/{savingsAccountId}/custominformation/{customFieldId}

Update a custom field value for a savings account

Update a custom field value for a savings account

Example Requests

{
  "value": "string"
}

Parameters

Name	Type	Description	In
value	string	none	body
savingsAccountId (required)	string	The ID of the savingsAccount.	path
customFieldId (required)	string	The ID of the custom field definition.	path

Example Responses

200 : OK
example-1

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
field is part of a group

{
  "returnCode": 916,
  "returnStatus": "INVALID_CUSTOM_FIELD_GROUP_INDEX",
  "errorSource": "cf_group_field_2"
}

404 : Not Found
not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

delete-savings-savingsAccountId-custominformation-customFieldId

DELETE /savings/{savingsAccountId}/custominformation/{customFieldId}

Delete a single custom field value

Parameters

Name	Type	Description	In
savingsAccountId (required)	string	The ID of the savingsAccount.	path
customFieldId (required)	string	The ID of the custom field definition.	path

Example Responses

200 : OK
success response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
field is part of a group

{
  "returnCode": 916,
  "returnStatus": "INVALID_CUSTOM_FIELD_GROUP_INDEX",
  "errorSource": "cf_group_field_2"
}

404 : Not Found
not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	string	none	none
» returnStatus	string	none	none

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

patch-savings-savingsAccountId-custominformation-customFieldId-customFieldGroupSetIndex

PATCH /savings/{savingsAccountId}/custominformation/{customFieldId}/{customFieldGroupSetIndex}

Update grouped custom field value

Update custom field value, which is part of a group

Example Requests

{
  "value": "string"
}

Parameters

Name	Type	Description	In
value	string	none	body
savingsAccountId (required)	string	The ID of the savingsAccount	path
customFieldId (required)	string	The ID of the custom field definition.	path
customFieldGroupSetIndex (required)	string	none	path

Example Responses

200 : OK
success response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
wrong group index provided

{
  "returnCode": 916,
  "returnStatus": "INVALID_CUSTOM_FIELD_GROUP_INDEX",
  "errorSource": "cf_group_field_2"
}

404 : Not Found
field not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

delete-savings-savingsAccountId-custominformation-customFieldId-customFieldGroupSetIndex

DELETE /savings/{savingsAccountId}/custominformation/{customFieldId}/{customFieldGroupSetIndex}

Delete grouped custom field value

Delete a custom field value, which is part of a group

Parameters

Name	Type	Description	In
savingsAccountId (required)	string	The ID of the savingsAccount	path
customFieldId (required)	string	The ID of the custom field definition.	path
customFieldGroupSetIndex (required)	string	none	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Get populated Document Template for Savings Account

GET /savings/{savingsAccountId}/templates/{templateId}

Allows you to get the raw HTML, as a string, of any document template associated with this savings deposit product with all placeholders populated with data for this account.

As ACCOUNT_WITH_TRANSACTIONS templates include placeholders for Transaction History you must supply a start and end date for your request. Note that any transcations between 00:00:00 on the start date and 23:59:59 of the end date will be considered when populating the template.

Parameters

Name	Type	Description	In
endDate	DateTime	The last date to consider when the document contains a list of transactions. Required when documents contain a transaction history. Format YYYY-MM-DD	query
startDate	DateTime	The first date to consider when the document contains a list of transcations. Required when documents contain a transaction history. Format YYYY-MM-DD	query
savingsAccountId (required)	string	The ID of the Savings Account	path
templateId (required)	string	The ID of the template you want to populate	path

Example Responses

200 Response

"string"

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	string

Get Comments (Savings Account)

GET /savings/{savingsAccountId}/comments

Get all Savings Account comments

Get all comments for a Savings Account

Parameters

Name	Type	Description	In
limit	string	none	query
offset	string	none	query
savingsAccountId (required)	string	the ID of the Savings Account	path

Example Responses

200 : OK
an array of comments

[
  {
    "encodedKey": "8a19b7057471f4af017472dc0fd80470",
    "parentKey": "8a193c26722b51b701722d77c5e423b7",
    "userKey": "8a194075720ece2c017226fced6f005e",
    "creationDate": "2020-09-09T14:24:42+0000",
    "lastModifiedDate": "2020-09-09T14:24:42+0000",
    "text": "aanother afmaefomaef<div><br /></div><div><u>aefaefaf</u></div><div><u><br /></u></div><div><u>afaef</u></div>"
  },
  {
    "encodedKey": "8a193c26722b51b701722d77c8bf25ab",
    "parentKey": "8a193c26722b51b701722d77c5e423b7",
    "creationDate": "2020-05-19T15:05:24+0000",
    "lastModifiedDate": "2020-05-19T15:05:24+0000",
    "text": "Should suggest she apply for the agriculture loan given the nature of their business"
  }
]

400 : Bad Request
bad Savings Account ID

{
  "returnCode": 149,
  "returnStatus": "INVALID_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[CommentApiV1]	none	none
» creationDate	string(date-time)	the date and time at which this comment was added	none
» encodedKey	string	a unique key for this comment	none
» lastModifiedDate	string(date-time)	the date and time at which this comment was last modified	none
» parentKey	string	the unique key of the parent object for this comment, for example, the client or loan account to which it relates	none
» text	string	the text of the comment as a string, must be properly JSON escpaped if it contains special characters	none
» userKey	string	the unique key of the user who created the comment	none

Create new Comment (Savings Account)

POST /savings/{savingsAccountId}/comments

Create a Savings Account Comment

Create new comment for a savings account

Example Requests

a comment

{
  "comment": {
    "text": "this is a comment with \" \" all kinds of : \\ / \"non compliant\" stuff & = which has been JSON escaped"
  }
}

Parameters

Name	Type	Description	In
comment	object	an object contining the comment	body
» text	string	text of the comment to be added. if adding complex content make sure it is properly JSON encoded before making your request	body
savingsAccountId (required)	string	the ID of the Savings Account	path

Example Responses

200 : OK
a comment

{
  "encodedKey": "8a19c34574720f9e0174734a039f06e2",
  "parentKey": "8a193c26722b51b701722d77c5e423b7",
  "userKey": "8a194075720ece2c017226fced6f005e",
  "creationDate": "2020-09-09T14:39:36+0000",
  "lastModifiedDate": "2020-09-09T14:39:36+0000",
  "text": "this is a comment with \" \" all kinds of : \\ / non compliant stuff & = which has been JSON escaped"
}

400 : Bad Request
extra parameters in the request

{
  "returnCode": 27,
  "returnStatus": "PARAMETER_NOT_ALLOWED"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	CommentApiV1
`400`	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Description	Restrictions
» returnCode	string	none	none
» returnStatus	string	none	none

Get Documents (savings account)

GET /savings/{savingsAccountId}/documents

Get all Savings Account Documents

Get all documents relating to a given savings account

Parameters

Name	Type	Description	In
offset	integer	start at index x. use with `limit` parameter to achieve pagination	query
limit	integer	max number of results to return	query
savingsAccountId (required)	string	the ID of the savings account	path

Example Responses

200 : ok
an array of documents

[
  {
    "encodedKey": "8a19c035747bf5b901747c77d78e01c4",
    "id": 53,
    "creationDate": "2020-09-11T11:39:33+0000",
    "lastModifiedDate": "2020-09-11T11:39:33+0000",
    "documentHolderKey": "8a19b6e4746cc6ed01746cf1436c00c5",
    "documentHolderType": "SAVINGS_ACCOUNT",
    "name": "file for savings account",
    "type": "png",
    "fileSize": 8258,
    "originalFilename": "Screenshot_2020-04-22_at_14.31.29.png",
    "location": "FCLRPXHUTCXURCALXAIFESFUURNUBR",
    "description": "a file attached to a savings account",
    "createdByUserKey": "8a194075720ece2c017226fced6f005e",
    "userName": "big chief",
    "documentHolder": {
      "type": "SAVINGS",
      "holderKey": "8a193c26722b51b701722d77c5e423b7",
      "accountHolderType": "CLIENT",
      "encodedKey": "8a19b6e4746cc6ed01746cf1436c00c5",
      "displayName": "BLBE564"
    }
  },
  {
    "encodedKey": "8a19a3337476f2d00174775b6a3001b0",
    "id": 44,
    "creationDate": "2020-09-10T09:34:51+0000",
    "lastModifiedDate": "2020-09-10T09:34:51+0000",
    "documentHolderKey": "8a19b6e4746cc6ed01746cf1436c00c5",
    "documentHolderType": "SAVINGS_ACCOUNT",
    "name": "savings acc doc",
    "type": "png",
    "fileSize": 15028,
    "originalFilename": "additional_reading_callout.png",
    "location": "UTOLWAEQURRYFNBIPNUXXFEXBCPKQR",
    "description": "desc savings acc doc",
    "createdByUserKey": "8a194075720ece2c017226fced6f005e",
    "userName": "mayor mcbacon",
    "documentHolder": {
      "type": "SAVINGS",
      "holderKey": "8a193c26722b51b701722d77c5e423b7",
      "accountHolderType": "CLIENT",
      "encodedKey": "8a19b6e4746cc6ed01746cf1436c00c5",
      "displayName": "BLBE564"
    }
  }
]

400 : Bad Request
Bad Loan Account ID

{
  "returnCode": 4,
  "returnStatus": "INVALID_PARAMETERS",
  "errorSource": "wrong owner id"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[DocumentForAccountApiV1]	none	none
» DocumentForAccountApiV1	DocumentForAccountApiV1	none	none
»» createdByUserKey	string	the encoded key of the Mambu user who added the document	none
»» creationDate	string	the date and time when this document was created	none
»» description	string	a description of this document	none
»» documentHolder	DocumentHolderAccountApiV1	none	none
»»» accountHolderType	string	the type of entity that owns the document	none
»»» displayName	string	the ID of the account to which the document relates	none
»»» encodedKey	string	the encoded key of the account to which the document relates	none
»»» holderkey	string	the encoded key of the document owner	none
»»» type	string	the type of account that the document belongs to	none
»» documentHolderKey	string	the encoded key of the owner of this document, for exmaple, the client or group	none
»» documentHolderType	string	the type of entity to which this document belongs, ie savings or loan account	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» fileSize	string	the size, in bytes, of this document	none
»» id	string	the document ID	none
»» lastModifiedDate	string	the date on which this document was last modified	none
»» location	string	the location where this document is stored	none
»» name	string	the name of the document, if provided	none
»» originalFilename	string	the original name of the uploaded file	none
»» type	string	the file type of the document, eg. PDF, PNG, JPEG	none
»» userName	string	the name of the Mambu user who originally uploaded the document	none

Enumerated Values

Property	Value
accountHolderType	`CLIENT`
accountHolderType	`GROUP`
type	`LOAN`
type	`SAVINGS`
documentHolderType	`SAVINGS_ACCOUNT`
documentHolderType	`LOAN_ACCOUNT`

Attach new Document (savings account)

POST /savings/{savingsAccountId}/documents

Attach new Document to Savings Account

Attach a new document to a savings account

Example Requests

{
  "document": {
    "description": "string",
    "documentHolderKey": "string",
    "documentHolderType": "CLIENT",
    "name": "string",
    "type": "PDF"
  },
  "documentContent": "string"
}

Parameters

Name	Type	Description	In
body	CreateDocumentApiV1	a new document to be attached to an entity	body
savingsAccountId (required)	string	the ID of the savings account	path

Example Responses

201 : Created
uploaded document details

{
  "encodedKey": "8a19c035747bf5b901747c77d78e01c6",
  "id": 54,
  "creationDate": "2020-09-11T11:51:21+0000",
  "lastModifiedDate": "2020-09-11T11:51:21+0000",
  "documentHolderKey": "8a19b6e4746cc6ed01746cf1436c00c5",
  "documentHolderType": "SAVINGS_ACCOUNT",
  "name": "some other image",
  "type": "png",
  "fileSize": 32109,
  "originalFilename": "some_other_image.png",
  "location": "NCYBXXEJCZBQVHAEAJTPITEGUBVXRO",
  "description": "this is another image file",
  "createdByUserKey": "8a194075720ece2c017226fced6f005e"
}

400 : Bad Request
file type does not match content

{
  "returnCode": 973,
  "returnStatus": "INCONSISTENT_EXTENSION_WITH_FILE_CONTENT",
  "errorSource": "Invalid extension with file content"
}

404 : Not Found
documentHolderKey does not point to a real Account

{
  "returnCode": 29,
  "returnStatus": "OBJECT_NOT_FOUND",
  "errorSource": "Could not find object"
}

Responses

Status	Meaning	Description	Schema
`201`	Created	Created	DocumentApiV1
`400`	Bad Request	Bad Request	ExecutionStatusApiV1
`404`	Not Found	Not Found	ExecutionStatusApiV1

Get Document by ID (savings account)

GET /savings/{savingsAccountId}/documents/{documentId}

Get a Savings Account Document

Get a document attached to a savings account by its ID

Parameters

Name	Type	Description	In
savingsAccountId (required)	string	the ID of the savings account	path
documentId (required)	string	the ID of the document	path

Example Responses

200 : OK
a base64 encoded document

"iVBORw0KGgoAAAANSUhEUgAAAnYAAAF0CAYAAACudHRvAAABQGlDQ1BJQ0MgUHJvZmlsZQAAKJFjYGASSCwoyGFhYGDIzSspCnJ3UoiIjFJgf8zAzcDGwMmgyqCZmFxc4BgQ4ANUwgCjUcG3awyMIPqyLsisf+0bZndFf1ridW7vst321p2Y6lEAV0pqcTKQ/gPEickFRSUMDIwJQLZyeUkBiN0CZIsUAR0FZM8AsdMh7DUgdhKEfQCsJiTIGci=="

400 : Bad Request
bad document ID

{
  "returnCode": 970,
  "returnStatus": "INVALID_DOCUMENT_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	string
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Delete Document (savings account)

DELETE /savings/{savingsAccountId}/documents/{documentId}

Delete Savings Account Document

Delete a savings account document

Parameters

Name	Type	Description	In
savingsAccountId (required)	string	the ID of the savings account	path
documentId (required)	string	the ID of the document	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

404 : Not Found
bad Document ID

{
  "returnCode": 970,
  "returnStatus": "INVALID_DOCUMENT_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	ExecutionStatusApiV1
`404`	Not Found	Not Found	ExecutionStatusApiV1

Get repayments due from savings account

GET /savings/{savingsAccountId}/funding/{loanAccountId}/repayments

get all repayments due from a savings account when it is being used to fund a loan

Parameters

Name	Type	Description	In
undefined	string	none	query
savingsAccountId (required)	string	ID or encoded key of the savings account	path
loanAccountId (required)	string	ID of the loan account	path

Example Responses

200 Response

[
  {
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "customSettings": [
      {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "loanTransactionKey": "string",
        "source": "CENTRE_MEETING_DAY_CHANGED",
        "type": "CUSTOM_ADDED_INSTALLMENT"
      }
    ],
    "dueDate": "string",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "feesAppliedDue": 0,
    "feesDue": 0,
    "feesPaid": 0,
    "feesUnappliedDue": 0,
    "fundersInterestDue": 0,
    "index": 0,
    "interestDue": 0,
    "interestPaid": 0,
    "lastPaidDate": "string",
    "lastPenaltyAppliedDate": "string",
    "notes": "string",
    "organizationCommissionDue": 0,
    "parentAccountKey": "string",
    "penaltyDue": 0,
    "penaltyPaid": 0,
    "principalDue": 0,
    "principalPaid": 0,
    "repaidDate": "string",
    "repaymentUnappliedFeeDetails": [
      {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "feeDue": 0,
        "indexInList": 0,
        "predefinedFeeKey": "string",
        "repaymentKey": "string",
        "taxOnFeeDue": 0
      }
    ],
    "state": "PARTIALLY_PAID",
    "taxFeesDue": 0,
    "taxFeesPaid": 0,
    "taxInterestDue": 0,
    "taxInterestPaid": 0,
    "taxPenaltyDue": 0,
    "taxPenaltyPaid": 0
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[RepaymentApiV1]	none	none
» assignedBranchKey	string	none	none
» assignedCentreKey	string	none	none
» assignedUserKey	string	none	none
» customSettings	[CustomRepaymentSettingsApiV1]	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» loanTransactionKey	string	the encoded key of the transaction that used these custom settings	none
»» source	string	the reason for these custom settings being created	none
»» type	string	the settings which were customised	none
» dueDate	string	none	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» feesAppliedDue	number	none	none
» feesDue	number	none	none
» feesPaid	number	none	none
» feesUnappliedDue	number	none	none
» fundersInterestDue	number	none	none
» index	number	none	none
» interestDue	number	none	none
» interestPaid	number	none	none
» lastPaidDate	string	none	none
» lastPenaltyAppliedDate	string	none	none
» notes	string	none	none
» organizationCommissionDue	number	none	none
» parentAccountKey	string	none	none
» penaltyDue	number	none	none
» penaltyPaid	number	none	none
» principalDue	number	none	none
» principalPaid	number	none	none
» repaidDate	string	none	none
» repaymentUnappliedFeeDetails	[RepaymentUnappliedFeeDetailsApiV1]	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» feeDue	number	none	none
»» indexInList	number	none	none
»» predefinedFeeKey	string	none	none
»» repaymentKey	string	none	none
»» taxOnFeeDue	number	none	none
» state	string	none	none
» taxFeesDue	number	none	none
» taxFeesPaid	number	none	none
» taxInterestDue	number	none	none
» taxInterestPaid	number	none	none
» taxPenaltyDue	number	none	none
» taxPenaltyPaid	number	none	none

Enumerated Values

Property	Value
source	`CENTRE_MEETING_DAY_CHANGED`
source	`INTEREST_APPLIED`
source	`INSTALLMENT_GRACED_NON_NATIVELY`
source	`INSTALLMENT_PAID`
source	`USER_INPUT`
type	`CUSTOM_ADDED_INSTALLMENT`
type	`CUSTOM_PRINCIPAL`
type	`CUSTOM_DUE_DATE`
state	`PARTIALLY_PAID`
state	`LATE`
state	`GRACE`
state	`PAID`
state	`PENDING`

Get accounts funded by Savings Account

GET /savings/{savingsAccountId}/funding

Get information on accounts (generally loan accounts) that are funded by this savings account.

Parameters

Name	Type	Description	In
savingsAccountId (required)	string	The savings account ID or encoded key.	path

Example Responses

200 Response

[
  {
    "accountArrearsSettings": {
      "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
      "encodedKey": "string",
      "monthlyToleranceDay": 0,
      "nonWorkingDaysMethod": "EXCLUDED",
      "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY",
      "toleranceFloorAmount": 0,
      "tolerancePercentageOfOutstandingPrincipal": 0,
      "tolerancePeriod": 0
    },
    "accountHolderKey": "string",
    "accountHolderType": "GROUP",
    "accountState": "WITHDRAWN",
    "accountSubState": "WITHDRAWN",
    "accrueInterestAfterMaturity": true,
    "accrueLateInterest": true,
    "accruedInterest": 0,
    "accruedPenalty": 0,
    "activationTransactionKey": "string",
    "allowOffset": true,
    "applyInterestOnPrepaymentMethod": "AUTOMATIC",
    "approvedDate": "string",
    "arrearsTolerancePeriod": 0,
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "closedDate": "string",
    "creationDate": "string",
    "customFieldValues": [
      {
        "amount": 0,
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "customFieldID": "string",
        "customFieldKey": "string",
        "customFieldSetGroupIndex": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexInList": 0,
        "linkedEntityKeyValue": "string",
        "parentKey": "string",
        "selectionKey": "string",
        "value": "string"
      }
    ],
    "daysInArrears": 0,
    "defaultFirstRepaymentDueDateOffset": 0,
    "disbursementDetails": {
      "customInformation": [
        {
          "amount": 0,
          "customField": {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "customFieldID": "string",
          "customFieldKey": "string",
          "customFieldSetGroupIndex": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "linkedEntityKeyValue": "string",
          "parentKey": "string",
          "selectionKey": "string",
          "value": "string"
        }
      ],
      "disbursementDate": "string",
      "encodedKey": "string",
      "expectedDisbursementDate": "string",
      "fees": [
        {
          "amount": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "fee": {
            "active": true,
            "amortizationIntervalSettings": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
              "intervalCount": 0,
              "intervalType": "FULL_TERM",
              "periodCount": 0,
              "periodUnit": "MONTHS"
            },
            "amortizationProfile": "STRAIGHT_LINE",
            "amount": 0,
            "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
            "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
            "creationDate": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
            "feeApplication": "OPTIONAL",
            "feeProductRules": [
              {
                "account": {
                  "activated": true,
                  "allowManualJournalEntries": true,
                  "balance": 0,
                  "creationDate": "2019-08-24T14:15:22Z",
                  "currency": {
                    "code": "string",
                    "creationDate": "string",
                    "currencySymbolPosition": "AFTER_NUMBER",
                    "digitsAfterDecimal": 0,
                    "isBaseCurrency": true,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "symbol": "string"
                  },
                  "description": "string",
                  "encodedKey": "string",
                  "glCode": "string",
                  "lastModifiedDate": "2019-08-24T14:15:22Z",
                  "migrationEvent": {
                    "creationDate": "2019-08-24T14:15:22Z",
                    "encodedKey": "string",
                    "numCentresImported": 0,
                    "numClientsImported": 0,
                    "numGLAccountsImported": 0,
                    "numGroupsImported": 0,
                    "numLoanRepaymentsImported": 0,
                    "numLoanTransactionsImported": 0,
                    "numLoansImported": 0,
                    "numSavingsImported": 0,
                    "state": "REVERTED",
                    "type": "IMPORT"
                  },
                  "name": "string",
                  "stripTrailingZeros": true,
                  "type": "INCOME",
                  "usage": "HEADER"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "financialResource": "FEE_RECEIVABLE",
                "index": 0,
                "predefinedFeeKey": "string",
                "productKey": "string",
                "productType": "LOAN",
                "transactionChannelKey": "string"
              }
            ],
            "name": "string",
            "percentageAmount": 0,
            "trigger": "DISBURSEMENT"
          }
        }
      ],
      "firstRepaymentDate": "string",
      "transactionDetails": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "internalTransfer": true,
        "targetSavingsAccountKey": "string",
        "transactionChannel": {
          "activated": true,
          "createdByUserKey": "string",
          "creationDate": "string",
          "customFields": [
            {
              "amounts": {
                "property1": 0,
                "property2": 0
              },
              "builtInCustomFieldId": "MOBILE_PHONE",
              "creationDate": "string",
              "customFieldProductSettings": [
                {
                  "customFieldEncodedKey": "string",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isDefault": true,
                  "isRequired": true,
                  "linkType": "CLIENT_ROLE",
                  "productKey": "string"
                }
              ],
              "customFieldSelectionOptions": [
                {
                  "constraint": {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "score": 0,
                  "value": "string"
                }
              ],
              "customFieldSet": {
                "builtInType": "DETAILS",
                "createdDate": "string",
                "customFields": [
                  {}
                ],
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "notes": "string",
                "type": "USER_INFO",
                "usage": "SINGLE"
              },
              "dataType": "GROUP_LINK",
              "description": "string",
              "editRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "isDefault": true,
              "isRequired": true,
              "lastModifiedDate": "string",
              "name": "string",
              "state": "DEACTIVATED",
              "type": "USER_INFO",
              "unique": true,
              "validationPattern": "string",
              "valueLength": "SHORT",
              "values": [
                "string"
              ],
              "viewRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            }
          ],
          "encodedKey": "string",
          "id": "string",
          "index": 0,
          "loanConstraints": {
            "customConfigurationInfo": {
              "creationDate": "string",
              "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "shared": true,
              "userKey": "string"
            },
            "encodedKey": "string",
            "filterConstraints": [
              {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              }
            ]
          },
          "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
          "name": "string",
          "savingsConstraints": {
            "customConfigurationInfo": {
              "creationDate": "string",
              "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "shared": true,
              "userKey": "string"
            },
            "encodedKey": "string",
            "filterConstraints": [
              {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              }
            ]
          },
          "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
          "transactionChannelAccountingRule": {
            "account": {
              "activated": true,
              "allowManualJournalEntries": true,
              "balance": 0,
              "creationDate": "2019-08-24T14:15:22Z",
              "currency": {
                "code": "string",
                "creationDate": "string",
                "currencySymbolPosition": "AFTER_NUMBER",
                "digitsAfterDecimal": 0,
                "isBaseCurrency": true,
                "lastModifiedDate": "string",
                "name": "string",
                "symbol": "string"
              },
              "description": "string",
              "encodedKey": "string",
              "glCode": "string",
              "lastModifiedDate": "2019-08-24T14:15:22Z",
              "migrationEvent": {
                "creationDate": "2019-08-24T14:15:22Z",
                "encodedKey": "string",
                "numCentresImported": 0,
                "numClientsImported": 0,
                "numGLAccountsImported": 0,
                "numGroupsImported": 0,
                "numLoanRepaymentsImported": 0,
                "numLoanTransactionsImported": 0,
                "numLoansImported": 0,
                "numSavingsImported": 0,
                "state": "REVERTED",
                "type": "IMPORT"
              },
              "name": "string",
              "stripTrailingZeros": true,
              "type": "INCOME",
              "usage": "HEADER"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "financialResource": "FEE_RECEIVABLE",
            "index": 0,
            "predefinedFeeKey": "string",
            "productKey": "string",
            "productType": "LOAN",
            "transactionChannelKey": "string"
          },
          "usageRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "transactionChannelKey": "string"
      }
    },
    "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "feesBalance": 0,
    "feesDue": 0,
    "feesPaid": 0,
    "fixedDaysOfMonth": [
      0
    ],
    "funds": [
      {
        "amount": 0,
        "assetName": "string",
        "customFieldValues": [
          {
            "amount": 0,
            "customField": {
              "amounts": {
                "property1": 0,
                "property2": 0
              },
              "builtInCustomFieldId": "MOBILE_PHONE",
              "creationDate": "string",
              "customFieldProductSettings": [
                {
                  "customFieldEncodedKey": "string",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isDefault": true,
                  "isRequired": true,
                  "linkType": "CLIENT_ROLE",
                  "productKey": "string"
                }
              ],
              "customFieldSelectionOptions": [
                {
                  "constraint": {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "score": 0,
                  "value": "string"
                }
              ],
              "customFieldSet": {
                "builtInType": "DETAILS",
                "createdDate": "string",
                "customFields": [
                  {}
                ],
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "notes": "string",
                "type": "USER_INFO",
                "usage": "SINGLE"
              },
              "dataType": "GROUP_LINK",
              "description": "string",
              "editRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "isDefault": true,
              "isRequired": true,
              "lastModifiedDate": "string",
              "name": "string",
              "state": "DEACTIVATED",
              "type": "USER_INFO",
              "unique": true,
              "validationPattern": "string",
              "valueLength": "SHORT",
              "values": [
                "string"
              ],
              "viewRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "customFieldID": "string",
            "customFieldKey": "string",
            "customFieldSetGroupIndex": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "linkedEntityKeyValue": "string",
            "parentKey": "string",
            "selectionKey": "string",
            "value": "string"
          }
        ],
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "guarantorKey": "string",
        "guarantorType": "GROUP",
        "id": "string",
        "interestCommission": 0,
        "investmentPercentage": 0,
        "savingsAccountKey": "string",
        "type": "GUARANTOR"
      }
    ],
    "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
    "gracePeriod": 0,
    "gracePeriodType": "PAY_INTEREST_ONLY",
    "guarantees": [
      {
        "amount": 0,
        "assetName": "string",
        "customFieldValues": [
          {
            "amount": 0,
            "customField": {
              "amounts": {
                "property1": 0,
                "property2": 0
              },
              "builtInCustomFieldId": "MOBILE_PHONE",
              "creationDate": "string",
              "customFieldProductSettings": [
                {
                  "customFieldEncodedKey": "string",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isDefault": true,
                  "isRequired": true,
                  "linkType": "CLIENT_ROLE",
                  "productKey": "string"
                }
              ],
              "customFieldSelectionOptions": [
                {
                  "constraint": {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "score": 0,
                  "value": "string"
                }
              ],
              "customFieldSet": {
                "builtInType": "DETAILS",
                "createdDate": "string",
                "customFields": [
                  {}
                ],
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "notes": "string",
                "type": "USER_INFO",
                "usage": "SINGLE"
              },
              "dataType": "GROUP_LINK",
              "description": "string",
              "editRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "isDefault": true,
              "isRequired": true,
              "lastModifiedDate": "string",
              "name": "string",
              "state": "DEACTIVATED",
              "type": "USER_INFO",
              "unique": true,
              "validationPattern": "string",
              "valueLength": "SHORT",
              "values": [
                "string"
              ],
              "viewRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "customFieldID": "string",
            "customFieldKey": "string",
            "customFieldSetGroupIndex": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "linkedEntityKeyValue": "string",
            "parentKey": "string",
            "selectionKey": "string",
            "value": "string"
          }
        ],
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "guarantorKey": "string",
        "guarantorType": "GROUP",
        "savingsAccountKey": "string",
        "type": "GUARANTOR"
      }
    ],
    "hasCustomSchedule": true,
    "holdBalance": 0,
    "id": "string",
    "interestApplicationMethod": "ON_REPAYMENT",
    "interestBalance": 0,
    "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
    "interestCalculationMethod": "DECLINING_BALANCE",
    "interestChargeFrequency": "EVERY_WEEK",
    "interestCommission": 0,
    "interestDue": 0,
    "interestFromArrearsAccrued": 0,
    "interestFromArrearsBalance": 0,
    "interestFromArrearsDue": 0,
    "interestFromArrearsPaid": 0,
    "interestPaid": 0,
    "interestRate": 0,
    "interestRateReviewCount": 0,
    "interestRateReviewUnit": "MONTHS",
    "interestRateSource": "FIXED_INTEREST_RATE",
    "interestRoundingVersion": "VERSION_2",
    "interestSpread": 0,
    "interestType": "CAPITALIZED_INTEREST",
    "lastAccountAppraisalDate": "string",
    "lastInterestAppliedDate": "string",
    "lastInterestReviewDate": "string",
    "lastLockedDate": "string",
    "lastModifiedDate": "string",
    "lastSetToArrearsDate": "string",
    "lastTaxRateReviewDate": "string",
    "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
    "lineOfCreditKey": "string",
    "loanAmount": 0,
    "loanGroup": {
      "accounts": [
        {}
      ],
      "creationDate": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "group": {
        "assignedBranchKey": "string",
        "assignedCentreKey": "string",
        "assignedUserKey": "string",
        "clientRole": {
          "encodedKey": "string"
        },
        "creationDate": "2019-08-24T14:15:22Z",
        "emailAddress": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "groupName": "string",
        "homePhone": "string",
        "id": "string",
        "idPattern": "string",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "loanCycle": 0,
        "migrationEvent": {
          "creationDate": "2019-08-24T14:15:22Z",
          "encodedKey": "string",
          "numCentresImported": 0,
          "numClientsImported": 0,
          "numGLAccountsImported": 0,
          "numGroupsImported": 0,
          "numLoanRepaymentsImported": 0,
          "numLoanTransactionsImported": 0,
          "numLoansImported": 0,
          "numSavingsImported": 0,
          "state": "REVERTED",
          "type": "IMPORT"
        },
        "mobilePhone1": "string",
        "preferredLanguage": "PORTUGESE"
      },
      "lastModifiedDate": "string",
      "name": "string",
      "notes": "string"
    },
    "loanName": "string",
    "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
    "lockedOperations": [
      "APPLY_FEES"
    ],
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "notes": "string",
    "originalAccountKey": "string",
    "paymentMethod": "VERTICAL",
    "paymentPlan": [
      {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "endingInstallmentPosition": 0,
        "index": 0,
        "loanAccountEncodedKey": "string",
        "pmt": 0
      }
    ],
    "penaltyBalance": 0,
    "penaltyDue": 0,
    "penaltyPaid": 0,
    "penaltyRate": 0,
    "periodicPayment": 0,
    "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
    "prepaymentRecalculationMethod": "NO_RECALCULATION",
    "principalBalance": 0,
    "principalDue": 0,
    "principalPaid": 0,
    "principalPaidInstallmentStatus": "PARTIALLY_PAID",
    "principalPaymentSettings": {
      "amount": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "includeFeesInFloorAmount": true,
      "includeInterestInFloorAmount": true,
      "percentage": 0,
      "principalCeilingValue": 0,
      "principalFloorValue": 0,
      "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
    },
    "principalRepaymentInterval": 0,
    "productTypeKey": "string",
    "redrawBalance": 0,
    "redrawSettings": {
      "account": {},
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "restrictNextDueWithdrawal": true
    },
    "repaymentInstallments": 0,
    "repaymentPeriodCount": 0,
    "repaymentPeriodUnit": "MONTHS",
    "repaymentScheduleMethod": "FIXED",
    "rescheduledAccountKey": "string",
    "scheduleDueDatesMethod": "INTERVAL",
    "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
    "taxRate": 0,
    "tranches": [
      {
        "amount": 0,
        "disbursementTransactionKey": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "expectedDisbursementDate": "string",
        "index": 0
      }
    ]
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[LoanAccountApiV1]	none	none
» accountArrearsSettings	AccountArrearsSettingsApiV1	none	none
»» dateCalculationMethod	string	the method used to calculate arrears for an account	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» monthlyToleranceDay	number	none	none
»» nonWorkingDaysMethod	string	whether non-working days, such as holidays are included when calculating the number of days in arrears	none
»» toleranceCalculationMethod	string	none	none
»» toleranceFloorAmount	number	Used with the `tolerancePercentageOfOutstandingPrincipal` to set a minimum threshold that must be reached before an account will be set to 'in arrears'	none
»» tolerancePercentageOfOutstandingPrincipal	number	This setting will cause an account to automatically go into arrears if the amount due exceeds a given percentage of the loan amount remaining. Only available for fixed and dynamic term loans.	none
»» tolerancePeriod	number	the number of days a loan repayment can be late before the account will be automatically set to 'in arrears'.	none
» accountHolderKey	string	none	none
» accountHolderType	string	none	none
» accountState	string	none	none
» accountSubState	string	none	none
» accrueInterestAfterMaturity	boolean	none	none
» accrueLateInterest	boolean	none	none
» accruedInterest	number	none	none
» accruedPenalty	number	none	none
» activationTransactionKey	string	none	none
» allowOffset	boolean	none	none
» applyInterestOnPrepaymentMethod	string	none	none
» approvedDate	string	none	none
» arrearsTolerancePeriod	number	none	none
» assignedBranchKey	string	none	none
» assignedCentreKey	string	none	none
» assignedUserKey	string	none	none
» closedDate	string	none	none
» creationDate	string	the date and time when this loan account was created	none
» customFieldValues	[CustomFieldValueApiV1]	none	none
»» amount	number	none	none
»» customField	CustomFieldApiV1	none	none
»»» amounts	object	used when options available for a custom field definition translate to predefined amounts, for example, when the custom field value is used to generate a score	none
»»»» additionalProperties	number	none	none
»»» builtInCustomFieldId	string	if this field is one of the built in custom fiel definitions, this will have a value. These names are reserved and you can not use them for your own custom field definitions	none
»»» creationDate	string	the date on which this custom field definition was created	none
»»» customFieldProductSettings	[CustomFieldLinkApiV1]	none	none
»»»» customFieldEncodedKey	string	the key to the parent custom field definition	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isDefault	boolean	whether this field is displayed by default when creating a new record	none
»»»» isRequired	boolean	whether this field is required when creating a new record	none
»»»» linkType	string	the type of entity this field represents a link to	none
»»»» productKey	string	when the link type is product, this field should contain the encoded key of the linekd product	none
»»» customFieldSelectionOptions	[CustomFieldSelectionApiV1]	[represents a possible selection for select type custom field definitions]	none
»»»» constraint	CustomFilterConstraintApiV1	none	none
»»»»» customFieldKey	string	none	none
»»»»» dataFieldType	string	none	none
»»»»» dataFieldValue	string	none	none
»»»»» dataItemType	string	none	none
»»»»» dataType	string	none	none
»»»»» encodedKey	string	none	none
»»»»» filterElement	string	none	none
»»»»» groupNumber	number	none	none
»»»»» index	number	none	none
»»»»» linkingOperator	string	none	none
»»»»» secondValue	string	none	none
»»»»» value	string	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this selectable item	none
»»»» score	number	the score assigned to this selection	none
»»»» value	string	display name of this option	none
»»» customFieldSet	CustomFieldSetApiV1	none	none
»»»» builtInType	string	if this set is part of the set of built-in custom field sets, its type will be shown here	none
»»»» createdDate	string	the date and time when this custom field set was created	none
»»»» customFields	[CustomFieldApiV1]	an array of custom field definitions included in this custom field set	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this custom field set	none
»»»» indexInList	number	for field sets that can be added to an entity more than once, this number represents the index in the list and is used when changing values	none
»»»» lastModifiedDate	string	the date on which this custom field set was last modified	none
»»»» name	string	the name of this custom field set	none
»»»» notes	string	any notes regarding this custom field set	none
»»»» type	string	the entity type that this custom field definition is attached to	none
»»»» usage	string	whether this custom field set can only be used once, or added multiple times to the same entity	none
»»» dataType	string	the type of custom field definition	none
»»» description	string	a brief description of this custom field definition	none
»»» editRights	UsageRightsApiV1	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isAccessibleByAllUsers	boolean	none	none
»»»» roles	[string]	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» id	string	the ID for this custom field definition	none
»»» indexInList	number	none	none
»»» isDefault	boolean	whether this field will be included by default on new records	none
»»» isRequired	boolean	whether this field is required when creating a new record	none
»»» lastModifiedDate	string	the date on which this custom field definition was last modified	none
»»» name	string	the name of this custom field definition	none
»»» state	string	whether this field is available for use or has been deactivated	none
»»» type	string	the type of data this custom field definition will contain	none
»»» unique	boolean	whether the data in this custom field definition needs to be a unique value	none
»»» validationPattern	string	a user-provided pattern to which data in this custom field definition must conform where @ represents numbers, # represents letters and $ is either a number or letter. Other special characters used as separators are allowed, for example `@@-##-$$$`	none
»»» valueLength	string	whether this field needs to support a large number of characters	none
»»» values	[string]	a list of possible values when the field is a selection field	none
»»» viewRights	UsageRightsApiV1	none	none
»» customFieldID	string	none	none
»» customFieldKey	string	none	none
»» customFieldSetGroupIndex	number	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» indexInList	number	none	none
»» linkedEntityKeyValue	string	none	none
»» parentKey	string	none	none
»» selectionKey	string	none	none
»» value	string	none	none
» daysInArrears	number	none	none
» defaultFirstRepaymentDueDateOffset	number	none	none
» disbursementDetails	DisbursementDetailsApiV1	none	none
»» customInformation	[CustomFieldValueApiV1]	custom field definitions associated with this disbursement	none
»» disbursementDate	string	the date on which the loan was disbursed	none
»» encodedKey	string	the automatically generated ID for this disbursement	none
»» expectedDisbursementDate	string	the date on which this disbursement is expected to take place	none
»» fees	[CustomPredefinedFeeApiV1]	a list of fees associated with the disbursement	none
»»» amount	number	the amount of this fee	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» fee	PredefinedFeeApiV1	none	none
»»»» active	boolean	none	none
»»»» amortizationIntervalSettings	PeriodIntervalSettingsApiV1	none	none
»»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»»» frequency	string	none	none
»»»»» intervalCount	number	none	none
»»»»» intervalType	string	none	none
»»»»» periodCount	number	none	none
»»»»» periodUnit	string	none	none
»»»» amortizationProfile	string	none	none
»»»» amount	number	none	none
»»»» amountCalculationMethod	string	none	none
»»»» applyDateMethod	string	none	none
»»»» creationDate	string	the date and time when this fee was created	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» feeAmortizationUponRescheduleOption	string	none	none
»»»» feeApplication	string	none	none
»»»» feeProductRules	[GLAccountingRuleApiV1]	none	none
»»»»» account	GLAccountApiV1	A general ledger account	none
»»»»»» activated	boolean	whether this general ledger account is in use	none
»»»»»» allowManualJournalEntries	boolean	whether manual entries are allowed for this general ledger account	none
»»»»»» balance	number	the current balance of this general ledger account	none
»»»»»» creationDate	string(date-time)	the date on which this general ledger account was created	read-only
»»»»»» currency	CurrencyApiV1	none	none
»»»»»»» code	string	the three letter ISO code for this currency	none
»»»»»»» creationDate	string	the date on which this currency was created	none
»»»»»»» currencySymbolPosition	string	indicates where the currency symbol should appear in relation to the numeric value	none
»»»»»»» digitsAfterDecimal	number	indicates how many decimal places are allowed for this currency. For example, a currenncy with 100 minor units to 1 major unit, there will be 2 decimal places.	none
»»»»»»» isBaseCurrency	boolean	whether this currency is the base currency for your banking institution	none
»»»»»»» lastModifiedDate	string	the date on which this currency was last modified	none
»»»»»»» name	string	the name of this currency	none
»»»»»»» symbol	string	the currency symnbol used for this currency	none
»»»»»» description	string	an optional description for this general ledger account	none
»»»»»» encodedKey	string	the encoded key of this general ledger account	none
»»»»»» glCode	string	the numeric code for this general ledger account	none
»»»»»» lastModifiedDate	string(date-time)	the date on which this general ledger account was last modified	read-only
»»»»»» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
»»»»»»» creationDate	string(date-time)	the date on which the data import was made	none
»»»»»»» encodedKey	string	the encoded key of this data migration event	none
»»»»»»» numCentresImported	number	the number of centres which were imported during the data migration	none
»»»»»»» numClientsImported	number	the number of clients which were imported as part of the data migration	none
»»»»»»» numGLAccountsImported	number	the number of general ledger accounts which were imported as part of the data migration	none
»»»»»»» numGroupsImported	number	the number of groups which were imported as part of the data migration	none
»»»»»»» numLoanRepaymentsImported	number	the number of loan repayment transations which were imported as part of the data migration	none
»»»»»»» numLoanTransactionsImported	number	the number of loan transactions which were imported as part of the data migration	none
»»»»»»» numLoansImported	number	the number of loan accounts which were imported as part of the data migration	none
»»»»»»» numSavingsImported	number	the number of savings accounts which were imported as part of the data migration	none
»»»»»»» state	string	whether the data import was accepted, is still in a draft state, or was rejected and all data reverted	none
»»»»»»» type	string	the type of migration event	none
»»»»»» name	string	the name of this general ledger account	none
»»»»»» stripTrailingZeros	boolean	controls how this account is organized into header accounts when there are trailing zeroes, for example, for the account code `1100`, if this field is set to true, only the first two numbers will be recognised	none
»»»»»» type	string	the type of general ledger account	none
»»»»»» usage	string	whether this general ledger account is a `DETAIL` account, in which case it will have a value, or a `HEADER` account, in which case its value will be calculated based on the sum of detail accounts under it.	none
»»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»»» financialResource	string	the type of transaction governed by this rule	none
»»»»» index	number	the index in list when there are multiple rules for the same type of transaction	none
»»»»» predefinedFeeKey	string	the encoded key of the predefined key this rule relates to	none
»»»»» productKey	string	the encoded key of the product this rule relates to	none
»»»»» productType	string	the type of account this rule relates to	none
»»»»» transactionChannelKey	string	the encoded key of the transaction channel that this rule relates to	none
»»»» name	string	none	none
»»»» percentageAmount	number	none	none
»»»» trigger	string	none	none
»» firstRepaymentDate	string	the date of the first repayment for the loan	none
»» transactionDetails	TransactionDetailsApiV1	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» internalTransfer	boolean	none	none
»»» targetSavingsAccountKey	string	none	none
»»» transactionChannel	TransactionChannelInTransactionDetailsApiV1	none	none
»»»» activated	boolean	whether this transaction channel is enabled	none
»»»» createdByUserKey	string	the encoded key of the user who created this transaction channel	none
»»»» creationDate	string	the date on which this transaction channel was created	none
»»»» customFields	[CustomFieldApiV1]	none	none
»»»» encodedKey	string	the encoded key for this transaction channel	none
»»»» id	string	the user specified ID for this transaction channel	none
»»»» index	number	none	none
»»»» loanConstraints	CustomFilterApiV1	none	none
»»»»» customConfigurationInfo	CustomConfigurationInfoApiV1	none	none
»»»»»» creationDate	string	the date on which this configuration was created	none
»»»»»» dataViewType	string	the type of entity this configuration is for	none
»»»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»»»» indexInList	number	if more than one configuration exists for a given type, this is its index in the list	none
»»»»»» lastModifiedDate	string	the date on which this configuration was last modified	none
»»»»»» name	string	the name for this configuration	none
»»»»»» shared	boolean	whether this configuration is private or can be used by other users of the system	none
»»»»»» userKey	string	the encoded key of the Mambu user who created this configuration	none
»»»»» encodedKey	string	none	none
»»»»» filterConstraints	[CustomFilterConstraintApiV1]	none	none
»»»» loanConstraintsUsage	string	whether there are any rules regarding usage of this transaction channel with loan accounts	none
»»»» name	string	the name of this transaction channel	none
»»»» savingsConstraints	CustomFilterApiV1	none	none
»»»» savingsConstraintsUsage	string	whether there are any rules regarding usage of this transaction channel with savings accounts	none
»»»» transactionChannelAccountingRule	GLAccountingRuleApiV1	none	none
»»»» usageRights	UsageRightsApiV1	none	none
»»» transactionChannelKey	string	none	none
» elementsRecalculationMethod	string	none	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» feesBalance	number	none	none
» feesDue	number	none	none
» feesPaid	number	none	none
» fixedDaysOfMonth	[number]	none	none
» funds	[InvestorFundApiV1]	[An object containing information about people who may be acting as guarantor for a loan or collatoral being used, for more information please consult our p2p lending support article.]	none
»» amount	number	the amount being funded	none
»» assetName	string	the name of an asset being used as collatoral	none
»» customFieldValues	[CustomFieldValueApiV1]	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» guarantorKey	string	the encoded key of the client who is acting as guarantor	none
»» guarantorType	string	the type of guarantor, either a private individual or a group	none
»» id	string	the ID for this funding action	none
»» interestCommission	number	how much this funder shares in the interest generated by the loan	none
»» investmentPercentage	number	when the type of funding is `investor`, the percentage which will go back to them when repayments are made	none
»» savingsAccountKey	string	the savings account ID of the account being used to back a loan	none
»» type	string	the type of funder, either another client of the bank who is acting as guarantor, an asset being used as collatoral or an investor who shares in the interest generated by the loan	none
» futurePaymentsAcceptance	string	none	none
» gracePeriod	number	none	none
» gracePeriodType	string	none	none
» guarantees	[GuarantyApiV1]	none	none
»» amount	number	the amount being guaranteed	none
»» assetName	string	the name of the asset being used as a guranty	none
»» customFieldValues	[CustomFieldValueApiV1]	a list of custom information for this guranty	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» guarantorKey	string	the encoded key of the client acting as guarantor	none
»» guarantorType	string	the type of entity acting as gurantor, either client or group	none
»» savingsAccountKey	string	the encoded key of the savings account guranteeing the loan	none
»» type	string	the type of guarantor, either asset backed, an investor or private gurantor	none
» hasCustomSchedule	boolean	none	none
» holdBalance	number	none	none
» id	string	none	none
» interestApplicationMethod	string	none	none
» interestBalance	number	none	none
» interestBalanceCalculationMethod	string	none	none
» interestCalculationMethod	string	none	none
» interestChargeFrequency	string	none	none
» interestCommission	number	none	none
» interestDue	number	none	none
» interestFromArrearsAccrued	number	none	none
» interestFromArrearsBalance	number	none	none
» interestFromArrearsDue	number	none	none
» interestFromArrearsPaid	number	none	none
» interestPaid	number	none	none
» interestRate	number	none	none
» interestRateReviewCount	number	none	none
» interestRateReviewUnit	string	none	none
» interestRateSource	string	none	none
» interestRoundingVersion	string	none	none
» interestSpread	number	none	none
» interestType	string	none	none
» lastAccountAppraisalDate	string	none	none
» lastInterestAppliedDate	string	none	none
» lastInterestReviewDate	string	none	none
» lastLockedDate	string	none	none
» lastModifiedDate	string	the date on which this loan account was last modified	none
» lastSetToArrearsDate	string	none	none
» lastTaxRateReviewDate	string	none	none
» latePaymentsRecalculationMethod	string	none	none
» lineOfCreditKey	string	none	none
» loanAmount	number	none	none
» loanGroup	LoanGroupApiV1	none	none
»» accounts	[LoanAccountApiV1]	none	none
»» creationDate	string	the date and time when this group was created	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» group	GroupApiV1	A group object	none
»»» assignedBranchKey	string	the encoded key of the branch to which this group is assigned	none
»»» assignedCentreKey	string	the encoded key of the centre to which this group is assigned	none
»»» assignedUserKey	string	the encoded key of the Mambu user to which this group is assigned	none
»»» clientRole	ClientRoleBasicApiV1	the type of client or group as defined in Mambu in Administration > General Settings > Client Types	none
»»»» encodedKey	string	the automatically generated encoded ID for this client or group type	none
»»» creationDate	string(date-time)	the date and time when this group was created	read-only
»»» emailAddress	string	the email address for this group. This address will be used for automated and manually sent email notifications	none
»»» encodedKey	string	the automatically generated encoded ID for this group	none
»»» groupName	string	the name of the group	none
»»» homePhone	string	the primary landline contact number for this group	none
»»» id	string	the ID for this group	none
»»» idPattern	string	the pattern used to generate IDs	none
»»» lastModifiedDate	string(date-time)	the date on which this group was last modified	read-only
»»» loanCycle	number	this number will increment each time this group takes out and fully pays back a loan	none
»»» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
»»» mobilePhone1	string	the primiary mobile contact number for this group	none
»»» preferredLanguage	string	the language which shoudl ideally be used when communicating with this group	none
»» lastModifiedDate	string	the date on which this group was last modified	none
»» name	string	none	none
»» notes	string	none	none
» loanName	string	none	none
» loanPenaltyCalculationMethod	string	none	none
» lockedOperations	[string]	none	none
» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
» notes	string	none	none
» originalAccountKey	string	none	none
» paymentMethod	string	none	none
» paymentPlan	[PeriodicPaymentApiV1]	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» endingInstallmentPosition	number	none	none
»» index	number	none	none
»» loanAccountEncodedKey	string	none	none
»» pmt	number	none	none
» penaltyBalance	number	none	none
» penaltyDue	number	none	none
» penaltyPaid	number	none	none
» penaltyRate	number	none	none
» periodicPayment	number	none	none
» prepaymentAcceptance	string	none	none
» prepaymentRecalculationMethod	string	none	none
» principalBalance	number	none	none
» principalDue	number	none	none
» principalPaid	number	none	none
» principalPaidInstallmentStatus	string	none	none
» principalPaymentSettings	PrincipalPaymentAccountSettingsApiV1	none	none
»» amount	number	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» includeFeesInFloorAmount	boolean	none	none
»» includeInterestInFloorAmount	boolean	none	none
»» percentage	number	none	none
»» principalCeilingValue	number	none	none
»» principalFloorValue	number	none	none
»» principalPaymentMethod	string	none	none
» principalRepaymentInterval	number	none	none
» productTypeKey	string	none	none
» redrawBalance	number	none	none
» redrawSettings	LoanAccountRedrawSettingsApiV1	none	none
»» account	LoanAccountApiV1	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» restrictNextDueWithdrawal	boolean	none	none
» repaymentInstallments	number	none	none
» repaymentPeriodCount	number	none	none
» repaymentPeriodUnit	string	none	none
» repaymentScheduleMethod	string	none	none
» rescheduledAccountKey	string	none	none
» scheduleDueDatesMethod	string	none	none
» shortMonthHandlingMethod	string	none	none
» taxRate	number	none	none
» tranches	[LoanTrancheApiV1]	none	none
»» amount	number	none	none
»» disbursementTransactionKey	string	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» expectedDisbursementDate	string	none	none
»» index	number	none	none

Enumerated Values

Property	Value
dateCalculationMethod	`DATE_OF_LAST_LATE_REPAYMENT`
dateCalculationMethod	`DATE_ACCOUNT_FIRST_WENT_TO_ARREARS`
nonWorkingDaysMethod	`EXCLUDED`
nonWorkingDaysMethod	`INCLUDED`
toleranceCalculationMethod	`MONTHLY_ARREARS_TOLERANCE_DAY`
toleranceCalculationMethod	`ARREARS_TOLERANCE_PERIOD`
accountHolderType	`GROUP`
accountHolderType	`CLIENT`
accountState	`WITHDRAWN`
accountState	`PARTIALLY_DISBURSED`
accountState	`LOCKED`
accountState	`ACTIVE`
accountState	`CLOSED`
accountState	`PARTIAL_APPLICATION`
accountState	`LOCKED_CAPPING`
accountState	`CLOSED_REJECTED`
accountState	`RESCHEDULED`
accountState	`ACTIVE_IN_ARREARS`
accountState	`MATURED`
accountState	`CLOSED_RESCHEDULED`
accountState	`CLOSED_WITHDRAWN`
accountState	`PENDING_APPROVAL`
accountState	`APPROVED`
accountState	`REFINANCED`
accountState	`DORMANT`
accountState	`CLOSED_WRITTEN_OFF`
accountSubState	`WITHDRAWN`
accountSubState	`PARTIALLY_DISBURSED`
accountSubState	`LOCKED`
accountSubState	`ACTIVE`
accountSubState	`CLOSED`
accountSubState	`PARTIAL_APPLICATION`
accountSubState	`LOCKED_CAPPING`
accountSubState	`CLOSED_REJECTED`
accountSubState	`RESCHEDULED`
accountSubState	`ACTIVE_IN_ARREARS`
accountSubState	`MATURED`
accountSubState	`CLOSED_RESCHEDULED`
accountSubState	`CLOSED_WITHDRAWN`
accountSubState	`PENDING_APPROVAL`
accountSubState	`APPROVED`
accountSubState	`REFINANCED`
accountSubState	`DORMANT`
accountSubState	`CLOSED_WRITTEN_OFF`
applyInterestOnPrepaymentMethod	`AUTOMATIC`
applyInterestOnPrepaymentMethod	`MANUAL`
builtInCustomFieldId	`MOBILE_PHONE`
builtInCustomFieldId	`EMAIL_ADDRESS`
builtInCustomFieldId	`GENDER`
builtInCustomFieldId	`MIDDLE_NAME`
builtInCustomFieldId	`HOME_PHONE`
builtInCustomFieldId	`BIRTHDATE`
builtInCustomFieldId	`LAST_NAME`
builtInCustomFieldId	`FIRST_NAME`
linkType	`CLIENT_ROLE`
linkType	`CHANNEL`
linkType	`PRODUCT`
dataFieldType	`NATIVE`
dataFieldType	`CUSTOM`
dataItemType	`WRITTEN_OFF_LOANS`
dataItemType	`LINE_OF_CREDIT`
dataItemType	`INVESTOR_FUND`
dataItemType	`TRANSACTION_DETAILS`
dataItemType	`DOCUMENT_TEMPLATE`
dataItemType	`PRODUCT`
dataItemType	`MCC_EXPIRATION`
dataItemType	`CENTRE`
dataItemType	`REPAYMENT_COLLECTION`
dataItemType	`TASK`
dataItemType	`OUTSTANDING_PORTFOLIO_AMOUNTS`
dataItemType	`REVENUE`
dataItemType	`COMPOSED_TRANSACTIONS`
dataItemType	`UNION_TRANSACTIONS`
dataItemType	`PRINCIPAL_PAYMENT_SETTINGS`
dataItemType	`LOANS`
dataItemType	`DISBURSEMENT_DETAILS`
dataItemType	`SAVINGS_TRANSACTION`
dataItemType	`IDENTIFICATION_DOCUMENT`
dataItemType	`LOAN_PRODUCT`
dataItemType	`DISBURSED_LOANS`
dataItemType	`LOAN_GROUP`
dataItemType	`TRANSACTION_CHANNEL`
dataItemType	`CUSTOM_PREDEFINED_FEE`
dataItemType	`JOURNAL_ENTRY`
dataItemType	`ATTACHMENT`
dataItemType	`PREDEFINED_FEE`
dataItemType	`TRANCHE`
dataItemType	`TRANSACTION`
dataItemType	`INDEX_RATE_SOURCE`
dataItemType	`GROUP_ROLE`
dataItemType	`LOAN_TRANSACTION`
dataItemType	`CLIENT_ROLE`
dataItemType	`GROUP`
dataItemType	`NOTIFICATION_MESSAGE`
dataItemType	`OUTSTANDING_PORTFOLIO_ACCOUNTS`
dataItemType	`REPAYMENT`
dataItemType	`LOAN_ACCOUNT_GUARANTY`
dataItemType	`BRANCH`
dataItemType	`CURRENCY`
dataItemType	`CARD_TRANSACTION_REVERSAL`
dataItemType	`INTEREST_PRODUCT_SETTINGS`
dataItemType	`CREATED_ACCOUNTS`
dataItemType	`USER`
dataItemType	`SAVINGS_PRODUCT`
dataItemType	`CLIENT`
dataItemType	`PRODUCT_ARREARS_SETTINGS`
dataItemType	`SAVINGS`
dataItemType	`EXPENSE`
dataItemType	`INDEX_RATE`
dataItemType	`NOTIFICATION_TEMPLATE`
dataItemType	`CUSTOM_FIELD_SELECTION`
dataItemType	`ACTIVITY`
dataType	`ENUM`
dataType	`MONEY`
dataType	`NUMBER`
dataType	`DATE_UTC`
dataType	`JAVA_BLOB`
dataType	`OBJECT`
dataType	`BOOLEAN`
dataType	`DATE`
dataType	`PERCENT`
dataType	`BIG_DECIMAL`
dataType	`STRING`
dataType	`KEY`
dataType	`LONG`
filterElement	`STARTS_WITH_CASE_SENSITIVE`
filterElement	`THIS_WEEK`
filterElement	`EQUALS`
filterElement	`STARTS_WITH`
filterElement	`IN`
filterElement	`TODAY`
filterElement	`THIS_YEAR`
filterElement	`BETWEEN`
filterElement	`AFTER`
filterElement	`LESS_THAN`
filterElement	`DIFFERENT_THAN`
filterElement	`THIS_MONTH`
filterElement	`NOT_EMPTY`
filterElement	`BEFORE`
filterElement	`EQUALS_CASE_SENSITIVE`
filterElement	`LAST_DAYS`
filterElement	`MORE_THAN`
filterElement	`EMPTY`
filterElement	`ON`
linkingOperator	`OR`
linkingOperator	`AND`
builtInType	`DETAILS`
builtInType	`GENERAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
usage	`SINGLE`
usage	`GROUPED`
dataType	`GROUP_LINK`
dataType	`DATE`
dataType	`NUMBER`
dataType	`CHECKBOX`
dataType	`CLIENT_LINK`
dataType	`STRING`
dataType	`USER_LINK`
dataType	`SELECTION`
state	`DEACTIVATED`
state	`NORMAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
valueLength	`SHORT`
valueLength	`LONG`
frequency	`ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING`
frequency	`ACCOUNT_INSTALLMENTS_DUE_DATES`
frequency	`CUSTOM_INTERVAL`
intervalType	`FULL_TERM`
intervalType	`PREDEFINED_INTERVALS`
periodUnit	`MONTHS`
periodUnit	`YEARS`
periodUnit	`WEEKS`
periodUnit	`DAYS`
amortizationProfile	`STRAIGHT_LINE`
amortizationProfile	`SUM_OF_YEARS_DIGITS`
amortizationProfile	`EFFECTIVE_INTEREST_RATE`
amortizationProfile	`NONE`
amountCalculationMethod	`LOAN_AMOUNT_PERCENTAGE`
amountCalculationMethod	`LOAN_AMOUNT_PERCENTAGE_NUMBER_OF_INSTALLMENTS`
amountCalculationMethod	`REPAYMENT_PRINCIPAL_AMOUNT_PERCENTAGE`
amountCalculationMethod	`FLAT_NUMBER_OF_INSTALLMENTS`
amountCalculationMethod	`FLAT`
applyDateMethod	`MONTHLY_FROM_ACTIVATION`
applyDateMethod	`FIRST_OF_EVERY_MONTH`
feeAmortizationUponRescheduleOption	`CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT`
feeAmortizationUponRescheduleOption	`END_AMORTIZATION_ON_THE_ORIGINAL_ACCOUNT`
feeApplication	`OPTIONAL`
feeApplication	`REQUIRED`
currencySymbolPosition	`AFTER_NUMBER`
currencySymbolPosition	`BEFORE_NUMBER`
state	`REVERTED`
state	`DRAFT`
state	`APPROVED`
type	`IMPORT`
type	`EXPORT`
type	`INCOME`
type	`EXPENSE`
type	`LIABILITY`
type	`ASSET`
type	`EQUITY`
usage	`HEADER`
usage	`DETAIL`
financialResource	`FEE_RECEIVABLE`
financialResource	`OVERDRAFT_INTEREST_INCOME`
financialResource	`OVERDRAFT_INTEREST_RECEIVABLE`
financialResource	`FEE_INCOME`
financialResource	`INTEREST_PAYABLE`
financialResource	`INTEREST_EXPENSE`
financialResource	`PENALTY_RECEIVABLE`
financialResource	`INTEREST_INCOME`
financialResource	`DEFERRED_TAXES`
financialResource	`DEFERRED_FEE_INCOME`
financialResource	`PORTFOLIO_CONTROL`
financialResource	`DEFERRED_INTERESTS_INCOME`
financialResource	`OVERDRAFT_WRITE_OFF_EXPENSE`
financialResource	`PENALTY_INCOME`
financialResource	`OVERDRAFT_PORTFOLIO_CONTROL`
financialResource	`SAVINGS_CONTROL`
financialResource	`TAXES_RECEIVABLE`
financialResource	`INTEREST_RECEIVABLE`
financialResource	`INTER_BRANCH_TRANSFER`
financialResource	`FUND_SOURCE`
financialResource	`WRITE_OFF_EXPENSE`
financialResource	`DEPOSIT_REFERENCE`
financialResource	`TAXES_PAYABLE`
productType	`LOAN`
productType	`SAVINGS`
trigger	`DISBURSEMENT`
trigger	`ARBITRARY`
trigger	`CAPITALIZED_DISBURSEMENT`
trigger	`MONTHLY_FEE`
trigger	`UPFRONT_DISBURSEMENT`
trigger	`LATE_REPAYMENT`
trigger	`MANUAL`
trigger	`PAYMENT_DUE`
trigger	`PAYMENT_DUE_APPLIED_ON_DUE_DATES`
dataViewType	`PORTAL_ACCOUNT_TRANSACTION`
dataViewType	`LOANS_AGING_ANALYSIS`
dataViewType	`CLOSED_ACCOUNTS`
dataViewType	`CLIENT_OVERVIEW`
dataViewType	`ADMIN_CENTRES`
dataViewType	`USER_NOTIFICATION_MESSAGES`
dataViewType	`LINE_OF_CREDIT`
dataViewType	`USER_OVERVIEW`
dataViewType	`CENTRE_OVERVIEW`
dataViewType	`REPAYMENT_REPAYMENTS_COLLECTION`
dataViewType	`GROUP_OVERVIEW`
dataViewType	`ACTIVITIES_LOOKUP`
dataViewType	`TRANSACTION`
dataViewType	`ADMIN_BRANCHES`
dataViewType	`GROUP`
dataViewType	`BRANCH_OVERVIEW`
dataViewType	`NOTIFICATION_MESSAGE`
dataViewType	`PORTFOLIO_REPORTS`
dataViewType	`GROUP_NOTIFICATION_MESSAGES`
dataViewType	`LOAN_ACCOUNT_SECURITIES_OVERVIEW`
dataViewType	`LINE_OF_CREDIT_OVERVIEW`
dataViewType	`CURRENCIES`
dataViewType	`REPAYMENT`
dataViewType	`TILL_TRANSACTIONS`
dataViewType	`ALL_TASKS`
dataViewType	`CENTRE`
dataViewType	`BRANCH`
dataViewType	`INDEX_RATES_LIST`
dataViewType	`USER_TASKS`
dataViewType	`DOCUMENT_TEMPLATES`
dataViewType	`SAVINGS_TRANSACTIONS_LOOKUP`
dataViewType	`LOAN_ACCOUNT_OVERVIEW`
dataViewType	`DEPOSITS_COLLECTION`
dataViewType	`USER`
dataViewType	`ADMIN_USERS`
dataViewType	`GROUP_TASKS`
dataViewType	`CLIENT`
dataViewType	`LOAN_TRANSACTIONS_LOOKUP`
dataViewType	`LOANS`
dataViewType	`LOANS_REPAYMENTS_COLLECTION`
dataViewType	`CLIENT_TASKS`
dataViewType	`OVERDRAFTS_AGING_ANALYSIS`
dataViewType	`LOAN_ACCOUNT_FUNDING_OVERVIEW`
dataViewType	`SAVINGS`
dataViewType	`SAVINGS_OVERVIEW`
dataViewType	`JOURNAL_ENTRY`
dataViewType	`CLIENT_NOTIFICATION_MESSAGES`
loanConstraintsUsage	`UNCONSTRAINED_USAGE`
loanConstraintsUsage	`LIMITED_USAGE`
savingsConstraintsUsage	`UNCONSTRAINED_USAGE`
savingsConstraintsUsage	`LIMITED_USAGE`
elementsRecalculationMethod	`FIXED_PRINCIPAL_EXPECTED`
elementsRecalculationMethod	`FIXED_TOTAL_EXPECTED`
guarantorType	`GROUP`
guarantorType	`CLIENT`
type	`GUARANTOR`
type	`INVESTOR`
type	`ASSET`
futurePaymentsAcceptance	`ACCEPT_OVERPAYMENTS`
futurePaymentsAcceptance	`NO_FUTURE_PAYMENTS`
futurePaymentsAcceptance	`ACCEPT_FUTURE_PAYMENTS`
gracePeriodType	`PAY_INTEREST_ONLY`
gracePeriodType	`NONE`
gracePeriodType	`INTEREST_FORGIVENESS`
guarantorType	`GROUP`
guarantorType	`CLIENT`
type	`GUARANTOR`
type	`INVESTOR`
type	`ASSET`
interestApplicationMethod	`ON_REPAYMENT`
interestApplicationMethod	`ON_DISBURSEMENT`
interestBalanceCalculationMethod	`PRINCIPAL_ONLY`
interestBalanceCalculationMethod	`PRINCIPAL_AND_INTEREST`
interestCalculationMethod	`DECLINING_BALANCE`
interestCalculationMethod	`DECLINING_BALANCE_DISCOUNTED`
interestCalculationMethod	`FLAT`
interestChargeFrequency	`EVERY_WEEK`
interestChargeFrequency	`ANNUALIZED`
interestChargeFrequency	`EVERY_MONTH`
interestChargeFrequency	`EVERY_X_DAYS`
interestChargeFrequency	`EVERY_FOUR_WEEKS`
interestChargeFrequency	`EVERY_DAY`
interestRateReviewUnit	`MONTHS`
interestRateReviewUnit	`WEEKS`
interestRateReviewUnit	`DAYS`
interestRateSource	`FIXED_INTEREST_RATE`
interestRateSource	`INDEX_INTEREST_RATE`
interestRoundingVersion	`VERSION_2`
interestRoundingVersion	`VERSION_1`
interestRoundingVersion	`VERSION_3`
interestType	`CAPITALIZED_INTEREST`
interestType	`SIMPLE_INTEREST`
latePaymentsRecalculationMethod	`INCREASE_OVERDUE_INSTALLMENTS`
latePaymentsRecalculationMethod	`INCREASE_LAST_INSTALLMENT`
preferredLanguage	`PORTUGESE`
preferredLanguage	`RUSSIAN`
preferredLanguage	`ROMANIAN`
preferredLanguage	`ENGLISH`
preferredLanguage	`SPANISH`
preferredLanguage	`GEORGIAN`
preferredLanguage	`BURMESE`
preferredLanguage	`PHRASE`
preferredLanguage	`CHINESE`
preferredLanguage	`FRENCH`
preferredLanguage	`INDONESIAN`
loanPenaltyCalculationMethod	`OVERDUE_BALANCE_AND_INTEREST`
loanPenaltyCalculationMethod	`OUTSTANDING_PRINCIPAL`
loanPenaltyCalculationMethod	`OVERDUE_BALANCE`
loanPenaltyCalculationMethod	`NONE`
paymentMethod	`VERTICAL`
paymentMethod	`HORIZONTAL`
prepaymentAcceptance	`ACCEPT_PREPAYMENTS`
prepaymentAcceptance	`NO_PREPAYMENTS`
prepaymentRecalculationMethod	`NO_RECALCULATION`
prepaymentRecalculationMethod	`RECALCULATE_SCHEDULE_KEEP_SAME_NUMBER_OF_TERMS`
prepaymentRecalculationMethod	`REDUCE_AMOUNT_PER_INSTALLMENT`
prepaymentRecalculationMethod	`REDUCE_NUMBER_OF_INSTALLMENTS_NEW`
prepaymentRecalculationMethod	`REDUCE_NUMBER_OF_INSTALLMENTS`
prepaymentRecalculationMethod	`RESCHEDULE_REMAINING_REPAYMENTS`
prepaymentRecalculationMethod	`RECALCULATE_SCHEDULE_KEEP_SAME_TOTAL_REPAYMENT_AMOUNT`
prepaymentRecalculationMethod	`RECALCULATE_SCHEDULE_KEEP_SAME_PRINCIPAL_AMOUNT`
principalPaidInstallmentStatus	`PARTIALLY_PAID`
principalPaidInstallmentStatus	`ORIGINAL_TOTAL_EXPECTED_PAID`
principalPaidInstallmentStatus	`PAID`
principalPaymentMethod	`OUTSTANDING_PRINCIPAL_PERCENTAGE`
principalPaymentMethod	`FLAT`
principalPaymentMethod	`TOTAL_BALANCE_PERCENTAGE`
repaymentPeriodUnit	`MONTHS`
repaymentPeriodUnit	`YEARS`
repaymentPeriodUnit	`WEEKS`
repaymentPeriodUnit	`DAYS`
repaymentScheduleMethod	`FIXED`
repaymentScheduleMethod	`NONE`
repaymentScheduleMethod	`DYNAMIC`
scheduleDueDatesMethod	`INTERVAL`
scheduleDueDatesMethod	`FIXED_DAYS_OF_MONTH`
shortMonthHandlingMethod	`LAST_DAY_IN_MONTH`
shortMonthHandlingMethod	`FIRST_DAY_OF_NEXT_MONTH`

Savings Products

Allows you to retrieve one individual savings product by id/key or a list of paginated savings products.

Get Savings Products

GET /savingsproducts

Get all savings products

Parameters

Name	Type	Description	In
offset	integer	none	query
limit	integer	none	query

Example Responses

200 Response

[
  {
    "accountingMethod": "NONE",
    "activated": true,
    "allowArbitraryFees": true,
    "allowOffset": true,
    "allowOverdraft": true,
    "allowTechnicalOverdraft": true,
    "availableProductBranches": [
      {
        "branchKey": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "product": {}
      }
    ],
    "collectInterestWhenLocked": true,
    "creationDate": "string",
    "currencies": [
      {
        "code": "string",
        "creationDate": "string",
        "currencySymbolPosition": "AFTER_NUMBER",
        "digitsAfterDecimal": 0,
        "isBaseCurrency": true,
        "lastModifiedDate": "string",
        "name": "string",
        "symbol": "string"
      }
    ],
    "defaultMaturityPeriod": 0,
    "defaultOpeningBalance": 0,
    "description": "string",
    "dormancyPeriodDays": 0,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "forAllBranches": true,
    "forGroups": true,
    "forIndividuals": true,
    "id": "string",
    "idGeneratorType": "INCREMENTAL_NUMBER",
    "idPattern": "string",
    "interestAccruedAccountingMethod": "DAILY",
    "interestCalculationBalance": "MINIMUM",
    "interestDaysInYear": "E30_42_365",
    "interestPaidIntoAccount": true,
    "interestPaymentDates": [
      {
        "dayOfMonth": 0,
        "monthOfYear": 0,
        "year": 0
      }
    ],
    "interestPaymentPoint": "EVERY_WEEK",
    "interestRateSettings": {
      "accrueInterestAfterMaturity": true,
      "defaultInterestRate": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexSourceKey": "string",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestChargeFrequencyCount": 0,
      "interestRateCeilingValue": 0,
      "interestRateFloorValue": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "TIERED_PERIOD",
      "interestRateTiers": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingBalance": 0,
          "endingDay": 0,
          "index": 0,
          "interestRate": 0
        }
      ],
      "maxInterestRate": 0,
      "minInterestRate": 0
    },
    "lastModifiedDate": "string",
    "lineOfCreditRequirement": "OPTIONAL",
    "maturityPeriodUnit": "MONTHS",
    "maxMaturityPeriod": 0,
    "maxOpeningBalance": 0,
    "maxOverdraftLimit": 0,
    "maxWidthdrawlAmount": 0,
    "maximumBalance": 0,
    "minMaturityPeriod": 0,
    "minOpeningBalance": 0,
    "name": "string",
    "overdraftDaysInYear": "E30_42_365",
    "overdraftInterestCalculationBalance": "MINIMUM",
    "overdraftInterestRateSettings": {
      "accrueInterestAfterMaturity": true,
      "defaultInterestRate": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexSourceKey": "string",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestChargeFrequencyCount": 0,
      "interestRateCeilingValue": 0,
      "interestRateFloorValue": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "TIERED_PERIOD",
      "interestRateTiers": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingBalance": 0,
          "endingDay": 0,
          "index": 0,
          "interestRate": 0
        }
      ],
      "maxInterestRate": 0,
      "minInterestRate": 0
    },
    "productType": "CURRENT_ACCOUNT",
    "recommendedDepositAmount": 0,
    "savingsFees": [
      {
        "active": true,
        "amortizationIntervalSettings": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
          "intervalCount": 0,
          "intervalType": "FULL_TERM",
          "periodCount": 0,
          "periodUnit": "MONTHS"
        },
        "amortizationProfile": "STRAIGHT_LINE",
        "amount": 0,
        "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
        "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
        "creationDate": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
        "feeApplication": "OPTIONAL",
        "feeProductRules": [
          {
            "account": {
              "activated": true,
              "allowManualJournalEntries": true,
              "balance": 0,
              "creationDate": "2019-08-24T14:15:22Z",
              "currency": {
                "code": "string",
                "creationDate": "string",
                "currencySymbolPosition": "AFTER_NUMBER",
                "digitsAfterDecimal": 0,
                "isBaseCurrency": true,
                "lastModifiedDate": "string",
                "name": "string",
                "symbol": "string"
              },
              "description": "string",
              "encodedKey": "string",
              "glCode": "string",
              "lastModifiedDate": "2019-08-24T14:15:22Z",
              "migrationEvent": {
                "creationDate": "2019-08-24T14:15:22Z",
                "encodedKey": "string",
                "numCentresImported": 0,
                "numClientsImported": 0,
                "numGLAccountsImported": 0,
                "numGroupsImported": 0,
                "numLoanRepaymentsImported": 0,
                "numLoanTransactionsImported": 0,
                "numLoansImported": 0,
                "numSavingsImported": 0,
                "state": "REVERTED",
                "type": "IMPORT"
              },
              "name": "string",
              "stripTrailingZeros": true,
              "type": "INCOME",
              "usage": "HEADER"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "financialResource": "FEE_RECEIVABLE",
            "index": 0,
            "predefinedFeeKey": "string",
            "productKey": "string",
            "productType": "LOAN",
            "transactionChannelKey": "string"
          }
        ],
        "name": "string",
        "percentageAmount": 0,
        "trigger": "DISBURSEMENT"
      }
    ],
    "savingsProductRules": [
      {
        "account": {
          "activated": true,
          "allowManualJournalEntries": true,
          "balance": 0,
          "creationDate": "2019-08-24T14:15:22Z",
          "currency": {
            "code": "string",
            "creationDate": "string",
            "currencySymbolPosition": "AFTER_NUMBER",
            "digitsAfterDecimal": 0,
            "isBaseCurrency": true,
            "lastModifiedDate": "string",
            "name": "string",
            "symbol": "string"
          },
          "description": "string",
          "encodedKey": "string",
          "glCode": "string",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "migrationEvent": {
            "creationDate": "2019-08-24T14:15:22Z",
            "encodedKey": "string",
            "numCentresImported": 0,
            "numClientsImported": 0,
            "numGLAccountsImported": 0,
            "numGroupsImported": 0,
            "numLoanRepaymentsImported": 0,
            "numLoanTransactionsImported": 0,
            "numLoansImported": 0,
            "numSavingsImported": 0,
            "state": "REVERTED",
            "type": "IMPORT"
          },
          "name": "string",
          "stripTrailingZeros": true,
          "type": "INCOME",
          "usage": "HEADER"
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "financialResource": "FEE_RECEIVABLE",
        "index": 0,
        "predefinedFeeKey": "string",
        "productKey": "string",
        "productType": "LOAN",
        "transactionChannelKey": "string"
      }
    ],
    "templates": [
      {
        "creationDate": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "lastModifiedDate": "string",
        "name": "string",
        "type": "ACCOUNT"
      }
    ],
    "withholdingTaxEnabled": true
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[SavingsProductApiV1]	none	none
» accountingMethod	string	none	none
» activated	boolean	none	none
» allowArbitraryFees	boolean	none	none
» allowOffset	boolean	none	none
» allowOverdraft	boolean	none	none
» allowTechnicalOverdraft	boolean	none	none
» availableProductBranches	[SavingsProductBranchApiV1]	none	none
»» branchKey	string	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» product	SavingsProductApiV1	none	none
» collectInterestWhenLocked	boolean	none	none
» creationDate	string	the date and time when this savings product was created	none
» currencies	[CurrencyApiV1]	none	none
»» code	string	the three letter ISO code for this currency	none
»» creationDate	string	the date on which this currency was created	none
»» currencySymbolPosition	string	indicates where the currency symbol should appear in relation to the numeric value	none
»» digitsAfterDecimal	number	indicates how many decimal places are allowed for this currency. For example, a currenncy with 100 minor units to 1 major unit, there will be 2 decimal places.	none
»» isBaseCurrency	boolean	whether this currency is the base currency for your banking institution	none
»» lastModifiedDate	string	the date on which this currency was last modified	none
»» name	string	the name of this currency	none
»» symbol	string	the currency symnbol used for this currency	none
» defaultMaturityPeriod	number	none	none
» defaultOpeningBalance	number	none	none
» description	string	none	none
» dormancyPeriodDays	number	none	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» forAllBranches	boolean	none	none
» forGroups	boolean	none	none
» forIndividuals	boolean	none	none
» id	string	none	none
» idGeneratorType	string	none	none
» idPattern	string	none	none
» interestAccruedAccountingMethod	string	none	none
» interestCalculationBalance	string	none	none
» interestDaysInYear	string	none	none
» interestPaidIntoAccount	boolean	none	none
» interestPaymentDates	[DateDTOApiV1]	none	none
»» dayOfMonth	number	the day of the month	none
»» monthOfYear	number	the month	none
»» year	number	the year	none
» interestPaymentPoint	string	none	none
» interestRateSettings	InterestProductSettingsApiV1	none	none
»» accrueInterestAfterMaturity	boolean	none	none
»» defaultInterestRate	number	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» indexSourceKey	string	none	none
»» interestChargeFrequency	string	none	none
»» interestChargeFrequencyCount	number	none	none
»» interestRateCeilingValue	number	none	none
»» interestRateFloorValue	number	none	none
»» interestRateReviewCount	number	none	none
»» interestRateReviewUnit	string	none	none
»» interestRateSource	string	none	none
»» interestRateTerms	string	none	none
»» interestRateTiers	[InterestRateTierApiV1]	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» endingBalance	number	none	none
»»» endingDay	number	none	none
»»» index	number	none	none
»»» interestRate	number	none	none
»» maxInterestRate	number	none	none
»» minInterestRate	number	none	none
» lastModifiedDate	string	the date on which this savings product was last modified	none
» lineOfCreditRequirement	string	none	none
» maturityPeriodUnit	string	none	none
» maxMaturityPeriod	number	none	none
» maxOpeningBalance	number	none	none
» maxOverdraftLimit	number	none	none
» maxWidthdrawlAmount	number	none	none
» maximumBalance	number	none	none
» minMaturityPeriod	number	none	none
» minOpeningBalance	number	none	none
» name	string	none	none
» overdraftDaysInYear	string	none	none
» overdraftInterestCalculationBalance	string	none	none
» overdraftInterestRateSettings	InterestProductSettingsApiV1	none	none
» productType	string	none	none
» recommendedDepositAmount	number	none	none
» savingsFees	[PredefinedFeeApiV1]	none	none
»» active	boolean	none	none
»» amortizationIntervalSettings	PeriodIntervalSettingsApiV1	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» frequency	string	none	none
»»» intervalCount	number	none	none
»»» intervalType	string	none	none
»»» periodCount	number	none	none
»»» periodUnit	string	none	none
»» amortizationProfile	string	none	none
»» amount	number	none	none
»» amountCalculationMethod	string	none	none
»» applyDateMethod	string	none	none
»» creationDate	string	the date and time when this fee was created	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» feeAmortizationUponRescheduleOption	string	none	none
»» feeApplication	string	none	none
»» feeProductRules	[GLAccountingRuleApiV1]	none	none
»»» account	GLAccountApiV1	A general ledger account	none
»»»» activated	boolean	whether this general ledger account is in use	none
»»»» allowManualJournalEntries	boolean	whether manual entries are allowed for this general ledger account	none
»»»» balance	number	the current balance of this general ledger account	none
»»»» creationDate	string(date-time)	the date on which this general ledger account was created	read-only
»»»» currency	CurrencyApiV1	none	none
»»»» description	string	an optional description for this general ledger account	none
»»»» encodedKey	string	the encoded key of this general ledger account	none
»»»» glCode	string	the numeric code for this general ledger account	none
»»»» lastModifiedDate	string(date-time)	the date on which this general ledger account was last modified	read-only
»»»» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
»»»»» creationDate	string(date-time)	the date on which the data import was made	none
»»»»» encodedKey	string	the encoded key of this data migration event	none
»»»»» numCentresImported	number	the number of centres which were imported during the data migration	none
»»»»» numClientsImported	number	the number of clients which were imported as part of the data migration	none
»»»»» numGLAccountsImported	number	the number of general ledger accounts which were imported as part of the data migration	none
»»»»» numGroupsImported	number	the number of groups which were imported as part of the data migration	none
»»»»» numLoanRepaymentsImported	number	the number of loan repayment transations which were imported as part of the data migration	none
»»»»» numLoanTransactionsImported	number	the number of loan transactions which were imported as part of the data migration	none
»»»»» numLoansImported	number	the number of loan accounts which were imported as part of the data migration	none
»»»»» numSavingsImported	number	the number of savings accounts which were imported as part of the data migration	none
»»»»» state	string	whether the data import was accepted, is still in a draft state, or was rejected and all data reverted	none
»»»»» type	string	the type of migration event	none
»»»» name	string	the name of this general ledger account	none
»»»» stripTrailingZeros	boolean	controls how this account is organized into header accounts when there are trailing zeroes, for example, for the account code `1100`, if this field is set to true, only the first two numbers will be recognised	none
»»»» type	string	the type of general ledger account	none
»»»» usage	string	whether this general ledger account is a `DETAIL` account, in which case it will have a value, or a `HEADER` account, in which case its value will be calculated based on the sum of detail accounts under it.	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» financialResource	string	the type of transaction governed by this rule	none
»»» index	number	the index in list when there are multiple rules for the same type of transaction	none
»»» predefinedFeeKey	string	the encoded key of the predefined key this rule relates to	none
»»» productKey	string	the encoded key of the product this rule relates to	none
»»» productType	string	the type of account this rule relates to	none
»»» transactionChannelKey	string	the encoded key of the transaction channel that this rule relates to	none
»» name	string	none	none
»» percentageAmount	number	none	none
»» trigger	string	none	none
» savingsProductRules	[GLAccountingRuleApiV1]	none	none
» templates	[DocumentTemplateApiV1]	none	none
»» creationDate	string	the date and time when this document was created	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» lastModifiedDate	string	the date on which this document template was last modified	none
»» name	string	the name of the document template	none
»» type	string	the type of template, this will have an impact on what data is available to the template as placeholders	none
» withholdingTaxEnabled	boolean	none	none

Enumerated Values

Property	Value
accountingMethod	`NONE`
accountingMethod	`CASH`
accountingMethod	`ACCRUAL`
currencySymbolPosition	`AFTER_NUMBER`
currencySymbolPosition	`BEFORE_NUMBER`
idGeneratorType	`INCREMENTAL_NUMBER`
idGeneratorType	`RANDOM_PATTERN`
interestAccruedAccountingMethod	`DAILY`
interestAccruedAccountingMethod	`END_OF_MONTH`
interestAccruedAccountingMethod	`NONE`
interestCalculationBalance	`MINIMUM`
interestCalculationBalance	`END_OF_DAY`
interestCalculationBalance	`AVERAGE`
interestDaysInYear	`E30_42_365`
interestDaysInYear	`ACTUAL_365_FIXED`
interestDaysInYear	`ACTUAL_360`
interestDaysInYear	`E30_360`
interestDaysInYear	`ACTUAL_364`
interestDaysInYear	`ACTUAL_ACTUAL_ISDA`
interestPaymentPoint	`EVERY_WEEK`
interestPaymentPoint	`ON_FIXED_DATES`
interestPaymentPoint	`EVERY_MONTH`
interestPaymentPoint	`ON_ACCOUNT_MATURITY`
interestPaymentPoint	`EVERY_3_MONTHS`
interestPaymentPoint	`FIRST_DAY_OF_MONTH`
interestPaymentPoint	`EVERY_OTHER_WEEK`
interestChargeFrequency	`EVERY_WEEK`
interestChargeFrequency	`ANNUALIZED`
interestChargeFrequency	`EVERY_MONTH`
interestChargeFrequency	`EVERY_X_DAYS`
interestChargeFrequency	`EVERY_FOUR_WEEKS`
interestChargeFrequency	`EVERY_DAY`
interestRateReviewUnit	`MONTHS`
interestRateReviewUnit	`WEEKS`
interestRateReviewUnit	`DAYS`
interestRateSource	`FIXED_INTEREST_RATE`
interestRateSource	`INDEX_INTEREST_RATE`
interestRateTerms	`TIERED_PERIOD`
interestRateTerms	`FIXED`
interestRateTerms	`TIERED`
lineOfCreditRequirement	`OPTIONAL`
lineOfCreditRequirement	`NOT_REQUIRED`
lineOfCreditRequirement	`REQUIRED`
maturityPeriodUnit	`MONTHS`
maturityPeriodUnit	`WEEKS`
maturityPeriodUnit	`DAYS`
overdraftDaysInYear	`E30_42_365`
overdraftDaysInYear	`ACTUAL_365_FIXED`
overdraftDaysInYear	`ACTUAL_360`
overdraftDaysInYear	`E30_360`
overdraftDaysInYear	`ACTUAL_364`
overdraftDaysInYear	`ACTUAL_ACTUAL_ISDA`
overdraftInterestCalculationBalance	`MINIMUM`
overdraftInterestCalculationBalance	`END_OF_DAY`
overdraftInterestCalculationBalance	`AVERAGE`
productType	`CURRENT_ACCOUNT`
productType	`REGULAR_SAVINGS`
productType	`FIXED_DEPOSIT`
productType	`INVESTOR_ACCOUNT`
productType	`SAVINGS_PLAN`
frequency	`ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING`
frequency	`ACCOUNT_INSTALLMENTS_DUE_DATES`
frequency	`CUSTOM_INTERVAL`
intervalType	`FULL_TERM`
intervalType	`PREDEFINED_INTERVALS`
periodUnit	`MONTHS`
periodUnit	`YEARS`
periodUnit	`WEEKS`
periodUnit	`DAYS`
amortizationProfile	`STRAIGHT_LINE`
amortizationProfile	`SUM_OF_YEARS_DIGITS`
amortizationProfile	`EFFECTIVE_INTEREST_RATE`
amortizationProfile	`NONE`
amountCalculationMethod	`LOAN_AMOUNT_PERCENTAGE`
amountCalculationMethod	`LOAN_AMOUNT_PERCENTAGE_NUMBER_OF_INSTALLMENTS`
amountCalculationMethod	`REPAYMENT_PRINCIPAL_AMOUNT_PERCENTAGE`
amountCalculationMethod	`FLAT_NUMBER_OF_INSTALLMENTS`
amountCalculationMethod	`FLAT`
applyDateMethod	`MONTHLY_FROM_ACTIVATION`
applyDateMethod	`FIRST_OF_EVERY_MONTH`
feeAmortizationUponRescheduleOption	`CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT`
feeAmortizationUponRescheduleOption	`END_AMORTIZATION_ON_THE_ORIGINAL_ACCOUNT`
feeApplication	`OPTIONAL`
feeApplication	`REQUIRED`
state	`REVERTED`
state	`DRAFT`
state	`APPROVED`
type	`IMPORT`
type	`EXPORT`
type	`INCOME`
type	`EXPENSE`
type	`LIABILITY`
type	`ASSET`
type	`EQUITY`
usage	`HEADER`
usage	`DETAIL`
financialResource	`FEE_RECEIVABLE`
financialResource	`OVERDRAFT_INTEREST_INCOME`
financialResource	`OVERDRAFT_INTEREST_RECEIVABLE`
financialResource	`FEE_INCOME`
financialResource	`INTEREST_PAYABLE`
financialResource	`INTEREST_EXPENSE`
financialResource	`PENALTY_RECEIVABLE`
financialResource	`INTEREST_INCOME`
financialResource	`DEFERRED_TAXES`
financialResource	`DEFERRED_FEE_INCOME`
financialResource	`PORTFOLIO_CONTROL`
financialResource	`DEFERRED_INTERESTS_INCOME`
financialResource	`OVERDRAFT_WRITE_OFF_EXPENSE`
financialResource	`PENALTY_INCOME`
financialResource	`OVERDRAFT_PORTFOLIO_CONTROL`
financialResource	`SAVINGS_CONTROL`
financialResource	`TAXES_RECEIVABLE`
financialResource	`INTEREST_RECEIVABLE`
financialResource	`INTER_BRANCH_TRANSFER`
financialResource	`FUND_SOURCE`
financialResource	`WRITE_OFF_EXPENSE`
financialResource	`DEPOSIT_REFERENCE`
financialResource	`TAXES_PAYABLE`
productType	`LOAN`
productType	`SAVINGS`
trigger	`DISBURSEMENT`
trigger	`ARBITRARY`
trigger	`CAPITALIZED_DISBURSEMENT`
trigger	`MONTHLY_FEE`
trigger	`UPFRONT_DISBURSEMENT`
trigger	`LATE_REPAYMENT`
trigger	`MANUAL`
trigger	`PAYMENT_DUE`
trigger	`PAYMENT_DUE_APPLIED_ON_DUE_DATES`
type	`ACCOUNT`
type	`ACCOUNT_WITH_TRANSACTIONS`
type	`TRANSACTION`

Get Savings Product by ID

GET /savingsproducts/{savingsProductId}

Get a savings product by ID

Parameters

Name	Type	Description	In
savingsProductId (required)	string	The ID of the product	path

Example Responses

200 Response

{
  "accountingMethod": "NONE",
  "activated": true,
  "allowArbitraryFees": true,
  "allowOffset": true,
  "allowOverdraft": true,
  "allowTechnicalOverdraft": true,
  "availableProductBranches": [
    {
      "branchKey": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "product": {
        "accountingMethod": "NONE",
        "activated": true,
        "allowArbitraryFees": true,
        "allowOffset": true,
        "allowOverdraft": true,
        "allowTechnicalOverdraft": true,
        "availableProductBranches": [],
        "collectInterestWhenLocked": true,
        "creationDate": "string",
        "currencies": [
          {
            "code": "string",
            "creationDate": "string",
            "currencySymbolPosition": "AFTER_NUMBER",
            "digitsAfterDecimal": 0,
            "isBaseCurrency": true,
            "lastModifiedDate": "string",
            "name": "string",
            "symbol": "string"
          }
        ],
        "defaultMaturityPeriod": 0,
        "defaultOpeningBalance": 0,
        "description": "string",
        "dormancyPeriodDays": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "forAllBranches": true,
        "forGroups": true,
        "forIndividuals": true,
        "id": "string",
        "idGeneratorType": "INCREMENTAL_NUMBER",
        "idPattern": "string",
        "interestAccruedAccountingMethod": "DAILY",
        "interestCalculationBalance": "MINIMUM",
        "interestDaysInYear": "E30_42_365",
        "interestPaidIntoAccount": true,
        "interestPaymentDates": [
          {
            "dayOfMonth": 0,
            "monthOfYear": 0,
            "year": 0
          }
        ],
        "interestPaymentPoint": "EVERY_WEEK",
        "interestRateSettings": {
          "accrueInterestAfterMaturity": true,
          "defaultInterestRate": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexSourceKey": "string",
          "interestChargeFrequency": "EVERY_WEEK",
          "interestChargeFrequencyCount": 0,
          "interestRateCeilingValue": 0,
          "interestRateFloorValue": 0,
          "interestRateReviewCount": 0,
          "interestRateReviewUnit": "MONTHS",
          "interestRateSource": "FIXED_INTEREST_RATE",
          "interestRateTerms": "TIERED_PERIOD",
          "interestRateTiers": [
            {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "endingBalance": 0,
              "endingDay": 0,
              "index": 0,
              "interestRate": 0
            }
          ],
          "maxInterestRate": 0,
          "minInterestRate": 0
        },
        "lastModifiedDate": "string",
        "lineOfCreditRequirement": "OPTIONAL",
        "maturityPeriodUnit": "MONTHS",
        "maxMaturityPeriod": 0,
        "maxOpeningBalance": 0,
        "maxOverdraftLimit": 0,
        "maxWidthdrawlAmount": 0,
        "maximumBalance": 0,
        "minMaturityPeriod": 0,
        "minOpeningBalance": 0,
        "name": "string",
        "overdraftDaysInYear": "E30_42_365",
        "overdraftInterestCalculationBalance": "MINIMUM",
        "overdraftInterestRateSettings": {
          "accrueInterestAfterMaturity": true,
          "defaultInterestRate": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexSourceKey": "string",
          "interestChargeFrequency": "EVERY_WEEK",
          "interestChargeFrequencyCount": 0,
          "interestRateCeilingValue": 0,
          "interestRateFloorValue": 0,
          "interestRateReviewCount": 0,
          "interestRateReviewUnit": "MONTHS",
          "interestRateSource": "FIXED_INTEREST_RATE",
          "interestRateTerms": "TIERED_PERIOD",
          "interestRateTiers": [
            {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "endingBalance": 0,
              "endingDay": 0,
              "index": 0,
              "interestRate": 0
            }
          ],
          "maxInterestRate": 0,
          "minInterestRate": 0
        },
        "productType": "CURRENT_ACCOUNT",
        "recommendedDepositAmount": 0,
        "savingsFees": [
          {
            "active": true,
            "amortizationIntervalSettings": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
              "intervalCount": 0,
              "intervalType": "FULL_TERM",
              "periodCount": 0,
              "periodUnit": "MONTHS"
            },
            "amortizationProfile": "STRAIGHT_LINE",
            "amount": 0,
            "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
            "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
            "creationDate": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
            "feeApplication": "OPTIONAL",
            "feeProductRules": [
              {
                "account": {
                  "activated": true,
                  "allowManualJournalEntries": true,
                  "balance": 0,
                  "creationDate": "2019-08-24T14:15:22Z",
                  "currency": {
                    "code": "string",
                    "creationDate": "string",
                    "currencySymbolPosition": "AFTER_NUMBER",
                    "digitsAfterDecimal": 0,
                    "isBaseCurrency": true,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "symbol": "string"
                  },
                  "description": "string",
                  "encodedKey": "string",
                  "glCode": "string",
                  "lastModifiedDate": "2019-08-24T14:15:22Z",
                  "migrationEvent": {
                    "creationDate": "2019-08-24T14:15:22Z",
                    "encodedKey": "string",
                    "numCentresImported": 0,
                    "numClientsImported": 0,
                    "numGLAccountsImported": 0,
                    "numGroupsImported": 0,
                    "numLoanRepaymentsImported": 0,
                    "numLoanTransactionsImported": 0,
                    "numLoansImported": 0,
                    "numSavingsImported": 0,
                    "state": "REVERTED",
                    "type": "IMPORT"
                  },
                  "name": "string",
                  "stripTrailingZeros": true,
                  "type": "INCOME",
                  "usage": "HEADER"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "financialResource": "FEE_RECEIVABLE",
                "index": 0,
                "predefinedFeeKey": "string",
                "productKey": "string",
                "productType": "LOAN",
                "transactionChannelKey": "string"
              }
            ],
            "name": "string",
            "percentageAmount": 0,
            "trigger": "DISBURSEMENT"
          }
        ],
        "savingsProductRules": [
          {
            "account": {
              "activated": true,
              "allowManualJournalEntries": true,
              "balance": 0,
              "creationDate": "2019-08-24T14:15:22Z",
              "currency": {
                "code": "string",
                "creationDate": "string",
                "currencySymbolPosition": "AFTER_NUMBER",
                "digitsAfterDecimal": 0,
                "isBaseCurrency": true,
                "lastModifiedDate": "string",
                "name": "string",
                "symbol": "string"
              },
              "description": "string",
              "encodedKey": "string",
              "glCode": "string",
              "lastModifiedDate": "2019-08-24T14:15:22Z",
              "migrationEvent": {
                "creationDate": "2019-08-24T14:15:22Z",
                "encodedKey": "string",
                "numCentresImported": 0,
                "numClientsImported": 0,
                "numGLAccountsImported": 0,
                "numGroupsImported": 0,
                "numLoanRepaymentsImported": 0,
                "numLoanTransactionsImported": 0,
                "numLoansImported": 0,
                "numSavingsImported": 0,
                "state": "REVERTED",
                "type": "IMPORT"
              },
              "name": "string",
              "stripTrailingZeros": true,
              "type": "INCOME",
              "usage": "HEADER"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "financialResource": "FEE_RECEIVABLE",
            "index": 0,
            "predefinedFeeKey": "string",
            "productKey": "string",
            "productType": "LOAN",
            "transactionChannelKey": "string"
          }
        ],
        "templates": [
          {
            "creationDate": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "lastModifiedDate": "string",
            "name": "string",
            "type": "ACCOUNT"
          }
        ],
        "withholdingTaxEnabled": true
      }
    }
  ],
  "collectInterestWhenLocked": true,
  "creationDate": "string",
  "currencies": [
    {
      "code": "string",
      "creationDate": "string",
      "currencySymbolPosition": "AFTER_NUMBER",
      "digitsAfterDecimal": 0,
      "isBaseCurrency": true,
      "lastModifiedDate": "string",
      "name": "string",
      "symbol": "string"
    }
  ],
  "defaultMaturityPeriod": 0,
  "defaultOpeningBalance": 0,
  "description": "string",
  "dormancyPeriodDays": 0,
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "forAllBranches": true,
  "forGroups": true,
  "forIndividuals": true,
  "id": "string",
  "idGeneratorType": "INCREMENTAL_NUMBER",
  "idPattern": "string",
  "interestAccruedAccountingMethod": "DAILY",
  "interestCalculationBalance": "MINIMUM",
  "interestDaysInYear": "E30_42_365",
  "interestPaidIntoAccount": true,
  "interestPaymentDates": [
    {
      "dayOfMonth": 0,
      "monthOfYear": 0,
      "year": 0
    }
  ],
  "interestPaymentPoint": "EVERY_WEEK",
  "interestRateSettings": {
    "accrueInterestAfterMaturity": true,
    "defaultInterestRate": 0,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "indexSourceKey": "string",
    "interestChargeFrequency": "EVERY_WEEK",
    "interestChargeFrequencyCount": 0,
    "interestRateCeilingValue": 0,
    "interestRateFloorValue": 0,
    "interestRateReviewCount": 0,
    "interestRateReviewUnit": "MONTHS",
    "interestRateSource": "FIXED_INTEREST_RATE",
    "interestRateTerms": "TIERED_PERIOD",
    "interestRateTiers": [
      {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "endingBalance": 0,
        "endingDay": 0,
        "index": 0,
        "interestRate": 0
      }
    ],
    "maxInterestRate": 0,
    "minInterestRate": 0
  },
  "lastModifiedDate": "string",
  "lineOfCreditRequirement": "OPTIONAL",
  "maturityPeriodUnit": "MONTHS",
  "maxMaturityPeriod": 0,
  "maxOpeningBalance": 0,
  "maxOverdraftLimit": 0,
  "maxWidthdrawlAmount": 0,
  "maximumBalance": 0,
  "minMaturityPeriod": 0,
  "minOpeningBalance": 0,
  "name": "string",
  "overdraftDaysInYear": "E30_42_365",
  "overdraftInterestCalculationBalance": "MINIMUM",
  "overdraftInterestRateSettings": {
    "accrueInterestAfterMaturity": true,
    "defaultInterestRate": 0,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "indexSourceKey": "string",
    "interestChargeFrequency": "EVERY_WEEK",
    "interestChargeFrequencyCount": 0,
    "interestRateCeilingValue": 0,
    "interestRateFloorValue": 0,
    "interestRateReviewCount": 0,
    "interestRateReviewUnit": "MONTHS",
    "interestRateSource": "FIXED_INTEREST_RATE",
    "interestRateTerms": "TIERED_PERIOD",
    "interestRateTiers": [
      {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "endingBalance": 0,
        "endingDay": 0,
        "index": 0,
        "interestRate": 0
      }
    ],
    "maxInterestRate": 0,
    "minInterestRate": 0
  },
  "productType": "CURRENT_ACCOUNT",
  "recommendedDepositAmount": 0,
  "savingsFees": [
    {
      "active": true,
      "amortizationIntervalSettings": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
        "intervalCount": 0,
        "intervalType": "FULL_TERM",
        "periodCount": 0,
        "periodUnit": "MONTHS"
      },
      "amortizationProfile": "STRAIGHT_LINE",
      "amount": 0,
      "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
      "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
      "creationDate": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
      "feeApplication": "OPTIONAL",
      "feeProductRules": [
        {
          "account": {
            "activated": true,
            "allowManualJournalEntries": true,
            "balance": 0,
            "creationDate": "2019-08-24T14:15:22Z",
            "currency": {
              "code": "string",
              "creationDate": "string",
              "currencySymbolPosition": "AFTER_NUMBER",
              "digitsAfterDecimal": 0,
              "isBaseCurrency": true,
              "lastModifiedDate": "string",
              "name": "string",
              "symbol": "string"
            },
            "description": "string",
            "encodedKey": "string",
            "glCode": "string",
            "lastModifiedDate": "2019-08-24T14:15:22Z",
            "migrationEvent": {
              "creationDate": "2019-08-24T14:15:22Z",
              "encodedKey": "string",
              "numCentresImported": 0,
              "numClientsImported": 0,
              "numGLAccountsImported": 0,
              "numGroupsImported": 0,
              "numLoanRepaymentsImported": 0,
              "numLoanTransactionsImported": 0,
              "numLoansImported": 0,
              "numSavingsImported": 0,
              "state": "REVERTED",
              "type": "IMPORT"
            },
            "name": "string",
            "stripTrailingZeros": true,
            "type": "INCOME",
            "usage": "HEADER"
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "financialResource": "FEE_RECEIVABLE",
          "index": 0,
          "predefinedFeeKey": "string",
          "productKey": "string",
          "productType": "LOAN",
          "transactionChannelKey": "string"
        }
      ],
      "name": "string",
      "percentageAmount": 0,
      "trigger": "DISBURSEMENT"
    }
  ],
  "savingsProductRules": [
    {
      "account": {
        "activated": true,
        "allowManualJournalEntries": true,
        "balance": 0,
        "creationDate": "2019-08-24T14:15:22Z",
        "currency": {
          "code": "string",
          "creationDate": "string",
          "currencySymbolPosition": "AFTER_NUMBER",
          "digitsAfterDecimal": 0,
          "isBaseCurrency": true,
          "lastModifiedDate": "string",
          "name": "string",
          "symbol": "string"
        },
        "description": "string",
        "encodedKey": "string",
        "glCode": "string",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "migrationEvent": {
          "creationDate": "2019-08-24T14:15:22Z",
          "encodedKey": "string",
          "numCentresImported": 0,
          "numClientsImported": 0,
          "numGLAccountsImported": 0,
          "numGroupsImported": 0,
          "numLoanRepaymentsImported": 0,
          "numLoanTransactionsImported": 0,
          "numLoansImported": 0,
          "numSavingsImported": 0,
          "state": "REVERTED",
          "type": "IMPORT"
        },
        "name": "string",
        "stripTrailingZeros": true,
        "type": "INCOME",
        "usage": "HEADER"
      },
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "financialResource": "FEE_RECEIVABLE",
      "index": 0,
      "predefinedFeeKey": "string",
      "productKey": "string",
      "productType": "LOAN",
      "transactionChannelKey": "string"
    }
  ],
  "templates": [
    {
      "creationDate": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "lastModifiedDate": "string",
      "name": "string",
      "type": "ACCOUNT"
    }
  ],
  "withholdingTaxEnabled": true
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	SavingsProductApiV1

Get Comments (savings products)

GET /savingsproducts/{savingsProductId}/comments

Get all Savings Product comments

Get all comments for a Savings Product

Parameters

Name	Type	Description	In
limit	string	none	query
offset	string	none	query
savingsProductId (required)	string	the ID of the Savings Product	path

Example Responses

200 : OK
an array of comments

[
  {
    "encodedKey": "8a19b7057471f4af017472dc0fd80470",
    "parentKey": "8a193c26722b51b701722d77c5e423b7",
    "userKey": "8a194075720ece2c017226fced6f005e",
    "creationDate": "2020-09-09T14:24:42+0000",
    "lastModifiedDate": "2020-09-09T14:24:42+0000",
    "text": "aanother afmaefomaef<div><br /></div><div><u>aefaefaf</u></div><div><u><br /></u></div><div><u>afaef</u></div>"
  },
  {
    "encodedKey": "8a193c26722b51b701722d77c8bf25ab",
    "parentKey": "8a193c26722b51b701722d77c5e423b7",
    "creationDate": "2020-05-19T15:05:24+0000",
    "lastModifiedDate": "2020-05-19T15:05:24+0000",
    "text": "Should suggest she apply for the agriculture loan given the nature of their business"
  }
]

400 : Bad Request
bad Savings Account ID

{
  "returnCode": 149,
  "returnStatus": "INVALID_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[CommentApiV1]	none	none
» creationDate	string(date-time)	the date and time at which this comment was added	none
» encodedKey	string	a unique key for this comment	none
» lastModifiedDate	string(date-time)	the date and time at which this comment was last modified	none
» parentKey	string	the unique key of the parent object for this comment, for example, the client or loan account to which it relates	none
» text	string	the text of the comment as a string, must be properly JSON escpaped if it contains special characters	none
» userKey	string	the unique key of the user who created the comment	none

Add Comment (savings products)

POST /savingsproducts/{savingsProductId}/comments

Create a Savings Account Comment

Create new comment for a Savings Product

Example Requests

a comment

{
  "comment": {
    "text": "this is a comment with \" \" all kinds of : \\ / \"non compliant\" stuff & = which has been JSON escaped"
  }
}

Parameters

Name	Type	Description	In
comment	object	an object contining the comment	body
» text	string	text of the comment to be added. if adding complex content make sure it is properly JSON encoded before making your request	body
savingsProductId (required)	string	the ID of the Savings Product	path

Example Responses

200 : OK
a comment

{
  "encodedKey": "8a19c34574720f9e0174734a039f06e2",
  "parentKey": "8a193c26722b51b701722d77c5e423b7",
  "userKey": "8a194075720ece2c017226fced6f005e",
  "creationDate": "2020-09-09T14:39:36+0000",
  "lastModifiedDate": "2020-09-09T14:39:36+0000",
  "text": "this is a comment with \" \" all kinds of : \\ / non compliant stuff & = which has been JSON escaped"
}

400 : Bad Request
extra parameters in the request

{
  "returnCode": 27,
  "returnStatus": "PARAMETER_NOT_ALLOWED"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	CommentApiV1
`400`	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Description	Restrictions
» returnCode	string	none	none
» returnStatus	string	none	none

Get Documents (savings products)

GET /savingsproducts/{savingsProductId}/documents

Get documents for a savings product

Get all documents for a given savings product

Parameters

Name	Type	Description	In
offset	integer	offset results. use with `limit` parameter to achieve paging	query
limit	integer	max number of records to return	query
savingsProductId (required)	string	The ID of the savings product	path

Example Responses

200 : ok
an array of documents

[
  {
    "encodedKey": "8a19c035747bf5b901747c5bfb04014b",
    "id": 51,
    "creationDate": "2020-09-11T08:52:48+0000",
    "lastModifiedDate": "2020-09-11T08:52:48+0000",
    "documentHolderKey": "8a193c26722b51b701722d779e7122df",
    "documentHolderType": "SAVINGS_PRODUCT",
    "name": "covid rules",
    "type": "png",
    "fileSize": 8258,
    "originalFilename": "Screenshot_2020-04-22_at_14.31.29.png",
    "location": "BRSIDSLFBOGAYZKUUKCOGGQEDOSEOD",
    "description": "some guidelines regarding covid",
    "createdByUserKey": "8a194075720ece2c017226fced6f005e",
    "userName": "big chief"
  },
  {
    "encodedKey": "8a19a3337476f2d00174775b6a3001ae",
    "id": 43,
    "creationDate": "2020-09-10T09:31:54+0000",
    "lastModifiedDate": "2020-09-10T09:31:54+0000",
    "documentHolderKey": "8a193c26722b51b701722d779e7122df",
    "documentHolderType": "SAVINGS_PRODUCT",
    "name": "savings product doc",
    "type": "png",
    "fileSize": 32109,
    "originalFilename": "clients_duplicate_id.png",
    "location": "JRTBQGGVXFQRQRBDGBRWQCTXJNRWXP",
    "description": "savings product doc desc",
    "createdByUserKey": "8a194075720ece2c017226fced6f005e",
    "userName": "big chief"
  }
]

400 : Bad Request
bad savings product ID

{
  "returnCode": 4,
  "returnStatus": "INVALID_PARAMETERS",
  "errorSource": "wrong owner id"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[DocumentApiV1]	none	none
» createdByUserKey	string	the encoded key of the user who added this document	none
» creationDate	string	the date and time when this document was created	none
» description	string	a description of this document	none
» documentHolderKey	string	the encoded key of the entity to which this document is attached	none
» documentHolderType	string	the type of entity, eg. client, loan product, to which this document is attached	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» fileSize	number	the size, in bytes, of the attached document	none
» id	number	an ID for this document	none
» lastModifiedDate	string	the date on which this document was last modified	none
» location	string	indicates where the document is saved	none
» name	string	the display name of this document	none
» originalFilename	string	the name of the originally uploaded file	none
» type	string	the file type of the document, eg. png, jpeg, pdf	none
» userName	string	the name of the user who uploaded the document	none

Enumerated Values

Property	Value
documentHolderType	`BRANCH`
documentHolderType	`LOAN_ACCOUNT`
documentHolderType	`GROUP`
documentHolderType	`DEPOSIT_ACCOUNT`
documentHolderType	`LINE_OF_CREDIT`
documentHolderType	`LOAN_PRODUCT`
documentHolderType	`GL_JOURNAL_ENTRY`
documentHolderType	`SAVINGS_PRODUCT`
documentHolderType	`USER`
documentHolderType	`CLIENT`
documentHolderType	`CENTRE`
documentHolderType	`ID_DOCUMENT`

Attach Document (savings products)

POST /savingsproducts/{savingsProductId}/documents

Attach new Document to a savings product

Attach a new document to a savings product

Example Requests

a document to uplaod

{
  "document": {
    "documentHolderKey": "8a193c26722b51b701722d779e7122df",
    "documentHolderType": "SAVINGS_PRODUCT",
    "name": "some image",
    "type": "png",
    "description": "this is an image file"
  },
  "documentContent": "iVBORw0KGgoAAAANSUhEUgAAAnYAAAF0CAYAAACudHRvAAABQGlDQ1BJQ0MgUHJvZmlsZQAAKJFjYGASS=="
}

Parameters

Name	Type	Description	In
body	CreateDocumentApiV1	a new document to be attached to an entity	body
savingsProductId (required)	string	The ID of the savings product	path

Example Responses

201 : Created
uploaded document details

{
  "encodedKey": "8a19c035747bf5b901747c5bfb04014d",
  "id": 52,
  "creationDate": "2020-09-11T08:54:53+0000",
  "lastModifiedDate": "2020-09-11T08:54:53+0000",
  "documentHolderKey": "8a193c26722b51b701722d779e7122df",
  "documentHolderType": "SAVINGS_PRODUCT",
  "name": "some image",
  "type": "png",
  "fileSize": 32109,
  "originalFilename": "some_image.png",
  "location": "RCPOUIUHJFBYDRURQNNHMOGBEFIOQF",
  "description": "this is an image file",
  "createdByUserKey": "8a194075720ece2c017226fced6f005e"
}

400 : Bad Request
filetype provided does not match actual file type

{
  "returnCode": 973,
  "returnStatus": "INCONSISTENT_EXTENSION_WITH_FILE_CONTENT",
  "errorSource": "Invalid extension with file content"
}

Responses

Status	Meaning	Description	Schema
`201`	Created	Created	DocumentApiV1
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Get Document by ID (savings products)

GET /savingsproducts/{savingsProductId}/documents/{documentId}

Get a savings product Document

Get a specific document attached to a savings product

Parameters

Name	Type	Description	In
savingsProductId (required)	string	the ID of the savings product	path
documentId (required)	string	the ID of the document	path

Example Responses

200 : OK
base64 encoded document

"iVBORw0KGgoAAAANSUhEUgAAAEAAAAA9CAYAAAAd1W/BAAAMY2lDQ1BJQ0MgUHJvZmlsZQAASImVVwdck0cbv3dkkrACEZAR9hJFZgAZIawIAjIFUQlJIGHEmBBE3NRSBesWUZxoVUTRagWkDkSssyhu6yiKqFRqsYoLle8yoNZ+4/c9v9+993+fe+7/jNzlvQNAr5Mvk+Wj+gAUSAvlCZGhrElp6SzSI4ABU0ADtsCTL1DIOPHxMQDKUP93eX0DIKr+qpuK65/j/1UMhSKFAAAkA=="

400 : Bad Request
bad Document ID

{
  "returnCode": 970,
  "returnStatus": "INVALID_DOCUMENT_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	string
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Delete Document (savings products)

DELETE /savingsproducts/{savingsProductId}/documents/{documentId}

Delete a savings product Document

Delete a document attached to a savings product

Parameters

Name	Type	Description	In
savingsProductId (required)	string	the ID of the savings product	path
documentId (required)	string	the ID of the document	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
bad Document ID

{
  "returnCode": 970,
  "returnStatus": "INVALID_DOCUMENT_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	ExecutionStatusApiV1
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Savings Transactions

Allows you to retrieve and post transactions for a savings account. Various transactions can be posted including:

Approving a savings account
Undo approving a savings accunt
Making a deposit
Making a withdrawal
Making a transfer
Applying a Fee
Closing a savings account

Search for Savings Transactions

POST /savings/transactions/search

Search for Savings Transactions

Allows to retrieve transactions using dynamic custom filters.

Parameters

Parameter	Value
filterConstraints	A JSON array of constraints.
filterSelection	The field on which the constraint will be applied. Available transaction filter selections can be found below.
filterElement	The constraint operator. Available filter elements can be found below.
value	The constraint value. Required for filter elements with one or two values.
secondValue	The constraint second value. Required for filter elements with two values.
dataItemType	The entity where the field on which to apply the constraint is located. If the field is located in the same entity with the entity being searched, this field is optional.

Available transaction filter values

Filter Selection Parameter	Data Type
PARENT_ACCOUNT_KEY	KEY
PRODUCT_TYPE_KEY	KEY
USER_KEY	KEY
BRANCH_KEY	KEY
CENTRE_KEY	KEY
PARENT_ACCOUNT_HOLDER_KEY	KEY
CURRENCY_CODE	KEY
PRODUCT_ID	STRING
WAS_REVERSED	BOOLEAN
TYPE_IS_REVERSAL	BOOLEAN
INTERNAL_TRANSFER	BOOLEAN
TRANSACTION_CHANNEL_KEY	KEY
ENCODED_KEY	KEY
TRANSACTION_ID	LONG
TILL_ID	STRING
ENTRY_DATE	DATE
TRANSACTION_DATE	DATE_UTC
EVENT	ENUM
AMOUNT	MONEY
ADVANCE_POSITION	MONEY
ARREARS_POSITION	MONEY
EXPECTED_PRINCIPAL_REDRAW	MONEY
ORIGINAL_AMOUNT	MONEY
ORIGINAL_AMOUNT_CURRENCY_CODE	STRING
BALANCE (Deprecated. Use TOTAL_BALANCE)	MONEY
TOTAL_BALANCE	MONEY
PRINCIPAL_BALANCE	MONEY
REDRAW_BALANCE	MONEY
PRINCIPAL_PAID	MONEY
INTEREST_PAID	MONEY
DEFERRED_INTEREST	MONEY
FEES_PAID	MONEY
FEE_KEY	KEY
FEE_TYPE	ENUM
PENALTY_PAID	MONEY
BRANCH	STRING
CENTRE	STRING
PARENT_ACCOUNT	STRING
PARENT_ACCOUNT_ID	STRING
PARENT_ACCOUNT_HOLDER	STRING
PARENT_ACCOUNT_HOLDER_ID	STRING
TAX_RATE	BIG_DECIMAL
TAX_AMOUNT	MONEY
INTEREST_RATE	BIG_DECIMAL
PRINCIPAL_PAYMENT_FLAT_AMOUNT	MONEY
PRINCIPAL_PAYMENT_PERCENTAGE	BIG_DECIMAL
OVERDRAFT_INTEREST_RATE	BIG_DECIMAL
OVERDRAFT_LIMIT	MONEY

Filter Element	Number Of affected values	Available for
EQUALS	ONE_VALUE	BIG_DECIMAL,BOOLEAN,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY
EQUALS_CASE_SENSITIVE	ONE_VALUE	BIG_DECIMAL,BOOLEAN,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY
MORE_THAN	ONE_VALUE	BIG_DECIMAL,NUMBER,MONEY
LESS_THAN	ONE_VALUE	BIG_DECIMAL,NUMBER,MONEY
BETWEEN	TWO_VALUES	BIG_DECIMAL,NUMBER,MONEY,DATE,DATE_UTC
ON	ONE_VALUE	DATE,DATE_UTC
AFTER	ONE_VALUE	DATE,DATE_UTC
BEFORE	ONE_VALUE	DATE,DATE_UTC
STARTS_WITH	ONE_VALUE	STRING
IN	LIST	ENUM,KEY
TODAY	NO_VALUE	DATE,DATE_UTC
THIS_WEEK	NO_VALUE	DATE,DATE_UTC
THIS_MONTH	NO_VALUE	DATE,DATE_UTC
THIS_YEAR	NO_VALUE	DATE,DATE_UTC
LAST_DAYS	ONE_VALUE	DATE,DATE_UTC
EMPTY	NO_VALUE	BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_UTC
NOT_EMPTY	NO_VALUE	BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_UTC

Optimising searches:
Use EQUALS_CASE_SENSITIVE when searching by transaction id or account parent id as the performance is better than EQUALS. It can be used in all situations where we know precisely the case of the supplied value.

Example Requests

{
  "filterConstraints": [
    {
      "dataFieldType": "string",
      "dataItemType": "string",
      "filterElement": "string",
      "filterSelection": "string",
      "secondValue": "string",
      "value": "string",
      "values": [
        "string"
      ]
    }
  ],
  "sortDetails": {
    "dataFieldType": "string",
    "dataItemType": "string",
    "sortingColumn": "string",
    "sortingOrder": "string"
  }
}

Parameters

Name	Type	Description	In
offset	integer	none	query
limit	integer	none	query
body	FilterApiV1	none	body

Example Responses

200 Response

[
  {
    "amount": 0,
    "balance": 0,
    "bookingDate": "string",
    "branchKey": "string",
    "centreKey": "string",
    "comment": "string",
    "creationDate": "string",
    "currencyCode": "string",
    "customInformation": [
      {
        "amount": 0,
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "customFieldID": "string",
        "customFieldKey": "string",
        "customFieldSetGroupIndex": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexInList": 0,
        "linkedEntityKeyValue": "string",
        "parentKey": "string",
        "selectionKey": "string",
        "value": "string"
      }
    ],
    "details": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "internalTransfer": true,
      "targetSavingsAccountKey": "string",
      "transactionChannel": {
        "activated": true,
        "createdByUserKey": "string",
        "creationDate": "string",
        "customFields": [
          {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          }
        ],
        "encodedKey": "string",
        "id": "string",
        "index": 0,
        "loanConstraints": {
          "customConfigurationInfo": {
            "creationDate": "string",
            "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "shared": true,
            "userKey": "string"
          },
          "encodedKey": "string",
          "filterConstraints": [
            {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            }
          ]
        },
        "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
        "name": "string",
        "savingsConstraints": {
          "customConfigurationInfo": {
            "creationDate": "string",
            "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "shared": true,
            "userKey": "string"
          },
          "encodedKey": "string",
          "filterConstraints": [
            {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            }
          ]
        },
        "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
        "transactionChannelAccountingRule": {
          "account": {
            "activated": true,
            "allowManualJournalEntries": true,
            "balance": 0,
            "creationDate": "2019-08-24T14:15:22Z",
            "currency": {
              "code": "string",
              "creationDate": "string",
              "currencySymbolPosition": "AFTER_NUMBER",
              "digitsAfterDecimal": 0,
              "isBaseCurrency": true,
              "lastModifiedDate": "string",
              "name": "string",
              "symbol": "string"
            },
            "description": "string",
            "encodedKey": "string",
            "glCode": "string",
            "lastModifiedDate": "2019-08-24T14:15:22Z",
            "migrationEvent": {
              "creationDate": "2019-08-24T14:15:22Z",
              "encodedKey": "string",
              "numCentresImported": 0,
              "numClientsImported": 0,
              "numGLAccountsImported": 0,
              "numGroupsImported": 0,
              "numLoanRepaymentsImported": 0,
              "numLoanTransactionsImported": 0,
              "numLoansImported": 0,
              "numSavingsImported": 0,
              "state": "REVERTED",
              "type": "IMPORT"
            },
            "name": "string",
            "stripTrailingZeros": true,
            "type": "INCOME",
            "usage": "HEADER"
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "financialResource": "FEE_RECEIVABLE",
          "index": 0,
          "predefinedFeeKey": "string",
          "productKey": "string",
          "productType": "LOAN",
          "transactionChannelKey": "string"
        },
        "usageRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "transactionChannelKey": "string"
    },
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "entryDate": "string",
    "feesAmount": 0,
    "feesPaid": 0,
    "fractionAmount": 0,
    "fundsAmount": 0,
    "interestAmount": 0,
    "interestPaid": 0,
    "interestRate": 0,
    "linkedLoanTransactionKey": "string",
    "linkedSavingsTransactionKey": "string",
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "overdraftAmount": 0,
    "overdraftIndexRate": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "notes": "string",
      "rate": 0,
      "rateSource": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "name": "string",
        "notes": "string",
        "type": "TAX_RATE"
      },
      "startDate": "string",
      "userKey": "string"
    },
    "overdraftInterestRate": 0,
    "overdraftLimit": 0,
    "parentAccountKey": "string",
    "preciseInterestAmount": 0,
    "productTypeKey": "string",
    "reversalTransactionKey": "string",
    "savingsPredefinedFeeAmounts": [
      {
        "amortizedAmounts": [
          {
            "amount": 0,
            "branchKey": "string",
            "centreKey": "string",
            "creationDate": "string",
            "encodedKey": "string",
            "entryDate": "string",
            "reversalAmountKey": "string",
            "taxAmount": 0,
            "type": "AMORTIZATION_ADJUSTMENT"
          }
        ],
        "amount": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "fee": {
          "active": true,
          "amortizationIntervalSettings": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
            "intervalCount": 0,
            "intervalType": "FULL_TERM",
            "periodCount": 0,
            "periodUnit": "MONTHS"
          },
          "amortizationProfile": "STRAIGHT_LINE",
          "amount": 0,
          "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
          "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
          "creationDate": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
          "feeApplication": "OPTIONAL",
          "feeProductRules": [
            {
              "account": {
                "activated": true,
                "allowManualJournalEntries": true,
                "balance": 0,
                "creationDate": "2019-08-24T14:15:22Z",
                "currency": {
                  "code": "string",
                  "creationDate": "string",
                  "currencySymbolPosition": "AFTER_NUMBER",
                  "digitsAfterDecimal": 0,
                  "isBaseCurrency": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "symbol": "string"
                },
                "description": "string",
                "encodedKey": "string",
                "glCode": "string",
                "lastModifiedDate": "2019-08-24T14:15:22Z",
                "migrationEvent": {
                  "creationDate": "2019-08-24T14:15:22Z",
                  "encodedKey": "string",
                  "numCentresImported": 0,
                  "numClientsImported": 0,
                  "numGLAccountsImported": 0,
                  "numGroupsImported": 0,
                  "numLoanRepaymentsImported": 0,
                  "numLoanTransactionsImported": 0,
                  "numLoansImported": 0,
                  "numSavingsImported": 0,
                  "state": "REVERTED",
                  "type": "IMPORT"
                },
                "name": "string",
                "stripTrailingZeros": true,
                "type": "INCOME",
                "usage": "HEADER"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "financialResource": "FEE_RECEIVABLE",
              "index": 0,
              "predefinedFeeKey": "string",
              "productKey": "string",
              "productType": "LOAN",
              "transactionChannelKey": "string"
            }
          ],
          "name": "string",
          "percentageAmount": 0,
          "trigger": "DISBURSEMENT"
        },
        "taxAmount": 0,
        "transactionId": 0
      }
    ],
    "taxRate": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "notes": "string",
      "rate": 0,
      "rateSource": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "name": "string",
        "notes": "string",
        "type": "TAX_RATE"
      },
      "startDate": "string",
      "userKey": "string"
    },
    "technicalOverdraftAmount": 0,
    "technicalOverdraftInterestAmount": 0,
    "tillKey": "string",
    "transactionId": 0,
    "type": "LOAN_FRACTION_SOLD",
    "userKey": "string",
    "valueDate": "string"
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[SavingsTransactionApiV1]	none	none
» amount	number	none	none
» balance	number	none	none
» bookingDate	string	none	none
» branchKey	string	none	none
» centreKey	string	none	none
» comment	string	none	none
» creationDate	string	the date and time when this savings transaction was created	none
» currencyCode	string	none	none
» customInformation	[CustomFieldValueApiV1]	none	none
»» amount	number	none	none
»» customField	CustomFieldApiV1	none	none
»»» amounts	object	used when options available for a custom field definition translate to predefined amounts, for example, when the custom field value is used to generate a score	none
»»»» additionalProperties	number	none	none
»»» builtInCustomFieldId	string	if this field is one of the built in custom fiel definitions, this will have a value. These names are reserved and you can not use them for your own custom field definitions	none
»»» creationDate	string	the date on which this custom field definition was created	none
»»» customFieldProductSettings	[CustomFieldLinkApiV1]	none	none
»»»» customFieldEncodedKey	string	the key to the parent custom field definition	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isDefault	boolean	whether this field is displayed by default when creating a new record	none
»»»» isRequired	boolean	whether this field is required when creating a new record	none
»»»» linkType	string	the type of entity this field represents a link to	none
»»»» productKey	string	when the link type is product, this field should contain the encoded key of the linekd product	none
»»» customFieldSelectionOptions	[CustomFieldSelectionApiV1]	[represents a possible selection for select type custom field definitions]	none
»»»» constraint	CustomFilterConstraintApiV1	none	none
»»»»» customFieldKey	string	none	none
»»»»» dataFieldType	string	none	none
»»»»» dataFieldValue	string	none	none
»»»»» dataItemType	string	none	none
»»»»» dataType	string	none	none
»»»»» encodedKey	string	none	none
»»»»» filterElement	string	none	none
»»»»» groupNumber	number	none	none
»»»»» index	number	none	none
»»»»» linkingOperator	string	none	none
»»»»» secondValue	string	none	none
»»»»» value	string	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this selectable item	none
»»»» score	number	the score assigned to this selection	none
»»»» value	string	display name of this option	none
»»» customFieldSet	CustomFieldSetApiV1	none	none
»»»» builtInType	string	if this set is part of the set of built-in custom field sets, its type will be shown here	none
»»»» createdDate	string	the date and time when this custom field set was created	none
»»»» customFields	[CustomFieldApiV1]	an array of custom field definitions included in this custom field set	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this custom field set	none
»»»» indexInList	number	for field sets that can be added to an entity more than once, this number represents the index in the list and is used when changing values	none
»»»» lastModifiedDate	string	the date on which this custom field set was last modified	none
»»»» name	string	the name of this custom field set	none
»»»» notes	string	any notes regarding this custom field set	none
»»»» type	string	the entity type that this custom field definition is attached to	none
»»»» usage	string	whether this custom field set can only be used once, or added multiple times to the same entity	none
»»» dataType	string	the type of custom field definition	none
»»» description	string	a brief description of this custom field definition	none
»»» editRights	UsageRightsApiV1	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isAccessibleByAllUsers	boolean	none	none
»»»» roles	[string]	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» id	string	the ID for this custom field definition	none
»»» indexInList	number	none	none
»»» isDefault	boolean	whether this field will be included by default on new records	none
»»» isRequired	boolean	whether this field is required when creating a new record	none
»»» lastModifiedDate	string	the date on which this custom field definition was last modified	none
»»» name	string	the name of this custom field definition	none
»»» state	string	whether this field is available for use or has been deactivated	none
»»» type	string	the type of data this custom field definition will contain	none
»»» unique	boolean	whether the data in this custom field definition needs to be a unique value	none
»»» validationPattern	string	a user-provided pattern to which data in this custom field definition must conform where @ represents numbers, # represents letters and $ is either a number or letter. Other special characters used as separators are allowed, for example `@@-##-$$$`	none
»»» valueLength	string	whether this field needs to support a large number of characters	none
»»» values	[string]	a list of possible values when the field is a selection field	none
»»» viewRights	UsageRightsApiV1	none	none
»» customFieldID	string	none	none
»» customFieldKey	string	none	none
»» customFieldSetGroupIndex	number	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» indexInList	number	none	none
»» linkedEntityKeyValue	string	none	none
»» parentKey	string	none	none
»» selectionKey	string	none	none
»» value	string	none	none
» details	TransactionDetailsApiV1	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» internalTransfer	boolean	none	none
»» targetSavingsAccountKey	string	none	none
»» transactionChannel	TransactionChannelInTransactionDetailsApiV1	none	none
»»» activated	boolean	whether this transaction channel is enabled	none
»»» createdByUserKey	string	the encoded key of the user who created this transaction channel	none
»»» creationDate	string	the date on which this transaction channel was created	none
»»» customFields	[CustomFieldApiV1]	none	none
»»» encodedKey	string	the encoded key for this transaction channel	none
»»» id	string	the user specified ID for this transaction channel	none
»»» index	number	none	none
»»» loanConstraints	CustomFilterApiV1	none	none
»»»» customConfigurationInfo	CustomConfigurationInfoApiV1	none	none
»»»»» creationDate	string	the date on which this configuration was created	none
»»»»» dataViewType	string	the type of entity this configuration is for	none
»»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»»» indexInList	number	if more than one configuration exists for a given type, this is its index in the list	none
»»»»» lastModifiedDate	string	the date on which this configuration was last modified	none
»»»»» name	string	the name for this configuration	none
»»»»» shared	boolean	whether this configuration is private or can be used by other users of the system	none
»»»»» userKey	string	the encoded key of the Mambu user who created this configuration	none
»»»» encodedKey	string	none	none
»»»» filterConstraints	[CustomFilterConstraintApiV1]	none	none
»»» loanConstraintsUsage	string	whether there are any rules regarding usage of this transaction channel with loan accounts	none
»»» name	string	the name of this transaction channel	none
»»» savingsConstraints	CustomFilterApiV1	none	none
»»» savingsConstraintsUsage	string	whether there are any rules regarding usage of this transaction channel with savings accounts	none
»»» transactionChannelAccountingRule	GLAccountingRuleApiV1	none	none
»»»» account	GLAccountApiV1	A general ledger account	none
»»»»» activated	boolean	whether this general ledger account is in use	none
»»»»» allowManualJournalEntries	boolean	whether manual entries are allowed for this general ledger account	none
»»»»» balance	number	the current balance of this general ledger account	none
»»»»» creationDate	string(date-time)	the date on which this general ledger account was created	read-only
»»»»» currency	CurrencyApiV1	none	none
»»»»»» code	string	the three letter ISO code for this currency	none
»»»»»» creationDate	string	the date on which this currency was created	none
»»»»»» currencySymbolPosition	string	indicates where the currency symbol should appear in relation to the numeric value	none
»»»»»» digitsAfterDecimal	number	indicates how many decimal places are allowed for this currency. For example, a currenncy with 100 minor units to 1 major unit, there will be 2 decimal places.	none
»»»»»» isBaseCurrency	boolean	whether this currency is the base currency for your banking institution	none
»»»»»» lastModifiedDate	string	the date on which this currency was last modified	none
»»»»»» name	string	the name of this currency	none
»»»»»» symbol	string	the currency symnbol used for this currency	none
»»»»» description	string	an optional description for this general ledger account	none
»»»»» encodedKey	string	the encoded key of this general ledger account	none
»»»»» glCode	string	the numeric code for this general ledger account	none
»»»»» lastModifiedDate	string(date-time)	the date on which this general ledger account was last modified	read-only
»»»»» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
»»»»»» creationDate	string(date-time)	the date on which the data import was made	none
»»»»»» encodedKey	string	the encoded key of this data migration event	none
»»»»»» numCentresImported	number	the number of centres which were imported during the data migration	none
»»»»»» numClientsImported	number	the number of clients which were imported as part of the data migration	none
»»»»»» numGLAccountsImported	number	the number of general ledger accounts which were imported as part of the data migration	none
»»»»»» numGroupsImported	number	the number of groups which were imported as part of the data migration	none
»»»»»» numLoanRepaymentsImported	number	the number of loan repayment transations which were imported as part of the data migration	none
»»»»»» numLoanTransactionsImported	number	the number of loan transactions which were imported as part of the data migration	none
»»»»»» numLoansImported	number	the number of loan accounts which were imported as part of the data migration	none
»»»»»» numSavingsImported	number	the number of savings accounts which were imported as part of the data migration	none
»»»»»» state	string	whether the data import was accepted, is still in a draft state, or was rejected and all data reverted	none
»»»»»» type	string	the type of migration event	none
»»»»» name	string	the name of this general ledger account	none
»»»»» stripTrailingZeros	boolean	controls how this account is organized into header accounts when there are trailing zeroes, for example, for the account code `1100`, if this field is set to true, only the first two numbers will be recognised	none
»»»»» type	string	the type of general ledger account	none
»»»»» usage	string	whether this general ledger account is a `DETAIL` account, in which case it will have a value, or a `HEADER` account, in which case its value will be calculated based on the sum of detail accounts under it.	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» financialResource	string	the type of transaction governed by this rule	none
»»»» index	number	the index in list when there are multiple rules for the same type of transaction	none
»»»» predefinedFeeKey	string	the encoded key of the predefined key this rule relates to	none
»»»» productKey	string	the encoded key of the product this rule relates to	none
»»»» productType	string	the type of account this rule relates to	none
»»»» transactionChannelKey	string	the encoded key of the transaction channel that this rule relates to	none
»»» usageRights	UsageRightsApiV1	none	none
»» transactionChannelKey	string	none	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» entryDate	string	none	none
» feesAmount	number	none	none
» feesPaid	number	none	none
» fractionAmount	number	none	none
» fundsAmount	number	none	none
» interestAmount	number	none	none
» interestPaid	number	none	none
» interestRate	number	none	none
» linkedLoanTransactionKey	string	none	none
» linkedSavingsTransactionKey	string	none	none
» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
» overdraftAmount	number	none	none
» overdraftIndexRate	IndexRateApiV1	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» notes	string	any notes relating to this index rate	none
»» rate	number	the percentage rate for this tax or interest rate	none
»» rateSource	IndexRateSourceApiV1	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» name	string	the name of this index rate source, eg. LIBOR	none
»»» notes	string	any notes relating to this index rate	none
»»» type	string	what kind of rate this source provides, eg. tax, interest, withholding tax	none
»» startDate	string	the first day on which this rate is considered valid	none
»» userKey	string	the encoded key of the user who added this index rate	none
» overdraftInterestRate	number	none	none
» overdraftLimit	number	none	none
» parentAccountKey	string	none	none
» preciseInterestAmount	number	none	none
» productTypeKey	string	none	none
» reversalTransactionKey	string	none	none
» savingsPredefinedFeeAmounts	[PredefinedFeeAmountApiV1]	none	none
»» amortizedAmounts	[AmortizationAmountApiV1]	none	none
»»» amount	number	the amount to be amortized	none
»»» branchKey	string	the encoded key of the branch owning the amount	none
»»» centreKey	string	the encoded key of the centre owning the amount	none
»»» creationDate	string	the date on which the amortization amount was created	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» entryDate	string	the date when this amount was recognised as amortized (in organization time)	none
»»» reversalAmountKey	string	if the amount was reversed, this field will contain the encoded key of the reversal record	none
»»» taxAmount	number	the amount of tax included in the amortized amount	none
»»» type	string	the type of entry represented by this object	none
»» amount	number	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» fee	PredefinedFeeApiV1	none	none
»»» active	boolean	none	none
»»» amortizationIntervalSettings	PeriodIntervalSettingsApiV1	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» frequency	string	none	none
»»»» intervalCount	number	none	none
»»»» intervalType	string	none	none
»»»» periodCount	number	none	none
»»»» periodUnit	string	none	none
»»» amortizationProfile	string	none	none
»»» amount	number	none	none
»»» amountCalculationMethod	string	none	none
»»» applyDateMethod	string	none	none
»»» creationDate	string	the date and time when this fee was created	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» feeAmortizationUponRescheduleOption	string	none	none
»»» feeApplication	string	none	none
»»» feeProductRules	[GLAccountingRuleApiV1]	none	none
»»» name	string	none	none
»»» percentageAmount	number	none	none
»»» trigger	string	none	none
»» taxAmount	number	none	none
»» transactionId	number	none	none
» taxRate	IndexRateApiV1	none	none
» technicalOverdraftAmount	number	none	none
» technicalOverdraftInterestAmount	number	none	none
» tillKey	string	none	none
» transactionId	number	none	none
» type	string	none	none
» userKey	string	none	none
» valueDate	string	none	none

Enumerated Values

Property	Value
builtInCustomFieldId	`MOBILE_PHONE`
builtInCustomFieldId	`EMAIL_ADDRESS`
builtInCustomFieldId	`GENDER`
builtInCustomFieldId	`MIDDLE_NAME`
builtInCustomFieldId	`HOME_PHONE`
builtInCustomFieldId	`BIRTHDATE`
builtInCustomFieldId	`LAST_NAME`
builtInCustomFieldId	`FIRST_NAME`
linkType	`CLIENT_ROLE`
linkType	`CHANNEL`
linkType	`PRODUCT`
dataFieldType	`NATIVE`
dataFieldType	`CUSTOM`
dataItemType	`WRITTEN_OFF_LOANS`
dataItemType	`LINE_OF_CREDIT`
dataItemType	`INVESTOR_FUND`
dataItemType	`TRANSACTION_DETAILS`
dataItemType	`DOCUMENT_TEMPLATE`
dataItemType	`PRODUCT`
dataItemType	`MCC_EXPIRATION`
dataItemType	`CENTRE`
dataItemType	`REPAYMENT_COLLECTION`
dataItemType	`TASK`
dataItemType	`OUTSTANDING_PORTFOLIO_AMOUNTS`
dataItemType	`REVENUE`
dataItemType	`COMPOSED_TRANSACTIONS`
dataItemType	`UNION_TRANSACTIONS`
dataItemType	`PRINCIPAL_PAYMENT_SETTINGS`
dataItemType	`LOANS`
dataItemType	`DISBURSEMENT_DETAILS`
dataItemType	`SAVINGS_TRANSACTION`
dataItemType	`IDENTIFICATION_DOCUMENT`
dataItemType	`LOAN_PRODUCT`
dataItemType	`DISBURSED_LOANS`
dataItemType	`LOAN_GROUP`
dataItemType	`TRANSACTION_CHANNEL`
dataItemType	`CUSTOM_PREDEFINED_FEE`
dataItemType	`JOURNAL_ENTRY`
dataItemType	`ATTACHMENT`
dataItemType	`PREDEFINED_FEE`
dataItemType	`TRANCHE`
dataItemType	`TRANSACTION`
dataItemType	`INDEX_RATE_SOURCE`
dataItemType	`GROUP_ROLE`
dataItemType	`LOAN_TRANSACTION`
dataItemType	`CLIENT_ROLE`
dataItemType	`GROUP`
dataItemType	`NOTIFICATION_MESSAGE`
dataItemType	`OUTSTANDING_PORTFOLIO_ACCOUNTS`
dataItemType	`REPAYMENT`
dataItemType	`LOAN_ACCOUNT_GUARANTY`
dataItemType	`BRANCH`
dataItemType	`CURRENCY`
dataItemType	`CARD_TRANSACTION_REVERSAL`
dataItemType	`INTEREST_PRODUCT_SETTINGS`
dataItemType	`CREATED_ACCOUNTS`
dataItemType	`USER`
dataItemType	`SAVINGS_PRODUCT`
dataItemType	`CLIENT`
dataItemType	`PRODUCT_ARREARS_SETTINGS`
dataItemType	`SAVINGS`
dataItemType	`EXPENSE`
dataItemType	`INDEX_RATE`
dataItemType	`NOTIFICATION_TEMPLATE`
dataItemType	`CUSTOM_FIELD_SELECTION`
dataItemType	`ACTIVITY`
dataType	`ENUM`
dataType	`MONEY`
dataType	`NUMBER`
dataType	`DATE_UTC`
dataType	`JAVA_BLOB`
dataType	`OBJECT`
dataType	`BOOLEAN`
dataType	`DATE`
dataType	`PERCENT`
dataType	`BIG_DECIMAL`
dataType	`STRING`
dataType	`KEY`
dataType	`LONG`
filterElement	`STARTS_WITH_CASE_SENSITIVE`
filterElement	`THIS_WEEK`
filterElement	`EQUALS`
filterElement	`STARTS_WITH`
filterElement	`IN`
filterElement	`TODAY`
filterElement	`THIS_YEAR`
filterElement	`BETWEEN`
filterElement	`AFTER`
filterElement	`LESS_THAN`
filterElement	`DIFFERENT_THAN`
filterElement	`THIS_MONTH`
filterElement	`NOT_EMPTY`
filterElement	`BEFORE`
filterElement	`EQUALS_CASE_SENSITIVE`
filterElement	`LAST_DAYS`
filterElement	`MORE_THAN`
filterElement	`EMPTY`
filterElement	`ON`
linkingOperator	`OR`
linkingOperator	`AND`
builtInType	`DETAILS`
builtInType	`GENERAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
usage	`SINGLE`
usage	`GROUPED`
dataType	`GROUP_LINK`
dataType	`DATE`
dataType	`NUMBER`
dataType	`CHECKBOX`
dataType	`CLIENT_LINK`
dataType	`STRING`
dataType	`USER_LINK`
dataType	`SELECTION`
state	`DEACTIVATED`
state	`NORMAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
valueLength	`SHORT`
valueLength	`LONG`
dataViewType	`PORTAL_ACCOUNT_TRANSACTION`
dataViewType	`LOANS_AGING_ANALYSIS`
dataViewType	`CLOSED_ACCOUNTS`
dataViewType	`CLIENT_OVERVIEW`
dataViewType	`ADMIN_CENTRES`
dataViewType	`USER_NOTIFICATION_MESSAGES`
dataViewType	`LINE_OF_CREDIT`
dataViewType	`USER_OVERVIEW`
dataViewType	`CENTRE_OVERVIEW`
dataViewType	`REPAYMENT_REPAYMENTS_COLLECTION`
dataViewType	`GROUP_OVERVIEW`
dataViewType	`ACTIVITIES_LOOKUP`
dataViewType	`TRANSACTION`
dataViewType	`ADMIN_BRANCHES`
dataViewType	`GROUP`
dataViewType	`BRANCH_OVERVIEW`
dataViewType	`NOTIFICATION_MESSAGE`
dataViewType	`PORTFOLIO_REPORTS`
dataViewType	`GROUP_NOTIFICATION_MESSAGES`
dataViewType	`LOAN_ACCOUNT_SECURITIES_OVERVIEW`
dataViewType	`LINE_OF_CREDIT_OVERVIEW`
dataViewType	`CURRENCIES`
dataViewType	`REPAYMENT`
dataViewType	`TILL_TRANSACTIONS`
dataViewType	`ALL_TASKS`
dataViewType	`CENTRE`
dataViewType	`BRANCH`
dataViewType	`INDEX_RATES_LIST`
dataViewType	`USER_TASKS`
dataViewType	`DOCUMENT_TEMPLATES`
dataViewType	`SAVINGS_TRANSACTIONS_LOOKUP`
dataViewType	`LOAN_ACCOUNT_OVERVIEW`
dataViewType	`DEPOSITS_COLLECTION`
dataViewType	`USER`
dataViewType	`ADMIN_USERS`
dataViewType	`GROUP_TASKS`
dataViewType	`CLIENT`
dataViewType	`LOAN_TRANSACTIONS_LOOKUP`
dataViewType	`LOANS`
dataViewType	`LOANS_REPAYMENTS_COLLECTION`
dataViewType	`CLIENT_TASKS`
dataViewType	`OVERDRAFTS_AGING_ANALYSIS`
dataViewType	`LOAN_ACCOUNT_FUNDING_OVERVIEW`
dataViewType	`SAVINGS`
dataViewType	`SAVINGS_OVERVIEW`
dataViewType	`JOURNAL_ENTRY`
dataViewType	`CLIENT_NOTIFICATION_MESSAGES`
loanConstraintsUsage	`UNCONSTRAINED_USAGE`
loanConstraintsUsage	`LIMITED_USAGE`
savingsConstraintsUsage	`UNCONSTRAINED_USAGE`
savingsConstraintsUsage	`LIMITED_USAGE`
currencySymbolPosition	`AFTER_NUMBER`
currencySymbolPosition	`BEFORE_NUMBER`
state	`REVERTED`
state	`DRAFT`
state	`APPROVED`
type	`IMPORT`
type	`EXPORT`
type	`INCOME`
type	`EXPENSE`
type	`LIABILITY`
type	`ASSET`
type	`EQUITY`
usage	`HEADER`
usage	`DETAIL`
financialResource	`FEE_RECEIVABLE`
financialResource	`OVERDRAFT_INTEREST_INCOME`
financialResource	`OVERDRAFT_INTEREST_RECEIVABLE`
financialResource	`FEE_INCOME`
financialResource	`INTEREST_PAYABLE`
financialResource	`INTEREST_EXPENSE`
financialResource	`PENALTY_RECEIVABLE`
financialResource	`INTEREST_INCOME`
financialResource	`DEFERRED_TAXES`
financialResource	`DEFERRED_FEE_INCOME`
financialResource	`PORTFOLIO_CONTROL`
financialResource	`DEFERRED_INTERESTS_INCOME`
financialResource	`OVERDRAFT_WRITE_OFF_EXPENSE`
financialResource	`PENALTY_INCOME`
financialResource	`OVERDRAFT_PORTFOLIO_CONTROL`
financialResource	`SAVINGS_CONTROL`
financialResource	`TAXES_RECEIVABLE`
financialResource	`INTEREST_RECEIVABLE`
financialResource	`INTER_BRANCH_TRANSFER`
financialResource	`FUND_SOURCE`
financialResource	`WRITE_OFF_EXPENSE`
financialResource	`DEPOSIT_REFERENCE`
financialResource	`TAXES_PAYABLE`
productType	`LOAN`
productType	`SAVINGS`
type	`TAX_RATE`
type	`INTEREST_RATE`
type	`WITHHOLDING_TAX_RATE`
type	`AMORTIZATION_ADJUSTMENT`
type	`AMORTIZATION_CORRECTION`
type	`AMORTIZATION`
frequency	`ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING`
frequency	`ACCOUNT_INSTALLMENTS_DUE_DATES`
frequency	`CUSTOM_INTERVAL`
intervalType	`FULL_TERM`
intervalType	`PREDEFINED_INTERVALS`
periodUnit	`MONTHS`
periodUnit	`YEARS`
periodUnit	`WEEKS`
periodUnit	`DAYS`
amortizationProfile	`STRAIGHT_LINE`
amortizationProfile	`SUM_OF_YEARS_DIGITS`
amortizationProfile	`EFFECTIVE_INTEREST_RATE`
amortizationProfile	`NONE`
amountCalculationMethod	`LOAN_AMOUNT_PERCENTAGE`
amountCalculationMethod	`LOAN_AMOUNT_PERCENTAGE_NUMBER_OF_INSTALLMENTS`
amountCalculationMethod	`REPAYMENT_PRINCIPAL_AMOUNT_PERCENTAGE`
amountCalculationMethod	`FLAT_NUMBER_OF_INSTALLMENTS`
amountCalculationMethod	`FLAT`
applyDateMethod	`MONTHLY_FROM_ACTIVATION`
applyDateMethod	`FIRST_OF_EVERY_MONTH`
feeAmortizationUponRescheduleOption	`CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT`
feeAmortizationUponRescheduleOption	`END_AMORTIZATION_ON_THE_ORIGINAL_ACCOUNT`
feeApplication	`OPTIONAL`
feeApplication	`REQUIRED`
trigger	`DISBURSEMENT`
trigger	`ARBITRARY`
trigger	`CAPITALIZED_DISBURSEMENT`
trigger	`MONTHLY_FEE`
trigger	`UPFRONT_DISBURSEMENT`
trigger	`LATE_REPAYMENT`
trigger	`MANUAL`
trigger	`PAYMENT_DUE`
trigger	`PAYMENT_DUE_APPLIED_ON_DUE_DATES`
type	`LOAN_FRACTION_SOLD`
type	`WRITE_OFF_ADJUSTMENT`
type	`LOAN_FUNDED_ADJUSTMENT`
type	`LOAN_FRACTION_SOLD_ADJUSTMENT`
type	`DEPOSIT`
type	`LOAN_REPAID_ADJUSTMENT`
type	`FEE_REDUCTION_ADJUSTMENT`
type	`IMPORT`
type	`LOAN_FUNDED`
type	`TRANSFER_ADJUSTMENT`
type	`TRANSFER`
type	`LOAN_FRACTION_BOUGHT_ADJUSTMENT`
type	`WRITE_OFF`
type	`WITHDRAWAL_ADJUSTMENT`
type	`LOAN_FRACTION_BOUGHT`
type	`FEE_APPLIED`
type	`FEES_DUE_REDUCED`
type	`WITHHOLDING_TAX`
type	`CARD_TRANSACTION_REVERSAL`
type	`OVERDRAFT_LIMIT_CHANGED`
type	`INTEREST_APPLIED`
type	`INTEREST_APPLIED_ADJUSTMENT`
type	`ADJUSTMENT`
type	`WITHHOLDING_TAX_ADJUSTMENT`
type	`FEE_ADJUSTED`
type	`LOAN_REPAID`
type	`BRANCH_CHANGED`
type	`OVERDRAFT_INTEREST_RATE_CHANGED`
type	`WITHDRAWAL`
type	`INTEREST_RATE_CHANGED`

Get Savings Transactions

GET /savings/{savingsAccountId}/transactions

Get Savings Transactions

Allows for retrieving savings transactions for a specific account. Transactions are returned in order sorted by most recent to oldest.

Parameters

Name	Type	Description	In
offset	string	Start at index X. Use the `limit` parameter to achieve paging.	query
limit	string	Max number of records to return.	query
savingsAccountId	string	none	path

Example Responses

200 : OK
An array of transactions

[
  {
    "encodedKey": "8a19bf9a744688ce017446891a54021e",
    "transactionId": 22,
    "parentAccountKey": "8a19df6972b787fc0172b8c7b0e70bc1",
    "type": "FEE_APPLIED",
    "creationDate": "2020-08-31T22:00:25+0000",
    "entryDate": "2020-09-01T00:00:00+0000",
    "amount": "-50",
    "interestAmount": "0",
    "feesAmount": "50",
    "overdraftAmount": "0",
    "technicalOverdraftAmount": "0",
    "fundsAmount": "0",
    "feesPaid": "0",
    "interestPaid": "0",
    "technicalOverdraftInterestAmount": "0",
    "fractionAmount": "0",
    "preciseInterestAmount": "0",
    "balance": "2850",
    "savingsPredefinedFeeAmounts": [],
    "productTypeKey": "8a19a5e472b747bd0172b77434f200ab",
    "currencyCode": "EUR",
    "customInformation": [],
    "valueDate": "2020-09-01T00:00:00+0000",
    "bookingDate": "2020-09-01T00:00:00+0000"
  },
  {
    "encodedKey": "8a19da3a73a6b9020173a6e3f5137951",
    "transactionId": 18,
    "parentAccountKey": "8a19df6972b787fc0172b8c7b0e70bc1",
    "type": "FEE_APPLIED",
    "creationDate": "2020-07-31T22:00:24+0000",
    "entryDate": "2020-08-01T00:00:00+0000",
    "amount": "-50",
    "interestAmount": "0",
    "feesAmount": "50",
    "overdraftAmount": "0",
    "technicalOverdraftAmount": "0",
    "fundsAmount": "0",
    "feesPaid": "0",
    "interestPaid": "0",
    "technicalOverdraftInterestAmount": "0",
    "fractionAmount": "0",
    "preciseInterestAmount": "0",
    "balance": "2900",
    "savingsPredefinedFeeAmounts": [],
    "productTypeKey": "8a19a5e472b747bd0172b77434f200ab",
    "currencyCode": "EUR",
    "customInformation": [],
    "valueDate": "2020-08-01T00:00:00+0000",
    "bookingDate": "2020-08-01T00:00:00+0000"
  },
  {
    "encodedKey": "8a19a7de7306fd4f0173073e983e09b2",
    "transactionId": 14,
    "parentAccountKey": "8a19df6972b787fc0172b8c7b0e70bc1",
    "type": "FEE_APPLIED",
    "creationDate": "2020-06-30T22:00:10+0000",
    "entryDate": "2020-07-01T00:00:00+0000",
    "amount": "-50",
    "interestAmount": "0",
    "feesAmount": "50",
    "overdraftAmount": "0",
    "technicalOverdraftAmount": "0",
    "fundsAmount": "0",
    "feesPaid": "0",
    "interestPaid": "0",
    "technicalOverdraftInterestAmount": "0",
    "fractionAmount": "0",
    "preciseInterestAmount": "0",
    "balance": "2950",
    "savingsPredefinedFeeAmounts": [],
    "productTypeKey": "8a19a5e472b747bd0172b77434f200ab",
    "currencyCode": "EUR",
    "customInformation": [],
    "valueDate": "2020-07-01T00:00:00+0000",
    "bookingDate": "2020-07-01T00:00:00+0000"
  },
  {
    "encodedKey": "8a19df6972b787fc0172b8caaaf40bc6",
    "transactionId": 10,
    "parentAccountKey": "8a19df6972b787fc0172b8c7b0e70bc1",
    "type": "DEPOSIT",
    "comment": "",
    "creationDate": "2020-06-15T16:23:20+0000",
    "entryDate": "2020-06-15T18:23:20+0000",
    "amount": "3000",
    "interestAmount": "0",
    "feesAmount": "0",
    "overdraftAmount": "0",
    "technicalOverdraftAmount": "0",
    "fundsAmount": "3000",
    "feesPaid": "0",
    "interestPaid": "0",
    "technicalOverdraftInterestAmount": "0",
    "fractionAmount": "0",
    "preciseInterestAmount": "0",
    "balance": "3000",
    "details": {
      "encodedKey": "8a19df6972b787fc0172b8cad4fb0bc7",
      "transactionChannelKey": "8a194075720ece2c017226fcf55e0064",
      "internalTransfer": false,
      "transactionChannel": {
        "encodedKey": "8a194075720ece2c017226fcf55e0064",
        "id": "cash",
        "name": "Cash",
        "creationDate": "2020-05-18T10:53:32+0000",
        "index": 0,
        "activated": true,
        "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
        "savingsConstraints": {
          "encodedKey": "8a194075720ece2c017226fcf55e0066",
          "filterConstraints": []
        },
        "usageRights": {
          "encodedKey": "8a194075720ece2c017226fcf55e0065",
          "isAccessibleByAllUsers": true,
          "roles": []
        }
      }
    },
    "userKey": "8a194075720ece2c017226fced6f005e",
    "savingsPredefinedFeeAmounts": [],
    "productTypeKey": "8a19a5e472b747bd0172b77434f200ab",
    "overdraftLimit": "0",
    "currencyCode": "EUR",
    "customInformation": [],
    "valueDate": "2020-06-15T18:23:20+0000"
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[SavingsTransactionApiV1]	none	none
» amount	number	none	none
» balance	number	none	none
» bookingDate	string	none	none
» branchKey	string	none	none
» centreKey	string	none	none
» comment	string	none	none
» creationDate	string	the date and time when this savings transaction was created	none
» currencyCode	string	none	none
» customInformation	[CustomFieldValueApiV1]	none	none
»» amount	number	none	none
»» customField	CustomFieldApiV1	none	none
»»» amounts	object	used when options available for a custom field definition translate to predefined amounts, for example, when the custom field value is used to generate a score	none
»»»» additionalProperties	number	none	none
»»» builtInCustomFieldId	string	if this field is one of the built in custom fiel definitions, this will have a value. These names are reserved and you can not use them for your own custom field definitions	none
»»» creationDate	string	the date on which this custom field definition was created	none
»»» customFieldProductSettings	[CustomFieldLinkApiV1]	none	none
»»»» customFieldEncodedKey	string	the key to the parent custom field definition	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isDefault	boolean	whether this field is displayed by default when creating a new record	none
»»»» isRequired	boolean	whether this field is required when creating a new record	none
»»»» linkType	string	the type of entity this field represents a link to	none
»»»» productKey	string	when the link type is product, this field should contain the encoded key of the linekd product	none
»»» customFieldSelectionOptions	[CustomFieldSelectionApiV1]	[represents a possible selection for select type custom field definitions]	none
»»»» constraint	CustomFilterConstraintApiV1	none	none
»»»»» customFieldKey	string	none	none
»»»»» dataFieldType	string	none	none
»»»»» dataFieldValue	string	none	none
»»»»» dataItemType	string	none	none
»»»»» dataType	string	none	none
»»»»» encodedKey	string	none	none
»»»»» filterElement	string	none	none
»»»»» groupNumber	number	none	none
»»»»» index	number	none	none
»»»»» linkingOperator	string	none	none
»»»»» secondValue	string	none	none
»»»»» value	string	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this selectable item	none
»»»» score	number	the score assigned to this selection	none
»»»» value	string	display name of this option	none
»»» customFieldSet	CustomFieldSetApiV1	none	none
»»»» builtInType	string	if this set is part of the set of built-in custom field sets, its type will be shown here	none
»»»» createdDate	string	the date and time when this custom field set was created	none
»»»» customFields	[CustomFieldApiV1]	an array of custom field definitions included in this custom field set	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this custom field set	none
»»»» indexInList	number	for field sets that can be added to an entity more than once, this number represents the index in the list and is used when changing values	none
»»»» lastModifiedDate	string	the date on which this custom field set was last modified	none
»»»» name	string	the name of this custom field set	none
»»»» notes	string	any notes regarding this custom field set	none
»»»» type	string	the entity type that this custom field definition is attached to	none
»»»» usage	string	whether this custom field set can only be used once, or added multiple times to the same entity	none
»»» dataType	string	the type of custom field definition	none
»»» description	string	a brief description of this custom field definition	none
»»» editRights	UsageRightsApiV1	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isAccessibleByAllUsers	boolean	none	none
»»»» roles	[string]	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» id	string	the ID for this custom field definition	none
»»» indexInList	number	none	none
»»» isDefault	boolean	whether this field will be included by default on new records	none
»»» isRequired	boolean	whether this field is required when creating a new record	none
»»» lastModifiedDate	string	the date on which this custom field definition was last modified	none
»»» name	string	the name of this custom field definition	none
»»» state	string	whether this field is available for use or has been deactivated	none
»»» type	string	the type of data this custom field definition will contain	none
»»» unique	boolean	whether the data in this custom field definition needs to be a unique value	none
»»» validationPattern	string	a user-provided pattern to which data in this custom field definition must conform where @ represents numbers, # represents letters and $ is either a number or letter. Other special characters used as separators are allowed, for example `@@-##-$$$`	none
»»» valueLength	string	whether this field needs to support a large number of characters	none
»»» values	[string]	a list of possible values when the field is a selection field	none
»»» viewRights	UsageRightsApiV1	none	none
»» customFieldID	string	none	none
»» customFieldKey	string	none	none
»» customFieldSetGroupIndex	number	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» indexInList	number	none	none
»» linkedEntityKeyValue	string	none	none
»» parentKey	string	none	none
»» selectionKey	string	none	none
»» value	string	none	none
» details	TransactionDetailsApiV1	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» internalTransfer	boolean	none	none
»» targetSavingsAccountKey	string	none	none
»» transactionChannel	TransactionChannelInTransactionDetailsApiV1	none	none
»»» activated	boolean	whether this transaction channel is enabled	none
»»» createdByUserKey	string	the encoded key of the user who created this transaction channel	none
»»» creationDate	string	the date on which this transaction channel was created	none
»»» customFields	[CustomFieldApiV1]	none	none
»»» encodedKey	string	the encoded key for this transaction channel	none
»»» id	string	the user specified ID for this transaction channel	none
»»» index	number	none	none
»»» loanConstraints	CustomFilterApiV1	none	none
»»»» customConfigurationInfo	CustomConfigurationInfoApiV1	none	none
»»»»» creationDate	string	the date on which this configuration was created	none
»»»»» dataViewType	string	the type of entity this configuration is for	none
»»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»»» indexInList	number	if more than one configuration exists for a given type, this is its index in the list	none
»»»»» lastModifiedDate	string	the date on which this configuration was last modified	none
»»»»» name	string	the name for this configuration	none
»»»»» shared	boolean	whether this configuration is private or can be used by other users of the system	none
»»»»» userKey	string	the encoded key of the Mambu user who created this configuration	none
»»»» encodedKey	string	none	none
»»»» filterConstraints	[CustomFilterConstraintApiV1]	none	none
»»» loanConstraintsUsage	string	whether there are any rules regarding usage of this transaction channel with loan accounts	none
»»» name	string	the name of this transaction channel	none
»»» savingsConstraints	CustomFilterApiV1	none	none
»»» savingsConstraintsUsage	string	whether there are any rules regarding usage of this transaction channel with savings accounts	none
»»» transactionChannelAccountingRule	GLAccountingRuleApiV1	none	none
»»»» account	GLAccountApiV1	A general ledger account	none
»»»»» activated	boolean	whether this general ledger account is in use	none
»»»»» allowManualJournalEntries	boolean	whether manual entries are allowed for this general ledger account	none
»»»»» balance	number	the current balance of this general ledger account	none
»»»»» creationDate	string(date-time)	the date on which this general ledger account was created	read-only
»»»»» currency	CurrencyApiV1	none	none
»»»»»» code	string	the three letter ISO code for this currency	none
»»»»»» creationDate	string	the date on which this currency was created	none
»»»»»» currencySymbolPosition	string	indicates where the currency symbol should appear in relation to the numeric value	none
»»»»»» digitsAfterDecimal	number	indicates how many decimal places are allowed for this currency. For example, a currenncy with 100 minor units to 1 major unit, there will be 2 decimal places.	none
»»»»»» isBaseCurrency	boolean	whether this currency is the base currency for your banking institution	none
»»»»»» lastModifiedDate	string	the date on which this currency was last modified	none
»»»»»» name	string	the name of this currency	none
»»»»»» symbol	string	the currency symnbol used for this currency	none
»»»»» description	string	an optional description for this general ledger account	none
»»»»» encodedKey	string	the encoded key of this general ledger account	none
»»»»» glCode	string	the numeric code for this general ledger account	none
»»»»» lastModifiedDate	string(date-time)	the date on which this general ledger account was last modified	read-only
»»»»» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
»»»»»» creationDate	string(date-time)	the date on which the data import was made	none
»»»»»» encodedKey	string	the encoded key of this data migration event	none
»»»»»» numCentresImported	number	the number of centres which were imported during the data migration	none
»»»»»» numClientsImported	number	the number of clients which were imported as part of the data migration	none
»»»»»» numGLAccountsImported	number	the number of general ledger accounts which were imported as part of the data migration	none
»»»»»» numGroupsImported	number	the number of groups which were imported as part of the data migration	none
»»»»»» numLoanRepaymentsImported	number	the number of loan repayment transations which were imported as part of the data migration	none
»»»»»» numLoanTransactionsImported	number	the number of loan transactions which were imported as part of the data migration	none
»»»»»» numLoansImported	number	the number of loan accounts which were imported as part of the data migration	none
»»»»»» numSavingsImported	number	the number of savings accounts which were imported as part of the data migration	none
»»»»»» state	string	whether the data import was accepted, is still in a draft state, or was rejected and all data reverted	none
»»»»»» type	string	the type of migration event	none
»»»»» name	string	the name of this general ledger account	none
»»»»» stripTrailingZeros	boolean	controls how this account is organized into header accounts when there are trailing zeroes, for example, for the account code `1100`, if this field is set to true, only the first two numbers will be recognised	none
»»»»» type	string	the type of general ledger account	none
»»»»» usage	string	whether this general ledger account is a `DETAIL` account, in which case it will have a value, or a `HEADER` account, in which case its value will be calculated based on the sum of detail accounts under it.	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» financialResource	string	the type of transaction governed by this rule	none
»»»» index	number	the index in list when there are multiple rules for the same type of transaction	none
»»»» predefinedFeeKey	string	the encoded key of the predefined key this rule relates to	none
»»»» productKey	string	the encoded key of the product this rule relates to	none
»»»» productType	string	the type of account this rule relates to	none
»»»» transactionChannelKey	string	the encoded key of the transaction channel that this rule relates to	none
»»» usageRights	UsageRightsApiV1	none	none
»» transactionChannelKey	string	none	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» entryDate	string	none	none
» feesAmount	number	none	none
» feesPaid	number	none	none
» fractionAmount	number	none	none
» fundsAmount	number	none	none
» interestAmount	number	none	none
» interestPaid	number	none	none
» interestRate	number	none	none
» linkedLoanTransactionKey	string	none	none
» linkedSavingsTransactionKey	string	none	none
» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
» overdraftAmount	number	none	none
» overdraftIndexRate	IndexRateApiV1	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» notes	string	any notes relating to this index rate	none
»» rate	number	the percentage rate for this tax or interest rate	none
»» rateSource	IndexRateSourceApiV1	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» name	string	the name of this index rate source, eg. LIBOR	none
»»» notes	string	any notes relating to this index rate	none
»»» type	string	what kind of rate this source provides, eg. tax, interest, withholding tax	none
»» startDate	string	the first day on which this rate is considered valid	none
»» userKey	string	the encoded key of the user who added this index rate	none
» overdraftInterestRate	number	none	none
» overdraftLimit	number	none	none
» parentAccountKey	string	none	none
» preciseInterestAmount	number	none	none
» productTypeKey	string	none	none
» reversalTransactionKey	string	none	none
» savingsPredefinedFeeAmounts	[PredefinedFeeAmountApiV1]	none	none
»» amortizedAmounts	[AmortizationAmountApiV1]	none	none
»»» amount	number	the amount to be amortized	none
»»» branchKey	string	the encoded key of the branch owning the amount	none
»»» centreKey	string	the encoded key of the centre owning the amount	none
»»» creationDate	string	the date on which the amortization amount was created	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» entryDate	string	the date when this amount was recognised as amortized (in organization time)	none
»»» reversalAmountKey	string	if the amount was reversed, this field will contain the encoded key of the reversal record	none
»»» taxAmount	number	the amount of tax included in the amortized amount	none
»»» type	string	the type of entry represented by this object	none
»» amount	number	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» fee	PredefinedFeeApiV1	none	none
»»» active	boolean	none	none
»»» amortizationIntervalSettings	PeriodIntervalSettingsApiV1	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» frequency	string	none	none
»»»» intervalCount	number	none	none
»»»» intervalType	string	none	none
»»»» periodCount	number	none	none
»»»» periodUnit	string	none	none
»»» amortizationProfile	string	none	none
»»» amount	number	none	none
»»» amountCalculationMethod	string	none	none
»»» applyDateMethod	string	none	none
»»» creationDate	string	the date and time when this fee was created	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» feeAmortizationUponRescheduleOption	string	none	none
»»» feeApplication	string	none	none
»»» feeProductRules	[GLAccountingRuleApiV1]	none	none
»»» name	string	none	none
»»» percentageAmount	number	none	none
»»» trigger	string	none	none
»» taxAmount	number	none	none
»» transactionId	number	none	none
» taxRate	IndexRateApiV1	none	none
» technicalOverdraftAmount	number	none	none
» technicalOverdraftInterestAmount	number	none	none
» tillKey	string	none	none
» transactionId	number	none	none
» type	string	none	none
» userKey	string	none	none
» valueDate	string	none	none

Enumerated Values

Property	Value
builtInCustomFieldId	`MOBILE_PHONE`
builtInCustomFieldId	`EMAIL_ADDRESS`
builtInCustomFieldId	`GENDER`
builtInCustomFieldId	`MIDDLE_NAME`
builtInCustomFieldId	`HOME_PHONE`
builtInCustomFieldId	`BIRTHDATE`
builtInCustomFieldId	`LAST_NAME`
builtInCustomFieldId	`FIRST_NAME`
linkType	`CLIENT_ROLE`
linkType	`CHANNEL`
linkType	`PRODUCT`
dataFieldType	`NATIVE`
dataFieldType	`CUSTOM`
dataItemType	`WRITTEN_OFF_LOANS`
dataItemType	`LINE_OF_CREDIT`
dataItemType	`INVESTOR_FUND`
dataItemType	`TRANSACTION_DETAILS`
dataItemType	`DOCUMENT_TEMPLATE`
dataItemType	`PRODUCT`
dataItemType	`MCC_EXPIRATION`
dataItemType	`CENTRE`
dataItemType	`REPAYMENT_COLLECTION`
dataItemType	`TASK`
dataItemType	`OUTSTANDING_PORTFOLIO_AMOUNTS`
dataItemType	`REVENUE`
dataItemType	`COMPOSED_TRANSACTIONS`
dataItemType	`UNION_TRANSACTIONS`
dataItemType	`PRINCIPAL_PAYMENT_SETTINGS`
dataItemType	`LOANS`
dataItemType	`DISBURSEMENT_DETAILS`
dataItemType	`SAVINGS_TRANSACTION`
dataItemType	`IDENTIFICATION_DOCUMENT`
dataItemType	`LOAN_PRODUCT`
dataItemType	`DISBURSED_LOANS`
dataItemType	`LOAN_GROUP`
dataItemType	`TRANSACTION_CHANNEL`
dataItemType	`CUSTOM_PREDEFINED_FEE`
dataItemType	`JOURNAL_ENTRY`
dataItemType	`ATTACHMENT`
dataItemType	`PREDEFINED_FEE`
dataItemType	`TRANCHE`
dataItemType	`TRANSACTION`
dataItemType	`INDEX_RATE_SOURCE`
dataItemType	`GROUP_ROLE`
dataItemType	`LOAN_TRANSACTION`
dataItemType	`CLIENT_ROLE`
dataItemType	`GROUP`
dataItemType	`NOTIFICATION_MESSAGE`
dataItemType	`OUTSTANDING_PORTFOLIO_ACCOUNTS`
dataItemType	`REPAYMENT`
dataItemType	`LOAN_ACCOUNT_GUARANTY`
dataItemType	`BRANCH`
dataItemType	`CURRENCY`
dataItemType	`CARD_TRANSACTION_REVERSAL`
dataItemType	`INTEREST_PRODUCT_SETTINGS`
dataItemType	`CREATED_ACCOUNTS`
dataItemType	`USER`
dataItemType	`SAVINGS_PRODUCT`
dataItemType	`CLIENT`
dataItemType	`PRODUCT_ARREARS_SETTINGS`
dataItemType	`SAVINGS`
dataItemType	`EXPENSE`
dataItemType	`INDEX_RATE`
dataItemType	`NOTIFICATION_TEMPLATE`
dataItemType	`CUSTOM_FIELD_SELECTION`
dataItemType	`ACTIVITY`
dataType	`ENUM`
dataType	`MONEY`
dataType	`NUMBER`
dataType	`DATE_UTC`
dataType	`JAVA_BLOB`
dataType	`OBJECT`
dataType	`BOOLEAN`
dataType	`DATE`
dataType	`PERCENT`
dataType	`BIG_DECIMAL`
dataType	`STRING`
dataType	`KEY`
dataType	`LONG`
filterElement	`STARTS_WITH_CASE_SENSITIVE`
filterElement	`THIS_WEEK`
filterElement	`EQUALS`
filterElement	`STARTS_WITH`
filterElement	`IN`
filterElement	`TODAY`
filterElement	`THIS_YEAR`
filterElement	`BETWEEN`
filterElement	`AFTER`
filterElement	`LESS_THAN`
filterElement	`DIFFERENT_THAN`
filterElement	`THIS_MONTH`
filterElement	`NOT_EMPTY`
filterElement	`BEFORE`
filterElement	`EQUALS_CASE_SENSITIVE`
filterElement	`LAST_DAYS`
filterElement	`MORE_THAN`
filterElement	`EMPTY`
filterElement	`ON`
linkingOperator	`OR`
linkingOperator	`AND`
builtInType	`DETAILS`
builtInType	`GENERAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
usage	`SINGLE`
usage	`GROUPED`
dataType	`GROUP_LINK`
dataType	`DATE`
dataType	`NUMBER`
dataType	`CHECKBOX`
dataType	`CLIENT_LINK`
dataType	`STRING`
dataType	`USER_LINK`
dataType	`SELECTION`
state	`DEACTIVATED`
state	`NORMAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
valueLength	`SHORT`
valueLength	`LONG`
dataViewType	`PORTAL_ACCOUNT_TRANSACTION`
dataViewType	`LOANS_AGING_ANALYSIS`
dataViewType	`CLOSED_ACCOUNTS`
dataViewType	`CLIENT_OVERVIEW`
dataViewType	`ADMIN_CENTRES`
dataViewType	`USER_NOTIFICATION_MESSAGES`
dataViewType	`LINE_OF_CREDIT`
dataViewType	`USER_OVERVIEW`
dataViewType	`CENTRE_OVERVIEW`
dataViewType	`REPAYMENT_REPAYMENTS_COLLECTION`
dataViewType	`GROUP_OVERVIEW`
dataViewType	`ACTIVITIES_LOOKUP`
dataViewType	`TRANSACTION`
dataViewType	`ADMIN_BRANCHES`
dataViewType	`GROUP`
dataViewType	`BRANCH_OVERVIEW`
dataViewType	`NOTIFICATION_MESSAGE`
dataViewType	`PORTFOLIO_REPORTS`
dataViewType	`GROUP_NOTIFICATION_MESSAGES`
dataViewType	`LOAN_ACCOUNT_SECURITIES_OVERVIEW`
dataViewType	`LINE_OF_CREDIT_OVERVIEW`
dataViewType	`CURRENCIES`
dataViewType	`REPAYMENT`
dataViewType	`TILL_TRANSACTIONS`
dataViewType	`ALL_TASKS`
dataViewType	`CENTRE`
dataViewType	`BRANCH`
dataViewType	`INDEX_RATES_LIST`
dataViewType	`USER_TASKS`
dataViewType	`DOCUMENT_TEMPLATES`
dataViewType	`SAVINGS_TRANSACTIONS_LOOKUP`
dataViewType	`LOAN_ACCOUNT_OVERVIEW`
dataViewType	`DEPOSITS_COLLECTION`
dataViewType	`USER`
dataViewType	`ADMIN_USERS`
dataViewType	`GROUP_TASKS`
dataViewType	`CLIENT`
dataViewType	`LOAN_TRANSACTIONS_LOOKUP`
dataViewType	`LOANS`
dataViewType	`LOANS_REPAYMENTS_COLLECTION`
dataViewType	`CLIENT_TASKS`
dataViewType	`OVERDRAFTS_AGING_ANALYSIS`
dataViewType	`LOAN_ACCOUNT_FUNDING_OVERVIEW`
dataViewType	`SAVINGS`
dataViewType	`SAVINGS_OVERVIEW`
dataViewType	`JOURNAL_ENTRY`
dataViewType	`CLIENT_NOTIFICATION_MESSAGES`
loanConstraintsUsage	`UNCONSTRAINED_USAGE`
loanConstraintsUsage	`LIMITED_USAGE`
savingsConstraintsUsage	`UNCONSTRAINED_USAGE`
savingsConstraintsUsage	`LIMITED_USAGE`
currencySymbolPosition	`AFTER_NUMBER`
currencySymbolPosition	`BEFORE_NUMBER`
state	`REVERTED`
state	`DRAFT`
state	`APPROVED`
type	`IMPORT`
type	`EXPORT`
type	`INCOME`
type	`EXPENSE`
type	`LIABILITY`
type	`ASSET`
type	`EQUITY`
usage	`HEADER`
usage	`DETAIL`
financialResource	`FEE_RECEIVABLE`
financialResource	`OVERDRAFT_INTEREST_INCOME`
financialResource	`OVERDRAFT_INTEREST_RECEIVABLE`
financialResource	`FEE_INCOME`
financialResource	`INTEREST_PAYABLE`
financialResource	`INTEREST_EXPENSE`
financialResource	`PENALTY_RECEIVABLE`
financialResource	`INTEREST_INCOME`
financialResource	`DEFERRED_TAXES`
financialResource	`DEFERRED_FEE_INCOME`
financialResource	`PORTFOLIO_CONTROL`
financialResource	`DEFERRED_INTERESTS_INCOME`
financialResource	`OVERDRAFT_WRITE_OFF_EXPENSE`
financialResource	`PENALTY_INCOME`
financialResource	`OVERDRAFT_PORTFOLIO_CONTROL`
financialResource	`SAVINGS_CONTROL`
financialResource	`TAXES_RECEIVABLE`
financialResource	`INTEREST_RECEIVABLE`
financialResource	`INTER_BRANCH_TRANSFER`
financialResource	`FUND_SOURCE`
financialResource	`WRITE_OFF_EXPENSE`
financialResource	`DEPOSIT_REFERENCE`
financialResource	`TAXES_PAYABLE`
productType	`LOAN`
productType	`SAVINGS`
type	`TAX_RATE`
type	`INTEREST_RATE`
type	`WITHHOLDING_TAX_RATE`
type	`AMORTIZATION_ADJUSTMENT`
type	`AMORTIZATION_CORRECTION`
type	`AMORTIZATION`
frequency	`ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING`
frequency	`ACCOUNT_INSTALLMENTS_DUE_DATES`
frequency	`CUSTOM_INTERVAL`
intervalType	`FULL_TERM`
intervalType	`PREDEFINED_INTERVALS`
periodUnit	`MONTHS`
periodUnit	`YEARS`
periodUnit	`WEEKS`
periodUnit	`DAYS`
amortizationProfile	`STRAIGHT_LINE`
amortizationProfile	`SUM_OF_YEARS_DIGITS`
amortizationProfile	`EFFECTIVE_INTEREST_RATE`
amortizationProfile	`NONE`
amountCalculationMethod	`LOAN_AMOUNT_PERCENTAGE`
amountCalculationMethod	`LOAN_AMOUNT_PERCENTAGE_NUMBER_OF_INSTALLMENTS`
amountCalculationMethod	`REPAYMENT_PRINCIPAL_AMOUNT_PERCENTAGE`
amountCalculationMethod	`FLAT_NUMBER_OF_INSTALLMENTS`
amountCalculationMethod	`FLAT`
applyDateMethod	`MONTHLY_FROM_ACTIVATION`
applyDateMethod	`FIRST_OF_EVERY_MONTH`
feeAmortizationUponRescheduleOption	`CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT`
feeAmortizationUponRescheduleOption	`END_AMORTIZATION_ON_THE_ORIGINAL_ACCOUNT`
feeApplication	`OPTIONAL`
feeApplication	`REQUIRED`
trigger	`DISBURSEMENT`
trigger	`ARBITRARY`
trigger	`CAPITALIZED_DISBURSEMENT`
trigger	`MONTHLY_FEE`
trigger	`UPFRONT_DISBURSEMENT`
trigger	`LATE_REPAYMENT`
trigger	`MANUAL`
trigger	`PAYMENT_DUE`
trigger	`PAYMENT_DUE_APPLIED_ON_DUE_DATES`
type	`LOAN_FRACTION_SOLD`
type	`WRITE_OFF_ADJUSTMENT`
type	`LOAN_FUNDED_ADJUSTMENT`
type	`LOAN_FRACTION_SOLD_ADJUSTMENT`
type	`DEPOSIT`
type	`LOAN_REPAID_ADJUSTMENT`
type	`FEE_REDUCTION_ADJUSTMENT`
type	`IMPORT`
type	`LOAN_FUNDED`
type	`TRANSFER_ADJUSTMENT`
type	`TRANSFER`
type	`LOAN_FRACTION_BOUGHT_ADJUSTMENT`
type	`WRITE_OFF`
type	`WITHDRAWAL_ADJUSTMENT`
type	`LOAN_FRACTION_BOUGHT`
type	`FEE_APPLIED`
type	`FEES_DUE_REDUCED`
type	`WITHHOLDING_TAX`
type	`CARD_TRANSACTION_REVERSAL`
type	`OVERDRAFT_LIMIT_CHANGED`
type	`INTEREST_APPLIED`
type	`INTEREST_APPLIED_ADJUSTMENT`
type	`ADJUSTMENT`
type	`WITHHOLDING_TAX_ADJUSTMENT`
type	`FEE_ADJUSTED`
type	`LOAN_REPAID`
type	`BRANCH_CHANGED`
type	`OVERDRAFT_INTEREST_RATE_CHANGED`
type	`WITHDRAWAL`
type	`INTEREST_RATE_CHANGED`

Create Savings Transaction

POST /savings/{savingsAccountId}/transactions

Create Savings Transaction

Allows for posting transaction to the account. Transactions may affect the balance (such as a deposit or withdrawal).

Transactions can be posted either via query parameters or as JSON.

Example requests

Create a transaction using query parameters


https://mybank.mambu.com/api/savings/1234-abcd/transactions?type=deposit&amount=500

JSON transaction

{
  "type": "WITHDRAWAL",
  "amount": "200",
  "method": "cash",
  "customInformation": [
    {
      "value": "3333se",
      "customFieldID": "transaction_cf"
    }
  ]
}

Parameters

Name	Type	Description	In
type	string	the type of transaction	query
amount (required)	number	the amount for the transaction	query
notes	string	none	query
originalTransactionId	string	none	query
method	string	none	query
bookingDate	string(date)	none	query
valueDate	string(date)	none	query
toSavingsAccount	string	none	query
toLoanAccount	string	none	query
body	JSONSavingsTransactionRequestApiV1	none	body
savingsAccountId	string	none	path

Enumerated Values

Parameter	Value
type	`approval`
type	`close`
type	`deposit`
type	`deposit_adjustment`
type	`fee`
type	`fee_adjusted`
type	`reject`
type	`start_maturity`
type	`transfer`
type	`transfer_adjustment`
type	`undo_approval`
type	`undo_close`
type	`undo_reject`
type	`undo_withdrawn`
type	`withdraw`
type	`withdrawal`
type	`withdrawal_adjustment`

Example Responses

201 : Created a transaction
Created a transaction

{
  "encodedKey": "8a19dab474909bc80174922be8d8108e",
  "transactionId": 63,
  "parentAccountKey": "8a19a46f72b6bb9a0172b76ef2ed045c",
  "type": "WITHDRAWAL",
  "comment": "some notes on this transaction",
  "creationDate": "2020-09-15T14:29:45+0000",
  "entryDate": "2020-09-02T00:01:00+0000",
  "amount": "-10",
  "interestAmount": "0",
  "feesAmount": "0",
  "overdraftAmount": "0",
  "technicalOverdraftAmount": "0",
  "fundsAmount": "10",
  "feesPaid": "0",
  "interestPaid": "0",
  "technicalOverdraftInterestAmount": "0",
  "fractionAmount": "0",
  "preciseInterestAmount": "0",
  "balance": "11659.09",
  "details": {
    "encodedKey": "8a19dab474909bc80174922be8d8108f",
    "transactionChannelKey": "8a193c26722b51b701722d77ce232708",
    "internalTransfer": false,
    "transactionChannel": {
      "encodedKey": "8a193c26722b51b701722d77ce232708",
      "id": "bank",
      "name": "Bank",
      "creationDate": "2020-05-19T15:05:26+0000",
      "index": 3,
      "activated": true,
      "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
      "savingsConstraints": {
        "encodedKey": "8a193c26722b51b701722d77ce23270a",
        "filterConstraints": []
      },
      "usageRights": {
        "encodedKey": "8a193c26722b51b701722d77ce232709",
        "isAccessibleByAllUsers": true,
        "roles": []
      }
    }
  },
  "userKey": "8a194075720ece2c017226fced6f005e",
  "savingsPredefinedFeeAmounts": [],
  "productTypeKey": "8a193c26722b51b701722d77cb63261a",
  "currencyCode": "EUR",
  "valueDate": "2020-09-02T00:01:00+0000",
  "bookingDate": "2020-09-03T00:01:00+0000"
}

Responses

Status	Meaning	Description	Schema
`201`	Created	Created a transaction	SavingsTransactionApiV1

Update Custom Field Value (savings transactions)

PATCH /savings/{savingsAccountId}/transactions/{transactionId}/custominformation

Update Custom Information

Update custom information for a savings account transaction

Example Requests

Update a single custom field value

{
  "customInformation": [
    {
      "customFieldID": "custom_field_2",
      "value": "3"
    }
  ]
}

Update a field in a group

{
  "customInformation": [
    {
      "customFieldID": "cf_grouped_field",
      "value": "new value",
      "customFieldSetGroupIndex": "0"
    }
  ]
}

Update mutliple custom field values

{
  "customInformation": [
    {
      "customFieldID": "grouped_custom_field",
      "customFieldSetGroupIndex": 0,
      "value": "bowser"
    },
    {
      "customFieldId": "custom_number",
      "value": "42"
    }
  ]
}

Parameters

Name	Type	Description	In
transactionId (required)	string	none	path
savingsAccountId (required)	string	none	path
body	UpdateCustomInformationRequest	none	body

Example Responses

200 Response

{
  "errorSource": "string",
  "returnCode": 0,
  "returnStatus": "string"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	ExecutionStatusApiV1

Update Custom Information (savings transactions)

PATCH /savings/{savingsAccountId}/transactions/{transactionId}/custominformation/{customInformationId}

Update custom field value for a savings transaction

Example Requests

{
  "value": "string"
}

Parameters

Name	Type	Description	In
customInformationId (required)	string	none	path
transactionId (required)	string	none	path
savingsAccountId (required)	string	none	path
body	CustomFieldOnUpdate	none	body

Example Responses

200 Response

{
  "errorSource": "string",
  "returnCode": 0,
  "returnStatus": "string"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	ExecutionStatusApiV1

Get Document for transaction

GET /savings/{savingsAccountId}/transactions/{transactionId}/templates/{templateID}

Get Populated Document for a Savings Account Transaction

Allows you to get the raw HTML, as a string, of any document template associated with this savings account transaction with all placeholders populated.

You can get the ID for templates available for a savings account deposit product by calling the Savings Products API. The ID is retuned as encoded key in the templates array. Supported templates for this operation will be of the type TRANSACTION.

Parameters

Name	Type	Description	In
savingsAccountId (required)	string	The ID of the savings account.	path
templateID (required)	string	The ID of the template you wish to populate with data from this transaction.	path
transactionId (required)	string	The ID of the transaction.	path

Example Responses

200 : OK
Example document

"Hi Terry Terrence Testington,<div><br /></div><div>your deposit of 42,000.00 <span style="\"background-color:">€</span> has been received and processed on the 12-11-2019, bringing your savings in this account to 43,969.00 <span style="\"background-color:">€</span>.</div><div><br /></div><div>Your current interest rate is 10% and to date you have accrued 0.00 <span style="\"background-color:">€</span> interest from this account.</div><div><br /></div><div>Keep up the good habits!</div><div><br /></div><div>Happy saving,</div><div>Manhattan Beach Branch</div>"

404 : Not Found
Template not found

{
  "returnCode": 2200,
  "returnStatus": "INVALID_TEMPLATE_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	string
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Settings

Get information from the current organization. Logo and icons will be returned as a base64 encoded data image.

Get Branding Assets

GET /settings/branding/{asset}

Get Branding Assets

Get the logo (300x50 pixels) or the icon (16x16 pixels) as base64 encoded string

Parameters

Name	Type	Description	In
asset (required)	string	The type of asset you want to view, either `logo` or `icon`.	path

Enumerated Values

Parameter	Value
asset	`logo`
asset	`icon`

Example Responses

200 : OK
Base64-encoded image

"data:image/PNG;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAECAYAAACH=="

404 Response

{
  "returnCode": 0,
  "returnStatus": "string"
}

404 : Not Found
response

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	string
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Get General Settings

GET /settings/general

Get General Settings

Get the settings of the organization (holidays, non-working days, internal controls, date and number formatting, default values, etc.). These settings are available in the UI under the General Setup tab in the Mambu Administration menu.

Example Responses

200 : OK
General organization settings

{
  "encodedKey": "8a194075720ece2c017226fcf713006a",
  "clientIDFormat": "#########",
  "groupIDFormat": "#########",
  "lineOfCreditIdFormat": "@@@###",
  "tillIDFormat": "@@@###",
  "decimalSeperator": "DECIMAL",
  "dateFormats": {
    "DATE_FORMAT": "dd-MM-yyyy",
    "DATE_TIME_FORMAT": "dd-MM-yyyy HH:mm:ss"
  },
  "nonWorkingDays": [
    {
      "encodedKey": "8a19a5e472b747bd0172b79a0c9602b5",
      "dayOfWeek": "SATURDAY",
      "creationDate": "2020-06-15T11:00:43+0000"
    },
    {
      "encodedKey": "8a19a5e472b747bd0172b79a0c9602b6",
      "dayOfWeek": "SUNDAY",
      "creationDate": "2020-06-15T11:00:43+0000"
    }
  ],
  "arrearsDaysBeforeWriteoOff": 0,
  "exposureType": "UNLIMITED",
  "multipleLoans": "UNLIMITED",
  "assignmentConstraints": [],
  "multipleGroupMemberships": "UNLIMITED",
  "enabledComponents": [
    "LOANS",
    "DEPOSITS",
    "BRANCHES",
    "CENTRES",
    "CLIENTS",
    "GROUPS",
    "ACCOUNTING",
    "CREDIT_OFFICERS"
  ],
  "defaultTransactionChannelKey": "8a194075720ece2c017226fcf55e0064",
  "defaultClientRoleKey": "8a194075720ece2c017226fcf55e0068",
  "defaultGroupRoleKey": "8a194075720ece2c017226fcf7130069",
  "groupSizeLimitType": "NONE",
  "defaultClientState": "INACTIVE",
  "defaultLineOfCreditState": "APPROVED",
  "generalHolidays": [
    {
      "encodedKey": "8a19a5e472b747bd0172b7a376e402d5",
      "keyId": 1,
      "name": "cheat day",
      "dayOfMonth": 22,
      "monthOfYear": 6,
      "year": 2020,
      "isAnnualyRecurring": true,
      "creationDate": "2020-06-15T11:00:43+0000"
    },
    {
      "encodedKey": "8a19a5e472b747bd0172b7a376e402d6",
      "keyId": 2,
      "name": "day off day",
      "dayOfMonth": 25,
      "monthOfYear": 6,
      "year": 2020,
      "isAnnualyRecurring": true,
      "creationDate": "2020-06-15T11:00:43+0000"
    },
    {
      "encodedKey": "8a19df6972b787fc0172b8c0bfe70b96",
      "keyId": 11,
      "name": "oday day",
      "dayOfMonth": 30,
      "monthOfYear": 6,
      "year": 2020,
      "isAnnualyRecurring": false,
      "creationDate": "2020-06-15T16:16:22+0000"
    }
  ],
  "approvalDisbursalTwoManRuleEnabled": false,
  "automatedAccountingClosuresInterval": 0,
  "maxAllowedUndoClosurePeriod": 30,
  "maxAllowedIdDocumentAttachments": 5,
  "maxAllowedJournalEntryDocumentAttachments": 5,
  "eodProcessingMethod": "AUTOMATIC",
  "duplicateClientChecks": [
    {
      "encodedKey": "8a194075720ece2c017226fcfe2f0233",
      "dataField": "ID",
      "dataItemType": "IDENTIFICATION_DOCUMENT",
      "groupIndex": 0,
      "active": true
    },
    {
      "encodedKey": "8a194075720ece2c017226fcfe2f0234",
      "dataField": "HOME_PHONE_NUMBER",
      "dataItemType": "CLIENT",
      "groupIndex": 1,
      "active": true
    },
    {
      "encodedKey": "8a194075720ece2c017226fd019d0235",
      "dataField": "MOBILE_PHONE_NUMBER",
      "dataItemType": "CLIENT",
      "groupIndex": 2,
      "active": true
    },
    {
      "encodedKey": "8a194075720ece2c017226fd019d0236",
      "dataField": "EMAIL_ADDRESS",
      "dataItemType": "CLIENT",
      "groupIndex": 3,
      "active": true
    },
    {
      "encodedKey": "8a194075720ece2c017226fd019d0237",
      "dataField": "FIRST_NAME",
      "dataItemType": "CLIENT",
      "groupIndex": 4,
      "active": true
    },
    {
      "encodedKey": "8a194075720ece2c017226fd019d0238",
      "dataField": "LAST_NAME",
      "dataItemType": "CLIENT",
      "groupIndex": 4,
      "active": true
    },
    {
      "encodedKey": "8a194075720ece2c017226fd019d0239",
      "dataField": "LAST_NAME",
      "dataItemType": "CLIENT",
      "groupIndex": 5,
      "active": true
    },
    {
      "encodedKey": "8a194075720ece2c017226fd019e023a",
      "dataField": "BIRTHDATE",
      "dataItemType": "CLIENT",
      "groupIndex": 5,
      "active": true
    }
  ],
  "duplicateClientConstraintAction": "WARNING",
  "otherIdDocumentsEnabled": true
}

200 : OK
response

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	GeneralSettingsApiV1

Get ID Templates

GET /settings/iddocumenttemplates

Get all ID templates

Allows the retrieval of information about the document templates. This is especially useful when creating clients which require an ID document and the template key needs to be provided. If no templates are defined we will return an empty array

Example Responses

200 : ok
A list of ID templates

[
  {
    "encodedKey": "40298a134700d849014700d872fd000f",
    "documentType": "Reispass",
    "issuingAuthority": "Bundesrepublik Deutschland",
    "documentIdTemplate": "####@###$###@",
    "mandatoryForClients": "true",
    "allowAttachments": "true"
  },
  {
    "encodedKey": "ab74ccd134700d849014700d872fd000f",
    "documentType": "Identity Card",
    "issuingAuthority": "Spain",
    "documentIdTemplate": "#########@@@",
    "mandatoryForClients": "false",
    "allowAttachments": "false"
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[IdentificationDocumentTemplateApiV1]	none	none
» allowAttachments	boolean	whether there can be attachements for this ID document type, for example, a scanned copy or photograph	none
» documentIdTemplate	string	none	none
» documentType	string	the type of ID document, eg. passport, ID card	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» issuingAuthority	string	the institution who provides this kind of ID document, eg. Driver and Vehicle Licencing Agency	none
» mandatoryForClients	boolean	whether clients must provide this kind of ID when creating an account	none

Get UI Labels

GET /settings/labels

Get UI Labels

Get object labels and their translations.

Example Responses

200 : OK
Truncated labels example

[
  {
    "type": "CLIENT",
    "singularValue": "Client",
    "pluralValue": "Clients",
    "language": "ENGLISH",
    "hasCustomValue": false
  },
  {
    "type": "GROUP",
    "singularValue": "Group",
    "pluralValue": "Groups",
    "language": "ENGLISH",
    "hasCustomValue": false
  },
  {
    "type": "CLIENT",
    "singularValue": "Cliente",
    "pluralValue": "Clientes",
    "language": "SPANISH",
    "hasCustomValue": false
  },
  {
    "type": "GROUP",
    "singularValue": "Grupo",
    "pluralValue": "Grupos",
    "language": "SPANISH",
    "hasCustomValue": false
  },
  {
    "type": "CLIENT",
    "singularValue": "Client",
    "pluralValue": "Clients",
    "language": "FRENCH",
    "hasCustomValue": false
  },
  {
    "type": "GROUP",
    "singularValue": "Groupe",
    "pluralValue": "Groupes",
    "language": "FRENCH",
    "hasCustomValue": false
  },
  {
    "type": "BRANCH",
    "singularValue": "Branche",
    "pluralValue": "Branches",
    "language": "FRENCH",
    "hasCustomValue": false
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[ObjectLabelApiV1]	none	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» hasCustomValue	boolean	none	none
» language	string	none	none
» pluralValue	string	none	none
» singularValue	string	none	none
» type	string	none	none

Enumerated Values

Property	Value
language	`PORTUGESE`
language	`RUSSIAN`
language	`ROMANIAN`
language	`ENGLISH`
language	`SPANISH`
language	`GEORGIAN`
language	`BURMESE`
language	`PHRASE`
language	`CHINESE`
language	`GERMAN`
language	`FRENCH`
language	`INDONESIAN`
type	`BRANCH`
type	`GROUP`
type	`CREDIT_OFFICER`
type	`FEE`
type	`CLIENT`
type	`CENTRE`
type	`INTEREST`

Get Organization Settings

GET /settings/organization

Get Organization Settings

Get details about the organization.

Example Responses

200 : OK
organization settings

{
  "encodedKey": "8a194075720ece2c017226fced6f005c",
  "name": "Mambu",
  "creationDate": "2020-05-18T08:53:29+0000",
  "lastModifiedDate": "2020-08-14T11:19:18+0000",
  "phoneNo": "+420456978",
  "emailAddress": "info@BofAlg.es",
  "timeZoneID": "Europe/Berlin",
  "address": {
    "encodedKey": "8a19b33d73ec6a7b0173ecb20d1c015f",
    "parentKey": "8a194075720ece2c017226fced6f005c",
    "line1": "street address",
    "city": "big city",
    "region": "cloud country",
    "postcode": "90210",
    "country": "Countrystan",
    "indexInList": -1
  }
}

200 : OK
response

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	OrganizationApiV1

Tasks

Allows you to fetch, create or update tasks assigned for users with optional due dates and association to clients.

Get Tasks

GET /tasks

Get all Tasks

Allows retrieving tasks that can be filtered by user key or client key. Please note you will only be able to view tasks allowed by your permission set. For example, only from the assigned branch for your own clients.

Parameters

Name	Type	Description	In
clientID	string	The ID of the client to which the task is linked to.	query
offset	number	Start at index x. Use with `limit` parameter to achieve paging.	query
groupID	string	The ID of the group to which the task is linked to.	query
limit	number	Max number of records to return.	query
username	string	The username of the user to which the task is assigned to.	query
status	string	The task status: (`OPEN`, `COMPLETED`, `OVERDUE`) - if not provide defaulted to `OPEN`.	query

Enumerated Values

Parameter	Value
status	`OPEN`
status	`COMPLETED`
status	`OVERDUE`

Example Responses

200 : OK
A list of tasks

[
  {
    "encodedKey": "8a33ae49441c4fe101441c71580403a5",
    "id": 1,
    "creationDate": "2014-02-10T15:36:34+0000",
    "lastModifiedDate": "2014-02-10T15:36:34+0000",
    "dueDate": "2014-02-11T15:36:34+0000",
    "title": "Create a new client",
    "description": "Create a new client named John Smith with home phone (35)325-069 and address 123 Home Street",
    "createdByUserKey": "8a33ae49441c4fe101441c5fe42f0005",
    "status": "OPEN",
    "daysUntilDue": -7,
    "createdByFullName": "Max Power",
    "assignedUserKey": "8a33ae49441c4fe101441c5fe42f0005"
  },
  {
    "encodedKey": "8a33ae49441c4fe101441c71581203a6",
    "id": 2,
    "creationDate": "2014-02-10T15:36:34+0000",
    "lastModifiedDate": "2014-02-10T15:36:34+0000",
    "dueDate": "2014-02-12T15:36:34+0000",
    "title": "Disburse your first loan",
    "description": "Disburse a $200 loan for a client.",
    "createdByUserKey": "8a33ae49441c4fe101441c5fe42f0005",
    "status": "OPEN",
    "daysUntilDue": -6,
    "createdByFullName": "Max Power",
    "assignedUserKey": "8a33ae49441c4fe101441c5fe42f0005"
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[TaskApiV1]	none	none
» assignedUserKey	string	the encoded key of the user to whom the task is assigned	none
» completionDate	string	the date on which the task was marked as completed	none
» createdByFullName	string	the full name of the Mambu user who created this task	none
» createdByUserKey	string	the encoded key of the Mambu user who created the task	none
» creationDate	string	the date on which the task was created	none
» daysUntilDue	number	the number of days remaining until the task status will be set to `OVERDUE` if still incomplete	none
» description	string	a rich text description of the task	none
» dueDate	string	the date by which the task should be completed	none
» encodedKey	string	the automatically generated encoded key of the task	none
» id	number	the user provided ID of the task	none
» lastModifiedDate	string	the date on which the task was last modified	none
» status	string	the current status of the task	none
» taskLinkKey	string	the encoded key of the entity associated with the task, for example, the client or account	none
» taskLinkName	string	the name of the entity, for example client or user, linked to this task	none
» taskLinkType	string	the type of entity linked to the task	none
» title	string	the title of the task	none

Enumerated Values

Property	Value
status	`COMPLETED`
status	`OPEN`
status	`OVERDUE`
taskLinkType	`BRANCH`
taskLinkType	`LOAN_ACCOUNT`
taskLinkType	`GROUP`
taskLinkType	`DEPOSIT_ACCOUNT`
taskLinkType	`LINE_OF_CREDIT`
taskLinkType	`LOAN_PRODUCT`
taskLinkType	`GL_JOURNAL_ENTRY`
taskLinkType	`SAVINGS_PRODUCT`
taskLinkType	`USER`
taskLinkType	`CLIENT`
taskLinkType	`CENTRE`
taskLinkType	`ID_DOCUMENT`

Create Task

POST /tasks

Create Task

Create a new task using either query parameters or JSON body. If using query parameters, please ensure that you properly URL escape the content if it contains any unsafe characters such as spaces or other special characters.

Example Requests

Create a task using query parameters

POST /api/tasks?title=Review%20Loan&duedate=2011-06-16&username=demo&clientid=64&description=Please%20check%20the%20automatically%20created%20loan%20application%20for%20this%20client.

Update an existing task

{
   "task":{
      "encodedKey":"8a33ae49441c4fe101441c71581203a6",
      "dueDate":"2021-02-12T15:36:34+0000",
      "title":"Disburse your first loan",
      "description":"Disburse a $200 loan for a client.",
      "status":"OPEN",
      "assignedUserKey":"8a33ae49441c4fe101441c5fe42f0005"
   }
}

Create a new Task

{
  "task": {
    "dueDate": "2020-02-11T15:36:34+0000",
    "title": "Create a new client",
    "description": "Create a new client named John Smith with home phone (44)333-8989 and address 123 Main Street",
    "status": "OPEN",
    "assignedUserKey": "8a33ae49441c4fe101441c5fe42f0005"
  }
}

Parameters

Name	Type	Description	In
clientid	string	none	query
duedate	string	Required if using query parameters	query
groupid	string	none	query
description	string	none	query
title	string	Required if using query parameters	query
username	string	Required if using query parameters	query
task	TaskCreateApiV1	none	body
» assignedUserKey (required)	string	The assigned user key.	body
» description	string	The task description.	body
» dueDate (required)	string(date-time)	The due date for the task.	body
» encodedKey	string	EncodedKey of the task to update. If no key is provided a new Task will be created.	body
» id	string	ID of the task. The parameter cannot be empty if the parameter itself is provided.	body
» status	string	The task status.	body
» taskLinkKey	string	The key of the client/group that is linked to this task. If null, means nobody is linked to this task. The parameter cannot be empty if the parameter itself is provided.	body
» taskLinkType	string	The type of task link.	body
» title (required)	string	The task title.	body

Enumerated Values

Parameter	Value
» status	`OPEN`
» status	`COMPLETED`
» taskLinkType	`CLIENT`
» taskLinkType	`GROUP`

Example Responses

200 : OK
a created task

{
  "task": {
    "encodedKey": "8a19dab474909bc8017490f2fb9006a6",
    "id": 11,
    "creationDate": "2020-09-15T09:23:02+0000",
    "lastModifiedDate": "2020-09-15T09:23:02+0000",
    "dueDate": "2020-12-11T00:00:00+0000",
    "title": "Create a new client",
    "description": "Create a new client named John Smith with home phone (44)333-8989 and address 123 Main Street",
    "createdByUserKey": "8a194075720ece2c017226fced6f005e",
    "status": "OPEN",
    "taskLinkType": "CLIENT",
    "daysUntilDue": 0,
    "assignedUserKey": "8a194075720ece2c017226fced6f005e"
  }
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	TaskApiV1

Transaction Channels

Allows the retrieval of a list of all transaction channels in the organization. Transaction channels represent the ways money comes in and out of accounts. For example, cash, cheque and card.

Get all Transaction Channels

GET /transactionchannels

Get all Transaction Channels

Get a list of channels in JSON format.

Example Responses

200 : ok
A list of transaction channels

[
  {
    "encodedKey": "8a0b8a2b4b9f463f014ba2627d910761",
    "channelFields": [],
    "id": "multicred",
    "name": "Multicredit",
    "createdByUserKey": "8a3e492e4b30343b014b316db58b0121",
    "creationDate": "2015-02-19T15:08:59+0000",
    "index": 2147483647,
    "activated": true,
    "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
    "loanConstraints": {
      "encodedKey": "4028809258fe98710158fe9871550001",
      "filterConstraints": []
    },
    "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
    "savingsConstraints": {
      "encodedKey": "8a80870a5908937f01590897b7ae000e",
      "filterConstraints": []
    }
  },
  {
    "encodedKey": "8a5103ac47aaf9e60147abc3130b011d",
    "channelFields": [
      "IDENTIFIER"
    ],
    "id": "BANK",
    "name": "BANK",
    "createdByUserKey": "8ae02be94371dfe3014371e7a7750020",
    "creationDate": "2014-08-06T14:39:54+0000",
    "index": 2147483647,
    "activated": true,
    "loanConstraintsUsage": "LIMITED_USAGE",
    "loanConstraints": {
      "encodedKey": "4028809258fe98710158fe9871550001",
      "filterConstraints": [
        {
          "encodedKey": "4028809258fe98710158fe9871550002",
          "dataFieldType": "NATIVE",
          "dataItemType": "TRANSACTION",
          "dataType": "ENUM",
          "dataFieldValue": "EVENT",
          "filterElement": "IN",
          "value": "DISBURSMENT",
          "linkingOperator": "AND",
          "groupNumber": 10
        },
        {
          "encodedKey": "4028809258fe98710158fe9871550003",
          "dataFieldType": "NATIVE",
          "dataItemType": "LOANS",
          "dataType": "KEY",
          "dataFieldValue": "PRODUCT_KEY",
          "filterElement": "IN",
          "value": "4028809258fc15dd0158fc17a65c034c",
          "linkingOperator": "AND",
          "groupNumber": 10
        },
        {
          "encodedKey": "4028809258fe98710158fe9871550004",
          "dataFieldType": "NATIVE",
          "dataItemType": "TRANSACTION",
          "dataType": "MONEY",
          "dataFieldValue": "AMOUNT",
          "filterElement": "MORE_THAN",
          "value": "100.00",
          "secondValue": "",
          "linkingOperator": "AND",
          "groupNumber": 10
        }
      ]
    },
    "savingsConstraintsUsage": "LIMITED_USAGE",
    "savingsConstraints": {
      "encodedKey": "8a80870a5908937f01590897b7ae000e",
      "filterConstraints": [
        {
          "encodedKey": "4028809258fe98710158fe9871550002",
          "dataFieldType": "NATIVE",
          "dataItemType": "TRANSACTION",
          "dataType": "ENUM",
          "dataFieldValue": "EVENT",
          "filterElement": "IN",
          "value": "DEPOSIT,WITHDRAWAL",
          "linkingOperator": "AND",
          "groupNumber": 10
        },
        {
          "encodedKey": "4028809258fe98710158fe9871550003",
          "dataFieldType": "NATIVE",
          "dataItemType": "SAVINGS",
          "dataType": "KEY",
          "dataFieldValue": "PRODUCT_KEY",
          "filterElement": "IN",
          "value": "8a80865d59078eaa015907c891420132",
          "linkingOperator": "AND",
          "groupNumber": 10
        },
        {
          "encodedKey": "4028809258fe98710158fe9871550004",
          "dataFieldType": "NATIVE",
          "dataItemType": "TRANSACTION",
          "dataType": "MONEY",
          "dataFieldValue": "AMOUNT",
          "filterElement": "MORE_THAN",
          "value": "100.00",
          "secondValue": "",
          "linkingOperator": "AND",
          "groupNumber": 10
        }
      ]
    },
    "customFields": [
      {
        "encodedKey": "8a80802a53d214ba0153e0eca1550ad7",
        "id": "IDENTIFIER_TRANSACTION_CHANNEL_I",
        "creationDate": "2016-04-15T06:59:18+0000",
        "lastModifiedDate": "2016-04-15T06:59:18+0000",
        "name": "Identifier",
        "type": "TRANSACTION_CHANNEL_INFO",
        "dataType": "STRING",
        "valueLength": "SHORT",
        "isDefault": false,
        "isRequired": false,
        "description": "",
        "customFieldSet": {
          "encodedKey": "8a80802a53d214ba0153e0eca13c0ad6",
          "indexInList": 0,
          "usage": "SINGLE"
        },
        "indexInList": 0,
        "customFieldProductSettings": [
          {
            "encodedKey": "8a80802a53d214ba0153e0eca1c20aec",
            "linkType": "CHANNEL",
            "productKey": "8a124c5c4619ffe901461a0d991c00e2",
            "isDefault": true,
            "isRequired": false
          },
          {
            "encodedKey": "8a8080b15416793e015418b7798f0119",
            "linkType": "CHANNEL",
            "productKey": "8a8080b15416793e015418b5ddaf0114",
            "isDefault": true,
            "isRequired": false
          }
        ],
        "state": "NORMAL",
        "customFieldSelectionOptions": [],
        "viewRights": {
          "encodedKey": "8a80802a53d214ba0153e0eca1550ad8",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "editRights": {
          "encodedKey": "8a80802a53d214ba0153e0eca1550ad9",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "unique": true,
        "values": [],
        "amounts": {}
      },
      {
        "encodedKey": "8a8080b1540761b301540a7bea330368",
        "id": "5_Transactions",
        "creationDate": "2016-04-12T12:39:34+0000",
        "lastModifiedDate": "2016-04-12T12:39:34+0000",
        "name": "5",
        "type": "TRANSACTION_CHANNEL_INFO",
        "dataType": "SELECTION",
        "valueLength": "SHORT",
        "isDefault": false,
        "isRequired": false,
        "description": "",
        "customFieldSet": {
          "encodedKey": "8a80802a53d214ba0153e0eca13c0ad6",
          "indexInList": 0,
          "usage": "SINGLE"
        },
        "indexInList": 7,
        "customFieldProductSettings": [
          {
            "encodedKey": "8a8080b1540761b301540a7bea41036b",
            "linkType": "CHANNEL",
            "productKey": "8a124c5c4619ffe901461a0d991c00e2",
            "isDefault": true,
            "isRequired": false
          },
          {
            "encodedKey": "8a8080b1540761b301540a7bea46036c",
            "linkType": "CHANNEL",
            "productKey": "8a0b8a2b4b9f463f014ba2627d910761",
            "isDefault": true,
            "isRequired": false
          },
          {
            "encodedKey": "8a8080b1540761b301540a7bea4a036d",
            "linkType": "CHANNEL",
            "productKey": "8a3ed7584b9c66e1014b9d81f8f2032a",
            "isDefault": true,
            "isRequired": false
          },
          {
            "encodedKey": "8a8080b1540761b301540a7bea4d036e",
            "linkType": "CHANNEL",
            "productKey": "8a5103ac47aaf9e60147abc3130b011d",
            "isDefault": true,
            "isRequired": false
          },
          {
            "encodedKey": "8a8080b1540761b301540a7bea50036f",
            "linkType": "CHANNEL",
            "productKey": "8ac9053748eaa70b0148efb4df021a88",
            "isDefault": true,
            "isRequired": false
          }
        ],
        "state": "NORMAL",
        "customFieldSelectionOptions": [],
        "viewRights": {
          "encodedKey": "8a8080b1540761b301540a7bea330369",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "editRights": {
          "encodedKey": "8a8080b1540761b301540a7bea34036a",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "unique": false,
        "values": [],
        "amounts": {}
      }
    ]
  },
  {
    "encodedKey": "8a5103ac47aaf9e60147abc3130b011d",
    "channelFields": [
      "BANK_NUMBER",
      "ACCOUNT_NUMBER"
    ],
    "id": "BANK",
    "name": "BANK",
    "createdByUserKey": "8ae02be94371dfe3014371e7a7750020",
    "creationDate": "2014-08-06T14:39:54+0000",
    "index": 2147483647,
    "activated": true,
    "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
    "loanConstraints": {
      "encodedKey": "4028809258fe98710158fe9871550001",
      "filterConstraints": []
    },
    "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
    "savingsConstraints": {
      "encodedKey": "8a80870a5908937f01590897b7ae000e",
      "filterConstraints": []
    },
    "usageRights": {
      "encodedKey": "8a17ed7e4f1cf5cd014f1d06ec540084",
      "isAccessibleByAllUsers": true,
      "roles": []
    },
    "transactionChannelAccountingRule": {
      "encodedKey": "8a099bf64db1cf54014db36e561e04f1",
      "financialResource": "FUND_SOURCE",
      "account": {
        "encodedKey": "8a099bf64db1cf54014db36d93a204ed",
        "creationDate": "2015-06-02T08:40:12+0000",
        "lastModifiedDate": "2015-06-02T08:40:12+0000",
        "glCode": "11200",
        "type": "ASSET",
        "usage": "DETAIL",
        "name": "Bank Account",
        "activated": true,
        "description": "",
        "allowManualJournalEntries": true,
        "stripTrailingZeros": true
      },
      "index": 0,
      "transactionChannelKey": "8a5103ac47aaf9e60147abc3130b011d"
    },
    "customFields": [
      {
        "encodedKey": "8a80802a53d214ba0153e0eca1630ada",
        "id": "BANK_NUMBER_TRANSACTION_CHANNEL_",
        "creationDate": "2016-04-15T06:58:11+0000",
        "lastModifiedDate": "2016-04-15T06:58:43+0000",
        "name": "Bank #",
        "type": "TRANSACTION_CHANNEL_INFO",
        "dataType": "STRING",
        "valueLength": "SHORT",
        "isDefault": false,
        "isRequired": false,
        "description": "",
        "customFieldSet": {
          "encodedKey": "8a80802a53d214ba0153e0eca13c0ad6",
          "indexInList": 0,
          "usage": "SINGLE"
        },
        "indexInList": 1,
        "customFieldProductSettings": [
          {
            "encodedKey": "8a80802a53d214ba0153e0eca1d00aed",
            "linkType": "CHANNEL",
            "productKey": "8a5103ac47aaf9e60147abc3130b011d",
            "isDefault": true,
            "isRequired": true
          },
          {
            "encodedKey": "8a8080b15416793e015418b6731f0116",
            "linkType": "CHANNEL",
            "productKey": "8a8080b15416793e015418b5ddaf0114",
            "isDefault": true,
            "isRequired": true
          },
          {
            "encodedKey": "8a80802a53d214ba0153e0eca1d30aee",
            "linkType": "CHANNEL",
            "productKey": "8ac9053748eaa70b0148efb4df021a88",
            "isDefault": true,
            "isRequired": false
          }
        ],
        "state": "NORMAL",
        "customFieldSelectionOptions": [],
        "viewRights": {
          "encodedKey": "8a80802a53d214ba0153e0eca1640adb",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "editRights": {
          "encodedKey": "8a80802a53d214ba0153e0eca1640adc",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "unique": false,
        "values": [],
        "amounts": {}
      },
      {
        "encodedKey": "8a80802a53d214ba0153e0eca18a0ae3",
        "id": "ACCOUNT_NUMBER_TRANSACTION_CHANN",
        "name": "Account #",
        "type": "TRANSACTION_CHANNEL_INFO",
        "dataType": "STRING",
        "valueLength": "SHORT",
        "isDefault": false,
        "isRequired": false,
        "customFieldSet": {
          "encodedKey": "8a80802a53d214ba0153e0eca13c0ad6",
          "indexInList": 0,
          "usage": "SINGLE"
        },
        "indexInList": 4,
        "customFieldProductSettings": [
          {
            "encodedKey": "8a80802a53d214ba0153e0eca1fe0af1",
            "linkType": "CHANNEL",
            "productKey": "8a5103ac47aaf9e60147abc3130b011d",
            "isDefault": true,
            "isRequired": false
          },
          {
            "encodedKey": "8a80802a53d214ba0153e0eca2010af2",
            "linkType": "CHANNEL",
            "productKey": "8ac9053748eaa70b0148efb4df021a88",
            "isDefault": true,
            "isRequired": false
          }
        ],
        "state": "NORMAL",
        "customFieldSelectionOptions": [],
        "viewRights": {
          "encodedKey": "8a80802a53d214ba0153e0eca18a0ae4",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "editRights": {
          "encodedKey": "8a80802a53d214ba0153e0eca18a0ae5",
          "isAccessibleByAllUsers": false,
          "roles": []
        },
        "unique": false,
        "values": [],
        "amounts": {}
      }
    ]
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[TransactionChannelInTransactionDetailsApiV1]	none	none
» activated	boolean	whether this transaction channel is enabled	none
» createdByUserKey	string	the encoded key of the user who created this transaction channel	none
» creationDate	string	the date on which this transaction channel was created	none
» customFields	[CustomFieldApiV1]	none	none
»» amounts	object	used when options available for a custom field definition translate to predefined amounts, for example, when the custom field value is used to generate a score	none
»»» additionalProperties	number	none	none
»» builtInCustomFieldId	string	if this field is one of the built in custom fiel definitions, this will have a value. These names are reserved and you can not use them for your own custom field definitions	none
»» creationDate	string	the date on which this custom field definition was created	none
»» customFieldProductSettings	[CustomFieldLinkApiV1]	none	none
»»» customFieldEncodedKey	string	the key to the parent custom field definition	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» isDefault	boolean	whether this field is displayed by default when creating a new record	none
»»» isRequired	boolean	whether this field is required when creating a new record	none
»»» linkType	string	the type of entity this field represents a link to	none
»»» productKey	string	when the link type is product, this field should contain the encoded key of the linekd product	none
»» customFieldSelectionOptions	[CustomFieldSelectionApiV1]	[represents a possible selection for select type custom field definitions]	none
»»» constraint	CustomFilterConstraintApiV1	none	none
»»»» customFieldKey	string	none	none
»»»» dataFieldType	string	none	none
»»»» dataFieldValue	string	none	none
»»»» dataItemType	string	none	none
»»»» dataType	string	none	none
»»»» encodedKey	string	none	none
»»»» filterElement	string	none	none
»»»» groupNumber	number	none	none
»»»» index	number	none	none
»»»» linkingOperator	string	none	none
»»»» secondValue	string	none	none
»»»» value	string	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» id	string	the ID of this selectable item	none
»»» score	number	the score assigned to this selection	none
»»» value	string	display name of this option	none
»» customFieldSet	CustomFieldSetApiV1	none	none
»»» builtInType	string	if this set is part of the set of built-in custom field sets, its type will be shown here	none
»»» createdDate	string	the date and time when this custom field set was created	none
»»» customFields	[CustomFieldApiV1]	an array of custom field definitions included in this custom field set	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» id	string	the ID of this custom field set	none
»»» indexInList	number	for field sets that can be added to an entity more than once, this number represents the index in the list and is used when changing values	none
»»» lastModifiedDate	string	the date on which this custom field set was last modified	none
»»» name	string	the name of this custom field set	none
»»» notes	string	any notes regarding this custom field set	none
»»» type	string	the entity type that this custom field definition is attached to	none
»»» usage	string	whether this custom field set can only be used once, or added multiple times to the same entity	none
»» dataType	string	the type of custom field definition	none
»» description	string	a brief description of this custom field definition	none
»» editRights	UsageRightsApiV1	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» isAccessibleByAllUsers	boolean	none	none
»»» roles	[string]	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» id	string	the ID for this custom field definition	none
»» indexInList	number	none	none
»» isDefault	boolean	whether this field will be included by default on new records	none
»» isRequired	boolean	whether this field is required when creating a new record	none
»» lastModifiedDate	string	the date on which this custom field definition was last modified	none
»» name	string	the name of this custom field definition	none
»» state	string	whether this field is available for use or has been deactivated	none
»» type	string	the type of data this custom field definition will contain	none
»» unique	boolean	whether the data in this custom field definition needs to be a unique value	none
»» validationPattern	string	a user-provided pattern to which data in this custom field definition must conform where @ represents numbers, # represents letters and $ is either a number or letter. Other special characters used as separators are allowed, for example `@@-##-$$$`	none
»» valueLength	string	whether this field needs to support a large number of characters	none
»» values	[string]	a list of possible values when the field is a selection field	none
»» viewRights	UsageRightsApiV1	none	none
» encodedKey	string	the encoded key for this transaction channel	none
» id	string	the user specified ID for this transaction channel	none
» index	number	none	none
» loanConstraints	CustomFilterApiV1	none	none
»» customConfigurationInfo	CustomConfigurationInfoApiV1	none	none
»»» creationDate	string	the date on which this configuration was created	none
»»» dataViewType	string	the type of entity this configuration is for	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» indexInList	number	if more than one configuration exists for a given type, this is its index in the list	none
»»» lastModifiedDate	string	the date on which this configuration was last modified	none
»»» name	string	the name for this configuration	none
»»» shared	boolean	whether this configuration is private or can be used by other users of the system	none
»»» userKey	string	the encoded key of the Mambu user who created this configuration	none
»» encodedKey	string	none	none
»» filterConstraints	[CustomFilterConstraintApiV1]	none	none
» loanConstraintsUsage	string	whether there are any rules regarding usage of this transaction channel with loan accounts	none
» name	string	the name of this transaction channel	none
» savingsConstraints	CustomFilterApiV1	none	none
» savingsConstraintsUsage	string	whether there are any rules regarding usage of this transaction channel with savings accounts	none
» transactionChannelAccountingRule	GLAccountingRuleApiV1	none	none
»» account	GLAccountApiV1	A general ledger account	none
»»» activated	boolean	whether this general ledger account is in use	none
»»» allowManualJournalEntries	boolean	whether manual entries are allowed for this general ledger account	none
»»» balance	number	the current balance of this general ledger account	none
»»» creationDate	string(date-time)	the date on which this general ledger account was created	read-only
»»» currency	CurrencyApiV1	none	none
»»»» code	string	the three letter ISO code for this currency	none
»»»» creationDate	string	the date on which this currency was created	none
»»»» currencySymbolPosition	string	indicates where the currency symbol should appear in relation to the numeric value	none
»»»» digitsAfterDecimal	number	indicates how many decimal places are allowed for this currency. For example, a currenncy with 100 minor units to 1 major unit, there will be 2 decimal places.	none
»»»» isBaseCurrency	boolean	whether this currency is the base currency for your banking institution	none
»»»» lastModifiedDate	string	the date on which this currency was last modified	none
»»»» name	string	the name of this currency	none
»»»» symbol	string	the currency symnbol used for this currency	none
»»» description	string	an optional description for this general ledger account	none
»»» encodedKey	string	the encoded key of this general ledger account	none
»»» glCode	string	the numeric code for this general ledger account	none
»»» lastModifiedDate	string(date-time)	the date on which this general ledger account was last modified	read-only
»»» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
»»»» creationDate	string(date-time)	the date on which the data import was made	none
»»»» encodedKey	string	the encoded key of this data migration event	none
»»»» numCentresImported	number	the number of centres which were imported during the data migration	none
»»»» numClientsImported	number	the number of clients which were imported as part of the data migration	none
»»»» numGLAccountsImported	number	the number of general ledger accounts which were imported as part of the data migration	none
»»»» numGroupsImported	number	the number of groups which were imported as part of the data migration	none
»»»» numLoanRepaymentsImported	number	the number of loan repayment transations which were imported as part of the data migration	none
»»»» numLoanTransactionsImported	number	the number of loan transactions which were imported as part of the data migration	none
»»»» numLoansImported	number	the number of loan accounts which were imported as part of the data migration	none
»»»» numSavingsImported	number	the number of savings accounts which were imported as part of the data migration	none
»»»» state	string	whether the data import was accepted, is still in a draft state, or was rejected and all data reverted	none
»»»» type	string	the type of migration event	none
»»» name	string	the name of this general ledger account	none
»»» stripTrailingZeros	boolean	controls how this account is organized into header accounts when there are trailing zeroes, for example, for the account code `1100`, if this field is set to true, only the first two numbers will be recognised	none
»»» type	string	the type of general ledger account	none
»»» usage	string	whether this general ledger account is a `DETAIL` account, in which case it will have a value, or a `HEADER` account, in which case its value will be calculated based on the sum of detail accounts under it.	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» financialResource	string	the type of transaction governed by this rule	none
»» index	number	the index in list when there are multiple rules for the same type of transaction	none
»» predefinedFeeKey	string	the encoded key of the predefined key this rule relates to	none
»» productKey	string	the encoded key of the product this rule relates to	none
»» productType	string	the type of account this rule relates to	none
»» transactionChannelKey	string	the encoded key of the transaction channel that this rule relates to	none
» usageRights	UsageRightsApiV1	none	none

Enumerated Values

Property	Value
builtInCustomFieldId	`MOBILE_PHONE`
builtInCustomFieldId	`EMAIL_ADDRESS`
builtInCustomFieldId	`GENDER`
builtInCustomFieldId	`MIDDLE_NAME`
builtInCustomFieldId	`HOME_PHONE`
builtInCustomFieldId	`BIRTHDATE`
builtInCustomFieldId	`LAST_NAME`
builtInCustomFieldId	`FIRST_NAME`
linkType	`CLIENT_ROLE`
linkType	`CHANNEL`
linkType	`PRODUCT`
dataFieldType	`NATIVE`
dataFieldType	`CUSTOM`
dataItemType	`WRITTEN_OFF_LOANS`
dataItemType	`LINE_OF_CREDIT`
dataItemType	`INVESTOR_FUND`
dataItemType	`TRANSACTION_DETAILS`
dataItemType	`DOCUMENT_TEMPLATE`
dataItemType	`PRODUCT`
dataItemType	`MCC_EXPIRATION`
dataItemType	`CENTRE`
dataItemType	`REPAYMENT_COLLECTION`
dataItemType	`TASK`
dataItemType	`OUTSTANDING_PORTFOLIO_AMOUNTS`
dataItemType	`REVENUE`
dataItemType	`COMPOSED_TRANSACTIONS`
dataItemType	`UNION_TRANSACTIONS`
dataItemType	`PRINCIPAL_PAYMENT_SETTINGS`
dataItemType	`LOANS`
dataItemType	`DISBURSEMENT_DETAILS`
dataItemType	`SAVINGS_TRANSACTION`
dataItemType	`IDENTIFICATION_DOCUMENT`
dataItemType	`LOAN_PRODUCT`
dataItemType	`DISBURSED_LOANS`
dataItemType	`LOAN_GROUP`
dataItemType	`TRANSACTION_CHANNEL`
dataItemType	`CUSTOM_PREDEFINED_FEE`
dataItemType	`JOURNAL_ENTRY`
dataItemType	`ATTACHMENT`
dataItemType	`PREDEFINED_FEE`
dataItemType	`TRANCHE`
dataItemType	`TRANSACTION`
dataItemType	`INDEX_RATE_SOURCE`
dataItemType	`GROUP_ROLE`
dataItemType	`LOAN_TRANSACTION`
dataItemType	`CLIENT_ROLE`
dataItemType	`GROUP`
dataItemType	`NOTIFICATION_MESSAGE`
dataItemType	`OUTSTANDING_PORTFOLIO_ACCOUNTS`
dataItemType	`REPAYMENT`
dataItemType	`LOAN_ACCOUNT_GUARANTY`
dataItemType	`BRANCH`
dataItemType	`CURRENCY`
dataItemType	`CARD_TRANSACTION_REVERSAL`
dataItemType	`INTEREST_PRODUCT_SETTINGS`
dataItemType	`CREATED_ACCOUNTS`
dataItemType	`USER`
dataItemType	`SAVINGS_PRODUCT`
dataItemType	`CLIENT`
dataItemType	`PRODUCT_ARREARS_SETTINGS`
dataItemType	`SAVINGS`
dataItemType	`EXPENSE`
dataItemType	`INDEX_RATE`
dataItemType	`NOTIFICATION_TEMPLATE`
dataItemType	`CUSTOM_FIELD_SELECTION`
dataItemType	`ACTIVITY`
dataType	`ENUM`
dataType	`MONEY`
dataType	`NUMBER`
dataType	`DATE_UTC`
dataType	`JAVA_BLOB`
dataType	`OBJECT`
dataType	`BOOLEAN`
dataType	`DATE`
dataType	`PERCENT`
dataType	`BIG_DECIMAL`
dataType	`STRING`
dataType	`KEY`
dataType	`LONG`
filterElement	`STARTS_WITH_CASE_SENSITIVE`
filterElement	`THIS_WEEK`
filterElement	`EQUALS`
filterElement	`STARTS_WITH`
filterElement	`IN`
filterElement	`TODAY`
filterElement	`THIS_YEAR`
filterElement	`BETWEEN`
filterElement	`AFTER`
filterElement	`LESS_THAN`
filterElement	`DIFFERENT_THAN`
filterElement	`THIS_MONTH`
filterElement	`NOT_EMPTY`
filterElement	`BEFORE`
filterElement	`EQUALS_CASE_SENSITIVE`
filterElement	`LAST_DAYS`
filterElement	`MORE_THAN`
filterElement	`EMPTY`
filterElement	`ON`
linkingOperator	`OR`
linkingOperator	`AND`
builtInType	`DETAILS`
builtInType	`GENERAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
usage	`SINGLE`
usage	`GROUPED`
dataType	`GROUP_LINK`
dataType	`DATE`
dataType	`NUMBER`
dataType	`CHECKBOX`
dataType	`CLIENT_LINK`
dataType	`STRING`
dataType	`USER_LINK`
dataType	`SELECTION`
state	`DEACTIVATED`
state	`NORMAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
valueLength	`SHORT`
valueLength	`LONG`
dataViewType	`PORTAL_ACCOUNT_TRANSACTION`
dataViewType	`LOANS_AGING_ANALYSIS`
dataViewType	`CLOSED_ACCOUNTS`
dataViewType	`CLIENT_OVERVIEW`
dataViewType	`ADMIN_CENTRES`
dataViewType	`USER_NOTIFICATION_MESSAGES`
dataViewType	`LINE_OF_CREDIT`
dataViewType	`USER_OVERVIEW`
dataViewType	`CENTRE_OVERVIEW`
dataViewType	`REPAYMENT_REPAYMENTS_COLLECTION`
dataViewType	`GROUP_OVERVIEW`
dataViewType	`ACTIVITIES_LOOKUP`
dataViewType	`TRANSACTION`
dataViewType	`ADMIN_BRANCHES`
dataViewType	`GROUP`
dataViewType	`BRANCH_OVERVIEW`
dataViewType	`NOTIFICATION_MESSAGE`
dataViewType	`PORTFOLIO_REPORTS`
dataViewType	`GROUP_NOTIFICATION_MESSAGES`
dataViewType	`LOAN_ACCOUNT_SECURITIES_OVERVIEW`
dataViewType	`LINE_OF_CREDIT_OVERVIEW`
dataViewType	`CURRENCIES`
dataViewType	`REPAYMENT`
dataViewType	`TILL_TRANSACTIONS`
dataViewType	`ALL_TASKS`
dataViewType	`CENTRE`
dataViewType	`BRANCH`
dataViewType	`INDEX_RATES_LIST`
dataViewType	`USER_TASKS`
dataViewType	`DOCUMENT_TEMPLATES`
dataViewType	`SAVINGS_TRANSACTIONS_LOOKUP`
dataViewType	`LOAN_ACCOUNT_OVERVIEW`
dataViewType	`DEPOSITS_COLLECTION`
dataViewType	`USER`
dataViewType	`ADMIN_USERS`
dataViewType	`GROUP_TASKS`
dataViewType	`CLIENT`
dataViewType	`LOAN_TRANSACTIONS_LOOKUP`
dataViewType	`LOANS`
dataViewType	`LOANS_REPAYMENTS_COLLECTION`
dataViewType	`CLIENT_TASKS`
dataViewType	`OVERDRAFTS_AGING_ANALYSIS`
dataViewType	`LOAN_ACCOUNT_FUNDING_OVERVIEW`
dataViewType	`SAVINGS`
dataViewType	`SAVINGS_OVERVIEW`
dataViewType	`JOURNAL_ENTRY`
dataViewType	`CLIENT_NOTIFICATION_MESSAGES`
loanConstraintsUsage	`UNCONSTRAINED_USAGE`
loanConstraintsUsage	`LIMITED_USAGE`
savingsConstraintsUsage	`UNCONSTRAINED_USAGE`
savingsConstraintsUsage	`LIMITED_USAGE`
currencySymbolPosition	`AFTER_NUMBER`
currencySymbolPosition	`BEFORE_NUMBER`
state	`REVERTED`
state	`DRAFT`
state	`APPROVED`
type	`IMPORT`
type	`EXPORT`
type	`INCOME`
type	`EXPENSE`
type	`LIABILITY`
type	`ASSET`
type	`EQUITY`
usage	`HEADER`
usage	`DETAIL`
financialResource	`FEE_RECEIVABLE`
financialResource	`OVERDRAFT_INTEREST_INCOME`
financialResource	`OVERDRAFT_INTEREST_RECEIVABLE`
financialResource	`FEE_INCOME`
financialResource	`INTEREST_PAYABLE`
financialResource	`INTEREST_EXPENSE`
financialResource	`PENALTY_RECEIVABLE`
financialResource	`INTEREST_INCOME`
financialResource	`DEFERRED_TAXES`
financialResource	`DEFERRED_FEE_INCOME`
financialResource	`PORTFOLIO_CONTROL`
financialResource	`DEFERRED_INTERESTS_INCOME`
financialResource	`OVERDRAFT_WRITE_OFF_EXPENSE`
financialResource	`PENALTY_INCOME`
financialResource	`OVERDRAFT_PORTFOLIO_CONTROL`
financialResource	`SAVINGS_CONTROL`
financialResource	`TAXES_RECEIVABLE`
financialResource	`INTEREST_RECEIVABLE`
financialResource	`INTER_BRANCH_TRANSFER`
financialResource	`FUND_SOURCE`
financialResource	`WRITE_OFF_EXPENSE`
financialResource	`DEPOSIT_REFERENCE`
financialResource	`TAXES_PAYABLE`
productType	`LOAN`
productType	`SAVINGS`

User Roles

Allows you to retrieve the user roles for an organization.

Get User Roles

GET /userroles

Get User Roles

Get a list of user roles in JSON format.

Example Responses

200 Response

[
  {
    "accessRights": [
      "APIS"
    ],
    "creationDate": "2019-08-24T14:15:22Z",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "id": "string",
    "isAdministrator": true,
    "isCreditOfficer": true,
    "isDelivery": true,
    "isSupport": true,
    "isTeller": true,
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "name": "string",
    "permissions": {
      "canManageAllBranches": true,
      "canManageEntitiesAssignedToOtherOfficers": true,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "permissions": [
        "string"
      ]
    }
  }
]

200 : OK
response

404 : Not Found
Bad User Role Key

{
  "returnCode": 707,
  "returnStatus": "INVALID_USER_ROLE_KEY"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[role]	[A userrole object]	none
» role	role	A userrole object	none
»» accessRights (required)	[string]	defines whether the user can access the UI, the API, or both.	none
»» creationDate (required)	string(date-time)	the date and time when this role was created	none
»» encodedKey (required)	string	the automatically generated encoded ID for this item	none
»» id (required)	string	the ID for this role	none
»» isAdministrator (required)	boolean	whether this role is for an administrator. Please note if this option is selected, the user will have blanket access, it is not possible to restict access for administrators using the permissions object.	none
»» isCreditOfficer (required)	boolean	whether this role represents a credit/loan officer type of user	none
»» isDelivery	boolean	whether this role relates to Mambu delivery users. Delivery teams need have accounts to assist you during the intitial setup stage, which will be disabled when you start using Mambu in production	none
»» isSupport (required)	boolean	whether this is a role for Mambu support users. Mambu users may, on request, be granted access to your system in order to troubleshoot problems	none
»» isTeller (required)	boolean	whether this role is for a 'teller' type user who will manage tills	none
»» lastModifiedDate (required)	string(date-time)	the date on which this role was last modified	none
»» name (required)	string	the name of this role	none
»» permissions (required)	object	none	none
»»» canManageAllBranches (required)	boolean	indicates whether the user can manage all branches or only they one they are assigned to	none
»»» canManageEntitiesAssignedToOtherOfficers (required)	boolean	indicates whether the user can edit clients and accounts which are assigned to other Mambu users	none
»»» encodedKey (required)	string	the automatically generated encoded ID for this item	none
»»» permissions (required)	[string]	a list of permissions	none

Status Code 404

Name	Type	Description	Restrictions
» returnCode (required)	number	none	none
» returnStatus (required)	string	none	none
» errorSource	string	none	none

Get User Role by ID

GET /userroles/{userRoleId}

Get User Role by ID

Get the user roles for a user by encoded key or ID.

Parameters

Name	Type	Description	In
userRoleId (required)	string	The encoded key or ID of the role.	path

Example Responses

200 Response

{
  "accessRights": [
    "APIS"
  ],
  "creationDate": "2019-08-24T14:15:22Z",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "id": "string",
  "isAdministrator": true,
  "isCreditOfficer": true,
  "isDelivery": true,
  "isSupport": true,
  "isTeller": true,
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "name": "string",
  "permissions": {
    "canManageAllBranches": true,
    "canManageEntitiesAssignedToOtherOfficers": true,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "permissions": [
      "string"
    ]
  }
}

200 : OK
response

404 : Not Found
Bad User Role ID

{
  "returnCode": 707,
  "returnStatus": "INVALID_USER_ROLE_KEY"
}

404 : Not Found
response

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	role
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 404

Name	Type	Description	Restrictions
» returnCode (required)	string	none	none
» returnStatus (required)	string	none	none

Enumerated Values

Property	Value
returnCode	`707`
returnStatus	`INVALID_USER_ROLE_KEY`

Users

Allows you to retrieve users by their id either a list of users or as one individual user. Note that certain fields (like password) are stripped out from the response for security reasons. User custom field values can be changed using patch or delete methods. See Custom Fields API for more information about custom field definitions and custom fields sets.

Get User's Custom Views

GET /users/{username}/views

Get User's Custom Views

get view filters for a user

Parameters

Name	Type	Description	In
for	string	The type of entity the view is for	query
username (required)	string	the username for the user, please note this is not the encoded key	path

Enumerated Values

Parameter	Value
for	`CLIENTS`
for	`GROUPS`
for	`LOANS`
for	`DEPOSITS`

Example Responses

200 : undefined
custom views for clients

[
  {
    "encodedKey": "8a194075720ece2c017226fcfa4c006e",
    "filter": {
      "encodedKey": "8a194075720ece2c017226fcfa4c0070",
      "filterConstraints": [
        {
          "encodedKey": "8a194075720ece2c017226fcfa4c0071",
          "dataFieldType": "NATIVE",
          "dataItemType": "CLIENT",
          "dataType": "ENUM",
          "dataFieldValue": "CLIENT_STATE",
          "filterElement": "EQUALS",
          "value": "ACTIVE",
          "linkingOperator": "AND",
          "groupNumber": 0,
          "index": 0
        }
      ]
    },
    "columnConfiguration": {
      "encodedKey": "8a194075720ece2c017226fcfaa40073",
      "fieldColumns": [
        {
          "encodedKey": "8a194075720ece2c017226fcfaa40075",
          "dataField": "FULL_NAME",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfaa40076",
          "dataField": "ID",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfaa40077",
          "dataField": "CLIENT_STATE",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfaad0078",
          "dataField": "CREDIT_OFFICER_NAME",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfaad0079",
          "dataField": "LOANS_BALANCE",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfaad007a",
          "dataField": "DEPOSITS_BALANCE",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfaad007b",
          "dataField": "LAST_MODIFIED_DATE",
          "dataItemType": "CLIENT"
        }
      ],
      "includeTotals": true,
      "includeTimestamp": false,
      "sortingColumn": {
        "encodedKey": "8a194075720ece2c017226fcfaa40074",
        "dataField": "LAST_MODIFIED_DATE",
        "dataItemType": "CLIENT"
      },
      "sortingOrder": "DESCENDING"
    },
    "customConfigurationInfo": {
      "encodedKey": "8a194075720ece2c017226fcfa4c0072",
      "name": "Active",
      "dataViewType": "CLIENT",
      "indexInList": -1,
      "creationDate": "2020-05-18T08:53:33+0000",
      "lastModifiedDate": "2020-05-18T08:53:33+0000"
    },
    "viewMode": "LIST",
    "parentMenuItemKey": "8a194075720ece2c017226fcf713006c",
    "viewRights": {
      "encodedKey": "8a194075720ece2c017226fcfa4c006f",
      "isAccessibleByAllUsers": true,
      "roles": []
    }
  },
  {
    "encodedKey": "8a194075720ece2c017226fcfaad007c",
    "filter": {
      "encodedKey": "8a194075720ece2c017226fcfaaf007e",
      "filterConstraints": [
        {
          "encodedKey": "8a194075720ece2c017226fcfaaf007f",
          "dataFieldType": "NATIVE",
          "dataItemType": "CLIENT",
          "dataType": "ENUM",
          "dataFieldValue": "CLIENT_STATE",
          "filterElement": "EQUALS",
          "value": "INACTIVE",
          "linkingOperator": "AND",
          "groupNumber": 0,
          "index": 0
        }
      ]
    },
    "columnConfiguration": {
      "encodedKey": "8a194075720ece2c017226fcfaaf0081",
      "fieldColumns": [
        {
          "encodedKey": "8a194075720ece2c017226fcfab10083",
          "dataField": "FULL_NAME",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfab10084",
          "dataField": "ID",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfab10085",
          "dataField": "CLIENT_STATE",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfab10086",
          "dataField": "CREDIT_OFFICER_NAME",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfabe0087",
          "dataField": "TOTAL_BALANCE",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfabe0088",
          "dataField": "PENDING_LOAN_AMOUNT",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfabe0089",
          "dataField": "APPROVED_LOAN_AMOUNT",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfabe008a",
          "dataField": "LAST_MODIFIED_DATE",
          "dataItemType": "CLIENT"
        }
      ],
      "includeTotals": true,
      "includeTimestamp": false,
      "sortingColumn": {
        "encodedKey": "8a194075720ece2c017226fcfab10082",
        "dataField": "LAST_MODIFIED_DATE",
        "dataItemType": "CLIENT"
      },
      "sortingOrder": "DESCENDING"
    },
    "customConfigurationInfo": {
      "encodedKey": "8a194075720ece2c017226fcfaaf0080",
      "name": "Inactive",
      "dataViewType": "CLIENT",
      "indexInList": -1,
      "creationDate": "2020-05-18T08:53:33+0000",
      "lastModifiedDate": "2020-05-18T08:53:33+0000"
    },
    "viewMode": "LIST",
    "parentMenuItemKey": "8a194075720ece2c017226fcf713006c",
    "viewRights": {
      "encodedKey": "8a194075720ece2c017226fcfaaf007d",
      "isAccessibleByAllUsers": true,
      "roles": []
    }
  },
  {
    "encodedKey": "8a194075720ece2c017226fcfabe008b",
    "filter": {
      "encodedKey": "8a194075720ece2c017226fcfac1008d",
      "filterConstraints": [
        {
          "encodedKey": "8a194075720ece2c017226fcfac1008e",
          "dataFieldType": "NATIVE",
          "dataItemType": "CLIENT",
          "dataType": "ENUM",
          "dataFieldValue": "CLIENT_STATE",
          "filterElement": "EQUALS",
          "value": "PENDING_APPROVAL",
          "linkingOperator": "AND",
          "groupNumber": 0,
          "index": 0
        }
      ]
    },
    "columnConfiguration": {
      "encodedKey": "8a194075720ece2c017226fcfac10090",
      "fieldColumns": [
        {
          "encodedKey": "8a194075720ece2c017226fcfacb0092",
          "dataField": "FULL_NAME",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfacb0093",
          "dataField": "ID",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfacb0094",
          "dataField": "CLIENT_STATE",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfacb0095",
          "dataField": "CREDIT_OFFICER_NAME",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcface0096",
          "dataField": "CREATION_DATE",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcface0097",
          "dataField": "LAST_MODIFIED_DATE",
          "dataItemType": "CLIENT"
        }
      ],
      "includeTotals": true,
      "includeTimestamp": false,
      "sortingColumn": {
        "encodedKey": "8a194075720ece2c017226fcfacb0091",
        "dataField": "LAST_MODIFIED_DATE",
        "dataItemType": "CLIENT"
      },
      "sortingOrder": "DESCENDING"
    },
    "customConfigurationInfo": {
      "encodedKey": "8a194075720ece2c017226fcfac1008f",
      "name": "Pending Approval",
      "dataViewType": "CLIENT",
      "indexInList": -1,
      "creationDate": "2020-05-18T08:53:33+0000",
      "lastModifiedDate": "2020-05-18T08:53:33+0000"
    },
    "viewMode": "LIST",
    "parentMenuItemKey": "8a194075720ece2c017226fcf713006c",
    "viewRights": {
      "encodedKey": "8a194075720ece2c017226fcfac1008c",
      "isAccessibleByAllUsers": true,
      "roles": []
    }
  },
  {
    "encodedKey": "8a194075720ece2c017226fcface0098",
    "filter": {
      "encodedKey": "8a194075720ece2c017226fcface009a",
      "filterConstraints": [
        {
          "encodedKey": "8a194075720ece2c017226fcfad8009b",
          "dataFieldType": "NATIVE",
          "dataItemType": "CLIENT",
          "dataType": "ENUM",
          "dataFieldValue": "CLIENT_STATE",
          "filterElement": "EQUALS",
          "value": "EXITED",
          "linkingOperator": "AND",
          "groupNumber": 0,
          "index": 0
        }
      ]
    },
    "columnConfiguration": {
      "encodedKey": "8a194075720ece2c017226fcfad8009d",
      "fieldColumns": [
        {
          "encodedKey": "8a194075720ece2c017226fcfad8009f",
          "dataField": "FULL_NAME",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfadb00a0",
          "dataField": "ID",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfadb00a1",
          "dataField": "CLIENT_STATE",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfadb00a2",
          "dataField": "CREDIT_OFFICER_NAME",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfadb00a3",
          "dataField": "TOTAL_BALANCE",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfadb00a4",
          "dataField": "LOAN_CYCLE",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfadd00a5",
          "dataField": "LAST_MODIFIED_DATE",
          "dataItemType": "CLIENT"
        }
      ],
      "includeTotals": true,
      "includeTimestamp": false,
      "sortingColumn": {
        "encodedKey": "8a194075720ece2c017226fcfad8009e",
        "dataField": "LAST_MODIFIED_DATE",
        "dataItemType": "CLIENT"
      },
      "sortingOrder": "DESCENDING"
    },
    "customConfigurationInfo": {
      "encodedKey": "8a194075720ece2c017226fcfad8009c",
      "name": "Exited",
      "dataViewType": "CLIENT",
      "indexInList": -1,
      "creationDate": "2020-05-18T08:53:33+0000",
      "lastModifiedDate": "2020-05-18T08:53:33+0000"
    },
    "viewMode": "LIST",
    "parentMenuItemKey": "8a194075720ece2c017226fcf713006c",
    "viewRights": {
      "encodedKey": "8a194075720ece2c017226fcface0099",
      "isAccessibleByAllUsers": true,
      "roles": []
    }
  },
  {
    "encodedKey": "8a194075720ece2c017226fcfadd00a6",
    "filter": {
      "encodedKey": "8a194075720ece2c017226fcfadd00a8",
      "filterConstraints": [
        {
          "encodedKey": "8a194075720ece2c017226fcfadd00a9",
          "dataFieldType": "NATIVE",
          "dataItemType": "CLIENT",
          "dataType": "ENUM",
          "dataFieldValue": "CLIENT_STATE",
          "filterElement": "EQUALS",
          "value": "BLACKLISTED",
          "linkingOperator": "AND",
          "groupNumber": 0,
          "index": 0
        }
      ]
    },
    "columnConfiguration": {
      "encodedKey": "8a194075720ece2c017226fcfae000ab",
      "fieldColumns": [
        {
          "encodedKey": "8a194075720ece2c017226fcfae000ad",
          "dataField": "FULL_NAME",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfae000ae",
          "dataField": "ID",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfae700af",
          "dataField": "CLIENT_STATE",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfae700b0",
          "dataField": "CREDIT_OFFICER_NAME",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfae700b1",
          "dataField": "TOTAL_BALANCE",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfae700b2",
          "dataField": "LOAN_CYCLE",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a194075720ece2c017226fcfae700b3",
          "dataField": "LAST_MODIFIED_DATE",
          "dataItemType": "CLIENT"
        }
      ],
      "includeTotals": true,
      "includeTimestamp": false,
      "sortingColumn": {
        "encodedKey": "8a194075720ece2c017226fcfae000ac",
        "dataField": "LAST_MODIFIED_DATE",
        "dataItemType": "CLIENT"
      },
      "sortingOrder": "DESCENDING"
    },
    "customConfigurationInfo": {
      "encodedKey": "8a194075720ece2c017226fcfae000aa",
      "name": "Blacklisted",
      "dataViewType": "CLIENT",
      "indexInList": -1,
      "creationDate": "2020-05-18T08:53:33+0000",
      "lastModifiedDate": "2020-05-18T08:53:33+0000"
    },
    "viewMode": "LIST",
    "parentMenuItemKey": "8a194075720ece2c017226fcf713006c",
    "viewRights": {
      "encodedKey": "8a194075720ece2c017226fcfadd00a7",
      "isAccessibleByAllUsers": true,
      "roles": []
    }
  },
  {
    "encodedKey": "8a19df6972b787fc0172b83fe8830700",
    "filter": {
      "encodedKey": "8a19df6972b787fc0172b83fe8830702",
      "filterConstraints": [
        {
          "encodedKey": "8a19df6972b787fc0172b83fe8860703",
          "dataFieldType": "NATIVE",
          "dataItemType": "CLIENT",
          "dataType": "KEY",
          "dataFieldValue": "CLIENT_ROLE_KEY",
          "filterElement": "IN",
          "value": "8a194075720ece2c017226fcf55e0068",
          "linkingOperator": "AND",
          "groupNumber": 10,
          "index": 0
        }
      ]
    },
    "columnConfiguration": {
      "encodedKey": "8a19df6972b787fc0172b83f3de206fb",
      "fieldColumns": [
        {
          "encodedKey": "8a19df6972b787fc0172b83f3de206fd",
          "dataField": "CLIENT_STATE",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a19df6972b787fc0172b83fe88306fe",
          "dataField": "BRANCH_NAME",
          "dataItemType": "CLIENT"
        },
        {
          "encodedKey": "8a19df6972b787fc0172b83fe88306ff",
          "dataField": "CREDIT_OFFICER_NAME",
          "dataItemType": "CLIENT"
        }
      ],
      "includeTotals": true,
      "includeTimestamp": true,
      "sortingColumn": {
        "encodedKey": "8a19df6972b787fc0172b83f3de206fc",
        "dataField": "CENTRE_NAME",
        "dataItemType": "CLIENT"
      },
      "sortingOrder": "DESCENDING"
    },
    "customConfigurationInfo": {
      "encodedKey": "8a19df6972b787fc0172b83fe8860704",
      "userKey": "8a194075720ece2c017226fced6f005e",
      "name": "list all people custom",
      "dataViewType": "CLIENT",
      "indexInList": -1,
      "creationDate": "2020-06-15T13:51:36+0000",
      "lastModifiedDate": "2020-06-15T13:51:36+0000"
    },
    "viewMode": "LIST",
    "parentMenuItemKey": "8a19df6972b787fc0172b83f3de206f9",
    "viewRights": {
      "encodedKey": "8a19df6972b787fc0172b83fe8830701",
      "isAccessibleByAllUsers": true,
      "roles": []
    }
  }
]

400 : Bad Request
Bad filter parameter

{
  "returnCode": 4,
  "returnStatus": "INVALID_PARAMETERS",
  "errorSource": "invalid for parameter"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	none	Inline
`400`	Bad Request	Bad Request	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[CustomViewApiV1]	none	none
» columnConfiguration	ColumnConfigurationApiV1	none	none
»» customConfigurationInfo	CustomViewConfigurationInfoApiV1	none	none
»»» creationDate	string	the date on which this configuration was created	none
»»» dataViewType	string	the type of entity that will be shown using this view, for example clients, groups etc.	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» indexInList	number	index in list when there is more than one custom view for a given entity type	none
»»» lastModifiedDate	string	the date on which this custom view was last modified	none
»»» name	string	the name of this custom view	none
»»» userKey	string	the encoded key of the user who created this custom view	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» fieldColumns	[FieldColumnApiV1]	none	none
»»» customField	CustomFieldApiV1	none	none
»»»» amounts	object	used when options available for a custom field definition translate to predefined amounts, for example, when the custom field value is used to generate a score	none
»»»»» additionalProperties	number	none	none
»»»» builtInCustomFieldId	string	if this field is one of the built in custom fiel definitions, this will have a value. These names are reserved and you can not use them for your own custom field definitions	none
»»»» creationDate	string	the date on which this custom field definition was created	none
»»»» customFieldProductSettings	[CustomFieldLinkApiV1]	none	none
»»»»» customFieldEncodedKey	string	the key to the parent custom field definition	none
»»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»»» isDefault	boolean	whether this field is displayed by default when creating a new record	none
»»»»» isRequired	boolean	whether this field is required when creating a new record	none
»»»»» linkType	string	the type of entity this field represents a link to	none
»»»»» productKey	string	when the link type is product, this field should contain the encoded key of the linekd product	none
»»»» customFieldSelectionOptions	[CustomFieldSelectionApiV1]	[represents a possible selection for select type custom field definitions]	none
»»»»» constraint	CustomFilterConstraintApiV1	none	none
»»»»»» customFieldKey	string	none	none
»»»»»» dataFieldType	string	none	none
»»»»»» dataFieldValue	string	none	none
»»»»»» dataItemType	string	none	none
»»»»»» dataType	string	none	none
»»»»»» encodedKey	string	none	none
»»»»»» filterElement	string	none	none
»»»»»» groupNumber	number	none	none
»»»»»» index	number	none	none
»»»»»» linkingOperator	string	none	none
»»»»»» secondValue	string	none	none
»»»»»» value	string	none	none
»»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»»» id	string	the ID of this selectable item	none
»»»»» score	number	the score assigned to this selection	none
»»»»» value	string	display name of this option	none
»»»» customFieldSet	CustomFieldSetApiV1	none	none
»»»»» builtInType	string	if this set is part of the set of built-in custom field sets, its type will be shown here	none
»»»»» createdDate	string	the date and time when this custom field set was created	none
»»»»» customFields	[CustomFieldApiV1]	an array of custom field definitions included in this custom field set	none
»»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»»» id	string	the ID of this custom field set	none
»»»»» indexInList	number	for field sets that can be added to an entity more than once, this number represents the index in the list and is used when changing values	none
»»»»» lastModifiedDate	string	the date on which this custom field set was last modified	none
»»»»» name	string	the name of this custom field set	none
»»»»» notes	string	any notes regarding this custom field set	none
»»»»» type	string	the entity type that this custom field definition is attached to	none
»»»»» usage	string	whether this custom field set can only be used once, or added multiple times to the same entity	none
»»»» dataType	string	the type of custom field definition	none
»»»» description	string	a brief description of this custom field definition	none
»»»» editRights	UsageRightsApiV1	none	none
»»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»»» isAccessibleByAllUsers	boolean	none	none
»»»»» roles	[string]	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID for this custom field definition	none
»»»» indexInList	number	none	none
»»»» isDefault	boolean	whether this field will be included by default on new records	none
»»»» isRequired	boolean	whether this field is required when creating a new record	none
»»»» lastModifiedDate	string	the date on which this custom field definition was last modified	none
»»»» name	string	the name of this custom field definition	none
»»»» state	string	whether this field is available for use or has been deactivated	none
»»»» type	string	the type of data this custom field definition will contain	none
»»»» unique	boolean	whether the data in this custom field definition needs to be a unique value	none
»»»» validationPattern	string	a user-provided pattern to which data in this custom field definition must conform where @ represents numbers, # represents letters and $ is either a number or letter. Other special characters used as separators are allowed, for example `@@-##-$$$`	none
»»»» valueLength	string	whether this field needs to support a large number of characters	none
»»»» values	[string]	a list of possible values when the field is a selection field	none
»»»» viewRights	UsageRightsApiV1	none	none
»»» dataField	string	none	none
»»» dataItemType	string	the type of data which is displayed in this column	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»» includeTimestamp	boolean	wether the column should include a timestamp	none
»» includeTotals	boolean	whether there should be an automatically calucalated sum total for this column	none
»» sortingColumn	FieldColumnApiV1	none	none
»» sortingOrder	string	the default sort order for this column	none
» customConfigurationInfo	CustomViewConfigurationInfoApiV1	none	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» filter	CustomViewFilterApiV1	none	none
»» customConfigurationInfo	CustomViewConfigurationInfoApiV1	none	none
»» encodedKey	string	the automatically generated ID for this item	none
»» filterConstraints	[CustomFilterConstraintApiV1]	none	none
» parentMenuItemKey	string	the encoded key of the menu that uses this custom view	none
» viewMode	string	whether this view is a simple list or more detailed table	none
» viewRights	UsageRightsApiV1	none	none

Enumerated Values

Property	Value
dataViewType	`PORTAL_ACCOUNT_TRANSACTION`
dataViewType	`LOANS_AGING_ANALYSIS`
dataViewType	`CLOSED_ACCOUNTS`
dataViewType	`CLIENT_OVERVIEW`
dataViewType	`ADMIN_CENTRES`
dataViewType	`USER_NOTIFICATION_MESSAGES`
dataViewType	`LINE_OF_CREDIT`
dataViewType	`USER_OVERVIEW`
dataViewType	`CENTRE_OVERVIEW`
dataViewType	`REPAYMENT_REPAYMENTS_COLLECTION`
dataViewType	`GROUP_OVERVIEW`
dataViewType	`ACTIVITIES_LOOKUP`
dataViewType	`TRANSACTION`
dataViewType	`ADMIN_BRANCHES`
dataViewType	`GROUP`
dataViewType	`BRANCH_OVERVIEW`
dataViewType	`NOTIFICATION_MESSAGE`
dataViewType	`PORTFOLIO_REPORTS`
dataViewType	`GROUP_NOTIFICATION_MESSAGES`
dataViewType	`LOAN_ACCOUNT_SECURITIES_OVERVIEW`
dataViewType	`LINE_OF_CREDIT_OVERVIEW`
dataViewType	`CURRENCIES`
dataViewType	`REPAYMENT`
dataViewType	`TILL_TRANSACTIONS`
dataViewType	`ALL_TASKS`
dataViewType	`CENTRE`
dataViewType	`BRANCH`
dataViewType	`INDEX_RATES_LIST`
dataViewType	`USER_TASKS`
dataViewType	`DOCUMENT_TEMPLATES`
dataViewType	`SAVINGS_TRANSACTIONS_LOOKUP`
dataViewType	`LOAN_ACCOUNT_OVERVIEW`
dataViewType	`DEPOSITS_COLLECTION`
dataViewType	`USER`
dataViewType	`ADMIN_USERS`
dataViewType	`GROUP_TASKS`
dataViewType	`CLIENT`
dataViewType	`LOAN_TRANSACTIONS_LOOKUP`
dataViewType	`LOANS`
dataViewType	`LOANS_REPAYMENTS_COLLECTION`
dataViewType	`CLIENT_TASKS`
dataViewType	`OVERDRAFTS_AGING_ANALYSIS`
dataViewType	`LOAN_ACCOUNT_FUNDING_OVERVIEW`
dataViewType	`SAVINGS`
dataViewType	`SAVINGS_OVERVIEW`
dataViewType	`JOURNAL_ENTRY`
dataViewType	`CLIENT_NOTIFICATION_MESSAGES`
builtInCustomFieldId	`MOBILE_PHONE`
builtInCustomFieldId	`EMAIL_ADDRESS`
builtInCustomFieldId	`GENDER`
builtInCustomFieldId	`MIDDLE_NAME`
builtInCustomFieldId	`HOME_PHONE`
builtInCustomFieldId	`BIRTHDATE`
builtInCustomFieldId	`LAST_NAME`
builtInCustomFieldId	`FIRST_NAME`
linkType	`CLIENT_ROLE`
linkType	`CHANNEL`
linkType	`PRODUCT`
dataFieldType	`NATIVE`
dataFieldType	`CUSTOM`
dataItemType	`WRITTEN_OFF_LOANS`
dataItemType	`LINE_OF_CREDIT`
dataItemType	`INVESTOR_FUND`
dataItemType	`TRANSACTION_DETAILS`
dataItemType	`DOCUMENT_TEMPLATE`
dataItemType	`PRODUCT`
dataItemType	`MCC_EXPIRATION`
dataItemType	`CENTRE`
dataItemType	`REPAYMENT_COLLECTION`
dataItemType	`TASK`
dataItemType	`OUTSTANDING_PORTFOLIO_AMOUNTS`
dataItemType	`REVENUE`
dataItemType	`COMPOSED_TRANSACTIONS`
dataItemType	`UNION_TRANSACTIONS`
dataItemType	`PRINCIPAL_PAYMENT_SETTINGS`
dataItemType	`LOANS`
dataItemType	`DISBURSEMENT_DETAILS`
dataItemType	`SAVINGS_TRANSACTION`
dataItemType	`IDENTIFICATION_DOCUMENT`
dataItemType	`LOAN_PRODUCT`
dataItemType	`DISBURSED_LOANS`
dataItemType	`LOAN_GROUP`
dataItemType	`TRANSACTION_CHANNEL`
dataItemType	`CUSTOM_PREDEFINED_FEE`
dataItemType	`JOURNAL_ENTRY`
dataItemType	`ATTACHMENT`
dataItemType	`PREDEFINED_FEE`
dataItemType	`TRANCHE`
dataItemType	`TRANSACTION`
dataItemType	`INDEX_RATE_SOURCE`
dataItemType	`GROUP_ROLE`
dataItemType	`LOAN_TRANSACTION`
dataItemType	`CLIENT_ROLE`
dataItemType	`GROUP`
dataItemType	`NOTIFICATION_MESSAGE`
dataItemType	`OUTSTANDING_PORTFOLIO_ACCOUNTS`
dataItemType	`REPAYMENT`
dataItemType	`LOAN_ACCOUNT_GUARANTY`
dataItemType	`BRANCH`
dataItemType	`CURRENCY`
dataItemType	`CARD_TRANSACTION_REVERSAL`
dataItemType	`INTEREST_PRODUCT_SETTINGS`
dataItemType	`CREATED_ACCOUNTS`
dataItemType	`USER`
dataItemType	`SAVINGS_PRODUCT`
dataItemType	`CLIENT`
dataItemType	`PRODUCT_ARREARS_SETTINGS`
dataItemType	`SAVINGS`
dataItemType	`EXPENSE`
dataItemType	`INDEX_RATE`
dataItemType	`NOTIFICATION_TEMPLATE`
dataItemType	`CUSTOM_FIELD_SELECTION`
dataItemType	`ACTIVITY`
dataType	`ENUM`
dataType	`MONEY`
dataType	`NUMBER`
dataType	`DATE_UTC`
dataType	`JAVA_BLOB`
dataType	`OBJECT`
dataType	`BOOLEAN`
dataType	`DATE`
dataType	`PERCENT`
dataType	`BIG_DECIMAL`
dataType	`STRING`
dataType	`KEY`
dataType	`LONG`
filterElement	`STARTS_WITH_CASE_SENSITIVE`
filterElement	`THIS_WEEK`
filterElement	`EQUALS`
filterElement	`STARTS_WITH`
filterElement	`IN`
filterElement	`TODAY`
filterElement	`THIS_YEAR`
filterElement	`BETWEEN`
filterElement	`AFTER`
filterElement	`LESS_THAN`
filterElement	`DIFFERENT_THAN`
filterElement	`THIS_MONTH`
filterElement	`NOT_EMPTY`
filterElement	`BEFORE`
filterElement	`EQUALS_CASE_SENSITIVE`
filterElement	`LAST_DAYS`
filterElement	`MORE_THAN`
filterElement	`EMPTY`
filterElement	`ON`
linkingOperator	`OR`
linkingOperator	`AND`
builtInType	`DETAILS`
builtInType	`GENERAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
usage	`SINGLE`
usage	`GROUPED`
dataType	`GROUP_LINK`
dataType	`DATE`
dataType	`NUMBER`
dataType	`CHECKBOX`
dataType	`CLIENT_LINK`
dataType	`STRING`
dataType	`USER_LINK`
dataType	`SELECTION`
state	`DEACTIVATED`
state	`NORMAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
valueLength	`SHORT`
valueLength	`LONG`
dataItemType	`WRITTEN_OFF_LOANS`
dataItemType	`LINE_OF_CREDIT`
dataItemType	`INVESTOR_FUND`
dataItemType	`TRANSACTION_DETAILS`
dataItemType	`DOCUMENT_TEMPLATE`
dataItemType	`PRODUCT`
dataItemType	`MCC_EXPIRATION`
dataItemType	`CENTRE`
dataItemType	`REPAYMENT_COLLECTION`
dataItemType	`TASK`
dataItemType	`OUTSTANDING_PORTFOLIO_AMOUNTS`
dataItemType	`REVENUE`
dataItemType	`COMPOSED_TRANSACTIONS`
dataItemType	`UNION_TRANSACTIONS`
dataItemType	`PRINCIPAL_PAYMENT_SETTINGS`
dataItemType	`LOANS`
dataItemType	`DISBURSEMENT_DETAILS`
dataItemType	`SAVINGS_TRANSACTION`
dataItemType	`IDENTIFICATION_DOCUMENT`
dataItemType	`LOAN_PRODUCT`
dataItemType	`DISBURSED_LOANS`
dataItemType	`LOAN_GROUP`
dataItemType	`TRANSACTION_CHANNEL`
dataItemType	`CUSTOM_PREDEFINED_FEE`
dataItemType	`JOURNAL_ENTRY`
dataItemType	`ATTACHMENT`
dataItemType	`PREDEFINED_FEE`
dataItemType	`TRANCHE`
dataItemType	`TRANSACTION`
dataItemType	`INDEX_RATE_SOURCE`
dataItemType	`GROUP_ROLE`
dataItemType	`LOAN_TRANSACTION`
dataItemType	`CLIENT_ROLE`
dataItemType	`GROUP`
dataItemType	`NOTIFICATION_MESSAGE`
dataItemType	`OUTSTANDING_PORTFOLIO_ACCOUNTS`
dataItemType	`REPAYMENT`
dataItemType	`LOAN_ACCOUNT_GUARANTY`
dataItemType	`BRANCH`
dataItemType	`CURRENCY`
dataItemType	`CARD_TRANSACTION_REVERSAL`
dataItemType	`INTEREST_PRODUCT_SETTINGS`
dataItemType	`CREATED_ACCOUNTS`
dataItemType	`USER`
dataItemType	`SAVINGS_PRODUCT`
dataItemType	`CLIENT`
dataItemType	`PRODUCT_ARREARS_SETTINGS`
dataItemType	`SAVINGS`
dataItemType	`EXPENSE`
dataItemType	`INDEX_RATE`
dataItemType	`NOTIFICATION_TEMPLATE`
dataItemType	`CUSTOM_FIELD_SELECTION`
dataItemType	`ACTIVITY`
sortingOrder	`ASCENDING`
sortingOrder	`ASCENDING_IGORE_CASE`
sortingOrder	`DESCENDING`
viewMode	`DETAIL`
viewMode	`LIST`

Status Code 400

Name	Type	Description	Restrictions
» returnCode (required)	string	none	none
» returnStatus (required)	string	none	none
» errorSource	string	none	none

Get all users

GET /users

Get all users

Get all users

Parameters

Name	Type	Description	In
branchID	string	filter users by assigned Branch	query
offset	integer	Start at index x. Use with `limit` parameter to achieve paging	query
limit	integer	Max number of records to return.	query
fullDetails	boolean	Include all nested and custom field values.	query
branchIDType	string	How to filter the users based on id. (Optional).	query

Detailed descriptions

branchIDType: How to filter the users based on id. (Optional).

ASSIGNED - Returns the users assigned to the branchId. Default value if this parameter is missing
MANAGE - Returns the users that can manage the branch (are assigned to the branch, can manage the branch, can manage all branches)

Enumerated Values

Parameter	Value
branchIDType	`ASSIGNED`
branchIDType	`MANAGE`

Example Responses

200 : ok
An array of users

[
  {
    "encodedKey": "8a194075720ece2c017226fced6f005e",
    "id": 1,
    "creationDate": "2020-05-18T08:53:30+0000",
    "lastModifiedDate": "2020-09-14T11:23:42+0000",
    "lastLoggedInDate": "2020-09-14T11:23:42+0000",
    "username": "bigchief",
    "email": "bigchief@mambu.com",
    "title": "",
    "firstName": "Big",
    "lastName": "Chief",
    "homePhone": "",
    "mobilePhone1": "",
    "language": "ENGLISH",
    "userState": "ACTIVE",
    "twoFactorAuthentication": false,
    "isAdministrator": true,
    "isTeller": false,
    "isCreditOfficer": false,
    "isSupport": false,
    "accessRights": [
      "MAMBU",
      "APIS"
    ],
    "managedBranches": [],
    "notes": "",
    "failedLoginsCount": 0,
    "failedLoginsDates": [],
    "provisionedThroughFederation": false
  },
  {
    "encodedKey": "8a19df0e730ee86f01730f4c3cf2074a",
    "id": 11,
    "creationDate": "2020-07-02T11:34:32+0000",
    "lastModifiedDate": "2020-07-02T11:34:32+0000",
    "username": "jonnyt",
    "email": "johnny@testbank.com",
    "title": "",
    "firstName": "Johnny",
    "lastName": "Test",
    "homePhone": "",
    "mobilePhone1": "",
    "language": "ENGLISH",
    "userState": "ACTIVE",
    "twoFactorAuthentication": false,
    "isAdministrator": false,
    "isTeller": false,
    "isCreditOfficer": false,
    "isSupport": false,
    "accessRights": [
      "MAMBU"
    ],
    "managedBranches": [],
    "notes": "",
    "failedLoginsCount": 0,
    "provisionedThroughFederation": false
  }
]

400 : Bad Request
Bad Branch ID

{
  "returnCode": 800,
  "returnStatus": "INVALID_BRANCH_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[UserApiV1]	none	none
» accessRights	[string]	none	none
» apiConsumerType	string	none	none
» assignedBranchKey	string	none	none
» creationDate	string	the date and time when this user was created	none
» customFields	[CustomFieldValueApiV1]	none	none
»» amount	number	none	none
»» customField	CustomFieldApiV1	none	none
»»» amounts	object	used when options available for a custom field definition translate to predefined amounts, for example, when the custom field value is used to generate a score	none
»»»» additionalProperties	number	none	none
»»» builtInCustomFieldId	string	if this field is one of the built in custom fiel definitions, this will have a value. These names are reserved and you can not use them for your own custom field definitions	none
»»» creationDate	string	the date on which this custom field definition was created	none
»»» customFieldProductSettings	[CustomFieldLinkApiV1]	none	none
»»»» customFieldEncodedKey	string	the key to the parent custom field definition	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isDefault	boolean	whether this field is displayed by default when creating a new record	none
»»»» isRequired	boolean	whether this field is required when creating a new record	none
»»»» linkType	string	the type of entity this field represents a link to	none
»»»» productKey	string	when the link type is product, this field should contain the encoded key of the linekd product	none
»»» customFieldSelectionOptions	[CustomFieldSelectionApiV1]	[represents a possible selection for select type custom field definitions]	none
»»»» constraint	CustomFilterConstraintApiV1	none	none
»»»»» customFieldKey	string	none	none
»»»»» dataFieldType	string	none	none
»»»»» dataFieldValue	string	none	none
»»»»» dataItemType	string	none	none
»»»»» dataType	string	none	none
»»»»» encodedKey	string	none	none
»»»»» filterElement	string	none	none
»»»»» groupNumber	number	none	none
»»»»» index	number	none	none
»»»»» linkingOperator	string	none	none
»»»»» secondValue	string	none	none
»»»»» value	string	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this selectable item	none
»»»» score	number	the score assigned to this selection	none
»»»» value	string	display name of this option	none
»»» customFieldSet	CustomFieldSetApiV1	none	none
»»»» builtInType	string	if this set is part of the set of built-in custom field sets, its type will be shown here	none
»»»» createdDate	string	the date and time when this custom field set was created	none
»»»» customFields	[CustomFieldApiV1]	an array of custom field definitions included in this custom field set	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» id	string	the ID of this custom field set	none
»»»» indexInList	number	for field sets that can be added to an entity more than once, this number represents the index in the list and is used when changing values	none
»»»» lastModifiedDate	string	the date on which this custom field set was last modified	none
»»»» name	string	the name of this custom field set	none
»»»» notes	string	any notes regarding this custom field set	none
»»»» type	string	the entity type that this custom field definition is attached to	none
»»»» usage	string	whether this custom field set can only be used once, or added multiple times to the same entity	none
»»» dataType	string	the type of custom field definition	none
»»» description	string	a brief description of this custom field definition	none
»»» editRights	UsageRightsApiV1	none	none
»»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»»» isAccessibleByAllUsers	boolean	none	none
»»»» roles	[string]	none	none
»»» encodedKey	string	the automatically generated encoded ID for this item	none
»»» id	string	the ID for this custom field definition	none
»»» indexInList	number	none	none
»»» isDefault	boolean	whether this field will be included by default on new records	none
»»» isRequired	boolean	whether this field is required when creating a new record	none
»»» lastModifiedDate	string	the date on which this custom field definition was last modified	none
»»» name	string	the name of this custom field definition	none
»»» state	string	whether this field is available for use or has been deactivated	none
»»» type	string	the type of data this custom field definition will contain	none
»»» unique	boolean	whether the data in this custom field definition needs to be a unique value	none
»»» validationPattern	string	a user-provided pattern to which data in this custom field definition must conform where @ represents numbers, # represents letters and $ is either a number or letter. Other special characters used as separators are allowed, for example `@@-##-$$$`	none
»»» valueLength	string	whether this field needs to support a large number of characters	none
»»» values	[string]	a list of possible values when the field is a selection field	none
»»» viewRights	UsageRightsApiV1	none	none
»» customFieldID	string	none	none
»» customFieldKey	string	none	none
»» customFieldSetGroupIndex	number	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» indexInList	number	none	none
»» linkedEntityKeyValue	string	none	none
»» parentKey	string	none	none
»» selectionKey	string	none	none
»» value	string	none	none
» email	string	none	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» failedLoginsCount	number	none	none
» failedLoginsDates	[string]	none	none
» firstName	string	none	none
» homePhone	string	none	none
» id	number	none	none
» isAdministrator	boolean	none	none
» isCreditOfficer	boolean	none	none
» isSupport	boolean	none	none
» isTeller	boolean	none	none
» language	string	none	none
» lastLoggedInDate	string	none	none
» lastModifiedDate	string	the date on which this user was last modified	none
» lastName	string	none	none
» managedBranches	[UserManagedBranchApiV1]	none	none
»» branchKey	string	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» indexInList	number	none	none
» mobilePhone1	string	none	none
» notes	string	none	none
» permissions	PermissionsApiV1	none	none
»» canManageAllBranches	boolean	none	none
»» canManageEntitiesAssignedToOtherOfficers	boolean	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» permissions	[string]	none	none
» provisionedThroughFederation	boolean	none	none
» role	EncodedKeyAndIdRoleApiV1	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
»» id	string	the user generated or provided ID for this item	none
» title	string	none	none
» transactionLimits	object	none	none
»» additionalProperties	MoneyApiV1	none	none
»»» amount	number	none	none
» twoFactorAuthentication	boolean	none	none
» userState	string	none	none
» username	string	none	none

Enumerated Values

Property	Value
apiConsumerType	`PAYMENTS`
apiConsumerType	`AUDIT_TRAIL`
apiConsumerType	`MAMBU_API`
apiConsumerType	`STREAMING_API`
builtInCustomFieldId	`MOBILE_PHONE`
builtInCustomFieldId	`EMAIL_ADDRESS`
builtInCustomFieldId	`GENDER`
builtInCustomFieldId	`MIDDLE_NAME`
builtInCustomFieldId	`HOME_PHONE`
builtInCustomFieldId	`BIRTHDATE`
builtInCustomFieldId	`LAST_NAME`
builtInCustomFieldId	`FIRST_NAME`
linkType	`CLIENT_ROLE`
linkType	`CHANNEL`
linkType	`PRODUCT`
dataFieldType	`NATIVE`
dataFieldType	`CUSTOM`
dataItemType	`WRITTEN_OFF_LOANS`
dataItemType	`LINE_OF_CREDIT`
dataItemType	`INVESTOR_FUND`
dataItemType	`TRANSACTION_DETAILS`
dataItemType	`DOCUMENT_TEMPLATE`
dataItemType	`PRODUCT`
dataItemType	`MCC_EXPIRATION`
dataItemType	`CENTRE`
dataItemType	`REPAYMENT_COLLECTION`
dataItemType	`TASK`
dataItemType	`OUTSTANDING_PORTFOLIO_AMOUNTS`
dataItemType	`REVENUE`
dataItemType	`COMPOSED_TRANSACTIONS`
dataItemType	`UNION_TRANSACTIONS`
dataItemType	`PRINCIPAL_PAYMENT_SETTINGS`
dataItemType	`LOANS`
dataItemType	`DISBURSEMENT_DETAILS`
dataItemType	`SAVINGS_TRANSACTION`
dataItemType	`IDENTIFICATION_DOCUMENT`
dataItemType	`LOAN_PRODUCT`
dataItemType	`DISBURSED_LOANS`
dataItemType	`LOAN_GROUP`
dataItemType	`TRANSACTION_CHANNEL`
dataItemType	`CUSTOM_PREDEFINED_FEE`
dataItemType	`JOURNAL_ENTRY`
dataItemType	`ATTACHMENT`
dataItemType	`PREDEFINED_FEE`
dataItemType	`TRANCHE`
dataItemType	`TRANSACTION`
dataItemType	`INDEX_RATE_SOURCE`
dataItemType	`GROUP_ROLE`
dataItemType	`LOAN_TRANSACTION`
dataItemType	`CLIENT_ROLE`
dataItemType	`GROUP`
dataItemType	`NOTIFICATION_MESSAGE`
dataItemType	`OUTSTANDING_PORTFOLIO_ACCOUNTS`
dataItemType	`REPAYMENT`
dataItemType	`LOAN_ACCOUNT_GUARANTY`
dataItemType	`BRANCH`
dataItemType	`CURRENCY`
dataItemType	`CARD_TRANSACTION_REVERSAL`
dataItemType	`INTEREST_PRODUCT_SETTINGS`
dataItemType	`CREATED_ACCOUNTS`
dataItemType	`USER`
dataItemType	`SAVINGS_PRODUCT`
dataItemType	`CLIENT`
dataItemType	`PRODUCT_ARREARS_SETTINGS`
dataItemType	`SAVINGS`
dataItemType	`EXPENSE`
dataItemType	`INDEX_RATE`
dataItemType	`NOTIFICATION_TEMPLATE`
dataItemType	`CUSTOM_FIELD_SELECTION`
dataItemType	`ACTIVITY`
dataType	`ENUM`
dataType	`MONEY`
dataType	`NUMBER`
dataType	`DATE_UTC`
dataType	`JAVA_BLOB`
dataType	`OBJECT`
dataType	`BOOLEAN`
dataType	`DATE`
dataType	`PERCENT`
dataType	`BIG_DECIMAL`
dataType	`STRING`
dataType	`KEY`
dataType	`LONG`
filterElement	`STARTS_WITH_CASE_SENSITIVE`
filterElement	`THIS_WEEK`
filterElement	`EQUALS`
filterElement	`STARTS_WITH`
filterElement	`IN`
filterElement	`TODAY`
filterElement	`THIS_YEAR`
filterElement	`BETWEEN`
filterElement	`AFTER`
filterElement	`LESS_THAN`
filterElement	`DIFFERENT_THAN`
filterElement	`THIS_MONTH`
filterElement	`NOT_EMPTY`
filterElement	`BEFORE`
filterElement	`EQUALS_CASE_SENSITIVE`
filterElement	`LAST_DAYS`
filterElement	`MORE_THAN`
filterElement	`EMPTY`
filterElement	`ON`
linkingOperator	`OR`
linkingOperator	`AND`
builtInType	`DETAILS`
builtInType	`GENERAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
usage	`SINGLE`
usage	`GROUPED`
dataType	`GROUP_LINK`
dataType	`DATE`
dataType	`NUMBER`
dataType	`CHECKBOX`
dataType	`CLIENT_LINK`
dataType	`STRING`
dataType	`USER_LINK`
dataType	`SELECTION`
state	`DEACTIVATED`
state	`NORMAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
valueLength	`SHORT`
valueLength	`LONG`
language	`PORTUGESE`
language	`RUSSIAN`
language	`ROMANIAN`
language	`ENGLISH`
language	`SPANISH`
language	`GEORGIAN`
language	`BURMESE`
language	`PHRASE`
language	`CHINESE`
language	`FRENCH`
language	`INDONESIAN`
userState	`LOCKED`
userState	`ACTIVE`
userState	`INACTIVE`

Create User

POST /users

Create user

Allows the creation of a user using a predefined role.

Please Note If federated authentication is enabled, user creation is available only if the Role associated with the created user has API-only access rights.

Example Requests

create user call

{
  "user": {
    "username": "myUserName",
    "password": "complicatedPassword",
    "role": {
      "encodedKey": "ff8080815843175f015843192dac0001"
    },
    "permissions": {
      "canManageAllBranches": "false",
      "canManageEntitiesAssignedToOtherOfficers": "false"
    },
    "email": "valid@email.com",
    "title": "Mr.",
    "firstName": "MandatoryFirstName",
    "lastName": "John",
    "homePhone": "1234567890",
    "mobilePhone1": "1234567890",
    "language": "ENGLISH",
    "userState": "ACTIVE",
    "twoFactorAuthentication": false,
    "notes": "notes"
  },
  "customInformation": [
    {
      "value": "yes",
      "customFieldID": "isTechnical"
    }
  ]
}

Parameters

Name	Type	Description	In
body	UserCreateApiV1	none	body

Example Responses

200 Response

{
  "accessRights": [
    "MAMBU"
  ],
  "apiConsumerType": "PAYMENTS",
  "assignedBranchKey": "string",
  "creationDate": "string",
  "customFields": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "email": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "failedLoginsCount": 0,
  "failedLoginsDates": [
    "string"
  ],
  "firstName": "string",
  "homePhone": "string",
  "id": 0,
  "isAdministrator": true,
  "isCreditOfficer": true,
  "isSupport": true,
  "isTeller": true,
  "language": "PORTUGESE",
  "lastLoggedInDate": "string",
  "lastModifiedDate": "string",
  "lastName": "string",
  "managedBranches": [
    {
      "branchKey": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0
    }
  ],
  "mobilePhone1": "string",
  "notes": "string",
  "permissions": {
    "canManageAllBranches": true,
    "canManageEntitiesAssignedToOtherOfficers": true,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "permissions": [
      "CREATE_INVESTOR_FUNDS"
    ]
  },
  "provisionedThroughFederation": true,
  "role": {
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "id": "string"
  },
  "title": "string",
  "transactionLimits": {
    "property1": {
      "amount": 0
    },
    "property2": {
      "amount": 0
    }
  },
  "twoFactorAuthentication": true,
  "userState": "LOCKED",
  "username": "string"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	UserApiV1

Get User by ID

GET /users/{userId}

Get User by ID

Get a user by their ID

Parameters

Name	Type	Description	In
fullDetails	boolean	none	query
userId (required)	string	none	path

Example Responses

200 Response

{
  "accessRights": [
    "MAMBU"
  ],
  "apiConsumerType": "PAYMENTS",
  "assignedBranchKey": "string",
  "creationDate": "string",
  "customFields": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "email": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "failedLoginsCount": 0,
  "failedLoginsDates": [
    "string"
  ],
  "firstName": "string",
  "homePhone": "string",
  "id": 0,
  "isAdministrator": true,
  "isCreditOfficer": true,
  "isSupport": true,
  "isTeller": true,
  "language": "PORTUGESE",
  "lastLoggedInDate": "string",
  "lastModifiedDate": "string",
  "lastName": "string",
  "managedBranches": [
    {
      "branchKey": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0
    }
  ],
  "mobilePhone1": "string",
  "notes": "string",
  "permissions": {
    "canManageAllBranches": true,
    "canManageEntitiesAssignedToOtherOfficers": true,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "permissions": [
      "CREATE_INVESTOR_FUNDS"
    ]
  },
  "provisionedThroughFederation": true,
  "role": {
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "id": "string"
  },
  "title": "string",
  "transactionLimits": {
    "property1": {
      "amount": 0
    },
    "property2": {
      "amount": 0
    }
  },
  "twoFactorAuthentication": true,
  "userState": "LOCKED",
  "username": "string"
}

404 : Not Found
Bad User ID

{
  "returnCode": 701,
  "returnStatus": "INVALID_USER_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	UserApiV1
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 404

Name	Type	Description	Restrictions
» returnCode (required)	string	none	none
» returnStatus (required)	string	none	none
» errorSource	string	none	none

Get all user comments

GET /users/{userId}/comments

Get all user comments

Get all comments for a user

Parameters

Name	Type	Description	In
limit	string	none	query
offset	string	none	query
userId (required)	string	the ID of the user	path

Example Responses

200 : OK
an array of comments

[
  {
    "encodedKey": "8a19b7057471f4af017472dc0fd80470",
    "parentKey": "8a193c26722b51b701722d77c5e423b7",
    "userKey": "8a194075720ece2c017226fced6f005e",
    "creationDate": "2020-09-09T14:24:42+0000",
    "lastModifiedDate": "2020-09-09T14:24:42+0000",
    "text": "aanother afmaefomaef<div><br /></div><div><u>aefaefaf</u></div><div><u><br /></u></div><div><u>afaef</u></div>"
  },
  {
    "encodedKey": "8a193c26722b51b701722d77c8bf25ab",
    "parentKey": "8a193c26722b51b701722d77c5e423b7",
    "creationDate": "2020-05-19T15:05:24+0000",
    "lastModifiedDate": "2020-05-19T15:05:24+0000",
    "text": "Should suggest she apply for the agriculture loan given the nature of their business"
  }
]

400 : Bad Request
bad user ID

{
  "returnCode": 149,
  "returnStatus": "INVALID_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[CommentApiV1]	none	none
» creationDate	string(date-time)	the date and time at which this comment was added	none
» encodedKey	string	a unique key for this comment	none
» lastModifiedDate	string(date-time)	the date and time at which this comment was last modified	none
» parentKey	string	the unique key of the parent object for this comment, for example, the client or loan account to which it relates	none
» text	string	the text of the comment as a string, must be properly JSON escpaped if it contains special characters	none
» userKey	string	the unique key of the user who created the comment	none

Create a user Comment

POST /users/{userId}/comments

Create a user Comment

Create new comment for a user

Example Requests

a comment

{
  "comment": {
    "text": "this is a comment with \" \" all kinds of : \\ / \"non compliant\" stuff & = which has been JSON escaped"
  }
}

Parameters

Name	Type	Description	In
comment	object	an object contining the comment	body
» text	string	text of the comment to be added. if adding complex content make sure it is properly JSON encoded before making your request	body
userId (required)	string	the ID of the user	path

Example Responses

200 : OK
a comment

{
  "encodedKey": "8a19c34574720f9e0174734a039f06e2",
  "parentKey": "8a193c26722b51b701722d77c5e423b7",
  "userKey": "8a194075720ece2c017226fced6f005e",
  "creationDate": "2020-09-09T14:39:36+0000",
  "lastModifiedDate": "2020-09-09T14:39:36+0000",
  "text": "this is a comment with \" \" all kinds of : \\ / non compliant stuff & = which has been JSON escaped"
}

400 : Bad Request
extra parameters in the request

{
  "returnCode": 27,
  "returnStatus": "PARAMETER_NOT_ALLOWED"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	CommentApiV1
`400`	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Description	Restrictions
» returnCode	string	none	none
» returnStatus	string	none	none

Get Documents for User

GET /users/{userId}/documents

Get documents for user

Get all documents for a given user

Parameters

Name	Type	Description	In
offset	integer	offset results. use with `limit` parameter to achieve paging	query
limit	integer	max number of records to return	query
userId (required)	string	The ID of the user	path

Example Responses

200 : ok
an array of documents

[
  {
    "encodedKey": "8a19c035747bf5b901747c5bfb04014b",
    "id": 51,
    "creationDate": "2020-09-11T08:52:48+0000",
    "lastModifiedDate": "2020-09-11T08:52:48+0000",
    "documentHolderKey": "8a193c26722b51b701722d779e7122df",
    "documentHolderType": "USER",
    "name": "covid rules",
    "type": "png",
    "fileSize": 8258,
    "originalFilename": "Screenshot_2020-04-22_at_14.31.29.png",
    "location": "BRSIDSLFBOGAYZKUUKCOGGQEDOSEOD",
    "description": "some guidelines regarding covid",
    "createdByUserKey": "8a194075720ece2c017226fced6f005e",
    "userName": "big chief"
  },
  {
    "encodedKey": "8a19a3337476f2d00174775b6a3001ae",
    "id": 43,
    "creationDate": "2020-09-10T09:31:54+0000",
    "lastModifiedDate": "2020-09-10T09:31:54+0000",
    "documentHolderKey": "8a193c26722b51b701722d779e7122df",
    "documentHolderType": "USER",
    "name": "user doc",
    "type": "png",
    "fileSize": 32109,
    "originalFilename": "clients_duplicate_id.png",
    "location": "JRTBQGGVXFQRQRBDGBRWQCTXJNRWXP",
    "description": "user doc desc",
    "createdByUserKey": "8a194075720ece2c017226fced6f005e",
    "userName": "big chief"
  }
]

400 : Bad Request
bad user ID

{
  "returnCode": 4,
  "returnStatus": "INVALID_PARAMETERS",
  "errorSource": "wrong owner id"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[DocumentApiV1]	none	none
» createdByUserKey	string	the encoded key of the user who added this document	none
» creationDate	string	the date and time when this document was created	none
» description	string	a description of this document	none
» documentHolderKey	string	the encoded key of the entity to which this document is attached	none
» documentHolderType	string	the type of entity, eg. client, loan product, to which this document is attached	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» fileSize	number	the size, in bytes, of the attached document	none
» id	number	an ID for this document	none
» lastModifiedDate	string	the date on which this document was last modified	none
» location	string	indicates where the document is saved	none
» name	string	the display name of this document	none
» originalFilename	string	the name of the originally uploaded file	none
» type	string	the file type of the document, eg. png, jpeg, pdf	none
» userName	string	the name of the user who uploaded the document	none

Enumerated Values

Property	Value
documentHolderType	`BRANCH`
documentHolderType	`LOAN_ACCOUNT`
documentHolderType	`GROUP`
documentHolderType	`DEPOSIT_ACCOUNT`
documentHolderType	`LINE_OF_CREDIT`
documentHolderType	`LOAN_PRODUCT`
documentHolderType	`GL_JOURNAL_ENTRY`
documentHolderType	`SAVINGS_PRODUCT`
documentHolderType	`USER`
documentHolderType	`CLIENT`
documentHolderType	`CENTRE`
documentHolderType	`ID_DOCUMENT`

Attach new Document to a User

POST /users/{userId}/documents

Attach new Document to a User

Attach a new document to a user

Example Requests

a document to uplaod

{
  "document": {
    "documentHolderKey": "8a193c26722b51b701722d779e7122df",
    "documentHolderType": "USER",
    "name": "some image",
    "type": "png",
    "description": "this is an image file"
  },
  "documentContent": "iVBORw0KGgoAAAANSUhEUgAAAnYAAAF0CAYAAACudHRvAAABQGlDQ1BJQ0MgUHJvZmlsZQAAKJFjYGASS=="
}

Parameters

Name	Type	Description	In
body	CreateDocumentApiV1	a new document to be attached to an entity	body
userId (required)	string	The ID of the user	path

Example Responses

201 : Created
uploaded document details

{
  "encodedKey": "8a19c035747bf5b901747c5bfb04014d",
  "id": 52,
  "creationDate": "2020-09-11T08:54:53+0000",
  "lastModifiedDate": "2020-09-11T08:54:53+0000",
  "documentHolderKey": "8a193c26722b51b701722d779e7122df",
  "documentHolderType": "USER",
  "name": "some image",
  "type": "png",
  "fileSize": 32109,
  "originalFilename": "some_image.png",
  "location": "RCPOUIUHJFBYDRURQNNHMOGBEFIOQF",
  "description": "this is an image file",
  "createdByUserKey": "8a194075720ece2c017226fced6f005e"
}

400 : Bad Request
filetype provided does not match actual file type

{
  "returnCode": 973,
  "returnStatus": "INCONSISTENT_EXTENSION_WITH_FILE_CONTENT",
  "errorSource": "Invalid extension with file content"
}

Responses

Status	Meaning	Description	Schema
`201`	Created	Created	DocumentApiV1
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Get a User Document by ID

GET /users/{userId}/documents/{documentId}

Get a user Document

Get a specific document attached to a user

Parameters

Name	Type	Description	In
userId (required)	string	the ID of the user	path
documentId (required)	string	the ID of the document	path

Example Responses

200 : OK
base64 encoded document

"iVBORw0KGgoAAAANSUhEUgAAAEAAAAA9CAYAAAAd1W/BAAAMY2lDQ1BJQ0MgUHJvZmlsZQAASImVVwdck0cbv3dkkrACEZAR9hJFZgAZIawIAjIFUQlJIGHEmBBE3NRSBesWUZxoVUTRagWkDkSssyhu6yiKqFRqsYoLle8yoNZ+4/c9v9+993+fe+7/jNzlvQNAr5Mvk+Wj+gAUSAvlCZGhrElp6SzSI4ABU0ADtsCTL1DIOPHxMQDKUP93eX0DIKr+qpuK65/j/1UMhSKFAAAkA=="

400 : Bad Request
bad Document ID

{
  "returnCode": 970,
  "returnStatus": "INVALID_DOCUMENT_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	string
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Delete User Document

DELETE /users/{userId}/documents/{documentId}

Delete a user Document

Delete a document attached to a user

Parameters

Name	Type	Description	In
userId (required)	string	the ID of the user	path
documentId (required)	string	the ID of the document	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
bad Document ID

{
  "returnCode": 970,
  "returnStatus": "INVALID_DOCUMENT_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	ExecutionStatusApiV1
`400`	Bad Request	Bad Request	ExecutionStatusApiV1

Update Custom Info (users)

PATCH /users/{userId}/custominformation

Update custom field values

Update custom field values

Example Requests

Update a single custom field value

{
  "customInformation": [
    {
      "customFieldID": "custom_field_2",
      "value": "3"
    }
  ]
}

Update a field in a group

{
  "customInformation": [
    {
      "customFieldID": "cf_grouped_field",
      "value": "new value",
      "customFieldSetGroupIndex": "0"
    }
  ]
}

Update multiple custom field values

{
  "customInformation": [
    {
      "customFieldID": "cf_grouped_field_2",
      "value": "3",
      "customFieldSetGroupIndex": "0"
    },
    {
      "customFieldID": "field_3",
      "value": "divorced"
    }
  ]
}

Parameters

Name	Type	Description	In
customInformation	[object]	none	body
» customFieldID (required)	string	none	body
» value (required)	string	none	body
» customFieldSetGroupIndex	string	Required if field to update is part of a group, if the Field Set Group Index is not set, a new group will be created with the value provided.	body
userId (required)	string	The ID of the user	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Get Custom Info (users)

GET /users/{userId}/custominformation/{customFieldId}

Get a custom field definition for a user

Allows retrieving a custom field definition for a given user directly by the ID/key of the user and the ID/key of the custom field definition.

Parameters

Name	Type	Description	In
userId (required)	string	The ID of the user.	path
customFieldId (required)	string	The ID of the custom field definition.	path

Example Responses

200 : OK
A custom field definition

[
  {
    "encodedKey": "8a19cd6f74674df9017467f25aab02c6",
    "parentKey": "8a193c26722b51b701722d779e7122de",
    "customFieldKey": "8a19cd6f74674df9017467ef8e6802af",
    "customField": {
      "encodedKey": "8a19cd6f74674df9017467ef8e6802af",
      "id": "cf_user",
      "creationDate": "2020-09-07T09:42:33+0000",
      "lastModifiedDate": "2020-09-07T09:42:33+0000",
      "name": "Example Custom Field Definition",
      "type": "BRANCH_INFO",
      "dataType": "CHECKBOX",
      "valueLength": "SHORT",
      "isDefault": false,
      "isRequired": false,
      "description": "an example of a checkbox custom field definition",
      "customFieldSet": {
        "encodedKey": "8a19cd6f74674df9017467ef8e6802ae",
        "id": "_example_user_custom_field_set",
        "name": "example user custom field set",
        "notes": "example custom field set",
        "createdDate": "2020-09-07T09:41:50+0000",
        "lastModifiedDate": "2020-09-07T09:41:50+0000",
        "indexInList": 2,
        "type": "BRANCH_INFO",
        "usage": "SINGLE"
      },
      "indexInList": 0,
      "state": "NORMAL",
      "customFieldSelectionOptions": [],
      "viewRights": {
        "encodedKey": "8a19cd6f74674df9017467ef8e6802b0",
        "isAccessibleByAllUsers": false,
        "roles": []
      },
      "editRights": {
        "encodedKey": "8a19cd6f74674df9017467ef8e6802b1",
        "isAccessibleByAllUsers": false,
        "roles": []
      },
      "unique": false,
      "values": [],
      "amounts": {}
    },
    "value": "TRUE",
    "indexInList": -1,
    "customFieldID": "cf_user",
    "customFieldSetGroupIndex": -1
  }
]

404 : Not Found
not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	CustomFieldApiV1
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Update Custom Field Value (users)

PATCH /users/{userId}/custominformation/{customFieldId}

Update a custom field value for a user

Update a custom field value for a user custom field definition

Example Requests

Update a custom field value

{
  "value": "new custom field value"
}

Parameters

Name	Type	Description	In
value	string	none	body
userId (required)	string	The ID of the user.	path
customFieldId (required)	string	The ID of the custom field definition.	path

Example Responses

200 : OK
example-1

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
field is part of a group

{
  "returnCode": 916,
  "returnStatus": "INVALID_CUSTOM_FIELD_GROUP_INDEX",
  "errorSource": "cf_group_field_2"
}

404 : Not Found
not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Delete Custom Field Value (users)

DELETE /users/{userId}/custominformation/{customFieldId}

Delete a single custom field value

Parameters

Name	Type	Description	In
userId (required)	string	The ID of the user.	path
customFieldId (required)	string	The ID of the custom field definition.	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
field is part of a group

{
  "returnCode": 916,
  "returnStatus": "INVALID_CUSTOM_FIELD_GROUP_INDEX",
  "errorSource": "cf_group_field_2"
}

404 : Not Found
not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	string	none	none
» returnStatus	string	none	none

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Update Grouped Custom Info (users)

PATCH /users/{userId}/custominformation/{customFieldId}/{customFieldGroupSetIndex}

Update grouped custom field value

Update custom field value, which is part of a group

Example Requests

Update the custom field value for a group

{
  "value": "56ab9"
}

Parameters

Name	Type	Description	In
value	string	none	body
userId (required)	string	The ID of the user	path
customFieldId (required)	string	The ID of the custom field definition.	path
customFieldGroupSetIndex (required)	string	none	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

400 : Bad Request
wrong group index provided

{
  "returnCode": 916,
  "returnStatus": "INVALID_CUSTOM_FIELD_GROUP_INDEX",
  "errorSource": "cf_group_field_2"
}

404 : Not Found
field not found

{
  "returnCode": 903,
  "returnStatus": "INVALID_CUSTOM_FIELD_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline
`404`	Not Found	Not Found	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Status Code 400

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none
» errorSource	string	none	none

Status Code 404

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

Delete Grouped Custom Info (users)

DELETE /users/{userId}/custominformation/{customFieldId}/{customFieldGroupSetIndex}

Delete grouped custom field value

Delete a custom field value, which is part of a group

Parameters

Name	Type	Description	In
userId (required)	string	The ID of the user	path
customFieldId (required)	string	The ID of the custom field definition.	path
customFieldGroupSetIndex (required)	string	none	path

Example Responses

200 : OK
Success Response

{
  "returnCode": 0,
  "returnStatus": "SUCCESS"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
» returnCode	integer	none	none
» returnStatus	string	none	none

GL Journal Entries

Create new GL Journal Entry

POST /gljournalentries

Create new GL Journal Entries

Manually post GL journal entries to any number of debit and credit accounts. Any number of journal entries may be posted with a given date and branch as long as the standard accounting rules apply.

Any number of paramaters may be specified in the syntax of debitAccountX & debitAmountX and creditAccountX & creditAmountX where X is the posting account index. At least one debit and credit account must be specified.

Example requests

POST /api/gljournalentries?branchId=2&date=2010-02-03&debitAccount1=100001&debitAmount1=30&creditAccount1=100002&creditAmount1=30

Parameters

Name	Type	Description	In
date (required)	string(date)	The date of the posting of the journal entry.	query
branchID	string	The branch ID to post the journal entries to.	query
notes	string	Any optional GL Journal entries notes.	query
debitAmount{x} (required)	string	The amount of the posting debit entry.	query
creditAmount{x} (required)	string	The amount of the posting credit entry.	query
bookingDate	string(date)	The date on which the Journal Entry should be recorded.	query
debitAccount{x} (required)	string	The code of the GL Account to post debit entry to.	query
transactionID	string	The unique transaction identifier. Will be auto generated if not provided.	query
creditAccount{x} (required)	string	The code of the GL Account to post debit entry to.	query

Example Responses

201 : ok
Newly created GL Journal Entries

[
  {
    "encodedKey": "8a19b592746765a5017468fb932f0732",
    "entryID": 101,
    "creationDate": "2020-09-07T15:06:18+0000",
    "entryDate": "2020-09-05T00:00:00+0000",
    "transactionID": "773DJI15WD318",
    "amount": 30,
    "glAccount": {
      "encodedKey": "8a193c26722b51b701722d77cdaa26c6",
      "creationDate": "2020-05-19T15:05:26+0000",
      "lastModifiedDate": "2020-05-19T15:05:26+0000",
      "glCode": "52100",
      "type": "INCOME",
      "usage": "DETAIL",
      "name": "Penalties & Fines",
      "activated": true,
      "allowManualJournalEntries": true,
      "stripTrailingZeros": true,
      "currency": {
        "code": "EUR",
        "name": "Euro",
        "symbol": "€",
        "digitsAfterDecimal": 2,
        "currencySymbolPosition": "BEFORE_NUMBER",
        "isBaseCurrency": true,
        "creationDate": "2020-05-18T08:53:31+0000",
        "lastModifiedDate": "2020-05-18T08:53:31+0000"
      }
    },
    "type": "DEBIT",
    "userKey": "8a194075720ece2c017226fced6f005e",
    "bookingDate": "2020-09-05T00:00:00+0000"
  },
  {
    "encodedKey": "8a19b592746765a5017468fb932f0733",
    "entryID": 102,
    "creationDate": "2020-09-07T15:06:18+0000",
    "entryDate": "2020-09-05T00:00:00+0000",
    "transactionID": "773DJI15WD318",
    "amount": 5,
    "glAccount": {
      "encodedKey": "8a193c26722b51b701722d77cd9e26c2",
      "creationDate": "2020-05-19T15:05:26+0000",
      "lastModifiedDate": "2020-05-19T15:05:26+0000",
      "glCode": "51100",
      "type": "INCOME",
      "usage": "DETAIL",
      "name": "Interest from Loans",
      "activated": true,
      "allowManualJournalEntries": true,
      "stripTrailingZeros": true,
      "currency": {
        "code": "EUR",
        "name": "Euro",
        "symbol": "€",
        "digitsAfterDecimal": 2,
        "currencySymbolPosition": "BEFORE_NUMBER",
        "isBaseCurrency": true,
        "creationDate": "2020-05-18T08:53:31+0000",
        "lastModifiedDate": "2020-05-18T08:53:31+0000"
      }
    },
    "type": "CREDIT",
    "userKey": "8a194075720ece2c017226fced6f005e",
    "bookingDate": "2020-09-05T00:00:00+0000"
  },
  {
    "encodedKey": "8a19b592746765a5017468fb932f0734",
    "entryID": 103,
    "creationDate": "2020-09-07T15:06:18+0000",
    "entryDate": "2020-09-05T00:00:00+0000",
    "transactionID": "773DJI15WD318",
    "amount": 25,
    "glAccount": {
      "encodedKey": "8a193c26722b51b701722d77cdc826d4",
      "creationDate": "2020-05-19T15:05:26+0000",
      "lastModifiedDate": "2020-05-19T15:05:26+0000",
      "glCode": "22000",
      "type": "LIABILITY",
      "usage": "DETAIL",
      "name": "Client Savings",
      "activated": true,
      "allowManualJournalEntries": true,
      "stripTrailingZeros": true,
      "currency": {
        "code": "EUR",
        "name": "Euro",
        "symbol": "€",
        "digitsAfterDecimal": 2,
        "currencySymbolPosition": "BEFORE_NUMBER",
        "isBaseCurrency": true,
        "creationDate": "2020-05-18T08:53:31+0000",
        "lastModifiedDate": "2020-05-18T08:53:31+0000"
      }
    },
    "type": "CREDIT",
    "userKey": "8a194075720ece2c017226fced6f005e",
    "bookingDate": "2020-09-05T00:00:00+0000"
  }
]

400 : Bad Request
invalid GL Account ID

{
  "returnCode": "600",
  "returnStatus": "INVALID_GL_ACCOUNT_ID"
}

Responses

Status	Meaning	Description	Schema
`201`	Created	ok	Inline
`400`	Bad Request	Bad Request	Inline

Response Schema

Status Code 201

Name	Type	Description	Restrictions
*anonymous*	[GLJournalEntryApiV1]	none	none
» accountKey	string	the encoded key of the loan or savings account that this journal entry relates to	none
» amount	number	the amount of the journal entry	none
» assignedBranchKey	string	the encoded key of the branch that this journal entry is associated with	none
» bookingDate	string	the booking date of this journal entry	none
» creationDate	string	the date and time when the transaction that caused this journal entry was created	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» entryDate	string	the date on which this journal entry was entered into the ledger	none
» entryID	number	a unique, incremental ID for ledger entries	none
» glAccount	GLAccountApiV1	A general ledger account	none
»» activated	boolean	whether this general ledger account is in use	none
»» allowManualJournalEntries	boolean	whether manual entries are allowed for this general ledger account	none
»» balance	number	the current balance of this general ledger account	none
»» creationDate	string(date-time)	the date on which this general ledger account was created	read-only
»» currency	CurrencyApiV1	none	none
»»» code	string	the three letter ISO code for this currency	none
»»» creationDate	string	the date on which this currency was created	none
»»» currencySymbolPosition	string	indicates where the currency symbol should appear in relation to the numeric value	none
»»» digitsAfterDecimal	number	indicates how many decimal places are allowed for this currency. For example, a currenncy with 100 minor units to 1 major unit, there will be 2 decimal places.	none
»»» isBaseCurrency	boolean	whether this currency is the base currency for your banking institution	none
»»» lastModifiedDate	string	the date on which this currency was last modified	none
»»» name	string	the name of this currency	none
»»» symbol	string	the currency symnbol used for this currency	none
»» description	string	an optional description for this general ledger account	none
»» encodedKey	string	the encoded key of this general ledger account	none
»» glCode	string	the numeric code for this general ledger account	none
»» lastModifiedDate	string(date-time)	the date on which this general ledger account was last modified	read-only
»» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
»»» creationDate	string(date-time)	the date on which the data import was made	none
»»» encodedKey	string	the encoded key of this data migration event	none
»»» numCentresImported	number	the number of centres which were imported during the data migration	none
»»» numClientsImported	number	the number of clients which were imported as part of the data migration	none
»»» numGLAccountsImported	number	the number of general ledger accounts which were imported as part of the data migration	none
»»» numGroupsImported	number	the number of groups which were imported as part of the data migration	none
»»» numLoanRepaymentsImported	number	the number of loan repayment transations which were imported as part of the data migration	none
»»» numLoanTransactionsImported	number	the number of loan transactions which were imported as part of the data migration	none
»»» numLoansImported	number	the number of loan accounts which were imported as part of the data migration	none
»»» numSavingsImported	number	the number of savings accounts which were imported as part of the data migration	none
»»» state	string	whether the data import was accepted, is still in a draft state, or was rejected and all data reverted	none
»»» type	string	the type of migration event	none
»» name	string	the name of this general ledger account	none
»» stripTrailingZeros	boolean	controls how this account is organized into header accounts when there are trailing zeroes, for example, for the account code `1100`, if this field is set to true, only the first two numbers will be recognised	none
»» type	string	the type of general ledger account	none
»» usage	string	whether this general ledger account is a `DETAIL` account, in which case it will have a value, or a `HEADER` account, in which case its value will be calculated based on the sum of detail accounts under it.	none
» notes	string	any notes relating to this journal entry	none
» productKey	string	the product associated with this journal entry	none
» productType	string	the type of product associated with this journal entry	none
» reversalEntryKey	string	if this entry was subsequently revered by another journal entry, this field contains the encoded key of that journal entry	none
» transactionID	string	the transaction ID that caused this journal entry. Please note, multiple journal entries can have the same transaction ID, for example, when a repayment goes to cover fees, princial, taxes etc.	none
» type	string	whether this journal entry represents funds coming in or going out	none
» userKey	string	the encoded key of the user who created this journal entry, if it was created manually	none

Enumerated Values

Property	Value
currencySymbolPosition	`AFTER_NUMBER`
currencySymbolPosition	`BEFORE_NUMBER`
state	`REVERTED`
state	`DRAFT`
state	`APPROVED`
type	`IMPORT`
type	`EXPORT`
type	`INCOME`
type	`EXPENSE`
type	`LIABILITY`
type	`ASSET`
type	`EQUITY`
usage	`HEADER`
usage	`DETAIL`
productType	`LOAN`
productType	`SAVINGS`
type	`CREDIT`
type	`DEBIT`

Status Code 400

Name	Type	Description	Restrictions
» returnCode	string	none	none
» returnStatus	string	none	none

Get all GL Journal Entries

GET /gljournalentries

List GL Journal Entries

Retrieve a list of GL journal entries filtered by branch and within a given date range.

Parameters

Name	Type	Description	In
from (required)	string(date)	Start date - The first booking date you want to retrieve journal entries from.	query
to (required)	string(date)	End date - The last booking date you want to retrieve journal entries from.	query
branchID	string	The branch ID to filter accounts on.	query

Example Responses

200 : OK
A list of GL Journal Entries

[
  {
    "encodedKey": "8a42711a4428c1f101442ab778ff0add",
    "entryID": 3021,
    "creationDate": "2014-02-13T10:07:51+0000",
    "entryDate": "2014-02-13T00:00:00+0000",
    "transactionID": "281BUM86WV376",
    "accountKey": "8a17d0d84dbd8a73014dbdd9b7cf0420",
    "productKey": "8a6c37aa4c20087a014c224058580465",
    "productType": "LOAN",
    "amount": "3",
    "glAccount": {
      "encodedKey": "8a33ae49441c4fe101441c7157630374",
      "creationDate": "2014-02-10T15:36:33+0000",
      "lastModifiedDate": "2014-02-10T15:36:33+0000",
      "glCode": "11700",
      "type": "ASSET",
      "usage": "DETAIL",
      "name": "Interest Receivable",
      "activated": true,
      "allowManualJournalEntries": true
    },
    "type": "DEBIT",
    "userKey": "8a42711a4428c1f101442a50ba9807e4"
  },
  {
    "encodedKey": "8a42711a4428c1f101442ab778fe0adc",
    "entryID": 3020,
    "creationDate": "2014-02-13T10:07:51+0000",
    "entryDate": "2014-02-13T00:00:00+0000",
    "transactionID": "281BUM86WV376",
    "amount": "3",
    "glAccount": {
      "encodedKey": "8a33ae49441c4fe101441c715743036a",
      "creationDate": "2014-02-10T15:36:33+0000",
      "lastModifiedDate": "2014-02-10T15:36:33+0000",
      "glCode": "11100",
      "type": "ASSET",
      "usage": "DETAIL",
      "name": "Cash on Hand",
      "activated": true,
      "allowManualJournalEntries": true
    },
    "type": "CREDIT",
    "userKey": "8a42711a4428c1f101442a50ba9807e4"
  },
  {
    "encodedKey": "8a42711a4428c1f101442ab6cb0e0ad9",
    "entryID": 3019,
    "creationDate": "2014-02-13T10:07:06+0000",
    "entryDate": "2014-02-13T00:00:00+0000",
    "transactionID": "912RCS00HU811",
    "amount": "3",
    "glAccount": {
      "encodedKey": "8a33ae49441c4fe101441c7157630374",
      "creationDate": "2014-02-10T15:36:33+0000",
      "lastModifiedDate": "2014-02-10T15:36:33+0000",
      "glCode": "11700",
      "type": "ASSET",
      "usage": "DETAIL",
      "name": "Interest Receivable",
      "activated": true,
      "allowManualJournalEntries": true
    },
    "type": "CREDIT",
    "userKey": "8a42711a4428c1f101442a50ba9807e4",
    "reversalEntryKey": "8a42711a4428c1f101442ab778ff0add"
  },
  {
    "encodedKey": "8a42711a4428c1f101442ab6cb0c0ad8",
    "entryID": 3018,
    "creationDate": "2014-02-13T10:07:06+0000",
    "entryDate": "2014-02-13T00:00:00+0000",
    "transactionID": "912RCS00HU811",
    "amount": "3",
    "glAccount": {
      "encodedKey": "8a33ae49441c4fe101441c715743036a",
      "creationDate": "2014-02-10T15:36:33+0000",
      "lastModifiedDate": "2014-02-10T15:36:33+0000",
      "glCode": "11100",
      "type": "ASSET",
      "usage": "DETAIL",
      "name": "Cash on Hand",
      "activated": true,
      "allowManualJournalEntries": true
    },
    "type": "DEBIT",
    "userKey": "8a42711a4428c1f101442a50ba9807e4",
    "reversalEntryKey": "8a42711a4428c1f101442ab778fe0adc"
  }
]

400 : Bad Request
bad branch ID

{
  "returnCode": "800",
  "returnStatus": "INVALID_BRANCH_ID"
}

Responses

Status	Meaning	Description	Schema
`200`	OK	OK	Inline
`400`	Bad Request	Bad Request	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[GLJournalEntryApiV1]	none	none
» accountKey	string	the encoded key of the loan or savings account that this journal entry relates to	none
» amount	number	the amount of the journal entry	none
» assignedBranchKey	string	the encoded key of the branch that this journal entry is associated with	none
» bookingDate	string	the booking date of this journal entry	none
» creationDate	string	the date and time when the transaction that caused this journal entry was created	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» entryDate	string	the date on which this journal entry was entered into the ledger	none
» entryID	number	a unique, incremental ID for ledger entries	none
» glAccount	GLAccountApiV1	A general ledger account	none
»» activated	boolean	whether this general ledger account is in use	none
»» allowManualJournalEntries	boolean	whether manual entries are allowed for this general ledger account	none
»» balance	number	the current balance of this general ledger account	none
»» creationDate	string(date-time)	the date on which this general ledger account was created	read-only
»» currency	CurrencyApiV1	none	none
»»» code	string	the three letter ISO code for this currency	none
»»» creationDate	string	the date on which this currency was created	none
»»» currencySymbolPosition	string	indicates where the currency symbol should appear in relation to the numeric value	none
»»» digitsAfterDecimal	number	indicates how many decimal places are allowed for this currency. For example, a currenncy with 100 minor units to 1 major unit, there will be 2 decimal places.	none
»»» isBaseCurrency	boolean	whether this currency is the base currency for your banking institution	none
»»» lastModifiedDate	string	the date on which this currency was last modified	none
»»» name	string	the name of this currency	none
»»» symbol	string	the currency symnbol used for this currency	none
»» description	string	an optional description for this general ledger account	none
»» encodedKey	string	the encoded key of this general ledger account	none
»» glCode	string	the numeric code for this general ledger account	none
»» lastModifiedDate	string(date-time)	the date on which this general ledger account was last modified	read-only
»» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
»»» creationDate	string(date-time)	the date on which the data import was made	none
»»» encodedKey	string	the encoded key of this data migration event	none
»»» numCentresImported	number	the number of centres which were imported during the data migration	none
»»» numClientsImported	number	the number of clients which were imported as part of the data migration	none
»»» numGLAccountsImported	number	the number of general ledger accounts which were imported as part of the data migration	none
»»» numGroupsImported	number	the number of groups which were imported as part of the data migration	none
»»» numLoanRepaymentsImported	number	the number of loan repayment transations which were imported as part of the data migration	none
»»» numLoanTransactionsImported	number	the number of loan transactions which were imported as part of the data migration	none
»»» numLoansImported	number	the number of loan accounts which were imported as part of the data migration	none
»»» numSavingsImported	number	the number of savings accounts which were imported as part of the data migration	none
»»» state	string	whether the data import was accepted, is still in a draft state, or was rejected and all data reverted	none
»»» type	string	the type of migration event	none
»» name	string	the name of this general ledger account	none
»» stripTrailingZeros	boolean	controls how this account is organized into header accounts when there are trailing zeroes, for example, for the account code `1100`, if this field is set to true, only the first two numbers will be recognised	none
»» type	string	the type of general ledger account	none
»» usage	string	whether this general ledger account is a `DETAIL` account, in which case it will have a value, or a `HEADER` account, in which case its value will be calculated based on the sum of detail accounts under it.	none
» notes	string	any notes relating to this journal entry	none
» productKey	string	the product associated with this journal entry	none
» productType	string	the type of product associated with this journal entry	none
» reversalEntryKey	string	if this entry was subsequently revered by another journal entry, this field contains the encoded key of that journal entry	none
» transactionID	string	the transaction ID that caused this journal entry. Please note, multiple journal entries can have the same transaction ID, for example, when a repayment goes to cover fees, princial, taxes etc.	none
» type	string	whether this journal entry represents funds coming in or going out	none
» userKey	string	the encoded key of the user who created this journal entry, if it was created manually	none

Enumerated Values

Property	Value
currencySymbolPosition	`AFTER_NUMBER`
currencySymbolPosition	`BEFORE_NUMBER`
state	`REVERTED`
state	`DRAFT`
state	`APPROVED`
type	`IMPORT`
type	`EXPORT`
type	`INCOME`
type	`EXPENSE`
type	`LIABILITY`
type	`ASSET`
type	`EQUITY`
usage	`HEADER`
usage	`DETAIL`
productType	`LOAN`
productType	`SAVINGS`
type	`CREDIT`
type	`DEBIT`

Status Code 400

Name	Type	Description	Restrictions
» returnCode	string	none	none
» returnStatus	string	none	none

Search for GL Journal Entries

POST /gljournalentries/search

Search for GL Journal Entries

Retrieve GL journal entries using dynamic custom filters.

Available filter values

Filter Selection Parameter	Data Type
PRODUCT_TYPE	ENUM
GL_ACCOUNT_KEY	KEY
USER_KEY	KEY
ENCODED_KEY	STRING
ENTRY_ID	NUMBER
DATE	DATE
CREATION_DATE	DATE
TRANSACTION_ID	STRING
GL_ACCOUNT_ID	STRING
GL_ACCOUNT_TYPE	ENUM
SOURCE	ENUM
DEBIT	MONEY
CREDIT	MONEY

Filter Element	Number Of affected values	Available for
EQUALS	ONE_VALUE	BIG_DECIMAL,BOOLEAN,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY
MORE_THAN	ONE_VALUE	BIG_DECIMAL,NUMBER,MONEY
LESS_THAN	ONE_VALUE	BIG_DECIMAL,NUMBER,MONEY
BETWEEN	TWO_VALUES	BIG_DECIMAL,NUMBER,MONEY,DATE,DATE_UTC
ON	ONE_VALUE	DATE,DATE_UTC
AFTER	ONE_VALUE	DATE,DATE_UTC
BEFORE	ONE_VALUE	DATE,DATE_UTC
STARTS_WITH	ONE_VALUE	STRING
IN	LIST	ENUM,KEY
TODAY	NO_VALUE	DATE,DATE_UTC
THIS_WEEK	NO_VALUE	DATE,DATE_UTC
THIS_MONTH	NO_VALUE	DATE,DATE_UTC
THIS_YEAR	NO_VALUE	DATE,DATE_UTC
LAST_DAYS	ONE_VALUE	DATE,DATE_UTC
EMPTY	NO_VALUE	BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_UTC
NOT_EMPTY	NO_VALUE	BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_UTC

Example requests

a search

{
  "filterConstraints": [
    {
      "dataFieldType": "string",
      "dataItemType": "string",
      "filterElement": "string",
      "filterSelection": "string",
      "secondValue": "string",
      "value": "string",
      "values": [
        "string"
      ]
    }
  ],
  "sortDetails": {
    "dataFieldType": "string",
    "dataItemType": "string",
    "sortingColumn": "string",
    "sortingOrder": "string"
  }
}

Parameters

Name	Type	Description	In
offset	integer	none	query
limit	integer	none	query
body	FilterApiV1	none	body

Example Responses

200 Response

[
  {
    "accountKey": "string",
    "amount": 0,
    "assignedBranchKey": "string",
    "bookingDate": "string",
    "creationDate": "string",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "entryDate": "string",
    "entryID": 0,
    "glAccount": {
      "activated": true,
      "allowManualJournalEntries": true,
      "balance": 0,
      "creationDate": "2019-08-24T14:15:22Z",
      "currency": {
        "code": "string",
        "creationDate": "string",
        "currencySymbolPosition": "AFTER_NUMBER",
        "digitsAfterDecimal": 0,
        "isBaseCurrency": true,
        "lastModifiedDate": "string",
        "name": "string",
        "symbol": "string"
      },
      "description": "string",
      "encodedKey": "string",
      "glCode": "string",
      "lastModifiedDate": "2019-08-24T14:15:22Z",
      "migrationEvent": {
        "creationDate": "2019-08-24T14:15:22Z",
        "encodedKey": "string",
        "numCentresImported": 0,
        "numClientsImported": 0,
        "numGLAccountsImported": 0,
        "numGroupsImported": 0,
        "numLoanRepaymentsImported": 0,
        "numLoanTransactionsImported": 0,
        "numLoansImported": 0,
        "numSavingsImported": 0,
        "state": "REVERTED",
        "type": "IMPORT"
      },
      "name": "string",
      "stripTrailingZeros": true,
      "type": "INCOME",
      "usage": "HEADER"
    },
    "notes": "string",
    "productKey": "string",
    "productType": "LOAN",
    "reversalEntryKey": "string",
    "transactionID": "string",
    "type": "CREDIT",
    "userKey": "string"
  }
]

Responses

Status	Meaning	Description	Schema
`200`	OK	ok	Inline

Response Schema

Status Code 200

Name	Type	Description	Restrictions
*anonymous*	[GLJournalEntryApiV1]	none	none
» accountKey	string	the encoded key of the loan or savings account that this journal entry relates to	none
» amount	number	the amount of the journal entry	none
» assignedBranchKey	string	the encoded key of the branch that this journal entry is associated with	none
» bookingDate	string	the booking date of this journal entry	none
» creationDate	string	the date and time when the transaction that caused this journal entry was created	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» entryDate	string	the date on which this journal entry was entered into the ledger	none
» entryID	number	a unique, incremental ID for ledger entries	none
» glAccount	GLAccountApiV1	A general ledger account	none
»» activated	boolean	whether this general ledger account is in use	none
»» allowManualJournalEntries	boolean	whether manual entries are allowed for this general ledger account	none
»» balance	number	the current balance of this general ledger account	none
»» creationDate	string(date-time)	the date on which this general ledger account was created	read-only
»» currency	CurrencyApiV1	none	none
»»» code	string	the three letter ISO code for this currency	none
»»» creationDate	string	the date on which this currency was created	none
»»» currencySymbolPosition	string	indicates where the currency symbol should appear in relation to the numeric value	none
»»» digitsAfterDecimal	number	indicates how many decimal places are allowed for this currency. For example, a currenncy with 100 minor units to 1 major unit, there will be 2 decimal places.	none
»»» isBaseCurrency	boolean	whether this currency is the base currency for your banking institution	none
»»» lastModifiedDate	string	the date on which this currency was last modified	none
»»» name	string	the name of this currency	none
»»» symbol	string	the currency symnbol used for this currency	none
»» description	string	an optional description for this general ledger account	none
»» encodedKey	string	the encoded key of this general ledger account	none
»» glCode	string	the numeric code for this general ledger account	none
»» lastModifiedDate	string(date-time)	the date on which this general ledger account was last modified	read-only
»» migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
»»» creationDate	string(date-time)	the date on which the data import was made	none
»»» encodedKey	string	the encoded key of this data migration event	none
»»» numCentresImported	number	the number of centres which were imported during the data migration	none
»»» numClientsImported	number	the number of clients which were imported as part of the data migration	none
»»» numGLAccountsImported	number	the number of general ledger accounts which were imported as part of the data migration	none
»»» numGroupsImported	number	the number of groups which were imported as part of the data migration	none
»»» numLoanRepaymentsImported	number	the number of loan repayment transations which were imported as part of the data migration	none
»»» numLoanTransactionsImported	number	the number of loan transactions which were imported as part of the data migration	none
»»» numLoansImported	number	the number of loan accounts which were imported as part of the data migration	none
»»» numSavingsImported	number	the number of savings accounts which were imported as part of the data migration	none
»»» state	string	whether the data import was accepted, is still in a draft state, or was rejected and all data reverted	none
»»» type	string	the type of migration event	none
»» name	string	the name of this general ledger account	none
»» stripTrailingZeros	boolean	controls how this account is organized into header accounts when there are trailing zeroes, for example, for the account code `1100`, if this field is set to true, only the first two numbers will be recognised	none
»» type	string	the type of general ledger account	none
»» usage	string	whether this general ledger account is a `DETAIL` account, in which case it will have a value, or a `HEADER` account, in which case its value will be calculated based on the sum of detail accounts under it.	none
» notes	string	any notes relating to this journal entry	none
» productKey	string	the product associated with this journal entry	none
» productType	string	the type of product associated with this journal entry	none
» reversalEntryKey	string	if this entry was subsequently revered by another journal entry, this field contains the encoded key of that journal entry	none
» transactionID	string	the transaction ID that caused this journal entry. Please note, multiple journal entries can have the same transaction ID, for example, when a repayment goes to cover fees, princial, taxes etc.	none
» type	string	whether this journal entry represents funds coming in or going out	none
» userKey	string	the encoded key of the user who created this journal entry, if it was created manually	none

Enumerated Values

Property	Value
currencySymbolPosition	`AFTER_NUMBER`
currencySymbolPosition	`BEFORE_NUMBER`
state	`REVERTED`
state	`DRAFT`
state	`APPROVED`
type	`IMPORT`
type	`EXPORT`
type	`INCOME`
type	`EXPENSE`
type	`LIABILITY`
type	`ASSET`
type	`EQUITY`
usage	`HEADER`
usage	`DETAIL`
productType	`LOAN`
productType	`SAVINGS`
type	`CREDIT`
type	`DEBIT`

Schemas

AccountArrearsSettingsApiV1

{
  "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
  "encodedKey": "string",
  "monthlyToleranceDay": 0,
  "nonWorkingDaysMethod": "EXCLUDED",
  "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY",
  "toleranceFloorAmount": 0,
  "tolerancePercentageOfOutstandingPrincipal": 0,
  "tolerancePeriod": 0
}

Properties

Name	Type	Description	Restrictions
dateCalculationMethod	string	the method used to calculate arrears for an account	none
encodedKey	string	the automatically generated encoded ID for this item	none
monthlyToleranceDay	number	none	none
nonWorkingDaysMethod	string	whether non-working days, such as holidays are included when calculating the number of days in arrears	none
toleranceCalculationMethod	string	none	none
toleranceFloorAmount	number	Used with the `tolerancePercentageOfOutstandingPrincipal` to set a minimum threshold that must be reached before an account will be set to 'in arrears'	none
tolerancePercentageOfOutstandingPrincipal	number	This setting will cause an account to automatically go into arrears if the amount due exceeds a given percentage of the loan amount remaining. Only available for fixed and dynamic term loans.	none
tolerancePeriod	number	the number of days a loan repayment can be late before the account will be automatically set to 'in arrears'.	none

Enumerated Values

Property	Value
dateCalculationMethod	`DATE_OF_LAST_LATE_REPAYMENT`
dateCalculationMethod	`DATE_ACCOUNT_FIRST_WENT_TO_ARREARS`
nonWorkingDaysMethod	`EXCLUDED`
nonWorkingDaysMethod	`INCLUDED`
toleranceCalculationMethod	`MONTHLY_ARREARS_TOLERANCE_DAY`
toleranceCalculationMethod	`ARREARS_TOLERANCE_PERIOD`

AccountsFromLineOfCreditApiV1

{
  "loanAccounts": [
    {
      "accountArrearsSettings": {
        "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
        "encodedKey": "string",
        "monthlyToleranceDay": 0,
        "nonWorkingDaysMethod": "EXCLUDED",
        "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY",
        "toleranceFloorAmount": 0,
        "tolerancePercentageOfOutstandingPrincipal": 0,
        "tolerancePeriod": 0
      },
      "accountHolderKey": "string",
      "accountHolderType": "GROUP",
      "accountState": "WITHDRAWN",
      "accountSubState": "WITHDRAWN",
      "accrueInterestAfterMaturity": true,
      "accrueLateInterest": true,
      "accruedInterest": 0,
      "accruedPenalty": 0,
      "activationTransactionKey": "string",
      "allowOffset": true,
      "applyInterestOnPrepaymentMethod": "AUTOMATIC",
      "approvedDate": "string",
      "arrearsTolerancePeriod": 0,
      "assignedBranchKey": "string",
      "assignedCentreKey": "string",
      "assignedUserKey": "string",
      "closedDate": "string",
      "creationDate": "string",
      "customFieldValues": [
        {
          "amount": 0,
          "customField": {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "customFieldID": "string",
          "customFieldKey": "string",
          "customFieldSetGroupIndex": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "linkedEntityKeyValue": "string",
          "parentKey": "string",
          "selectionKey": "string",
          "value": "string"
        }
      ],
      "daysInArrears": 0,
      "defaultFirstRepaymentDueDateOffset": 0,
      "disbursementDetails": {
        "customInformation": [
          {
            "amount": 0,
            "customField": {
              "amounts": {
                "property1": 0,
                "property2": 0
              },
              "builtInCustomFieldId": "MOBILE_PHONE",
              "creationDate": "string",
              "customFieldProductSettings": [
                {
                  "customFieldEncodedKey": "string",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isDefault": true,
                  "isRequired": true,
                  "linkType": "CLIENT_ROLE",
                  "productKey": "string"
                }
              ],
              "customFieldSelectionOptions": [
                {
                  "constraint": {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "score": 0,
                  "value": "string"
                }
              ],
              "customFieldSet": {
                "builtInType": "DETAILS",
                "createdDate": "string",
                "customFields": [
                  {}
                ],
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "notes": "string",
                "type": "USER_INFO",
                "usage": "SINGLE"
              },
              "dataType": "GROUP_LINK",
              "description": "string",
              "editRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "isDefault": true,
              "isRequired": true,
              "lastModifiedDate": "string",
              "name": "string",
              "state": "DEACTIVATED",
              "type": "USER_INFO",
              "unique": true,
              "validationPattern": "string",
              "valueLength": "SHORT",
              "values": [
                "string"
              ],
              "viewRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "customFieldID": "string",
            "customFieldKey": "string",
            "customFieldSetGroupIndex": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "linkedEntityKeyValue": "string",
            "parentKey": "string",
            "selectionKey": "string",
            "value": "string"
          }
        ],
        "disbursementDate": "string",
        "encodedKey": "string",
        "expectedDisbursementDate": "string",
        "fees": [
          {
            "amount": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "fee": {
              "active": true,
              "amortizationIntervalSettings": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
                "intervalCount": 0,
                "intervalType": "FULL_TERM",
                "periodCount": 0,
                "periodUnit": "MONTHS"
              },
              "amortizationProfile": "STRAIGHT_LINE",
              "amount": 0,
              "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
              "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
              "creationDate": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
              "feeApplication": "OPTIONAL",
              "feeProductRules": [
                {
                  "account": {
                    "activated": true,
                    "allowManualJournalEntries": true,
                    "balance": 0,
                    "creationDate": "2019-08-24T14:15:22Z",
                    "currency": {},
                    "description": "string",
                    "encodedKey": "string",
                    "glCode": "string",
                    "lastModifiedDate": "2019-08-24T14:15:22Z",
                    "migrationEvent": {},
                    "name": "string",
                    "stripTrailingZeros": true,
                    "type": "INCOME",
                    "usage": "HEADER"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "financialResource": "FEE_RECEIVABLE",
                  "index": 0,
                  "predefinedFeeKey": "string",
                  "productKey": "string",
                  "productType": "LOAN",
                  "transactionChannelKey": "string"
                }
              ],
              "name": "string",
              "percentageAmount": 0,
              "trigger": "DISBURSEMENT"
            }
          }
        ],
        "firstRepaymentDate": "string",
        "transactionDetails": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "internalTransfer": true,
          "targetSavingsAccountKey": "string",
          "transactionChannel": {
            "activated": true,
            "createdByUserKey": "string",
            "creationDate": "string",
            "customFields": [
              {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              }
            ],
            "encodedKey": "string",
            "id": "string",
            "index": 0,
            "loanConstraints": {
              "customConfigurationInfo": {
                "creationDate": "string",
                "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "shared": true,
                "userKey": "string"
              },
              "encodedKey": "string",
              "filterConstraints": [
                {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                }
              ]
            },
            "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
            "name": "string",
            "savingsConstraints": {
              "customConfigurationInfo": {
                "creationDate": "string",
                "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "shared": true,
                "userKey": "string"
              },
              "encodedKey": "string",
              "filterConstraints": [
                {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                }
              ]
            },
            "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
            "transactionChannelAccountingRule": {
              "account": {
                "activated": true,
                "allowManualJournalEntries": true,
                "balance": 0,
                "creationDate": "2019-08-24T14:15:22Z",
                "currency": {
                  "code": "string",
                  "creationDate": "string",
                  "currencySymbolPosition": "AFTER_NUMBER",
                  "digitsAfterDecimal": 0,
                  "isBaseCurrency": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "symbol": "string"
                },
                "description": "string",
                "encodedKey": "string",
                "glCode": "string",
                "lastModifiedDate": "2019-08-24T14:15:22Z",
                "migrationEvent": {
                  "creationDate": "2019-08-24T14:15:22Z",
                  "encodedKey": "string",
                  "numCentresImported": 0,
                  "numClientsImported": 0,
                  "numGLAccountsImported": 0,
                  "numGroupsImported": 0,
                  "numLoanRepaymentsImported": 0,
                  "numLoanTransactionsImported": 0,
                  "numLoansImported": 0,
                  "numSavingsImported": 0,
                  "state": "REVERTED",
                  "type": "IMPORT"
                },
                "name": "string",
                "stripTrailingZeros": true,
                "type": "INCOME",
                "usage": "HEADER"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "financialResource": "FEE_RECEIVABLE",
              "index": 0,
              "predefinedFeeKey": "string",
              "productKey": "string",
              "productType": "LOAN",
              "transactionChannelKey": "string"
            },
            "usageRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "transactionChannelKey": "string"
        }
      },
      "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "feesBalance": 0,
      "feesDue": 0,
      "feesPaid": 0,
      "fixedDaysOfMonth": [
        0
      ],
      "funds": [
        {
          "amount": 0,
          "assetName": "string",
          "customFieldValues": [
            {
              "amount": 0,
              "customField": {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              },
              "customFieldID": "string",
              "customFieldKey": "string",
              "customFieldSetGroupIndex": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "linkedEntityKeyValue": "string",
              "parentKey": "string",
              "selectionKey": "string",
              "value": "string"
            }
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "guarantorKey": "string",
          "guarantorType": "GROUP",
          "id": "string",
          "interestCommission": 0,
          "investmentPercentage": 0,
          "savingsAccountKey": "string",
          "type": "GUARANTOR"
        }
      ],
      "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
      "gracePeriod": 0,
      "gracePeriodType": "PAY_INTEREST_ONLY",
      "guarantees": [
        {
          "amount": 0,
          "assetName": "string",
          "customFieldValues": [
            {
              "amount": 0,
              "customField": {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              },
              "customFieldID": "string",
              "customFieldKey": "string",
              "customFieldSetGroupIndex": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "linkedEntityKeyValue": "string",
              "parentKey": "string",
              "selectionKey": "string",
              "value": "string"
            }
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "guarantorKey": "string",
          "guarantorType": "GROUP",
          "savingsAccountKey": "string",
          "type": "GUARANTOR"
        }
      ],
      "hasCustomSchedule": true,
      "holdBalance": 0,
      "id": "string",
      "interestApplicationMethod": "ON_REPAYMENT",
      "interestBalance": 0,
      "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
      "interestCalculationMethod": "DECLINING_BALANCE",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestCommission": 0,
      "interestDue": 0,
      "interestFromArrearsAccrued": 0,
      "interestFromArrearsBalance": 0,
      "interestFromArrearsDue": 0,
      "interestFromArrearsPaid": 0,
      "interestPaid": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRoundingVersion": "VERSION_2",
      "interestSpread": 0,
      "interestType": "CAPITALIZED_INTEREST",
      "lastAccountAppraisalDate": "string",
      "lastInterestAppliedDate": "string",
      "lastInterestReviewDate": "string",
      "lastLockedDate": "string",
      "lastModifiedDate": "string",
      "lastSetToArrearsDate": "string",
      "lastTaxRateReviewDate": "string",
      "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
      "lineOfCreditKey": "string",
      "loanAmount": 0,
      "loanGroup": {
        "accounts": [
          {}
        ],
        "creationDate": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "group": {
          "assignedBranchKey": "string",
          "assignedCentreKey": "string",
          "assignedUserKey": "string",
          "clientRole": {
            "encodedKey": "string"
          },
          "creationDate": "2019-08-24T14:15:22Z",
          "emailAddress": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "groupName": "string",
          "homePhone": "string",
          "id": "string",
          "idPattern": "string",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "loanCycle": 0,
          "migrationEvent": {
            "creationDate": "2019-08-24T14:15:22Z",
            "encodedKey": "string",
            "numCentresImported": 0,
            "numClientsImported": 0,
            "numGLAccountsImported": 0,
            "numGroupsImported": 0,
            "numLoanRepaymentsImported": 0,
            "numLoanTransactionsImported": 0,
            "numLoansImported": 0,
            "numSavingsImported": 0,
            "state": "REVERTED",
            "type": "IMPORT"
          },
          "mobilePhone1": "string",
          "preferredLanguage": "PORTUGESE"
        },
        "lastModifiedDate": "string",
        "name": "string",
        "notes": "string"
      },
      "loanName": "string",
      "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
      "lockedOperations": [
        "APPLY_FEES"
      ],
      "migrationEvent": {
        "creationDate": "2019-08-24T14:15:22Z",
        "encodedKey": "string",
        "numCentresImported": 0,
        "numClientsImported": 0,
        "numGLAccountsImported": 0,
        "numGroupsImported": 0,
        "numLoanRepaymentsImported": 0,
        "numLoanTransactionsImported": 0,
        "numLoansImported": 0,
        "numSavingsImported": 0,
        "state": "REVERTED",
        "type": "IMPORT"
      },
      "notes": "string",
      "originalAccountKey": "string",
      "paymentMethod": "VERTICAL",
      "paymentPlan": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingInstallmentPosition": 0,
          "index": 0,
          "loanAccountEncodedKey": "string",
          "pmt": 0
        }
      ],
      "penaltyBalance": 0,
      "penaltyDue": 0,
      "penaltyPaid": 0,
      "penaltyRate": 0,
      "periodicPayment": 0,
      "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
      "prepaymentRecalculationMethod": "NO_RECALCULATION",
      "principalBalance": 0,
      "principalDue": 0,
      "principalPaid": 0,
      "principalPaidInstallmentStatus": "PARTIALLY_PAID",
      "principalPaymentSettings": {
        "amount": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "includeFeesInFloorAmount": true,
        "includeInterestInFloorAmount": true,
        "percentage": 0,
        "principalCeilingValue": 0,
        "principalFloorValue": 0,
        "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
      },
      "principalRepaymentInterval": 0,
      "productTypeKey": "string",
      "redrawBalance": 0,
      "redrawSettings": {
        "account": {},
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "restrictNextDueWithdrawal": true
      },
      "repaymentInstallments": 0,
      "repaymentPeriodCount": 0,
      "repaymentPeriodUnit": "MONTHS",
      "repaymentScheduleMethod": "FIXED",
      "rescheduledAccountKey": "string",
      "scheduleDueDatesMethod": "INTERVAL",
      "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
      "taxRate": 0,
      "tranches": [
        {
          "amount": 0,
          "disbursementTransactionKey": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "expectedDisbursementDate": "string",
          "index": 0
        }
      ]
    }
  ],
  "savingsAccounts": [
    {
      "accountHolderKey": "string",
      "accountHolderType": "GROUP",
      "accountState": "WITHDRAWN",
      "accountType": "CURRENT_ACCOUNT",
      "accruedInterest": 0,
      "activationDate": "string",
      "allowOverdraft": true,
      "approvedDate": "string",
      "assignedBranchKey": "string",
      "assignedCentreKey": "string",
      "assignedUserKey": "string",
      "availableBalance": 0,
      "balance": 0,
      "closedDate": "string",
      "creationDate": "string",
      "currency": {
        "code": "string",
        "creationDate": "string",
        "currencySymbolPosition": "AFTER_NUMBER",
        "digitsAfterDecimal": 0,
        "isBaseCurrency": true,
        "lastModifiedDate": "string",
        "name": "string",
        "symbol": "string"
      },
      "currencyCode": "string",
      "customFieldValues": [
        {
          "amount": 0,
          "customField": {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "customFieldID": "string",
          "customFieldKey": "string",
          "customFieldSetGroupIndex": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "linkedEntityKeyValue": "string",
          "parentKey": "string",
          "selectionKey": "string",
          "value": "string"
        }
      ],
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "feesDue": 0,
      "holdBalance": 0,
      "id": "string",
      "interestDue": 0,
      "interestPaymentDates": [
        {
          "dayOfMonth": 0,
          "monthOfYear": 0,
          "year": 0
        }
      ],
      "interestPaymentPoint": "EVERY_WEEK",
      "interestSettings": {
        "accrueInterestAfterMaturity": true,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "interestChargeFrequency": "EVERY_WEEK",
        "interestChargeFrequencyCount": 0,
        "interestRate": 0,
        "interestRateReviewCount": 0,
        "interestRateReviewUnit": "MONTHS",
        "interestRateSource": "FIXED_INTEREST_RATE",
        "interestRateTerms": "TIERED_PERIOD",
        "interestRateTiers": [
          {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "endingBalance": 0,
            "endingDay": 0,
            "index": 0,
            "interestRate": 0
          }
        ],
        "interestSpread": 0
      },
      "lastAccountAppraisalDate": "string",
      "lastInterestCalculationDate": "string",
      "lastInterestStoredDate": "string",
      "lastModifiedDate": "string",
      "lastOverdraftInterestReviewDate": "string",
      "lastSetToArrearsDate": "string",
      "lineOfCreditKey": "string",
      "lockedBalance": 0,
      "lockedDate": "string",
      "maturityDate": "string",
      "maxWidthdrawlAmount": 0,
      "migrationEvent": {
        "creationDate": "2019-08-24T14:15:22Z",
        "encodedKey": "string",
        "numCentresImported": 0,
        "numClientsImported": 0,
        "numGLAccountsImported": 0,
        "numGroupsImported": 0,
        "numLoanRepaymentsImported": 0,
        "numLoanTransactionsImported": 0,
        "numLoansImported": 0,
        "numSavingsImported": 0,
        "state": "REVERTED",
        "type": "IMPORT"
      },
      "name": "string",
      "notes": "string",
      "overdraftAmount": 0,
      "overdraftExpiryDate": "string",
      "overdraftExpiryDateDTO": {
        "dayOfMonth": 0,
        "monthOfYear": 0,
        "year": 0
      },
      "overdraftInterestAccrued": 0,
      "overdraftInterestSettings": {
        "accrueInterestAfterMaturity": true,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "interestChargeFrequency": "EVERY_WEEK",
        "interestChargeFrequencyCount": 0,
        "interestRate": 0,
        "interestRateReviewCount": 0,
        "interestRateReviewUnit": "MONTHS",
        "interestRateSource": "FIXED_INTEREST_RATE",
        "interestRateTerms": "TIERED_PERIOD",
        "interestRateTiers": [
          {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "endingBalance": 0,
            "endingDay": 0,
            "index": 0,
            "interestRate": 0
          }
        ],
        "interestSpread": 0
      },
      "overdraftLimit": 0,
      "productTypeKey": "string",
      "recommendedDepositAmount": 0,
      "targetAmount": 0,
      "technicalInterestDue": 0,
      "technicalOverdraftAmount": 0,
      "technicalOverdraftInterestAccrued": 0,
      "withholdingTaxSourceKey": "string"
    }
  ]
}

Properties

Name	Type	Description	Restrictions
loanAccounts	[LoanAccountApiV1]	none	none
savingsAccounts	[SavingsAccountApiV1]	none	none

AddressApiV1

{
  "addressType": "string",
  "city": "string",
  "country": "string",
  "encodedKey": "string",
  "indexInList": 0,
  "latitude": 0,
  "line1": "string",
  "line2": "string",
  "longitude": 0,
  "parentKey": "string",
  "postcode": "string",
  "region": "string",
  "toBeDeleted": true
}

Properties

Name	Type	Description	Restrictions
addressType	string	the type of the address, eg. home, office. Deprecated.	none
city	string	the city	none
country	string	the country	none
encodedKey	string	the automatically generated encoded ID for this item	none
indexInList	integer	the index of this address when there are multiple addresses assigned for a single entity	none
latitude	number	the latitude of the address point	none
line1	string	the first line of the address	none
line2	string	the second line of the address	none
longitude	number	the longitude of the address point	none
parentKey	string	the encoded key of the entity to whom this address belongs, for example, the client of group	none
postcode	string	the postal (zip) code of the address	none
region	string	the region of the address	none
toBeDeleted	boolean	whether this address is marked to be deleted	none

AmortizationAmountApiV1

{
  "amount": 0,
  "branchKey": "string",
  "centreKey": "string",
  "creationDate": "string",
  "encodedKey": "string",
  "entryDate": "string",
  "reversalAmountKey": "string",
  "taxAmount": 0,
  "type": "AMORTIZATION_ADJUSTMENT"
}

Properties

Name	Type	Description	Restrictions
amount	number	the amount to be amortized	none
branchKey	string	the encoded key of the branch owning the amount	none
centreKey	string	the encoded key of the centre owning the amount	none
creationDate	string	the date on which the amortization amount was created	none
encodedKey	string	the automatically generated encoded ID for this item	none
entryDate	string	the date when this amount was recognised as amortized (in organization time)	none
reversalAmountKey	string	if the amount was reversed, this field will contain the encoded key of the reversal record	none
taxAmount	number	the amount of tax included in the amortized amount	none
type	string	the type of entry represented by this object	none

Enumerated Values

Property	Value
type	`AMORTIZATION_ADJUSTMENT`
type	`AMORTIZATION_CORRECTION`
type	`AMORTIZATION`

BranchApiV1

{
  "creationDate": "2019-08-24T14:15:22Z",
  "emailAddress": "string",
  "encodedKey": "string",
  "id": "string",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "name": "string",
  "phoneNumber": "string",
  "state": "ACTIVE"
}

A branch

Properties

Name	Type	Description	Restrictions
creationDate (required)	string(date-time)	the date on which this branch was created	none
emailAddress (required)	string	the primary email address for this branch	none
encodedKey (required)	string	the automatically generated encoded key for this branch	none
id (required)	string	the ID for this branch	none
lastModifiedDate (required)	string(date-time)	The date on which this branch was last modified	none
name (required)	string	the name of this branch	none
phoneNumber (required)	string	The main contact number for this branch	none
state (required)	string	whether this branch is `ACTIVE`, and can be used, or `INACTIVE`	none

BranchFullDetailsApiV1

{
  "address": {
    "addressType": "string",
    "city": "string",
    "country": "string",
    "encodedKey": "string",
    "indexInList": 0,
    "latitude": 0,
    "line1": "string",
    "line2": "string",
    "longitude": 0,
    "parentKey": "string",
    "postcode": "string",
    "region": "string",
    "toBeDeleted": true
  },
  "branchHolidays": [
    {
      "creationDate": "string",
      "dayOfMonth": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "isAnnualyRecurring": true,
      "keyId": 0,
      "monthOfYear": 0,
      "name": "string",
      "year": 0
    }
  ],
  "creationDate": "string",
  "customFieldValues": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "emailAddress": "string",
  "encodedKey": "string",
  "id": "string",
  "lastModifiedDate": "string",
  "name": "string",
  "notes": "string",
  "phoneNumber": "string",
  "state": "ACTIVE"
}

Properties

Name	Type	Description	Restrictions
address	AddressApiV1	none	none
branchHolidays	[HolidayApiV1]	a list of holidays specific to this branch	none
creationDate	string	the date on which this branch was created	none
customFieldValues	[CustomFieldValueApiV1]	none	none
emailAddress	string	the email address for this branch	none
encodedKey	string	the automatically generated encoded ID for this item	none
id	string	the user provided ID for this branch	none
lastModifiedDate	string	the date on which the details for this branch were last modified	none
name	string	the name of this branch	none
notes	string	notes associated with this branch	none
phoneNumber	string	the contact telephone number for this branch	none
state	string	wether this branch is active or not	none

Enumerated Values

Property	Value
state	`ACTIVE`
state	`INACTIVE`

CentreApiV1

{
  "address": {
    "addressType": "string",
    "city": "string",
    "country": "string",
    "encodedKey": "string",
    "indexInList": 0,
    "latitude": 0,
    "line1": "string",
    "line2": "string",
    "longitude": 0,
    "parentKey": "string",
    "postcode": "string",
    "region": "string",
    "toBeDeleted": true
  },
  "assignedBranchKey": "string",
  "creationDate": "string",
  "customFieldValues": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "encodedKey": "string",
  "id": "string",
  "lastModifiedDate": "string",
  "meetingDay": "WEDNESDAY",
  "name": "string",
  "notes": "string",
  "state": "ACTIVE"
}

Properties

Name	Type	Description	Restrictions
address	AddressApiV1	none	none
assignedBranchKey	string	the encoded key of the branch associated with this centre	none
creationDate	string	the date on which this centre was created	none
customFieldValues	[CustomFieldValueApiV1]	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
id	string	the user provided ID for this centre	none
lastModifiedDate	string	the date on which this branch was last modified	none
meetingDay	string	the day of the week that this centre meets. This may have an impact when calculating repayment days or arrears periods for loans associated with this centre	none
name	string	the name of the centre	none
notes	string	notes associated with this centre	none
state	string	whether this centre is active	none

Enumerated Values

Property	Value
meetingDay	`WEDNESDAY`
meetingDay	`MONDAY`
meetingDay	`THURSDAY`
meetingDay	`SUNDAY`
meetingDay	`TUESDAY`
meetingDay	`FRIDAY`
meetingDay	`SATURDAY`
state	`ACTIVE`
state	`INACTIVE`

ClientApiV1

{
  "activationDate": "string",
  "approvedDate": "string",
  "assignedBranchKey": "string",
  "assignedCentreKey": "string",
  "assignedUserKey": "string",
  "birthDate": "string",
  "clientRole": {
    "encodedKey": "string"
  },
  "closedDate": "string",
  "creationDate": "string",
  "emailAddress": "string",
  "encodedKey": "string",
  "firstName": "string",
  "gender": "MALE",
  "groupLoanCycle": 0,
  "homePhone": "string",
  "id": "string",
  "idPattern": "string",
  "lastModifiedDate": "string",
  "lastName": "string",
  "loanCycle": 0,
  "middleName": "string",
  "migrationEvent": {
    "creationDate": "2019-08-24T14:15:22Z",
    "encodedKey": "string",
    "numCentresImported": 0,
    "numClientsImported": 0,
    "numGLAccountsImported": 0,
    "numGroupsImported": 0,
    "numLoanRepaymentsImported": 0,
    "numLoanTransactionsImported": 0,
    "numLoansImported": 0,
    "numSavingsImported": 0,
    "state": "REVERTED",
    "type": "IMPORT"
  },
  "mobilePhone1": "string",
  "mobilePhone2": "string",
  "notes": "string",
  "portalPreferences": {
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "lastLoggedInDate": "string",
    "password": "string",
    "portalState": "DISABLED"
  },
  "preferredLanguage": "PORTUGESE",
  "profilePictureKey": "string",
  "profileSignatureKey": "string",
  "state": "PENDING_APPROVAL"
}

Properties

Name	Type	Description	Restrictions
activationDate	string	the date when the client was set to active, ie. an active account was created for them	none
approvedDate	string	the date when the client was approved	none
assignedBranchKey	string	the encoded key of the client's branch	none
assignedCentreKey	string	the encoded key of the client's assigned centre	none
assignedUserKey	string	the encoded key of the Mambu user associated with this client, eg. their credit officer	none
birthDate	string	the date of birth of this client	none
clientRole	ClientRoleBasicApiV1	the type of client or group as defined in Mambu in Administration > General Settings > Client Types	none
closedDate	string	the date when the client was exited or blacklisted	none
creationDate	string	the date on which this client record was created	none
emailAddress	string	the email address of the client	none
encodedKey	string	the automatically generated encoded ID for this item	none
firstName	string	the first name of the client	none
gender	string	the client's gender	none
groupLoanCycle	number	if this client is a member of a group, this number will increase by 1 each time they successfully close a loan as fully paid	none
homePhone	string	a home contact number for this client	none
id	string	the ID for this client	none
idPattern	string	the pattern that is used to generate the client ID	none
lastModifiedDate	string	the date on which this client record was last modified	none
lastName	string	the last name of this client	none
loanCycle	number	the number of loans this client has opened and closed as fully paid as an individual	none
middleName	string	any middle names for this client	none
migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
mobilePhone1	string	a mobile contact number for this client	none
mobilePhone2	string	another mobile contact number for this client	none
notes	string	any rich text notes about this client	none
portalPreferences	PortalPreferencesApiV1	none	none
preferredLanguage	string	the language which should be used when communicating with this client	none
profilePictureKey	string	the encoded key of this user's proficle picture	none
profileSignatureKey	string	the encoded key of the digital copy of this client's signature	none
state	string	the current state of this client	none

Enumerated Values

Property	Value
gender	`MALE`
gender	`FEMALE`
preferredLanguage	`PORTUGESE`
preferredLanguage	`RUSSIAN`
preferredLanguage	`ROMANIAN`
preferredLanguage	`ENGLISH`
preferredLanguage	`SPANISH`
preferredLanguage	`GEORGIAN`
preferredLanguage	`BURMESE`
preferredLanguage	`PHRASE`
preferredLanguage	`CHINESE`
preferredLanguage	`FRENCH`
preferredLanguage	`INDONESIAN`
state	`PENDING_APPROVAL`
state	`ACTIVE`
state	`INACTIVE`
state	`EXITED`
state	`BLACKLISTED`
state	`REJECTED`

ClientExpandedApiV1

{
  "addresses": [
    {
      "addressType": "string",
      "city": "string",
      "country": "string",
      "encodedKey": "string",
      "indexInList": 0,
      "latitude": 0,
      "line1": "string",
      "line2": "string",
      "longitude": 0,
      "parentKey": "string",
      "postcode": "string",
      "region": "string",
      "toBeDeleted": true
    }
  ],
  "centreId": "string",
  "client": {
    "activationDate": "string",
    "approvedDate": "string",
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "birthDate": "string",
    "clientRole": {
      "encodedKey": "string"
    },
    "closedDate": "string",
    "creationDate": "string",
    "emailAddress": "string",
    "encodedKey": "string",
    "firstName": "string",
    "gender": "MALE",
    "groupLoanCycle": 0,
    "homePhone": "string",
    "id": "string",
    "idPattern": "string",
    "lastModifiedDate": "string",
    "lastName": "string",
    "loanCycle": 0,
    "middleName": "string",
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "mobilePhone1": "string",
    "mobilePhone2": "string",
    "notes": "string",
    "portalPreferences": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "lastLoggedInDate": "string",
      "password": "string",
      "portalState": "DISABLED"
    },
    "preferredLanguage": "PORTUGESE",
    "profilePictureKey": "string",
    "profileSignatureKey": "string",
    "state": "PENDING_APPROVAL"
  },
  "clientTypeId": "string",
  "customInformation": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "groupKeys": [
    "string"
  ],
  "idDocuments": [
    {
      "clientKey": "string",
      "documentId": "string",
      "documentType": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "identificationDocumentTemplateKey": "string",
      "indexInList": 0,
      "issuingAuthority": "string",
      "toBeDeleted": true,
      "validUntil": "string",
      "validUntilDTOdate": {
        "dayOfMonth": 0,
        "monthOfYear": 0,
        "year": 0
      }
    }
  ],
  "notificationTemplates": [
    {
      "activated": true,
      "authorization": "NO_AUTHORIZATION",
      "contentType": "PLAIN_TEXT",
      "creationDate": "string",
      "customFilter": {
        "customConfigurationInfo": {
          "creationDate": "string",
          "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "shared": true,
          "userKey": "string"
        },
        "encodedKey": "string",
        "filterConstraints": [
          {
            "customFieldKey": "string",
            "dataFieldType": "NATIVE",
            "dataFieldValue": "string",
            "dataItemType": "WRITTEN_OFF_LOANS",
            "dataType": "ENUM",
            "encodedKey": "string",
            "filterElement": "STARTS_WITH_CASE_SENSITIVE",
            "groupNumber": 0,
            "index": 0,
            "linkingOperator": "OR",
            "secondValue": "string",
            "value": "string"
          }
        ]
      },
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "event": "LOAN_CREATED",
      "isInUse": true,
      "lastModifiedDate": "string",
      "name": "string",
      "option": "OPT_IN",
      "recipient": {
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "groupRole": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "name": "string"
        },
        "recipientType": "CREDIT_OFFICER"
      },
      "requestType": "HEAD",
      "subject": "string",
      "targetType": "LOANS",
      "template": "string",
      "topic": "string",
      "trigger": "AUTOMATIC",
      "triggerDays": 0,
      "type": "EVENT_STREAM",
      "url": "string",
      "username": "string"
    }
  ]
}

Properties

Name	Type	Description	Restrictions
addresses	[AddressApiV1]	addresses associated with this client	none
centreId	string	the ID of the centre this client is assigned to	none
client	ClientApiV1	none	none
clientTypeId	string	the type of client	none
customInformation	[CustomFieldValueApiV1]	custom information attached to this client record	none
groupKeys	[string]	the encoded keys of any groups this client belongs to	none
idDocuments	[IdentificationDocumentApiV1]	an array of ID documents this client has provided	none
notificationTemplates	[MessageTemplateApiV1]	an array of notification templates which can be used to send messages to this client via email or sms	none

ClientOnUpdate

{
  "assignedBranchKey": "string",
  "assignedCentreKey": "string",
  "assignedUserKey": "string",
  "birthDate": "string",
  "clientRoleId": "string",
  "emailAddress": "string",
  "firstName": "string",
  "gender": "MALE",
  "homePhone": "string",
  "id": "string",
  "lastName": "string",
  "middleName": "string",
  "mobilePhone1": "string",
  "notes": "string",
  "preferredLanguage": "PORTUGESE",
  "state": "PENDING_APPROVAL"
}

Properties

Name	Type	Description	Restrictions
assignedBranchKey	string	the encoded key of the branch this client is assigned to	none
assignedCentreKey	string	the encoded key of the centre this client is assigned to	none
assignedUserKey	string	the encoded key of a Mambu user who is responsible for this client	none
birthDate	string	the date of birth for this client	none
clientRoleId	string	the ID of the role this client has, for example, if they are a member of a group	none
emailAddress	string	the email address for this client	none
firstName	string	the first name of this client	none
gender	string	Gender of the client. Can be null	none
homePhone	string	the home contact number for this client	none
id	string	the ID of this client according to the ID pattern defined for your organisation	none
lastName	string	the last name of this client	none
middleName	string	any middle names of this client	none
mobilePhone1	string	a primary mobile contact number for this client	none
notes	string	any notes regarding this client	none
preferredLanguage	string	A language supported by Mambu. When used, it does not accept `null` values.	none
state	string	the current state of this client	none

Enumerated Values

Property	Value
gender	`MALE`
gender	`FEMALE`
preferredLanguage	`PORTUGESE`
preferredLanguage	`RUSSIAN`
preferredLanguage	`ROMANIAN`
preferredLanguage	`ENGLISH`
preferredLanguage	`SPANISH`
preferredLanguage	`GEORGIAN`
preferredLanguage	`BURMESE`
preferredLanguage	`PHRASE`
preferredLanguage	`CHINESE`
preferredLanguage	`GERMAN`
preferredLanguage	`FRENCH`
preferredLanguage	`INDONESIAN`
state	`PENDING_APPROVAL`
state	`ACTIVE`
state	`INACTIVE`
state	`EXITED`
state	`BLACKLISTED`
state	`REJECTED`

ClientRoleBasicApiV1

{
  "encodedKey": "string"
}

the type of client or group as defined in Mambu in Administration > General Settings > Client Types

Properties

Name	Type	Description	Restrictions
encodedKey	string	the automatically generated encoded ID for this client or group type	none

ClientRoleFullApiV1

{
  "canGuarantee": true,
  "canOpenAccounts": true,
  "clientType": "GROUP",
  "createdByUserKey": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "description": "string",
  "encodedKey": "string",
  "id": "string",
  "idPattern": "string",
  "index": 0,
  "name": "string",
  "requireID": true,
  "useDefaultAddress": true
}

the type of client or group as defined in Mambu in Administration > General Settings > Client Types

Properties

Name	Type	Description	Restrictions
canGuarantee (required)	boolean	whether this client type can guarantee loans	none
canOpenAccounts (required)	boolean	whether this client type can open accounts	none
clientType (required)	string	which entity this type is valid for, either `CLIENT` or `GROUP`	none
createdByUserKey	string	if this client type was not one of the defaults provided by Mambu the encoded key of the user who created it will be displayed here	none
creationDate (required)	string(date-time)	timestamp of when this group was created	none
description	string	description of this client type as provided through the Mambu UI	none
encodedKey (required)	string	a unique ID for this client type	none
id (required)	string	the machine-readable ID for this client type	none
idPattern	string	the pattern used to generate IDs for clients of this type, `@` represents a random letter, `#` indicates a random number, `$` represents a random letter or number	none
index (required)	number	if more than one role is assigned to this client, for example, if they are members of multiple groups, this number represents the index in the list	none
name (required)	string	the human-readable name of this client type	none
requireID (required)	boolean	whether ID is required for this client type	none
useDefaultAddress (required)	boolean	whether an address can be associated with clients of this type	none

Enumerated Values

Property	Value
clientType	`GROUP`
clientType	`CLIENT`

ColumnConfigurationApiV1

{
  "customConfigurationInfo": {
    "creationDate": "string",
    "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "indexInList": 0,
    "lastModifiedDate": "string",
    "name": "string",
    "userKey": "string"
  },
  "encodedKey": "string",
  "fieldColumns": [
    {
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "dataField": "string",
      "dataItemType": "WRITTEN_OFF_LOANS",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472"
    }
  ],
  "includeTimestamp": true,
  "includeTotals": true,
  "sortingColumn": {
    "customField": {
      "amounts": {
        "property1": 0,
        "property2": 0
      },
      "builtInCustomFieldId": "MOBILE_PHONE",
      "creationDate": "string",
      "customFieldProductSettings": [
        {
          "customFieldEncodedKey": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isDefault": true,
          "isRequired": true,
          "linkType": "CLIENT_ROLE",
          "productKey": "string"
        }
      ],
      "customFieldSelectionOptions": [
        {
          "constraint": {
            "customFieldKey": "string",
            "dataFieldType": "NATIVE",
            "dataFieldValue": "string",
            "dataItemType": "WRITTEN_OFF_LOANS",
            "dataType": "ENUM",
            "encodedKey": "string",
            "filterElement": "STARTS_WITH_CASE_SENSITIVE",
            "groupNumber": 0,
            "index": 0,
            "linkingOperator": "OR",
            "secondValue": "string",
            "value": "string"
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "score": 0,
          "value": "string"
        }
      ],
      "customFieldSet": {
        "builtInType": "DETAILS",
        "createdDate": "string",
        "customFields": [
          {}
        ],
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "lastModifiedDate": "string",
        "name": "string",
        "notes": "string",
        "type": "USER_INFO",
        "usage": "SINGLE"
      },
      "dataType": "GROUP_LINK",
      "description": "string",
      "editRights": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "isAccessibleByAllUsers": true,
        "roles": [
          "string"
        ]
      },
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "id": "string",
      "indexInList": 0,
      "isDefault": true,
      "isRequired": true,
      "lastModifiedDate": "string",
      "name": "string",
      "state": "DEACTIVATED",
      "type": "USER_INFO",
      "unique": true,
      "validationPattern": "string",
      "valueLength": "SHORT",
      "values": [
        "string"
      ],
      "viewRights": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "isAccessibleByAllUsers": true,
        "roles": [
          "string"
        ]
      }
    },
    "dataField": "string",
    "dataItemType": "WRITTEN_OFF_LOANS",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472"
  },
  "sortingOrder": "ASCENDING"
}

Properties

Name	Type	Description	Restrictions
customConfigurationInfo	CustomViewConfigurationInfoApiV1	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
fieldColumns	[FieldColumnApiV1]	none	none
includeTimestamp	boolean	wether the column should include a timestamp	none
includeTotals	boolean	whether there should be an automatically calucalated sum total for this column	none
sortingColumn	FieldColumnApiV1	none	none
sortingOrder	string	the default sort order for this column	none

Enumerated Values

Property	Value
sortingOrder	`ASCENDING`
sortingOrder	`ASCENDING_IGORE_CASE`
sortingOrder	`DESCENDING`

CommentApiV1

{
  "creationDate": "2020-09-09T14:37:14+0000",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "lastModifiedDate": "2020-09-09T14:37:14+0000",
  "parentKey": "string",
  "text": "string",
  "userKey": "string"
}

Properties

Name	Type	Description	Restrictions
creationDate	string(date-time)	the date and time at which this comment was added	none
encodedKey	string	a unique key for this comment	none
lastModifiedDate	string(date-time)	the date and time at which this comment was last modified	none
parentKey	string	the unique key of the parent object for this comment, for example, the client or loan account to which it relates	none
text	string	the text of the comment as a string, must be properly JSON escpaped if it contains special characters	none
userKey	string	the unique key of the user who created the comment	none

CreateDocumentApiV1

{
  "document": {
    "description": "string",
    "documentHolderKey": "string",
    "documentHolderType": "CLIENT",
    "name": "string",
    "type": "PDF"
  },
  "documentContent": "string"
}

CreateDocumentApiV1

Properties

Name	Type	Description	Restrictions
document (required)	object	none	none
» description	string	a description of this document	none
» documentHolderKey (required)	string	The attachment holder encoded key. eg. client key, branch key etc.	none
» documentHolderType (required)	string	The entity to which the document will be attached.	none
» name (required)	string	The attachment file name (maximum 256 characters). Maximum one extension must be provided in the name (could be none). If the extension is provided it must match with the one provided in the type parameter. Please note: Some special characters are not allowed in the filename, these are: `/ < > \| : & ? * [ ] # \ " '`	none
» type (required)	string	The attachment file extension type(example doc). Please note: Encrypted PDF files will always be rejected, since our anti-virus cannot scan them for malware.	none
documentContent (required)	string	base64 encoded file	none

Enumerated Values

Property	Value
documentHolderType	`CLIENT`
documentHolderType	`GROUP`
documentHolderType	`LOAN_ACCOUNT`
documentHolderType	`LOAN_PRODUCT`
documentHolderType	`DEPOSIT_ACCOUNT`
documentHolderType	`SAVINGS_PRODUCT`
documentHolderType	`BRANCH`
documentHolderType	`CENTRE`
documentHolderType	`USER`
documentHolderType	`GL_JOURNAL_ENTRY`
type	`JPG`
type	`JPEG`
type	`PNG`
type	`GIF`
type	`BMP`
type	`TIFF`
type	`DOC`
type	`DOCX`
type	`DOCM`
type	`DOT`
type	`DOTX`
type	`DOTM`
type	`XLS`
type	`XLSX`
type	`XLSB`
type	`PPTX`
type	`PPT`
type	`PPS`
type	`PPSX`
type	`ODT`
type	`OTT`
type	`FODT`
type	`PDF`
type	`XML`
type	`TXT`
type	`CSV`
type	`PROPERTIES`
type	`MSG`
type	`TIF`
type	`ZIP`
type	`RTF`
type	`XLSM`
type	`ODS`
type	`ODP`
type	`EML`
type	`EMLX`
type	`HTML`
type	`MHT`
type	`MHTML`
type	`XPS`
type	`NUMBERS`
type	`KEY`
type	`PAGES`
type	`YAML`
type	`JSON`
type	`JASPER`
type	`JRXML`

CreateExchangeRateApiV1

{
  "buyRate": "string",
  "sellRate": "string",
  "startDate": "string"
}

CreateExchangeRateApiV1

Properties

Name	Type	Description	Restrictions
buyRate (required)	string	The amount the currency will be sold to base currency.	none
sellRate (required)	string	The amount the currency will be bought from base currency.	none
startDate	string	The date from which the exchange rate will be valid. Must not be in the future or before the latest exchange rate's (for that currency) start date. If not provided, the organization current date and time will be used.	none

CreateLineOfCreditApiV1

{
  "lineOfCredit": {
    "amount": "string",
    "clientKey": "string",
    "customInformation": [
      {
        "customFieldID": "string",
        "value": "string"
      }
    ],
    "expireDate": "2019-08-24T14:15:22Z",
    "exposureLimitType": "OUTSTANDING_AMOUNT",
    "groupKey": "string",
    "id": "string",
    "notes": "string",
    "startDate": "2019-08-24T14:15:22Z"
  }
}

CreateLineOfCreditApiV1

Properties

Name	Type	Description	Restrictions
lineOfCredit (required)	object	an object representing a line of credit	none
» amount (required)	string	the amount of the line of credit	none
» clientKey	string	The ID of the client for whom the line of credit is to be created	none
» customInformation	[object]	an array of any custom field values you may have set up for your Mambu instance	none
»» customFieldID	string	The ID of the custom field definition.	none
»» value	string	the custom field value	none
» expireDate (required)	string(date-time)	the date on which the line of credit will end	none
» exposureLimitType (required)	string	Limit comparing to the original (`APPROVED_AMOUNT`) loan/overdraft amounts or the current (`OUTSTANDING_AMOUNT`) amount	none
» groupKey	string	the ID of the group for whom the line of credit is to be created	none
» id (required)	string	the ID of the line of credit to be created	none
» notes	string	some notes	none
» startDate (required)	string(date-time)	the date on which the line of credit will become valid	none

Enumerated Values

Property	Value
exposureLimitType	`OUTSTANDING_AMOUNT`
exposureLimitType	`APPROVED_AMOUNT`

CreateOrUpdateClientRequest

{
  "addresses": [
    {
      "addressType": "string",
      "city": "string",
      "country": "string",
      "encodedKey": "string",
      "indexInList": 0,
      "latitude": 0,
      "line1": "string",
      "line2": "string",
      "longitude": 0,
      "parentKey": "string",
      "postcode": "string",
      "region": "string",
      "toBeDeleted": true
    }
  ],
  "client": {
    "activationDate": "string",
    "approvedDate": "string",
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "birthDate": "string",
    "clientRole": {
      "encodedKey": "string"
    },
    "closedDate": "string",
    "creationDate": "string",
    "emailAddress": "string",
    "encodedKey": "string",
    "firstName": "string",
    "gender": "MALE",
    "groupLoanCycle": 0,
    "homePhone": "string",
    "id": "string",
    "idPattern": "string",
    "lastModifiedDate": "string",
    "lastName": "string",
    "loanCycle": 0,
    "middleName": "string",
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "mobilePhone1": "string",
    "mobilePhone2": "string",
    "notes": "string",
    "portalPreferences": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "lastLoggedInDate": "string",
      "password": "string",
      "portalState": "DISABLED"
    },
    "preferredLanguage": "PORTUGESE",
    "profilePictureKey": "string",
    "profileSignatureKey": "string",
    "state": "PENDING_APPROVAL"
  },
  "customInformation": [
    {
      "customFieldID": "string",
      "customFieldSetGroupIndex": 0,
      "linkedEntityKeyValue": "string",
      "value": "string"
    }
  ],
  "groupKeys": [
    "string"
  ],
  "idDocuments": [
    {
      "clientKey": "string",
      "documentId": "string",
      "documentType": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "identificationDocumentTemplateKey": "string",
      "indexInList": 0,
      "issuingAuthority": "string",
      "toBeDeleted": true,
      "validUntil": "string",
      "validUntilDTOdate": {
        "dayOfMonth": 0,
        "monthOfYear": 0,
        "year": 0
      }
    }
  ]
}

Properties

Name	Type	Description	Restrictions
addresses	[AddressApiV1]	an array of addresses for this client	none
client	ClientApiV1	none	none
customInformation	[CustomFieldValueRequest]	custom information relating to this client	none
groupKeys	[string]	a list of encoded keys of groups of which this client is a member	none
idDocuments	[IdentificationDocumentApiV1]	an array of ID documents for this client	none

CreateOrUpdateClientResponse

{
  "addresses": [
    {
      "addressType": "string",
      "city": "string",
      "country": "string",
      "encodedKey": "string",
      "indexInList": 0,
      "latitude": 0,
      "line1": "string",
      "line2": "string",
      "longitude": 0,
      "parentKey": "string",
      "postcode": "string",
      "region": "string",
      "toBeDeleted": true
    }
  ],
  "client": {
    "activationDate": "string",
    "approvedDate": "string",
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "birthDate": "string",
    "clientRole": {
      "encodedKey": "string"
    },
    "closedDate": "string",
    "creationDate": "string",
    "emailAddress": "string",
    "encodedKey": "string",
    "firstName": "string",
    "gender": "MALE",
    "groupLoanCycle": 0,
    "homePhone": "string",
    "id": "string",
    "idPattern": "string",
    "lastModifiedDate": "string",
    "lastName": "string",
    "loanCycle": 0,
    "middleName": "string",
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "mobilePhone1": "string",
    "mobilePhone2": "string",
    "notes": "string",
    "portalPreferences": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "lastLoggedInDate": "string",
      "password": "string",
      "portalState": "DISABLED"
    },
    "preferredLanguage": "PORTUGESE",
    "profilePictureKey": "string",
    "profileSignatureKey": "string",
    "state": "PENDING_APPROVAL"
  },
  "customInformation": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "groupKeys": [
    "string"
  ],
  "idDocuments": [
    {
      "clientKey": "string",
      "documentId": "string",
      "documentType": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "identificationDocumentTemplateKey": "string",
      "indexInList": 0,
      "issuingAuthority": "string",
      "toBeDeleted": true,
      "validUntil": "string",
      "validUntilDTOdate": {
        "dayOfMonth": 0,
        "monthOfYear": 0,
        "year": 0
      }
    }
  ]
}

Properties

Name	Type	Description	Restrictions
addresses	[AddressApiV1]	an array of addresses associated with this client	none
client	ClientApiV1	none	none
customInformation	[CustomFieldValueApiV1]	custom information associated with this client	none
groupKeys	[string]	an array of encoded keys for any groups the client is a member of	none
idDocuments	[IdentificationDocumentApiV1]	an array of ID documents associated with this client	none

CurrencyApiV1

{
  "code": "string",
  "creationDate": "string",
  "currencySymbolPosition": "AFTER_NUMBER",
  "digitsAfterDecimal": 0,
  "isBaseCurrency": true,
  "lastModifiedDate": "string",
  "name": "string",
  "symbol": "string"
}

Properties

Name	Type	Description	Restrictions
code	string	the three letter ISO code for this currency	none
creationDate	string	the date on which this currency was created	none
currencySymbolPosition	string	indicates where the currency symbol should appear in relation to the numeric value	none
digitsAfterDecimal	number	indicates how many decimal places are allowed for this currency. For example, a currenncy with 100 minor units to 1 major unit, there will be 2 decimal places.	none
isBaseCurrency	boolean	whether this currency is the base currency for your banking institution	none
lastModifiedDate	string	the date on which this currency was last modified	none
name	string	the name of this currency	none
symbol	string	the currency symnbol used for this currency	none

Enumerated Values

Property	Value
currencySymbolPosition	`AFTER_NUMBER`
currencySymbolPosition	`BEFORE_NUMBER`

CustomConfigurationInfoApiV1

{
  "creationDate": "string",
  "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "indexInList": 0,
  "lastModifiedDate": "string",
  "name": "string",
  "shared": true,
  "userKey": "string"
}

Properties

Name	Type	Description	Restrictions
creationDate	string	the date on which this configuration was created	none
dataViewType	string	the type of entity this configuration is for	none
encodedKey	string	the automatically generated encoded ID for this item	none
indexInList	number	if more than one configuration exists for a given type, this is its index in the list	none
lastModifiedDate	string	the date on which this configuration was last modified	none
name	string	the name for this configuration	none
shared	boolean	whether this configuration is private or can be used by other users of the system	none
userKey	string	the encoded key of the Mambu user who created this configuration	none

Enumerated Values

Property	Value
dataViewType	`PORTAL_ACCOUNT_TRANSACTION`
dataViewType	`LOANS_AGING_ANALYSIS`
dataViewType	`CLOSED_ACCOUNTS`
dataViewType	`CLIENT_OVERVIEW`
dataViewType	`ADMIN_CENTRES`
dataViewType	`USER_NOTIFICATION_MESSAGES`
dataViewType	`LINE_OF_CREDIT`
dataViewType	`USER_OVERVIEW`
dataViewType	`CENTRE_OVERVIEW`
dataViewType	`REPAYMENT_REPAYMENTS_COLLECTION`
dataViewType	`GROUP_OVERVIEW`
dataViewType	`ACTIVITIES_LOOKUP`
dataViewType	`TRANSACTION`
dataViewType	`ADMIN_BRANCHES`
dataViewType	`GROUP`
dataViewType	`BRANCH_OVERVIEW`
dataViewType	`NOTIFICATION_MESSAGE`
dataViewType	`PORTFOLIO_REPORTS`
dataViewType	`GROUP_NOTIFICATION_MESSAGES`
dataViewType	`LOAN_ACCOUNT_SECURITIES_OVERVIEW`
dataViewType	`LINE_OF_CREDIT_OVERVIEW`
dataViewType	`CURRENCIES`
dataViewType	`REPAYMENT`
dataViewType	`TILL_TRANSACTIONS`
dataViewType	`ALL_TASKS`
dataViewType	`CENTRE`
dataViewType	`BRANCH`
dataViewType	`INDEX_RATES_LIST`
dataViewType	`USER_TASKS`
dataViewType	`DOCUMENT_TEMPLATES`
dataViewType	`SAVINGS_TRANSACTIONS_LOOKUP`
dataViewType	`LOAN_ACCOUNT_OVERVIEW`
dataViewType	`DEPOSITS_COLLECTION`
dataViewType	`USER`
dataViewType	`ADMIN_USERS`
dataViewType	`GROUP_TASKS`
dataViewType	`CLIENT`
dataViewType	`LOAN_TRANSACTIONS_LOOKUP`
dataViewType	`LOANS`
dataViewType	`LOANS_REPAYMENTS_COLLECTION`
dataViewType	`CLIENT_TASKS`
dataViewType	`OVERDRAFTS_AGING_ANALYSIS`
dataViewType	`LOAN_ACCOUNT_FUNDING_OVERVIEW`
dataViewType	`SAVINGS`
dataViewType	`SAVINGS_OVERVIEW`
dataViewType	`JOURNAL_ENTRY`
dataViewType	`CLIENT_NOTIFICATION_MESSAGES`

CustomFieldApiV1

{
  "amounts": {
    "property1": 0,
    "property2": 0
  },
  "builtInCustomFieldId": "MOBILE_PHONE",
  "creationDate": "string",
  "customFieldProductSettings": [
    {
      "customFieldEncodedKey": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "isDefault": true,
      "isRequired": true,
      "linkType": "CLIENT_ROLE",
      "productKey": "string"
    }
  ],
  "customFieldSelectionOptions": [
    {
      "constraint": {
        "customFieldKey": "string",
        "dataFieldType": "NATIVE",
        "dataFieldValue": "string",
        "dataItemType": "WRITTEN_OFF_LOANS",
        "dataType": "ENUM",
        "encodedKey": "string",
        "filterElement": "STARTS_WITH_CASE_SENSITIVE",
        "groupNumber": 0,
        "index": 0,
        "linkingOperator": "OR",
        "secondValue": "string",
        "value": "string"
      },
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "id": "string",
      "score": 0,
      "value": "string"
    }
  ],
  "customFieldSet": {
    "builtInType": "DETAILS",
    "createdDate": "string",
    "customFields": [
      {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {},
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      }
    ],
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "id": "string",
    "indexInList": 0,
    "lastModifiedDate": "string",
    "name": "string",
    "notes": "string",
    "type": "USER_INFO",
    "usage": "SINGLE"
  },
  "dataType": "GROUP_LINK",
  "description": "string",
  "editRights": {
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "isAccessibleByAllUsers": true,
    "roles": [
      "string"
    ]
  },
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "id": "string",
  "indexInList": 0,
  "isDefault": true,
  "isRequired": true,
  "lastModifiedDate": "string",
  "name": "string",
  "state": "DEACTIVATED",
  "type": "USER_INFO",
  "unique": true,
  "validationPattern": "string",
  "valueLength": "SHORT",
  "values": [
    "string"
  ],
  "viewRights": {
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "isAccessibleByAllUsers": true,
    "roles": [
      "string"
    ]
  }
}

Properties

Name	Type	Description	Restrictions
amounts	object	used when options available for a custom field definition translate to predefined amounts, for example, when the custom field value is used to generate a score	none
» additionalProperties	number	none	none
builtInCustomFieldId	string	if this field is one of the built in custom fiel definitions, this will have a value. These names are reserved and you can not use them for your own custom field definitions	none
creationDate	string	the date on which this custom field definition was created	none
customFieldProductSettings	[CustomFieldLinkApiV1]	none	none
customFieldSelectionOptions	[CustomFieldSelectionApiV1]	[represents a possible selection for select type custom field definitions]	none
customFieldSet	CustomFieldSetApiV1	none	none
dataType	string	the type of custom field definition	none
description	string	a brief description of this custom field definition	none
editRights	UsageRightsApiV1	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
id	string	the ID for this custom field definition	none
indexInList	number	none	none
isDefault	boolean	whether this field will be included by default on new records	none
isRequired	boolean	whether this field is required when creating a new record	none
lastModifiedDate	string	the date on which this custom field definition was last modified	none
name	string	the name of this custom field definition	none
state	string	whether this field is available for use or has been deactivated	none
type	string	the type of data this custom field definition will contain	none
unique	boolean	whether the data in this custom field definition needs to be a unique value	none
validationPattern	string	a user-provided pattern to which data in this custom field definition must conform where @ represents numbers, # represents letters and $ is either a number or letter. Other special characters used as separators are allowed, for example `@@-##-$$$`	none
valueLength	string	whether this field needs to support a large number of characters	none
values	[string]	a list of possible values when the field is a selection field	none
viewRights	UsageRightsApiV1	none	none

Enumerated Values

Property	Value
builtInCustomFieldId	`MOBILE_PHONE`
builtInCustomFieldId	`EMAIL_ADDRESS`
builtInCustomFieldId	`GENDER`
builtInCustomFieldId	`MIDDLE_NAME`
builtInCustomFieldId	`HOME_PHONE`
builtInCustomFieldId	`BIRTHDATE`
builtInCustomFieldId	`LAST_NAME`
builtInCustomFieldId	`FIRST_NAME`
dataType	`GROUP_LINK`
dataType	`DATE`
dataType	`NUMBER`
dataType	`CHECKBOX`
dataType	`CLIENT_LINK`
dataType	`STRING`
dataType	`USER_LINK`
dataType	`SELECTION`
state	`DEACTIVATED`
state	`NORMAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
valueLength	`SHORT`
valueLength	`LONG`

CustomFieldLinkApiV1

{
  "customFieldEncodedKey": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "isDefault": true,
  "isRequired": true,
  "linkType": "CLIENT_ROLE",
  "productKey": "string"
}

Properties

Name	Type	Description	Restrictions
customFieldEncodedKey	string	the key to the parent custom field definition	none
encodedKey	string	the automatically generated encoded ID for this item	none
isDefault	boolean	whether this field is displayed by default when creating a new record	none
isRequired	boolean	whether this field is required when creating a new record	none
linkType	string	the type of entity this field represents a link to	none
productKey	string	when the link type is product, this field should contain the encoded key of the linekd product	none

Enumerated Values

Property	Value
linkType	`CLIENT_ROLE`
linkType	`CHANNEL`
linkType	`PRODUCT`

CustomFieldOnUpdate

{
  "value": "string"
}

Properties

Name	Type	Description	Restrictions
value	string	the new custom field value	none

CustomFieldSelectionApiV1

{
  "constraint": {
    "customFieldKey": "string",
    "dataFieldType": "NATIVE",
    "dataFieldValue": "string",
    "dataItemType": "WRITTEN_OFF_LOANS",
    "dataType": "ENUM",
    "encodedKey": "string",
    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
    "groupNumber": 0,
    "index": 0,
    "linkingOperator": "OR",
    "secondValue": "string",
    "value": "string"
  },
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "id": "string",
  "score": 0,
  "value": "string"
}

represents a possible selection for select type custom field definitions

Properties

Name	Type	Description	Restrictions
constraint	CustomFilterConstraintApiV1	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
id	string	the ID of this selectable item	none
score	number	the score assigned to this selection	none
value	string	display name of this option	none

CustomFieldSetApiV1

{
  "builtInType": "DETAILS",
  "createdDate": "string",
  "customFields": [
    {
      "amounts": {
        "property1": 0,
        "property2": 0
      },
      "builtInCustomFieldId": "MOBILE_PHONE",
      "creationDate": "string",
      "customFieldProductSettings": [
        {
          "customFieldEncodedKey": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isDefault": true,
          "isRequired": true,
          "linkType": "CLIENT_ROLE",
          "productKey": "string"
        }
      ],
      "customFieldSelectionOptions": [
        {
          "constraint": {
            "customFieldKey": "string",
            "dataFieldType": "NATIVE",
            "dataFieldValue": "string",
            "dataItemType": "WRITTEN_OFF_LOANS",
            "dataType": "ENUM",
            "encodedKey": "string",
            "filterElement": "STARTS_WITH_CASE_SENSITIVE",
            "groupNumber": 0,
            "index": 0,
            "linkingOperator": "OR",
            "secondValue": "string",
            "value": "string"
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "score": 0,
          "value": "string"
        }
      ],
      "customFieldSet": {
        "builtInType": "DETAILS",
        "createdDate": "string",
        "customFields": [],
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "lastModifiedDate": "string",
        "name": "string",
        "notes": "string",
        "type": "USER_INFO",
        "usage": "SINGLE"
      },
      "dataType": "GROUP_LINK",
      "description": "string",
      "editRights": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "isAccessibleByAllUsers": true,
        "roles": [
          "string"
        ]
      },
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "id": "string",
      "indexInList": 0,
      "isDefault": true,
      "isRequired": true,
      "lastModifiedDate": "string",
      "name": "string",
      "state": "DEACTIVATED",
      "type": "USER_INFO",
      "unique": true,
      "validationPattern": "string",
      "valueLength": "SHORT",
      "values": [
        "string"
      ],
      "viewRights": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "isAccessibleByAllUsers": true,
        "roles": [
          "string"
        ]
      }
    }
  ],
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "id": "string",
  "indexInList": 0,
  "lastModifiedDate": "string",
  "name": "string",
  "notes": "string",
  "type": "USER_INFO",
  "usage": "SINGLE"
}

Properties

Name	Type	Description	Restrictions
builtInType	string	if this set is part of the set of built-in custom field sets, its type will be shown here	none
createdDate	string	the date and time when this custom field set was created	none
customFields	[CustomFieldApiV1]	an array of custom field definitions included in this custom field set	none
encodedKey	string	the automatically generated encoded ID for this item	none
id	string	the ID of this custom field set	none
indexInList	number	for field sets that can be added to an entity more than once, this number represents the index in the list and is used when changing values	none
lastModifiedDate	string	the date on which this custom field set was last modified	none
name	string	the name of this custom field set	none
notes	string	any notes regarding this custom field set	none
type	string	the entity type that this custom field definition is attached to	none
usage	string	whether this custom field set can only be used once, or added multiple times to the same entity	none

Enumerated Values

Property	Value
builtInType	`DETAILS`
builtInType	`GENERAL`
type	`USER_INFO`
type	`ASSET_INFO`
type	`CLIENT_INFO`
type	`LINE_OF_CREDIT`
type	`GROUP_INFO`
type	`TRANSACTION_CHANNEL_INFO`
type	`BRANCH_INFO`
type	`SAVINGS_ACCOUNT_INFO`
type	`LOAN_ACCOUNT_INFO`
type	`GUARANTOR_INFO`
type	`CENTRE_INFO`
usage	`SINGLE`
usage	`GROUPED`

CustomFieldValueApiV1

{
  "amount": 0,
  "customField": {
    "amounts": {
      "property1": 0,
      "property2": 0
    },
    "builtInCustomFieldId": "MOBILE_PHONE",
    "creationDate": "string",
    "customFieldProductSettings": [
      {
        "customFieldEncodedKey": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "isDefault": true,
        "isRequired": true,
        "linkType": "CLIENT_ROLE",
        "productKey": "string"
      }
    ],
    "customFieldSelectionOptions": [
      {
        "constraint": {
          "customFieldKey": "string",
          "dataFieldType": "NATIVE",
          "dataFieldValue": "string",
          "dataItemType": "WRITTEN_OFF_LOANS",
          "dataType": "ENUM",
          "encodedKey": "string",
          "filterElement": "STARTS_WITH_CASE_SENSITIVE",
          "groupNumber": 0,
          "index": 0,
          "linkingOperator": "OR",
          "secondValue": "string",
          "value": "string"
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "score": 0,
        "value": "string"
      }
    ],
    "customFieldSet": {
      "builtInType": "DETAILS",
      "createdDate": "string",
      "customFields": [
        {}
      ],
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "id": "string",
      "indexInList": 0,
      "lastModifiedDate": "string",
      "name": "string",
      "notes": "string",
      "type": "USER_INFO",
      "usage": "SINGLE"
    },
    "dataType": "GROUP_LINK",
    "description": "string",
    "editRights": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "isAccessibleByAllUsers": true,
      "roles": [
        "string"
      ]
    },
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "id": "string",
    "indexInList": 0,
    "isDefault": true,
    "isRequired": true,
    "lastModifiedDate": "string",
    "name": "string",
    "state": "DEACTIVATED",
    "type": "USER_INFO",
    "unique": true,
    "validationPattern": "string",
    "valueLength": "SHORT",
    "values": [
      "string"
    ],
    "viewRights": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "isAccessibleByAllUsers": true,
      "roles": [
        "string"
      ]
    }
  },
  "customFieldID": "string",
  "customFieldKey": "string",
  "customFieldSetGroupIndex": 0,
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "indexInList": 0,
  "linkedEntityKeyValue": "string",
  "parentKey": "string",
  "selectionKey": "string",
  "value": "string"
}

Properties

Name	Type	Description	Restrictions
amount	number	none	none
customField	CustomFieldApiV1	none	none
customFieldID	string	none	none
customFieldKey	string	none	none
customFieldSetGroupIndex	number	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
indexInList	number	none	none
linkedEntityKeyValue	string	none	none
parentKey	string	none	none
selectionKey	string	none	none
value	string	none	none

CustomFieldValueOnUpdate

{
  "customFieldID": "string",
  "customFieldSetGroupIndex": 0,
  "value": "string"
}

Properties

Name	Type	Description	Restrictions
customFieldID	string	none	none
customFieldSetGroupIndex	number	none	none
value	string	none	none

CustomFieldValueRequest

{
  "customFieldID": "string",
  "customFieldSetGroupIndex": 0,
  "linkedEntityKeyValue": "string",
  "value": "string"
}

Properties

Name	Type	Description	Restrictions
customFieldID	string	none	none
customFieldSetGroupIndex	number	none	none
linkedEntityKeyValue	string	none	none
value	string	none	none

CustomFilterApiV1

{
  "customConfigurationInfo": {
    "creationDate": "string",
    "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "indexInList": 0,
    "lastModifiedDate": "string",
    "name": "string",
    "shared": true,
    "userKey": "string"
  },
  "encodedKey": "string",
  "filterConstraints": [
    {
      "customFieldKey": "string",
      "dataFieldType": "NATIVE",
      "dataFieldValue": "string",
      "dataItemType": "WRITTEN_OFF_LOANS",
      "dataType": "ENUM",
      "encodedKey": "string",
      "filterElement": "STARTS_WITH_CASE_SENSITIVE",
      "groupNumber": 0,
      "index": 0,
      "linkingOperator": "OR",
      "secondValue": "string",
      "value": "string"
    }
  ]
}

Properties

Name	Type	Description	Restrictions
customConfigurationInfo	CustomConfigurationInfoApiV1	none	none
encodedKey	string	none	none
filterConstraints	[CustomFilterConstraintApiV1]	none	none

CustomFilterConstraintApiV1

{
  "customFieldKey": "string",
  "dataFieldType": "NATIVE",
  "dataFieldValue": "string",
  "dataItemType": "WRITTEN_OFF_LOANS",
  "dataType": "ENUM",
  "encodedKey": "string",
  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
  "groupNumber": 0,
  "index": 0,
  "linkingOperator": "OR",
  "secondValue": "string",
  "value": "string"
}

Properties

Name	Type	Description	Restrictions
customFieldKey	string	none	none
dataFieldType	string	none	none
dataFieldValue	string	none	none
dataItemType	string	none	none
dataType	string	none	none
encodedKey	string	none	none
filterElement	string	none	none
groupNumber	number	none	none
index	number	none	none
linkingOperator	string	none	none
secondValue	string	none	none
value	string	none	none

Enumerated Values

Property	Value
dataFieldType	`NATIVE`
dataFieldType	`CUSTOM`
dataItemType	`WRITTEN_OFF_LOANS`
dataItemType	`LINE_OF_CREDIT`
dataItemType	`INVESTOR_FUND`
dataItemType	`TRANSACTION_DETAILS`
dataItemType	`DOCUMENT_TEMPLATE`
dataItemType	`PRODUCT`
dataItemType	`MCC_EXPIRATION`
dataItemType	`CENTRE`
dataItemType	`REPAYMENT_COLLECTION`
dataItemType	`TASK`
dataItemType	`OUTSTANDING_PORTFOLIO_AMOUNTS`
dataItemType	`REVENUE`
dataItemType	`COMPOSED_TRANSACTIONS`
dataItemType	`UNION_TRANSACTIONS`
dataItemType	`PRINCIPAL_PAYMENT_SETTINGS`
dataItemType	`LOANS`
dataItemType	`DISBURSEMENT_DETAILS`
dataItemType	`SAVINGS_TRANSACTION`
dataItemType	`IDENTIFICATION_DOCUMENT`
dataItemType	`LOAN_PRODUCT`
dataItemType	`DISBURSED_LOANS`
dataItemType	`LOAN_GROUP`
dataItemType	`TRANSACTION_CHANNEL`
dataItemType	`CUSTOM_PREDEFINED_FEE`
dataItemType	`JOURNAL_ENTRY`
dataItemType	`ATTACHMENT`
dataItemType	`PREDEFINED_FEE`
dataItemType	`TRANCHE`
dataItemType	`TRANSACTION`
dataItemType	`INDEX_RATE_SOURCE`
dataItemType	`GROUP_ROLE`
dataItemType	`LOAN_TRANSACTION`
dataItemType	`CLIENT_ROLE`
dataItemType	`GROUP`
dataItemType	`NOTIFICATION_MESSAGE`
dataItemType	`OUTSTANDING_PORTFOLIO_ACCOUNTS`
dataItemType	`REPAYMENT`
dataItemType	`LOAN_ACCOUNT_GUARANTY`
dataItemType	`BRANCH`
dataItemType	`CURRENCY`
dataItemType	`CARD_TRANSACTION_REVERSAL`
dataItemType	`INTEREST_PRODUCT_SETTINGS`
dataItemType	`CREATED_ACCOUNTS`
dataItemType	`USER`
dataItemType	`SAVINGS_PRODUCT`
dataItemType	`CLIENT`
dataItemType	`PRODUCT_ARREARS_SETTINGS`
dataItemType	`SAVINGS`
dataItemType	`EXPENSE`
dataItemType	`INDEX_RATE`
dataItemType	`NOTIFICATION_TEMPLATE`
dataItemType	`CUSTOM_FIELD_SELECTION`
dataItemType	`ACTIVITY`
dataType	`ENUM`
dataType	`MONEY`
dataType	`NUMBER`
dataType	`DATE_UTC`
dataType	`JAVA_BLOB`
dataType	`OBJECT`
dataType	`BOOLEAN`
dataType	`DATE`
dataType	`PERCENT`
dataType	`BIG_DECIMAL`
dataType	`STRING`
dataType	`KEY`
dataType	`LONG`
filterElement	`STARTS_WITH_CASE_SENSITIVE`
filterElement	`THIS_WEEK`
filterElement	`EQUALS`
filterElement	`STARTS_WITH`
filterElement	`IN`
filterElement	`TODAY`
filterElement	`THIS_YEAR`
filterElement	`BETWEEN`
filterElement	`AFTER`
filterElement	`LESS_THAN`
filterElement	`DIFFERENT_THAN`
filterElement	`THIS_MONTH`
filterElement	`NOT_EMPTY`
filterElement	`BEFORE`
filterElement	`EQUALS_CASE_SENSITIVE`
filterElement	`LAST_DAYS`
filterElement	`MORE_THAN`
filterElement	`EMPTY`
filterElement	`ON`
linkingOperator	`OR`
linkingOperator	`AND`

CustomPaymentAmountApiV1

{
  "amount": 0,
  "customPaymentAmountType": "PAYMENT_DUE_FEE",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "index": 0,
  "loanTransactionKey": "string",
  "taxOnAmount": 0
}

Properties

Name	Type	Description	Restrictions
amount	number	the amount of this custom payment	none
customPaymentAmountType	string	the type of this custom payment	none
encodedKey	string	the automatically generated encoded ID for this item	none
index	number	index in list when this is part of a custom payment of which parts are allocated to different types of charge, for example, a single payment that goes towards loan principal, a late payment fee and a penalty	none
loanTransactionKey	string	the encoded key of the loan transaction this custom payment is part of	none
taxOnAmount	number	the amount of tax charged for this payment	none

Enumerated Values

Property	Value
customPaymentAmountType	`PAYMENT_DUE_FEE`
customPaymentAmountType	`PENALTY`
customPaymentAmountType	`MANUAL_FEE`
customPaymentAmountType	`PRINCIPAL`
customPaymentAmountType	`UPFRONT_DISBURSEMENT_FEE`
customPaymentAmountType	`LATE_REPAYMENT_FEE`
customPaymentAmountType	`INTEREST`

CustomPredefinedFeeApiV1

{
  "amount": 0,
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "fee": {
    "active": true,
    "amortizationIntervalSettings": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
      "intervalCount": 0,
      "intervalType": "FULL_TERM",
      "periodCount": 0,
      "periodUnit": "MONTHS"
    },
    "amortizationProfile": "STRAIGHT_LINE",
    "amount": 0,
    "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
    "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
    "creationDate": "string",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
    "feeApplication": "OPTIONAL",
    "feeProductRules": [
      {
        "account": {
          "activated": true,
          "allowManualJournalEntries": true,
          "balance": 0,
          "creationDate": "2019-08-24T14:15:22Z",
          "currency": {
            "code": "string",
            "creationDate": "string",
            "currencySymbolPosition": "AFTER_NUMBER",
            "digitsAfterDecimal": 0,
            "isBaseCurrency": true,
            "lastModifiedDate": "string",
            "name": "string",
            "symbol": "string"
          },
          "description": "string",
          "encodedKey": "string",
          "glCode": "string",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "migrationEvent": {
            "creationDate": "2019-08-24T14:15:22Z",
            "encodedKey": "string",
            "numCentresImported": 0,
            "numClientsImported": 0,
            "numGLAccountsImported": 0,
            "numGroupsImported": 0,
            "numLoanRepaymentsImported": 0,
            "numLoanTransactionsImported": 0,
            "numLoansImported": 0,
            "numSavingsImported": 0,
            "state": "REVERTED",
            "type": "IMPORT"
          },
          "name": "string",
          "stripTrailingZeros": true,
          "type": "INCOME",
          "usage": "HEADER"
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "financialResource": "FEE_RECEIVABLE",
        "index": 0,
        "predefinedFeeKey": "string",
        "productKey": "string",
        "productType": "LOAN",
        "transactionChannelKey": "string"
      }
    ],
    "name": "string",
    "percentageAmount": 0,
    "trigger": "DISBURSEMENT"
  }
}

Properties

Name	Type	Description	Restrictions
amount	number	the amount of this fee	none
encodedKey	string	the automatically generated encoded ID for this item	none
fee	PredefinedFeeApiV1	none	none

CustomRepaymentSettingsApiV1

{
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "loanTransactionKey": "string",
  "source": "CENTRE_MEETING_DAY_CHANGED",
  "type": "CUSTOM_ADDED_INSTALLMENT"
}

Properties

Name	Type	Description	Restrictions
encodedKey	string	the automatically generated encoded ID for this item	none
loanTransactionKey	string	the encoded key of the transaction that used these custom settings	none
source	string	the reason for these custom settings being created	none
type	string	the settings which were customised	none

Enumerated Values

Property	Value
source	`CENTRE_MEETING_DAY_CHANGED`
source	`INTEREST_APPLIED`
source	`INSTALLMENT_GRACED_NON_NATIVELY`
source	`INSTALLMENT_PAID`
source	`USER_INPUT`
type	`CUSTOM_ADDED_INSTALLMENT`
type	`CUSTOM_PRINCIPAL`
type	`CUSTOM_DUE_DATE`

CustomViewApiV1

{
  "columnConfiguration": {
    "customConfigurationInfo": {
      "creationDate": "string",
      "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "lastModifiedDate": "string",
      "name": "string",
      "userKey": "string"
    },
    "encodedKey": "string",
    "fieldColumns": [
      {
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "dataField": "string",
        "dataItemType": "WRITTEN_OFF_LOANS",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472"
      }
    ],
    "includeTimestamp": true,
    "includeTotals": true,
    "sortingColumn": {
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "dataField": "string",
      "dataItemType": "WRITTEN_OFF_LOANS",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472"
    },
    "sortingOrder": "ASCENDING"
  },
  "customConfigurationInfo": {
    "creationDate": "string",
    "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "indexInList": 0,
    "lastModifiedDate": "string",
    "name": "string",
    "userKey": "string"
  },
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "filter": {
    "customConfigurationInfo": {
      "creationDate": "string",
      "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "lastModifiedDate": "string",
      "name": "string",
      "userKey": "string"
    },
    "encodedKey": "string",
    "filterConstraints": [
      {
        "customFieldKey": "string",
        "dataFieldType": "NATIVE",
        "dataFieldValue": "string",
        "dataItemType": "WRITTEN_OFF_LOANS",
        "dataType": "ENUM",
        "encodedKey": "string",
        "filterElement": "STARTS_WITH_CASE_SENSITIVE",
        "groupNumber": 0,
        "index": 0,
        "linkingOperator": "OR",
        "secondValue": "string",
        "value": "string"
      }
    ]
  },
  "parentMenuItemKey": "string",
  "viewMode": "DETAIL",
  "viewRights": {
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "isAccessibleByAllUsers": true,
    "roles": [
      "string"
    ]
  }
}

Properties

Name	Type	Description	Restrictions
columnConfiguration	ColumnConfigurationApiV1	none	none
customConfigurationInfo	CustomViewConfigurationInfoApiV1	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
filter	CustomViewFilterApiV1	none	none
parentMenuItemKey	string	the encoded key of the menu that uses this custom view	none
viewMode	string	whether this view is a simple list or more detailed table	none
viewRights	UsageRightsApiV1	none	none

Enumerated Values

Property	Value
viewMode	`DETAIL`
viewMode	`LIST`

CustomViewConfigurationInfoApiV1

{
  "creationDate": "string",
  "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "indexInList": 0,
  "lastModifiedDate": "string",
  "name": "string",
  "userKey": "string"
}

Properties

Name	Type	Description	Restrictions
creationDate	string	the date on which this configuration was created	none
dataViewType	string	the type of entity that will be shown using this view, for example clients, groups etc.	none
encodedKey	string	the automatically generated encoded ID for this item	none
indexInList	number	index in list when there is more than one custom view for a given entity type	none
lastModifiedDate	string	the date on which this custom view was last modified	none
name	string	the name of this custom view	none
userKey	string	the encoded key of the user who created this custom view	none

Enumerated Values

Property	Value
dataViewType	`PORTAL_ACCOUNT_TRANSACTION`
dataViewType	`LOANS_AGING_ANALYSIS`
dataViewType	`CLOSED_ACCOUNTS`
dataViewType	`CLIENT_OVERVIEW`
dataViewType	`ADMIN_CENTRES`
dataViewType	`USER_NOTIFICATION_MESSAGES`
dataViewType	`LINE_OF_CREDIT`
dataViewType	`USER_OVERVIEW`
dataViewType	`CENTRE_OVERVIEW`
dataViewType	`REPAYMENT_REPAYMENTS_COLLECTION`
dataViewType	`GROUP_OVERVIEW`
dataViewType	`ACTIVITIES_LOOKUP`
dataViewType	`TRANSACTION`
dataViewType	`ADMIN_BRANCHES`
dataViewType	`GROUP`
dataViewType	`BRANCH_OVERVIEW`
dataViewType	`NOTIFICATION_MESSAGE`
dataViewType	`PORTFOLIO_REPORTS`
dataViewType	`GROUP_NOTIFICATION_MESSAGES`
dataViewType	`LOAN_ACCOUNT_SECURITIES_OVERVIEW`
dataViewType	`LINE_OF_CREDIT_OVERVIEW`
dataViewType	`CURRENCIES`
dataViewType	`REPAYMENT`
dataViewType	`TILL_TRANSACTIONS`
dataViewType	`ALL_TASKS`
dataViewType	`CENTRE`
dataViewType	`BRANCH`
dataViewType	`INDEX_RATES_LIST`
dataViewType	`USER_TASKS`
dataViewType	`DOCUMENT_TEMPLATES`
dataViewType	`SAVINGS_TRANSACTIONS_LOOKUP`
dataViewType	`LOAN_ACCOUNT_OVERVIEW`
dataViewType	`DEPOSITS_COLLECTION`
dataViewType	`USER`
dataViewType	`ADMIN_USERS`
dataViewType	`GROUP_TASKS`
dataViewType	`CLIENT`
dataViewType	`LOAN_TRANSACTIONS_LOOKUP`
dataViewType	`LOANS`
dataViewType	`LOANS_REPAYMENTS_COLLECTION`
dataViewType	`CLIENT_TASKS`
dataViewType	`OVERDRAFTS_AGING_ANALYSIS`
dataViewType	`LOAN_ACCOUNT_FUNDING_OVERVIEW`
dataViewType	`SAVINGS`
dataViewType	`SAVINGS_OVERVIEW`
dataViewType	`JOURNAL_ENTRY`
dataViewType	`CLIENT_NOTIFICATION_MESSAGES`

CustomViewEntitiesSummaryWrapperApiV1

{
  "count": "string",
  "totals": [
    {
      "customFieldValues": {
        "property1": {},
        "property2": {}
      },
      "dataItemType": "WRITTEN_OFF_LOANS",
      "values": {
        "property1": {},
        "property2": {}
      }
    }
  ]
}

Properties

Name	Type	Description	Restrictions
count	string	none	none
totals	[SummaryTotalsWrapperApiV1]	none	none

CustomViewFilterApiV1

{
  "customConfigurationInfo": {
    "creationDate": "string",
    "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "indexInList": 0,
    "lastModifiedDate": "string",
    "name": "string",
    "userKey": "string"
  },
  "encodedKey": "string",
  "filterConstraints": [
    {
      "customFieldKey": "string",
      "dataFieldType": "NATIVE",
      "dataFieldValue": "string",
      "dataItemType": "WRITTEN_OFF_LOANS",
      "dataType": "ENUM",
      "encodedKey": "string",
      "filterElement": "STARTS_WITH_CASE_SENSITIVE",
      "groupNumber": 0,
      "index": 0,
      "linkingOperator": "OR",
      "secondValue": "string",
      "value": "string"
    }
  ]
}

Properties

Name	Type	Description	Restrictions
customConfigurationInfo	CustomViewConfigurationInfoApiV1	none	none
encodedKey	string	the automatically generated ID for this item	none
filterConstraints	[CustomFilterConstraintApiV1]	none	none

DataMigrationEventApiV1

{
  "creationDate": "2019-08-24T14:15:22Z",
  "encodedKey": "string",
  "numCentresImported": 0,
  "numClientsImported": 0,
  "numGLAccountsImported": 0,
  "numGroupsImported": 0,
  "numLoanRepaymentsImported": 0,
  "numLoanTransactionsImported": 0,
  "numLoansImported": 0,
  "numSavingsImported": 0,
  "state": "REVERTED",
  "type": "IMPORT"
}

details about an import or export operation

Properties

Name	Type	Description	Restrictions
creationDate	string(date-time)	the date on which the data import was made	none
encodedKey	string	the encoded key of this data migration event	none
numCentresImported	number	the number of centres which were imported during the data migration	none
numClientsImported	number	the number of clients which were imported as part of the data migration	none
numGLAccountsImported	number	the number of general ledger accounts which were imported as part of the data migration	none
numGroupsImported	number	the number of groups which were imported as part of the data migration	none
numLoanRepaymentsImported	number	the number of loan repayment transations which were imported as part of the data migration	none
numLoanTransactionsImported	number	the number of loan transactions which were imported as part of the data migration	none
numLoansImported	number	the number of loan accounts which were imported as part of the data migration	none
numSavingsImported	number	the number of savings accounts which were imported as part of the data migration	none
state	string	whether the data import was accepted, is still in a draft state, or was rejected and all data reverted	none
type	string	the type of migration event	none

Enumerated Values

Property	Value
state	`REVERTED`
state	`DRAFT`
state	`APPROVED`
type	`IMPORT`
type	`EXPORT`

DateDTOApiV1

{
  "dayOfMonth": 0,
  "monthOfYear": 0,
  "year": 0
}

Properties

Name	Type	Description	Restrictions
dayOfMonth	number	the day of the month	none
monthOfYear	number	the month	none
year	number	the year	none

DecimalIntervalConstraintsApiV1

{
  "defaultValue": 0,
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "maxValue": 0,
  "minValue": 0
}

Properties

Name	Type	Description	Restrictions
defaultValue	number	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
maxValue	number	none	none
minValue	number	none	none

DisbursementDetailsApiV1

{
  "customInformation": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "disbursementDate": "string",
  "encodedKey": "string",
  "expectedDisbursementDate": "string",
  "fees": [
    {
      "amount": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "fee": {
        "active": true,
        "amortizationIntervalSettings": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
          "intervalCount": 0,
          "intervalType": "FULL_TERM",
          "periodCount": 0,
          "periodUnit": "MONTHS"
        },
        "amortizationProfile": "STRAIGHT_LINE",
        "amount": 0,
        "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
        "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
        "creationDate": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
        "feeApplication": "OPTIONAL",
        "feeProductRules": [
          {
            "account": {
              "activated": true,
              "allowManualJournalEntries": true,
              "balance": 0,
              "creationDate": "2019-08-24T14:15:22Z",
              "currency": {
                "code": "string",
                "creationDate": "string",
                "currencySymbolPosition": "AFTER_NUMBER",
                "digitsAfterDecimal": 0,
                "isBaseCurrency": true,
                "lastModifiedDate": "string",
                "name": "string",
                "symbol": "string"
              },
              "description": "string",
              "encodedKey": "string",
              "glCode": "string",
              "lastModifiedDate": "2019-08-24T14:15:22Z",
              "migrationEvent": {
                "creationDate": "2019-08-24T14:15:22Z",
                "encodedKey": "string",
                "numCentresImported": 0,
                "numClientsImported": 0,
                "numGLAccountsImported": 0,
                "numGroupsImported": 0,
                "numLoanRepaymentsImported": 0,
                "numLoanTransactionsImported": 0,
                "numLoansImported": 0,
                "numSavingsImported": 0,
                "state": "REVERTED",
                "type": "IMPORT"
              },
              "name": "string",
              "stripTrailingZeros": true,
              "type": "INCOME",
              "usage": "HEADER"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "financialResource": "FEE_RECEIVABLE",
            "index": 0,
            "predefinedFeeKey": "string",
            "productKey": "string",
            "productType": "LOAN",
            "transactionChannelKey": "string"
          }
        ],
        "name": "string",
        "percentageAmount": 0,
        "trigger": "DISBURSEMENT"
      }
    }
  ],
  "firstRepaymentDate": "string",
  "transactionDetails": {
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "internalTransfer": true,
    "targetSavingsAccountKey": "string",
    "transactionChannel": {
      "activated": true,
      "createdByUserKey": "string",
      "creationDate": "string",
      "customFields": [
        {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        }
      ],
      "encodedKey": "string",
      "id": "string",
      "index": 0,
      "loanConstraints": {
        "customConfigurationInfo": {
          "creationDate": "string",
          "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "shared": true,
          "userKey": "string"
        },
        "encodedKey": "string",
        "filterConstraints": [
          {
            "customFieldKey": "string",
            "dataFieldType": "NATIVE",
            "dataFieldValue": "string",
            "dataItemType": "WRITTEN_OFF_LOANS",
            "dataType": "ENUM",
            "encodedKey": "string",
            "filterElement": "STARTS_WITH_CASE_SENSITIVE",
            "groupNumber": 0,
            "index": 0,
            "linkingOperator": "OR",
            "secondValue": "string",
            "value": "string"
          }
        ]
      },
      "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
      "name": "string",
      "savingsConstraints": {
        "customConfigurationInfo": {
          "creationDate": "string",
          "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "shared": true,
          "userKey": "string"
        },
        "encodedKey": "string",
        "filterConstraints": [
          {
            "customFieldKey": "string",
            "dataFieldType": "NATIVE",
            "dataFieldValue": "string",
            "dataItemType": "WRITTEN_OFF_LOANS",
            "dataType": "ENUM",
            "encodedKey": "string",
            "filterElement": "STARTS_WITH_CASE_SENSITIVE",
            "groupNumber": 0,
            "index": 0,
            "linkingOperator": "OR",
            "secondValue": "string",
            "value": "string"
          }
        ]
      },
      "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
      "transactionChannelAccountingRule": {
        "account": {
          "activated": true,
          "allowManualJournalEntries": true,
          "balance": 0,
          "creationDate": "2019-08-24T14:15:22Z",
          "currency": {
            "code": "string",
            "creationDate": "string",
            "currencySymbolPosition": "AFTER_NUMBER",
            "digitsAfterDecimal": 0,
            "isBaseCurrency": true,
            "lastModifiedDate": "string",
            "name": "string",
            "symbol": "string"
          },
          "description": "string",
          "encodedKey": "string",
          "glCode": "string",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "migrationEvent": {
            "creationDate": "2019-08-24T14:15:22Z",
            "encodedKey": "string",
            "numCentresImported": 0,
            "numClientsImported": 0,
            "numGLAccountsImported": 0,
            "numGroupsImported": 0,
            "numLoanRepaymentsImported": 0,
            "numLoanTransactionsImported": 0,
            "numLoansImported": 0,
            "numSavingsImported": 0,
            "state": "REVERTED",
            "type": "IMPORT"
          },
          "name": "string",
          "stripTrailingZeros": true,
          "type": "INCOME",
          "usage": "HEADER"
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "financialResource": "FEE_RECEIVABLE",
        "index": 0,
        "predefinedFeeKey": "string",
        "productKey": "string",
        "productType": "LOAN",
        "transactionChannelKey": "string"
      },
      "usageRights": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "isAccessibleByAllUsers": true,
        "roles": [
          "string"
        ]
      }
    },
    "transactionChannelKey": "string"
  }
}

Properties

Name	Type	Description	Restrictions
customInformation	[CustomFieldValueApiV1]	custom field definitions associated with this disbursement	none
disbursementDate	string	the date on which the loan was disbursed	none
encodedKey	string	the automatically generated ID for this disbursement	none
expectedDisbursementDate	string	the date on which this disbursement is expected to take place	none
fees	[CustomPredefinedFeeApiV1]	a list of fees associated with the disbursement	none
firstRepaymentDate	string	the date of the first repayment for the loan	none
transactionDetails	TransactionDetailsApiV1	none	none

DisbursementDetailsPatch

{
  "expectedDisbursementDate": "string",
  "firstRepaymentDate": "string"
}

Properties

Name	Type	Description	Restrictions
expectedDisbursementDate	string	the new expected date the loan will be disbursed	none
firstRepaymentDate	string	the new date on which the first repayment will become due	none

DocumentApiV1

{
  "createdByUserKey": "string",
  "creationDate": "string",
  "description": "string",
  "documentHolderKey": "string",
  "documentHolderType": "BRANCH",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "fileSize": 0,
  "id": 0,
  "lastModifiedDate": "string",
  "location": "string",
  "name": "string",
  "originalFilename": "string",
  "type": "string",
  "userName": "string"
}

Properties

Name	Type	Description	Restrictions
createdByUserKey	string	the encoded key of the user who added this document	none
creationDate	string	the date and time when this document was created	none
description	string	a description of this document	none
documentHolderKey	string	the encoded key of the entity to which this document is attached	none
documentHolderType	string	the type of entity, eg. client, loan product, to which this document is attached	none
encodedKey	string	the automatically generated encoded ID for this item	none
fileSize	number	the size, in bytes, of the attached document	none
id	number	an ID for this document	none
lastModifiedDate	string	the date on which this document was last modified	none
location	string	indicates where the document is saved	none
name	string	the display name of this document	none
originalFilename	string	the name of the originally uploaded file	none
type	string	the file type of the document, eg. png, jpeg, pdf	none
userName	string	the name of the user who uploaded the document	none

Enumerated Values

Property	Value
documentHolderType	`BRANCH`
documentHolderType	`LOAN_ACCOUNT`
documentHolderType	`GROUP`
documentHolderType	`DEPOSIT_ACCOUNT`
documentHolderType	`LINE_OF_CREDIT`
documentHolderType	`LOAN_PRODUCT`
documentHolderType	`GL_JOURNAL_ENTRY`
documentHolderType	`SAVINGS_PRODUCT`
documentHolderType	`USER`
documentHolderType	`CLIENT`
documentHolderType	`CENTRE`
documentHolderType	`ID_DOCUMENT`

DocumentExpandedApiV1

{
  "document": {
    "createdByUserKey": "string",
    "creationDate": "string",
    "description": "string",
    "documentHolderKey": "string",
    "documentHolderType": "BRANCH",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "fileSize": 0,
    "id": 0,
    "lastModifiedDate": "string",
    "location": "string",
    "name": "string",
    "originalFilename": "string",
    "type": "string",
    "userName": "string"
  },
  "documentContent": "string"
}

Properties

Name	Type	Description	Restrictions
document	DocumentApiV1	none	none
documentContent	string	the actual content of the document as a base64 encoded string	none

DocumentForAccountApiV1

{
  "createdByUserKey": "string",
  "creationDate": "string",
  "description": "string",
  "documentHolder": {
    "accountHolderType": "CLIENT",
    "displayName": "ABC111",
    "encodedKey": "8a19b6e4746cc6abf1746cf1436c00c5",
    "holderkey": "8a193c262f3b51b701722d77c5e423b7",
    "type": "LOAN"
  },
  "documentHolderKey": "string",
  "documentHolderType": "SAVINGS_ACCOUNT",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "fileSize": "string",
  "id": "string",
  "lastModifiedDate": "string",
  "location": "string",
  "name": "string",
  "originalFilename": "string",
  "type": "string",
  "userName": "string"
}

DocumentForAccountApiV1

Properties

Name	Type	Description	Restrictions
createdByUserKey	string	the encoded key of the Mambu user who added the document	none
creationDate	string	the date and time when this document was created	none
description	string	a description of this document	none
documentHolder	DocumentHolderAccountApiV1	none	none
documentHolderKey	string	the encoded key of the owner of this document, for exmaple, the client or group	none
documentHolderType	string	the type of entity to which this document belongs, ie savings or loan account	none
encodedKey	string	the automatically generated encoded ID for this item	none
fileSize	string	the size, in bytes, of this document	none
id	string	the document ID	none
lastModifiedDate	string	the date on which this document was last modified	none
location	string	the location where this document is stored	none
name	string	the name of the document, if provided	none
originalFilename	string	the original name of the uploaded file	none
type	string	the file type of the document, eg. PDF, PNG, JPEG	none
userName	string	the name of the Mambu user who originally uploaded the document	none

Enumerated Values

Property	Value
documentHolderType	`SAVINGS_ACCOUNT`
documentHolderType	`LOAN_ACCOUNT`

DocumentHolderAccountApiV1

{
  "accountHolderType": "CLIENT",
  "displayName": "ABC111",
  "encodedKey": "8a19b6e4746cc6abf1746cf1436c00c5",
  "holderkey": "8a193c262f3b51b701722d77c5e423b7",
  "type": "LOAN"
}

DocumentHolderAccountApiV1

Properties

Name	Type	Description	Restrictions
accountHolderType	string	the type of entity that owns the document	none
displayName	string	the ID of the account to which the document relates	none
encodedKey	string	the encoded key of the account to which the document relates	none
holderkey	string	the encoded key of the document owner	none
type	string	the type of account that the document belongs to	none

Enumerated Values

Property	Value
accountHolderType	`CLIENT`
accountHolderType	`GROUP`
type	`LOAN`
type	`SAVINGS`

DocumentTemplateApiV1

{
  "creationDate": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "lastModifiedDate": "string",
  "name": "string",
  "type": "ACCOUNT"
}

Properties

Name	Type	Description	Restrictions
creationDate	string	the date and time when this document was created	none
encodedKey	string	the automatically generated encoded ID for this item	none
lastModifiedDate	string	the date on which this document template was last modified	none
name	string	the name of the document template	none
type	string	the type of template, this will have an impact on what data is available to the template as placeholders	none

Enumerated Values

Property	Value
type	`ACCOUNT`
type	`ACCOUNT_WITH_TRANSACTIONS`
type	`TRANSACTION`

Duplicate-Client-Check

{
  "active": true,
  "dataField": "string",
  "dataItemType": "CLIENT",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "groupIndex": 0
}

Duplicate-Client-Check

Properties

Name	Type	Description	Restrictions
active	boolean	whether this rule is currently active	none
dataField	string	what field will be checked by this rule	none
dataItemType	string	what kind of entity this check will be performed on	none
encodedKey	string	the automatically generated encoded ID for this item	none
groupIndex	number	index in list if there are multiple checks for the same entity	none

Enumerated Values

Property	Value
dataItemType	`CLIENT`
dataItemType	`IDENTIFICATION_DOCUMENT`

DuplicateFieldConstraintApiV1

{
  "active": true,
  "dataField": "string",
  "dataItemType": "WRITTEN_OFF_LOANS",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "groupIndex": 0
}

Properties

Name	Type	Description	Restrictions
active	boolean	whether this rule is active	none
dataField	string	what field is covered by this rule	none
dataItemType	string	what kind of entity this rule relates to	none
encodedKey	string	the automatically generated encoded ID for this item	none
groupIndex	number	index in list when there are mutliple rules for the same entity	none

Enumerated Values

Property	Value
dataItemType	`WRITTEN_OFF_LOANS`
dataItemType	`LINE_OF_CREDIT`
dataItemType	`INVESTOR_FUND`
dataItemType	`TRANSACTION_DETAILS`
dataItemType	`DOCUMENT_TEMPLATE`
dataItemType	`PRODUCT`
dataItemType	`MCC_EXPIRATION`
dataItemType	`CENTRE`
dataItemType	`REPAYMENT_COLLECTION`
dataItemType	`TASK`
dataItemType	`OUTSTANDING_PORTFOLIO_AMOUNTS`
dataItemType	`REVENUE`
dataItemType	`COMPOSED_TRANSACTIONS`
dataItemType	`UNION_TRANSACTIONS`
dataItemType	`PRINCIPAL_PAYMENT_SETTINGS`
dataItemType	`LOANS`
dataItemType	`DISBURSEMENT_DETAILS`
dataItemType	`SAVINGS_TRANSACTION`
dataItemType	`IDENTIFICATION_DOCUMENT`
dataItemType	`LOAN_PRODUCT`
dataItemType	`DISBURSED_LOANS`
dataItemType	`LOAN_GROUP`
dataItemType	`TRANSACTION_CHANNEL`
dataItemType	`CUSTOM_PREDEFINED_FEE`
dataItemType	`JOURNAL_ENTRY`
dataItemType	`ATTACHMENT`
dataItemType	`PREDEFINED_FEE`
dataItemType	`TRANCHE`
dataItemType	`TRANSACTION`
dataItemType	`INDEX_RATE_SOURCE`
dataItemType	`GROUP_ROLE`
dataItemType	`LOAN_TRANSACTION`
dataItemType	`CLIENT_ROLE`
dataItemType	`GROUP`
dataItemType	`NOTIFICATION_MESSAGE`
dataItemType	`OUTSTANDING_PORTFOLIO_ACCOUNTS`
dataItemType	`REPAYMENT`
dataItemType	`LOAN_ACCOUNT_GUARANTY`
dataItemType	`BRANCH`
dataItemType	`CURRENCY`
dataItemType	`CARD_TRANSACTION_REVERSAL`
dataItemType	`INTEREST_PRODUCT_SETTINGS`
dataItemType	`CREATED_ACCOUNTS`
dataItemType	`USER`
dataItemType	`SAVINGS_PRODUCT`
dataItemType	`CLIENT`
dataItemType	`PRODUCT_ARREARS_SETTINGS`
dataItemType	`SAVINGS`
dataItemType	`EXPENSE`
dataItemType	`INDEX_RATE`
dataItemType	`NOTIFICATION_TEMPLATE`
dataItemType	`CUSTOM_FIELD_SELECTION`
dataItemType	`ACTIVITY`
dataItemType	`INTEREST_ACCRUAL_BREAKDOWN`

EncodedKeyAndIdRoleApiV1

{
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "id": "string"
}

Properties

Name	Type	Description	Restrictions
encodedKey	string	the automatically generated encoded ID for this item	none
id	string	the user generated or provided ID for this item	none

ExchangeRateApiV1

{
  "buyRate": 0,
  "encodedKey": "string",
  "endDate": "2019-08-24T14:15:22Z",
  "fromCurrencyCode": "string",
  "sellRate": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "toCurrencyCode": "string",
  "userKey": "string"
}

Properties

Name	Type	Description	Restrictions
buyRate (required)	number	The amount the currency will be bought compared to the base currency.	none
encodedKey	string	a unique key for this exchange rate	none
endDate	string(date-time)	the date and time at which this rate was replaced by a newer one	none
fromCurrencyCode	string	the currency code from which the currency will be exchanged	none
sellRate (required)	number	The amount the currency will be sold to base currency.	none
startDate (required)	string(date-time)	The date from which the exchange rate will be valid. Must not be in the future or before the latest exchange rate's (for that currency) start date. If not provided, the organization current date and time will be used.	none
toCurrencyCode	string	the currency code into which the currency will be exchanged	none
userKey	string	the encoded key of the user who created the exchange rate	none

ExecutionStatusApiV1

{
  "errorSource": "string",
  "returnCode": 0,
  "returnStatus": "string"
}

Properties

Name	Type	Description	Restrictions
errorSource	string	a human-readable description of the error	none
returnCode (required)	integer	a numeric error code	none
returnStatus (required)	string	a machine-readable description of the error	none

FeeRequestApiV1

{
  "amount": 0,
  "encodedKey": "string"
}

Properties

Name	Type	Description	Restrictions
amount	number	none	none
encodedKey	string	none	none

FieldColumnApiV1

{
  "customField": {
    "amounts": {
      "property1": 0,
      "property2": 0
    },
    "builtInCustomFieldId": "MOBILE_PHONE",
    "creationDate": "string",
    "customFieldProductSettings": [
      {
        "customFieldEncodedKey": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "isDefault": true,
        "isRequired": true,
        "linkType": "CLIENT_ROLE",
        "productKey": "string"
      }
    ],
    "customFieldSelectionOptions": [
      {
        "constraint": {
          "customFieldKey": "string",
          "dataFieldType": "NATIVE",
          "dataFieldValue": "string",
          "dataItemType": "WRITTEN_OFF_LOANS",
          "dataType": "ENUM",
          "encodedKey": "string",
          "filterElement": "STARTS_WITH_CASE_SENSITIVE",
          "groupNumber": 0,
          "index": 0,
          "linkingOperator": "OR",
          "secondValue": "string",
          "value": "string"
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "score": 0,
        "value": "string"
      }
    ],
    "customFieldSet": {
      "builtInType": "DETAILS",
      "createdDate": "string",
      "customFields": [
        {}
      ],
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "id": "string",
      "indexInList": 0,
      "lastModifiedDate": "string",
      "name": "string",
      "notes": "string",
      "type": "USER_INFO",
      "usage": "SINGLE"
    },
    "dataType": "GROUP_LINK",
    "description": "string",
    "editRights": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "isAccessibleByAllUsers": true,
      "roles": [
        "string"
      ]
    },
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "id": "string",
    "indexInList": 0,
    "isDefault": true,
    "isRequired": true,
    "lastModifiedDate": "string",
    "name": "string",
    "state": "DEACTIVATED",
    "type": "USER_INFO",
    "unique": true,
    "validationPattern": "string",
    "valueLength": "SHORT",
    "values": [
      "string"
    ],
    "viewRights": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "isAccessibleByAllUsers": true,
      "roles": [
        "string"
      ]
    }
  },
  "dataField": "string",
  "dataItemType": "WRITTEN_OFF_LOANS",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472"
}

Properties

Name	Type	Description	Restrictions
customField	CustomFieldApiV1	none	none
dataField	string	none	none
dataItemType	string	the type of data which is displayed in this column	none
encodedKey	string	the automatically generated encoded ID for this item	none

Enumerated Values

Property	Value
dataItemType	`WRITTEN_OFF_LOANS`
dataItemType	`LINE_OF_CREDIT`
dataItemType	`INVESTOR_FUND`
dataItemType	`TRANSACTION_DETAILS`
dataItemType	`DOCUMENT_TEMPLATE`
dataItemType	`PRODUCT`
dataItemType	`MCC_EXPIRATION`
dataItemType	`CENTRE`
dataItemType	`REPAYMENT_COLLECTION`
dataItemType	`TASK`
dataItemType	`OUTSTANDING_PORTFOLIO_AMOUNTS`
dataItemType	`REVENUE`
dataItemType	`COMPOSED_TRANSACTIONS`
dataItemType	`UNION_TRANSACTIONS`
dataItemType	`PRINCIPAL_PAYMENT_SETTINGS`
dataItemType	`LOANS`
dataItemType	`DISBURSEMENT_DETAILS`
dataItemType	`SAVINGS_TRANSACTION`
dataItemType	`IDENTIFICATION_DOCUMENT`
dataItemType	`LOAN_PRODUCT`
dataItemType	`DISBURSED_LOANS`
dataItemType	`LOAN_GROUP`
dataItemType	`TRANSACTION_CHANNEL`
dataItemType	`CUSTOM_PREDEFINED_FEE`
dataItemType	`JOURNAL_ENTRY`
dataItemType	`ATTACHMENT`
dataItemType	`PREDEFINED_FEE`
dataItemType	`TRANCHE`
dataItemType	`TRANSACTION`
dataItemType	`INDEX_RATE_SOURCE`
dataItemType	`GROUP_ROLE`
dataItemType	`LOAN_TRANSACTION`
dataItemType	`CLIENT_ROLE`
dataItemType	`GROUP`
dataItemType	`NOTIFICATION_MESSAGE`
dataItemType	`OUTSTANDING_PORTFOLIO_ACCOUNTS`
dataItemType	`REPAYMENT`
dataItemType	`LOAN_ACCOUNT_GUARANTY`
dataItemType	`BRANCH`
dataItemType	`CURRENCY`
dataItemType	`CARD_TRANSACTION_REVERSAL`
dataItemType	`INTEREST_PRODUCT_SETTINGS`
dataItemType	`CREATED_ACCOUNTS`
dataItemType	`USER`
dataItemType	`SAVINGS_PRODUCT`
dataItemType	`CLIENT`
dataItemType	`PRODUCT_ARREARS_SETTINGS`
dataItemType	`SAVINGS`
dataItemType	`EXPENSE`
dataItemType	`INDEX_RATE`
dataItemType	`NOTIFICATION_TEMPLATE`
dataItemType	`CUSTOM_FIELD_SELECTION`
dataItemType	`ACTIVITY`

FilterApiV1

{
  "filterConstraints": [
    {
      "dataFieldType": "string",
      "dataItemType": "string",
      "filterElement": "string",
      "filterSelection": "string",
      "secondValue": "string",
      "value": "string",
      "values": [
        "string"
      ]
    }
  ],
  "sortDetails": {
    "dataFieldType": "string",
    "dataItemType": "string",
    "sortingColumn": "string",
    "sortingOrder": "string"
  }
}

Properties

Name	Type	Description	Restrictions
filterConstraints	[FilterConstraintsApiV1]	none	none
sortDetails	SortDetailsApiV1	none	none

FilterConstraintsApiV1

{
  "dataFieldType": "string",
  "dataItemType": "string",
  "filterElement": "string",
  "filterSelection": "string",
  "secondValue": "string",
  "value": "string",
  "values": [
    "string"
  ]
}

Properties

Name	Type	Description	Restrictions
dataFieldType	string	none	none
dataItemType	string	none	none
filterElement	string	none	none
filterSelection	string	none	none
secondValue	string	none	none
value	string	none	none
values	[string]	none	none

GLAccountApiV1

{
  "activated": true,
  "allowManualJournalEntries": true,
  "balance": 0,
  "creationDate": "2019-08-24T14:15:22Z",
  "currency": {
    "code": "string",
    "creationDate": "string",
    "currencySymbolPosition": "AFTER_NUMBER",
    "digitsAfterDecimal": 0,
    "isBaseCurrency": true,
    "lastModifiedDate": "string",
    "name": "string",
    "symbol": "string"
  },
  "description": "string",
  "encodedKey": "string",
  "glCode": "string",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "migrationEvent": {
    "creationDate": "2019-08-24T14:15:22Z",
    "encodedKey": "string",
    "numCentresImported": 0,
    "numClientsImported": 0,
    "numGLAccountsImported": 0,
    "numGroupsImported": 0,
    "numLoanRepaymentsImported": 0,
    "numLoanTransactionsImported": 0,
    "numLoansImported": 0,
    "numSavingsImported": 0,
    "state": "REVERTED",
    "type": "IMPORT"
  },
  "name": "string",
  "stripTrailingZeros": true,
  "type": "INCOME",
  "usage": "HEADER"
}

A general ledger account

Properties

Name	Type	Description	Restrictions
activated	boolean	whether this general ledger account is in use	none
allowManualJournalEntries	boolean	whether manual entries are allowed for this general ledger account	none
balance	number	the current balance of this general ledger account	none
creationDate	string(date-time)	the date on which this general ledger account was created	read-only
currency	CurrencyApiV1	none	none
description	string	an optional description for this general ledger account	none
encodedKey	string	the encoded key of this general ledger account	none
glCode	string	the numeric code for this general ledger account	none
lastModifiedDate	string(date-time)	the date on which this general ledger account was last modified	read-only
migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
name	string	the name of this general ledger account	none
stripTrailingZeros	boolean	controls how this account is organized into header accounts when there are trailing zeroes, for example, for the account code `1100`, if this field is set to true, only the first two numbers will be recognised	none
type	string	the type of general ledger account	none
usage	string	whether this general ledger account is a `DETAIL` account, in which case it will have a value, or a `HEADER` account, in which case its value will be calculated based on the sum of detail accounts under it.	none

Enumerated Values

Property	Value
type	`INCOME`
type	`EXPENSE`
type	`LIABILITY`
type	`ASSET`
type	`EQUITY`
usage	`HEADER`
usage	`DETAIL`

GLAccountingRuleApiV1

{
  "account": {
    "activated": true,
    "allowManualJournalEntries": true,
    "balance": 0,
    "creationDate": "2019-08-24T14:15:22Z",
    "currency": {
      "code": "string",
      "creationDate": "string",
      "currencySymbolPosition": "AFTER_NUMBER",
      "digitsAfterDecimal": 0,
      "isBaseCurrency": true,
      "lastModifiedDate": "string",
      "name": "string",
      "symbol": "string"
    },
    "description": "string",
    "encodedKey": "string",
    "glCode": "string",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "name": "string",
    "stripTrailingZeros": true,
    "type": "INCOME",
    "usage": "HEADER"
  },
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "financialResource": "FEE_RECEIVABLE",
  "index": 0,
  "predefinedFeeKey": "string",
  "productKey": "string",
  "productType": "LOAN",
  "transactionChannelKey": "string"
}

Properties

Name	Type	Description	Restrictions
account	GLAccountApiV1	A general ledger account	none
encodedKey	string	the automatically generated encoded ID for this item	none
financialResource	string	the type of transaction governed by this rule	none
index	number	the index in list when there are multiple rules for the same type of transaction	none
predefinedFeeKey	string	the encoded key of the predefined key this rule relates to	none
productKey	string	the encoded key of the product this rule relates to	none
productType	string	the type of account this rule relates to	none
transactionChannelKey	string	the encoded key of the transaction channel that this rule relates to	none

Enumerated Values

Property	Value
financialResource	`FEE_RECEIVABLE`
financialResource	`OVERDRAFT_INTEREST_INCOME`
financialResource	`OVERDRAFT_INTEREST_RECEIVABLE`
financialResource	`FEE_INCOME`
financialResource	`INTEREST_PAYABLE`
financialResource	`INTEREST_EXPENSE`
financialResource	`PENALTY_RECEIVABLE`
financialResource	`INTEREST_INCOME`
financialResource	`DEFERRED_TAXES`
financialResource	`DEFERRED_FEE_INCOME`
financialResource	`PORTFOLIO_CONTROL`
financialResource	`DEFERRED_INTERESTS_INCOME`
financialResource	`OVERDRAFT_WRITE_OFF_EXPENSE`
financialResource	`PENALTY_INCOME`
financialResource	`OVERDRAFT_PORTFOLIO_CONTROL`
financialResource	`SAVINGS_CONTROL`
financialResource	`TAXES_RECEIVABLE`
financialResource	`INTEREST_RECEIVABLE`
financialResource	`INTER_BRANCH_TRANSFER`
financialResource	`FUND_SOURCE`
financialResource	`WRITE_OFF_EXPENSE`
financialResource	`DEPOSIT_REFERENCE`
financialResource	`TAXES_PAYABLE`
productType	`LOAN`
productType	`SAVINGS`

GLJournalEntryApiV1

{
  "accountKey": "string",
  "amount": 0,
  "assignedBranchKey": "string",
  "bookingDate": "string",
  "creationDate": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "entryDate": "string",
  "entryID": 0,
  "glAccount": {
    "activated": true,
    "allowManualJournalEntries": true,
    "balance": 0,
    "creationDate": "2019-08-24T14:15:22Z",
    "currency": {
      "code": "string",
      "creationDate": "string",
      "currencySymbolPosition": "AFTER_NUMBER",
      "digitsAfterDecimal": 0,
      "isBaseCurrency": true,
      "lastModifiedDate": "string",
      "name": "string",
      "symbol": "string"
    },
    "description": "string",
    "encodedKey": "string",
    "glCode": "string",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "name": "string",
    "stripTrailingZeros": true,
    "type": "INCOME",
    "usage": "HEADER"
  },
  "notes": "string",
  "productKey": "string",
  "productType": "LOAN",
  "reversalEntryKey": "string",
  "transactionID": "string",
  "type": "CREDIT",
  "userKey": "string"
}

Properties

Name	Type	Description	Restrictions
accountKey	string	the encoded key of the loan or savings account that this journal entry relates to	none
amount	number	the amount of the journal entry	none
assignedBranchKey	string	the encoded key of the branch that this journal entry is associated with	none
bookingDate	string	the booking date of this journal entry	none
creationDate	string	the date and time when the transaction that caused this journal entry was created	none
encodedKey	string	the automatically generated encoded ID for this item	none
entryDate	string	the date on which this journal entry was entered into the ledger	none
entryID	number	a unique, incremental ID for ledger entries	none
glAccount	GLAccountApiV1	A general ledger account	none
notes	string	any notes relating to this journal entry	none
productKey	string	the product associated with this journal entry	none
productType	string	the type of product associated with this journal entry	none
reversalEntryKey	string	if this entry was subsequently revered by another journal entry, this field contains the encoded key of that journal entry	none
transactionID	string	the transaction ID that caused this journal entry. Please note, multiple journal entries can have the same transaction ID, for example, when a repayment goes to cover fees, princial, taxes etc.	none
type	string	whether this journal entry represents funds coming in or going out	none
userKey	string	the encoded key of the user who created this journal entry, if it was created manually	none

Enumerated Values

Property	Value
productType	`LOAN`
productType	`SAVINGS`
type	`CREDIT`
type	`DEBIT`

General-Holidays

{
  "creationDate": "2019-08-24T14:15:22Z",
  "dayOfMonth": 0,
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "isAnnualyRecurring": true,
  "keyId": "string",
  "monthOfYear": 0,
  "name": "string",
  "year": 0
}

General-Holidays

Properties

Name	Type	Description	Restrictions
creationDate	string(date-time)	the date and time when this holiday was created	none
dayOfMonth	number	the day of the month on which this holiday occurs	none
encodedKey	string	the automatically generated encoded ID for this item	none
isAnnualyRecurring	boolean	whether the holiday is a one-off or occurs every year	none
keyId	string	an internal ID for this holiday	none
monthOfYear	number	the month in which this holiday occurs	none
name	string	the name of this holiday	none
year	number	the year in this this holiday takes place	none

GeneralSettingsApiV1

{
  "approvalDisbursalTwoManRuleEnabled": true,
  "arrearsDaysBeforeWriteOff": 0,
  "assignmentConstraints": [
    "string"
  ],
  "automatedAccountingClosuresInterval": 0,
  "clientIDFormat": "string",
  "dateFormats": "string",
  "decimalSeperator": "string",
  "defaultClientRoleKey": "string",
  "defaultClientState": "string",
  "defaultGroupRoleKey": "string",
  "defaultLineOfCreditState": "string",
  "defaultTransactionChannelKey": "string",
  "duplicateClientChecks": [
    {
      "active": true,
      "dataField": "string",
      "dataItemType": "CLIENT",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "groupIndex": 0
    }
  ],
  "duplicateClientConstraintAction": "string",
  "enabledComponents": [
    "string"
  ],
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "eodProcessingMethod": "MANUAL",
  "exposireAmount": "string",
  "exposureType": "UNLIMITED",
  "generalHolidays": [
    {
      "creationDate": "2019-08-24T14:15:22Z",
      "dayOfMonth": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "isAnnualyRecurring": true,
      "keyId": "string",
      "monthOfYear": 0,
      "name": "string",
      "year": 0
    }
  ],
  "groupIDFormat": "string",
  "groupSizeLimitType": "string",
  "lineOfCreditIdFormat": "string",
  "maxAllowedIdDocumentAttachments": 0,
  "maxAllowedJournalEntryDocumentAttachments": 0,
  "maxAllowedUndoClosurePeriod": 0,
  "multipleGroupMembership": "string",
  "multipleLoans": "string",
  "nonWorkingDays": [
    {
      "creationDate": "string",
      "dayOfWeek": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472"
    }
  ],
  "otherIdDocumentsEnabled": true,
  "tillIDFormat": "string"
}

GeneralSettingsApiV1

Properties

Name	Type	Description	Restrictions
approvalDisbursalTwoManRuleEnabled	boolean	whether loan disbursals need to be approved by another Mambu user	none
arrearsDaysBeforeWriteOff	number	the number of days an account must be in arrears before the overdue loan is written off	none
assignmentConstraints	[string]	none	none
automatedAccountingClosuresInterval	number	the number of days between automatic accounting closures, if this is set to 0 closures will have to be made manually	none
clientIDFormat	string	the pattern for automatically generated client IDs where	none
dateFormats	string	the date and time format that will be used, eg DATE_TIME_FORMAT dd-MM-yyyy hh:mm	none
decimalSeperator	string	the character used to separate major and minor currency units as well as tenths, hundreths etc, such as for interest rates	none
defaultClientRoleKey	string	the default role assigned to new clients	none
defaultClientState	string	the default state a new client will be given when created	none
defaultGroupRoleKey	string	the encoded key of the default role which will be assigned when adding members to groups	none
defaultLineOfCreditState	string	the default state for new lines of credit	none
defaultTransactionChannelKey	string	the encoded key of the default channel which will be used for transactions	none
duplicateClientChecks	[Duplicate-Client-Check]	a list of checks that will be carried out when creating a new client to identify duplicates	none
duplicateClientConstraintAction	string	none	none
enabledComponents	[string]	a list of features which are enabled for this Mambu tenant	none
encodedKey	string	the automatically generated encoded ID for this item	none
eodProcessingMethod	string	whether end of day processing will be started automatically at midnight local time or manually	none
exposireAmount	string	a maximum exposure representing the most a given client can take out in loans	none
exposureType	string	whether a client can take out an unlimited amount in loans or there are constraints	none
generalHolidays	[General-Holidays]	a list of holidays applying to the whole organisation	none
groupIDFormat	string	the pattern that will be used when generating IDs for new groups	none
groupSizeLimitType	string	the maximum number of members who can be included in a group	none
lineOfCreditIdFormat	string	the pattern used to generate IDs for lines of credit	none
maxAllowedIdDocumentAttachments	number	the maximum number of ID documents that can be associated with one client	none
maxAllowedJournalEntryDocumentAttachments	number	the maximum number of documents that can be attached to one journal entry	none
maxAllowedUndoClosurePeriod	number	the number of days before it is no longer possible to undo a closed loan	none
multipleGroupMembership	string	whether a single client can be a member of multiple groups	none
multipleLoans	string	whether a single client can take out more than one loan	none
nonWorkingDays	[nonWorkingDays]	a list of non-working days	none
otherIdDocumentsEnabled	boolean	whether arbitrary ID documents can be attached to a client	none
tillIDFormat	string	the pattern used for generating IDs for tills	none

Enumerated Values

Property	Value
eodProcessingMethod	`MANUAL`
eodProcessingMethod	`AUTOMATIC`
exposureType	`UNLIMITED`
exposureType	`SUM_OF_LOANS`
exposureType	`SUM_OF_LOANS_MINUS_SAVINGS`

GroupApiV1

{
  "assignedBranchKey": "string",
  "assignedCentreKey": "string",
  "assignedUserKey": "string",
  "clientRole": {
    "encodedKey": "string"
  },
  "creationDate": "2019-08-24T14:15:22Z",
  "emailAddress": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "groupName": "string",
  "homePhone": "string",
  "id": "string",
  "idPattern": "string",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "loanCycle": 0,
  "migrationEvent": {
    "creationDate": "2019-08-24T14:15:22Z",
    "encodedKey": "string",
    "numCentresImported": 0,
    "numClientsImported": 0,
    "numGLAccountsImported": 0,
    "numGroupsImported": 0,
    "numLoanRepaymentsImported": 0,
    "numLoanTransactionsImported": 0,
    "numLoansImported": 0,
    "numSavingsImported": 0,
    "state": "REVERTED",
    "type": "IMPORT"
  },
  "mobilePhone1": "string",
  "preferredLanguage": "PORTUGESE"
}

A group object

Properties

Name	Type	Description	Restrictions
assignedBranchKey	string	the encoded key of the branch to which this group is assigned	none
assignedCentreKey	string	the encoded key of the centre to which this group is assigned	none
assignedUserKey	string	the encoded key of the Mambu user to which this group is assigned	none
clientRole	ClientRoleBasicApiV1	the type of client or group as defined in Mambu in Administration > General Settings > Client Types	none
creationDate	string(date-time)	the date and time when this group was created	read-only
emailAddress	string	the email address for this group. This address will be used for automated and manually sent email notifications	none
encodedKey	string	the automatically generated encoded ID for this group	none
groupName	string	the name of the group	none
homePhone	string	the primary landline contact number for this group	none
id	string	the ID for this group	none
idPattern	string	the pattern used to generate IDs	none
lastModifiedDate	string(date-time)	the date on which this group was last modified	read-only
loanCycle	number	this number will increment each time this group takes out and fully pays back a loan	none
migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
mobilePhone1	string	the primiary mobile contact number for this group	none
preferredLanguage	string	the language which shoudl ideally be used when communicating with this group	none

Enumerated Values

Property	Value
preferredLanguage	`PORTUGESE`
preferredLanguage	`RUSSIAN`
preferredLanguage	`ROMANIAN`
preferredLanguage	`ENGLISH`
preferredLanguage	`SPANISH`
preferredLanguage	`GEORGIAN`
preferredLanguage	`BURMESE`
preferredLanguage	`PHRASE`
preferredLanguage	`CHINESE`
preferredLanguage	`FRENCH`
preferredLanguage	`INDONESIAN`

GroupExpandedApiV1

{
  "addresses": [
    {
      "addressType": "string",
      "city": "string",
      "country": "string",
      "encodedKey": "string",
      "indexInList": 0,
      "latitude": 0,
      "line1": "string",
      "line2": "string",
      "longitude": 0,
      "parentKey": "string",
      "postcode": "string",
      "region": "string",
      "toBeDeleted": true
    }
  ],
  "customInformation": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "groupMembers": [
    {
      "clientKey": "string",
      "creationDate": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "groupKey": "string",
      "indexInList": 0
    }
  ],
  "groupRoles": [
    {
      "clientKey": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "groupKey": "string",
      "groupRoleNameKey": "string",
      "indexInList": 0,
      "roleName": "string"
    }
  ],
  "theGroup": {
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "clientRole": {
      "encodedKey": "string"
    },
    "creationDate": "2019-08-24T14:15:22Z",
    "emailAddress": "string",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "groupName": "string",
    "homePhone": "string",
    "id": "string",
    "idPattern": "string",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "loanCycle": 0,
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "mobilePhone1": "string",
    "preferredLanguage": "PORTUGESE"
  }
}

a group object with full details

Properties

Name	Type	Description	Restrictions
addresses	[AddressApiV1]	a list of addresses for this group	none
customInformation	[CustomFieldValueApiV1]	custom information associated with this group	none
groupMembers	[GroupMemberApiV1]	a list of members of this group	none
groupRoles	[GroupRoleApiV1]	a list of roles which members of this group can have	none
theGroup	GroupApiV1	A group object	none

GroupMemberApiV1

{
  "clientKey": "string",
  "creationDate": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "groupKey": "string",
  "indexInList": 0
}

Properties

Name	Type	Description	Restrictions
clientKey	string	the encoded key of this group member. Members must have an existing client record	none
creationDate	string	the date and time when this group member was added	none
encodedKey	string	the automatically generated encoded ID for this item	none
groupKey	string	the key of the group of which this client is a member	none
indexInList	number	if a group contains more than one member, this number represents the index in the list for this member	none

GroupRoleApiV1

{
  "clientKey": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "groupKey": "string",
  "groupRoleNameKey": "string",
  "indexInList": 0,
  "roleName": "string"
}

Properties

Name	Type	Description	Restrictions
clientKey	string	the encoded key of the group member who has this role	none
encodedKey	string	the automatically generated encoded ID for this item	none
groupKey	string	the encoded key of the group which uses this role	none
groupRoleNameKey	string	the encoded key of the group role	none
indexInList	number	none	none
roleName	string	the name of this role	none

GroupRoleNameApiV1

{
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "name": "string"
}

Properties

Name	Type	Description	Restrictions
encodedKey	string	the automatically generated encoded ID for this item	none
name	string	the name of this role	none

GuarantyApiV1

{
  "amount": 0,
  "assetName": "string",
  "customFieldValues": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "guarantorKey": "string",
  "guarantorType": "GROUP",
  "savingsAccountKey": "string",
  "type": "GUARANTOR"
}

Properties

Name	Type	Description	Restrictions
amount	number	the amount being guaranteed	none
assetName	string	the name of the asset being used as a guranty	none
customFieldValues	[CustomFieldValueApiV1]	a list of custom information for this guranty	none
encodedKey	string	the automatically generated encoded ID for this item	none
guarantorKey	string	the encoded key of the client acting as guarantor	none
guarantorType	string	the type of entity acting as gurantor, either client or group	none
savingsAccountKey	string	the encoded key of the savings account guranteeing the loan	none
type	string	the type of guarantor, either asset backed, an investor or private gurantor	none

Enumerated Values

Property	Value
guarantorType	`GROUP`
guarantorType	`CLIENT`
type	`GUARANTOR`
type	`INVESTOR`
type	`ASSET`

HolidayApiV1

{
  "creationDate": "string",
  "dayOfMonth": 0,
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "isAnnualyRecurring": true,
  "keyId": 0,
  "monthOfYear": 0,
  "name": "string",
  "year": 0
}

Properties

Name	Type	Description	Restrictions
creationDate	string	the date and time when this holdiay was created	none
dayOfMonth	number	the day of the month on which this holiday falls	none
encodedKey	string	the automatically generated encoded ID for this item	none
isAnnualyRecurring	boolean	whether this holiday takes place every year	none
keyId	number	none	none
monthOfYear	number	the month of the year in which this holiday takes place	none
name	string	the name of this holiday	none
year	number	the year in which this holiday takes place	none

IdentificationDocumentApiV1

{
  "clientKey": "string",
  "documentId": "string",
  "documentType": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "identificationDocumentTemplateKey": "string",
  "indexInList": 0,
  "issuingAuthority": "string",
  "toBeDeleted": true,
  "validUntil": "string",
  "validUntilDTOdate": {
    "dayOfMonth": 0,
    "monthOfYear": 0,
    "year": 0
  }
}

Properties

Name	Type	Description	Restrictions
clientKey	string	the encoded key of the client with which this ID document is associated	none
documentId	string	the ID	none
documentType	string	the type of document, eg. passport, ID card	none
encodedKey	string	the automatically generated encoded ID for this item	none
identificationDocumentTemplateKey	string	the ID template associated with this kind of ID	none
indexInList	number	if there is more than one ID document attached to a single entity, this number represents the index in the list of this particular document	none
issuingAuthority	string	the institution who provided this ID document, eg, Her Majesty's Passport Authority	none
toBeDeleted	boolean	whether this ID document is marked for deletion	none
validUntil	string	the last day on which this document can be used	none
validUntilDTOdate	DateDTOApiV1	none	none

IdentificationDocumentTemplateApiV1

{
  "allowAttachments": true,
  "documentIdTemplate": "string",
  "documentType": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "issuingAuthority": "string",
  "mandatoryForClients": true
}

Properties

Name	Type	Description	Restrictions
allowAttachments	boolean	whether there can be attachements for this ID document type, for example, a scanned copy or photograph	none
documentIdTemplate	string	none	none
documentType	string	the type of ID document, eg. passport, ID card	none
encodedKey	string	the automatically generated encoded ID for this item	none
issuingAuthority	string	the institution who provides this kind of ID document, eg. Driver and Vehicle Licencing Agency	none
mandatoryForClients	boolean	whether clients must provide this kind of ID when creating an account	none

IndexRateApiV1

{
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "notes": "string",
  "rate": 0,
  "rateSource": {
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "name": "string",
    "notes": "string",
    "type": "TAX_RATE"
  },
  "startDate": "string",
  "userKey": "string"
}

Properties

Name	Type	Description	Restrictions
encodedKey	string	the automatically generated encoded ID for this item	none
notes	string	any notes relating to this index rate	none
rate	number	the percentage rate for this tax or interest rate	none
rateSource	IndexRateSourceApiV1	none	none
startDate	string	the first day on which this rate is considered valid	none
userKey	string	the encoded key of the user who added this index rate	none

IndexRateSourceApiV1

{
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "name": "string",
  "notes": "string",
  "type": "TAX_RATE"
}

Properties

Name	Type	Description	Restrictions
encodedKey	string	the automatically generated encoded ID for this item	none
name	string	the name of this index rate source, eg. LIBOR	none
notes	string	any notes relating to this index rate	none
type	string	what kind of rate this source provides, eg. tax, interest, withholding tax	none

Enumerated Values

Property	Value
type	`TAX_RATE`
type	`INTEREST_RATE`
type	`WITHHOLDING_TAX_RATE`

InterestAccountSettingsApiV1

{
  "accrueInterestAfterMaturity": true,
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "interestChargeFrequency": "EVERY_WEEK",
  "interestChargeFrequencyCount": 0,
  "interestRate": 0,
  "interestRateReviewCount": 0,
  "interestRateReviewUnit": "MONTHS",
  "interestRateSource": "FIXED_INTEREST_RATE",
  "interestRateTerms": "TIERED_PERIOD",
  "interestRateTiers": [
    {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "endingBalance": 0,
      "endingDay": 0,
      "index": 0,
      "interestRate": 0
    }
  ],
  "interestSpread": 0
}

Properties

Name	Type	Description	Restrictions
accrueInterestAfterMaturity	boolean	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
interestChargeFrequency	string	none	none
interestChargeFrequencyCount	number	none	none
interestRate	number	none	none
interestRateReviewCount	number	none	none
interestRateReviewUnit	string	none	none
interestRateSource	string	none	none
interestRateTerms	string	none	none
interestRateTiers	[InterestRateTierApiV1]	none	none
interestSpread	number	none	none

Enumerated Values

Property	Value
interestChargeFrequency	`EVERY_WEEK`
interestChargeFrequency	`ANNUALIZED`
interestChargeFrequency	`EVERY_MONTH`
interestChargeFrequency	`EVERY_X_DAYS`
interestChargeFrequency	`EVERY_FOUR_WEEKS`
interestChargeFrequency	`EVERY_DAY`
interestRateReviewUnit	`MONTHS`
interestRateReviewUnit	`WEEKS`
interestRateReviewUnit	`DAYS`
interestRateSource	`FIXED_INTEREST_RATE`
interestRateSource	`INDEX_INTEREST_RATE`
interestRateTerms	`TIERED_PERIOD`
interestRateTerms	`FIXED`
interestRateTerms	`TIERED`

InterestProductSettingsApiV1

{
  "accrueInterestAfterMaturity": true,
  "defaultInterestRate": 0,
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "indexSourceKey": "string",
  "interestChargeFrequency": "EVERY_WEEK",
  "interestChargeFrequencyCount": 0,
  "interestRateCeilingValue": 0,
  "interestRateFloorValue": 0,
  "interestRateReviewCount": 0,
  "interestRateReviewUnit": "MONTHS",
  "interestRateSource": "FIXED_INTEREST_RATE",
  "interestRateTerms": "TIERED_PERIOD",
  "interestRateTiers": [
    {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "endingBalance": 0,
      "endingDay": 0,
      "index": 0,
      "interestRate": 0
    }
  ],
  "maxInterestRate": 0,
  "minInterestRate": 0
}

Properties

Name	Type	Description	Restrictions
accrueInterestAfterMaturity	boolean	none	none
defaultInterestRate	number	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
indexSourceKey	string	none	none
interestChargeFrequency	string	none	none
interestChargeFrequencyCount	number	none	none
interestRateCeilingValue	number	none	none
interestRateFloorValue	number	none	none
interestRateReviewCount	number	none	none
interestRateReviewUnit	string	none	none
interestRateSource	string	none	none
interestRateTerms	string	none	none
interestRateTiers	[InterestRateTierApiV1]	none	none
maxInterestRate	number	none	none
minInterestRate	number	none	none

Enumerated Values

Property	Value
interestChargeFrequency	`EVERY_WEEK`
interestChargeFrequency	`ANNUALIZED`
interestChargeFrequency	`EVERY_MONTH`
interestChargeFrequency	`EVERY_X_DAYS`
interestChargeFrequency	`EVERY_FOUR_WEEKS`
interestChargeFrequency	`EVERY_DAY`
interestRateReviewUnit	`MONTHS`
interestRateReviewUnit	`WEEKS`
interestRateReviewUnit	`DAYS`
interestRateSource	`FIXED_INTEREST_RATE`
interestRateSource	`INDEX_INTEREST_RATE`
interestRateTerms	`TIERED_PERIOD`
interestRateTerms	`FIXED`
interestRateTerms	`TIERED`

InterestRateTierApiV1

{
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "endingBalance": 0,
  "endingDay": 0,
  "index": 0,
  "interestRate": 0
}

Properties

Name	Type	Description	Restrictions
encodedKey	string	the automatically generated encoded ID for this item	none
endingBalance	number	none	none
endingDay	number	none	none
index	number	none	none
interestRate	number	none	none

InvestorFundApiV1

{
  "amount": 0,
  "assetName": "string",
  "customFieldValues": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "guarantorKey": "string",
  "guarantorType": "GROUP",
  "id": "string",
  "interestCommission": 0,
  "investmentPercentage": 0,
  "savingsAccountKey": "string",
  "type": "GUARANTOR"
}

An object containing information about people who may be acting as guarantor for a loan or collatoral being used, for more information please consult our p2p lending support article.

Properties

Name	Type	Description	Restrictions
amount	number	the amount being funded	none
assetName	string	the name of an asset being used as collatoral	none
customFieldValues	[CustomFieldValueApiV1]	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
guarantorKey	string	the encoded key of the client who is acting as guarantor	none
guarantorType	string	the type of guarantor, either a private individual or a group	none
id	string	the ID for this funding action	none
interestCommission	number	how much this funder shares in the interest generated by the loan	none
investmentPercentage	number	when the type of funding is `investor`, the percentage which will go back to them when repayments are made	none
savingsAccountKey	string	the savings account ID of the account being used to back a loan	none
type	string	the type of funder, either another client of the bank who is acting as guarantor, an asset being used as collatoral or an investor who shares in the interest generated by the loan	none

Enumerated Values

Property	Value
guarantorType	`GROUP`
guarantorType	`CLIENT`
type	`GUARANTOR`
type	`INVESTOR`
type	`ASSET`

JSONApplyManualFeeApiV1

{
  "amount": 0,
  "bookingDate": "string",
  "currencyCode": "string",
  "customInformation": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "date": "string",
  "fees": [
    {
      "amount": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472"
    }
  ],
  "firstRepaymentDate": "string",
  "method": "string",
  "notes": "string",
  "originalTransactionId": "string",
  "rate": 0,
  "repayment": 0,
  "type": "string",
  "valueDate": "string"
}

Properties

Name	Type	Description	Restrictions
amount	number	none	none
bookingDate	string	none	none
currencyCode	string	none	none
customInformation	[CustomFieldValueApiV1]	none	none
date	string	none	none
fees	[JsonFeeRequestApiV1]	none	none
firstRepaymentDate	string	none	none
method	string	none	none
notes	string	none	none
originalTransactionId	string	none	none
rate	number	none	none
repayment	number	none	none
type	string	none	none
valueDate	string	none	none

JSONFeeRequestApiV1

{
  "amount": 0,
  "encodedKey": "8a19b7057471f4af017472dc0fd80472"
}

Properties

Name	Type	Description	Restrictions
amount	number	none	none
encodedKey	string	the automatically generated encoded ID for this item	none

JSONLineOfCreditApiV1

{
  "lineOfCredit": {
    "amount": 0,
    "approvedDate": "string",
    "availableCreditAmount": 0,
    "clientKey": "string",
    "closedDate": "string",
    "creationDate": "string",
    "customInformation": [
      {
        "amount": 0,
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "customFieldID": "string",
        "customFieldKey": "string",
        "customFieldSetGroupIndex": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexInList": 0,
        "linkedEntityKeyValue": "string",
        "parentKey": "string",
        "selectionKey": "string",
        "value": "string"
      }
    ],
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "expireDate": "string",
    "exposureLimitType": "APPROVED_AMOUNT",
    "groupKey": "string",
    "id": "string",
    "idPattern": "string",
    "lastModifiedDate": "string",
    "notes": "string",
    "startDate": "string",
    "state": "WITHDRAWN",
    "subState": "WITHDRAWN"
  }
}

Properties

Name	Type	Description	Restrictions
lineOfCredit	LineOfCreditFullApiV1	none	none

JSONLoanRepaymentsApiV1

{
  "repayments": [
    {
      "dueDate": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "feesDue": 0,
      "feesUnappliedDue": 0,
      "interestDue": 0,
      "isPaymentHoliday": true,
      "parentAccountKey": "string",
      "penaltyDue": 0,
      "principalDue": 0
    }
  ]
}

Properties

Name	Type	Description	Restrictions
repayments	[PatchRepaymentApiV1]	none	none

JSONSavingsAccountApiV1

{
  "customInformation": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "savingsAccount": {
    "accountHolderKey": "string",
    "accountHolderType": "GROUP",
    "accountState": "WITHDRAWN",
    "accountType": "CURRENT_ACCOUNT",
    "accruedInterest": 0,
    "activationDate": "string",
    "allowOverdraft": true,
    "approvedDate": "string",
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "availableBalance": 0,
    "balance": 0,
    "closedDate": "string",
    "creationDate": "string",
    "currency": {
      "code": "string",
      "creationDate": "string",
      "currencySymbolPosition": "AFTER_NUMBER",
      "digitsAfterDecimal": 0,
      "isBaseCurrency": true,
      "lastModifiedDate": "string",
      "name": "string",
      "symbol": "string"
    },
    "currencyCode": "string",
    "customFieldValues": [
      {
        "amount": 0,
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "customFieldID": "string",
        "customFieldKey": "string",
        "customFieldSetGroupIndex": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexInList": 0,
        "linkedEntityKeyValue": "string",
        "parentKey": "string",
        "selectionKey": "string",
        "value": "string"
      }
    ],
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "feesDue": 0,
    "holdBalance": 0,
    "id": "string",
    "interestDue": 0,
    "interestPaymentDates": [
      {
        "dayOfMonth": 0,
        "monthOfYear": 0,
        "year": 0
      }
    ],
    "interestPaymentPoint": "EVERY_WEEK",
    "interestSettings": {
      "accrueInterestAfterMaturity": true,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestChargeFrequencyCount": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "TIERED_PERIOD",
      "interestRateTiers": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingBalance": 0,
          "endingDay": 0,
          "index": 0,
          "interestRate": 0
        }
      ],
      "interestSpread": 0
    },
    "lastAccountAppraisalDate": "string",
    "lastInterestCalculationDate": "string",
    "lastInterestStoredDate": "string",
    "lastModifiedDate": "string",
    "lastOverdraftInterestReviewDate": "string",
    "lastSetToArrearsDate": "string",
    "lineOfCreditKey": "string",
    "lockedBalance": 0,
    "lockedDate": "string",
    "maturityDate": "string",
    "maxWidthdrawlAmount": 0,
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "name": "string",
    "notes": "string",
    "overdraftAmount": 0,
    "overdraftExpiryDate": "string",
    "overdraftExpiryDateDTO": {
      "dayOfMonth": 0,
      "monthOfYear": 0,
      "year": 0
    },
    "overdraftInterestAccrued": 0,
    "overdraftInterestSettings": {
      "accrueInterestAfterMaturity": true,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestChargeFrequencyCount": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "TIERED_PERIOD",
      "interestRateTiers": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingBalance": 0,
          "endingDay": 0,
          "index": 0,
          "interestRate": 0
        }
      ],
      "interestSpread": 0
    },
    "overdraftLimit": 0,
    "productTypeKey": "string",
    "recommendedDepositAmount": 0,
    "targetAmount": 0,
    "technicalInterestDue": 0,
    "technicalOverdraftAmount": 0,
    "technicalOverdraftInterestAccrued": 0,
    "withholdingTaxSourceKey": "string"
  }
}

Properties

Name	Type	Description	Restrictions
customInformation	[CustomFieldValueApiV1]	none	none
savingsAccount	SavingsAccountApiV1	none	none

JSONSavingsTransactionRequestApiV1

{
  "amount": 0,
  "bookingDate": "string",
  "customInformation": [
    {
      "customFieldID": "string",
      "value": "string"
    }
  ],
  "date": "string",
  "fees": [
    {
      "amount": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472"
    }
  ],
  "method": "string",
  "notes": "string",
  "originalTransactionId": "string",
  "toLoanAccount": "string",
  "toSavingsAccount": "string",
  "type": "string",
  "valueDate": "string"
}

Properties

Name	Type	Description	Restrictions
amount	number	none	none
bookingDate	string	none	none
customInformation	[JSONTransactionRequestCustomFieldValueApiV1]	none	none
date	string	none	none
fees	[JSONFeeRequestApiV1]	none	none
method	string	none	none
notes	string	none	none
originalTransactionId	string	none	none
toLoanAccount	string	none	none
toSavingsAccount	string	none	none
type	string	none	none
valueDate	string	none	none

JSONTaskApiV1

{
  "task": {
    "assignedUserKey": "string",
    "completionDate": "string",
    "createdByFullName": "string",
    "createdByUserKey": "string",
    "creationDate": "string",
    "daysUntilDue": 0,
    "description": "string",
    "dueDate": "string",
    "encodedKey": "string",
    "id": 0,
    "lastModifiedDate": "string",
    "status": "COMPLETED",
    "taskLinkKey": "string",
    "taskLinkName": "string",
    "taskLinkType": "BRANCH",
    "title": "string"
  }
}

Properties

Name	Type	Description	Restrictions
task	TaskApiV1	none	none

JSONTransactionRequestApiV1

{
  "amount": 0,
  "bookingDate": "string",
  "currencyCode": "string",
  "customInformation": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "date": "string",
  "fees": [
    {
      "amount": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472"
    }
  ],
  "firstRepaymentDate": "string",
  "method": "string",
  "notes": "string",
  "originalTransactionId": "string",
  "rate": 0,
  "type": "string",
  "valueDate": "string"
}

Properties

Name	Type	Description	Restrictions
amount	number	none	none
bookingDate	string	none	none
currencyCode	string	none	none
customInformation	[CustomFieldValueApiV1]	none	none
date	string	none	none
fees	[JsonFeeRequestApiV1]	none	none
firstRepaymentDate	string	none	none
method	string	none	none
notes	string	none	none
originalTransactionId	string	none	none
rate	number	none	none
type	string	none	none
valueDate	string	none	none

JSONTransactionRequestCustomFieldValueApiV1

{
  "customFieldID": "string",
  "value": "string"
}

Properties

Name	Type	Description	Restrictions
customFieldID	string	none	none
value	string	none	none

JsonCustomViewEntitiesSummaryWrapperApiV1

{
  "summary": {
    "count": "string",
    "totals": [
      {
        "customFieldValues": {
          "property1": {},
          "property2": {}
        },
        "dataItemType": "WRITTEN_OFF_LOANS",
        "values": {
          "property1": {},
          "property2": {}
        }
      }
    ]
  }
}

Properties

Name	Type	Description	Restrictions
summary	CustomViewEntitiesSummaryWrapperApiV1	none	none

JsonFeeRequestApiV1

{
  "amount": 0,
  "encodedKey": "8a19b7057471f4af017472dc0fd80472"
}

Properties

Name	Type	Description	Restrictions
amount	number	none	none
encodedKey	string	the automatically generated encoded ID for this item	none

LineOfCreditBasicApiV1

{
  "amount": 0,
  "approvedDate": "string",
  "availableCreditAmount": 0,
  "clientKey": "string",
  "closedDate": "string",
  "creationDate": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "expireDate": "string",
  "exposureLimitType": "APPROVED_AMOUNT",
  "groupKey": "string",
  "id": "string",
  "idPattern": "string",
  "lastModifiedDate": "string",
  "notes": "string",
  "startDate": "string",
  "state": "WITHDRAWN",
  "subState": "WITHDRAWN"
}

Properties

Name	Type	Description	Restrictions
amount	number	none	none
approvedDate	string	none	none
availableCreditAmount	number	none	none
clientKey	string	none	none
closedDate	string	none	none
creationDate	string	the date and time when this line of credit was created	none
encodedKey	string	the automatically generated encoded ID for this item	none
expireDate	string	none	none
exposureLimitType	string	none	none
groupKey	string	none	none
id	string	none	none
idPattern	string	none	none
lastModifiedDate	string	the date on which this line of credit was last modified	none
notes	string	none	none
startDate	string	none	none
state	string	none	none
subState	string	none	none

Enumerated Values

Property	Value
exposureLimitType	`APPROVED_AMOUNT`
exposureLimitType	`OUTSTANDING_AMOUNT`
state	`WITHDRAWN`
state	`PENDING_APPROVAL`
state	`ACTIVE`
state	`CLOSED`
state	`APPROVED`
state	`REJECTED`
subState	`WITHDRAWN`
subState	`PENDING_APPROVAL`
subState	`ACTIVE`
subState	`CLOSED`
subState	`APPROVED`
subState	`REJECTED`

LineOfCreditExpandedApiV1

{
  "lineOfCredit": {
    "amount": 0,
    "approvedDate": "string",
    "availableCreditAmount": 0,
    "clientKey": "string",
    "closedDate": "string",
    "creationDate": "string",
    "customInformation": [
      {
        "amount": 0,
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "customFieldID": "string",
        "customFieldKey": "string",
        "customFieldSetGroupIndex": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexInList": 0,
        "linkedEntityKeyValue": "string",
        "parentKey": "string",
        "selectionKey": "string",
        "value": "string"
      }
    ],
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "expireDate": "string",
    "exposureLimitType": "APPROVED_AMOUNT",
    "groupKey": "string",
    "id": "string",
    "idPattern": "string",
    "lastModifiedDate": "string",
    "notes": "string",
    "startDate": "string",
    "state": "WITHDRAWN",
    "subState": "WITHDRAWN"
  }
}

Properties

Name	Type	Description	Restrictions
lineOfCredit	LineOfCreditFullApiV1	none	none

LineOfCreditFullApiV1

{
  "amount": 0,
  "approvedDate": "string",
  "availableCreditAmount": 0,
  "clientKey": "string",
  "closedDate": "string",
  "creationDate": "string",
  "customInformation": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "expireDate": "string",
  "exposureLimitType": "APPROVED_AMOUNT",
  "groupKey": "string",
  "id": "string",
  "idPattern": "string",
  "lastModifiedDate": "string",
  "notes": "string",
  "startDate": "string",
  "state": "WITHDRAWN",
  "subState": "WITHDRAWN"
}

Properties

Name	Type	Description	Restrictions
amount	number	none	none
approvedDate	string	none	none
availableCreditAmount	number	none	none
clientKey	string	none	none
closedDate	string	none	none
creationDate	string	the date and time when this line of credit was created	none
customInformation	[CustomFieldValueApiV1]	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
expireDate	string	none	none
exposureLimitType	string	none	none
groupKey	string	none	none
id	string	none	none
idPattern	string	none	none
lastModifiedDate	string	the date on which this line of credit was last modified	none
notes	string	none	none
startDate	string	none	none
state	string	none	none
subState	string	none	none

Enumerated Values

Property	Value
exposureLimitType	`APPROVED_AMOUNT`
exposureLimitType	`OUTSTANDING_AMOUNT`
state	`WITHDRAWN`
state	`PENDING_APPROVAL`
state	`ACTIVE`
state	`CLOSED`
state	`APPROVED`
state	`REJECTED`
subState	`WITHDRAWN`
subState	`PENDING_APPROVAL`
subState	`ACTIVE`
subState	`CLOSED`
subState	`APPROVED`
subState	`REJECTED`

LoanAccountApiV1

{
  "accountArrearsSettings": {
    "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
    "encodedKey": "string",
    "monthlyToleranceDay": 0,
    "nonWorkingDaysMethod": "EXCLUDED",
    "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY",
    "toleranceFloorAmount": 0,
    "tolerancePercentageOfOutstandingPrincipal": 0,
    "tolerancePeriod": 0
  },
  "accountHolderKey": "string",
  "accountHolderType": "GROUP",
  "accountState": "WITHDRAWN",
  "accountSubState": "WITHDRAWN",
  "accrueInterestAfterMaturity": true,
  "accrueLateInterest": true,
  "accruedInterest": 0,
  "accruedPenalty": 0,
  "activationTransactionKey": "string",
  "allowOffset": true,
  "applyInterestOnPrepaymentMethod": "AUTOMATIC",
  "approvedDate": "string",
  "arrearsTolerancePeriod": 0,
  "assignedBranchKey": "string",
  "assignedCentreKey": "string",
  "assignedUserKey": "string",
  "closedDate": "string",
  "creationDate": "string",
  "customFieldValues": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "daysInArrears": 0,
  "defaultFirstRepaymentDueDateOffset": 0,
  "disbursementDetails": {
    "customInformation": [
      {
        "amount": 0,
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "customFieldID": "string",
        "customFieldKey": "string",
        "customFieldSetGroupIndex": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexInList": 0,
        "linkedEntityKeyValue": "string",
        "parentKey": "string",
        "selectionKey": "string",
        "value": "string"
      }
    ],
    "disbursementDate": "string",
    "encodedKey": "string",
    "expectedDisbursementDate": "string",
    "fees": [
      {
        "amount": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "fee": {
          "active": true,
          "amortizationIntervalSettings": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
            "intervalCount": 0,
            "intervalType": "FULL_TERM",
            "periodCount": 0,
            "periodUnit": "MONTHS"
          },
          "amortizationProfile": "STRAIGHT_LINE",
          "amount": 0,
          "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
          "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
          "creationDate": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
          "feeApplication": "OPTIONAL",
          "feeProductRules": [
            {
              "account": {
                "activated": true,
                "allowManualJournalEntries": true,
                "balance": 0,
                "creationDate": "2019-08-24T14:15:22Z",
                "currency": {
                  "code": "string",
                  "creationDate": "string",
                  "currencySymbolPosition": "AFTER_NUMBER",
                  "digitsAfterDecimal": 0,
                  "isBaseCurrency": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "symbol": "string"
                },
                "description": "string",
                "encodedKey": "string",
                "glCode": "string",
                "lastModifiedDate": "2019-08-24T14:15:22Z",
                "migrationEvent": {
                  "creationDate": "2019-08-24T14:15:22Z",
                  "encodedKey": "string",
                  "numCentresImported": 0,
                  "numClientsImported": 0,
                  "numGLAccountsImported": 0,
                  "numGroupsImported": 0,
                  "numLoanRepaymentsImported": 0,
                  "numLoanTransactionsImported": 0,
                  "numLoansImported": 0,
                  "numSavingsImported": 0,
                  "state": "REVERTED",
                  "type": "IMPORT"
                },
                "name": "string",
                "stripTrailingZeros": true,
                "type": "INCOME",
                "usage": "HEADER"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "financialResource": "FEE_RECEIVABLE",
              "index": 0,
              "predefinedFeeKey": "string",
              "productKey": "string",
              "productType": "LOAN",
              "transactionChannelKey": "string"
            }
          ],
          "name": "string",
          "percentageAmount": 0,
          "trigger": "DISBURSEMENT"
        }
      }
    ],
    "firstRepaymentDate": "string",
    "transactionDetails": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "internalTransfer": true,
      "targetSavingsAccountKey": "string",
      "transactionChannel": {
        "activated": true,
        "createdByUserKey": "string",
        "creationDate": "string",
        "customFields": [
          {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          }
        ],
        "encodedKey": "string",
        "id": "string",
        "index": 0,
        "loanConstraints": {
          "customConfigurationInfo": {
            "creationDate": "string",
            "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "shared": true,
            "userKey": "string"
          },
          "encodedKey": "string",
          "filterConstraints": [
            {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            }
          ]
        },
        "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
        "name": "string",
        "savingsConstraints": {
          "customConfigurationInfo": {
            "creationDate": "string",
            "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "shared": true,
            "userKey": "string"
          },
          "encodedKey": "string",
          "filterConstraints": [
            {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            }
          ]
        },
        "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
        "transactionChannelAccountingRule": {
          "account": {
            "activated": true,
            "allowManualJournalEntries": true,
            "balance": 0,
            "creationDate": "2019-08-24T14:15:22Z",
            "currency": {
              "code": "string",
              "creationDate": "string",
              "currencySymbolPosition": "AFTER_NUMBER",
              "digitsAfterDecimal": 0,
              "isBaseCurrency": true,
              "lastModifiedDate": "string",
              "name": "string",
              "symbol": "string"
            },
            "description": "string",
            "encodedKey": "string",
            "glCode": "string",
            "lastModifiedDate": "2019-08-24T14:15:22Z",
            "migrationEvent": {
              "creationDate": "2019-08-24T14:15:22Z",
              "encodedKey": "string",
              "numCentresImported": 0,
              "numClientsImported": 0,
              "numGLAccountsImported": 0,
              "numGroupsImported": 0,
              "numLoanRepaymentsImported": 0,
              "numLoanTransactionsImported": 0,
              "numLoansImported": 0,
              "numSavingsImported": 0,
              "state": "REVERTED",
              "type": "IMPORT"
            },
            "name": "string",
            "stripTrailingZeros": true,
            "type": "INCOME",
            "usage": "HEADER"
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "financialResource": "FEE_RECEIVABLE",
          "index": 0,
          "predefinedFeeKey": "string",
          "productKey": "string",
          "productType": "LOAN",
          "transactionChannelKey": "string"
        },
        "usageRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "transactionChannelKey": "string"
    }
  },
  "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "feesBalance": 0,
  "feesDue": 0,
  "feesPaid": 0,
  "fixedDaysOfMonth": [
    0
  ],
  "funds": [
    {
      "amount": 0,
      "assetName": "string",
      "customFieldValues": [
        {
          "amount": 0,
          "customField": {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "customFieldID": "string",
          "customFieldKey": "string",
          "customFieldSetGroupIndex": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "linkedEntityKeyValue": "string",
          "parentKey": "string",
          "selectionKey": "string",
          "value": "string"
        }
      ],
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "guarantorKey": "string",
      "guarantorType": "GROUP",
      "id": "string",
      "interestCommission": 0,
      "investmentPercentage": 0,
      "savingsAccountKey": "string",
      "type": "GUARANTOR"
    }
  ],
  "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
  "gracePeriod": 0,
  "gracePeriodType": "PAY_INTEREST_ONLY",
  "guarantees": [
    {
      "amount": 0,
      "assetName": "string",
      "customFieldValues": [
        {
          "amount": 0,
          "customField": {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "customFieldID": "string",
          "customFieldKey": "string",
          "customFieldSetGroupIndex": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "linkedEntityKeyValue": "string",
          "parentKey": "string",
          "selectionKey": "string",
          "value": "string"
        }
      ],
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "guarantorKey": "string",
      "guarantorType": "GROUP",
      "savingsAccountKey": "string",
      "type": "GUARANTOR"
    }
  ],
  "hasCustomSchedule": true,
  "holdBalance": 0,
  "id": "string",
  "interestApplicationMethod": "ON_REPAYMENT",
  "interestBalance": 0,
  "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
  "interestCalculationMethod": "DECLINING_BALANCE",
  "interestChargeFrequency": "EVERY_WEEK",
  "interestCommission": 0,
  "interestDue": 0,
  "interestFromArrearsAccrued": 0,
  "interestFromArrearsBalance": 0,
  "interestFromArrearsDue": 0,
  "interestFromArrearsPaid": 0,
  "interestPaid": 0,
  "interestRate": 0,
  "interestRateReviewCount": 0,
  "interestRateReviewUnit": "MONTHS",
  "interestRateSource": "FIXED_INTEREST_RATE",
  "interestRoundingVersion": "VERSION_2",
  "interestSpread": 0,
  "interestType": "CAPITALIZED_INTEREST",
  "lastAccountAppraisalDate": "string",
  "lastInterestAppliedDate": "string",
  "lastInterestReviewDate": "string",
  "lastLockedDate": "string",
  "lastModifiedDate": "string",
  "lastSetToArrearsDate": "string",
  "lastTaxRateReviewDate": "string",
  "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
  "lineOfCreditKey": "string",
  "loanAmount": 0,
  "loanGroup": {
    "accounts": [
      {
        "accountArrearsSettings": {
          "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
          "encodedKey": "string",
          "monthlyToleranceDay": 0,
          "nonWorkingDaysMethod": "EXCLUDED",
          "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY",
          "toleranceFloorAmount": 0,
          "tolerancePercentageOfOutstandingPrincipal": 0,
          "tolerancePeriod": 0
        },
        "accountHolderKey": "string",
        "accountHolderType": "GROUP",
        "accountState": "WITHDRAWN",
        "accountSubState": "WITHDRAWN",
        "accrueInterestAfterMaturity": true,
        "accrueLateInterest": true,
        "accruedInterest": 0,
        "accruedPenalty": 0,
        "activationTransactionKey": "string",
        "allowOffset": true,
        "applyInterestOnPrepaymentMethod": "AUTOMATIC",
        "approvedDate": "string",
        "arrearsTolerancePeriod": 0,
        "assignedBranchKey": "string",
        "assignedCentreKey": "string",
        "assignedUserKey": "string",
        "closedDate": "string",
        "creationDate": "string",
        "customFieldValues": [
          {
            "amount": 0,
            "customField": {
              "amounts": {
                "property1": 0,
                "property2": 0
              },
              "builtInCustomFieldId": "MOBILE_PHONE",
              "creationDate": "string",
              "customFieldProductSettings": [
                {
                  "customFieldEncodedKey": "string",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isDefault": true,
                  "isRequired": true,
                  "linkType": "CLIENT_ROLE",
                  "productKey": "string"
                }
              ],
              "customFieldSelectionOptions": [
                {
                  "constraint": {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "score": 0,
                  "value": "string"
                }
              ],
              "customFieldSet": {
                "builtInType": "DETAILS",
                "createdDate": "string",
                "customFields": [
                  {}
                ],
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "notes": "string",
                "type": "USER_INFO",
                "usage": "SINGLE"
              },
              "dataType": "GROUP_LINK",
              "description": "string",
              "editRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "isDefault": true,
              "isRequired": true,
              "lastModifiedDate": "string",
              "name": "string",
              "state": "DEACTIVATED",
              "type": "USER_INFO",
              "unique": true,
              "validationPattern": "string",
              "valueLength": "SHORT",
              "values": [
                "string"
              ],
              "viewRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "customFieldID": "string",
            "customFieldKey": "string",
            "customFieldSetGroupIndex": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "linkedEntityKeyValue": "string",
            "parentKey": "string",
            "selectionKey": "string",
            "value": "string"
          }
        ],
        "daysInArrears": 0,
        "defaultFirstRepaymentDueDateOffset": 0,
        "disbursementDetails": {
          "customInformation": [
            {
              "amount": 0,
              "customField": {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              },
              "customFieldID": "string",
              "customFieldKey": "string",
              "customFieldSetGroupIndex": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "linkedEntityKeyValue": "string",
              "parentKey": "string",
              "selectionKey": "string",
              "value": "string"
            }
          ],
          "disbursementDate": "string",
          "encodedKey": "string",
          "expectedDisbursementDate": "string",
          "fees": [
            {
              "amount": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "fee": {
                "active": true,
                "amortizationIntervalSettings": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
                  "intervalCount": 0,
                  "intervalType": "FULL_TERM",
                  "periodCount": 0,
                  "periodUnit": "MONTHS"
                },
                "amortizationProfile": "STRAIGHT_LINE",
                "amount": 0,
                "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
                "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
                "creationDate": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
                "feeApplication": "OPTIONAL",
                "feeProductRules": [
                  {
                    "account": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "financialResource": "FEE_RECEIVABLE",
                    "index": 0,
                    "predefinedFeeKey": "string",
                    "productKey": "string",
                    "productType": "LOAN",
                    "transactionChannelKey": "string"
                  }
                ],
                "name": "string",
                "percentageAmount": 0,
                "trigger": "DISBURSEMENT"
              }
            }
          ],
          "firstRepaymentDate": "string",
          "transactionDetails": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "internalTransfer": true,
            "targetSavingsAccountKey": "string",
            "transactionChannel": {
              "activated": true,
              "createdByUserKey": "string",
              "creationDate": "string",
              "customFields": [
                {
                  "amounts": {
                    "property1": 0,
                    "property2": 0
                  },
                  "builtInCustomFieldId": "MOBILE_PHONE",
                  "creationDate": "string",
                  "customFieldProductSettings": [
                    {}
                  ],
                  "customFieldSelectionOptions": [
                    {}
                  ],
                  "customFieldSet": {
                    "builtInType": "DETAILS",
                    "createdDate": "string",
                    "customFields": [],
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "indexInList": 0,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "notes": "string",
                    "type": "USER_INFO",
                    "usage": "SINGLE"
                  },
                  "dataType": "GROUP_LINK",
                  "description": "string",
                  "editRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "isDefault": true,
                  "isRequired": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "state": "DEACTIVATED",
                  "type": "USER_INFO",
                  "unique": true,
                  "validationPattern": "string",
                  "valueLength": "SHORT",
                  "values": [
                    "string"
                  ],
                  "viewRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  }
                }
              ],
              "encodedKey": "string",
              "id": "string",
              "index": 0,
              "loanConstraints": {
                "customConfigurationInfo": {
                  "creationDate": "string",
                  "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "shared": true,
                  "userKey": "string"
                },
                "encodedKey": "string",
                "filterConstraints": [
                  {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  }
                ]
              },
              "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
              "name": "string",
              "savingsConstraints": {
                "customConfigurationInfo": {
                  "creationDate": "string",
                  "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "shared": true,
                  "userKey": "string"
                },
                "encodedKey": "string",
                "filterConstraints": [
                  {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  }
                ]
              },
              "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
              "transactionChannelAccountingRule": {
                "account": {
                  "activated": true,
                  "allowManualJournalEntries": true,
                  "balance": 0,
                  "creationDate": "2019-08-24T14:15:22Z",
                  "currency": {
                    "code": "string",
                    "creationDate": "string",
                    "currencySymbolPosition": "AFTER_NUMBER",
                    "digitsAfterDecimal": 0,
                    "isBaseCurrency": true,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "symbol": "string"
                  },
                  "description": "string",
                  "encodedKey": "string",
                  "glCode": "string",
                  "lastModifiedDate": "2019-08-24T14:15:22Z",
                  "migrationEvent": {
                    "creationDate": "2019-08-24T14:15:22Z",
                    "encodedKey": "string",
                    "numCentresImported": 0,
                    "numClientsImported": 0,
                    "numGLAccountsImported": 0,
                    "numGroupsImported": 0,
                    "numLoanRepaymentsImported": 0,
                    "numLoanTransactionsImported": 0,
                    "numLoansImported": 0,
                    "numSavingsImported": 0,
                    "state": "REVERTED",
                    "type": "IMPORT"
                  },
                  "name": "string",
                  "stripTrailingZeros": true,
                  "type": "INCOME",
                  "usage": "HEADER"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "financialResource": "FEE_RECEIVABLE",
                "index": 0,
                "predefinedFeeKey": "string",
                "productKey": "string",
                "productType": "LOAN",
                "transactionChannelKey": "string"
              },
              "usageRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "transactionChannelKey": "string"
          }
        },
        "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "feesBalance": 0,
        "feesDue": 0,
        "feesPaid": 0,
        "fixedDaysOfMonth": [
          0
        ],
        "funds": [
          {
            "amount": 0,
            "assetName": "string",
            "customFieldValues": [
              {
                "amount": 0,
                "customField": {
                  "amounts": {
                    "property1": 0,
                    "property2": 0
                  },
                  "builtInCustomFieldId": "MOBILE_PHONE",
                  "creationDate": "string",
                  "customFieldProductSettings": [
                    {}
                  ],
                  "customFieldSelectionOptions": [
                    {}
                  ],
                  "customFieldSet": {
                    "builtInType": "DETAILS",
                    "createdDate": "string",
                    "customFields": [],
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "indexInList": 0,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "notes": "string",
                    "type": "USER_INFO",
                    "usage": "SINGLE"
                  },
                  "dataType": "GROUP_LINK",
                  "description": "string",
                  "editRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "isDefault": true,
                  "isRequired": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "state": "DEACTIVATED",
                  "type": "USER_INFO",
                  "unique": true,
                  "validationPattern": "string",
                  "valueLength": "SHORT",
                  "values": [
                    "string"
                  ],
                  "viewRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  }
                },
                "customFieldID": "string",
                "customFieldKey": "string",
                "customFieldSetGroupIndex": 0,
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "linkedEntityKeyValue": "string",
                "parentKey": "string",
                "selectionKey": "string",
                "value": "string"
              }
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "guarantorKey": "string",
            "guarantorType": "GROUP",
            "id": "string",
            "interestCommission": 0,
            "investmentPercentage": 0,
            "savingsAccountKey": "string",
            "type": "GUARANTOR"
          }
        ],
        "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
        "gracePeriod": 0,
        "gracePeriodType": "PAY_INTEREST_ONLY",
        "guarantees": [
          {
            "amount": 0,
            "assetName": "string",
            "customFieldValues": [
              {
                "amount": 0,
                "customField": {
                  "amounts": {
                    "property1": 0,
                    "property2": 0
                  },
                  "builtInCustomFieldId": "MOBILE_PHONE",
                  "creationDate": "string",
                  "customFieldProductSettings": [
                    {}
                  ],
                  "customFieldSelectionOptions": [
                    {}
                  ],
                  "customFieldSet": {
                    "builtInType": "DETAILS",
                    "createdDate": "string",
                    "customFields": [],
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "indexInList": 0,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "notes": "string",
                    "type": "USER_INFO",
                    "usage": "SINGLE"
                  },
                  "dataType": "GROUP_LINK",
                  "description": "string",
                  "editRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "isDefault": true,
                  "isRequired": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "state": "DEACTIVATED",
                  "type": "USER_INFO",
                  "unique": true,
                  "validationPattern": "string",
                  "valueLength": "SHORT",
                  "values": [
                    "string"
                  ],
                  "viewRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  }
                },
                "customFieldID": "string",
                "customFieldKey": "string",
                "customFieldSetGroupIndex": 0,
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "linkedEntityKeyValue": "string",
                "parentKey": "string",
                "selectionKey": "string",
                "value": "string"
              }
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "guarantorKey": "string",
            "guarantorType": "GROUP",
            "savingsAccountKey": "string",
            "type": "GUARANTOR"
          }
        ],
        "hasCustomSchedule": true,
        "holdBalance": 0,
        "id": "string",
        "interestApplicationMethod": "ON_REPAYMENT",
        "interestBalance": 0,
        "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
        "interestCalculationMethod": "DECLINING_BALANCE",
        "interestChargeFrequency": "EVERY_WEEK",
        "interestCommission": 0,
        "interestDue": 0,
        "interestFromArrearsAccrued": 0,
        "interestFromArrearsBalance": 0,
        "interestFromArrearsDue": 0,
        "interestFromArrearsPaid": 0,
        "interestPaid": 0,
        "interestRate": 0,
        "interestRateReviewCount": 0,
        "interestRateReviewUnit": "MONTHS",
        "interestRateSource": "FIXED_INTEREST_RATE",
        "interestRoundingVersion": "VERSION_2",
        "interestSpread": 0,
        "interestType": "CAPITALIZED_INTEREST",
        "lastAccountAppraisalDate": "string",
        "lastInterestAppliedDate": "string",
        "lastInterestReviewDate": "string",
        "lastLockedDate": "string",
        "lastModifiedDate": "string",
        "lastSetToArrearsDate": "string",
        "lastTaxRateReviewDate": "string",
        "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
        "lineOfCreditKey": "string",
        "loanAmount": 0,
        "loanGroup": {},
        "loanName": "string",
        "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
        "lockedOperations": [
          "APPLY_FEES"
        ],
        "migrationEvent": {
          "creationDate": "2019-08-24T14:15:22Z",
          "encodedKey": "string",
          "numCentresImported": 0,
          "numClientsImported": 0,
          "numGLAccountsImported": 0,
          "numGroupsImported": 0,
          "numLoanRepaymentsImported": 0,
          "numLoanTransactionsImported": 0,
          "numLoansImported": 0,
          "numSavingsImported": 0,
          "state": "REVERTED",
          "type": "IMPORT"
        },
        "notes": "string",
        "originalAccountKey": "string",
        "paymentMethod": "VERTICAL",
        "paymentPlan": [
          {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "endingInstallmentPosition": 0,
            "index": 0,
            "loanAccountEncodedKey": "string",
            "pmt": 0
          }
        ],
        "penaltyBalance": 0,
        "penaltyDue": 0,
        "penaltyPaid": 0,
        "penaltyRate": 0,
        "periodicPayment": 0,
        "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
        "prepaymentRecalculationMethod": "NO_RECALCULATION",
        "principalBalance": 0,
        "principalDue": 0,
        "principalPaid": 0,
        "principalPaidInstallmentStatus": "PARTIALLY_PAID",
        "principalPaymentSettings": {
          "amount": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "includeFeesInFloorAmount": true,
          "includeInterestInFloorAmount": true,
          "percentage": 0,
          "principalCeilingValue": 0,
          "principalFloorValue": 0,
          "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
        },
        "principalRepaymentInterval": 0,
        "productTypeKey": "string",
        "redrawBalance": 0,
        "redrawSettings": {
          "account": {},
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "restrictNextDueWithdrawal": true
        },
        "repaymentInstallments": 0,
        "repaymentPeriodCount": 0,
        "repaymentPeriodUnit": "MONTHS",
        "repaymentScheduleMethod": "FIXED",
        "rescheduledAccountKey": "string",
        "scheduleDueDatesMethod": "INTERVAL",
        "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
        "taxRate": 0,
        "tranches": [
          {
            "amount": 0,
            "disbursementTransactionKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "expectedDisbursementDate": "string",
            "index": 0
          }
        ]
      }
    ],
    "creationDate": "string",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "group": {
      "assignedBranchKey": "string",
      "assignedCentreKey": "string",
      "assignedUserKey": "string",
      "clientRole": {
        "encodedKey": "string"
      },
      "creationDate": "2019-08-24T14:15:22Z",
      "emailAddress": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "groupName": "string",
      "homePhone": "string",
      "id": "string",
      "idPattern": "string",
      "lastModifiedDate": "2019-08-24T14:15:22Z",
      "loanCycle": 0,
      "migrationEvent": {
        "creationDate": "2019-08-24T14:15:22Z",
        "encodedKey": "string",
        "numCentresImported": 0,
        "numClientsImported": 0,
        "numGLAccountsImported": 0,
        "numGroupsImported": 0,
        "numLoanRepaymentsImported": 0,
        "numLoanTransactionsImported": 0,
        "numLoansImported": 0,
        "numSavingsImported": 0,
        "state": "REVERTED",
        "type": "IMPORT"
      },
      "mobilePhone1": "string",
      "preferredLanguage": "PORTUGESE"
    },
    "lastModifiedDate": "string",
    "name": "string",
    "notes": "string"
  },
  "loanName": "string",
  "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
  "lockedOperations": [
    "APPLY_FEES"
  ],
  "migrationEvent": {
    "creationDate": "2019-08-24T14:15:22Z",
    "encodedKey": "string",
    "numCentresImported": 0,
    "numClientsImported": 0,
    "numGLAccountsImported": 0,
    "numGroupsImported": 0,
    "numLoanRepaymentsImported": 0,
    "numLoanTransactionsImported": 0,
    "numLoansImported": 0,
    "numSavingsImported": 0,
    "state": "REVERTED",
    "type": "IMPORT"
  },
  "notes": "string",
  "originalAccountKey": "string",
  "paymentMethod": "VERTICAL",
  "paymentPlan": [
    {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "endingInstallmentPosition": 0,
      "index": 0,
      "loanAccountEncodedKey": "string",
      "pmt": 0
    }
  ],
  "penaltyBalance": 0,
  "penaltyDue": 0,
  "penaltyPaid": 0,
  "penaltyRate": 0,
  "periodicPayment": 0,
  "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
  "prepaymentRecalculationMethod": "NO_RECALCULATION",
  "principalBalance": 0,
  "principalDue": 0,
  "principalPaid": 0,
  "principalPaidInstallmentStatus": "PARTIALLY_PAID",
  "principalPaymentSettings": {
    "amount": 0,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "includeFeesInFloorAmount": true,
    "includeInterestInFloorAmount": true,
    "percentage": 0,
    "principalCeilingValue": 0,
    "principalFloorValue": 0,
    "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
  },
  "principalRepaymentInterval": 0,
  "productTypeKey": "string",
  "redrawBalance": 0,
  "redrawSettings": {
    "account": {
      "accountArrearsSettings": {
        "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
        "encodedKey": "string",
        "monthlyToleranceDay": 0,
        "nonWorkingDaysMethod": "EXCLUDED",
        "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY",
        "toleranceFloorAmount": 0,
        "tolerancePercentageOfOutstandingPrincipal": 0,
        "tolerancePeriod": 0
      },
      "accountHolderKey": "string",
      "accountHolderType": "GROUP",
      "accountState": "WITHDRAWN",
      "accountSubState": "WITHDRAWN",
      "accrueInterestAfterMaturity": true,
      "accrueLateInterest": true,
      "accruedInterest": 0,
      "accruedPenalty": 0,
      "activationTransactionKey": "string",
      "allowOffset": true,
      "applyInterestOnPrepaymentMethod": "AUTOMATIC",
      "approvedDate": "string",
      "arrearsTolerancePeriod": 0,
      "assignedBranchKey": "string",
      "assignedCentreKey": "string",
      "assignedUserKey": "string",
      "closedDate": "string",
      "creationDate": "string",
      "customFieldValues": [
        {
          "amount": 0,
          "customField": {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "customFieldID": "string",
          "customFieldKey": "string",
          "customFieldSetGroupIndex": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "linkedEntityKeyValue": "string",
          "parentKey": "string",
          "selectionKey": "string",
          "value": "string"
        }
      ],
      "daysInArrears": 0,
      "defaultFirstRepaymentDueDateOffset": 0,
      "disbursementDetails": {
        "customInformation": [
          {
            "amount": 0,
            "customField": {
              "amounts": {
                "property1": 0,
                "property2": 0
              },
              "builtInCustomFieldId": "MOBILE_PHONE",
              "creationDate": "string",
              "customFieldProductSettings": [
                {
                  "customFieldEncodedKey": "string",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isDefault": true,
                  "isRequired": true,
                  "linkType": "CLIENT_ROLE",
                  "productKey": "string"
                }
              ],
              "customFieldSelectionOptions": [
                {
                  "constraint": {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "score": 0,
                  "value": "string"
                }
              ],
              "customFieldSet": {
                "builtInType": "DETAILS",
                "createdDate": "string",
                "customFields": [
                  {}
                ],
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "notes": "string",
                "type": "USER_INFO",
                "usage": "SINGLE"
              },
              "dataType": "GROUP_LINK",
              "description": "string",
              "editRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "isDefault": true,
              "isRequired": true,
              "lastModifiedDate": "string",
              "name": "string",
              "state": "DEACTIVATED",
              "type": "USER_INFO",
              "unique": true,
              "validationPattern": "string",
              "valueLength": "SHORT",
              "values": [
                "string"
              ],
              "viewRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "customFieldID": "string",
            "customFieldKey": "string",
            "customFieldSetGroupIndex": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "linkedEntityKeyValue": "string",
            "parentKey": "string",
            "selectionKey": "string",
            "value": "string"
          }
        ],
        "disbursementDate": "string",
        "encodedKey": "string",
        "expectedDisbursementDate": "string",
        "fees": [
          {
            "amount": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "fee": {
              "active": true,
              "amortizationIntervalSettings": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
                "intervalCount": 0,
                "intervalType": "FULL_TERM",
                "periodCount": 0,
                "periodUnit": "MONTHS"
              },
              "amortizationProfile": "STRAIGHT_LINE",
              "amount": 0,
              "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
              "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
              "creationDate": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
              "feeApplication": "OPTIONAL",
              "feeProductRules": [
                {
                  "account": {
                    "activated": true,
                    "allowManualJournalEntries": true,
                    "balance": 0,
                    "creationDate": "2019-08-24T14:15:22Z",
                    "currency": {},
                    "description": "string",
                    "encodedKey": "string",
                    "glCode": "string",
                    "lastModifiedDate": "2019-08-24T14:15:22Z",
                    "migrationEvent": {},
                    "name": "string",
                    "stripTrailingZeros": true,
                    "type": "INCOME",
                    "usage": "HEADER"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "financialResource": "FEE_RECEIVABLE",
                  "index": 0,
                  "predefinedFeeKey": "string",
                  "productKey": "string",
                  "productType": "LOAN",
                  "transactionChannelKey": "string"
                }
              ],
              "name": "string",
              "percentageAmount": 0,
              "trigger": "DISBURSEMENT"
            }
          }
        ],
        "firstRepaymentDate": "string",
        "transactionDetails": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "internalTransfer": true,
          "targetSavingsAccountKey": "string",
          "transactionChannel": {
            "activated": true,
            "createdByUserKey": "string",
            "creationDate": "string",
            "customFields": [
              {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              }
            ],
            "encodedKey": "string",
            "id": "string",
            "index": 0,
            "loanConstraints": {
              "customConfigurationInfo": {
                "creationDate": "string",
                "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "shared": true,
                "userKey": "string"
              },
              "encodedKey": "string",
              "filterConstraints": [
                {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                }
              ]
            },
            "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
            "name": "string",
            "savingsConstraints": {
              "customConfigurationInfo": {
                "creationDate": "string",
                "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "shared": true,
                "userKey": "string"
              },
              "encodedKey": "string",
              "filterConstraints": [
                {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                }
              ]
            },
            "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
            "transactionChannelAccountingRule": {
              "account": {
                "activated": true,
                "allowManualJournalEntries": true,
                "balance": 0,
                "creationDate": "2019-08-24T14:15:22Z",
                "currency": {
                  "code": "string",
                  "creationDate": "string",
                  "currencySymbolPosition": "AFTER_NUMBER",
                  "digitsAfterDecimal": 0,
                  "isBaseCurrency": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "symbol": "string"
                },
                "description": "string",
                "encodedKey": "string",
                "glCode": "string",
                "lastModifiedDate": "2019-08-24T14:15:22Z",
                "migrationEvent": {
                  "creationDate": "2019-08-24T14:15:22Z",
                  "encodedKey": "string",
                  "numCentresImported": 0,
                  "numClientsImported": 0,
                  "numGLAccountsImported": 0,
                  "numGroupsImported": 0,
                  "numLoanRepaymentsImported": 0,
                  "numLoanTransactionsImported": 0,
                  "numLoansImported": 0,
                  "numSavingsImported": 0,
                  "state": "REVERTED",
                  "type": "IMPORT"
                },
                "name": "string",
                "stripTrailingZeros": true,
                "type": "INCOME",
                "usage": "HEADER"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "financialResource": "FEE_RECEIVABLE",
              "index": 0,
              "predefinedFeeKey": "string",
              "productKey": "string",
              "productType": "LOAN",
              "transactionChannelKey": "string"
            },
            "usageRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "transactionChannelKey": "string"
        }
      },
      "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "feesBalance": 0,
      "feesDue": 0,
      "feesPaid": 0,
      "fixedDaysOfMonth": [
        0
      ],
      "funds": [
        {
          "amount": 0,
          "assetName": "string",
          "customFieldValues": [
            {
              "amount": 0,
              "customField": {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              },
              "customFieldID": "string",
              "customFieldKey": "string",
              "customFieldSetGroupIndex": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "linkedEntityKeyValue": "string",
              "parentKey": "string",
              "selectionKey": "string",
              "value": "string"
            }
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "guarantorKey": "string",
          "guarantorType": "GROUP",
          "id": "string",
          "interestCommission": 0,
          "investmentPercentage": 0,
          "savingsAccountKey": "string",
          "type": "GUARANTOR"
        }
      ],
      "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
      "gracePeriod": 0,
      "gracePeriodType": "PAY_INTEREST_ONLY",
      "guarantees": [
        {
          "amount": 0,
          "assetName": "string",
          "customFieldValues": [
            {
              "amount": 0,
              "customField": {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              },
              "customFieldID": "string",
              "customFieldKey": "string",
              "customFieldSetGroupIndex": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "linkedEntityKeyValue": "string",
              "parentKey": "string",
              "selectionKey": "string",
              "value": "string"
            }
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "guarantorKey": "string",
          "guarantorType": "GROUP",
          "savingsAccountKey": "string",
          "type": "GUARANTOR"
        }
      ],
      "hasCustomSchedule": true,
      "holdBalance": 0,
      "id": "string",
      "interestApplicationMethod": "ON_REPAYMENT",
      "interestBalance": 0,
      "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
      "interestCalculationMethod": "DECLINING_BALANCE",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestCommission": 0,
      "interestDue": 0,
      "interestFromArrearsAccrued": 0,
      "interestFromArrearsBalance": 0,
      "interestFromArrearsDue": 0,
      "interestFromArrearsPaid": 0,
      "interestPaid": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRoundingVersion": "VERSION_2",
      "interestSpread": 0,
      "interestType": "CAPITALIZED_INTEREST",
      "lastAccountAppraisalDate": "string",
      "lastInterestAppliedDate": "string",
      "lastInterestReviewDate": "string",
      "lastLockedDate": "string",
      "lastModifiedDate": "string",
      "lastSetToArrearsDate": "string",
      "lastTaxRateReviewDate": "string",
      "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
      "lineOfCreditKey": "string",
      "loanAmount": 0,
      "loanGroup": {
        "accounts": [
          {}
        ],
        "creationDate": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "group": {
          "assignedBranchKey": "string",
          "assignedCentreKey": "string",
          "assignedUserKey": "string",
          "clientRole": {
            "encodedKey": "string"
          },
          "creationDate": "2019-08-24T14:15:22Z",
          "emailAddress": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "groupName": "string",
          "homePhone": "string",
          "id": "string",
          "idPattern": "string",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "loanCycle": 0,
          "migrationEvent": {
            "creationDate": "2019-08-24T14:15:22Z",
            "encodedKey": "string",
            "numCentresImported": 0,
            "numClientsImported": 0,
            "numGLAccountsImported": 0,
            "numGroupsImported": 0,
            "numLoanRepaymentsImported": 0,
            "numLoanTransactionsImported": 0,
            "numLoansImported": 0,
            "numSavingsImported": 0,
            "state": "REVERTED",
            "type": "IMPORT"
          },
          "mobilePhone1": "string",
          "preferredLanguage": "PORTUGESE"
        },
        "lastModifiedDate": "string",
        "name": "string",
        "notes": "string"
      },
      "loanName": "string",
      "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
      "lockedOperations": [
        "APPLY_FEES"
      ],
      "migrationEvent": {
        "creationDate": "2019-08-24T14:15:22Z",
        "encodedKey": "string",
        "numCentresImported": 0,
        "numClientsImported": 0,
        "numGLAccountsImported": 0,
        "numGroupsImported": 0,
        "numLoanRepaymentsImported": 0,
        "numLoanTransactionsImported": 0,
        "numLoansImported": 0,
        "numSavingsImported": 0,
        "state": "REVERTED",
        "type": "IMPORT"
      },
      "notes": "string",
      "originalAccountKey": "string",
      "paymentMethod": "VERTICAL",
      "paymentPlan": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingInstallmentPosition": 0,
          "index": 0,
          "loanAccountEncodedKey": "string",
          "pmt": 0
        }
      ],
      "penaltyBalance": 0,
      "penaltyDue": 0,
      "penaltyPaid": 0,
      "penaltyRate": 0,
      "periodicPayment": 0,
      "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
      "prepaymentRecalculationMethod": "NO_RECALCULATION",
      "principalBalance": 0,
      "principalDue": 0,
      "principalPaid": 0,
      "principalPaidInstallmentStatus": "PARTIALLY_PAID",
      "principalPaymentSettings": {
        "amount": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "includeFeesInFloorAmount": true,
        "includeInterestInFloorAmount": true,
        "percentage": 0,
        "principalCeilingValue": 0,
        "principalFloorValue": 0,
        "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
      },
      "principalRepaymentInterval": 0,
      "productTypeKey": "string",
      "redrawBalance": 0,
      "redrawSettings": {},
      "repaymentInstallments": 0,
      "repaymentPeriodCount": 0,
      "repaymentPeriodUnit": "MONTHS",
      "repaymentScheduleMethod": "FIXED",
      "rescheduledAccountKey": "string",
      "scheduleDueDatesMethod": "INTERVAL",
      "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
      "taxRate": 0,
      "tranches": [
        {
          "amount": 0,
          "disbursementTransactionKey": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "expectedDisbursementDate": "string",
          "index": 0
        }
      ]
    },
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "restrictNextDueWithdrawal": true
  },
  "repaymentInstallments": 0,
  "repaymentPeriodCount": 0,
  "repaymentPeriodUnit": "MONTHS",
  "repaymentScheduleMethod": "FIXED",
  "rescheduledAccountKey": "string",
  "scheduleDueDatesMethod": "INTERVAL",
  "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
  "taxRate": 0,
  "tranches": [
    {
      "amount": 0,
      "disbursementTransactionKey": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "expectedDisbursementDate": "string",
      "index": 0
    }
  ]
}

Properties

Name	Type	Description	Restrictions
accountArrearsSettings	AccountArrearsSettingsApiV1	none	none
accountHolderKey	string	none	none
accountHolderType	string	none	none
accountState	string	none	none
accountSubState	string	none	none
accrueInterestAfterMaturity	boolean	none	none
accrueLateInterest	boolean	none	none
accruedInterest	number	none	none
accruedPenalty	number	none	none
activationTransactionKey	string	none	none
allowOffset	boolean	none	none
applyInterestOnPrepaymentMethod	string	none	none
approvedDate	string	none	none
arrearsTolerancePeriod	number	none	none
assignedBranchKey	string	none	none
assignedCentreKey	string	none	none
assignedUserKey	string	none	none
closedDate	string	none	none
creationDate	string	the date and time when this loan account was created	none
customFieldValues	[CustomFieldValueApiV1]	none	none
daysInArrears	number	none	none
defaultFirstRepaymentDueDateOffset	number	none	none
disbursementDetails	DisbursementDetailsApiV1	none	none
elementsRecalculationMethod	string	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
feesBalance	number	none	none
feesDue	number	none	none
feesPaid	number	none	none
fixedDaysOfMonth	[number]	none	none
funds	[InvestorFundApiV1]	[An object containing information about people who may be acting as guarantor for a loan or collatoral being used, for more information please consult our p2p lending support article.]	none
futurePaymentsAcceptance	string	none	none
gracePeriod	number	none	none
gracePeriodType	string	none	none
guarantees	[GuarantyApiV1]	none	none
hasCustomSchedule	boolean	none	none
holdBalance	number	none	none
id	string	none	none
interestApplicationMethod	string	none	none
interestBalance	number	none	none
interestBalanceCalculationMethod	string	none	none
interestCalculationMethod	string	none	none
interestChargeFrequency	string	none	none
interestCommission	number	none	none
interestDue	number	none	none
interestFromArrearsAccrued	number	none	none
interestFromArrearsBalance	number	none	none
interestFromArrearsDue	number	none	none
interestFromArrearsPaid	number	none	none
interestPaid	number	none	none
interestRate	number	none	none
interestRateReviewCount	number	none	none
interestRateReviewUnit	string	none	none
interestRateSource	string	none	none
interestRoundingVersion	string	none	none
interestSpread	number	none	none
interestType	string	none	none
lastAccountAppraisalDate	string	none	none
lastInterestAppliedDate	string	none	none
lastInterestReviewDate	string	none	none
lastLockedDate	string	none	none
lastModifiedDate	string	the date on which this loan account was last modified	none
lastSetToArrearsDate	string	none	none
lastTaxRateReviewDate	string	none	none
latePaymentsRecalculationMethod	string	none	none
lineOfCreditKey	string	none	none
loanAmount	number	none	none
loanGroup	LoanGroupApiV1	none	none
loanName	string	none	none
loanPenaltyCalculationMethod	string	none	none
lockedOperations	[string]	none	none
migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
notes	string	none	none
originalAccountKey	string	none	none
paymentMethod	string	none	none
paymentPlan	[PeriodicPaymentApiV1]	none	none
penaltyBalance	number	none	none
penaltyDue	number	none	none
penaltyPaid	number	none	none
penaltyRate	number	none	none
periodicPayment	number	none	none
prepaymentAcceptance	string	none	none
prepaymentRecalculationMethod	string	none	none
principalBalance	number	none	none
principalDue	number	none	none
principalPaid	number	none	none
principalPaidInstallmentStatus	string	none	none
principalPaymentSettings	PrincipalPaymentAccountSettingsApiV1	none	none
principalRepaymentInterval	number	none	none
productTypeKey	string	none	none
redrawBalance	number	none	none
redrawSettings	LoanAccountRedrawSettingsApiV1	none	none
repaymentInstallments	number	none	none
repaymentPeriodCount	number	none	none
repaymentPeriodUnit	string	none	none
repaymentScheduleMethod	string	none	none
rescheduledAccountKey	string	none	none
scheduleDueDatesMethod	string	none	none
shortMonthHandlingMethod	string	none	none
taxRate	number	none	none
tranches	[LoanTrancheApiV1]	none	none

Enumerated Values

Property	Value
accountHolderType	`GROUP`
accountHolderType	`CLIENT`
accountState	`WITHDRAWN`
accountState	`PARTIALLY_DISBURSED`
accountState	`LOCKED`
accountState	`ACTIVE`
accountState	`CLOSED`
accountState	`PARTIAL_APPLICATION`
accountState	`LOCKED_CAPPING`
accountState	`CLOSED_REJECTED`
accountState	`RESCHEDULED`
accountState	`ACTIVE_IN_ARREARS`
accountState	`MATURED`
accountState	`CLOSED_RESCHEDULED`
accountState	`CLOSED_WITHDRAWN`
accountState	`PENDING_APPROVAL`
accountState	`APPROVED`
accountState	`REFINANCED`
accountState	`DORMANT`
accountState	`CLOSED_WRITTEN_OFF`
accountSubState	`WITHDRAWN`
accountSubState	`PARTIALLY_DISBURSED`
accountSubState	`LOCKED`
accountSubState	`ACTIVE`
accountSubState	`CLOSED`
accountSubState	`PARTIAL_APPLICATION`
accountSubState	`LOCKED_CAPPING`
accountSubState	`CLOSED_REJECTED`
accountSubState	`RESCHEDULED`
accountSubState	`ACTIVE_IN_ARREARS`
accountSubState	`MATURED`
accountSubState	`CLOSED_RESCHEDULED`
accountSubState	`CLOSED_WITHDRAWN`
accountSubState	`PENDING_APPROVAL`
accountSubState	`APPROVED`
accountSubState	`REFINANCED`
accountSubState	`DORMANT`
accountSubState	`CLOSED_WRITTEN_OFF`
applyInterestOnPrepaymentMethod	`AUTOMATIC`
applyInterestOnPrepaymentMethod	`MANUAL`
elementsRecalculationMethod	`FIXED_PRINCIPAL_EXPECTED`
elementsRecalculationMethod	`FIXED_TOTAL_EXPECTED`
futurePaymentsAcceptance	`ACCEPT_OVERPAYMENTS`
futurePaymentsAcceptance	`NO_FUTURE_PAYMENTS`
futurePaymentsAcceptance	`ACCEPT_FUTURE_PAYMENTS`
gracePeriodType	`PAY_INTEREST_ONLY`
gracePeriodType	`NONE`
gracePeriodType	`INTEREST_FORGIVENESS`
interestApplicationMethod	`ON_REPAYMENT`
interestApplicationMethod	`ON_DISBURSEMENT`
interestBalanceCalculationMethod	`PRINCIPAL_ONLY`
interestBalanceCalculationMethod	`PRINCIPAL_AND_INTEREST`
interestCalculationMethod	`DECLINING_BALANCE`
interestCalculationMethod	`DECLINING_BALANCE_DISCOUNTED`
interestCalculationMethod	`FLAT`
interestChargeFrequency	`EVERY_WEEK`
interestChargeFrequency	`ANNUALIZED`
interestChargeFrequency	`EVERY_MONTH`
interestChargeFrequency	`EVERY_X_DAYS`
interestChargeFrequency	`EVERY_FOUR_WEEKS`
interestChargeFrequency	`EVERY_DAY`
interestRateReviewUnit	`MONTHS`
interestRateReviewUnit	`WEEKS`
interestRateReviewUnit	`DAYS`
interestRateSource	`FIXED_INTEREST_RATE`
interestRateSource	`INDEX_INTEREST_RATE`
interestRoundingVersion	`VERSION_2`
interestRoundingVersion	`VERSION_1`
interestRoundingVersion	`VERSION_3`
interestType	`CAPITALIZED_INTEREST`
interestType	`SIMPLE_INTEREST`
latePaymentsRecalculationMethod	`INCREASE_OVERDUE_INSTALLMENTS`
latePaymentsRecalculationMethod	`INCREASE_LAST_INSTALLMENT`
loanPenaltyCalculationMethod	`OVERDUE_BALANCE_AND_INTEREST`
loanPenaltyCalculationMethod	`OUTSTANDING_PRINCIPAL`
loanPenaltyCalculationMethod	`OVERDUE_BALANCE`
loanPenaltyCalculationMethod	`NONE`
paymentMethod	`VERTICAL`
paymentMethod	`HORIZONTAL`
prepaymentAcceptance	`ACCEPT_PREPAYMENTS`
prepaymentAcceptance	`NO_PREPAYMENTS`
prepaymentRecalculationMethod	`NO_RECALCULATION`
prepaymentRecalculationMethod	`RECALCULATE_SCHEDULE_KEEP_SAME_NUMBER_OF_TERMS`
prepaymentRecalculationMethod	`REDUCE_AMOUNT_PER_INSTALLMENT`
prepaymentRecalculationMethod	`REDUCE_NUMBER_OF_INSTALLMENTS_NEW`
prepaymentRecalculationMethod	`REDUCE_NUMBER_OF_INSTALLMENTS`
prepaymentRecalculationMethod	`RESCHEDULE_REMAINING_REPAYMENTS`
prepaymentRecalculationMethod	`RECALCULATE_SCHEDULE_KEEP_SAME_TOTAL_REPAYMENT_AMOUNT`
prepaymentRecalculationMethod	`RECALCULATE_SCHEDULE_KEEP_SAME_PRINCIPAL_AMOUNT`
principalPaidInstallmentStatus	`PARTIALLY_PAID`
principalPaidInstallmentStatus	`ORIGINAL_TOTAL_EXPECTED_PAID`
principalPaidInstallmentStatus	`PAID`
repaymentPeriodUnit	`MONTHS`
repaymentPeriodUnit	`YEARS`
repaymentPeriodUnit	`WEEKS`
repaymentPeriodUnit	`DAYS`
repaymentScheduleMethod	`FIXED`
repaymentScheduleMethod	`NONE`
repaymentScheduleMethod	`DYNAMIC`
scheduleDueDatesMethod	`INTERVAL`
scheduleDueDatesMethod	`FIXED_DAYS_OF_MONTH`
shortMonthHandlingMethod	`LAST_DAY_IN_MONTH`
shortMonthHandlingMethod	`FIRST_DAY_OF_NEXT_MONTH`

LoanAccountApiV1Wrapper

{
  "customInformation": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "loanAccount": {
    "accountArrearsSettings": {
      "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
      "encodedKey": "string",
      "monthlyToleranceDay": 0,
      "nonWorkingDaysMethod": "EXCLUDED",
      "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY",
      "toleranceFloorAmount": 0,
      "tolerancePercentageOfOutstandingPrincipal": 0,
      "tolerancePeriod": 0
    },
    "accountHolderKey": "string",
    "accountHolderType": "GROUP",
    "accountState": "WITHDRAWN",
    "accountSubState": "WITHDRAWN",
    "accrueInterestAfterMaturity": true,
    "accrueLateInterest": true,
    "accruedInterest": 0,
    "accruedPenalty": 0,
    "activationTransactionKey": "string",
    "allowOffset": true,
    "applyInterestOnPrepaymentMethod": "AUTOMATIC",
    "approvedDate": "string",
    "arrearsTolerancePeriod": 0,
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "closedDate": "string",
    "creationDate": "string",
    "customFieldValues": [
      {
        "amount": 0,
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "customFieldID": "string",
        "customFieldKey": "string",
        "customFieldSetGroupIndex": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexInList": 0,
        "linkedEntityKeyValue": "string",
        "parentKey": "string",
        "selectionKey": "string",
        "value": "string"
      }
    ],
    "daysInArrears": 0,
    "defaultFirstRepaymentDueDateOffset": 0,
    "disbursementDetails": {
      "customInformation": [
        {
          "amount": 0,
          "customField": {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "customFieldID": "string",
          "customFieldKey": "string",
          "customFieldSetGroupIndex": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "linkedEntityKeyValue": "string",
          "parentKey": "string",
          "selectionKey": "string",
          "value": "string"
        }
      ],
      "disbursementDate": "string",
      "encodedKey": "string",
      "expectedDisbursementDate": "string",
      "fees": [
        {
          "amount": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "fee": {
            "active": true,
            "amortizationIntervalSettings": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
              "intervalCount": 0,
              "intervalType": "FULL_TERM",
              "periodCount": 0,
              "periodUnit": "MONTHS"
            },
            "amortizationProfile": "STRAIGHT_LINE",
            "amount": 0,
            "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
            "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
            "creationDate": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
            "feeApplication": "OPTIONAL",
            "feeProductRules": [
              {
                "account": {
                  "activated": true,
                  "allowManualJournalEntries": true,
                  "balance": 0,
                  "creationDate": "2019-08-24T14:15:22Z",
                  "currency": {
                    "code": "string",
                    "creationDate": "string",
                    "currencySymbolPosition": "AFTER_NUMBER",
                    "digitsAfterDecimal": 0,
                    "isBaseCurrency": true,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "symbol": "string"
                  },
                  "description": "string",
                  "encodedKey": "string",
                  "glCode": "string",
                  "lastModifiedDate": "2019-08-24T14:15:22Z",
                  "migrationEvent": {
                    "creationDate": "2019-08-24T14:15:22Z",
                    "encodedKey": "string",
                    "numCentresImported": 0,
                    "numClientsImported": 0,
                    "numGLAccountsImported": 0,
                    "numGroupsImported": 0,
                    "numLoanRepaymentsImported": 0,
                    "numLoanTransactionsImported": 0,
                    "numLoansImported": 0,
                    "numSavingsImported": 0,
                    "state": "REVERTED",
                    "type": "IMPORT"
                  },
                  "name": "string",
                  "stripTrailingZeros": true,
                  "type": "INCOME",
                  "usage": "HEADER"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "financialResource": "FEE_RECEIVABLE",
                "index": 0,
                "predefinedFeeKey": "string",
                "productKey": "string",
                "productType": "LOAN",
                "transactionChannelKey": "string"
              }
            ],
            "name": "string",
            "percentageAmount": 0,
            "trigger": "DISBURSEMENT"
          }
        }
      ],
      "firstRepaymentDate": "string",
      "transactionDetails": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "internalTransfer": true,
        "targetSavingsAccountKey": "string",
        "transactionChannel": {
          "activated": true,
          "createdByUserKey": "string",
          "creationDate": "string",
          "customFields": [
            {
              "amounts": {
                "property1": 0,
                "property2": 0
              },
              "builtInCustomFieldId": "MOBILE_PHONE",
              "creationDate": "string",
              "customFieldProductSettings": [
                {
                  "customFieldEncodedKey": "string",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isDefault": true,
                  "isRequired": true,
                  "linkType": "CLIENT_ROLE",
                  "productKey": "string"
                }
              ],
              "customFieldSelectionOptions": [
                {
                  "constraint": {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "score": 0,
                  "value": "string"
                }
              ],
              "customFieldSet": {
                "builtInType": "DETAILS",
                "createdDate": "string",
                "customFields": [
                  {}
                ],
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "notes": "string",
                "type": "USER_INFO",
                "usage": "SINGLE"
              },
              "dataType": "GROUP_LINK",
              "description": "string",
              "editRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "isDefault": true,
              "isRequired": true,
              "lastModifiedDate": "string",
              "name": "string",
              "state": "DEACTIVATED",
              "type": "USER_INFO",
              "unique": true,
              "validationPattern": "string",
              "valueLength": "SHORT",
              "values": [
                "string"
              ],
              "viewRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            }
          ],
          "encodedKey": "string",
          "id": "string",
          "index": 0,
          "loanConstraints": {
            "customConfigurationInfo": {
              "creationDate": "string",
              "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "shared": true,
              "userKey": "string"
            },
            "encodedKey": "string",
            "filterConstraints": [
              {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              }
            ]
          },
          "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
          "name": "string",
          "savingsConstraints": {
            "customConfigurationInfo": {
              "creationDate": "string",
              "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "shared": true,
              "userKey": "string"
            },
            "encodedKey": "string",
            "filterConstraints": [
              {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              }
            ]
          },
          "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
          "transactionChannelAccountingRule": {
            "account": {
              "activated": true,
              "allowManualJournalEntries": true,
              "balance": 0,
              "creationDate": "2019-08-24T14:15:22Z",
              "currency": {
                "code": "string",
                "creationDate": "string",
                "currencySymbolPosition": "AFTER_NUMBER",
                "digitsAfterDecimal": 0,
                "isBaseCurrency": true,
                "lastModifiedDate": "string",
                "name": "string",
                "symbol": "string"
              },
              "description": "string",
              "encodedKey": "string",
              "glCode": "string",
              "lastModifiedDate": "2019-08-24T14:15:22Z",
              "migrationEvent": {
                "creationDate": "2019-08-24T14:15:22Z",
                "encodedKey": "string",
                "numCentresImported": 0,
                "numClientsImported": 0,
                "numGLAccountsImported": 0,
                "numGroupsImported": 0,
                "numLoanRepaymentsImported": 0,
                "numLoanTransactionsImported": 0,
                "numLoansImported": 0,
                "numSavingsImported": 0,
                "state": "REVERTED",
                "type": "IMPORT"
              },
              "name": "string",
              "stripTrailingZeros": true,
              "type": "INCOME",
              "usage": "HEADER"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "financialResource": "FEE_RECEIVABLE",
            "index": 0,
            "predefinedFeeKey": "string",
            "productKey": "string",
            "productType": "LOAN",
            "transactionChannelKey": "string"
          },
          "usageRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "transactionChannelKey": "string"
      }
    },
    "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "feesBalance": 0,
    "feesDue": 0,
    "feesPaid": 0,
    "fixedDaysOfMonth": [
      0
    ],
    "funds": [
      {
        "amount": 0,
        "assetName": "string",
        "customFieldValues": [
          {
            "amount": 0,
            "customField": {
              "amounts": {
                "property1": 0,
                "property2": 0
              },
              "builtInCustomFieldId": "MOBILE_PHONE",
              "creationDate": "string",
              "customFieldProductSettings": [
                {
                  "customFieldEncodedKey": "string",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isDefault": true,
                  "isRequired": true,
                  "linkType": "CLIENT_ROLE",
                  "productKey": "string"
                }
              ],
              "customFieldSelectionOptions": [
                {
                  "constraint": {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "score": 0,
                  "value": "string"
                }
              ],
              "customFieldSet": {
                "builtInType": "DETAILS",
                "createdDate": "string",
                "customFields": [
                  {}
                ],
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "notes": "string",
                "type": "USER_INFO",
                "usage": "SINGLE"
              },
              "dataType": "GROUP_LINK",
              "description": "string",
              "editRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "isDefault": true,
              "isRequired": true,
              "lastModifiedDate": "string",
              "name": "string",
              "state": "DEACTIVATED",
              "type": "USER_INFO",
              "unique": true,
              "validationPattern": "string",
              "valueLength": "SHORT",
              "values": [
                "string"
              ],
              "viewRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "customFieldID": "string",
            "customFieldKey": "string",
            "customFieldSetGroupIndex": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "linkedEntityKeyValue": "string",
            "parentKey": "string",
            "selectionKey": "string",
            "value": "string"
          }
        ],
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "guarantorKey": "string",
        "guarantorType": "GROUP",
        "id": "string",
        "interestCommission": 0,
        "investmentPercentage": 0,
        "savingsAccountKey": "string",
        "type": "GUARANTOR"
      }
    ],
    "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
    "gracePeriod": 0,
    "gracePeriodType": "PAY_INTEREST_ONLY",
    "guarantees": [
      {
        "amount": 0,
        "assetName": "string",
        "customFieldValues": [
          {
            "amount": 0,
            "customField": {
              "amounts": {
                "property1": 0,
                "property2": 0
              },
              "builtInCustomFieldId": "MOBILE_PHONE",
              "creationDate": "string",
              "customFieldProductSettings": [
                {
                  "customFieldEncodedKey": "string",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isDefault": true,
                  "isRequired": true,
                  "linkType": "CLIENT_ROLE",
                  "productKey": "string"
                }
              ],
              "customFieldSelectionOptions": [
                {
                  "constraint": {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "score": 0,
                  "value": "string"
                }
              ],
              "customFieldSet": {
                "builtInType": "DETAILS",
                "createdDate": "string",
                "customFields": [
                  {}
                ],
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "notes": "string",
                "type": "USER_INFO",
                "usage": "SINGLE"
              },
              "dataType": "GROUP_LINK",
              "description": "string",
              "editRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "isDefault": true,
              "isRequired": true,
              "lastModifiedDate": "string",
              "name": "string",
              "state": "DEACTIVATED",
              "type": "USER_INFO",
              "unique": true,
              "validationPattern": "string",
              "valueLength": "SHORT",
              "values": [
                "string"
              ],
              "viewRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "customFieldID": "string",
            "customFieldKey": "string",
            "customFieldSetGroupIndex": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "linkedEntityKeyValue": "string",
            "parentKey": "string",
            "selectionKey": "string",
            "value": "string"
          }
        ],
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "guarantorKey": "string",
        "guarantorType": "GROUP",
        "savingsAccountKey": "string",
        "type": "GUARANTOR"
      }
    ],
    "hasCustomSchedule": true,
    "holdBalance": 0,
    "id": "string",
    "interestApplicationMethod": "ON_REPAYMENT",
    "interestBalance": 0,
    "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
    "interestCalculationMethod": "DECLINING_BALANCE",
    "interestChargeFrequency": "EVERY_WEEK",
    "interestCommission": 0,
    "interestDue": 0,
    "interestFromArrearsAccrued": 0,
    "interestFromArrearsBalance": 0,
    "interestFromArrearsDue": 0,
    "interestFromArrearsPaid": 0,
    "interestPaid": 0,
    "interestRate": 0,
    "interestRateReviewCount": 0,
    "interestRateReviewUnit": "MONTHS",
    "interestRateSource": "FIXED_INTEREST_RATE",
    "interestRoundingVersion": "VERSION_2",
    "interestSpread": 0,
    "interestType": "CAPITALIZED_INTEREST",
    "lastAccountAppraisalDate": "string",
    "lastInterestAppliedDate": "string",
    "lastInterestReviewDate": "string",
    "lastLockedDate": "string",
    "lastModifiedDate": "string",
    "lastSetToArrearsDate": "string",
    "lastTaxRateReviewDate": "string",
    "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
    "lineOfCreditKey": "string",
    "loanAmount": 0,
    "loanGroup": {
      "accounts": [
        {}
      ],
      "creationDate": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "group": {
        "assignedBranchKey": "string",
        "assignedCentreKey": "string",
        "assignedUserKey": "string",
        "clientRole": {
          "encodedKey": "string"
        },
        "creationDate": "2019-08-24T14:15:22Z",
        "emailAddress": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "groupName": "string",
        "homePhone": "string",
        "id": "string",
        "idPattern": "string",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "loanCycle": 0,
        "migrationEvent": {
          "creationDate": "2019-08-24T14:15:22Z",
          "encodedKey": "string",
          "numCentresImported": 0,
          "numClientsImported": 0,
          "numGLAccountsImported": 0,
          "numGroupsImported": 0,
          "numLoanRepaymentsImported": 0,
          "numLoanTransactionsImported": 0,
          "numLoansImported": 0,
          "numSavingsImported": 0,
          "state": "REVERTED",
          "type": "IMPORT"
        },
        "mobilePhone1": "string",
        "preferredLanguage": "PORTUGESE"
      },
      "lastModifiedDate": "string",
      "name": "string",
      "notes": "string"
    },
    "loanName": "string",
    "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
    "lockedOperations": [
      "APPLY_FEES"
    ],
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "notes": "string",
    "originalAccountKey": "string",
    "paymentMethod": "VERTICAL",
    "paymentPlan": [
      {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "endingInstallmentPosition": 0,
        "index": 0,
        "loanAccountEncodedKey": "string",
        "pmt": 0
      }
    ],
    "penaltyBalance": 0,
    "penaltyDue": 0,
    "penaltyPaid": 0,
    "penaltyRate": 0,
    "periodicPayment": 0,
    "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
    "prepaymentRecalculationMethod": "NO_RECALCULATION",
    "principalBalance": 0,
    "principalDue": 0,
    "principalPaid": 0,
    "principalPaidInstallmentStatus": "PARTIALLY_PAID",
    "principalPaymentSettings": {
      "amount": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "includeFeesInFloorAmount": true,
      "includeInterestInFloorAmount": true,
      "percentage": 0,
      "principalCeilingValue": 0,
      "principalFloorValue": 0,
      "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
    },
    "principalRepaymentInterval": 0,
    "productTypeKey": "string",
    "redrawBalance": 0,
    "redrawSettings": {
      "account": {},
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "restrictNextDueWithdrawal": true
    },
    "repaymentInstallments": 0,
    "repaymentPeriodCount": 0,
    "repaymentPeriodUnit": "MONTHS",
    "repaymentScheduleMethod": "FIXED",
    "rescheduledAccountKey": "string",
    "scheduleDueDatesMethod": "INTERVAL",
    "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
    "taxRate": 0,
    "tranches": [
      {
        "amount": 0,
        "disbursementTransactionKey": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "expectedDisbursementDate": "string",
        "index": 0
      }
    ]
  }
}

Properties

Name	Type	Description	Restrictions
customInformation	[CustomFieldValueApiV1]	none	none
loanAccount	LoanAccountApiV1	none	none

LoanAccountFullDetailsApiV1

{
  "accountArrearsSettings": {
    "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
    "encodedKey": "string",
    "monthlyToleranceDay": 0,
    "nonWorkingDaysMethod": "EXCLUDED",
    "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY",
    "toleranceFloorAmount": 0,
    "tolerancePercentageOfOutstandingPrincipal": 0,
    "tolerancePeriod": 0
  },
  "accountHolderKey": "string",
  "accountHolderType": "GROUP",
  "accountState": "WITHDRAWN",
  "accountSubState": "WITHDRAWN",
  "accrueInterestAfterMaturity": true,
  "accrueLateInterest": true,
  "accruedInterest": 0,
  "accruedPenalty": 0,
  "activationTransactionKey": "string",
  "allowOffset": true,
  "applyInterestOnPrepaymentMethod": "AUTOMATIC",
  "approvedDate": "string",
  "arrearsTolerancePeriod": 0,
  "assignedBranchKey": "string",
  "assignedCentreKey": "string",
  "assignedUserKey": "string",
  "closedDate": "string",
  "creationDate": "string",
  "customFieldValues": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "daysInArrears": 0,
  "defaultFirstRepaymentDueDateOffset": 0,
  "disbursementDetails": {
    "customInformation": [
      {
        "amount": 0,
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "customFieldID": "string",
        "customFieldKey": "string",
        "customFieldSetGroupIndex": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexInList": 0,
        "linkedEntityKeyValue": "string",
        "parentKey": "string",
        "selectionKey": "string",
        "value": "string"
      }
    ],
    "disbursementDate": "string",
    "encodedKey": "string",
    "expectedDisbursementDate": "string",
    "fees": [
      {
        "amount": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "fee": {
          "active": true,
          "amortizationIntervalSettings": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
            "intervalCount": 0,
            "intervalType": "FULL_TERM",
            "periodCount": 0,
            "periodUnit": "MONTHS"
          },
          "amortizationProfile": "STRAIGHT_LINE",
          "amount": 0,
          "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
          "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
          "creationDate": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
          "feeApplication": "OPTIONAL",
          "feeProductRules": [
            {
              "account": {
                "activated": true,
                "allowManualJournalEntries": true,
                "balance": 0,
                "creationDate": "2019-08-24T14:15:22Z",
                "currency": {
                  "code": "string",
                  "creationDate": "string",
                  "currencySymbolPosition": "AFTER_NUMBER",
                  "digitsAfterDecimal": 0,
                  "isBaseCurrency": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "symbol": "string"
                },
                "description": "string",
                "encodedKey": "string",
                "glCode": "string",
                "lastModifiedDate": "2019-08-24T14:15:22Z",
                "migrationEvent": {
                  "creationDate": "2019-08-24T14:15:22Z",
                  "encodedKey": "string",
                  "numCentresImported": 0,
                  "numClientsImported": 0,
                  "numGLAccountsImported": 0,
                  "numGroupsImported": 0,
                  "numLoanRepaymentsImported": 0,
                  "numLoanTransactionsImported": 0,
                  "numLoansImported": 0,
                  "numSavingsImported": 0,
                  "state": "REVERTED",
                  "type": "IMPORT"
                },
                "name": "string",
                "stripTrailingZeros": true,
                "type": "INCOME",
                "usage": "HEADER"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "financialResource": "FEE_RECEIVABLE",
              "index": 0,
              "predefinedFeeKey": "string",
              "productKey": "string",
              "productType": "LOAN",
              "transactionChannelKey": "string"
            }
          ],
          "name": "string",
          "percentageAmount": 0,
          "trigger": "DISBURSEMENT"
        }
      }
    ],
    "firstRepaymentDate": "string",
    "transactionDetails": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "internalTransfer": true,
      "targetSavingsAccountKey": "string",
      "transactionChannel": {
        "activated": true,
        "createdByUserKey": "string",
        "creationDate": "string",
        "customFields": [
          {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          }
        ],
        "encodedKey": "string",
        "id": "string",
        "index": 0,
        "loanConstraints": {
          "customConfigurationInfo": {
            "creationDate": "string",
            "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "shared": true,
            "userKey": "string"
          },
          "encodedKey": "string",
          "filterConstraints": [
            {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            }
          ]
        },
        "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
        "name": "string",
        "savingsConstraints": {
          "customConfigurationInfo": {
            "creationDate": "string",
            "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "shared": true,
            "userKey": "string"
          },
          "encodedKey": "string",
          "filterConstraints": [
            {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            }
          ]
        },
        "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
        "transactionChannelAccountingRule": {
          "account": {
            "activated": true,
            "allowManualJournalEntries": true,
            "balance": 0,
            "creationDate": "2019-08-24T14:15:22Z",
            "currency": {
              "code": "string",
              "creationDate": "string",
              "currencySymbolPosition": "AFTER_NUMBER",
              "digitsAfterDecimal": 0,
              "isBaseCurrency": true,
              "lastModifiedDate": "string",
              "name": "string",
              "symbol": "string"
            },
            "description": "string",
            "encodedKey": "string",
            "glCode": "string",
            "lastModifiedDate": "2019-08-24T14:15:22Z",
            "migrationEvent": {
              "creationDate": "2019-08-24T14:15:22Z",
              "encodedKey": "string",
              "numCentresImported": 0,
              "numClientsImported": 0,
              "numGLAccountsImported": 0,
              "numGroupsImported": 0,
              "numLoanRepaymentsImported": 0,
              "numLoanTransactionsImported": 0,
              "numLoansImported": 0,
              "numSavingsImported": 0,
              "state": "REVERTED",
              "type": "IMPORT"
            },
            "name": "string",
            "stripTrailingZeros": true,
            "type": "INCOME",
            "usage": "HEADER"
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "financialResource": "FEE_RECEIVABLE",
          "index": 0,
          "predefinedFeeKey": "string",
          "productKey": "string",
          "productType": "LOAN",
          "transactionChannelKey": "string"
        },
        "usageRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "transactionChannelKey": "string"
    }
  },
  "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "feesBalance": 0,
  "feesDue": 0,
  "feesPaid": 0,
  "fixedDaysOfMonth": [
    0
  ],
  "funds": [
    {
      "amount": 0,
      "assetName": "string",
      "customFieldValues": [
        {
          "amount": 0,
          "customField": {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "customFieldID": "string",
          "customFieldKey": "string",
          "customFieldSetGroupIndex": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "linkedEntityKeyValue": "string",
          "parentKey": "string",
          "selectionKey": "string",
          "value": "string"
        }
      ],
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "guarantorKey": "string",
      "guarantorType": "GROUP",
      "id": "string",
      "interestCommission": 0,
      "investmentPercentage": 0,
      "savingsAccountKey": "string",
      "type": "GUARANTOR"
    }
  ],
  "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
  "gracePeriod": 0,
  "gracePeriodType": "PAY_INTEREST_ONLY",
  "guarantees": [
    {
      "amount": 0,
      "assetName": "string",
      "customFieldValues": [
        {
          "amount": 0,
          "customField": {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "customFieldID": "string",
          "customFieldKey": "string",
          "customFieldSetGroupIndex": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "linkedEntityKeyValue": "string",
          "parentKey": "string",
          "selectionKey": "string",
          "value": "string"
        }
      ],
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "guarantorKey": "string",
      "guarantorType": "GROUP",
      "savingsAccountKey": "string",
      "type": "GUARANTOR"
    }
  ],
  "hasCustomSchedule": true,
  "holdBalance": 0,
  "id": "string",
  "interestApplicationMethod": "ON_REPAYMENT",
  "interestBalance": 0,
  "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
  "interestCalculationMethod": "DECLINING_BALANCE",
  "interestChargeFrequency": "EVERY_WEEK",
  "interestCommission": 0,
  "interestDue": 0,
  "interestFromArrearsAccrued": 0,
  "interestFromArrearsBalance": 0,
  "interestFromArrearsDue": 0,
  "interestFromArrearsPaid": 0,
  "interestPaid": 0,
  "interestRate": 0,
  "interestRateReviewCount": 0,
  "interestRateReviewUnit": "MONTHS",
  "interestRateSource": "FIXED_INTEREST_RATE",
  "interestRoundingVersion": "VERSION_2",
  "interestSpread": 0,
  "interestType": "CAPITALIZED_INTEREST",
  "lastAccountAppraisalDate": "string",
  "lastInterestAppliedDate": "string",
  "lastInterestReviewDate": "string",
  "lastLockedDate": "string",
  "lastModifiedDate": "string",
  "lastSetToArrearsDate": "string",
  "lastTaxRateReviewDate": "string",
  "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
  "lineOfCreditKey": "string",
  "loanAmount": 0,
  "loanGroup": {
    "accounts": [
      {
        "accountArrearsSettings": {
          "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
          "encodedKey": "string",
          "monthlyToleranceDay": 0,
          "nonWorkingDaysMethod": "EXCLUDED",
          "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY",
          "toleranceFloorAmount": 0,
          "tolerancePercentageOfOutstandingPrincipal": 0,
          "tolerancePeriod": 0
        },
        "accountHolderKey": "string",
        "accountHolderType": "GROUP",
        "accountState": "WITHDRAWN",
        "accountSubState": "WITHDRAWN",
        "accrueInterestAfterMaturity": true,
        "accrueLateInterest": true,
        "accruedInterest": 0,
        "accruedPenalty": 0,
        "activationTransactionKey": "string",
        "allowOffset": true,
        "applyInterestOnPrepaymentMethod": "AUTOMATIC",
        "approvedDate": "string",
        "arrearsTolerancePeriod": 0,
        "assignedBranchKey": "string",
        "assignedCentreKey": "string",
        "assignedUserKey": "string",
        "closedDate": "string",
        "creationDate": "string",
        "customFieldValues": [
          {
            "amount": 0,
            "customField": {
              "amounts": {
                "property1": 0,
                "property2": 0
              },
              "builtInCustomFieldId": "MOBILE_PHONE",
              "creationDate": "string",
              "customFieldProductSettings": [
                {
                  "customFieldEncodedKey": "string",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isDefault": true,
                  "isRequired": true,
                  "linkType": "CLIENT_ROLE",
                  "productKey": "string"
                }
              ],
              "customFieldSelectionOptions": [
                {
                  "constraint": {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "score": 0,
                  "value": "string"
                }
              ],
              "customFieldSet": {
                "builtInType": "DETAILS",
                "createdDate": "string",
                "customFields": [
                  {}
                ],
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "notes": "string",
                "type": "USER_INFO",
                "usage": "SINGLE"
              },
              "dataType": "GROUP_LINK",
              "description": "string",
              "editRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "isDefault": true,
              "isRequired": true,
              "lastModifiedDate": "string",
              "name": "string",
              "state": "DEACTIVATED",
              "type": "USER_INFO",
              "unique": true,
              "validationPattern": "string",
              "valueLength": "SHORT",
              "values": [
                "string"
              ],
              "viewRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "customFieldID": "string",
            "customFieldKey": "string",
            "customFieldSetGroupIndex": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "linkedEntityKeyValue": "string",
            "parentKey": "string",
            "selectionKey": "string",
            "value": "string"
          }
        ],
        "daysInArrears": 0,
        "defaultFirstRepaymentDueDateOffset": 0,
        "disbursementDetails": {
          "customInformation": [
            {
              "amount": 0,
              "customField": {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              },
              "customFieldID": "string",
              "customFieldKey": "string",
              "customFieldSetGroupIndex": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "linkedEntityKeyValue": "string",
              "parentKey": "string",
              "selectionKey": "string",
              "value": "string"
            }
          ],
          "disbursementDate": "string",
          "encodedKey": "string",
          "expectedDisbursementDate": "string",
          "fees": [
            {
              "amount": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "fee": {
                "active": true,
                "amortizationIntervalSettings": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
                  "intervalCount": 0,
                  "intervalType": "FULL_TERM",
                  "periodCount": 0,
                  "periodUnit": "MONTHS"
                },
                "amortizationProfile": "STRAIGHT_LINE",
                "amount": 0,
                "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
                "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
                "creationDate": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
                "feeApplication": "OPTIONAL",
                "feeProductRules": [
                  {
                    "account": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "financialResource": "FEE_RECEIVABLE",
                    "index": 0,
                    "predefinedFeeKey": "string",
                    "productKey": "string",
                    "productType": "LOAN",
                    "transactionChannelKey": "string"
                  }
                ],
                "name": "string",
                "percentageAmount": 0,
                "trigger": "DISBURSEMENT"
              }
            }
          ],
          "firstRepaymentDate": "string",
          "transactionDetails": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "internalTransfer": true,
            "targetSavingsAccountKey": "string",
            "transactionChannel": {
              "activated": true,
              "createdByUserKey": "string",
              "creationDate": "string",
              "customFields": [
                {
                  "amounts": {
                    "property1": 0,
                    "property2": 0
                  },
                  "builtInCustomFieldId": "MOBILE_PHONE",
                  "creationDate": "string",
                  "customFieldProductSettings": [
                    {}
                  ],
                  "customFieldSelectionOptions": [
                    {}
                  ],
                  "customFieldSet": {
                    "builtInType": "DETAILS",
                    "createdDate": "string",
                    "customFields": [],
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "indexInList": 0,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "notes": "string",
                    "type": "USER_INFO",
                    "usage": "SINGLE"
                  },
                  "dataType": "GROUP_LINK",
                  "description": "string",
                  "editRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "isDefault": true,
                  "isRequired": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "state": "DEACTIVATED",
                  "type": "USER_INFO",
                  "unique": true,
                  "validationPattern": "string",
                  "valueLength": "SHORT",
                  "values": [
                    "string"
                  ],
                  "viewRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  }
                }
              ],
              "encodedKey": "string",
              "id": "string",
              "index": 0,
              "loanConstraints": {
                "customConfigurationInfo": {
                  "creationDate": "string",
                  "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "shared": true,
                  "userKey": "string"
                },
                "encodedKey": "string",
                "filterConstraints": [
                  {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  }
                ]
              },
              "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
              "name": "string",
              "savingsConstraints": {
                "customConfigurationInfo": {
                  "creationDate": "string",
                  "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "shared": true,
                  "userKey": "string"
                },
                "encodedKey": "string",
                "filterConstraints": [
                  {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  }
                ]
              },
              "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
              "transactionChannelAccountingRule": {
                "account": {
                  "activated": true,
                  "allowManualJournalEntries": true,
                  "balance": 0,
                  "creationDate": "2019-08-24T14:15:22Z",
                  "currency": {
                    "code": "string",
                    "creationDate": "string",
                    "currencySymbolPosition": "AFTER_NUMBER",
                    "digitsAfterDecimal": 0,
                    "isBaseCurrency": true,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "symbol": "string"
                  },
                  "description": "string",
                  "encodedKey": "string",
                  "glCode": "string",
                  "lastModifiedDate": "2019-08-24T14:15:22Z",
                  "migrationEvent": {
                    "creationDate": "2019-08-24T14:15:22Z",
                    "encodedKey": "string",
                    "numCentresImported": 0,
                    "numClientsImported": 0,
                    "numGLAccountsImported": 0,
                    "numGroupsImported": 0,
                    "numLoanRepaymentsImported": 0,
                    "numLoanTransactionsImported": 0,
                    "numLoansImported": 0,
                    "numSavingsImported": 0,
                    "state": "REVERTED",
                    "type": "IMPORT"
                  },
                  "name": "string",
                  "stripTrailingZeros": true,
                  "type": "INCOME",
                  "usage": "HEADER"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "financialResource": "FEE_RECEIVABLE",
                "index": 0,
                "predefinedFeeKey": "string",
                "productKey": "string",
                "productType": "LOAN",
                "transactionChannelKey": "string"
              },
              "usageRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "transactionChannelKey": "string"
          }
        },
        "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "feesBalance": 0,
        "feesDue": 0,
        "feesPaid": 0,
        "fixedDaysOfMonth": [
          0
        ],
        "funds": [
          {
            "amount": 0,
            "assetName": "string",
            "customFieldValues": [
              {
                "amount": 0,
                "customField": {
                  "amounts": {
                    "property1": 0,
                    "property2": 0
                  },
                  "builtInCustomFieldId": "MOBILE_PHONE",
                  "creationDate": "string",
                  "customFieldProductSettings": [
                    {}
                  ],
                  "customFieldSelectionOptions": [
                    {}
                  ],
                  "customFieldSet": {
                    "builtInType": "DETAILS",
                    "createdDate": "string",
                    "customFields": [],
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "indexInList": 0,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "notes": "string",
                    "type": "USER_INFO",
                    "usage": "SINGLE"
                  },
                  "dataType": "GROUP_LINK",
                  "description": "string",
                  "editRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "isDefault": true,
                  "isRequired": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "state": "DEACTIVATED",
                  "type": "USER_INFO",
                  "unique": true,
                  "validationPattern": "string",
                  "valueLength": "SHORT",
                  "values": [
                    "string"
                  ],
                  "viewRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  }
                },
                "customFieldID": "string",
                "customFieldKey": "string",
                "customFieldSetGroupIndex": 0,
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "linkedEntityKeyValue": "string",
                "parentKey": "string",
                "selectionKey": "string",
                "value": "string"
              }
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "guarantorKey": "string",
            "guarantorType": "GROUP",
            "id": "string",
            "interestCommission": 0,
            "investmentPercentage": 0,
            "savingsAccountKey": "string",
            "type": "GUARANTOR"
          }
        ],
        "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
        "gracePeriod": 0,
        "gracePeriodType": "PAY_INTEREST_ONLY",
        "guarantees": [
          {
            "amount": 0,
            "assetName": "string",
            "customFieldValues": [
              {
                "amount": 0,
                "customField": {
                  "amounts": {
                    "property1": 0,
                    "property2": 0
                  },
                  "builtInCustomFieldId": "MOBILE_PHONE",
                  "creationDate": "string",
                  "customFieldProductSettings": [
                    {}
                  ],
                  "customFieldSelectionOptions": [
                    {}
                  ],
                  "customFieldSet": {
                    "builtInType": "DETAILS",
                    "createdDate": "string",
                    "customFields": [],
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "indexInList": 0,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "notes": "string",
                    "type": "USER_INFO",
                    "usage": "SINGLE"
                  },
                  "dataType": "GROUP_LINK",
                  "description": "string",
                  "editRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "isDefault": true,
                  "isRequired": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "state": "DEACTIVATED",
                  "type": "USER_INFO",
                  "unique": true,
                  "validationPattern": "string",
                  "valueLength": "SHORT",
                  "values": [
                    "string"
                  ],
                  "viewRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  }
                },
                "customFieldID": "string",
                "customFieldKey": "string",
                "customFieldSetGroupIndex": 0,
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "linkedEntityKeyValue": "string",
                "parentKey": "string",
                "selectionKey": "string",
                "value": "string"
              }
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "guarantorKey": "string",
            "guarantorType": "GROUP",
            "savingsAccountKey": "string",
            "type": "GUARANTOR"
          }
        ],
        "hasCustomSchedule": true,
        "holdBalance": 0,
        "id": "string",
        "interestApplicationMethod": "ON_REPAYMENT",
        "interestBalance": 0,
        "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
        "interestCalculationMethod": "DECLINING_BALANCE",
        "interestChargeFrequency": "EVERY_WEEK",
        "interestCommission": 0,
        "interestDue": 0,
        "interestFromArrearsAccrued": 0,
        "interestFromArrearsBalance": 0,
        "interestFromArrearsDue": 0,
        "interestFromArrearsPaid": 0,
        "interestPaid": 0,
        "interestRate": 0,
        "interestRateReviewCount": 0,
        "interestRateReviewUnit": "MONTHS",
        "interestRateSource": "FIXED_INTEREST_RATE",
        "interestRoundingVersion": "VERSION_2",
        "interestSpread": 0,
        "interestType": "CAPITALIZED_INTEREST",
        "lastAccountAppraisalDate": "string",
        "lastInterestAppliedDate": "string",
        "lastInterestReviewDate": "string",
        "lastLockedDate": "string",
        "lastModifiedDate": "string",
        "lastSetToArrearsDate": "string",
        "lastTaxRateReviewDate": "string",
        "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
        "lineOfCreditKey": "string",
        "loanAmount": 0,
        "loanGroup": {},
        "loanName": "string",
        "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
        "lockedOperations": [
          "APPLY_FEES"
        ],
        "migrationEvent": {
          "creationDate": "2019-08-24T14:15:22Z",
          "encodedKey": "string",
          "numCentresImported": 0,
          "numClientsImported": 0,
          "numGLAccountsImported": 0,
          "numGroupsImported": 0,
          "numLoanRepaymentsImported": 0,
          "numLoanTransactionsImported": 0,
          "numLoansImported": 0,
          "numSavingsImported": 0,
          "state": "REVERTED",
          "type": "IMPORT"
        },
        "notes": "string",
        "originalAccountKey": "string",
        "paymentMethod": "VERTICAL",
        "paymentPlan": [
          {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "endingInstallmentPosition": 0,
            "index": 0,
            "loanAccountEncodedKey": "string",
            "pmt": 0
          }
        ],
        "penaltyBalance": 0,
        "penaltyDue": 0,
        "penaltyPaid": 0,
        "penaltyRate": 0,
        "periodicPayment": 0,
        "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
        "prepaymentRecalculationMethod": "NO_RECALCULATION",
        "principalBalance": 0,
        "principalDue": 0,
        "principalPaid": 0,
        "principalPaidInstallmentStatus": "PARTIALLY_PAID",
        "principalPaymentSettings": {
          "amount": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "includeFeesInFloorAmount": true,
          "includeInterestInFloorAmount": true,
          "percentage": 0,
          "principalCeilingValue": 0,
          "principalFloorValue": 0,
          "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
        },
        "principalRepaymentInterval": 0,
        "productTypeKey": "string",
        "redrawBalance": 0,
        "redrawSettings": {
          "account": {},
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "restrictNextDueWithdrawal": true
        },
        "repaymentInstallments": 0,
        "repaymentPeriodCount": 0,
        "repaymentPeriodUnit": "MONTHS",
        "repaymentScheduleMethod": "FIXED",
        "rescheduledAccountKey": "string",
        "scheduleDueDatesMethod": "INTERVAL",
        "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
        "taxRate": 0,
        "tranches": [
          {
            "amount": 0,
            "disbursementTransactionKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "expectedDisbursementDate": "string",
            "index": 0
          }
        ]
      }
    ],
    "creationDate": "string",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "group": {
      "assignedBranchKey": "string",
      "assignedCentreKey": "string",
      "assignedUserKey": "string",
      "clientRole": {
        "encodedKey": "string"
      },
      "creationDate": "2019-08-24T14:15:22Z",
      "emailAddress": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "groupName": "string",
      "homePhone": "string",
      "id": "string",
      "idPattern": "string",
      "lastModifiedDate": "2019-08-24T14:15:22Z",
      "loanCycle": 0,
      "migrationEvent": {
        "creationDate": "2019-08-24T14:15:22Z",
        "encodedKey": "string",
        "numCentresImported": 0,
        "numClientsImported": 0,
        "numGLAccountsImported": 0,
        "numGroupsImported": 0,
        "numLoanRepaymentsImported": 0,
        "numLoanTransactionsImported": 0,
        "numLoansImported": 0,
        "numSavingsImported": 0,
        "state": "REVERTED",
        "type": "IMPORT"
      },
      "mobilePhone1": "string",
      "preferredLanguage": "PORTUGESE"
    },
    "lastModifiedDate": "string",
    "name": "string",
    "notes": "string"
  },
  "loanName": "string",
  "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
  "lockedOperations": [
    "APPLY_FEES"
  ],
  "migrationEvent": {
    "creationDate": "2019-08-24T14:15:22Z",
    "encodedKey": "string",
    "numCentresImported": 0,
    "numClientsImported": 0,
    "numGLAccountsImported": 0,
    "numGroupsImported": 0,
    "numLoanRepaymentsImported": 0,
    "numLoanTransactionsImported": 0,
    "numLoansImported": 0,
    "numSavingsImported": 0,
    "state": "REVERTED",
    "type": "IMPORT"
  },
  "notes": "string",
  "originalAccountKey": "string",
  "paymentMethod": "VERTICAL",
  "paymentPlan": [
    {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "endingInstallmentPosition": 0,
      "index": 0,
      "loanAccountEncodedKey": "string",
      "pmt": 0
    }
  ],
  "penaltyBalance": 0,
  "penaltyDue": 0,
  "penaltyPaid": 0,
  "penaltyRate": 0,
  "periodicPayment": 0,
  "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
  "prepaymentRecalculationMethod": "NO_RECALCULATION",
  "principalBalance": 0,
  "principalDue": 0,
  "principalPaid": 0,
  "principalPaidInstallmentStatus": "PARTIALLY_PAID",
  "principalPaymentSettings": {
    "amount": 0,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "includeFeesInFloorAmount": true,
    "includeInterestInFloorAmount": true,
    "percentage": 0,
    "principalCeilingValue": 0,
    "principalFloorValue": 0,
    "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
  },
  "principalRepaymentInterval": 0,
  "productTypeKey": "string",
  "redrawBalance": 0,
  "redrawSettings": {
    "account": {
      "accountArrearsSettings": {
        "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
        "encodedKey": "string",
        "monthlyToleranceDay": 0,
        "nonWorkingDaysMethod": "EXCLUDED",
        "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY",
        "toleranceFloorAmount": 0,
        "tolerancePercentageOfOutstandingPrincipal": 0,
        "tolerancePeriod": 0
      },
      "accountHolderKey": "string",
      "accountHolderType": "GROUP",
      "accountState": "WITHDRAWN",
      "accountSubState": "WITHDRAWN",
      "accrueInterestAfterMaturity": true,
      "accrueLateInterest": true,
      "accruedInterest": 0,
      "accruedPenalty": 0,
      "activationTransactionKey": "string",
      "allowOffset": true,
      "applyInterestOnPrepaymentMethod": "AUTOMATIC",
      "approvedDate": "string",
      "arrearsTolerancePeriod": 0,
      "assignedBranchKey": "string",
      "assignedCentreKey": "string",
      "assignedUserKey": "string",
      "closedDate": "string",
      "creationDate": "string",
      "customFieldValues": [
        {
          "amount": 0,
          "customField": {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "customFieldID": "string",
          "customFieldKey": "string",
          "customFieldSetGroupIndex": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "linkedEntityKeyValue": "string",
          "parentKey": "string",
          "selectionKey": "string",
          "value": "string"
        }
      ],
      "daysInArrears": 0,
      "defaultFirstRepaymentDueDateOffset": 0,
      "disbursementDetails": {
        "customInformation": [
          {
            "amount": 0,
            "customField": {
              "amounts": {
                "property1": 0,
                "property2": 0
              },
              "builtInCustomFieldId": "MOBILE_PHONE",
              "creationDate": "string",
              "customFieldProductSettings": [
                {
                  "customFieldEncodedKey": "string",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isDefault": true,
                  "isRequired": true,
                  "linkType": "CLIENT_ROLE",
                  "productKey": "string"
                }
              ],
              "customFieldSelectionOptions": [
                {
                  "constraint": {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "score": 0,
                  "value": "string"
                }
              ],
              "customFieldSet": {
                "builtInType": "DETAILS",
                "createdDate": "string",
                "customFields": [
                  {}
                ],
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "notes": "string",
                "type": "USER_INFO",
                "usage": "SINGLE"
              },
              "dataType": "GROUP_LINK",
              "description": "string",
              "editRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "isDefault": true,
              "isRequired": true,
              "lastModifiedDate": "string",
              "name": "string",
              "state": "DEACTIVATED",
              "type": "USER_INFO",
              "unique": true,
              "validationPattern": "string",
              "valueLength": "SHORT",
              "values": [
                "string"
              ],
              "viewRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "customFieldID": "string",
            "customFieldKey": "string",
            "customFieldSetGroupIndex": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "linkedEntityKeyValue": "string",
            "parentKey": "string",
            "selectionKey": "string",
            "value": "string"
          }
        ],
        "disbursementDate": "string",
        "encodedKey": "string",
        "expectedDisbursementDate": "string",
        "fees": [
          {
            "amount": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "fee": {
              "active": true,
              "amortizationIntervalSettings": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
                "intervalCount": 0,
                "intervalType": "FULL_TERM",
                "periodCount": 0,
                "periodUnit": "MONTHS"
              },
              "amortizationProfile": "STRAIGHT_LINE",
              "amount": 0,
              "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
              "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
              "creationDate": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
              "feeApplication": "OPTIONAL",
              "feeProductRules": [
                {
                  "account": {
                    "activated": true,
                    "allowManualJournalEntries": true,
                    "balance": 0,
                    "creationDate": "2019-08-24T14:15:22Z",
                    "currency": {},
                    "description": "string",
                    "encodedKey": "string",
                    "glCode": "string",
                    "lastModifiedDate": "2019-08-24T14:15:22Z",
                    "migrationEvent": {},
                    "name": "string",
                    "stripTrailingZeros": true,
                    "type": "INCOME",
                    "usage": "HEADER"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "financialResource": "FEE_RECEIVABLE",
                  "index": 0,
                  "predefinedFeeKey": "string",
                  "productKey": "string",
                  "productType": "LOAN",
                  "transactionChannelKey": "string"
                }
              ],
              "name": "string",
              "percentageAmount": 0,
              "trigger": "DISBURSEMENT"
            }
          }
        ],
        "firstRepaymentDate": "string",
        "transactionDetails": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "internalTransfer": true,
          "targetSavingsAccountKey": "string",
          "transactionChannel": {
            "activated": true,
            "createdByUserKey": "string",
            "creationDate": "string",
            "customFields": [
              {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              }
            ],
            "encodedKey": "string",
            "id": "string",
            "index": 0,
            "loanConstraints": {
              "customConfigurationInfo": {
                "creationDate": "string",
                "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "shared": true,
                "userKey": "string"
              },
              "encodedKey": "string",
              "filterConstraints": [
                {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                }
              ]
            },
            "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
            "name": "string",
            "savingsConstraints": {
              "customConfigurationInfo": {
                "creationDate": "string",
                "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "shared": true,
                "userKey": "string"
              },
              "encodedKey": "string",
              "filterConstraints": [
                {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                }
              ]
            },
            "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
            "transactionChannelAccountingRule": {
              "account": {
                "activated": true,
                "allowManualJournalEntries": true,
                "balance": 0,
                "creationDate": "2019-08-24T14:15:22Z",
                "currency": {
                  "code": "string",
                  "creationDate": "string",
                  "currencySymbolPosition": "AFTER_NUMBER",
                  "digitsAfterDecimal": 0,
                  "isBaseCurrency": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "symbol": "string"
                },
                "description": "string",
                "encodedKey": "string",
                "glCode": "string",
                "lastModifiedDate": "2019-08-24T14:15:22Z",
                "migrationEvent": {
                  "creationDate": "2019-08-24T14:15:22Z",
                  "encodedKey": "string",
                  "numCentresImported": 0,
                  "numClientsImported": 0,
                  "numGLAccountsImported": 0,
                  "numGroupsImported": 0,
                  "numLoanRepaymentsImported": 0,
                  "numLoanTransactionsImported": 0,
                  "numLoansImported": 0,
                  "numSavingsImported": 0,
                  "state": "REVERTED",
                  "type": "IMPORT"
                },
                "name": "string",
                "stripTrailingZeros": true,
                "type": "INCOME",
                "usage": "HEADER"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "financialResource": "FEE_RECEIVABLE",
              "index": 0,
              "predefinedFeeKey": "string",
              "productKey": "string",
              "productType": "LOAN",
              "transactionChannelKey": "string"
            },
            "usageRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "transactionChannelKey": "string"
        }
      },
      "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "feesBalance": 0,
      "feesDue": 0,
      "feesPaid": 0,
      "fixedDaysOfMonth": [
        0
      ],
      "funds": [
        {
          "amount": 0,
          "assetName": "string",
          "customFieldValues": [
            {
              "amount": 0,
              "customField": {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              },
              "customFieldID": "string",
              "customFieldKey": "string",
              "customFieldSetGroupIndex": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "linkedEntityKeyValue": "string",
              "parentKey": "string",
              "selectionKey": "string",
              "value": "string"
            }
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "guarantorKey": "string",
          "guarantorType": "GROUP",
          "id": "string",
          "interestCommission": 0,
          "investmentPercentage": 0,
          "savingsAccountKey": "string",
          "type": "GUARANTOR"
        }
      ],
      "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
      "gracePeriod": 0,
      "gracePeriodType": "PAY_INTEREST_ONLY",
      "guarantees": [
        {
          "amount": 0,
          "assetName": "string",
          "customFieldValues": [
            {
              "amount": 0,
              "customField": {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              },
              "customFieldID": "string",
              "customFieldKey": "string",
              "customFieldSetGroupIndex": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "linkedEntityKeyValue": "string",
              "parentKey": "string",
              "selectionKey": "string",
              "value": "string"
            }
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "guarantorKey": "string",
          "guarantorType": "GROUP",
          "savingsAccountKey": "string",
          "type": "GUARANTOR"
        }
      ],
      "hasCustomSchedule": true,
      "holdBalance": 0,
      "id": "string",
      "interestApplicationMethod": "ON_REPAYMENT",
      "interestBalance": 0,
      "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
      "interestCalculationMethod": "DECLINING_BALANCE",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestCommission": 0,
      "interestDue": 0,
      "interestFromArrearsAccrued": 0,
      "interestFromArrearsBalance": 0,
      "interestFromArrearsDue": 0,
      "interestFromArrearsPaid": 0,
      "interestPaid": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRoundingVersion": "VERSION_2",
      "interestSpread": 0,
      "interestType": "CAPITALIZED_INTEREST",
      "lastAccountAppraisalDate": "string",
      "lastInterestAppliedDate": "string",
      "lastInterestReviewDate": "string",
      "lastLockedDate": "string",
      "lastModifiedDate": "string",
      "lastSetToArrearsDate": "string",
      "lastTaxRateReviewDate": "string",
      "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
      "lineOfCreditKey": "string",
      "loanAmount": 0,
      "loanGroup": {
        "accounts": [
          {}
        ],
        "creationDate": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "group": {
          "assignedBranchKey": "string",
          "assignedCentreKey": "string",
          "assignedUserKey": "string",
          "clientRole": {
            "encodedKey": "string"
          },
          "creationDate": "2019-08-24T14:15:22Z",
          "emailAddress": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "groupName": "string",
          "homePhone": "string",
          "id": "string",
          "idPattern": "string",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "loanCycle": 0,
          "migrationEvent": {
            "creationDate": "2019-08-24T14:15:22Z",
            "encodedKey": "string",
            "numCentresImported": 0,
            "numClientsImported": 0,
            "numGLAccountsImported": 0,
            "numGroupsImported": 0,
            "numLoanRepaymentsImported": 0,
            "numLoanTransactionsImported": 0,
            "numLoansImported": 0,
            "numSavingsImported": 0,
            "state": "REVERTED",
            "type": "IMPORT"
          },
          "mobilePhone1": "string",
          "preferredLanguage": "PORTUGESE"
        },
        "lastModifiedDate": "string",
        "name": "string",
        "notes": "string"
      },
      "loanName": "string",
      "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
      "lockedOperations": [
        "APPLY_FEES"
      ],
      "migrationEvent": {
        "creationDate": "2019-08-24T14:15:22Z",
        "encodedKey": "string",
        "numCentresImported": 0,
        "numClientsImported": 0,
        "numGLAccountsImported": 0,
        "numGroupsImported": 0,
        "numLoanRepaymentsImported": 0,
        "numLoanTransactionsImported": 0,
        "numLoansImported": 0,
        "numSavingsImported": 0,
        "state": "REVERTED",
        "type": "IMPORT"
      },
      "notes": "string",
      "originalAccountKey": "string",
      "paymentMethod": "VERTICAL",
      "paymentPlan": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingInstallmentPosition": 0,
          "index": 0,
          "loanAccountEncodedKey": "string",
          "pmt": 0
        }
      ],
      "penaltyBalance": 0,
      "penaltyDue": 0,
      "penaltyPaid": 0,
      "penaltyRate": 0,
      "periodicPayment": 0,
      "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
      "prepaymentRecalculationMethod": "NO_RECALCULATION",
      "principalBalance": 0,
      "principalDue": 0,
      "principalPaid": 0,
      "principalPaidInstallmentStatus": "PARTIALLY_PAID",
      "principalPaymentSettings": {
        "amount": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "includeFeesInFloorAmount": true,
        "includeInterestInFloorAmount": true,
        "percentage": 0,
        "principalCeilingValue": 0,
        "principalFloorValue": 0,
        "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
      },
      "principalRepaymentInterval": 0,
      "productTypeKey": "string",
      "redrawBalance": 0,
      "redrawSettings": {},
      "repaymentInstallments": 0,
      "repaymentPeriodCount": 0,
      "repaymentPeriodUnit": "MONTHS",
      "repaymentScheduleMethod": "FIXED",
      "rescheduledAccountKey": "string",
      "scheduleDueDatesMethod": "INTERVAL",
      "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
      "taxRate": 0,
      "tranches": [
        {
          "amount": 0,
          "disbursementTransactionKey": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "expectedDisbursementDate": "string",
          "index": 0
        }
      ]
    },
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "restrictNextDueWithdrawal": true
  },
  "repaymentInstallments": 0,
  "repaymentPeriodCount": 0,
  "repaymentPeriodUnit": "MONTHS",
  "repaymentScheduleMethod": "FIXED",
  "rescheduledAccountKey": "string",
  "scheduleDueDatesMethod": "INTERVAL",
  "settlementAccounts": [
    {
      "accountHolderKey": "string",
      "accountHolderType": "GROUP",
      "accountState": "WITHDRAWN",
      "accountType": "CURRENT_ACCOUNT",
      "accruedInterest": 0,
      "activationDate": "string",
      "allowOverdraft": true,
      "approvedDate": "string",
      "assignedBranchKey": "string",
      "assignedCentreKey": "string",
      "assignedUserKey": "string",
      "availableBalance": 0,
      "balance": 0,
      "closedDate": "string",
      "creationDate": "string",
      "currency": {
        "code": "string",
        "creationDate": "string",
        "currencySymbolPosition": "AFTER_NUMBER",
        "digitsAfterDecimal": 0,
        "isBaseCurrency": true,
        "lastModifiedDate": "string",
        "name": "string",
        "symbol": "string"
      },
      "currencyCode": "string",
      "customFieldValues": [
        {
          "amount": 0,
          "customField": {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "customFieldID": "string",
          "customFieldKey": "string",
          "customFieldSetGroupIndex": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "linkedEntityKeyValue": "string",
          "parentKey": "string",
          "selectionKey": "string",
          "value": "string"
        }
      ],
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "feesDue": 0,
      "holdBalance": 0,
      "id": "string",
      "interestDue": 0,
      "interestPaymentDates": [
        {
          "dayOfMonth": 0,
          "monthOfYear": 0,
          "year": 0
        }
      ],
      "interestPaymentPoint": "EVERY_WEEK",
      "interestSettings": {
        "accrueInterestAfterMaturity": true,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "interestChargeFrequency": "EVERY_WEEK",
        "interestChargeFrequencyCount": 0,
        "interestRate": 0,
        "interestRateReviewCount": 0,
        "interestRateReviewUnit": "MONTHS",
        "interestRateSource": "FIXED_INTEREST_RATE",
        "interestRateTerms": "TIERED_PERIOD",
        "interestRateTiers": [
          {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "endingBalance": 0,
            "endingDay": 0,
            "index": 0,
            "interestRate": 0
          }
        ],
        "interestSpread": 0
      },
      "lastAccountAppraisalDate": "string",
      "lastInterestCalculationDate": "string",
      "lastInterestStoredDate": "string",
      "lastModifiedDate": "string",
      "lastOverdraftInterestReviewDate": "string",
      "lastSetToArrearsDate": "string",
      "lineOfCreditKey": "string",
      "lockedBalance": 0,
      "lockedDate": "string",
      "maturityDate": "string",
      "maxWidthdrawlAmount": 0,
      "migrationEvent": {
        "creationDate": "2019-08-24T14:15:22Z",
        "encodedKey": "string",
        "numCentresImported": 0,
        "numClientsImported": 0,
        "numGLAccountsImported": 0,
        "numGroupsImported": 0,
        "numLoanRepaymentsImported": 0,
        "numLoanTransactionsImported": 0,
        "numLoansImported": 0,
        "numSavingsImported": 0,
        "state": "REVERTED",
        "type": "IMPORT"
      },
      "name": "string",
      "notes": "string",
      "overdraftAmount": 0,
      "overdraftExpiryDate": "string",
      "overdraftExpiryDateDTO": {
        "dayOfMonth": 0,
        "monthOfYear": 0,
        "year": 0
      },
      "overdraftInterestAccrued": 0,
      "overdraftInterestSettings": {
        "accrueInterestAfterMaturity": true,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "interestChargeFrequency": "EVERY_WEEK",
        "interestChargeFrequencyCount": 0,
        "interestRate": 0,
        "interestRateReviewCount": 0,
        "interestRateReviewUnit": "MONTHS",
        "interestRateSource": "FIXED_INTEREST_RATE",
        "interestRateTerms": "TIERED_PERIOD",
        "interestRateTiers": [
          {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "endingBalance": 0,
            "endingDay": 0,
            "index": 0,
            "interestRate": 0
          }
        ],
        "interestSpread": 0
      },
      "overdraftLimit": 0,
      "productTypeKey": "string",
      "recommendedDepositAmount": 0,
      "targetAmount": 0,
      "technicalInterestDue": 0,
      "technicalOverdraftAmount": 0,
      "technicalOverdraftInterestAccrued": 0,
      "withholdingTaxSourceKey": "string"
    }
  ],
  "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
  "taxRate": 0,
  "tranches": [
    {
      "amount": 0,
      "disbursementTransactionKey": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "expectedDisbursementDate": "string",
      "index": 0
    }
  ]
}

Properties

Name	Type	Description	Restrictions
accountArrearsSettings	AccountArrearsSettingsApiV1	none	none
accountHolderKey	string	none	none
accountHolderType	string	none	none
accountState	string	none	none
accountSubState	string	none	none
accrueInterestAfterMaturity	boolean	none	none
accrueLateInterest	boolean	none	none
accruedInterest	number	none	none
accruedPenalty	number	none	none
activationTransactionKey	string	none	none
allowOffset	boolean	none	none
applyInterestOnPrepaymentMethod	string	none	none
approvedDate	string	none	none
arrearsTolerancePeriod	number	none	none
assignedBranchKey	string	none	none
assignedCentreKey	string	none	none
assignedUserKey	string	none	none
closedDate	string	none	none
creationDate	string	the date and time when this loan account was created	none
customFieldValues	[CustomFieldValueApiV1]	none	none
daysInArrears	number	none	none
defaultFirstRepaymentDueDateOffset	number	none	none
disbursementDetails	DisbursementDetailsApiV1	none	none
elementsRecalculationMethod	string	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
feesBalance	number	none	none
feesDue	number	none	none
feesPaid	number	none	none
fixedDaysOfMonth	[number]	none	none
funds	[InvestorFundApiV1]	[An object containing information about people who may be acting as guarantor for a loan or collatoral being used, for more information please consult our p2p lending support article.]	none
futurePaymentsAcceptance	string	none	none
gracePeriod	number	none	none
gracePeriodType	string	none	none
guarantees	[GuarantyApiV1]	none	none
hasCustomSchedule	boolean	none	none
holdBalance	number	none	none
id	string	none	none
interestApplicationMethod	string	none	none
interestBalance	number	none	none
interestBalanceCalculationMethod	string	none	none
interestCalculationMethod	string	none	none
interestChargeFrequency	string	none	none
interestCommission	number	none	none
interestDue	number	none	none
interestFromArrearsAccrued	number	none	none
interestFromArrearsBalance	number	none	none
interestFromArrearsDue	number	none	none
interestFromArrearsPaid	number	none	none
interestPaid	number	none	none
interestRate	number	none	none
interestRateReviewCount	number	none	none
interestRateReviewUnit	string	none	none
interestRateSource	string	none	none
interestRoundingVersion	string	none	none
interestSpread	number	none	none
interestType	string	none	none
lastAccountAppraisalDate	string	none	none
lastInterestAppliedDate	string	none	none
lastInterestReviewDate	string	none	none
lastLockedDate	string	none	none
lastModifiedDate	string	the date on which this loan account was last modified	none
lastSetToArrearsDate	string	none	none
lastTaxRateReviewDate	string	none	none
latePaymentsRecalculationMethod	string	none	none
lineOfCreditKey	string	none	none
loanAmount	number	none	none
loanGroup	LoanGroupApiV1	none	none
loanName	string	none	none
loanPenaltyCalculationMethod	string	none	none
lockedOperations	[string]	none	none
migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
notes	string	none	none
originalAccountKey	string	none	none
paymentMethod	string	none	none
paymentPlan	[PeriodicPaymentApiV1]	none	none
penaltyBalance	number	none	none
penaltyDue	number	none	none
penaltyPaid	number	none	none
penaltyRate	number	none	none
periodicPayment	number	none	none
prepaymentAcceptance	string	none	none
prepaymentRecalculationMethod	string	none	none
principalBalance	number	none	none
principalDue	number	none	none
principalPaid	number	none	none
principalPaidInstallmentStatus	string	none	none
principalPaymentSettings	PrincipalPaymentAccountSettingsApiV1	none	none
principalRepaymentInterval	number	none	none
productTypeKey	string	none	none
redrawBalance	number	none	none
redrawSettings	LoanAccountRedrawSettingsApiV1	none	none
repaymentInstallments	number	none	none
repaymentPeriodCount	number	none	none
repaymentPeriodUnit	string	none	none
repaymentScheduleMethod	string	none	none
rescheduledAccountKey	string	none	none
scheduleDueDatesMethod	string	none	none
settlementAccounts	[SavingsAccountApiV1]	none	none
shortMonthHandlingMethod	string	none	none
taxRate	number	none	none
tranches	[LoanTrancheApiV1]	none	none

Enumerated Values

Property	Value
accountHolderType	`GROUP`
accountHolderType	`CLIENT`
accountState	`WITHDRAWN`
accountState	`PARTIALLY_DISBURSED`
accountState	`LOCKED`
accountState	`ACTIVE`
accountState	`CLOSED`
accountState	`PARTIAL_APPLICATION`
accountState	`LOCKED_CAPPING`
accountState	`CLOSED_REJECTED`
accountState	`RESCHEDULED`
accountState	`ACTIVE_IN_ARREARS`
accountState	`MATURED`
accountState	`CLOSED_RESCHEDULED`
accountState	`CLOSED_WITHDRAWN`
accountState	`PENDING_APPROVAL`
accountState	`APPROVED`
accountState	`REFINANCED`
accountState	`DORMANT`
accountState	`CLOSED_WRITTEN_OFF`
accountSubState	`WITHDRAWN`
accountSubState	`PARTIALLY_DISBURSED`
accountSubState	`LOCKED`
accountSubState	`ACTIVE`
accountSubState	`CLOSED`
accountSubState	`PARTIAL_APPLICATION`
accountSubState	`LOCKED_CAPPING`
accountSubState	`CLOSED_REJECTED`
accountSubState	`RESCHEDULED`
accountSubState	`ACTIVE_IN_ARREARS`
accountSubState	`MATURED`
accountSubState	`CLOSED_RESCHEDULED`
accountSubState	`CLOSED_WITHDRAWN`
accountSubState	`PENDING_APPROVAL`
accountSubState	`APPROVED`
accountSubState	`REFINANCED`
accountSubState	`DORMANT`
accountSubState	`CLOSED_WRITTEN_OFF`
applyInterestOnPrepaymentMethod	`AUTOMATIC`
applyInterestOnPrepaymentMethod	`MANUAL`
elementsRecalculationMethod	`FIXED_PRINCIPAL_EXPECTED`
elementsRecalculationMethod	`FIXED_TOTAL_EXPECTED`
futurePaymentsAcceptance	`ACCEPT_OVERPAYMENTS`
futurePaymentsAcceptance	`NO_FUTURE_PAYMENTS`
futurePaymentsAcceptance	`ACCEPT_FUTURE_PAYMENTS`
gracePeriodType	`PAY_INTEREST_ONLY`
gracePeriodType	`NONE`
gracePeriodType	`INTEREST_FORGIVENESS`
interestApplicationMethod	`ON_REPAYMENT`
interestApplicationMethod	`ON_DISBURSEMENT`
interestBalanceCalculationMethod	`PRINCIPAL_ONLY`
interestBalanceCalculationMethod	`PRINCIPAL_AND_INTEREST`
interestCalculationMethod	`DECLINING_BALANCE`
interestCalculationMethod	`DECLINING_BALANCE_DISCOUNTED`
interestCalculationMethod	`FLAT`
interestChargeFrequency	`EVERY_WEEK`
interestChargeFrequency	`ANNUALIZED`
interestChargeFrequency	`EVERY_MONTH`
interestChargeFrequency	`EVERY_X_DAYS`
interestChargeFrequency	`EVERY_FOUR_WEEKS`
interestChargeFrequency	`EVERY_DAY`
interestRateReviewUnit	`MONTHS`
interestRateReviewUnit	`WEEKS`
interestRateReviewUnit	`DAYS`
interestRateSource	`FIXED_INTEREST_RATE`
interestRateSource	`INDEX_INTEREST_RATE`
interestRoundingVersion	`VERSION_2`
interestRoundingVersion	`VERSION_1`
interestRoundingVersion	`VERSION_3`
interestType	`CAPITALIZED_INTEREST`
interestType	`SIMPLE_INTEREST`
latePaymentsRecalculationMethod	`INCREASE_OVERDUE_INSTALLMENTS`
latePaymentsRecalculationMethod	`INCREASE_LAST_INSTALLMENT`
loanPenaltyCalculationMethod	`OVERDUE_BALANCE_AND_INTEREST`
loanPenaltyCalculationMethod	`OUTSTANDING_PRINCIPAL`
loanPenaltyCalculationMethod	`OVERDUE_BALANCE`
loanPenaltyCalculationMethod	`NONE`
paymentMethod	`VERTICAL`
paymentMethod	`HORIZONTAL`
prepaymentAcceptance	`ACCEPT_PREPAYMENTS`
prepaymentAcceptance	`NO_PREPAYMENTS`
prepaymentRecalculationMethod	`NO_RECALCULATION`
prepaymentRecalculationMethod	`RECALCULATE_SCHEDULE_KEEP_SAME_NUMBER_OF_TERMS`
prepaymentRecalculationMethod	`REDUCE_AMOUNT_PER_INSTALLMENT`
prepaymentRecalculationMethod	`REDUCE_NUMBER_OF_INSTALLMENTS_NEW`
prepaymentRecalculationMethod	`REDUCE_NUMBER_OF_INSTALLMENTS`
prepaymentRecalculationMethod	`RESCHEDULE_REMAINING_REPAYMENTS`
prepaymentRecalculationMethod	`RECALCULATE_SCHEDULE_KEEP_SAME_TOTAL_REPAYMENT_AMOUNT`
prepaymentRecalculationMethod	`RECALCULATE_SCHEDULE_KEEP_SAME_PRINCIPAL_AMOUNT`
principalPaidInstallmentStatus	`PARTIALLY_PAID`
principalPaidInstallmentStatus	`ORIGINAL_TOTAL_EXPECTED_PAID`
principalPaidInstallmentStatus	`PAID`
repaymentPeriodUnit	`MONTHS`
repaymentPeriodUnit	`YEARS`
repaymentPeriodUnit	`WEEKS`
repaymentPeriodUnit	`DAYS`
repaymentScheduleMethod	`FIXED`
repaymentScheduleMethod	`NONE`
repaymentScheduleMethod	`DYNAMIC`
scheduleDueDatesMethod	`INTERVAL`
scheduleDueDatesMethod	`FIXED_DAYS_OF_MONTH`
shortMonthHandlingMethod	`LAST_DAY_IN_MONTH`
shortMonthHandlingMethod	`FIRST_DAY_OF_NEXT_MONTH`

LoanAccountPatch

{
  "arrearsTolerancePeriod": 0,
  "disbursementDetails": {
    "expectedDisbursementDate": "string",
    "firstRepaymentDate": "string"
  },
  "gracePeriod": 0,
  "interestRate": 0,
  "interestSpread": 0,
  "loanAmount": 0,
  "penaltyRate": 0,
  "periodicPayment": 0,
  "principalPaymentSettings": {
    "amount": 0,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "includeFeesInFloorAmount": true,
    "includeInterestInFloorAmount": true,
    "percentage": 0,
    "principalCeilingValue": 0,
    "principalFloorValue": 0,
    "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
  },
  "principalRepaymentInterval": 0,
  "redrawSettings": {
    "account": {
      "accountArrearsSettings": {
        "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
        "encodedKey": "string",
        "monthlyToleranceDay": 0,
        "nonWorkingDaysMethod": "EXCLUDED",
        "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY",
        "toleranceFloorAmount": 0,
        "tolerancePercentageOfOutstandingPrincipal": 0,
        "tolerancePeriod": 0
      },
      "accountHolderKey": "string",
      "accountHolderType": "GROUP",
      "accountState": "WITHDRAWN",
      "accountSubState": "WITHDRAWN",
      "accrueInterestAfterMaturity": true,
      "accrueLateInterest": true,
      "accruedInterest": 0,
      "accruedPenalty": 0,
      "activationTransactionKey": "string",
      "allowOffset": true,
      "applyInterestOnPrepaymentMethod": "AUTOMATIC",
      "approvedDate": "string",
      "arrearsTolerancePeriod": 0,
      "assignedBranchKey": "string",
      "assignedCentreKey": "string",
      "assignedUserKey": "string",
      "closedDate": "string",
      "creationDate": "string",
      "customFieldValues": [
        {
          "amount": 0,
          "customField": {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "customFieldID": "string",
          "customFieldKey": "string",
          "customFieldSetGroupIndex": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "linkedEntityKeyValue": "string",
          "parentKey": "string",
          "selectionKey": "string",
          "value": "string"
        }
      ],
      "daysInArrears": 0,
      "defaultFirstRepaymentDueDateOffset": 0,
      "disbursementDetails": {
        "customInformation": [
          {
            "amount": 0,
            "customField": {
              "amounts": {
                "property1": 0,
                "property2": 0
              },
              "builtInCustomFieldId": "MOBILE_PHONE",
              "creationDate": "string",
              "customFieldProductSettings": [
                {
                  "customFieldEncodedKey": "string",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isDefault": true,
                  "isRequired": true,
                  "linkType": "CLIENT_ROLE",
                  "productKey": "string"
                }
              ],
              "customFieldSelectionOptions": [
                {
                  "constraint": {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "score": 0,
                  "value": "string"
                }
              ],
              "customFieldSet": {
                "builtInType": "DETAILS",
                "createdDate": "string",
                "customFields": [
                  {}
                ],
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "notes": "string",
                "type": "USER_INFO",
                "usage": "SINGLE"
              },
              "dataType": "GROUP_LINK",
              "description": "string",
              "editRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "isDefault": true,
              "isRequired": true,
              "lastModifiedDate": "string",
              "name": "string",
              "state": "DEACTIVATED",
              "type": "USER_INFO",
              "unique": true,
              "validationPattern": "string",
              "valueLength": "SHORT",
              "values": [
                "string"
              ],
              "viewRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "customFieldID": "string",
            "customFieldKey": "string",
            "customFieldSetGroupIndex": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "linkedEntityKeyValue": "string",
            "parentKey": "string",
            "selectionKey": "string",
            "value": "string"
          }
        ],
        "disbursementDate": "string",
        "encodedKey": "string",
        "expectedDisbursementDate": "string",
        "fees": [
          {
            "amount": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "fee": {
              "active": true,
              "amortizationIntervalSettings": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
                "intervalCount": 0,
                "intervalType": "FULL_TERM",
                "periodCount": 0,
                "periodUnit": "MONTHS"
              },
              "amortizationProfile": "STRAIGHT_LINE",
              "amount": 0,
              "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
              "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
              "creationDate": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
              "feeApplication": "OPTIONAL",
              "feeProductRules": [
                {
                  "account": {
                    "activated": true,
                    "allowManualJournalEntries": true,
                    "balance": 0,
                    "creationDate": "2019-08-24T14:15:22Z",
                    "currency": {},
                    "description": "string",
                    "encodedKey": "string",
                    "glCode": "string",
                    "lastModifiedDate": "2019-08-24T14:15:22Z",
                    "migrationEvent": {},
                    "name": "string",
                    "stripTrailingZeros": true,
                    "type": "INCOME",
                    "usage": "HEADER"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "financialResource": "FEE_RECEIVABLE",
                  "index": 0,
                  "predefinedFeeKey": "string",
                  "productKey": "string",
                  "productType": "LOAN",
                  "transactionChannelKey": "string"
                }
              ],
              "name": "string",
              "percentageAmount": 0,
              "trigger": "DISBURSEMENT"
            }
          }
        ],
        "firstRepaymentDate": "string",
        "transactionDetails": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "internalTransfer": true,
          "targetSavingsAccountKey": "string",
          "transactionChannel": {
            "activated": true,
            "createdByUserKey": "string",
            "creationDate": "string",
            "customFields": [
              {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              }
            ],
            "encodedKey": "string",
            "id": "string",
            "index": 0,
            "loanConstraints": {
              "customConfigurationInfo": {
                "creationDate": "string",
                "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "shared": true,
                "userKey": "string"
              },
              "encodedKey": "string",
              "filterConstraints": [
                {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                }
              ]
            },
            "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
            "name": "string",
            "savingsConstraints": {
              "customConfigurationInfo": {
                "creationDate": "string",
                "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "shared": true,
                "userKey": "string"
              },
              "encodedKey": "string",
              "filterConstraints": [
                {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                }
              ]
            },
            "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
            "transactionChannelAccountingRule": {
              "account": {
                "activated": true,
                "allowManualJournalEntries": true,
                "balance": 0,
                "creationDate": "2019-08-24T14:15:22Z",
                "currency": {
                  "code": "string",
                  "creationDate": "string",
                  "currencySymbolPosition": "AFTER_NUMBER",
                  "digitsAfterDecimal": 0,
                  "isBaseCurrency": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "symbol": "string"
                },
                "description": "string",
                "encodedKey": "string",
                "glCode": "string",
                "lastModifiedDate": "2019-08-24T14:15:22Z",
                "migrationEvent": {
                  "creationDate": "2019-08-24T14:15:22Z",
                  "encodedKey": "string",
                  "numCentresImported": 0,
                  "numClientsImported": 0,
                  "numGLAccountsImported": 0,
                  "numGroupsImported": 0,
                  "numLoanRepaymentsImported": 0,
                  "numLoanTransactionsImported": 0,
                  "numLoansImported": 0,
                  "numSavingsImported": 0,
                  "state": "REVERTED",
                  "type": "IMPORT"
                },
                "name": "string",
                "stripTrailingZeros": true,
                "type": "INCOME",
                "usage": "HEADER"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "financialResource": "FEE_RECEIVABLE",
              "index": 0,
              "predefinedFeeKey": "string",
              "productKey": "string",
              "productType": "LOAN",
              "transactionChannelKey": "string"
            },
            "usageRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "transactionChannelKey": "string"
        }
      },
      "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "feesBalance": 0,
      "feesDue": 0,
      "feesPaid": 0,
      "fixedDaysOfMonth": [
        0
      ],
      "funds": [
        {
          "amount": 0,
          "assetName": "string",
          "customFieldValues": [
            {
              "amount": 0,
              "customField": {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              },
              "customFieldID": "string",
              "customFieldKey": "string",
              "customFieldSetGroupIndex": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "linkedEntityKeyValue": "string",
              "parentKey": "string",
              "selectionKey": "string",
              "value": "string"
            }
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "guarantorKey": "string",
          "guarantorType": "GROUP",
          "id": "string",
          "interestCommission": 0,
          "investmentPercentage": 0,
          "savingsAccountKey": "string",
          "type": "GUARANTOR"
        }
      ],
      "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
      "gracePeriod": 0,
      "gracePeriodType": "PAY_INTEREST_ONLY",
      "guarantees": [
        {
          "amount": 0,
          "assetName": "string",
          "customFieldValues": [
            {
              "amount": 0,
              "customField": {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              },
              "customFieldID": "string",
              "customFieldKey": "string",
              "customFieldSetGroupIndex": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "linkedEntityKeyValue": "string",
              "parentKey": "string",
              "selectionKey": "string",
              "value": "string"
            }
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "guarantorKey": "string",
          "guarantorType": "GROUP",
          "savingsAccountKey": "string",
          "type": "GUARANTOR"
        }
      ],
      "hasCustomSchedule": true,
      "holdBalance": 0,
      "id": "string",
      "interestApplicationMethod": "ON_REPAYMENT",
      "interestBalance": 0,
      "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
      "interestCalculationMethod": "DECLINING_BALANCE",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestCommission": 0,
      "interestDue": 0,
      "interestFromArrearsAccrued": 0,
      "interestFromArrearsBalance": 0,
      "interestFromArrearsDue": 0,
      "interestFromArrearsPaid": 0,
      "interestPaid": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRoundingVersion": "VERSION_2",
      "interestSpread": 0,
      "interestType": "CAPITALIZED_INTEREST",
      "lastAccountAppraisalDate": "string",
      "lastInterestAppliedDate": "string",
      "lastInterestReviewDate": "string",
      "lastLockedDate": "string",
      "lastModifiedDate": "string",
      "lastSetToArrearsDate": "string",
      "lastTaxRateReviewDate": "string",
      "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
      "lineOfCreditKey": "string",
      "loanAmount": 0,
      "loanGroup": {
        "accounts": [
          {}
        ],
        "creationDate": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "group": {
          "assignedBranchKey": "string",
          "assignedCentreKey": "string",
          "assignedUserKey": "string",
          "clientRole": {
            "encodedKey": "string"
          },
          "creationDate": "2019-08-24T14:15:22Z",
          "emailAddress": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "groupName": "string",
          "homePhone": "string",
          "id": "string",
          "idPattern": "string",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "loanCycle": 0,
          "migrationEvent": {
            "creationDate": "2019-08-24T14:15:22Z",
            "encodedKey": "string",
            "numCentresImported": 0,
            "numClientsImported": 0,
            "numGLAccountsImported": 0,
            "numGroupsImported": 0,
            "numLoanRepaymentsImported": 0,
            "numLoanTransactionsImported": 0,
            "numLoansImported": 0,
            "numSavingsImported": 0,
            "state": "REVERTED",
            "type": "IMPORT"
          },
          "mobilePhone1": "string",
          "preferredLanguage": "PORTUGESE"
        },
        "lastModifiedDate": "string",
        "name": "string",
        "notes": "string"
      },
      "loanName": "string",
      "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
      "lockedOperations": [
        "APPLY_FEES"
      ],
      "migrationEvent": {
        "creationDate": "2019-08-24T14:15:22Z",
        "encodedKey": "string",
        "numCentresImported": 0,
        "numClientsImported": 0,
        "numGLAccountsImported": 0,
        "numGroupsImported": 0,
        "numLoanRepaymentsImported": 0,
        "numLoanTransactionsImported": 0,
        "numLoansImported": 0,
        "numSavingsImported": 0,
        "state": "REVERTED",
        "type": "IMPORT"
      },
      "notes": "string",
      "originalAccountKey": "string",
      "paymentMethod": "VERTICAL",
      "paymentPlan": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingInstallmentPosition": 0,
          "index": 0,
          "loanAccountEncodedKey": "string",
          "pmt": 0
        }
      ],
      "penaltyBalance": 0,
      "penaltyDue": 0,
      "penaltyPaid": 0,
      "penaltyRate": 0,
      "periodicPayment": 0,
      "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
      "prepaymentRecalculationMethod": "NO_RECALCULATION",
      "principalBalance": 0,
      "principalDue": 0,
      "principalPaid": 0,
      "principalPaidInstallmentStatus": "PARTIALLY_PAID",
      "principalPaymentSettings": {
        "amount": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "includeFeesInFloorAmount": true,
        "includeInterestInFloorAmount": true,
        "percentage": 0,
        "principalCeilingValue": 0,
        "principalFloorValue": 0,
        "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
      },
      "principalRepaymentInterval": 0,
      "productTypeKey": "string",
      "redrawBalance": 0,
      "redrawSettings": {},
      "repaymentInstallments": 0,
      "repaymentPeriodCount": 0,
      "repaymentPeriodUnit": "MONTHS",
      "repaymentScheduleMethod": "FIXED",
      "rescheduledAccountKey": "string",
      "scheduleDueDatesMethod": "INTERVAL",
      "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
      "taxRate": 0,
      "tranches": [
        {
          "amount": 0,
          "disbursementTransactionKey": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "expectedDisbursementDate": "string",
          "index": 0
        }
      ]
    },
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "restrictNextDueWithdrawal": true
  },
  "repaymentInstallments": 0,
  "repaymentPeriodCount": 0,
  "repaymentPeriodUnit": "MONTHS"
}

Properties

Name	Type	Description	Restrictions
arrearsTolerancePeriod	number	none	none
disbursementDetails	DisbursementDetailsPatch	none	none
gracePeriod	number	none	none
interestRate	number	none	none
interestSpread	number	none	none
loanAmount	number	none	none
penaltyRate	number	none	none
periodicPayment	number	none	none
principalPaymentSettings	PrincipalPaymentAccountSettingsApiV1	none	none
principalRepaymentInterval	number	none	none
redrawSettings	LoanAccountRedrawSettingsApiV1	none	none
repaymentInstallments	number	none	none
repaymentPeriodCount	number	none	none
repaymentPeriodUnit	string	none	none

Enumerated Values

Property	Value
repaymentPeriodUnit	`MONTHS`
repaymentPeriodUnit	`YEARS`
repaymentPeriodUnit	`WEEKS`
repaymentPeriodUnit	`DAYS`

LoanAccountPatchRequest

{
  "loanAccount": {
    "arrearsTolerancePeriod": 0,
    "disbursementDetails": {
      "expectedDisbursementDate": "string",
      "firstRepaymentDate": "string"
    },
    "gracePeriod": 0,
    "interestRate": 0,
    "interestSpread": 0,
    "loanAmount": 0,
    "penaltyRate": 0,
    "periodicPayment": 0,
    "principalPaymentSettings": {
      "amount": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "includeFeesInFloorAmount": true,
      "includeInterestInFloorAmount": true,
      "percentage": 0,
      "principalCeilingValue": 0,
      "principalFloorValue": 0,
      "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
    },
    "principalRepaymentInterval": 0,
    "redrawSettings": {
      "account": {
        "accountArrearsSettings": {
          "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
          "encodedKey": "string",
          "monthlyToleranceDay": 0,
          "nonWorkingDaysMethod": "EXCLUDED",
          "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY",
          "toleranceFloorAmount": 0,
          "tolerancePercentageOfOutstandingPrincipal": 0,
          "tolerancePeriod": 0
        },
        "accountHolderKey": "string",
        "accountHolderType": "GROUP",
        "accountState": "WITHDRAWN",
        "accountSubState": "WITHDRAWN",
        "accrueInterestAfterMaturity": true,
        "accrueLateInterest": true,
        "accruedInterest": 0,
        "accruedPenalty": 0,
        "activationTransactionKey": "string",
        "allowOffset": true,
        "applyInterestOnPrepaymentMethod": "AUTOMATIC",
        "approvedDate": "string",
        "arrearsTolerancePeriod": 0,
        "assignedBranchKey": "string",
        "assignedCentreKey": "string",
        "assignedUserKey": "string",
        "closedDate": "string",
        "creationDate": "string",
        "customFieldValues": [
          {
            "amount": 0,
            "customField": {
              "amounts": {
                "property1": 0,
                "property2": 0
              },
              "builtInCustomFieldId": "MOBILE_PHONE",
              "creationDate": "string",
              "customFieldProductSettings": [
                {
                  "customFieldEncodedKey": "string",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isDefault": true,
                  "isRequired": true,
                  "linkType": "CLIENT_ROLE",
                  "productKey": "string"
                }
              ],
              "customFieldSelectionOptions": [
                {
                  "constraint": {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "score": 0,
                  "value": "string"
                }
              ],
              "customFieldSet": {
                "builtInType": "DETAILS",
                "createdDate": "string",
                "customFields": [
                  {}
                ],
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "notes": "string",
                "type": "USER_INFO",
                "usage": "SINGLE"
              },
              "dataType": "GROUP_LINK",
              "description": "string",
              "editRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "isDefault": true,
              "isRequired": true,
              "lastModifiedDate": "string",
              "name": "string",
              "state": "DEACTIVATED",
              "type": "USER_INFO",
              "unique": true,
              "validationPattern": "string",
              "valueLength": "SHORT",
              "values": [
                "string"
              ],
              "viewRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "customFieldID": "string",
            "customFieldKey": "string",
            "customFieldSetGroupIndex": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "linkedEntityKeyValue": "string",
            "parentKey": "string",
            "selectionKey": "string",
            "value": "string"
          }
        ],
        "daysInArrears": 0,
        "defaultFirstRepaymentDueDateOffset": 0,
        "disbursementDetails": {
          "customInformation": [
            {
              "amount": 0,
              "customField": {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              },
              "customFieldID": "string",
              "customFieldKey": "string",
              "customFieldSetGroupIndex": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "linkedEntityKeyValue": "string",
              "parentKey": "string",
              "selectionKey": "string",
              "value": "string"
            }
          ],
          "disbursementDate": "string",
          "encodedKey": "string",
          "expectedDisbursementDate": "string",
          "fees": [
            {
              "amount": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "fee": {
                "active": true,
                "amortizationIntervalSettings": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
                  "intervalCount": 0,
                  "intervalType": "FULL_TERM",
                  "periodCount": 0,
                  "periodUnit": "MONTHS"
                },
                "amortizationProfile": "STRAIGHT_LINE",
                "amount": 0,
                "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
                "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
                "creationDate": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
                "feeApplication": "OPTIONAL",
                "feeProductRules": [
                  {
                    "account": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "financialResource": "FEE_RECEIVABLE",
                    "index": 0,
                    "predefinedFeeKey": "string",
                    "productKey": "string",
                    "productType": "LOAN",
                    "transactionChannelKey": "string"
                  }
                ],
                "name": "string",
                "percentageAmount": 0,
                "trigger": "DISBURSEMENT"
              }
            }
          ],
          "firstRepaymentDate": "string",
          "transactionDetails": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "internalTransfer": true,
            "targetSavingsAccountKey": "string",
            "transactionChannel": {
              "activated": true,
              "createdByUserKey": "string",
              "creationDate": "string",
              "customFields": [
                {
                  "amounts": {
                    "property1": 0,
                    "property2": 0
                  },
                  "builtInCustomFieldId": "MOBILE_PHONE",
                  "creationDate": "string",
                  "customFieldProductSettings": [
                    {}
                  ],
                  "customFieldSelectionOptions": [
                    {}
                  ],
                  "customFieldSet": {
                    "builtInType": "DETAILS",
                    "createdDate": "string",
                    "customFields": [],
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "indexInList": 0,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "notes": "string",
                    "type": "USER_INFO",
                    "usage": "SINGLE"
                  },
                  "dataType": "GROUP_LINK",
                  "description": "string",
                  "editRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "isDefault": true,
                  "isRequired": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "state": "DEACTIVATED",
                  "type": "USER_INFO",
                  "unique": true,
                  "validationPattern": "string",
                  "valueLength": "SHORT",
                  "values": [
                    "string"
                  ],
                  "viewRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  }
                }
              ],
              "encodedKey": "string",
              "id": "string",
              "index": 0,
              "loanConstraints": {
                "customConfigurationInfo": {
                  "creationDate": "string",
                  "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "shared": true,
                  "userKey": "string"
                },
                "encodedKey": "string",
                "filterConstraints": [
                  {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  }
                ]
              },
              "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
              "name": "string",
              "savingsConstraints": {
                "customConfigurationInfo": {
                  "creationDate": "string",
                  "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "shared": true,
                  "userKey": "string"
                },
                "encodedKey": "string",
                "filterConstraints": [
                  {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  }
                ]
              },
              "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
              "transactionChannelAccountingRule": {
                "account": {
                  "activated": true,
                  "allowManualJournalEntries": true,
                  "balance": 0,
                  "creationDate": "2019-08-24T14:15:22Z",
                  "currency": {
                    "code": "string",
                    "creationDate": "string",
                    "currencySymbolPosition": "AFTER_NUMBER",
                    "digitsAfterDecimal": 0,
                    "isBaseCurrency": true,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "symbol": "string"
                  },
                  "description": "string",
                  "encodedKey": "string",
                  "glCode": "string",
                  "lastModifiedDate": "2019-08-24T14:15:22Z",
                  "migrationEvent": {
                    "creationDate": "2019-08-24T14:15:22Z",
                    "encodedKey": "string",
                    "numCentresImported": 0,
                    "numClientsImported": 0,
                    "numGLAccountsImported": 0,
                    "numGroupsImported": 0,
                    "numLoanRepaymentsImported": 0,
                    "numLoanTransactionsImported": 0,
                    "numLoansImported": 0,
                    "numSavingsImported": 0,
                    "state": "REVERTED",
                    "type": "IMPORT"
                  },
                  "name": "string",
                  "stripTrailingZeros": true,
                  "type": "INCOME",
                  "usage": "HEADER"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "financialResource": "FEE_RECEIVABLE",
                "index": 0,
                "predefinedFeeKey": "string",
                "productKey": "string",
                "productType": "LOAN",
                "transactionChannelKey": "string"
              },
              "usageRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "transactionChannelKey": "string"
          }
        },
        "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "feesBalance": 0,
        "feesDue": 0,
        "feesPaid": 0,
        "fixedDaysOfMonth": [
          0
        ],
        "funds": [
          {
            "amount": 0,
            "assetName": "string",
            "customFieldValues": [
              {
                "amount": 0,
                "customField": {
                  "amounts": {
                    "property1": 0,
                    "property2": 0
                  },
                  "builtInCustomFieldId": "MOBILE_PHONE",
                  "creationDate": "string",
                  "customFieldProductSettings": [
                    {}
                  ],
                  "customFieldSelectionOptions": [
                    {}
                  ],
                  "customFieldSet": {
                    "builtInType": "DETAILS",
                    "createdDate": "string",
                    "customFields": [],
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "indexInList": 0,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "notes": "string",
                    "type": "USER_INFO",
                    "usage": "SINGLE"
                  },
                  "dataType": "GROUP_LINK",
                  "description": "string",
                  "editRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "isDefault": true,
                  "isRequired": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "state": "DEACTIVATED",
                  "type": "USER_INFO",
                  "unique": true,
                  "validationPattern": "string",
                  "valueLength": "SHORT",
                  "values": [
                    "string"
                  ],
                  "viewRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  }
                },
                "customFieldID": "string",
                "customFieldKey": "string",
                "customFieldSetGroupIndex": 0,
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "linkedEntityKeyValue": "string",
                "parentKey": "string",
                "selectionKey": "string",
                "value": "string"
              }
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "guarantorKey": "string",
            "guarantorType": "GROUP",
            "id": "string",
            "interestCommission": 0,
            "investmentPercentage": 0,
            "savingsAccountKey": "string",
            "type": "GUARANTOR"
          }
        ],
        "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
        "gracePeriod": 0,
        "gracePeriodType": "PAY_INTEREST_ONLY",
        "guarantees": [
          {
            "amount": 0,
            "assetName": "string",
            "customFieldValues": [
              {
                "amount": 0,
                "customField": {
                  "amounts": {
                    "property1": 0,
                    "property2": 0
                  },
                  "builtInCustomFieldId": "MOBILE_PHONE",
                  "creationDate": "string",
                  "customFieldProductSettings": [
                    {}
                  ],
                  "customFieldSelectionOptions": [
                    {}
                  ],
                  "customFieldSet": {
                    "builtInType": "DETAILS",
                    "createdDate": "string",
                    "customFields": [],
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "indexInList": 0,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "notes": "string",
                    "type": "USER_INFO",
                    "usage": "SINGLE"
                  },
                  "dataType": "GROUP_LINK",
                  "description": "string",
                  "editRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "isDefault": true,
                  "isRequired": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "state": "DEACTIVATED",
                  "type": "USER_INFO",
                  "unique": true,
                  "validationPattern": "string",
                  "valueLength": "SHORT",
                  "values": [
                    "string"
                  ],
                  "viewRights": {
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                  }
                },
                "customFieldID": "string",
                "customFieldKey": "string",
                "customFieldSetGroupIndex": 0,
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "linkedEntityKeyValue": "string",
                "parentKey": "string",
                "selectionKey": "string",
                "value": "string"
              }
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "guarantorKey": "string",
            "guarantorType": "GROUP",
            "savingsAccountKey": "string",
            "type": "GUARANTOR"
          }
        ],
        "hasCustomSchedule": true,
        "holdBalance": 0,
        "id": "string",
        "interestApplicationMethod": "ON_REPAYMENT",
        "interestBalance": 0,
        "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
        "interestCalculationMethod": "DECLINING_BALANCE",
        "interestChargeFrequency": "EVERY_WEEK",
        "interestCommission": 0,
        "interestDue": 0,
        "interestFromArrearsAccrued": 0,
        "interestFromArrearsBalance": 0,
        "interestFromArrearsDue": 0,
        "interestFromArrearsPaid": 0,
        "interestPaid": 0,
        "interestRate": 0,
        "interestRateReviewCount": 0,
        "interestRateReviewUnit": "MONTHS",
        "interestRateSource": "FIXED_INTEREST_RATE",
        "interestRoundingVersion": "VERSION_2",
        "interestSpread": 0,
        "interestType": "CAPITALIZED_INTEREST",
        "lastAccountAppraisalDate": "string",
        "lastInterestAppliedDate": "string",
        "lastInterestReviewDate": "string",
        "lastLockedDate": "string",
        "lastModifiedDate": "string",
        "lastSetToArrearsDate": "string",
        "lastTaxRateReviewDate": "string",
        "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
        "lineOfCreditKey": "string",
        "loanAmount": 0,
        "loanGroup": {
          "accounts": [
            {}
          ],
          "creationDate": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "group": {
            "assignedBranchKey": "string",
            "assignedCentreKey": "string",
            "assignedUserKey": "string",
            "clientRole": {
              "encodedKey": "string"
            },
            "creationDate": "2019-08-24T14:15:22Z",
            "emailAddress": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "groupName": "string",
            "homePhone": "string",
            "id": "string",
            "idPattern": "string",
            "lastModifiedDate": "2019-08-24T14:15:22Z",
            "loanCycle": 0,
            "migrationEvent": {
              "creationDate": "2019-08-24T14:15:22Z",
              "encodedKey": "string",
              "numCentresImported": 0,
              "numClientsImported": 0,
              "numGLAccountsImported": 0,
              "numGroupsImported": 0,
              "numLoanRepaymentsImported": 0,
              "numLoanTransactionsImported": 0,
              "numLoansImported": 0,
              "numSavingsImported": 0,
              "state": "REVERTED",
              "type": "IMPORT"
            },
            "mobilePhone1": "string",
            "preferredLanguage": "PORTUGESE"
          },
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string"
        },
        "loanName": "string",
        "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
        "lockedOperations": [
          "APPLY_FEES"
        ],
        "migrationEvent": {
          "creationDate": "2019-08-24T14:15:22Z",
          "encodedKey": "string",
          "numCentresImported": 0,
          "numClientsImported": 0,
          "numGLAccountsImported": 0,
          "numGroupsImported": 0,
          "numLoanRepaymentsImported": 0,
          "numLoanTransactionsImported": 0,
          "numLoansImported": 0,
          "numSavingsImported": 0,
          "state": "REVERTED",
          "type": "IMPORT"
        },
        "notes": "string",
        "originalAccountKey": "string",
        "paymentMethod": "VERTICAL",
        "paymentPlan": [
          {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "endingInstallmentPosition": 0,
            "index": 0,
            "loanAccountEncodedKey": "string",
            "pmt": 0
          }
        ],
        "penaltyBalance": 0,
        "penaltyDue": 0,
        "penaltyPaid": 0,
        "penaltyRate": 0,
        "periodicPayment": 0,
        "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
        "prepaymentRecalculationMethod": "NO_RECALCULATION",
        "principalBalance": 0,
        "principalDue": 0,
        "principalPaid": 0,
        "principalPaidInstallmentStatus": "PARTIALLY_PAID",
        "principalPaymentSettings": {
          "amount": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "includeFeesInFloorAmount": true,
          "includeInterestInFloorAmount": true,
          "percentage": 0,
          "principalCeilingValue": 0,
          "principalFloorValue": 0,
          "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
        },
        "principalRepaymentInterval": 0,
        "productTypeKey": "string",
        "redrawBalance": 0,
        "redrawSettings": {},
        "repaymentInstallments": 0,
        "repaymentPeriodCount": 0,
        "repaymentPeriodUnit": "MONTHS",
        "repaymentScheduleMethod": "FIXED",
        "rescheduledAccountKey": "string",
        "scheduleDueDatesMethod": "INTERVAL",
        "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
        "taxRate": 0,
        "tranches": [
          {
            "amount": 0,
            "disbursementTransactionKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "expectedDisbursementDate": "string",
            "index": 0
          }
        ]
      },
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "restrictNextDueWithdrawal": true
    },
    "repaymentInstallments": 0,
    "repaymentPeriodCount": 0,
    "repaymentPeriodUnit": "MONTHS"
  }
}

Properties

Name	Type	Description	Restrictions
loanAccount	LoanAccountPatch	none	none

LoanAccountRedrawSettingsApiV1

{
  "account": {
    "accountArrearsSettings": {
      "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
      "encodedKey": "string",
      "monthlyToleranceDay": 0,
      "nonWorkingDaysMethod": "EXCLUDED",
      "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY",
      "toleranceFloorAmount": 0,
      "tolerancePercentageOfOutstandingPrincipal": 0,
      "tolerancePeriod": 0
    },
    "accountHolderKey": "string",
    "accountHolderType": "GROUP",
    "accountState": "WITHDRAWN",
    "accountSubState": "WITHDRAWN",
    "accrueInterestAfterMaturity": true,
    "accrueLateInterest": true,
    "accruedInterest": 0,
    "accruedPenalty": 0,
    "activationTransactionKey": "string",
    "allowOffset": true,
    "applyInterestOnPrepaymentMethod": "AUTOMATIC",
    "approvedDate": "string",
    "arrearsTolerancePeriod": 0,
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "closedDate": "string",
    "creationDate": "string",
    "customFieldValues": [
      {
        "amount": 0,
        "customField": {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "customFieldID": "string",
        "customFieldKey": "string",
        "customFieldSetGroupIndex": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexInList": 0,
        "linkedEntityKeyValue": "string",
        "parentKey": "string",
        "selectionKey": "string",
        "value": "string"
      }
    ],
    "daysInArrears": 0,
    "defaultFirstRepaymentDueDateOffset": 0,
    "disbursementDetails": {
      "customInformation": [
        {
          "amount": 0,
          "customField": {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "customFieldID": "string",
          "customFieldKey": "string",
          "customFieldSetGroupIndex": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "linkedEntityKeyValue": "string",
          "parentKey": "string",
          "selectionKey": "string",
          "value": "string"
        }
      ],
      "disbursementDate": "string",
      "encodedKey": "string",
      "expectedDisbursementDate": "string",
      "fees": [
        {
          "amount": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "fee": {
            "active": true,
            "amortizationIntervalSettings": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
              "intervalCount": 0,
              "intervalType": "FULL_TERM",
              "periodCount": 0,
              "periodUnit": "MONTHS"
            },
            "amortizationProfile": "STRAIGHT_LINE",
            "amount": 0,
            "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
            "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
            "creationDate": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
            "feeApplication": "OPTIONAL",
            "feeProductRules": [
              {
                "account": {
                  "activated": true,
                  "allowManualJournalEntries": true,
                  "balance": 0,
                  "creationDate": "2019-08-24T14:15:22Z",
                  "currency": {
                    "code": "string",
                    "creationDate": "string",
                    "currencySymbolPosition": "AFTER_NUMBER",
                    "digitsAfterDecimal": 0,
                    "isBaseCurrency": true,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "symbol": "string"
                  },
                  "description": "string",
                  "encodedKey": "string",
                  "glCode": "string",
                  "lastModifiedDate": "2019-08-24T14:15:22Z",
                  "migrationEvent": {
                    "creationDate": "2019-08-24T14:15:22Z",
                    "encodedKey": "string",
                    "numCentresImported": 0,
                    "numClientsImported": 0,
                    "numGLAccountsImported": 0,
                    "numGroupsImported": 0,
                    "numLoanRepaymentsImported": 0,
                    "numLoanTransactionsImported": 0,
                    "numLoansImported": 0,
                    "numSavingsImported": 0,
                    "state": "REVERTED",
                    "type": "IMPORT"
                  },
                  "name": "string",
                  "stripTrailingZeros": true,
                  "type": "INCOME",
                  "usage": "HEADER"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "financialResource": "FEE_RECEIVABLE",
                "index": 0,
                "predefinedFeeKey": "string",
                "productKey": "string",
                "productType": "LOAN",
                "transactionChannelKey": "string"
              }
            ],
            "name": "string",
            "percentageAmount": 0,
            "trigger": "DISBURSEMENT"
          }
        }
      ],
      "firstRepaymentDate": "string",
      "transactionDetails": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "internalTransfer": true,
        "targetSavingsAccountKey": "string",
        "transactionChannel": {
          "activated": true,
          "createdByUserKey": "string",
          "creationDate": "string",
          "customFields": [
            {
              "amounts": {
                "property1": 0,
                "property2": 0
              },
              "builtInCustomFieldId": "MOBILE_PHONE",
              "creationDate": "string",
              "customFieldProductSettings": [
                {
                  "customFieldEncodedKey": "string",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isDefault": true,
                  "isRequired": true,
                  "linkType": "CLIENT_ROLE",
                  "productKey": "string"
                }
              ],
              "customFieldSelectionOptions": [
                {
                  "constraint": {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "score": 0,
                  "value": "string"
                }
              ],
              "customFieldSet": {
                "builtInType": "DETAILS",
                "createdDate": "string",
                "customFields": [
                  {}
                ],
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "notes": "string",
                "type": "USER_INFO",
                "usage": "SINGLE"
              },
              "dataType": "GROUP_LINK",
              "description": "string",
              "editRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "isDefault": true,
              "isRequired": true,
              "lastModifiedDate": "string",
              "name": "string",
              "state": "DEACTIVATED",
              "type": "USER_INFO",
              "unique": true,
              "validationPattern": "string",
              "valueLength": "SHORT",
              "values": [
                "string"
              ],
              "viewRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            }
          ],
          "encodedKey": "string",
          "id": "string",
          "index": 0,
          "loanConstraints": {
            "customConfigurationInfo": {
              "creationDate": "string",
              "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "shared": true,
              "userKey": "string"
            },
            "encodedKey": "string",
            "filterConstraints": [
              {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              }
            ]
          },
          "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
          "name": "string",
          "savingsConstraints": {
            "customConfigurationInfo": {
              "creationDate": "string",
              "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "shared": true,
              "userKey": "string"
            },
            "encodedKey": "string",
            "filterConstraints": [
              {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              }
            ]
          },
          "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
          "transactionChannelAccountingRule": {
            "account": {
              "activated": true,
              "allowManualJournalEntries": true,
              "balance": 0,
              "creationDate": "2019-08-24T14:15:22Z",
              "currency": {
                "code": "string",
                "creationDate": "string",
                "currencySymbolPosition": "AFTER_NUMBER",
                "digitsAfterDecimal": 0,
                "isBaseCurrency": true,
                "lastModifiedDate": "string",
                "name": "string",
                "symbol": "string"
              },
              "description": "string",
              "encodedKey": "string",
              "glCode": "string",
              "lastModifiedDate": "2019-08-24T14:15:22Z",
              "migrationEvent": {
                "creationDate": "2019-08-24T14:15:22Z",
                "encodedKey": "string",
                "numCentresImported": 0,
                "numClientsImported": 0,
                "numGLAccountsImported": 0,
                "numGroupsImported": 0,
                "numLoanRepaymentsImported": 0,
                "numLoanTransactionsImported": 0,
                "numLoansImported": 0,
                "numSavingsImported": 0,
                "state": "REVERTED",
                "type": "IMPORT"
              },
              "name": "string",
              "stripTrailingZeros": true,
              "type": "INCOME",
              "usage": "HEADER"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "financialResource": "FEE_RECEIVABLE",
            "index": 0,
            "predefinedFeeKey": "string",
            "productKey": "string",
            "productType": "LOAN",
            "transactionChannelKey": "string"
          },
          "usageRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        },
        "transactionChannelKey": "string"
      }
    },
    "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "feesBalance": 0,
    "feesDue": 0,
    "feesPaid": 0,
    "fixedDaysOfMonth": [
      0
    ],
    "funds": [
      {
        "amount": 0,
        "assetName": "string",
        "customFieldValues": [
          {
            "amount": 0,
            "customField": {
              "amounts": {
                "property1": 0,
                "property2": 0
              },
              "builtInCustomFieldId": "MOBILE_PHONE",
              "creationDate": "string",
              "customFieldProductSettings": [
                {
                  "customFieldEncodedKey": "string",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isDefault": true,
                  "isRequired": true,
                  "linkType": "CLIENT_ROLE",
                  "productKey": "string"
                }
              ],
              "customFieldSelectionOptions": [
                {
                  "constraint": {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "score": 0,
                  "value": "string"
                }
              ],
              "customFieldSet": {
                "builtInType": "DETAILS",
                "createdDate": "string",
                "customFields": [
                  {}
                ],
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "notes": "string",
                "type": "USER_INFO",
                "usage": "SINGLE"
              },
              "dataType": "GROUP_LINK",
              "description": "string",
              "editRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "isDefault": true,
              "isRequired": true,
              "lastModifiedDate": "string",
              "name": "string",
              "state": "DEACTIVATED",
              "type": "USER_INFO",
              "unique": true,
              "validationPattern": "string",
              "valueLength": "SHORT",
              "values": [
                "string"
              ],
              "viewRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "customFieldID": "string",
            "customFieldKey": "string",
            "customFieldSetGroupIndex": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "linkedEntityKeyValue": "string",
            "parentKey": "string",
            "selectionKey": "string",
            "value": "string"
          }
        ],
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "guarantorKey": "string",
        "guarantorType": "GROUP",
        "id": "string",
        "interestCommission": 0,
        "investmentPercentage": 0,
        "savingsAccountKey": "string",
        "type": "GUARANTOR"
      }
    ],
    "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
    "gracePeriod": 0,
    "gracePeriodType": "PAY_INTEREST_ONLY",
    "guarantees": [
      {
        "amount": 0,
        "assetName": "string",
        "customFieldValues": [
          {
            "amount": 0,
            "customField": {
              "amounts": {
                "property1": 0,
                "property2": 0
              },
              "builtInCustomFieldId": "MOBILE_PHONE",
              "creationDate": "string",
              "customFieldProductSettings": [
                {
                  "customFieldEncodedKey": "string",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isDefault": true,
                  "isRequired": true,
                  "linkType": "CLIENT_ROLE",
                  "productKey": "string"
                }
              ],
              "customFieldSelectionOptions": [
                {
                  "constraint": {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "score": 0,
                  "value": "string"
                }
              ],
              "customFieldSet": {
                "builtInType": "DETAILS",
                "createdDate": "string",
                "customFields": [
                  {}
                ],
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "notes": "string",
                "type": "USER_INFO",
                "usage": "SINGLE"
              },
              "dataType": "GROUP_LINK",
              "description": "string",
              "editRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "isDefault": true,
              "isRequired": true,
              "lastModifiedDate": "string",
              "name": "string",
              "state": "DEACTIVATED",
              "type": "USER_INFO",
              "unique": true,
              "validationPattern": "string",
              "valueLength": "SHORT",
              "values": [
                "string"
              ],
              "viewRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "customFieldID": "string",
            "customFieldKey": "string",
            "customFieldSetGroupIndex": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "linkedEntityKeyValue": "string",
            "parentKey": "string",
            "selectionKey": "string",
            "value": "string"
          }
        ],
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "guarantorKey": "string",
        "guarantorType": "GROUP",
        "savingsAccountKey": "string",
        "type": "GUARANTOR"
      }
    ],
    "hasCustomSchedule": true,
    "holdBalance": 0,
    "id": "string",
    "interestApplicationMethod": "ON_REPAYMENT",
    "interestBalance": 0,
    "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
    "interestCalculationMethod": "DECLINING_BALANCE",
    "interestChargeFrequency": "EVERY_WEEK",
    "interestCommission": 0,
    "interestDue": 0,
    "interestFromArrearsAccrued": 0,
    "interestFromArrearsBalance": 0,
    "interestFromArrearsDue": 0,
    "interestFromArrearsPaid": 0,
    "interestPaid": 0,
    "interestRate": 0,
    "interestRateReviewCount": 0,
    "interestRateReviewUnit": "MONTHS",
    "interestRateSource": "FIXED_INTEREST_RATE",
    "interestRoundingVersion": "VERSION_2",
    "interestSpread": 0,
    "interestType": "CAPITALIZED_INTEREST",
    "lastAccountAppraisalDate": "string",
    "lastInterestAppliedDate": "string",
    "lastInterestReviewDate": "string",
    "lastLockedDate": "string",
    "lastModifiedDate": "string",
    "lastSetToArrearsDate": "string",
    "lastTaxRateReviewDate": "string",
    "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
    "lineOfCreditKey": "string",
    "loanAmount": 0,
    "loanGroup": {
      "accounts": [
        {}
      ],
      "creationDate": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "group": {
        "assignedBranchKey": "string",
        "assignedCentreKey": "string",
        "assignedUserKey": "string",
        "clientRole": {
          "encodedKey": "string"
        },
        "creationDate": "2019-08-24T14:15:22Z",
        "emailAddress": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "groupName": "string",
        "homePhone": "string",
        "id": "string",
        "idPattern": "string",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "loanCycle": 0,
        "migrationEvent": {
          "creationDate": "2019-08-24T14:15:22Z",
          "encodedKey": "string",
          "numCentresImported": 0,
          "numClientsImported": 0,
          "numGLAccountsImported": 0,
          "numGroupsImported": 0,
          "numLoanRepaymentsImported": 0,
          "numLoanTransactionsImported": 0,
          "numLoansImported": 0,
          "numSavingsImported": 0,
          "state": "REVERTED",
          "type": "IMPORT"
        },
        "mobilePhone1": "string",
        "preferredLanguage": "PORTUGESE"
      },
      "lastModifiedDate": "string",
      "name": "string",
      "notes": "string"
    },
    "loanName": "string",
    "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
    "lockedOperations": [
      "APPLY_FEES"
    ],
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "notes": "string",
    "originalAccountKey": "string",
    "paymentMethod": "VERTICAL",
    "paymentPlan": [
      {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "endingInstallmentPosition": 0,
        "index": 0,
        "loanAccountEncodedKey": "string",
        "pmt": 0
      }
    ],
    "penaltyBalance": 0,
    "penaltyDue": 0,
    "penaltyPaid": 0,
    "penaltyRate": 0,
    "periodicPayment": 0,
    "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
    "prepaymentRecalculationMethod": "NO_RECALCULATION",
    "principalBalance": 0,
    "principalDue": 0,
    "principalPaid": 0,
    "principalPaidInstallmentStatus": "PARTIALLY_PAID",
    "principalPaymentSettings": {
      "amount": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "includeFeesInFloorAmount": true,
      "includeInterestInFloorAmount": true,
      "percentage": 0,
      "principalCeilingValue": 0,
      "principalFloorValue": 0,
      "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
    },
    "principalRepaymentInterval": 0,
    "productTypeKey": "string",
    "redrawBalance": 0,
    "redrawSettings": {
      "account": {},
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "restrictNextDueWithdrawal": true
    },
    "repaymentInstallments": 0,
    "repaymentPeriodCount": 0,
    "repaymentPeriodUnit": "MONTHS",
    "repaymentScheduleMethod": "FIXED",
    "rescheduledAccountKey": "string",
    "scheduleDueDatesMethod": "INTERVAL",
    "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
    "taxRate": 0,
    "tranches": [
      {
        "amount": 0,
        "disbursementTransactionKey": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "expectedDisbursementDate": "string",
        "index": 0
      }
    ]
  },
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "restrictNextDueWithdrawal": true
}

Properties

Name	Type	Description	Restrictions
account	LoanAccountApiV1	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
restrictNextDueWithdrawal	boolean	none	none

LoanGroupApiV1

{
  "accounts": [
    {
      "accountArrearsSettings": {
        "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
        "encodedKey": "string",
        "monthlyToleranceDay": 0,
        "nonWorkingDaysMethod": "EXCLUDED",
        "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY",
        "toleranceFloorAmount": 0,
        "tolerancePercentageOfOutstandingPrincipal": 0,
        "tolerancePeriod": 0
      },
      "accountHolderKey": "string",
      "accountHolderType": "GROUP",
      "accountState": "WITHDRAWN",
      "accountSubState": "WITHDRAWN",
      "accrueInterestAfterMaturity": true,
      "accrueLateInterest": true,
      "accruedInterest": 0,
      "accruedPenalty": 0,
      "activationTransactionKey": "string",
      "allowOffset": true,
      "applyInterestOnPrepaymentMethod": "AUTOMATIC",
      "approvedDate": "string",
      "arrearsTolerancePeriod": 0,
      "assignedBranchKey": "string",
      "assignedCentreKey": "string",
      "assignedUserKey": "string",
      "closedDate": "string",
      "creationDate": "string",
      "customFieldValues": [
        {
          "amount": 0,
          "customField": {
            "amounts": {
              "property1": 0,
              "property2": 0
            },
            "builtInCustomFieldId": "MOBILE_PHONE",
            "creationDate": "string",
            "customFieldProductSettings": [
              {
                "customFieldEncodedKey": "string",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isDefault": true,
                "isRequired": true,
                "linkType": "CLIENT_ROLE",
                "productKey": "string"
              }
            ],
            "customFieldSelectionOptions": [
              {
                "constraint": {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "score": 0,
                "value": "string"
              }
            ],
            "customFieldSet": {
              "builtInType": "DETAILS",
              "createdDate": "string",
              "customFields": [
                {}
              ],
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "lastModifiedDate": "string",
              "name": "string",
              "notes": "string",
              "type": "USER_INFO",
              "usage": "SINGLE"
            },
            "dataType": "GROUP_LINK",
            "description": "string",
            "editRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "isDefault": true,
            "isRequired": true,
            "lastModifiedDate": "string",
            "name": "string",
            "state": "DEACTIVATED",
            "type": "USER_INFO",
            "unique": true,
            "validationPattern": "string",
            "valueLength": "SHORT",
            "values": [
              "string"
            ],
            "viewRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "customFieldID": "string",
          "customFieldKey": "string",
          "customFieldSetGroupIndex": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "linkedEntityKeyValue": "string",
          "parentKey": "string",
          "selectionKey": "string",
          "value": "string"
        }
      ],
      "daysInArrears": 0,
      "defaultFirstRepaymentDueDateOffset": 0,
      "disbursementDetails": {
        "customInformation": [
          {
            "amount": 0,
            "customField": {
              "amounts": {
                "property1": 0,
                "property2": 0
              },
              "builtInCustomFieldId": "MOBILE_PHONE",
              "creationDate": "string",
              "customFieldProductSettings": [
                {
                  "customFieldEncodedKey": "string",
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isDefault": true,
                  "isRequired": true,
                  "linkType": "CLIENT_ROLE",
                  "productKey": "string"
                }
              ],
              "customFieldSelectionOptions": [
                {
                  "constraint": {
                    "customFieldKey": "string",
                    "dataFieldType": "NATIVE",
                    "dataFieldValue": "string",
                    "dataItemType": "WRITTEN_OFF_LOANS",
                    "dataType": "ENUM",
                    "encodedKey": "string",
                    "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                    "groupNumber": 0,
                    "index": 0,
                    "linkingOperator": "OR",
                    "secondValue": "string",
                    "value": "string"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "score": 0,
                  "value": "string"
                }
              ],
              "customFieldSet": {
                "builtInType": "DETAILS",
                "createdDate": "string",
                "customFields": [
                  {}
                ],
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "notes": "string",
                "type": "USER_INFO",
                "usage": "SINGLE"
              },
              "dataType": "GROUP_LINK",
              "description": "string",
              "editRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "indexInList": 0,
              "isDefault": true,
              "isRequired": true,
              "lastModifiedDate": "string",
              "name": "string",
              "state": "DEACTIVATED",
              "type": "USER_INFO",
              "unique": true,
              "validationPattern": "string",
              "valueLength": "SHORT",
              "values": [
                "string"
              ],
              "viewRights": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "isAccessibleByAllUsers": true,
                "roles": [
                  "string"
                ]
              }
            },
            "customFieldID": "string",
            "customFieldKey": "string",
            "customFieldSetGroupIndex": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "indexInList": 0,
            "linkedEntityKeyValue": "string",
            "parentKey": "string",
            "selectionKey": "string",
            "value": "string"
          }
        ],
        "disbursementDate": "string",
        "encodedKey": "string",
        "expectedDisbursementDate": "string",
        "fees": [
          {
            "amount": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "fee": {
              "active": true,
              "amortizationIntervalSettings": {
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
                "intervalCount": 0,
                "intervalType": "FULL_TERM",
                "periodCount": 0,
                "periodUnit": "MONTHS"
              },
              "amortizationProfile": "STRAIGHT_LINE",
              "amount": 0,
              "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
              "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
              "creationDate": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
              "feeApplication": "OPTIONAL",
              "feeProductRules": [
                {
                  "account": {
                    "activated": true,
                    "allowManualJournalEntries": true,
                    "balance": 0,
                    "creationDate": "2019-08-24T14:15:22Z",
                    "currency": {},
                    "description": "string",
                    "encodedKey": "string",
                    "glCode": "string",
                    "lastModifiedDate": "2019-08-24T14:15:22Z",
                    "migrationEvent": {},
                    "name": "string",
                    "stripTrailingZeros": true,
                    "type": "INCOME",
                    "usage": "HEADER"
                  },
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "financialResource": "FEE_RECEIVABLE",
                  "index": 0,
                  "predefinedFeeKey": "string",
                  "productKey": "string",
                  "productType": "LOAN",
                  "transactionChannelKey": "string"
                }
              ],
              "name": "string",
              "percentageAmount": 0,
              "trigger": "DISBURSEMENT"
            }
          }
        ],
        "firstRepaymentDate": "string",
        "transactionDetails": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "internalTransfer": true,
          "targetSavingsAccountKey": "string",
          "transactionChannel": {
            "activated": true,
            "createdByUserKey": "string",
            "creationDate": "string",
            "customFields": [
              {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              }
            ],
            "encodedKey": "string",
            "id": "string",
            "index": 0,
            "loanConstraints": {
              "customConfigurationInfo": {
                "creationDate": "string",
                "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "shared": true,
                "userKey": "string"
              },
              "encodedKey": "string",
              "filterConstraints": [
                {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                }
              ]
            },
            "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
            "name": "string",
            "savingsConstraints": {
              "customConfigurationInfo": {
                "creationDate": "string",
                "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "indexInList": 0,
                "lastModifiedDate": "string",
                "name": "string",
                "shared": true,
                "userKey": "string"
              },
              "encodedKey": "string",
              "filterConstraints": [
                {
                  "customFieldKey": "string",
                  "dataFieldType": "NATIVE",
                  "dataFieldValue": "string",
                  "dataItemType": "WRITTEN_OFF_LOANS",
                  "dataType": "ENUM",
                  "encodedKey": "string",
                  "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                  "groupNumber": 0,
                  "index": 0,
                  "linkingOperator": "OR",
                  "secondValue": "string",
                  "value": "string"
                }
              ]
            },
            "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
            "transactionChannelAccountingRule": {
              "account": {
                "activated": true,
                "allowManualJournalEntries": true,
                "balance": 0,
                "creationDate": "2019-08-24T14:15:22Z",
                "currency": {
                  "code": "string",
                  "creationDate": "string",
                  "currencySymbolPosition": "AFTER_NUMBER",
                  "digitsAfterDecimal": 0,
                  "isBaseCurrency": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "symbol": "string"
                },
                "description": "string",
                "encodedKey": "string",
                "glCode": "string",
                "lastModifiedDate": "2019-08-24T14:15:22Z",
                "migrationEvent": {
                  "creationDate": "2019-08-24T14:15:22Z",
                  "encodedKey": "string",
                  "numCentresImported": 0,
                  "numClientsImported": 0,
                  "numGLAccountsImported": 0,
                  "numGroupsImported": 0,
                  "numLoanRepaymentsImported": 0,
                  "numLoanTransactionsImported": 0,
                  "numLoansImported": 0,
                  "numSavingsImported": 0,
                  "state": "REVERTED",
                  "type": "IMPORT"
                },
                "name": "string",
                "stripTrailingZeros": true,
                "type": "INCOME",
                "usage": "HEADER"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "financialResource": "FEE_RECEIVABLE",
              "index": 0,
              "predefinedFeeKey": "string",
              "productKey": "string",
              "productType": "LOAN",
              "transactionChannelKey": "string"
            },
            "usageRights": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isAccessibleByAllUsers": true,
              "roles": [
                "string"
              ]
            }
          },
          "transactionChannelKey": "string"
        }
      },
      "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "feesBalance": 0,
      "feesDue": 0,
      "feesPaid": 0,
      "fixedDaysOfMonth": [
        0
      ],
      "funds": [
        {
          "amount": 0,
          "assetName": "string",
          "customFieldValues": [
            {
              "amount": 0,
              "customField": {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              },
              "customFieldID": "string",
              "customFieldKey": "string",
              "customFieldSetGroupIndex": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "linkedEntityKeyValue": "string",
              "parentKey": "string",
              "selectionKey": "string",
              "value": "string"
            }
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "guarantorKey": "string",
          "guarantorType": "GROUP",
          "id": "string",
          "interestCommission": 0,
          "investmentPercentage": 0,
          "savingsAccountKey": "string",
          "type": "GUARANTOR"
        }
      ],
      "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
      "gracePeriod": 0,
      "gracePeriodType": "PAY_INTEREST_ONLY",
      "guarantees": [
        {
          "amount": 0,
          "assetName": "string",
          "customFieldValues": [
            {
              "amount": 0,
              "customField": {
                "amounts": {
                  "property1": 0,
                  "property2": 0
                },
                "builtInCustomFieldId": "MOBILE_PHONE",
                "creationDate": "string",
                "customFieldProductSettings": [
                  {
                    "customFieldEncodedKey": "string",
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "isDefault": true,
                    "isRequired": true,
                    "linkType": "CLIENT_ROLE",
                    "productKey": "string"
                  }
                ],
                "customFieldSelectionOptions": [
                  {
                    "constraint": {},
                    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                    "id": "string",
                    "score": 0,
                    "value": "string"
                  }
                ],
                "customFieldSet": {
                  "builtInType": "DETAILS",
                  "createdDate": "string",
                  "customFields": [
                    {}
                  ],
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "id": "string",
                  "indexInList": 0,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "notes": "string",
                  "type": "USER_INFO",
                  "usage": "SINGLE"
                },
                "dataType": "GROUP_LINK",
                "description": "string",
                "editRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "id": "string",
                "indexInList": 0,
                "isDefault": true,
                "isRequired": true,
                "lastModifiedDate": "string",
                "name": "string",
                "state": "DEACTIVATED",
                "type": "USER_INFO",
                "unique": true,
                "validationPattern": "string",
                "valueLength": "SHORT",
                "values": [
                  "string"
                ],
                "viewRights": {
                  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                  "isAccessibleByAllUsers": true,
                  "roles": [
                    "string"
                  ]
                }
              },
              "customFieldID": "string",
              "customFieldKey": "string",
              "customFieldSetGroupIndex": 0,
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "indexInList": 0,
              "linkedEntityKeyValue": "string",
              "parentKey": "string",
              "selectionKey": "string",
              "value": "string"
            }
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "guarantorKey": "string",
          "guarantorType": "GROUP",
          "savingsAccountKey": "string",
          "type": "GUARANTOR"
        }
      ],
      "hasCustomSchedule": true,
      "holdBalance": 0,
      "id": "string",
      "interestApplicationMethod": "ON_REPAYMENT",
      "interestBalance": 0,
      "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
      "interestCalculationMethod": "DECLINING_BALANCE",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestCommission": 0,
      "interestDue": 0,
      "interestFromArrearsAccrued": 0,
      "interestFromArrearsBalance": 0,
      "interestFromArrearsDue": 0,
      "interestFromArrearsPaid": 0,
      "interestPaid": 0,
      "interestRate": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRoundingVersion": "VERSION_2",
      "interestSpread": 0,
      "interestType": "CAPITALIZED_INTEREST",
      "lastAccountAppraisalDate": "string",
      "lastInterestAppliedDate": "string",
      "lastInterestReviewDate": "string",
      "lastLockedDate": "string",
      "lastModifiedDate": "string",
      "lastSetToArrearsDate": "string",
      "lastTaxRateReviewDate": "string",
      "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
      "lineOfCreditKey": "string",
      "loanAmount": 0,
      "loanGroup": {
        "accounts": [],
        "creationDate": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "group": {
          "assignedBranchKey": "string",
          "assignedCentreKey": "string",
          "assignedUserKey": "string",
          "clientRole": {
            "encodedKey": "string"
          },
          "creationDate": "2019-08-24T14:15:22Z",
          "emailAddress": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "groupName": "string",
          "homePhone": "string",
          "id": "string",
          "idPattern": "string",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "loanCycle": 0,
          "migrationEvent": {
            "creationDate": "2019-08-24T14:15:22Z",
            "encodedKey": "string",
            "numCentresImported": 0,
            "numClientsImported": 0,
            "numGLAccountsImported": 0,
            "numGroupsImported": 0,
            "numLoanRepaymentsImported": 0,
            "numLoanTransactionsImported": 0,
            "numLoansImported": 0,
            "numSavingsImported": 0,
            "state": "REVERTED",
            "type": "IMPORT"
          },
          "mobilePhone1": "string",
          "preferredLanguage": "PORTUGESE"
        },
        "lastModifiedDate": "string",
        "name": "string",
        "notes": "string"
      },
      "loanName": "string",
      "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
      "lockedOperations": [
        "APPLY_FEES"
      ],
      "migrationEvent": {
        "creationDate": "2019-08-24T14:15:22Z",
        "encodedKey": "string",
        "numCentresImported": 0,
        "numClientsImported": 0,
        "numGLAccountsImported": 0,
        "numGroupsImported": 0,
        "numLoanRepaymentsImported": 0,
        "numLoanTransactionsImported": 0,
        "numLoansImported": 0,
        "numSavingsImported": 0,
        "state": "REVERTED",
        "type": "IMPORT"
      },
      "notes": "string",
      "originalAccountKey": "string",
      "paymentMethod": "VERTICAL",
      "paymentPlan": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingInstallmentPosition": 0,
          "index": 0,
          "loanAccountEncodedKey": "string",
          "pmt": 0
        }
      ],
      "penaltyBalance": 0,
      "penaltyDue": 0,
      "penaltyPaid": 0,
      "penaltyRate": 0,
      "periodicPayment": 0,
      "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
      "prepaymentRecalculationMethod": "NO_RECALCULATION",
      "principalBalance": 0,
      "principalDue": 0,
      "principalPaid": 0,
      "principalPaidInstallmentStatus": "PARTIALLY_PAID",
      "principalPaymentSettings": {
        "amount": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "includeFeesInFloorAmount": true,
        "includeInterestInFloorAmount": true,
        "percentage": 0,
        "principalCeilingValue": 0,
        "principalFloorValue": 0,
        "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
      },
      "principalRepaymentInterval": 0,
      "productTypeKey": "string",
      "redrawBalance": 0,
      "redrawSettings": {
        "account": {},
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "restrictNextDueWithdrawal": true
      },
      "repaymentInstallments": 0,
      "repaymentPeriodCount": 0,
      "repaymentPeriodUnit": "MONTHS",
      "repaymentScheduleMethod": "FIXED",
      "rescheduledAccountKey": "string",
      "scheduleDueDatesMethod": "INTERVAL",
      "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
      "taxRate": 0,
      "tranches": [
        {
          "amount": 0,
          "disbursementTransactionKey": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "expectedDisbursementDate": "string",
          "index": 0
        }
      ]
    }
  ],
  "creationDate": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "group": {
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "clientRole": {
      "encodedKey": "string"
    },
    "creationDate": "2019-08-24T14:15:22Z",
    "emailAddress": "string",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "groupName": "string",
    "homePhone": "string",
    "id": "string",
    "idPattern": "string",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "loanCycle": 0,
    "migrationEvent": {
      "creationDate": "2019-08-24T14:15:22Z",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "mobilePhone1": "string",
    "preferredLanguage": "PORTUGESE"
  },
  "lastModifiedDate": "string",
  "name": "string",
  "notes": "string"
}

Properties

Name	Type	Description	Restrictions
accounts	[LoanAccountApiV1]	none	none
creationDate	string	the date and time when this group was created	none
encodedKey	string	the automatically generated encoded ID for this item	none
group	GroupApiV1	A group object	none
lastModifiedDate	string	the date on which this group was last modified	none
name	string	none	none
notes	string	none	none

LoanProductApiV1

{
  "accountInitialState": "WITHDRAWN",
  "accountLinkingEnabled": true,
  "accountingMethod": "NONE",
  "accrueLateInterest": true,
  "activated": true,
  "allowArbitraryFees": true,
  "allowCustomRepaymentAllocation": true,
  "amortizationMethod": "PAYMENT_PLAN",
  "applyInterestOnPrepaymentMethod": "AUTOMATIC",
  "arrearsSettings": {
    "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
    "defaultTolerancePeriod": 0,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "maxTolerancePeriod": 0,
    "minTolerancePeriod": 0,
    "monthlyToleranceDay": 0,
    "nonWorkingDaysMethod": "EXCLUDED",
    "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY"
  },
  "autoCreateLinkedAccounts": true,
  "autoLinkAccounts": true,
  "availableProductBranches": [
    {
      "branchKey": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "product": {
        "accountInitialState": "WITHDRAWN",
        "accountLinkingEnabled": true,
        "accountingMethod": "NONE",
        "accrueLateInterest": true,
        "activated": true,
        "allowArbitraryFees": true,
        "allowCustomRepaymentAllocation": true,
        "amortizationMethod": "PAYMENT_PLAN",
        "applyInterestOnPrepaymentMethod": "AUTOMATIC",
        "arrearsSettings": {
          "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
          "defaultTolerancePeriod": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "maxTolerancePeriod": 0,
          "minTolerancePeriod": 0,
          "monthlyToleranceDay": 0,
          "nonWorkingDaysMethod": "EXCLUDED",
          "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY"
        },
        "autoCreateLinkedAccounts": true,
        "autoLinkAccounts": true,
        "availableProductBranches": [],
        "cappingApplyAccruedChargesBeforeLocking": true,
        "cappingConstraintType": "SOFT_CAP",
        "cappingMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE",
        "cappingPercentage": 0,
        "creationDate": "string",
        "daysInYear": "E30_42_365",
        "defaultFirstRepaymentDueDateOffset": 0,
        "defaultGracePeriod": 0,
        "defaultLoanAmount": 0,
        "defaultNumInstallments": 0,
        "defaultPenaltyRate": 0,
        "defaultPrincipalRepaymentInterval": 0,
        "defaultRepaymentPeriodCount": 0,
        "dormancyPeriodDays": 0,
        "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "fixedDaysOfMonth": [
          0
        ],
        "forAllBranches": true,
        "forHybridGroups": true,
        "forIndividuals": true,
        "forPureGroups": true,
        "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
        "gracePeriodType": "PAY_INTEREST_ONLY",
        "id": "string",
        "idGeneratorType": "INCREMENTAL_NUMBER",
        "idPattern": "string",
        "interestAccrualCalculation": "BREAKDOWN_PER_ACCOUNT",
        "interestAccruedAccountingMethod": "DAILY",
        "interestApplicationMethod": "ON_REPAYMENT",
        "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
        "interestCalculationMethod": "DECLINING_BALANCE",
        "interestRateSettings": {
          "accrueInterestAfterMaturity": true,
          "defaultInterestRate": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexSourceKey": "string",
          "interestChargeFrequency": "EVERY_WEEK",
          "interestChargeFrequencyCount": 0,
          "interestRateCeilingValue": 0,
          "interestRateFloorValue": 0,
          "interestRateReviewCount": 0,
          "interestRateReviewUnit": "MONTHS",
          "interestRateSource": "FIXED_INTEREST_RATE",
          "interestRateTerms": "TIERED_PERIOD",
          "interestRateTiers": [
            {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "endingBalance": 0,
              "endingDay": 0,
              "index": 0,
              "interestRate": 0
            }
          ],
          "maxInterestRate": 0,
          "minInterestRate": 0
        },
        "interestType": "CAPITALIZED_INTEREST",
        "lastModifiedDate": "string",
        "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
        "lineOfCreditRequirement": "OPTIONAL",
        "linkableSavingsProductKey": "string",
        "loanFees": [
          {
            "active": true,
            "amortizationIntervalSettings": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
              "intervalCount": 0,
              "intervalType": "FULL_TERM",
              "periodCount": 0,
              "periodUnit": "MONTHS"
            },
            "amortizationProfile": "STRAIGHT_LINE",
            "amount": 0,
            "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
            "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
            "creationDate": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
            "feeApplication": "OPTIONAL",
            "feeProductRules": [
              {
                "account": {
                  "activated": true,
                  "allowManualJournalEntries": true,
                  "balance": 0,
                  "creationDate": "2019-08-24T14:15:22Z",
                  "currency": {
                    "code": "string",
                    "creationDate": "string",
                    "currencySymbolPosition": "AFTER_NUMBER",
                    "digitsAfterDecimal": 0,
                    "isBaseCurrency": true,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "symbol": "string"
                  },
                  "description": "string",
                  "encodedKey": "string",
                  "glCode": "string",
                  "lastModifiedDate": "2019-08-24T14:15:22Z",
                  "migrationEvent": {
                    "creationDate": "2019-08-24T14:15:22Z",
                    "encodedKey": "string",
                    "numCentresImported": 0,
                    "numClientsImported": 0,
                    "numGLAccountsImported": 0,
                    "numGroupsImported": 0,
                    "numLoanRepaymentsImported": 0,
                    "numLoanTransactionsImported": 0,
                    "numLoansImported": 0,
                    "numSavingsImported": 0,
                    "state": "REVERTED",
                    "type": "IMPORT"
                  },
                  "name": "string",
                  "stripTrailingZeros": true,
                  "type": "INCOME",
                  "usage": "HEADER"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "financialResource": "FEE_RECEIVABLE",
                "index": 0,
                "predefinedFeeKey": "string",
                "productKey": "string",
                "productType": "LOAN",
                "transactionChannelKey": "string"
              }
            ],
            "name": "string",
            "percentageAmount": 0,
            "trigger": "DISBURSEMENT"
          }
        ],
        "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
        "loanPenaltyGracePeriod": 0,
        "loanProductRules": [
          {
            "account": {
              "activated": true,
              "allowManualJournalEntries": true,
              "balance": 0,
              "creationDate": "2019-08-24T14:15:22Z",
              "currency": {
                "code": "string",
                "creationDate": "string",
                "currencySymbolPosition": "AFTER_NUMBER",
                "digitsAfterDecimal": 0,
                "isBaseCurrency": true,
                "lastModifiedDate": "string",
                "name": "string",
                "symbol": "string"
              },
              "description": "string",
              "encodedKey": "string",
              "glCode": "string",
              "lastModifiedDate": "2019-08-24T14:15:22Z",
              "migrationEvent": {
                "creationDate": "2019-08-24T14:15:22Z",
                "encodedKey": "string",
                "numCentresImported": 0,
                "numClientsImported": 0,
                "numGLAccountsImported": 0,
                "numGroupsImported": 0,
                "numLoanRepaymentsImported": 0,
                "numLoanTransactionsImported": 0,
                "numLoansImported": 0,
                "numSavingsImported": 0,
                "state": "REVERTED",
                "type": "IMPORT"
              },
              "name": "string",
              "stripTrailingZeros": true,
              "type": "INCOME",
              "usage": "HEADER"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "financialResource": "FEE_RECEIVABLE",
            "index": 0,
            "predefinedFeeKey": "string",
            "productKey": "string",
            "productType": "LOAN",
            "transactionChannelKey": "string"
          }
        ],
        "loanProductType": "INTEREST_FREE_LOAN",
        "lockPeriodDays": 0,
        "maxFirstRepaymentDueDateOffset": 0,
        "maxGracePeriod": 0,
        "maxLoanAmount": 0,
        "maxNumInstallments": 0,
        "maxNumberOfDisbursementTranches": 0,
        "maxPenaltyRate": 0,
        "minFirstRepaymentDueDateOffset": 0,
        "minGracePeriod": 0,
        "minLoanAmount": 0,
        "minNumInstallments": 0,
        "minPenaltyRate": 0,
        "offsetPercentage": 0,
        "offsetSettings": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isOffsetEnabled": true,
          "loanProduct": {}
        },
        "paymentMethod": "VERTICAL",
        "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
        "prepaymentRecalculationMethod": "NO_RECALCULATION",
        "principalPaidInstallmentStatus": "PARTIALLY_PAID",
        "principalPaymentSettings": {
          "defaultAmount": 0,
          "defaultPercentage": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "includeFeesInFloorAmount": true,
          "includeInterestInFloorAmount": true,
          "maxAmount": 0,
          "maxPercentage": 0,
          "minAmount": 0,
          "minPercentage": 0,
          "principalCeilingValue": 0,
          "principalFloorValue": 0,
          "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
        },
        "productDescription": "string",
        "productName": "string",
        "productSecuritySettings": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "funderInterestCommission": {
            "defaultValue": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "maxValue": 0,
            "minValue": 0
          },
          "funderInterestCommissionAllocationType": "PERCENTAGE_OF_LOAN_FUNDING",
          "isCollateralEnabled": true,
          "isGuarantorsEnabled": true,
          "isInvestorFundsEnabled": true,
          "lockFundsAtApproval": true,
          "organizationInterestCommission": {
            "defaultValue": 0,
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "maxValue": 0,
            "minValue": 0
          },
          "requiredGuaranties": 0,
          "requiredInvestorFunds": 0
        },
        "redrawSettings": {
          "allowRedraw": true,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472"
        },
        "repaymentAllocationOrder": [
          "PENALTY"
        ],
        "repaymentCurrencyRounding": "ROUND_UP_TO_NEAREST_WHOLE_UNIT",
        "repaymentElementsRoundingMethod": "NO_ROUNDING",
        "repaymentPeriodUnit": "MONTHS",
        "repaymentReschedulingMethod": "PREVIOUS_WORKING_DAY",
        "repaymentScheduleEditOptions": [
          "ADJUST_PRINCIPAL_PAYMENT_SCHEDULE"
        ],
        "repaymentScheduleMethod": "FIXED",
        "roundingRepaymentScheduleMethod": "ROUND_PRINCIPAL_AND_INTEREST_REMAINDER_INTO_LAST_REPAYMENT",
        "scheduleDueDatesMethod": "INTERVAL",
        "scheduleInterestDaysCountMethod": "USING_REPAYMENT_PERIODICITY",
        "settlementOptions": "NO_AUTOMATED_TRANSFERS",
        "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
        "taxCalculationMethod": "EXCLUSIVE",
        "taxSourceKey": "string",
        "taxesOnFeesEnabled": true,
        "taxesOnInterestEnabled": true,
        "taxesOnPenaltyEnabled": true,
        "templates": [
          {
            "creationDate": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "lastModifiedDate": "string",
            "name": "string",
            "type": "ACCOUNT"
          }
        ]
      }
    }
  ],
  "cappingApplyAccruedChargesBeforeLocking": true,
  "cappingConstraintType": "SOFT_CAP",
  "cappingMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE",
  "cappingPercentage": 0,
  "creationDate": "string",
  "daysInYear": "E30_42_365",
  "defaultFirstRepaymentDueDateOffset": 0,
  "defaultGracePeriod": 0,
  "defaultLoanAmount": 0,
  "defaultNumInstallments": 0,
  "defaultPenaltyRate": 0,
  "defaultPrincipalRepaymentInterval": 0,
  "defaultRepaymentPeriodCount": 0,
  "dormancyPeriodDays": 0,
  "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "fixedDaysOfMonth": [
    0
  ],
  "forAllBranches": true,
  "forHybridGroups": true,
  "forIndividuals": true,
  "forPureGroups": true,
  "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
  "gracePeriodType": "PAY_INTEREST_ONLY",
  "id": "string",
  "idGeneratorType": "INCREMENTAL_NUMBER",
  "idPattern": "string",
  "interestAccrualCalculation": "BREAKDOWN_PER_ACCOUNT",
  "interestAccruedAccountingMethod": "DAILY",
  "interestApplicationMethod": "ON_REPAYMENT",
  "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
  "interestCalculationMethod": "DECLINING_BALANCE",
  "interestRateSettings": {
    "accrueInterestAfterMaturity": true,
    "defaultInterestRate": 0,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "indexSourceKey": "string",
    "interestChargeFrequency": "EVERY_WEEK",
    "interestChargeFrequencyCount": 0,
    "interestRateCeilingValue": 0,
    "interestRateFloorValue": 0,
    "interestRateReviewCount": 0,
    "interestRateReviewUnit": "MONTHS",
    "interestRateSource": "FIXED_INTEREST_RATE",
    "interestRateTerms": "TIERED_PERIOD",
    "interestRateTiers": [
      {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "endingBalance": 0,
        "endingDay": 0,
        "index": 0,
        "interestRate": 0
      }
    ],
    "maxInterestRate": 0,
    "minInterestRate": 0
  },
  "interestType": "CAPITALIZED_INTEREST",
  "lastModifiedDate": "string",
  "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
  "lineOfCreditRequirement": "OPTIONAL",
  "linkableSavingsProductKey": "string",
  "loanFees": [
    {
      "active": true,
      "amortizationIntervalSettings": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
        "intervalCount": 0,
        "intervalType": "FULL_TERM",
        "periodCount": 0,
        "periodUnit": "MONTHS"
      },
      "amortizationProfile": "STRAIGHT_LINE",
      "amount": 0,
      "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
      "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
      "creationDate": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
      "feeApplication": "OPTIONAL",
      "feeProductRules": [
        {
          "account": {
            "activated": true,
            "allowManualJournalEntries": true,
            "balance": 0,
            "creationDate": "2019-08-24T14:15:22Z",
            "currency": {
              "code": "string",
              "creationDate": "string",
              "currencySymbolPosition": "AFTER_NUMBER",
              "digitsAfterDecimal": 0,
              "isBaseCurrency": true,
              "lastModifiedDate": "string",
              "name": "string",
              "symbol": "string"
            },
            "description": "string",
            "encodedKey": "string",
            "glCode": "string",
            "lastModifiedDate": "2019-08-24T14:15:22Z",
            "migrationEvent": {
              "creationDate": "2019-08-24T14:15:22Z",
              "encodedKey": "string",
              "numCentresImported": 0,
              "numClientsImported": 0,
              "numGLAccountsImported": 0,
              "numGroupsImported": 0,
              "numLoanRepaymentsImported": 0,
              "numLoanTransactionsImported": 0,
              "numLoansImported": 0,
              "numSavingsImported": 0,
              "state": "REVERTED",
              "type": "IMPORT"
            },
            "name": "string",
            "stripTrailingZeros": true,
            "type": "INCOME",
            "usage": "HEADER"
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "financialResource": "FEE_RECEIVABLE",
          "index": 0,
          "predefinedFeeKey": "string",
          "productKey": "string",
          "productType": "LOAN",
          "transactionChannelKey": "string"
        }
      ],
      "name": "string",
      "percentageAmount": 0,
      "trigger": "DISBURSEMENT"
    }
  ],
  "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
  "loanPenaltyGracePeriod": 0,
  "loanProductRules": [
    {
      "account": {
        "activated": true,
        "allowManualJournalEntries": true,
        "balance": 0,
        "creationDate": "2019-08-24T14:15:22Z",
        "currency": {
          "code": "string",
          "creationDate": "string",
          "currencySymbolPosition": "AFTER_NUMBER",
          "digitsAfterDecimal": 0,
          "isBaseCurrency": true,
          "lastModifiedDate": "string",
          "name": "string",
          "symbol": "string"
        },
        "description": "string",
        "encodedKey": "string",
        "glCode": "string",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "migrationEvent": {
          "creationDate": "2019-08-24T14:15:22Z",
          "encodedKey": "string",
          "numCentresImported": 0,
          "numClientsImported": 0,
          "numGLAccountsImported": 0,
          "numGroupsImported": 0,
          "numLoanRepaymentsImported": 0,
          "numLoanTransactionsImported": 0,
          "numLoansImported": 0,
          "numSavingsImported": 0,
          "state": "REVERTED",
          "type": "IMPORT"
        },
        "name": "string",
        "stripTrailingZeros": true,
        "type": "INCOME",
        "usage": "HEADER"
      },
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "financialResource": "FEE_RECEIVABLE",
      "index": 0,
      "predefinedFeeKey": "string",
      "productKey": "string",
      "productType": "LOAN",
      "transactionChannelKey": "string"
    }
  ],
  "loanProductType": "INTEREST_FREE_LOAN",
  "lockPeriodDays": 0,
  "maxFirstRepaymentDueDateOffset": 0,
  "maxGracePeriod": 0,
  "maxLoanAmount": 0,
  "maxNumInstallments": 0,
  "maxNumberOfDisbursementTranches": 0,
  "maxPenaltyRate": 0,
  "minFirstRepaymentDueDateOffset": 0,
  "minGracePeriod": 0,
  "minLoanAmount": 0,
  "minNumInstallments": 0,
  "minPenaltyRate": 0,
  "offsetPercentage": 0,
  "offsetSettings": {
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "isOffsetEnabled": true,
    "loanProduct": {
      "accountInitialState": "WITHDRAWN",
      "accountLinkingEnabled": true,
      "accountingMethod": "NONE",
      "accrueLateInterest": true,
      "activated": true,
      "allowArbitraryFees": true,
      "allowCustomRepaymentAllocation": true,
      "amortizationMethod": "PAYMENT_PLAN",
      "applyInterestOnPrepaymentMethod": "AUTOMATIC",
      "arrearsSettings": {
        "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
        "defaultTolerancePeriod": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "maxTolerancePeriod": 0,
        "minTolerancePeriod": 0,
        "monthlyToleranceDay": 0,
        "nonWorkingDaysMethod": "EXCLUDED",
        "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY"
      },
      "autoCreateLinkedAccounts": true,
      "autoLinkAccounts": true,
      "availableProductBranches": [
        {
          "branchKey": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "product": {}
        }
      ],
      "cappingApplyAccruedChargesBeforeLocking": true,
      "cappingConstraintType": "SOFT_CAP",
      "cappingMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE",
      "cappingPercentage": 0,
      "creationDate": "string",
      "daysInYear": "E30_42_365",
      "defaultFirstRepaymentDueDateOffset": 0,
      "defaultGracePeriod": 0,
      "defaultLoanAmount": 0,
      "defaultNumInstallments": 0,
      "defaultPenaltyRate": 0,
      "defaultPrincipalRepaymentInterval": 0,
      "defaultRepaymentPeriodCount": 0,
      "dormancyPeriodDays": 0,
      "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "fixedDaysOfMonth": [
        0
      ],
      "forAllBranches": true,
      "forHybridGroups": true,
      "forIndividuals": true,
      "forPureGroups": true,
      "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
      "gracePeriodType": "PAY_INTEREST_ONLY",
      "id": "string",
      "idGeneratorType": "INCREMENTAL_NUMBER",
      "idPattern": "string",
      "interestAccrualCalculation": "BREAKDOWN_PER_ACCOUNT",
      "interestAccruedAccountingMethod": "DAILY",
      "interestApplicationMethod": "ON_REPAYMENT",
      "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
      "interestCalculationMethod": "DECLINING_BALANCE",
      "interestRateSettings": {
        "accrueInterestAfterMaturity": true,
        "defaultInterestRate": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexSourceKey": "string",
        "interestChargeFrequency": "EVERY_WEEK",
        "interestChargeFrequencyCount": 0,
        "interestRateCeilingValue": 0,
        "interestRateFloorValue": 0,
        "interestRateReviewCount": 0,
        "interestRateReviewUnit": "MONTHS",
        "interestRateSource": "FIXED_INTEREST_RATE",
        "interestRateTerms": "TIERED_PERIOD",
        "interestRateTiers": [
          {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "endingBalance": 0,
            "endingDay": 0,
            "index": 0,
            "interestRate": 0
          }
        ],
        "maxInterestRate": 0,
        "minInterestRate": 0
      },
      "interestType": "CAPITALIZED_INTEREST",
      "lastModifiedDate": "string",
      "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
      "lineOfCreditRequirement": "OPTIONAL",
      "linkableSavingsProductKey": "string",
      "loanFees": [
        {
          "active": true,
          "amortizationIntervalSettings": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
            "intervalCount": 0,
            "intervalType": "FULL_TERM",
            "periodCount": 0,
            "periodUnit": "MONTHS"
          },
          "amortizationProfile": "STRAIGHT_LINE",
          "amount": 0,
          "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
          "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
          "creationDate": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
          "feeApplication": "OPTIONAL",
          "feeProductRules": [
            {
              "account": {
                "activated": true,
                "allowManualJournalEntries": true,
                "balance": 0,
                "creationDate": "2019-08-24T14:15:22Z",
                "currency": {
                  "code": "string",
                  "creationDate": "string",
                  "currencySymbolPosition": "AFTER_NUMBER",
                  "digitsAfterDecimal": 0,
                  "isBaseCurrency": true,
                  "lastModifiedDate": "string",
                  "name": "string",
                  "symbol": "string"
                },
                "description": "string",
                "encodedKey": "string",
                "glCode": "string",
                "lastModifiedDate": "2019-08-24T14:15:22Z",
                "migrationEvent": {
                  "creationDate": "2019-08-24T14:15:22Z",
                  "encodedKey": "string",
                  "numCentresImported": 0,
                  "numClientsImported": 0,
                  "numGLAccountsImported": 0,
                  "numGroupsImported": 0,
                  "numLoanRepaymentsImported": 0,
                  "numLoanTransactionsImported": 0,
                  "numLoansImported": 0,
                  "numSavingsImported": 0,
                  "state": "REVERTED",
                  "type": "IMPORT"
                },
                "name": "string",
                "stripTrailingZeros": true,
                "type": "INCOME",
                "usage": "HEADER"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "financialResource": "FEE_RECEIVABLE",
              "index": 0,
              "predefinedFeeKey": "string",
              "productKey": "string",
              "productType": "LOAN",
              "transactionChannelKey": "string"
            }
          ],
          "name": "string",
          "percentageAmount": 0,
          "trigger": "DISBURSEMENT"
        }
      ],
      "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
      "loanPenaltyGracePeriod": 0,
      "loanProductRules": [
        {
          "account": {
            "activated": true,
            "allowManualJournalEntries": true,
            "balance": 0,
            "creationDate": "2019-08-24T14:15:22Z",
            "currency": {
              "code": "string",
              "creationDate": "string",
              "currencySymbolPosition": "AFTER_NUMBER",
              "digitsAfterDecimal": 0,
              "isBaseCurrency": true,
              "lastModifiedDate": "string",
              "name": "string",
              "symbol": "string"
            },
            "description": "string",
            "encodedKey": "string",
            "glCode": "string",
            "lastModifiedDate": "2019-08-24T14:15:22Z",
            "migrationEvent": {
              "creationDate": "2019-08-24T14:15:22Z",
              "encodedKey": "string",
              "numCentresImported": 0,
              "numClientsImported": 0,
              "numGLAccountsImported": 0,
              "numGroupsImported": 0,
              "numLoanRepaymentsImported": 0,
              "numLoanTransactionsImported": 0,
              "numLoansImported": 0,
              "numSavingsImported": 0,
              "state": "REVERTED",
              "type": "IMPORT"
            },
            "name": "string",
            "stripTrailingZeros": true,
            "type": "INCOME",
            "usage": "HEADER"
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "financialResource": "FEE_RECEIVABLE",
          "index": 0,
          "predefinedFeeKey": "string",
          "productKey": "string",
          "productType": "LOAN",
          "transactionChannelKey": "string"
        }
      ],
      "loanProductType": "INTEREST_FREE_LOAN",
      "lockPeriodDays": 0,
      "maxFirstRepaymentDueDateOffset": 0,
      "maxGracePeriod": 0,
      "maxLoanAmount": 0,
      "maxNumInstallments": 0,
      "maxNumberOfDisbursementTranches": 0,
      "maxPenaltyRate": 0,
      "minFirstRepaymentDueDateOffset": 0,
      "minGracePeriod": 0,
      "minLoanAmount": 0,
      "minNumInstallments": 0,
      "minPenaltyRate": 0,
      "offsetPercentage": 0,
      "offsetSettings": {},
      "paymentMethod": "VERTICAL",
      "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
      "prepaymentRecalculationMethod": "NO_RECALCULATION",
      "principalPaidInstallmentStatus": "PARTIALLY_PAID",
      "principalPaymentSettings": {
        "defaultAmount": 0,
        "defaultPercentage": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "includeFeesInFloorAmount": true,
        "includeInterestInFloorAmount": true,
        "maxAmount": 0,
        "maxPercentage": 0,
        "minAmount": 0,
        "minPercentage": 0,
        "principalCeilingValue": 0,
        "principalFloorValue": 0,
        "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
      },
      "productDescription": "string",
      "productName": "string",
      "productSecuritySettings": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "funderInterestCommission": {
          "defaultValue": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "maxValue": 0,
          "minValue": 0
        },
        "funderInterestCommissionAllocationType": "PERCENTAGE_OF_LOAN_FUNDING",
        "isCollateralEnabled": true,
        "isGuarantorsEnabled": true,
        "isInvestorFundsEnabled": true,
        "lockFundsAtApproval": true,
        "organizationInterestCommission": {
          "defaultValue": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "maxValue": 0,
          "minValue": 0
        },
        "requiredGuaranties": 0,
        "requiredInvestorFunds": 0
      },
      "redrawSettings": {
        "allowRedraw": true,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472"
      },
      "repaymentAllocationOrder": [
        "PENALTY"
      ],
      "repaymentCurrencyRounding": "ROUND_UP_TO_NEAREST_WHOLE_UNIT",
      "repaymentElementsRoundingMethod": "NO_ROUNDING",
      "repaymentPeriodUnit": "MONTHS",
      "repaymentReschedulingMethod": "PREVIOUS_WORKING_DAY",
      "repaymentScheduleEditOptions": [
        "ADJUST_PRINCIPAL_PAYMENT_SCHEDULE"
      ],
      "repaymentScheduleMethod": "FIXED",
      "roundingRepaymentScheduleMethod": "ROUND_PRINCIPAL_AND_INTEREST_REMAINDER_INTO_LAST_REPAYMENT",
      "scheduleDueDatesMethod": "INTERVAL",
      "scheduleInterestDaysCountMethod": "USING_REPAYMENT_PERIODICITY",
      "settlementOptions": "NO_AUTOMATED_TRANSFERS",
      "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
      "taxCalculationMethod": "EXCLUSIVE",
      "taxSourceKey": "string",
      "taxesOnFeesEnabled": true,
      "taxesOnInterestEnabled": true,
      "taxesOnPenaltyEnabled": true,
      "templates": [
        {
          "creationDate": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "lastModifiedDate": "string",
          "name": "string",
          "type": "ACCOUNT"
        }
      ]
    }
  },
  "paymentMethod": "VERTICAL",
  "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
  "prepaymentRecalculationMethod": "NO_RECALCULATION",
  "principalPaidInstallmentStatus": "PARTIALLY_PAID",
  "principalPaymentSettings": {
    "defaultAmount": 0,
    "defaultPercentage": 0,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "includeFeesInFloorAmount": true,
    "includeInterestInFloorAmount": true,
    "maxAmount": 0,
    "maxPercentage": 0,
    "minAmount": 0,
    "minPercentage": 0,
    "principalCeilingValue": 0,
    "principalFloorValue": 0,
    "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
  },
  "productDescription": "string",
  "productName": "string",
  "productSecuritySettings": {
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "funderInterestCommission": {
      "defaultValue": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "maxValue": 0,
      "minValue": 0
    },
    "funderInterestCommissionAllocationType": "PERCENTAGE_OF_LOAN_FUNDING",
    "isCollateralEnabled": true,
    "isGuarantorsEnabled": true,
    "isInvestorFundsEnabled": true,
    "lockFundsAtApproval": true,
    "organizationInterestCommission": {
      "defaultValue": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "maxValue": 0,
      "minValue": 0
    },
    "requiredGuaranties": 0,
    "requiredInvestorFunds": 0
  },
  "redrawSettings": {
    "allowRedraw": true,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472"
  },
  "repaymentAllocationOrder": [
    "PENALTY"
  ],
  "repaymentCurrencyRounding": "ROUND_UP_TO_NEAREST_WHOLE_UNIT",
  "repaymentElementsRoundingMethod": "NO_ROUNDING",
  "repaymentPeriodUnit": "MONTHS",
  "repaymentReschedulingMethod": "PREVIOUS_WORKING_DAY",
  "repaymentScheduleEditOptions": [
    "ADJUST_PRINCIPAL_PAYMENT_SCHEDULE"
  ],
  "repaymentScheduleMethod": "FIXED",
  "roundingRepaymentScheduleMethod": "ROUND_PRINCIPAL_AND_INTEREST_REMAINDER_INTO_LAST_REPAYMENT",
  "scheduleDueDatesMethod": "INTERVAL",
  "scheduleInterestDaysCountMethod": "USING_REPAYMENT_PERIODICITY",
  "settlementOptions": "NO_AUTOMATED_TRANSFERS",
  "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
  "taxCalculationMethod": "EXCLUSIVE",
  "taxSourceKey": "string",
  "taxesOnFeesEnabled": true,
  "taxesOnInterestEnabled": true,
  "taxesOnPenaltyEnabled": true,
  "templates": [
    {
      "creationDate": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "lastModifiedDate": "string",
      "name": "string",
      "type": "ACCOUNT"
    }
  ]
}

Properties

Name	Type	Description	Restrictions
accountInitialState	string	none	none
accountLinkingEnabled	boolean	none	none
accountingMethod	string	none	none
accrueLateInterest	boolean	none	none
activated	boolean	none	none
allowArbitraryFees	boolean	none	none
allowCustomRepaymentAllocation	boolean	none	none
amortizationMethod	string	none	none
applyInterestOnPrepaymentMethod	string	none	none
arrearsSettings	ProductArrearsSettingsApiV1	none	none
autoCreateLinkedAccounts	boolean	none	none
autoLinkAccounts	boolean	none	none
availableProductBranches	[LoanProductBranchApiV1]	none	none
cappingApplyAccruedChargesBeforeLocking	boolean	none	none
cappingConstraintType	string	none	none
cappingMethod	string	none	none
cappingPercentage	number	none	none
creationDate	string	the date and time when this loan product was created	none
daysInYear	string	none	none
defaultFirstRepaymentDueDateOffset	number	none	none
defaultGracePeriod	number	none	none
defaultLoanAmount	number	none	none
defaultNumInstallments	number	none	none
defaultPenaltyRate	number	none	none
defaultPrincipalRepaymentInterval	number	none	none
defaultRepaymentPeriodCount	number	none	none
dormancyPeriodDays	number	none	none
elementsRecalculationMethod	string	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
fixedDaysOfMonth	[number]	none	none
forAllBranches	boolean	none	none
forHybridGroups	boolean	none	none
forIndividuals	boolean	none	none
forPureGroups	boolean	none	none
futurePaymentsAcceptance	string	none	none
gracePeriodType	string	none	none
id	string	none	none
idGeneratorType	string	none	none
idPattern	string	none	none
interestAccrualCalculation	string	none	none
interestAccruedAccountingMethod	string	none	none
interestApplicationMethod	string	none	none
interestBalanceCalculationMethod	string	none	none
interestCalculationMethod	string	none	none
interestRateSettings	InterestProductSettingsApiV1	none	none
interestType	string	none	none
lastModifiedDate	string	the date on which this loan product was last modified	none
latePaymentsRecalculationMethod	string	none	none
lineOfCreditRequirement	string	none	none
linkableSavingsProductKey	string	none	none
loanFees	[PredefinedFeeApiV1]	none	none
loanPenaltyCalculationMethod	string	none	none
loanPenaltyGracePeriod	number	none	none
loanProductRules	[GLAccountingRuleApiV1]	none	none
loanProductType	string	none	none
lockPeriodDays	number	none	none
maxFirstRepaymentDueDateOffset	number	none	none
maxGracePeriod	number	none	none
maxLoanAmount	number	none	none
maxNumInstallments	number	none	none
maxNumberOfDisbursementTranches	number	none	none
maxPenaltyRate	number	none	none
minFirstRepaymentDueDateOffset	number	none	none
minGracePeriod	number	none	none
minLoanAmount	number	none	none
minNumInstallments	number	none	none
minPenaltyRate	number	none	none
offsetPercentage	number	none	none
offsetSettings	ProductOffsetSettingsApiV1	none	none
paymentMethod	string	none	none
prepaymentAcceptance	string	none	none
prepaymentRecalculationMethod	string	none	none
principalPaidInstallmentStatus	string	none	none
principalPaymentSettings	PrincipalPaymentProductSettingsApiV1	none	none
productDescription	string	none	none
productName	string	none	none
productSecuritySettings	ProductSecuritySettingsApiV1	none	none
redrawSettings	ProductRedrawSettingsApiV1	none	none
repaymentAllocationOrder	[string]	none	none
repaymentCurrencyRounding	string	none	none
repaymentElementsRoundingMethod	string	none	none
repaymentPeriodUnit	string	none	none
repaymentReschedulingMethod	string	none	none
repaymentScheduleEditOptions	[string]	none	none
repaymentScheduleMethod	string	none	none
roundingRepaymentScheduleMethod	string	none	none
scheduleDueDatesMethod	string	none	none
scheduleInterestDaysCountMethod	string	none	none
settlementOptions	string	none	none
shortMonthHandlingMethod	string	none	none
taxCalculationMethod	string	none	none
taxSourceKey	string	none	none
taxesOnFeesEnabled	boolean	none	none
taxesOnInterestEnabled	boolean	none	none
taxesOnPenaltyEnabled	boolean	none	none
templates	[DocumentTemplateApiV1]	none	none

Enumerated Values

Property	Value
accountInitialState	`WITHDRAWN`
accountInitialState	`PARTIALLY_DISBURSED`
accountInitialState	`LOCKED`
accountInitialState	`ACTIVE`
accountInitialState	`CLOSED`
accountInitialState	`PARTIAL_APPLICATION`
accountInitialState	`LOCKED_CAPPING`
accountInitialState	`CLOSED_REJECTED`
accountInitialState	`RESCHEDULED`
accountInitialState	`ACTIVE_IN_ARREARS`
accountInitialState	`MATURED`
accountInitialState	`CLOSED_RESCHEDULED`
accountInitialState	`CLOSED_WITHDRAWN`
accountInitialState	`PENDING_APPROVAL`
accountInitialState	`APPROVED`
accountInitialState	`REFINANCED`
accountInitialState	`DORMANT`
accountInitialState	`CLOSED_WRITTEN_OFF`
accountingMethod	`NONE`
accountingMethod	`CASH`
accountingMethod	`ACCRUAL`
amortizationMethod	`PAYMENT_PLAN`
amortizationMethod	`BALLOON_PAYMENTS`
amortizationMethod	`STANDARD_PAYMENTS`
amortizationMethod	`OPTIMIZED_PAYMENTS`
applyInterestOnPrepaymentMethod	`AUTOMATIC`
applyInterestOnPrepaymentMethod	`MANUAL`
cappingConstraintType	`SOFT_CAP`
cappingConstraintType	`HARD_CAP`
cappingMethod	`OUTSTANDING_PRINCIPAL_PERCENTAGE`
cappingMethod	`ORIGINAL_PRINCIPAL_PERCENTAGE`
daysInYear	`E30_42_365`
daysInYear	`ACTUAL_365_FIXED`
daysInYear	`ACTUAL_360`
daysInYear	`E30_360`
daysInYear	`ACTUAL_364`
daysInYear	`ACTUAL_ACTUAL_ISDA`
elementsRecalculationMethod	`FIXED_PRINCIPAL_EXPECTED`
elementsRecalculationMethod	`FIXED_TOTAL_EXPECTED`
futurePaymentsAcceptance	`ACCEPT_OVERPAYMENTS`
futurePaymentsAcceptance	`NO_FUTURE_PAYMENTS`
futurePaymentsAcceptance	`ACCEPT_FUTURE_PAYMENTS`
gracePeriodType	`PAY_INTEREST_ONLY`
gracePeriodType	`NONE`
gracePeriodType	`INTEREST_FORGIVENESS`
idGeneratorType	`INCREMENTAL_NUMBER`
idGeneratorType	`RANDOM_PATTERN`
interestAccrualCalculation	`BREAKDOWN_PER_ACCOUNT`
interestAccrualCalculation	`AGGREGATED_AMOUNT`
interestAccrualCalculation	`NONE`
interestAccruedAccountingMethod	`DAILY`
interestAccruedAccountingMethod	`END_OF_MONTH`
interestAccruedAccountingMethod	`NONE`
interestApplicationMethod	`ON_REPAYMENT`
interestApplicationMethod	`ON_DISBURSEMENT`
interestBalanceCalculationMethod	`PRINCIPAL_ONLY`
interestBalanceCalculationMethod	`PRINCIPAL_AND_INTEREST`
interestCalculationMethod	`DECLINING_BALANCE`
interestCalculationMethod	`DECLINING_BALANCE_DISCOUNTED`
interestCalculationMethod	`FLAT`
interestType	`CAPITALIZED_INTEREST`
interestType	`SIMPLE_INTEREST`
latePaymentsRecalculationMethod	`INCREASE_OVERDUE_INSTALLMENTS`
latePaymentsRecalculationMethod	`INCREASE_LAST_INSTALLMENT`
lineOfCreditRequirement	`OPTIONAL`
lineOfCreditRequirement	`NOT_REQUIRED`
lineOfCreditRequirement	`REQUIRED`
loanPenaltyCalculationMethod	`OVERDUE_BALANCE_AND_INTEREST`
loanPenaltyCalculationMethod	`OUTSTANDING_PRINCIPAL`
loanPenaltyCalculationMethod	`OVERDUE_BALANCE`
loanPenaltyCalculationMethod	`NONE`
loanProductType	`INTEREST_FREE_LOAN`
loanProductType	`DYNAMIC_TERM_LOAN`
loanProductType	`FIXED_TERM_LOAN`
loanProductType	`REVOLVING_CREDIT`
loanProductType	`TRANCHED_LOAN`
paymentMethod	`VERTICAL`
paymentMethod	`HORIZONTAL`
prepaymentAcceptance	`ACCEPT_PREPAYMENTS`
prepaymentAcceptance	`NO_PREPAYMENTS`
prepaymentRecalculationMethod	`NO_RECALCULATION`
prepaymentRecalculationMethod	`RECALCULATE_SCHEDULE_KEEP_SAME_NUMBER_OF_TERMS`
prepaymentRecalculationMethod	`REDUCE_AMOUNT_PER_INSTALLMENT`
prepaymentRecalculationMethod	`REDUCE_NUMBER_OF_INSTALLMENTS_NEW`
prepaymentRecalculationMethod	`REDUCE_NUMBER_OF_INSTALLMENTS`
prepaymentRecalculationMethod	`RESCHEDULE_REMAINING_REPAYMENTS`
prepaymentRecalculationMethod	`RECALCULATE_SCHEDULE_KEEP_SAME_TOTAL_REPAYMENT_AMOUNT`
prepaymentRecalculationMethod	`RECALCULATE_SCHEDULE_KEEP_SAME_PRINCIPAL_AMOUNT`
principalPaidInstallmentStatus	`PARTIALLY_PAID`
principalPaidInstallmentStatus	`ORIGINAL_TOTAL_EXPECTED_PAID`
principalPaidInstallmentStatus	`PAID`
repaymentCurrencyRounding	`ROUND_UP_TO_NEAREST_WHOLE_UNIT`
repaymentCurrencyRounding	`NO_ROUNDING`
repaymentCurrencyRounding	`ROUND_TO_NEAREST_WHOLE_UNIT`
repaymentElementsRoundingMethod	`NO_ROUNDING`
repaymentElementsRoundingMethod	`PAYMENT_DUE`
repaymentElementsRoundingMethod	`ROUND_ALL`
repaymentPeriodUnit	`MONTHS`
repaymentPeriodUnit	`YEARS`
repaymentPeriodUnit	`WEEKS`
repaymentPeriodUnit	`DAYS`
repaymentReschedulingMethod	`PREVIOUS_WORKING_DAY`
repaymentReschedulingMethod	`NEXT_WORKING_DAY`
repaymentReschedulingMethod	`NONE`
repaymentReschedulingMethod	`EXTEND_SCHEDULE`
repaymentScheduleMethod	`FIXED`
repaymentScheduleMethod	`NONE`
repaymentScheduleMethod	`DYNAMIC`
roundingRepaymentScheduleMethod	`ROUND_PRINCIPAL_AND_INTEREST_REMAINDER_INTO_LAST_REPAYMENT`
roundingRepaymentScheduleMethod	`NO_ROUNDING`
roundingRepaymentScheduleMethod	`ROUND_REMAINDER_INTO_LAST_REPAYMENT`
scheduleDueDatesMethod	`INTERVAL`
scheduleDueDatesMethod	`FIXED_DAYS_OF_MONTH`
scheduleInterestDaysCountMethod	`USING_REPAYMENT_PERIODICITY`
scheduleInterestDaysCountMethod	`USING_ACTUAL_DAYS_COUNT`
settlementOptions	`NO_AUTOMATED_TRANSFERS`
settlementOptions	`PARTIAL_DUE_AMOUNTS`
settlementOptions	`FULL_DUE_AMOUNTS`
shortMonthHandlingMethod	`LAST_DAY_IN_MONTH`
shortMonthHandlingMethod	`FIRST_DAY_OF_NEXT_MONTH`
taxCalculationMethod	`EXCLUSIVE`
taxCalculationMethod	`INCLUSIVE`

LoanProductBranchApiV1

{
  "branchKey": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "product": {
    "accountInitialState": "WITHDRAWN",
    "accountLinkingEnabled": true,
    "accountingMethod": "NONE",
    "accrueLateInterest": true,
    "activated": true,
    "allowArbitraryFees": true,
    "allowCustomRepaymentAllocation": true,
    "amortizationMethod": "PAYMENT_PLAN",
    "applyInterestOnPrepaymentMethod": "AUTOMATIC",
    "arrearsSettings": {
      "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
      "defaultTolerancePeriod": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "maxTolerancePeriod": 0,
      "minTolerancePeriod": 0,
      "monthlyToleranceDay": 0,
      "nonWorkingDaysMethod": "EXCLUDED",
      "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY"
    },
    "autoCreateLinkedAccounts": true,
    "autoLinkAccounts": true,
    "availableProductBranches": [
      {
        "branchKey": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "product": {}
      }
    ],
    "cappingApplyAccruedChargesBeforeLocking": true,
    "cappingConstraintType": "SOFT_CAP",
    "cappingMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE",
    "cappingPercentage": 0,
    "creationDate": "string",
    "daysInYear": "E30_42_365",
    "defaultFirstRepaymentDueDateOffset": 0,
    "defaultGracePeriod": 0,
    "defaultLoanAmount": 0,
    "defaultNumInstallments": 0,
    "defaultPenaltyRate": 0,
    "defaultPrincipalRepaymentInterval": 0,
    "defaultRepaymentPeriodCount": 0,
    "dormancyPeriodDays": 0,
    "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "fixedDaysOfMonth": [
      0
    ],
    "forAllBranches": true,
    "forHybridGroups": true,
    "forIndividuals": true,
    "forPureGroups": true,
    "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
    "gracePeriodType": "PAY_INTEREST_ONLY",
    "id": "string",
    "idGeneratorType": "INCREMENTAL_NUMBER",
    "idPattern": "string",
    "interestAccrualCalculation": "BREAKDOWN_PER_ACCOUNT",
    "interestAccruedAccountingMethod": "DAILY",
    "interestApplicationMethod": "ON_REPAYMENT",
    "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
    "interestCalculationMethod": "DECLINING_BALANCE",
    "interestRateSettings": {
      "accrueInterestAfterMaturity": true,
      "defaultInterestRate": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexSourceKey": "string",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestChargeFrequencyCount": 0,
      "interestRateCeilingValue": 0,
      "interestRateFloorValue": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "TIERED_PERIOD",
      "interestRateTiers": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingBalance": 0,
          "endingDay": 0,
          "index": 0,
          "interestRate": 0
        }
      ],
      "maxInterestRate": 0,
      "minInterestRate": 0
    },
    "interestType": "CAPITALIZED_INTEREST",
    "lastModifiedDate": "string",
    "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
    "lineOfCreditRequirement": "OPTIONAL",
    "linkableSavingsProductKey": "string",
    "loanFees": [
      {
        "active": true,
        "amortizationIntervalSettings": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
          "intervalCount": 0,
          "intervalType": "FULL_TERM",
          "periodCount": 0,
          "periodUnit": "MONTHS"
        },
        "amortizationProfile": "STRAIGHT_LINE",
        "amount": 0,
        "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
        "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
        "creationDate": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
        "feeApplication": "OPTIONAL",
        "feeProductRules": [
          {
            "account": {
              "activated": true,
              "allowManualJournalEntries": true,
              "balance": 0,
              "creationDate": "2019-08-24T14:15:22Z",
              "currency": {
                "code": "string",
                "creationDate": "string",
                "currencySymbolPosition": "AFTER_NUMBER",
                "digitsAfterDecimal": 0,
                "isBaseCurrency": true,
                "lastModifiedDate": "string",
                "name": "string",
                "symbol": "string"
              },
              "description": "string",
              "encodedKey": "string",
              "glCode": "string",
              "lastModifiedDate": "2019-08-24T14:15:22Z",
              "migrationEvent": {
                "creationDate": "2019-08-24T14:15:22Z",
                "encodedKey": "string",
                "numCentresImported": 0,
                "numClientsImported": 0,
                "numGLAccountsImported": 0,
                "numGroupsImported": 0,
                "numLoanRepaymentsImported": 0,
                "numLoanTransactionsImported": 0,
                "numLoansImported": 0,
                "numSavingsImported": 0,
                "state": "REVERTED",
                "type": "IMPORT"
              },
              "name": "string",
              "stripTrailingZeros": true,
              "type": "INCOME",
              "usage": "HEADER"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "financialResource": "FEE_RECEIVABLE",
            "index": 0,
            "predefinedFeeKey": "string",
            "productKey": "string",
            "productType": "LOAN",
            "transactionChannelKey": "string"
          }
        ],
        "name": "string",
        "percentageAmount": 0,
        "trigger": "DISBURSEMENT"
      }
    ],
    "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
    "loanPenaltyGracePeriod": 0,
    "loanProductRules": [
      {
        "account": {
          "activated": true,
          "allowManualJournalEntries": true,
          "balance": 0,
          "creationDate": "2019-08-24T14:15:22Z",
          "currency": {
            "code": "string",
            "creationDate": "string",
            "currencySymbolPosition": "AFTER_NUMBER",
            "digitsAfterDecimal": 0,
            "isBaseCurrency": true,
            "lastModifiedDate": "string",
            "name": "string",
            "symbol": "string"
          },
          "description": "string",
          "encodedKey": "string",
          "glCode": "string",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "migrationEvent": {
            "creationDate": "2019-08-24T14:15:22Z",
            "encodedKey": "string",
            "numCentresImported": 0,
            "numClientsImported": 0,
            "numGLAccountsImported": 0,
            "numGroupsImported": 0,
            "numLoanRepaymentsImported": 0,
            "numLoanTransactionsImported": 0,
            "numLoansImported": 0,
            "numSavingsImported": 0,
            "state": "REVERTED",
            "type": "IMPORT"
          },
          "name": "string",
          "stripTrailingZeros": true,
          "type": "INCOME",
          "usage": "HEADER"
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "financialResource": "FEE_RECEIVABLE",
        "index": 0,
        "predefinedFeeKey": "string",
        "productKey": "string",
        "productType": "LOAN",
        "transactionChannelKey": "string"
      }
    ],
    "loanProductType": "INTEREST_FREE_LOAN",
    "lockPeriodDays": 0,
    "maxFirstRepaymentDueDateOffset": 0,
    "maxGracePeriod": 0,
    "maxLoanAmount": 0,
    "maxNumInstallments": 0,
    "maxNumberOfDisbursementTranches": 0,
    "maxPenaltyRate": 0,
    "minFirstRepaymentDueDateOffset": 0,
    "minGracePeriod": 0,
    "minLoanAmount": 0,
    "minNumInstallments": 0,
    "minPenaltyRate": 0,
    "offsetPercentage": 0,
    "offsetSettings": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "isOffsetEnabled": true,
      "loanProduct": {}
    },
    "paymentMethod": "VERTICAL",
    "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
    "prepaymentRecalculationMethod": "NO_RECALCULATION",
    "principalPaidInstallmentStatus": "PARTIALLY_PAID",
    "principalPaymentSettings": {
      "defaultAmount": 0,
      "defaultPercentage": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "includeFeesInFloorAmount": true,
      "includeInterestInFloorAmount": true,
      "maxAmount": 0,
      "maxPercentage": 0,
      "minAmount": 0,
      "minPercentage": 0,
      "principalCeilingValue": 0,
      "principalFloorValue": 0,
      "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
    },
    "productDescription": "string",
    "productName": "string",
    "productSecuritySettings": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "funderInterestCommission": {
        "defaultValue": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "maxValue": 0,
        "minValue": 0
      },
      "funderInterestCommissionAllocationType": "PERCENTAGE_OF_LOAN_FUNDING",
      "isCollateralEnabled": true,
      "isGuarantorsEnabled": true,
      "isInvestorFundsEnabled": true,
      "lockFundsAtApproval": true,
      "organizationInterestCommission": {
        "defaultValue": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "maxValue": 0,
        "minValue": 0
      },
      "requiredGuaranties": 0,
      "requiredInvestorFunds": 0
    },
    "redrawSettings": {
      "allowRedraw": true,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472"
    },
    "repaymentAllocationOrder": [
      "PENALTY"
    ],
    "repaymentCurrencyRounding": "ROUND_UP_TO_NEAREST_WHOLE_UNIT",
    "repaymentElementsRoundingMethod": "NO_ROUNDING",
    "repaymentPeriodUnit": "MONTHS",
    "repaymentReschedulingMethod": "PREVIOUS_WORKING_DAY",
    "repaymentScheduleEditOptions": [
      "ADJUST_PRINCIPAL_PAYMENT_SCHEDULE"
    ],
    "repaymentScheduleMethod": "FIXED",
    "roundingRepaymentScheduleMethod": "ROUND_PRINCIPAL_AND_INTEREST_REMAINDER_INTO_LAST_REPAYMENT",
    "scheduleDueDatesMethod": "INTERVAL",
    "scheduleInterestDaysCountMethod": "USING_REPAYMENT_PERIODICITY",
    "settlementOptions": "NO_AUTOMATED_TRANSFERS",
    "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
    "taxCalculationMethod": "EXCLUSIVE",
    "taxSourceKey": "string",
    "taxesOnFeesEnabled": true,
    "taxesOnInterestEnabled": true,
    "taxesOnPenaltyEnabled": true,
    "templates": [
      {
        "creationDate": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "lastModifiedDate": "string",
        "name": "string",
        "type": "ACCOUNT"
      }
    ]
  }
}

Properties

Name	Type	Description	Restrictions
branchKey	string	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
product	LoanProductApiV1	none	none

LoanRepaymentApiV1

{
  "dueDate": "2019-08-24T14:15:22Z",
  "feesDue": "string",
  "feesPaid": "string",
  "fundersInterestDue": "string",
  "interestDue": "string",
  "interestPaid": "string",
  "organizationCommissionDue": "string",
  "penaltyDue": "string",
  "penaltyPaid": "string",
  "principalDue": "string",
  "principalPaid": "string",
  "repaymentUnappliedFeeDetails": [
    {}
  ],
  "state": "PENDING",
  "taxFeesDue": "string",
  "taxFeesPaid": "string",
  "taxInterestDue": "string",
  "taxInterestPaid": "string",
  "taxPenaltyDue": "string",
  "taxPenaltyPaid": "string"
}

LoanRepaymentApiV1

Properties

Name	Type	Description	Restrictions
dueDate	string(date-time)	none	none
feesDue	string	none	none
feesPaid	string	none	none
fundersInterestDue	string	none	none
interestDue	string	none	none
interestPaid	string	none	none
organizationCommissionDue	string	none	none
penaltyDue	string	none	none
penaltyPaid	string	none	none
principalDue	string	none	none
principalPaid	string	none	none
repaymentUnappliedFeeDetails	[object]	none	none
state	string	none	none
taxFeesDue	string	none	none
taxFeesPaid	string	none	none
taxInterestDue	string	none	none
taxInterestPaid	string	none	none
taxPenaltyDue	string	none	none
taxPenaltyPaid	string	none	none

Enumerated Values

Property	Value
state	`PENDING`
state	`PARTIALLY_PAID`
state	`LATE`
state	`PAID`
state	`GRACE`

LoanTrancheApiV1

{
  "amount": 0,
  "disbursementTransactionKey": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "expectedDisbursementDate": "string",
  "index": 0
}

Properties

Name	Type	Description	Restrictions
amount	number	none	none
disbursementTransactionKey	string	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
expectedDisbursementDate	string	none	none
index	number	none	none

LoanTransactionApiV1

{
  "advancePosition": 0,
  "amount": 0,
  "arrearsPosition": 0,
  "balance": 0,
  "bookingDate": "string",
  "branchKey": "string",
  "centreKey": "string",
  "comment": "string",
  "creationDate": "string",
  "customInformation": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "customPaymentAmounts": [
    {
      "amount": 0,
      "customPaymentAmountType": "PAYMENT_DUE_FEE",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "index": 0,
      "loanTransactionKey": "string",
      "taxOnAmount": 0
    }
  ],
  "deferredInterestAmount": 0,
  "deferredTaxOnInterestAmount": 0,
  "details": {
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "internalTransfer": true,
    "targetSavingsAccountKey": "string",
    "transactionChannel": {
      "activated": true,
      "createdByUserKey": "string",
      "creationDate": "string",
      "customFields": [
        {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        }
      ],
      "encodedKey": "string",
      "id": "string",
      "index": 0,
      "loanConstraints": {
        "customConfigurationInfo": {
          "creationDate": "string",
          "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "shared": true,
          "userKey": "string"
        },
        "encodedKey": "string",
        "filterConstraints": [
          {
            "customFieldKey": "string",
            "dataFieldType": "NATIVE",
            "dataFieldValue": "string",
            "dataItemType": "WRITTEN_OFF_LOANS",
            "dataType": "ENUM",
            "encodedKey": "string",
            "filterElement": "STARTS_WITH_CASE_SENSITIVE",
            "groupNumber": 0,
            "index": 0,
            "linkingOperator": "OR",
            "secondValue": "string",
            "value": "string"
          }
        ]
      },
      "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
      "name": "string",
      "savingsConstraints": {
        "customConfigurationInfo": {
          "creationDate": "string",
          "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "shared": true,
          "userKey": "string"
        },
        "encodedKey": "string",
        "filterConstraints": [
          {
            "customFieldKey": "string",
            "dataFieldType": "NATIVE",
            "dataFieldValue": "string",
            "dataItemType": "WRITTEN_OFF_LOANS",
            "dataType": "ENUM",
            "encodedKey": "string",
            "filterElement": "STARTS_WITH_CASE_SENSITIVE",
            "groupNumber": 0,
            "index": 0,
            "linkingOperator": "OR",
            "secondValue": "string",
            "value": "string"
          }
        ]
      },
      "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
      "transactionChannelAccountingRule": {
        "account": {
          "activated": true,
          "allowManualJournalEntries": true,
          "balance": 0,
          "creationDate": "2019-08-24T14:15:22Z",
          "currency": {
            "code": "string",
            "creationDate": "string",
            "currencySymbolPosition": "AFTER_NUMBER",
            "digitsAfterDecimal": 0,
            "isBaseCurrency": true,
            "lastModifiedDate": "string",
            "name": "string",
            "symbol": "string"
          },
          "description": "string",
          "encodedKey": "string",
          "glCode": "string",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "migrationEvent": {
            "creationDate": "2019-08-24T14:15:22Z",
            "encodedKey": "string",
            "numCentresImported": 0,
            "numClientsImported": 0,
            "numGLAccountsImported": 0,
            "numGroupsImported": 0,
            "numLoanRepaymentsImported": 0,
            "numLoanTransactionsImported": 0,
            "numLoansImported": 0,
            "numSavingsImported": 0,
            "state": "REVERTED",
            "type": "IMPORT"
          },
          "name": "string",
          "stripTrailingZeros": true,
          "type": "INCOME",
          "usage": "HEADER"
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "financialResource": "FEE_RECEIVABLE",
        "index": 0,
        "predefinedFeeKey": "string",
        "productKey": "string",
        "productType": "LOAN",
        "transactionChannelKey": "string"
      },
      "usageRights": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "isAccessibleByAllUsers": true,
        "roles": [
          "string"
        ]
      }
    },
    "transactionChannelKey": "string"
  },
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "entryDate": "string",
  "expectedPrincipalRedraw": 0,
  "feesPaid": 0,
  "fundersInterestAmount": 0,
  "indexInterestRate": {
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "notes": "string",
    "rate": 0,
    "rateSource": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "name": "string",
      "notes": "string",
      "type": "TAX_RATE"
    },
    "startDate": "string",
    "userKey": "string"
  },
  "interestFromArrearsAmount": 0,
  "interestPaid": 0,
  "interestRate": 0,
  "loanPredefinedFeeAmounts": [
    {
      "amortizedAmounts": [
        {
          "amount": 0,
          "branchKey": "string",
          "centreKey": "string",
          "creationDate": "string",
          "encodedKey": "string",
          "entryDate": "string",
          "reversalAmountKey": "string",
          "taxAmount": 0,
          "type": "AMORTIZATION_ADJUSTMENT"
        }
      ],
      "amount": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "fee": {
        "active": true,
        "amortizationIntervalSettings": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
          "intervalCount": 0,
          "intervalType": "FULL_TERM",
          "periodCount": 0,
          "periodUnit": "MONTHS"
        },
        "amortizationProfile": "STRAIGHT_LINE",
        "amount": 0,
        "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
        "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
        "creationDate": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
        "feeApplication": "OPTIONAL",
        "feeProductRules": [
          {
            "account": {
              "activated": true,
              "allowManualJournalEntries": true,
              "balance": 0,
              "creationDate": "2019-08-24T14:15:22Z",
              "currency": {
                "code": "string",
                "creationDate": "string",
                "currencySymbolPosition": "AFTER_NUMBER",
                "digitsAfterDecimal": 0,
                "isBaseCurrency": true,
                "lastModifiedDate": "string",
                "name": "string",
                "symbol": "string"
              },
              "description": "string",
              "encodedKey": "string",
              "glCode": "string",
              "lastModifiedDate": "2019-08-24T14:15:22Z",
              "migrationEvent": {
                "creationDate": "2019-08-24T14:15:22Z",
                "encodedKey": "string",
                "numCentresImported": 0,
                "numClientsImported": 0,
                "numGLAccountsImported": 0,
                "numGroupsImported": 0,
                "numLoanRepaymentsImported": 0,
                "numLoanTransactionsImported": 0,
                "numLoansImported": 0,
                "numSavingsImported": 0,
                "state": "REVERTED",
                "type": "IMPORT"
              },
              "name": "string",
              "stripTrailingZeros": true,
              "type": "INCOME",
              "usage": "HEADER"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "financialResource": "FEE_RECEIVABLE",
            "index": 0,
            "predefinedFeeKey": "string",
            "productKey": "string",
            "productType": "LOAN",
            "transactionChannelKey": "string"
          }
        ],
        "name": "string",
        "percentageAmount": 0,
        "trigger": "DISBURSEMENT"
      },
      "taxAmount": 0,
      "transactionId": 0
    }
  ],
  "loanTransactionTerms": {
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "principalPaymentAmount": 0,
    "principalPaymentPercentage": 0
  },
  "migrationEvent": {
    "creationDate": "2019-08-24T14:15:22Z",
    "encodedKey": "string",
    "numCentresImported": 0,
    "numClientsImported": 0,
    "numGLAccountsImported": 0,
    "numGroupsImported": 0,
    "numLoanRepaymentsImported": 0,
    "numLoanTransactionsImported": 0,
    "numLoansImported": 0,
    "numSavingsImported": 0,
    "state": "REVERTED",
    "type": "IMPORT"
  },
  "organizationCommissionAmount": 0,
  "originalAmount": 0,
  "originalCurrencyCode": "string",
  "parentAccountKey": "string",
  "parentLoanTransactionKey": "string",
  "penaltyPaid": 0,
  "principalBalance": 0,
  "principalPaid": 0,
  "productTypeKey": "string",
  "redrawBalance": 0,
  "reversalTransactionKey": "string",
  "taxOnFeesAmount": 0,
  "taxOnInterestFromArrearsAmount": 0,
  "taxOnInterestPaid": 0,
  "taxOnPenaltyAmount": 0,
  "taxRate": {
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "notes": "string",
    "rate": 0,
    "rateSource": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "name": "string",
      "notes": "string",
      "type": "TAX_RATE"
    },
    "startDate": "string",
    "userKey": "string"
  },
  "tillKey": "string",
  "transactionId": 0,
  "type": "PENALTY_UNLOCKED",
  "userKey": "string",
  "valueDate": "string"
}

Properties

Name	Type	Description	Restrictions
advancePosition	number	none	none
amount	number	none	none
arrearsPosition	number	none	none
balance	number	none	none
bookingDate	string	none	none
branchKey	string	none	none
centreKey	string	none	none
comment	string	none	none
creationDate	string	the date and time when this loan transaction was created	none
customInformation	[CustomFieldValueApiV1]	none	none
customPaymentAmounts	[CustomPaymentAmountApiV1]	none	none
deferredInterestAmount	number	none	none
deferredTaxOnInterestAmount	number	none	none
details	TransactionDetailsApiV1	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
entryDate	string	none	none
expectedPrincipalRedraw	number	none	none
feesPaid	number	none	none
fundersInterestAmount	number	none	none
indexInterestRate	IndexRateApiV1	none	none
interestFromArrearsAmount	number	none	none
interestPaid	number	none	none
interestRate	number	none	none
loanPredefinedFeeAmounts	[PredefinedFeeAmountApiV1]	none	none
loanTransactionTerms	LoanTransactionTermsApiV1	none	none
migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
organizationCommissionAmount	number	none	none
originalAmount	number	none	none
originalCurrencyCode	string	none	none
parentAccountKey	string	none	none
parentLoanTransactionKey	string	none	none
penaltyPaid	number	none	none
principalBalance	number	none	none
principalPaid	number	none	none
productTypeKey	string	none	none
redrawBalance	number	none	none
reversalTransactionKey	string	none	none
taxOnFeesAmount	number	none	none
taxOnInterestFromArrearsAmount	number	none	none
taxOnInterestPaid	number	none	none
taxOnPenaltyAmount	number	none	none
taxRate	IndexRateApiV1	none	none
tillKey	string	none	none
transactionId	number	none	none
type	string	none	none
userKey	string	none	none
valueDate	string	none	none

Enumerated Values

Property	Value
type	`PENALTY_UNLOCKED`
type	`INTEREST_UNLOCKED`
type	`INTEREST_LOCKED`
type	`DISBURSMENT`
type	`INTEREST_APPLIED`
type	`DISBURSMENT_ADJUSTMENT`
type	`FEE`
type	`INTEREST_APPLIED_ADJUSTMENT`
type	`FEE_ADJUSTMENT`
type	`REPAYMENT_ADJUSTMENT`
type	`PENALTY_LOCKED`
type	`REPAYMENT`
type	`WRITE_OFF`
type	`FEE_CHARGED`
type	`PENALTY_APPLIED`
type	`PENALTY_ADJUSTMENT`
type	`INTEREST_RATE_CHANGED`

LoanTransactionTermsApiV1

{
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "principalPaymentAmount": 0,
  "principalPaymentPercentage": 0
}

Properties

Name	Type	Description	Restrictions
encodedKey	string	the automatically generated encoded ID for this item	none
principalPaymentAmount	number	none	none
principalPaymentPercentage	number	none	none

MessageTemplateApiV1

{
  "activated": true,
  "authorization": "NO_AUTHORIZATION",
  "contentType": "PLAIN_TEXT",
  "creationDate": "string",
  "customFilter": {
    "customConfigurationInfo": {
      "creationDate": "string",
      "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "lastModifiedDate": "string",
      "name": "string",
      "shared": true,
      "userKey": "string"
    },
    "encodedKey": "string",
    "filterConstraints": [
      {
        "customFieldKey": "string",
        "dataFieldType": "NATIVE",
        "dataFieldValue": "string",
        "dataItemType": "WRITTEN_OFF_LOANS",
        "dataType": "ENUM",
        "encodedKey": "string",
        "filterElement": "STARTS_WITH_CASE_SENSITIVE",
        "groupNumber": 0,
        "index": 0,
        "linkingOperator": "OR",
        "secondValue": "string",
        "value": "string"
      }
    ]
  },
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "event": "LOAN_CREATED",
  "isInUse": true,
  "lastModifiedDate": "string",
  "name": "string",
  "option": "OPT_IN",
  "recipient": {
    "customField": {
      "amounts": {
        "property1": 0,
        "property2": 0
      },
      "builtInCustomFieldId": "MOBILE_PHONE",
      "creationDate": "string",
      "customFieldProductSettings": [
        {
          "customFieldEncodedKey": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isDefault": true,
          "isRequired": true,
          "linkType": "CLIENT_ROLE",
          "productKey": "string"
        }
      ],
      "customFieldSelectionOptions": [
        {
          "constraint": {
            "customFieldKey": "string",
            "dataFieldType": "NATIVE",
            "dataFieldValue": "string",
            "dataItemType": "WRITTEN_OFF_LOANS",
            "dataType": "ENUM",
            "encodedKey": "string",
            "filterElement": "STARTS_WITH_CASE_SENSITIVE",
            "groupNumber": 0,
            "index": 0,
            "linkingOperator": "OR",
            "secondValue": "string",
            "value": "string"
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "score": 0,
          "value": "string"
        }
      ],
      "customFieldSet": {
        "builtInType": "DETAILS",
        "createdDate": "string",
        "customFields": [
          {}
        ],
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "lastModifiedDate": "string",
        "name": "string",
        "notes": "string",
        "type": "USER_INFO",
        "usage": "SINGLE"
      },
      "dataType": "GROUP_LINK",
      "description": "string",
      "editRights": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "isAccessibleByAllUsers": true,
        "roles": [
          "string"
        ]
      },
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "id": "string",
      "indexInList": 0,
      "isDefault": true,
      "isRequired": true,
      "lastModifiedDate": "string",
      "name": "string",
      "state": "DEACTIVATED",
      "type": "USER_INFO",
      "unique": true,
      "validationPattern": "string",
      "valueLength": "SHORT",
      "values": [
        "string"
      ],
      "viewRights": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "isAccessibleByAllUsers": true,
        "roles": [
          "string"
        ]
      }
    },
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "groupRole": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "name": "string"
    },
    "recipientType": "CREDIT_OFFICER"
  },
  "requestType": "HEAD",
  "subject": "string",
  "targetType": "LOANS",
  "template": "string",
  "topic": "string",
  "trigger": "AUTOMATIC",
  "triggerDays": 0,
  "type": "EVENT_STREAM",
  "url": "string",
  "username": "string"
}

Properties

Name	Type	Description	Restrictions
activated	boolean	none	none
authorization	string	none	none
contentType	string	none	none
creationDate	string	the date and time when this template was created	none
customFilter	CustomFilterApiV1	none	none
encodedKey	string	the automatically generated encoded ID for this notification template	none
event	string	none	none
isInUse	boolean	none	none
lastModifiedDate	string	the date on which this notification template was last modified	none
name	string	none	none
option	string	none	none
recipient	MessageTemplateRecipientApiV1	none	none
requestType	string	none	none
subject	string	none	none
targetType	string	none	none
template	string	none	none
topic	string	none	none
trigger	string	none	none
triggerDays	number	none	none
type	string	none	none
url	string	none	none
username	string	none	none

Enumerated Values

Property	Value
authorization	`NO_AUTHORIZATION`
authorization	`BASIC_AUTHORIZATION`
contentType	`PLAIN_TEXT`
contentType	`APPLICATION_JSON`
contentType	`APPLICATION_XML`
event	`LOAN_CREATED`
event	`SAVINGS_ACCOUNT_REJECTION`
event	`SAVINGS_ACCOUNT_ACTIVATED`
event	`DATA_ACCESS_STATE_CHANGED`
event	`REPAYMENT_REMINDER`
event	`LOAN_ANTICIPATED_DISBURSEMENT`
event	`CREDIT_ARRANGEMENT_deleteD`
event	`SAVINGS_APPROVAL`
event	`PORTAL_ACTIVATED`
event	`SAVINGS_DEPOSIT`
event	`PORTAL_PASSWORD_RESET`
event	`CREDIT_ARRANGEMENT_REJECTED`
event	`LOAN_REPAYMENT_REVERSAL`
event	`SAVINGS_ACCOUNT_CLOSURE`
event	`LOAN_ACCOUNT_REJECTION`
event	`LOAN_ACCOUNT_RESCHEDULED`
event	`ACCOUNT_IN_ARREARS`
event	`LOAN_DISBURSEMENT_REVERSAL`
event	`SAVINGS_DEPOSIT_REVERSAL`
event	`CLIENT_APPROVED`
event	`LOAN_REPAYMENT`
event	`LOAN_ACCOUNT_ACTIVITY`
event	`GROUP_CREATED`
event	`LOAN_DISBURSEMENT`
event	`CREDIT_ARRANGEMENT_APPROVED`
event	`MANUAL`
event	`END_OF_DAY_PROCESSING_COMPLETED`
event	`CREDIT_ARRANGEMENT_ACCOUNT_ADDED`
event	`CLIENT_REJECTED`
event	`CLIENT_ACTIVITY`
event	`LOAN_ACCOUNT_REFINANCED`
event	`SAVINGS_CREATED`
event	`CLIENT_CREATED`
event	`LOAN_APPROVAL`
event	`GROUP_ACTIVITY`
event	`LOAN_ACCOUNT_CLOSURE`
event	`SAVINGS_WITHDRAWAL_REVERSAL`
event	`CREDIT_ARRANGEMENT_WITHDRAWN`
event	`CREDIT_ARRANGEMENT_CREATED`
event	`SAVINGS_WITHDRAWAL`
event	`SAVINGS_ACCOUNT_ACTIVITY`
event	`LOAN_ACCOUNT_WRITE_OFF`
event	`CREDIT_ARRANGEMENT_ACCOUNT_REMOVED`
event	`CREDIT_ARRANGEMENT_CLOSED`
option	`OPT_IN`
option	`OPT_OUT`
requestType	`HEAD`
requestType	`delete`
requestType	`post`
requestType	`get`
requestType	`put`
requestType	`patch`
targetType	`LOANS`
targetType	`GROUP`
targetType	`SAVINGS`
targetType	`DATA_ACCESS`
targetType	`BACKGROUND_PROCESS`
targetType	`CLIENT`
trigger	`AUTOMATIC`
trigger	`MANUAL`
type	`EVENT_STREAM`
type	`TASK`
type	`SMS`
type	`EMAIL`
type	`WEB_HOOK`

MessageTemplateRecipientApiV1

{
  "customField": {
    "amounts": {
      "property1": 0,
      "property2": 0
    },
    "builtInCustomFieldId": "MOBILE_PHONE",
    "creationDate": "string",
    "customFieldProductSettings": [
      {
        "customFieldEncodedKey": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "isDefault": true,
        "isRequired": true,
        "linkType": "CLIENT_ROLE",
        "productKey": "string"
      }
    ],
    "customFieldSelectionOptions": [
      {
        "constraint": {
          "customFieldKey": "string",
          "dataFieldType": "NATIVE",
          "dataFieldValue": "string",
          "dataItemType": "WRITTEN_OFF_LOANS",
          "dataType": "ENUM",
          "encodedKey": "string",
          "filterElement": "STARTS_WITH_CASE_SENSITIVE",
          "groupNumber": 0,
          "index": 0,
          "linkingOperator": "OR",
          "secondValue": "string",
          "value": "string"
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "score": 0,
        "value": "string"
      }
    ],
    "customFieldSet": {
      "builtInType": "DETAILS",
      "createdDate": "string",
      "customFields": [
        {}
      ],
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "id": "string",
      "indexInList": 0,
      "lastModifiedDate": "string",
      "name": "string",
      "notes": "string",
      "type": "USER_INFO",
      "usage": "SINGLE"
    },
    "dataType": "GROUP_LINK",
    "description": "string",
    "editRights": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "isAccessibleByAllUsers": true,
      "roles": [
        "string"
      ]
    },
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "id": "string",
    "indexInList": 0,
    "isDefault": true,
    "isRequired": true,
    "lastModifiedDate": "string",
    "name": "string",
    "state": "DEACTIVATED",
    "type": "USER_INFO",
    "unique": true,
    "validationPattern": "string",
    "valueLength": "SHORT",
    "values": [
      "string"
    ],
    "viewRights": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "isAccessibleByAllUsers": true,
      "roles": [
        "string"
      ]
    }
  },
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "groupRole": {
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "name": "string"
  },
  "recipientType": "CREDIT_OFFICER"
}

Properties

Name	Type	Description	Restrictions
customField	CustomFieldApiV1	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
groupRole	GroupRoleNameApiV1	none	none
recipientType	string	none	none

Enumerated Values

Property	Value
recipientType	`CREDIT_OFFICER`
recipientType	`CUSTOM_FIELD`
recipientType	`GROUP_ROLE`
recipientType	`CLIENT`

MoneyApiV1

{
  "amount": 0
}

Properties

Name	Type	Description	Restrictions
amount	number	none	none

NonWorkingDayApiV1

{
  "creationDate": "string",
  "dayOfWeek": "WEDNESDAY",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472"
}

Properties

Name	Type	Description	Restrictions
creationDate	string	the date and time when this non working day was created	none
dayOfWeek	string	none	none
encodedKey	string	the automatically generated encoded ID for this item	none

Enumerated Values

Property	Value
dayOfWeek	`WEDNESDAY`
dayOfWeek	`MONDAY`
dayOfWeek	`THURSDAY`
dayOfWeek	`SUNDAY`
dayOfWeek	`TUESDAY`
dayOfWeek	`FRIDAY`
dayOfWeek	`SATURDAY`

Object

{}

Properties

None

ObjectLabelApiV1

{
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "hasCustomValue": true,
  "language": "PORTUGESE",
  "pluralValue": "string",
  "singularValue": "string",
  "type": "BRANCH"
}

Properties

Name	Type	Description	Restrictions
encodedKey	string	the automatically generated encoded ID for this item	none
hasCustomValue	boolean	none	none
language	string	none	none
pluralValue	string	none	none
singularValue	string	none	none
type	string	none	none

Enumerated Values

Property	Value
language	`PORTUGESE`
language	`RUSSIAN`
language	`ROMANIAN`
language	`ENGLISH`
language	`SPANISH`
language	`GEORGIAN`
language	`BURMESE`
language	`PHRASE`
language	`CHINESE`
language	`GERMAN`
language	`FRENCH`
language	`INDONESIAN`
type	`BRANCH`
type	`GROUP`
type	`CREDIT_OFFICER`
type	`FEE`
type	`CLIENT`
type	`CENTRE`
type	`INTEREST`

OrganizationApiV1

{
  "address": {
    "addressType": "string",
    "city": "string",
    "country": "string",
    "encodedKey": "string",
    "indexInList": 0,
    "latitude": 0,
    "line1": "string",
    "line2": "string",
    "longitude": 0,
    "parentKey": "string",
    "postcode": "string",
    "region": "string",
    "toBeDeleted": true
  },
  "creationDate": "string",
  "emailAddress": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "lastModifiedDate": "string",
  "name": "string",
  "phoneNo": "string",
  "timeZoneID": "string"
}

OrganizationApiV1

Properties

Name	Type	Description	Restrictions
address	AddressApiV1	none	none
creationDate	string	the date and time when this organization was created	none
emailAddress	string	the main contact email address for your organization	none
encodedKey	string	the automatically generated encoded ID for this organization	none
lastModifiedDate	string	the date on which this organization was last modified	none
name	string	the name of your organization	none
phoneNo	string	the main contact number for your organization	none
timeZoneID	string	the timezone of your Mambu system, eg. 'Europe/Amsterdam'	none

PatchRepaymentApiV1

{
  "dueDate": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "feesDue": 0,
  "feesUnappliedDue": 0,
  "interestDue": 0,
  "isPaymentHoliday": true,
  "parentAccountKey": "string",
  "penaltyDue": 0,
  "principalDue": 0
}

Properties

Name	Type	Description	Restrictions
dueDate	string	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
feesDue	number	none	none
feesUnappliedDue	number	none	none
interestDue	number	none	none
isPaymentHoliday	boolean	none	none
parentAccountKey	string	none	none
penaltyDue	number	none	none
principalDue	number	none	none

PeriodIntervalSettingsApiV1

{
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
  "intervalCount": 0,
  "intervalType": "FULL_TERM",
  "periodCount": 0,
  "periodUnit": "MONTHS"
}

Properties

Name	Type	Description	Restrictions
encodedKey	string	the automatically generated encoded ID for this item	none
frequency	string	none	none
intervalCount	number	none	none
intervalType	string	none	none
periodCount	number	none	none
periodUnit	string	none	none

Enumerated Values

Property	Value
frequency	`ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING`
frequency	`ACCOUNT_INSTALLMENTS_DUE_DATES`
frequency	`CUSTOM_INTERVAL`
intervalType	`FULL_TERM`
intervalType	`PREDEFINED_INTERVALS`
periodUnit	`MONTHS`
periodUnit	`YEARS`
periodUnit	`WEEKS`
periodUnit	`DAYS`

PeriodicPaymentApiV1

{
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "endingInstallmentPosition": 0,
  "index": 0,
  "loanAccountEncodedKey": "string",
  "pmt": 0
}

Properties

Name	Type	Description	Restrictions
encodedKey	string	the automatically generated encoded ID for this item	none
endingInstallmentPosition	number	none	none
index	number	none	none
loanAccountEncodedKey	string	none	none
pmt	number	none	none

PermissionsApiV1

{
  "canManageAllBranches": true,
  "canManageEntitiesAssignedToOtherOfficers": true,
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "permissions": [
    "CREATE_INVESTOR_FUNDS"
  ]
}

Properties

Name	Type	Description	Restrictions
canManageAllBranches	boolean	none	none
canManageEntitiesAssignedToOtherOfficers	boolean	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
permissions	[string]	none	none

PortalPreferencesApiV1

{
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "lastLoggedInDate": "string",
  "password": "string",
  "portalState": "DISABLED"
}

Properties

Name	Type	Description	Restrictions
encodedKey	string	the automatically generated encoded ID for this item	none
lastLoggedInDate	string	none	none
password	string	none	none
portalState	string	none	none

Enumerated Values

Property	Value
portalState	`DISABLED`
portalState	`ENABLED`

PredefinedFeeAmountApiV1

{
  "amortizedAmounts": [
    {
      "amount": 0,
      "branchKey": "string",
      "centreKey": "string",
      "creationDate": "string",
      "encodedKey": "string",
      "entryDate": "string",
      "reversalAmountKey": "string",
      "taxAmount": 0,
      "type": "AMORTIZATION_ADJUSTMENT"
    }
  ],
  "amount": 0,
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "fee": {
    "active": true,
    "amortizationIntervalSettings": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
      "intervalCount": 0,
      "intervalType": "FULL_TERM",
      "periodCount": 0,
      "periodUnit": "MONTHS"
    },
    "amortizationProfile": "STRAIGHT_LINE",
    "amount": 0,
    "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
    "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
    "creationDate": "string",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
    "feeApplication": "OPTIONAL",
    "feeProductRules": [
      {
        "account": {
          "activated": true,
          "allowManualJournalEntries": true,
          "balance": 0,
          "creationDate": "2019-08-24T14:15:22Z",
          "currency": {
            "code": "string",
            "creationDate": "string",
            "currencySymbolPosition": "AFTER_NUMBER",
            "digitsAfterDecimal": 0,
            "isBaseCurrency": true,
            "lastModifiedDate": "string",
            "name": "string",
            "symbol": "string"
          },
          "description": "string",
          "encodedKey": "string",
          "glCode": "string",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "migrationEvent": {
            "creationDate": "2019-08-24T14:15:22Z",
            "encodedKey": "string",
            "numCentresImported": 0,
            "numClientsImported": 0,
            "numGLAccountsImported": 0,
            "numGroupsImported": 0,
            "numLoanRepaymentsImported": 0,
            "numLoanTransactionsImported": 0,
            "numLoansImported": 0,
            "numSavingsImported": 0,
            "state": "REVERTED",
            "type": "IMPORT"
          },
          "name": "string",
          "stripTrailingZeros": true,
          "type": "INCOME",
          "usage": "HEADER"
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "financialResource": "FEE_RECEIVABLE",
        "index": 0,
        "predefinedFeeKey": "string",
        "productKey": "string",
        "productType": "LOAN",
        "transactionChannelKey": "string"
      }
    ],
    "name": "string",
    "percentageAmount": 0,
    "trigger": "DISBURSEMENT"
  },
  "taxAmount": 0,
  "transactionId": 0
}

Properties

Name	Type	Description	Restrictions
amortizedAmounts	[AmortizationAmountApiV1]	none	none
amount	number	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
fee	PredefinedFeeApiV1	none	none
taxAmount	number	none	none
transactionId	number	none	none

PredefinedFeeApiV1

{
  "active": true,
  "amortizationIntervalSettings": {
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
    "intervalCount": 0,
    "intervalType": "FULL_TERM",
    "periodCount": 0,
    "periodUnit": "MONTHS"
  },
  "amortizationProfile": "STRAIGHT_LINE",
  "amount": 0,
  "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
  "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
  "creationDate": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
  "feeApplication": "OPTIONAL",
  "feeProductRules": [
    {
      "account": {
        "activated": true,
        "allowManualJournalEntries": true,
        "balance": 0,
        "creationDate": "2019-08-24T14:15:22Z",
        "currency": {
          "code": "string",
          "creationDate": "string",
          "currencySymbolPosition": "AFTER_NUMBER",
          "digitsAfterDecimal": 0,
          "isBaseCurrency": true,
          "lastModifiedDate": "string",
          "name": "string",
          "symbol": "string"
        },
        "description": "string",
        "encodedKey": "string",
        "glCode": "string",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "migrationEvent": {
          "creationDate": "2019-08-24T14:15:22Z",
          "encodedKey": "string",
          "numCentresImported": 0,
          "numClientsImported": 0,
          "numGLAccountsImported": 0,
          "numGroupsImported": 0,
          "numLoanRepaymentsImported": 0,
          "numLoanTransactionsImported": 0,
          "numLoansImported": 0,
          "numSavingsImported": 0,
          "state": "REVERTED",
          "type": "IMPORT"
        },
        "name": "string",
        "stripTrailingZeros": true,
        "type": "INCOME",
        "usage": "HEADER"
      },
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "financialResource": "FEE_RECEIVABLE",
      "index": 0,
      "predefinedFeeKey": "string",
      "productKey": "string",
      "productType": "LOAN",
      "transactionChannelKey": "string"
    }
  ],
  "name": "string",
  "percentageAmount": 0,
  "trigger": "DISBURSEMENT"
}

Properties

Name	Type	Description	Restrictions
active	boolean	none	none
amortizationIntervalSettings	PeriodIntervalSettingsApiV1	none	none
amortizationProfile	string	none	none
amount	number	none	none
amountCalculationMethod	string	none	none
applyDateMethod	string	none	none
creationDate	string	the date and time when this fee was created	none
encodedKey	string	the automatically generated encoded ID for this item	none
feeAmortizationUponRescheduleOption	string	none	none
feeApplication	string	none	none
feeProductRules	[GLAccountingRuleApiV1]	none	none
name	string	none	none
percentageAmount	number	none	none
trigger	string	none	none

Enumerated Values

Property	Value
amortizationProfile	`STRAIGHT_LINE`
amortizationProfile	`SUM_OF_YEARS_DIGITS`
amortizationProfile	`EFFECTIVE_INTEREST_RATE`
amortizationProfile	`NONE`
amountCalculationMethod	`LOAN_AMOUNT_PERCENTAGE`
amountCalculationMethod	`LOAN_AMOUNT_PERCENTAGE_NUMBER_OF_INSTALLMENTS`
amountCalculationMethod	`REPAYMENT_PRINCIPAL_AMOUNT_PERCENTAGE`
amountCalculationMethod	`FLAT_NUMBER_OF_INSTALLMENTS`
amountCalculationMethod	`FLAT`
applyDateMethod	`MONTHLY_FROM_ACTIVATION`
applyDateMethod	`FIRST_OF_EVERY_MONTH`
feeAmortizationUponRescheduleOption	`CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT`
feeAmortizationUponRescheduleOption	`END_AMORTIZATION_ON_THE_ORIGINAL_ACCOUNT`
feeApplication	`OPTIONAL`
feeApplication	`REQUIRED`
trigger	`DISBURSEMENT`
trigger	`ARBITRARY`
trigger	`CAPITALIZED_DISBURSEMENT`
trigger	`MONTHLY_FEE`
trigger	`UPFRONT_DISBURSEMENT`
trigger	`LATE_REPAYMENT`
trigger	`MANUAL`
trigger	`PAYMENT_DUE`
trigger	`PAYMENT_DUE_APPLIED_ON_DUE_DATES`

PrincipalPaymentAccountSettingsApiV1

{
  "amount": 0,
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "includeFeesInFloorAmount": true,
  "includeInterestInFloorAmount": true,
  "percentage": 0,
  "principalCeilingValue": 0,
  "principalFloorValue": 0,
  "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
}

Properties

Name	Type	Description	Restrictions
amount	number	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
includeFeesInFloorAmount	boolean	none	none
includeInterestInFloorAmount	boolean	none	none
percentage	number	none	none
principalCeilingValue	number	none	none
principalFloorValue	number	none	none
principalPaymentMethod	string	none	none

Enumerated Values

Property	Value
principalPaymentMethod	`OUTSTANDING_PRINCIPAL_PERCENTAGE`
principalPaymentMethod	`FLAT`
principalPaymentMethod	`TOTAL_BALANCE_PERCENTAGE`

PrincipalPaymentProductSettingsApiV1

{
  "defaultAmount": 0,
  "defaultPercentage": 0,
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "includeFeesInFloorAmount": true,
  "includeInterestInFloorAmount": true,
  "maxAmount": 0,
  "maxPercentage": 0,
  "minAmount": 0,
  "minPercentage": 0,
  "principalCeilingValue": 0,
  "principalFloorValue": 0,
  "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
}

Properties

Name	Type	Description	Restrictions
defaultAmount	number	none	none
defaultPercentage	number	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
includeFeesInFloorAmount	boolean	none	none
includeInterestInFloorAmount	boolean	none	none
maxAmount	number	none	none
maxPercentage	number	none	none
minAmount	number	none	none
minPercentage	number	none	none
principalCeilingValue	number	none	none
principalFloorValue	number	none	none
principalPaymentMethod	string	none	none

Enumerated Values

Property	Value
principalPaymentMethod	`OUTSTANDING_PRINCIPAL_PERCENTAGE`
principalPaymentMethod	`FLAT`
principalPaymentMethod	`TOTAL_BALANCE_PERCENTAGE`

ProductArrearsSettingsApiV1

{
  "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
  "defaultTolerancePeriod": 0,
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "maxTolerancePeriod": 0,
  "minTolerancePeriod": 0,
  "monthlyToleranceDay": 0,
  "nonWorkingDaysMethod": "EXCLUDED",
  "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY"
}

Properties

Name	Type	Description	Restrictions
dateCalculationMethod	string	none	none
defaultTolerancePeriod	number	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
maxTolerancePeriod	number	none	none
minTolerancePeriod	number	none	none
monthlyToleranceDay	number	none	none
nonWorkingDaysMethod	string	none	none
toleranceCalculationMethod	string	none	none

Enumerated Values

Property	Value
dateCalculationMethod	`DATE_OF_LAST_LATE_REPAYMENT`
dateCalculationMethod	`DATE_ACCOUNT_FIRST_WENT_TO_ARREARS`
nonWorkingDaysMethod	`EXCLUDED`
nonWorkingDaysMethod	`INCLUDED`
toleranceCalculationMethod	`MONTHLY_ARREARS_TOLERANCE_DAY`
toleranceCalculationMethod	`ARREARS_TOLERANCE_PERIOD`

ProductOffsetSettingsApiV1

{
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "isOffsetEnabled": true,
  "loanProduct": {
    "accountInitialState": "WITHDRAWN",
    "accountLinkingEnabled": true,
    "accountingMethod": "NONE",
    "accrueLateInterest": true,
    "activated": true,
    "allowArbitraryFees": true,
    "allowCustomRepaymentAllocation": true,
    "amortizationMethod": "PAYMENT_PLAN",
    "applyInterestOnPrepaymentMethod": "AUTOMATIC",
    "arrearsSettings": {
      "dateCalculationMethod": "DATE_OF_LAST_LATE_REPAYMENT",
      "defaultTolerancePeriod": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "maxTolerancePeriod": 0,
      "minTolerancePeriod": 0,
      "monthlyToleranceDay": 0,
      "nonWorkingDaysMethod": "EXCLUDED",
      "toleranceCalculationMethod": "MONTHLY_ARREARS_TOLERANCE_DAY"
    },
    "autoCreateLinkedAccounts": true,
    "autoLinkAccounts": true,
    "availableProductBranches": [
      {
        "branchKey": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "product": {}
      }
    ],
    "cappingApplyAccruedChargesBeforeLocking": true,
    "cappingConstraintType": "SOFT_CAP",
    "cappingMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE",
    "cappingPercentage": 0,
    "creationDate": "string",
    "daysInYear": "E30_42_365",
    "defaultFirstRepaymentDueDateOffset": 0,
    "defaultGracePeriod": 0,
    "defaultLoanAmount": 0,
    "defaultNumInstallments": 0,
    "defaultPenaltyRate": 0,
    "defaultPrincipalRepaymentInterval": 0,
    "defaultRepaymentPeriodCount": 0,
    "dormancyPeriodDays": 0,
    "elementsRecalculationMethod": "FIXED_PRINCIPAL_EXPECTED",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "fixedDaysOfMonth": [
      0
    ],
    "forAllBranches": true,
    "forHybridGroups": true,
    "forIndividuals": true,
    "forPureGroups": true,
    "futurePaymentsAcceptance": "ACCEPT_OVERPAYMENTS",
    "gracePeriodType": "PAY_INTEREST_ONLY",
    "id": "string",
    "idGeneratorType": "INCREMENTAL_NUMBER",
    "idPattern": "string",
    "interestAccrualCalculation": "BREAKDOWN_PER_ACCOUNT",
    "interestAccruedAccountingMethod": "DAILY",
    "interestApplicationMethod": "ON_REPAYMENT",
    "interestBalanceCalculationMethod": "PRINCIPAL_ONLY",
    "interestCalculationMethod": "DECLINING_BALANCE",
    "interestRateSettings": {
      "accrueInterestAfterMaturity": true,
      "defaultInterestRate": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexSourceKey": "string",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestChargeFrequencyCount": 0,
      "interestRateCeilingValue": 0,
      "interestRateFloorValue": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "TIERED_PERIOD",
      "interestRateTiers": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingBalance": 0,
          "endingDay": 0,
          "index": 0,
          "interestRate": 0
        }
      ],
      "maxInterestRate": 0,
      "minInterestRate": 0
    },
    "interestType": "CAPITALIZED_INTEREST",
    "lastModifiedDate": "string",
    "latePaymentsRecalculationMethod": "INCREASE_OVERDUE_INSTALLMENTS",
    "lineOfCreditRequirement": "OPTIONAL",
    "linkableSavingsProductKey": "string",
    "loanFees": [
      {
        "active": true,
        "amortizationIntervalSettings": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
          "intervalCount": 0,
          "intervalType": "FULL_TERM",
          "periodCount": 0,
          "periodUnit": "MONTHS"
        },
        "amortizationProfile": "STRAIGHT_LINE",
        "amount": 0,
        "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
        "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
        "creationDate": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
        "feeApplication": "OPTIONAL",
        "feeProductRules": [
          {
            "account": {
              "activated": true,
              "allowManualJournalEntries": true,
              "balance": 0,
              "creationDate": "2019-08-24T14:15:22Z",
              "currency": {
                "code": "string",
                "creationDate": "string",
                "currencySymbolPosition": "AFTER_NUMBER",
                "digitsAfterDecimal": 0,
                "isBaseCurrency": true,
                "lastModifiedDate": "string",
                "name": "string",
                "symbol": "string"
              },
              "description": "string",
              "encodedKey": "string",
              "glCode": "string",
              "lastModifiedDate": "2019-08-24T14:15:22Z",
              "migrationEvent": {
                "creationDate": "2019-08-24T14:15:22Z",
                "encodedKey": "string",
                "numCentresImported": 0,
                "numClientsImported": 0,
                "numGLAccountsImported": 0,
                "numGroupsImported": 0,
                "numLoanRepaymentsImported": 0,
                "numLoanTransactionsImported": 0,
                "numLoansImported": 0,
                "numSavingsImported": 0,
                "state": "REVERTED",
                "type": "IMPORT"
              },
              "name": "string",
              "stripTrailingZeros": true,
              "type": "INCOME",
              "usage": "HEADER"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "financialResource": "FEE_RECEIVABLE",
            "index": 0,
            "predefinedFeeKey": "string",
            "productKey": "string",
            "productType": "LOAN",
            "transactionChannelKey": "string"
          }
        ],
        "name": "string",
        "percentageAmount": 0,
        "trigger": "DISBURSEMENT"
      }
    ],
    "loanPenaltyCalculationMethod": "OVERDUE_BALANCE_AND_INTEREST",
    "loanPenaltyGracePeriod": 0,
    "loanProductRules": [
      {
        "account": {
          "activated": true,
          "allowManualJournalEntries": true,
          "balance": 0,
          "creationDate": "2019-08-24T14:15:22Z",
          "currency": {
            "code": "string",
            "creationDate": "string",
            "currencySymbolPosition": "AFTER_NUMBER",
            "digitsAfterDecimal": 0,
            "isBaseCurrency": true,
            "lastModifiedDate": "string",
            "name": "string",
            "symbol": "string"
          },
          "description": "string",
          "encodedKey": "string",
          "glCode": "string",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "migrationEvent": {
            "creationDate": "2019-08-24T14:15:22Z",
            "encodedKey": "string",
            "numCentresImported": 0,
            "numClientsImported": 0,
            "numGLAccountsImported": 0,
            "numGroupsImported": 0,
            "numLoanRepaymentsImported": 0,
            "numLoanTransactionsImported": 0,
            "numLoansImported": 0,
            "numSavingsImported": 0,
            "state": "REVERTED",
            "type": "IMPORT"
          },
          "name": "string",
          "stripTrailingZeros": true,
          "type": "INCOME",
          "usage": "HEADER"
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "financialResource": "FEE_RECEIVABLE",
        "index": 0,
        "predefinedFeeKey": "string",
        "productKey": "string",
        "productType": "LOAN",
        "transactionChannelKey": "string"
      }
    ],
    "loanProductType": "INTEREST_FREE_LOAN",
    "lockPeriodDays": 0,
    "maxFirstRepaymentDueDateOffset": 0,
    "maxGracePeriod": 0,
    "maxLoanAmount": 0,
    "maxNumInstallments": 0,
    "maxNumberOfDisbursementTranches": 0,
    "maxPenaltyRate": 0,
    "minFirstRepaymentDueDateOffset": 0,
    "minGracePeriod": 0,
    "minLoanAmount": 0,
    "minNumInstallments": 0,
    "minPenaltyRate": 0,
    "offsetPercentage": 0,
    "offsetSettings": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "isOffsetEnabled": true,
      "loanProduct": {}
    },
    "paymentMethod": "VERTICAL",
    "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
    "prepaymentRecalculationMethod": "NO_RECALCULATION",
    "principalPaidInstallmentStatus": "PARTIALLY_PAID",
    "principalPaymentSettings": {
      "defaultAmount": 0,
      "defaultPercentage": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "includeFeesInFloorAmount": true,
      "includeInterestInFloorAmount": true,
      "maxAmount": 0,
      "maxPercentage": 0,
      "minAmount": 0,
      "minPercentage": 0,
      "principalCeilingValue": 0,
      "principalFloorValue": 0,
      "principalPaymentMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE"
    },
    "productDescription": "string",
    "productName": "string",
    "productSecuritySettings": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "funderInterestCommission": {
        "defaultValue": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "maxValue": 0,
        "minValue": 0
      },
      "funderInterestCommissionAllocationType": "PERCENTAGE_OF_LOAN_FUNDING",
      "isCollateralEnabled": true,
      "isGuarantorsEnabled": true,
      "isInvestorFundsEnabled": true,
      "lockFundsAtApproval": true,
      "organizationInterestCommission": {
        "defaultValue": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "maxValue": 0,
        "minValue": 0
      },
      "requiredGuaranties": 0,
      "requiredInvestorFunds": 0
    },
    "redrawSettings": {
      "allowRedraw": true,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472"
    },
    "repaymentAllocationOrder": [
      "PENALTY"
    ],
    "repaymentCurrencyRounding": "ROUND_UP_TO_NEAREST_WHOLE_UNIT",
    "repaymentElementsRoundingMethod": "NO_ROUNDING",
    "repaymentPeriodUnit": "MONTHS",
    "repaymentReschedulingMethod": "PREVIOUS_WORKING_DAY",
    "repaymentScheduleEditOptions": [
      "ADJUST_PRINCIPAL_PAYMENT_SCHEDULE"
    ],
    "repaymentScheduleMethod": "FIXED",
    "roundingRepaymentScheduleMethod": "ROUND_PRINCIPAL_AND_INTEREST_REMAINDER_INTO_LAST_REPAYMENT",
    "scheduleDueDatesMethod": "INTERVAL",
    "scheduleInterestDaysCountMethod": "USING_REPAYMENT_PERIODICITY",
    "settlementOptions": "NO_AUTOMATED_TRANSFERS",
    "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH",
    "taxCalculationMethod": "EXCLUSIVE",
    "taxSourceKey": "string",
    "taxesOnFeesEnabled": true,
    "taxesOnInterestEnabled": true,
    "taxesOnPenaltyEnabled": true,
    "templates": [
      {
        "creationDate": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "lastModifiedDate": "string",
        "name": "string",
        "type": "ACCOUNT"
      }
    ]
  }
}

Properties

Name	Type	Description	Restrictions
encodedKey	string	the automatically generated encoded ID for this item	none
isOffsetEnabled	boolean	none	none
loanProduct	LoanProductApiV1	none	none

ProductRedrawSettingsApiV1

{
  "allowRedraw": true,
  "encodedKey": "8a19b7057471f4af017472dc0fd80472"
}

Properties

Name	Type	Description	Restrictions
allowRedraw	boolean	none	none
encodedKey	string	the automatically generated encoded ID for this item	none

ProductSecuritySettingsApiV1

{
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "funderInterestCommission": {
    "defaultValue": 0,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "maxValue": 0,
    "minValue": 0
  },
  "funderInterestCommissionAllocationType": "PERCENTAGE_OF_LOAN_FUNDING",
  "isCollateralEnabled": true,
  "isGuarantorsEnabled": true,
  "isInvestorFundsEnabled": true,
  "lockFundsAtApproval": true,
  "organizationInterestCommission": {
    "defaultValue": 0,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "maxValue": 0,
    "minValue": 0
  },
  "requiredGuaranties": 0,
  "requiredInvestorFunds": 0
}

Properties

Name	Type	Description	Restrictions
encodedKey	string	the automatically generated encoded ID for this item	none
funderInterestCommission	DecimalIntervalConstraintsApiV1	none	none
funderInterestCommissionAllocationType	string	none	none
isCollateralEnabled	boolean	none	none
isGuarantorsEnabled	boolean	none	none
isInvestorFundsEnabled	boolean	none	none
lockFundsAtApproval	boolean	none	none
organizationInterestCommission	DecimalIntervalConstraintsApiV1	none	none
requiredGuaranties	number	none	none
requiredInvestorFunds	number	none	none

Enumerated Values

Property	Value
funderInterestCommissionAllocationType	`PERCENTAGE_OF_LOAN_FUNDING`
funderInterestCommissionAllocationType	`FIXED_INTEREST_COMMISSIONS`

RepaymentApiV1

{
  "assignedBranchKey": "string",
  "assignedCentreKey": "string",
  "assignedUserKey": "string",
  "customSettings": [
    {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "loanTransactionKey": "string",
      "source": "CENTRE_MEETING_DAY_CHANGED",
      "type": "CUSTOM_ADDED_INSTALLMENT"
    }
  ],
  "dueDate": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "feesAppliedDue": 0,
  "feesDue": 0,
  "feesPaid": 0,
  "feesUnappliedDue": 0,
  "fundersInterestDue": 0,
  "index": 0,
  "interestDue": 0,
  "interestPaid": 0,
  "lastPaidDate": "string",
  "lastPenaltyAppliedDate": "string",
  "notes": "string",
  "organizationCommissionDue": 0,
  "parentAccountKey": "string",
  "penaltyDue": 0,
  "penaltyPaid": 0,
  "principalDue": 0,
  "principalPaid": 0,
  "repaidDate": "string",
  "repaymentUnappliedFeeDetails": [
    {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "feeDue": 0,
      "indexInList": 0,
      "predefinedFeeKey": "string",
      "repaymentKey": "string",
      "taxOnFeeDue": 0
    }
  ],
  "state": "PARTIALLY_PAID",
  "taxFeesDue": 0,
  "taxFeesPaid": 0,
  "taxInterestDue": 0,
  "taxInterestPaid": 0,
  "taxPenaltyDue": 0,
  "taxPenaltyPaid": 0
}

Properties

Name	Type	Description	Restrictions
assignedBranchKey	string	none	none
assignedCentreKey	string	none	none
assignedUserKey	string	none	none
customSettings	[CustomRepaymentSettingsApiV1]	none	none
dueDate	string	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
feesAppliedDue	number	none	none
feesDue	number	none	none
feesPaid	number	none	none
feesUnappliedDue	number	none	none
fundersInterestDue	number	none	none
index	number	none	none
interestDue	number	none	none
interestPaid	number	none	none
lastPaidDate	string	none	none
lastPenaltyAppliedDate	string	none	none
notes	string	none	none
organizationCommissionDue	number	none	none
parentAccountKey	string	none	none
penaltyDue	number	none	none
penaltyPaid	number	none	none
principalDue	number	none	none
principalPaid	number	none	none
repaidDate	string	none	none
repaymentUnappliedFeeDetails	[RepaymentUnappliedFeeDetailsApiV1]	none	none
state	string	none	none
taxFeesDue	number	none	none
taxFeesPaid	number	none	none
taxInterestDue	number	none	none
taxInterestPaid	number	none	none
taxPenaltyDue	number	none	none
taxPenaltyPaid	number	none	none

Enumerated Values

Property	Value
state	`PARTIALLY_PAID`
state	`LATE`
state	`GRACE`
state	`PAID`
state	`PENDING`

RepaymentUnappliedFeeDetailsApiV1

{
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "feeDue": 0,
  "indexInList": 0,
  "predefinedFeeKey": "string",
  "repaymentKey": "string",
  "taxOnFeeDue": 0
}

Properties

Name	Type	Description	Restrictions
encodedKey	string	the automatically generated encoded ID for this item	none
feeDue	number	none	none
indexInList	number	none	none
predefinedFeeKey	string	none	none
repaymentKey	string	none	none
taxOnFeeDue	number	none	none

SavingsAccountApiV1

{
  "accountHolderKey": "string",
  "accountHolderType": "GROUP",
  "accountState": "WITHDRAWN",
  "accountType": "CURRENT_ACCOUNT",
  "accruedInterest": 0,
  "activationDate": "string",
  "allowOverdraft": true,
  "approvedDate": "string",
  "assignedBranchKey": "string",
  "assignedCentreKey": "string",
  "assignedUserKey": "string",
  "availableBalance": 0,
  "balance": 0,
  "closedDate": "string",
  "creationDate": "string",
  "currency": {
    "code": "string",
    "creationDate": "string",
    "currencySymbolPosition": "AFTER_NUMBER",
    "digitsAfterDecimal": 0,
    "isBaseCurrency": true,
    "lastModifiedDate": "string",
    "name": "string",
    "symbol": "string"
  },
  "currencyCode": "string",
  "customFieldValues": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "feesDue": 0,
  "holdBalance": 0,
  "id": "string",
  "interestDue": 0,
  "interestPaymentDates": [
    {
      "dayOfMonth": 0,
      "monthOfYear": 0,
      "year": 0
    }
  ],
  "interestPaymentPoint": "EVERY_WEEK",
  "interestSettings": {
    "accrueInterestAfterMaturity": true,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "interestChargeFrequency": "EVERY_WEEK",
    "interestChargeFrequencyCount": 0,
    "interestRate": 0,
    "interestRateReviewCount": 0,
    "interestRateReviewUnit": "MONTHS",
    "interestRateSource": "FIXED_INTEREST_RATE",
    "interestRateTerms": "TIERED_PERIOD",
    "interestRateTiers": [
      {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "endingBalance": 0,
        "endingDay": 0,
        "index": 0,
        "interestRate": 0
      }
    ],
    "interestSpread": 0
  },
  "lastAccountAppraisalDate": "string",
  "lastInterestCalculationDate": "string",
  "lastInterestStoredDate": "string",
  "lastModifiedDate": "string",
  "lastOverdraftInterestReviewDate": "string",
  "lastSetToArrearsDate": "string",
  "lineOfCreditKey": "string",
  "lockedBalance": 0,
  "lockedDate": "string",
  "maturityDate": "string",
  "maxWidthdrawlAmount": 0,
  "migrationEvent": {
    "creationDate": "2019-08-24T14:15:22Z",
    "encodedKey": "string",
    "numCentresImported": 0,
    "numClientsImported": 0,
    "numGLAccountsImported": 0,
    "numGroupsImported": 0,
    "numLoanRepaymentsImported": 0,
    "numLoanTransactionsImported": 0,
    "numLoansImported": 0,
    "numSavingsImported": 0,
    "state": "REVERTED",
    "type": "IMPORT"
  },
  "name": "string",
  "notes": "string",
  "overdraftAmount": 0,
  "overdraftExpiryDate": "string",
  "overdraftExpiryDateDTO": {
    "dayOfMonth": 0,
    "monthOfYear": 0,
    "year": 0
  },
  "overdraftInterestAccrued": 0,
  "overdraftInterestSettings": {
    "accrueInterestAfterMaturity": true,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "interestChargeFrequency": "EVERY_WEEK",
    "interestChargeFrequencyCount": 0,
    "interestRate": 0,
    "interestRateReviewCount": 0,
    "interestRateReviewUnit": "MONTHS",
    "interestRateSource": "FIXED_INTEREST_RATE",
    "interestRateTerms": "TIERED_PERIOD",
    "interestRateTiers": [
      {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "endingBalance": 0,
        "endingDay": 0,
        "index": 0,
        "interestRate": 0
      }
    ],
    "interestSpread": 0
  },
  "overdraftLimit": 0,
  "productTypeKey": "string",
  "recommendedDepositAmount": 0,
  "targetAmount": 0,
  "technicalInterestDue": 0,
  "technicalOverdraftAmount": 0,
  "technicalOverdraftInterestAccrued": 0,
  "withholdingTaxSourceKey": "string"
}

Properties

Name	Type	Description	Restrictions
accountHolderKey	string	none	none
accountHolderType	string	none	none
accountState	string	none	none
accountType	string	none	none
accruedInterest	number	none	none
activationDate	string	none	none
allowOverdraft	boolean	none	none
approvedDate	string	none	none
assignedBranchKey	string	none	none
assignedCentreKey	string	none	none
assignedUserKey	string	none	none
availableBalance	number	none	none
balance	number	none	none
closedDate	string	none	none
creationDate	string	the date and time when this savings account was created	none
currency	CurrencyApiV1	none	none
currencyCode	string	none	none
customFieldValues	[CustomFieldValueApiV1]	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
feesDue	number	none	none
holdBalance	number	none	none
id	string	none	none
interestDue	number	none	none
interestPaymentDates	[DateDTOApiV1]	none	none
interestPaymentPoint	string	none	none
interestSettings	InterestAccountSettingsApiV1	none	none
lastAccountAppraisalDate	string	none	none
lastInterestCalculationDate	string	none	none
lastInterestStoredDate	string	none	none
lastModifiedDate	string	the date on which this savings account was last modified	none
lastOverdraftInterestReviewDate	string	none	none
lastSetToArrearsDate	string	none	none
lineOfCreditKey	string	none	none
lockedBalance	number	none	none
lockedDate	string	none	none
maturityDate	string	none	none
maxWidthdrawlAmount	number	none	none
migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
name	string	none	none
notes	string	none	none
overdraftAmount	number	none	none
overdraftExpiryDate	string	none	none
overdraftExpiryDateDTO	DateDTOApiV1	none	none
overdraftInterestAccrued	number	none	none
overdraftInterestSettings	InterestAccountSettingsApiV1	none	none
overdraftLimit	number	none	none
productTypeKey	string	none	none
recommendedDepositAmount	number	none	none
targetAmount	number	none	none
technicalInterestDue	number	none	none
technicalOverdraftAmount	number	none	none
technicalOverdraftInterestAccrued	number	none	none
withholdingTaxSourceKey	string	none	none

Enumerated Values

Property	Value
accountHolderType	`GROUP`
accountHolderType	`CLIENT`
accountState	`WITHDRAWN`
accountState	`PARTIALLY_DISBURSED`
accountState	`LOCKED`
accountState	`ACTIVE`
accountState	`CLOSED`
accountState	`PARTIAL_APPLICATION`
accountState	`LOCKED_CAPPING`
accountState	`CLOSED_REJECTED`
accountState	`RESCHEDULED`
accountState	`ACTIVE_IN_ARREARS`
accountState	`MATURED`
accountState	`CLOSED_RESCHEDULED`
accountState	`CLOSED_WITHDRAWN`
accountState	`PENDING_APPROVAL`
accountState	`APPROVED`
accountState	`REFINANCED`
accountState	`DORMANT`
accountState	`CLOSED_WRITTEN_OFF`
accountType	`CURRENT_ACCOUNT`
accountType	`REGULAR_SAVINGS`
accountType	`FIXED_DEPOSIT`
accountType	`INVESTOR_ACCOUNT`
accountType	`SAVINGS_PLAN`
interestPaymentPoint	`EVERY_WEEK`
interestPaymentPoint	`ON_FIXED_DATES`
interestPaymentPoint	`EVERY_MONTH`
interestPaymentPoint	`ON_ACCOUNT_MATURITY`
interestPaymentPoint	`EVERY_3_MONTHS`
interestPaymentPoint	`FIRST_DAY_OF_MONTH`
interestPaymentPoint	`EVERY_OTHER_WEEK`

SavingsProductApiV1

{
  "accountingMethod": "NONE",
  "activated": true,
  "allowArbitraryFees": true,
  "allowOffset": true,
  "allowOverdraft": true,
  "allowTechnicalOverdraft": true,
  "availableProductBranches": [
    {
      "branchKey": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "product": {
        "accountingMethod": "NONE",
        "activated": true,
        "allowArbitraryFees": true,
        "allowOffset": true,
        "allowOverdraft": true,
        "allowTechnicalOverdraft": true,
        "availableProductBranches": [],
        "collectInterestWhenLocked": true,
        "creationDate": "string",
        "currencies": [
          {
            "code": "string",
            "creationDate": "string",
            "currencySymbolPosition": "AFTER_NUMBER",
            "digitsAfterDecimal": 0,
            "isBaseCurrency": true,
            "lastModifiedDate": "string",
            "name": "string",
            "symbol": "string"
          }
        ],
        "defaultMaturityPeriod": 0,
        "defaultOpeningBalance": 0,
        "description": "string",
        "dormancyPeriodDays": 0,
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "forAllBranches": true,
        "forGroups": true,
        "forIndividuals": true,
        "id": "string",
        "idGeneratorType": "INCREMENTAL_NUMBER",
        "idPattern": "string",
        "interestAccruedAccountingMethod": "DAILY",
        "interestCalculationBalance": "MINIMUM",
        "interestDaysInYear": "E30_42_365",
        "interestPaidIntoAccount": true,
        "interestPaymentDates": [
          {
            "dayOfMonth": 0,
            "monthOfYear": 0,
            "year": 0
          }
        ],
        "interestPaymentPoint": "EVERY_WEEK",
        "interestRateSettings": {
          "accrueInterestAfterMaturity": true,
          "defaultInterestRate": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexSourceKey": "string",
          "interestChargeFrequency": "EVERY_WEEK",
          "interestChargeFrequencyCount": 0,
          "interestRateCeilingValue": 0,
          "interestRateFloorValue": 0,
          "interestRateReviewCount": 0,
          "interestRateReviewUnit": "MONTHS",
          "interestRateSource": "FIXED_INTEREST_RATE",
          "interestRateTerms": "TIERED_PERIOD",
          "interestRateTiers": [
            {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "endingBalance": 0,
              "endingDay": 0,
              "index": 0,
              "interestRate": 0
            }
          ],
          "maxInterestRate": 0,
          "minInterestRate": 0
        },
        "lastModifiedDate": "string",
        "lineOfCreditRequirement": "OPTIONAL",
        "maturityPeriodUnit": "MONTHS",
        "maxMaturityPeriod": 0,
        "maxOpeningBalance": 0,
        "maxOverdraftLimit": 0,
        "maxWidthdrawlAmount": 0,
        "maximumBalance": 0,
        "minMaturityPeriod": 0,
        "minOpeningBalance": 0,
        "name": "string",
        "overdraftDaysInYear": "E30_42_365",
        "overdraftInterestCalculationBalance": "MINIMUM",
        "overdraftInterestRateSettings": {
          "accrueInterestAfterMaturity": true,
          "defaultInterestRate": 0,
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexSourceKey": "string",
          "interestChargeFrequency": "EVERY_WEEK",
          "interestChargeFrequencyCount": 0,
          "interestRateCeilingValue": 0,
          "interestRateFloorValue": 0,
          "interestRateReviewCount": 0,
          "interestRateReviewUnit": "MONTHS",
          "interestRateSource": "FIXED_INTEREST_RATE",
          "interestRateTerms": "TIERED_PERIOD",
          "interestRateTiers": [
            {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "endingBalance": 0,
              "endingDay": 0,
              "index": 0,
              "interestRate": 0
            }
          ],
          "maxInterestRate": 0,
          "minInterestRate": 0
        },
        "productType": "CURRENT_ACCOUNT",
        "recommendedDepositAmount": 0,
        "savingsFees": [
          {
            "active": true,
            "amortizationIntervalSettings": {
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
              "intervalCount": 0,
              "intervalType": "FULL_TERM",
              "periodCount": 0,
              "periodUnit": "MONTHS"
            },
            "amortizationProfile": "STRAIGHT_LINE",
            "amount": 0,
            "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
            "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
            "creationDate": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
            "feeApplication": "OPTIONAL",
            "feeProductRules": [
              {
                "account": {
                  "activated": true,
                  "allowManualJournalEntries": true,
                  "balance": 0,
                  "creationDate": "2019-08-24T14:15:22Z",
                  "currency": {
                    "code": "string",
                    "creationDate": "string",
                    "currencySymbolPosition": "AFTER_NUMBER",
                    "digitsAfterDecimal": 0,
                    "isBaseCurrency": true,
                    "lastModifiedDate": "string",
                    "name": "string",
                    "symbol": "string"
                  },
                  "description": "string",
                  "encodedKey": "string",
                  "glCode": "string",
                  "lastModifiedDate": "2019-08-24T14:15:22Z",
                  "migrationEvent": {
                    "creationDate": "2019-08-24T14:15:22Z",
                    "encodedKey": "string",
                    "numCentresImported": 0,
                    "numClientsImported": 0,
                    "numGLAccountsImported": 0,
                    "numGroupsImported": 0,
                    "numLoanRepaymentsImported": 0,
                    "numLoanTransactionsImported": 0,
                    "numLoansImported": 0,
                    "numSavingsImported": 0,
                    "state": "REVERTED",
                    "type": "IMPORT"
                  },
                  "name": "string",
                  "stripTrailingZeros": true,
                  "type": "INCOME",
                  "usage": "HEADER"
                },
                "encodedKey": "8a19b7057471f4af017472dc0fd80472",
                "financialResource": "FEE_RECEIVABLE",
                "index": 0,
                "predefinedFeeKey": "string",
                "productKey": "string",
                "productType": "LOAN",
                "transactionChannelKey": "string"
              }
            ],
            "name": "string",
            "percentageAmount": 0,
            "trigger": "DISBURSEMENT"
          }
        ],
        "savingsProductRules": [
          {
            "account": {
              "activated": true,
              "allowManualJournalEntries": true,
              "balance": 0,
              "creationDate": "2019-08-24T14:15:22Z",
              "currency": {
                "code": "string",
                "creationDate": "string",
                "currencySymbolPosition": "AFTER_NUMBER",
                "digitsAfterDecimal": 0,
                "isBaseCurrency": true,
                "lastModifiedDate": "string",
                "name": "string",
                "symbol": "string"
              },
              "description": "string",
              "encodedKey": "string",
              "glCode": "string",
              "lastModifiedDate": "2019-08-24T14:15:22Z",
              "migrationEvent": {
                "creationDate": "2019-08-24T14:15:22Z",
                "encodedKey": "string",
                "numCentresImported": 0,
                "numClientsImported": 0,
                "numGLAccountsImported": 0,
                "numGroupsImported": 0,
                "numLoanRepaymentsImported": 0,
                "numLoanTransactionsImported": 0,
                "numLoansImported": 0,
                "numSavingsImported": 0,
                "state": "REVERTED",
                "type": "IMPORT"
              },
              "name": "string",
              "stripTrailingZeros": true,
              "type": "INCOME",
              "usage": "HEADER"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "financialResource": "FEE_RECEIVABLE",
            "index": 0,
            "predefinedFeeKey": "string",
            "productKey": "string",
            "productType": "LOAN",
            "transactionChannelKey": "string"
          }
        ],
        "templates": [
          {
            "creationDate": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "lastModifiedDate": "string",
            "name": "string",
            "type": "ACCOUNT"
          }
        ],
        "withholdingTaxEnabled": true
      }
    }
  ],
  "collectInterestWhenLocked": true,
  "creationDate": "string",
  "currencies": [
    {
      "code": "string",
      "creationDate": "string",
      "currencySymbolPosition": "AFTER_NUMBER",
      "digitsAfterDecimal": 0,
      "isBaseCurrency": true,
      "lastModifiedDate": "string",
      "name": "string",
      "symbol": "string"
    }
  ],
  "defaultMaturityPeriod": 0,
  "defaultOpeningBalance": 0,
  "description": "string",
  "dormancyPeriodDays": 0,
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "forAllBranches": true,
  "forGroups": true,
  "forIndividuals": true,
  "id": "string",
  "idGeneratorType": "INCREMENTAL_NUMBER",
  "idPattern": "string",
  "interestAccruedAccountingMethod": "DAILY",
  "interestCalculationBalance": "MINIMUM",
  "interestDaysInYear": "E30_42_365",
  "interestPaidIntoAccount": true,
  "interestPaymentDates": [
    {
      "dayOfMonth": 0,
      "monthOfYear": 0,
      "year": 0
    }
  ],
  "interestPaymentPoint": "EVERY_WEEK",
  "interestRateSettings": {
    "accrueInterestAfterMaturity": true,
    "defaultInterestRate": 0,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "indexSourceKey": "string",
    "interestChargeFrequency": "EVERY_WEEK",
    "interestChargeFrequencyCount": 0,
    "interestRateCeilingValue": 0,
    "interestRateFloorValue": 0,
    "interestRateReviewCount": 0,
    "interestRateReviewUnit": "MONTHS",
    "interestRateSource": "FIXED_INTEREST_RATE",
    "interestRateTerms": "TIERED_PERIOD",
    "interestRateTiers": [
      {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "endingBalance": 0,
        "endingDay": 0,
        "index": 0,
        "interestRate": 0
      }
    ],
    "maxInterestRate": 0,
    "minInterestRate": 0
  },
  "lastModifiedDate": "string",
  "lineOfCreditRequirement": "OPTIONAL",
  "maturityPeriodUnit": "MONTHS",
  "maxMaturityPeriod": 0,
  "maxOpeningBalance": 0,
  "maxOverdraftLimit": 0,
  "maxWidthdrawlAmount": 0,
  "maximumBalance": 0,
  "minMaturityPeriod": 0,
  "minOpeningBalance": 0,
  "name": "string",
  "overdraftDaysInYear": "E30_42_365",
  "overdraftInterestCalculationBalance": "MINIMUM",
  "overdraftInterestRateSettings": {
    "accrueInterestAfterMaturity": true,
    "defaultInterestRate": 0,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "indexSourceKey": "string",
    "interestChargeFrequency": "EVERY_WEEK",
    "interestChargeFrequencyCount": 0,
    "interestRateCeilingValue": 0,
    "interestRateFloorValue": 0,
    "interestRateReviewCount": 0,
    "interestRateReviewUnit": "MONTHS",
    "interestRateSource": "FIXED_INTEREST_RATE",
    "interestRateTerms": "TIERED_PERIOD",
    "interestRateTiers": [
      {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "endingBalance": 0,
        "endingDay": 0,
        "index": 0,
        "interestRate": 0
      }
    ],
    "maxInterestRate": 0,
    "minInterestRate": 0
  },
  "productType": "CURRENT_ACCOUNT",
  "recommendedDepositAmount": 0,
  "savingsFees": [
    {
      "active": true,
      "amortizationIntervalSettings": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
        "intervalCount": 0,
        "intervalType": "FULL_TERM",
        "periodCount": 0,
        "periodUnit": "MONTHS"
      },
      "amortizationProfile": "STRAIGHT_LINE",
      "amount": 0,
      "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
      "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
      "creationDate": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
      "feeApplication": "OPTIONAL",
      "feeProductRules": [
        {
          "account": {
            "activated": true,
            "allowManualJournalEntries": true,
            "balance": 0,
            "creationDate": "2019-08-24T14:15:22Z",
            "currency": {
              "code": "string",
              "creationDate": "string",
              "currencySymbolPosition": "AFTER_NUMBER",
              "digitsAfterDecimal": 0,
              "isBaseCurrency": true,
              "lastModifiedDate": "string",
              "name": "string",
              "symbol": "string"
            },
            "description": "string",
            "encodedKey": "string",
            "glCode": "string",
            "lastModifiedDate": "2019-08-24T14:15:22Z",
            "migrationEvent": {
              "creationDate": "2019-08-24T14:15:22Z",
              "encodedKey": "string",
              "numCentresImported": 0,
              "numClientsImported": 0,
              "numGLAccountsImported": 0,
              "numGroupsImported": 0,
              "numLoanRepaymentsImported": 0,
              "numLoanTransactionsImported": 0,
              "numLoansImported": 0,
              "numSavingsImported": 0,
              "state": "REVERTED",
              "type": "IMPORT"
            },
            "name": "string",
            "stripTrailingZeros": true,
            "type": "INCOME",
            "usage": "HEADER"
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "financialResource": "FEE_RECEIVABLE",
          "index": 0,
          "predefinedFeeKey": "string",
          "productKey": "string",
          "productType": "LOAN",
          "transactionChannelKey": "string"
        }
      ],
      "name": "string",
      "percentageAmount": 0,
      "trigger": "DISBURSEMENT"
    }
  ],
  "savingsProductRules": [
    {
      "account": {
        "activated": true,
        "allowManualJournalEntries": true,
        "balance": 0,
        "creationDate": "2019-08-24T14:15:22Z",
        "currency": {
          "code": "string",
          "creationDate": "string",
          "currencySymbolPosition": "AFTER_NUMBER",
          "digitsAfterDecimal": 0,
          "isBaseCurrency": true,
          "lastModifiedDate": "string",
          "name": "string",
          "symbol": "string"
        },
        "description": "string",
        "encodedKey": "string",
        "glCode": "string",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "migrationEvent": {
          "creationDate": "2019-08-24T14:15:22Z",
          "encodedKey": "string",
          "numCentresImported": 0,
          "numClientsImported": 0,
          "numGLAccountsImported": 0,
          "numGroupsImported": 0,
          "numLoanRepaymentsImported": 0,
          "numLoanTransactionsImported": 0,
          "numLoansImported": 0,
          "numSavingsImported": 0,
          "state": "REVERTED",
          "type": "IMPORT"
        },
        "name": "string",
        "stripTrailingZeros": true,
        "type": "INCOME",
        "usage": "HEADER"
      },
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "financialResource": "FEE_RECEIVABLE",
      "index": 0,
      "predefinedFeeKey": "string",
      "productKey": "string",
      "productType": "LOAN",
      "transactionChannelKey": "string"
    }
  ],
  "templates": [
    {
      "creationDate": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "lastModifiedDate": "string",
      "name": "string",
      "type": "ACCOUNT"
    }
  ],
  "withholdingTaxEnabled": true
}

Properties

Name	Type	Description	Restrictions
accountingMethod	string	none	none
activated	boolean	none	none
allowArbitraryFees	boolean	none	none
allowOffset	boolean	none	none
allowOverdraft	boolean	none	none
allowTechnicalOverdraft	boolean	none	none
availableProductBranches	[SavingsProductBranchApiV1]	none	none
collectInterestWhenLocked	boolean	none	none
creationDate	string	the date and time when this savings product was created	none
currencies	[CurrencyApiV1]	none	none
defaultMaturityPeriod	number	none	none
defaultOpeningBalance	number	none	none
description	string	none	none
dormancyPeriodDays	number	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
forAllBranches	boolean	none	none
forGroups	boolean	none	none
forIndividuals	boolean	none	none
id	string	none	none
idGeneratorType	string	none	none
idPattern	string	none	none
interestAccruedAccountingMethod	string	none	none
interestCalculationBalance	string	none	none
interestDaysInYear	string	none	none
interestPaidIntoAccount	boolean	none	none
interestPaymentDates	[DateDTOApiV1]	none	none
interestPaymentPoint	string	none	none
interestRateSettings	InterestProductSettingsApiV1	none	none
lastModifiedDate	string	the date on which this savings product was last modified	none
lineOfCreditRequirement	string	none	none
maturityPeriodUnit	string	none	none
maxMaturityPeriod	number	none	none
maxOpeningBalance	number	none	none
maxOverdraftLimit	number	none	none
maxWidthdrawlAmount	number	none	none
maximumBalance	number	none	none
minMaturityPeriod	number	none	none
minOpeningBalance	number	none	none
name	string	none	none
overdraftDaysInYear	string	none	none
overdraftInterestCalculationBalance	string	none	none
overdraftInterestRateSettings	InterestProductSettingsApiV1	none	none
productType	string	none	none
recommendedDepositAmount	number	none	none
savingsFees	[PredefinedFeeApiV1]	none	none
savingsProductRules	[GLAccountingRuleApiV1]	none	none
templates	[DocumentTemplateApiV1]	none	none
withholdingTaxEnabled	boolean	none	none

Enumerated Values

Property	Value
accountingMethod	`NONE`
accountingMethod	`CASH`
accountingMethod	`ACCRUAL`
idGeneratorType	`INCREMENTAL_NUMBER`
idGeneratorType	`RANDOM_PATTERN`
interestAccruedAccountingMethod	`DAILY`
interestAccruedAccountingMethod	`END_OF_MONTH`
interestAccruedAccountingMethod	`NONE`
interestCalculationBalance	`MINIMUM`
interestCalculationBalance	`END_OF_DAY`
interestCalculationBalance	`AVERAGE`
interestDaysInYear	`E30_42_365`
interestDaysInYear	`ACTUAL_365_FIXED`
interestDaysInYear	`ACTUAL_360`
interestDaysInYear	`E30_360`
interestDaysInYear	`ACTUAL_364`
interestDaysInYear	`ACTUAL_ACTUAL_ISDA`
interestPaymentPoint	`EVERY_WEEK`
interestPaymentPoint	`ON_FIXED_DATES`
interestPaymentPoint	`EVERY_MONTH`
interestPaymentPoint	`ON_ACCOUNT_MATURITY`
interestPaymentPoint	`EVERY_3_MONTHS`
interestPaymentPoint	`FIRST_DAY_OF_MONTH`
interestPaymentPoint	`EVERY_OTHER_WEEK`
lineOfCreditRequirement	`OPTIONAL`
lineOfCreditRequirement	`NOT_REQUIRED`
lineOfCreditRequirement	`REQUIRED`
maturityPeriodUnit	`MONTHS`
maturityPeriodUnit	`WEEKS`
maturityPeriodUnit	`DAYS`
overdraftDaysInYear	`E30_42_365`
overdraftDaysInYear	`ACTUAL_365_FIXED`
overdraftDaysInYear	`ACTUAL_360`
overdraftDaysInYear	`E30_360`
overdraftDaysInYear	`ACTUAL_364`
overdraftDaysInYear	`ACTUAL_ACTUAL_ISDA`
overdraftInterestCalculationBalance	`MINIMUM`
overdraftInterestCalculationBalance	`END_OF_DAY`
overdraftInterestCalculationBalance	`AVERAGE`
productType	`CURRENT_ACCOUNT`
productType	`REGULAR_SAVINGS`
productType	`FIXED_DEPOSIT`
productType	`INVESTOR_ACCOUNT`
productType	`SAVINGS_PLAN`

SavingsProductBranchApiV1

{
  "branchKey": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "product": {
    "accountingMethod": "NONE",
    "activated": true,
    "allowArbitraryFees": true,
    "allowOffset": true,
    "allowOverdraft": true,
    "allowTechnicalOverdraft": true,
    "availableProductBranches": [
      {
        "branchKey": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "product": {}
      }
    ],
    "collectInterestWhenLocked": true,
    "creationDate": "string",
    "currencies": [
      {
        "code": "string",
        "creationDate": "string",
        "currencySymbolPosition": "AFTER_NUMBER",
        "digitsAfterDecimal": 0,
        "isBaseCurrency": true,
        "lastModifiedDate": "string",
        "name": "string",
        "symbol": "string"
      }
    ],
    "defaultMaturityPeriod": 0,
    "defaultOpeningBalance": 0,
    "description": "string",
    "dormancyPeriodDays": 0,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "forAllBranches": true,
    "forGroups": true,
    "forIndividuals": true,
    "id": "string",
    "idGeneratorType": "INCREMENTAL_NUMBER",
    "idPattern": "string",
    "interestAccruedAccountingMethod": "DAILY",
    "interestCalculationBalance": "MINIMUM",
    "interestDaysInYear": "E30_42_365",
    "interestPaidIntoAccount": true,
    "interestPaymentDates": [
      {
        "dayOfMonth": 0,
        "monthOfYear": 0,
        "year": 0
      }
    ],
    "interestPaymentPoint": "EVERY_WEEK",
    "interestRateSettings": {
      "accrueInterestAfterMaturity": true,
      "defaultInterestRate": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexSourceKey": "string",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestChargeFrequencyCount": 0,
      "interestRateCeilingValue": 0,
      "interestRateFloorValue": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "TIERED_PERIOD",
      "interestRateTiers": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingBalance": 0,
          "endingDay": 0,
          "index": 0,
          "interestRate": 0
        }
      ],
      "maxInterestRate": 0,
      "minInterestRate": 0
    },
    "lastModifiedDate": "string",
    "lineOfCreditRequirement": "OPTIONAL",
    "maturityPeriodUnit": "MONTHS",
    "maxMaturityPeriod": 0,
    "maxOpeningBalance": 0,
    "maxOverdraftLimit": 0,
    "maxWidthdrawlAmount": 0,
    "maximumBalance": 0,
    "minMaturityPeriod": 0,
    "minOpeningBalance": 0,
    "name": "string",
    "overdraftDaysInYear": "E30_42_365",
    "overdraftInterestCalculationBalance": "MINIMUM",
    "overdraftInterestRateSettings": {
      "accrueInterestAfterMaturity": true,
      "defaultInterestRate": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexSourceKey": "string",
      "interestChargeFrequency": "EVERY_WEEK",
      "interestChargeFrequencyCount": 0,
      "interestRateCeilingValue": 0,
      "interestRateFloorValue": 0,
      "interestRateReviewCount": 0,
      "interestRateReviewUnit": "MONTHS",
      "interestRateSource": "FIXED_INTEREST_RATE",
      "interestRateTerms": "TIERED_PERIOD",
      "interestRateTiers": [
        {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "endingBalance": 0,
          "endingDay": 0,
          "index": 0,
          "interestRate": 0
        }
      ],
      "maxInterestRate": 0,
      "minInterestRate": 0
    },
    "productType": "CURRENT_ACCOUNT",
    "recommendedDepositAmount": 0,
    "savingsFees": [
      {
        "active": true,
        "amortizationIntervalSettings": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
          "intervalCount": 0,
          "intervalType": "FULL_TERM",
          "periodCount": 0,
          "periodUnit": "MONTHS"
        },
        "amortizationProfile": "STRAIGHT_LINE",
        "amount": 0,
        "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
        "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
        "creationDate": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
        "feeApplication": "OPTIONAL",
        "feeProductRules": [
          {
            "account": {
              "activated": true,
              "allowManualJournalEntries": true,
              "balance": 0,
              "creationDate": "2019-08-24T14:15:22Z",
              "currency": {
                "code": "string",
                "creationDate": "string",
                "currencySymbolPosition": "AFTER_NUMBER",
                "digitsAfterDecimal": 0,
                "isBaseCurrency": true,
                "lastModifiedDate": "string",
                "name": "string",
                "symbol": "string"
              },
              "description": "string",
              "encodedKey": "string",
              "glCode": "string",
              "lastModifiedDate": "2019-08-24T14:15:22Z",
              "migrationEvent": {
                "creationDate": "2019-08-24T14:15:22Z",
                "encodedKey": "string",
                "numCentresImported": 0,
                "numClientsImported": 0,
                "numGLAccountsImported": 0,
                "numGroupsImported": 0,
                "numLoanRepaymentsImported": 0,
                "numLoanTransactionsImported": 0,
                "numLoansImported": 0,
                "numSavingsImported": 0,
                "state": "REVERTED",
                "type": "IMPORT"
              },
              "name": "string",
              "stripTrailingZeros": true,
              "type": "INCOME",
              "usage": "HEADER"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "financialResource": "FEE_RECEIVABLE",
            "index": 0,
            "predefinedFeeKey": "string",
            "productKey": "string",
            "productType": "LOAN",
            "transactionChannelKey": "string"
          }
        ],
        "name": "string",
        "percentageAmount": 0,
        "trigger": "DISBURSEMENT"
      }
    ],
    "savingsProductRules": [
      {
        "account": {
          "activated": true,
          "allowManualJournalEntries": true,
          "balance": 0,
          "creationDate": "2019-08-24T14:15:22Z",
          "currency": {
            "code": "string",
            "creationDate": "string",
            "currencySymbolPosition": "AFTER_NUMBER",
            "digitsAfterDecimal": 0,
            "isBaseCurrency": true,
            "lastModifiedDate": "string",
            "name": "string",
            "symbol": "string"
          },
          "description": "string",
          "encodedKey": "string",
          "glCode": "string",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "migrationEvent": {
            "creationDate": "2019-08-24T14:15:22Z",
            "encodedKey": "string",
            "numCentresImported": 0,
            "numClientsImported": 0,
            "numGLAccountsImported": 0,
            "numGroupsImported": 0,
            "numLoanRepaymentsImported": 0,
            "numLoanTransactionsImported": 0,
            "numLoansImported": 0,
            "numSavingsImported": 0,
            "state": "REVERTED",
            "type": "IMPORT"
          },
          "name": "string",
          "stripTrailingZeros": true,
          "type": "INCOME",
          "usage": "HEADER"
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "financialResource": "FEE_RECEIVABLE",
        "index": 0,
        "predefinedFeeKey": "string",
        "productKey": "string",
        "productType": "LOAN",
        "transactionChannelKey": "string"
      }
    ],
    "templates": [
      {
        "creationDate": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "lastModifiedDate": "string",
        "name": "string",
        "type": "ACCOUNT"
      }
    ],
    "withholdingTaxEnabled": true
  }
}

Properties

Name	Type	Description	Restrictions
branchKey	string	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
product	SavingsProductApiV1	none	none

SavingsTransactionApiV1

{
  "amount": 0,
  "balance": 0,
  "bookingDate": "string",
  "branchKey": "string",
  "centreKey": "string",
  "comment": "string",
  "creationDate": "string",
  "currencyCode": "string",
  "customInformation": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "details": {
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "internalTransfer": true,
    "targetSavingsAccountKey": "string",
    "transactionChannel": {
      "activated": true,
      "createdByUserKey": "string",
      "creationDate": "string",
      "customFields": [
        {
          "amounts": {
            "property1": 0,
            "property2": 0
          },
          "builtInCustomFieldId": "MOBILE_PHONE",
          "creationDate": "string",
          "customFieldProductSettings": [
            {
              "customFieldEncodedKey": "string",
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "isDefault": true,
              "isRequired": true,
              "linkType": "CLIENT_ROLE",
              "productKey": "string"
            }
          ],
          "customFieldSelectionOptions": [
            {
              "constraint": {
                "customFieldKey": "string",
                "dataFieldType": "NATIVE",
                "dataFieldValue": "string",
                "dataItemType": "WRITTEN_OFF_LOANS",
                "dataType": "ENUM",
                "encodedKey": "string",
                "filterElement": "STARTS_WITH_CASE_SENSITIVE",
                "groupNumber": 0,
                "index": 0,
                "linkingOperator": "OR",
                "secondValue": "string",
                "value": "string"
              },
              "encodedKey": "8a19b7057471f4af017472dc0fd80472",
              "id": "string",
              "score": 0,
              "value": "string"
            }
          ],
          "customFieldSet": {
            "builtInType": "DETAILS",
            "createdDate": "string",
            "customFields": [
              {}
            ],
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "indexInList": 0,
            "lastModifiedDate": "string",
            "name": "string",
            "notes": "string",
            "type": "USER_INFO",
            "usage": "SINGLE"
          },
          "dataType": "GROUP_LINK",
          "description": "string",
          "editRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "isDefault": true,
          "isRequired": true,
          "lastModifiedDate": "string",
          "name": "string",
          "state": "DEACTIVATED",
          "type": "USER_INFO",
          "unique": true,
          "validationPattern": "string",
          "valueLength": "SHORT",
          "values": [
            "string"
          ],
          "viewRights": {
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isAccessibleByAllUsers": true,
            "roles": [
              "string"
            ]
          }
        }
      ],
      "encodedKey": "string",
      "id": "string",
      "index": 0,
      "loanConstraints": {
        "customConfigurationInfo": {
          "creationDate": "string",
          "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "shared": true,
          "userKey": "string"
        },
        "encodedKey": "string",
        "filterConstraints": [
          {
            "customFieldKey": "string",
            "dataFieldType": "NATIVE",
            "dataFieldValue": "string",
            "dataItemType": "WRITTEN_OFF_LOANS",
            "dataType": "ENUM",
            "encodedKey": "string",
            "filterElement": "STARTS_WITH_CASE_SENSITIVE",
            "groupNumber": 0,
            "index": 0,
            "linkingOperator": "OR",
            "secondValue": "string",
            "value": "string"
          }
        ]
      },
      "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
      "name": "string",
      "savingsConstraints": {
        "customConfigurationInfo": {
          "creationDate": "string",
          "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "shared": true,
          "userKey": "string"
        },
        "encodedKey": "string",
        "filterConstraints": [
          {
            "customFieldKey": "string",
            "dataFieldType": "NATIVE",
            "dataFieldValue": "string",
            "dataItemType": "WRITTEN_OFF_LOANS",
            "dataType": "ENUM",
            "encodedKey": "string",
            "filterElement": "STARTS_WITH_CASE_SENSITIVE",
            "groupNumber": 0,
            "index": 0,
            "linkingOperator": "OR",
            "secondValue": "string",
            "value": "string"
          }
        ]
      },
      "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
      "transactionChannelAccountingRule": {
        "account": {
          "activated": true,
          "allowManualJournalEntries": true,
          "balance": 0,
          "creationDate": "2019-08-24T14:15:22Z",
          "currency": {
            "code": "string",
            "creationDate": "string",
            "currencySymbolPosition": "AFTER_NUMBER",
            "digitsAfterDecimal": 0,
            "isBaseCurrency": true,
            "lastModifiedDate": "string",
            "name": "string",
            "symbol": "string"
          },
          "description": "string",
          "encodedKey": "string",
          "glCode": "string",
          "lastModifiedDate": "2019-08-24T14:15:22Z",
          "migrationEvent": {
            "creationDate": "2019-08-24T14:15:22Z",
            "encodedKey": "string",
            "numCentresImported": 0,
            "numClientsImported": 0,
            "numGLAccountsImported": 0,
            "numGroupsImported": 0,
            "numLoanRepaymentsImported": 0,
            "numLoanTransactionsImported": 0,
            "numLoansImported": 0,
            "numSavingsImported": 0,
            "state": "REVERTED",
            "type": "IMPORT"
          },
          "name": "string",
          "stripTrailingZeros": true,
          "type": "INCOME",
          "usage": "HEADER"
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "financialResource": "FEE_RECEIVABLE",
        "index": 0,
        "predefinedFeeKey": "string",
        "productKey": "string",
        "productType": "LOAN",
        "transactionChannelKey": "string"
      },
      "usageRights": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "isAccessibleByAllUsers": true,
        "roles": [
          "string"
        ]
      }
    },
    "transactionChannelKey": "string"
  },
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "entryDate": "string",
  "feesAmount": 0,
  "feesPaid": 0,
  "fractionAmount": 0,
  "fundsAmount": 0,
  "interestAmount": 0,
  "interestPaid": 0,
  "interestRate": 0,
  "linkedLoanTransactionKey": "string",
  "linkedSavingsTransactionKey": "string",
  "migrationEvent": {
    "creationDate": "2019-08-24T14:15:22Z",
    "encodedKey": "string",
    "numCentresImported": 0,
    "numClientsImported": 0,
    "numGLAccountsImported": 0,
    "numGroupsImported": 0,
    "numLoanRepaymentsImported": 0,
    "numLoanTransactionsImported": 0,
    "numLoansImported": 0,
    "numSavingsImported": 0,
    "state": "REVERTED",
    "type": "IMPORT"
  },
  "overdraftAmount": 0,
  "overdraftIndexRate": {
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "notes": "string",
    "rate": 0,
    "rateSource": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "name": "string",
      "notes": "string",
      "type": "TAX_RATE"
    },
    "startDate": "string",
    "userKey": "string"
  },
  "overdraftInterestRate": 0,
  "overdraftLimit": 0,
  "parentAccountKey": "string",
  "preciseInterestAmount": 0,
  "productTypeKey": "string",
  "reversalTransactionKey": "string",
  "savingsPredefinedFeeAmounts": [
    {
      "amortizedAmounts": [
        {
          "amount": 0,
          "branchKey": "string",
          "centreKey": "string",
          "creationDate": "string",
          "encodedKey": "string",
          "entryDate": "string",
          "reversalAmountKey": "string",
          "taxAmount": 0,
          "type": "AMORTIZATION_ADJUSTMENT"
        }
      ],
      "amount": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "fee": {
        "active": true,
        "amortizationIntervalSettings": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING",
          "intervalCount": 0,
          "intervalType": "FULL_TERM",
          "periodCount": 0,
          "periodUnit": "MONTHS"
        },
        "amortizationProfile": "STRAIGHT_LINE",
        "amount": 0,
        "amountCalculationMethod": "LOAN_AMOUNT_PERCENTAGE",
        "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
        "creationDate": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "feeAmortizationUponRescheduleOption": "CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT",
        "feeApplication": "OPTIONAL",
        "feeProductRules": [
          {
            "account": {
              "activated": true,
              "allowManualJournalEntries": true,
              "balance": 0,
              "creationDate": "2019-08-24T14:15:22Z",
              "currency": {
                "code": "string",
                "creationDate": "string",
                "currencySymbolPosition": "AFTER_NUMBER",
                "digitsAfterDecimal": 0,
                "isBaseCurrency": true,
                "lastModifiedDate": "string",
                "name": "string",
                "symbol": "string"
              },
              "description": "string",
              "encodedKey": "string",
              "glCode": "string",
              "lastModifiedDate": "2019-08-24T14:15:22Z",
              "migrationEvent": {
                "creationDate": "2019-08-24T14:15:22Z",
                "encodedKey": "string",
                "numCentresImported": 0,
                "numClientsImported": 0,
                "numGLAccountsImported": 0,
                "numGroupsImported": 0,
                "numLoanRepaymentsImported": 0,
                "numLoanTransactionsImported": 0,
                "numLoansImported": 0,
                "numSavingsImported": 0,
                "state": "REVERTED",
                "type": "IMPORT"
              },
              "name": "string",
              "stripTrailingZeros": true,
              "type": "INCOME",
              "usage": "HEADER"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "financialResource": "FEE_RECEIVABLE",
            "index": 0,
            "predefinedFeeKey": "string",
            "productKey": "string",
            "productType": "LOAN",
            "transactionChannelKey": "string"
          }
        ],
        "name": "string",
        "percentageAmount": 0,
        "trigger": "DISBURSEMENT"
      },
      "taxAmount": 0,
      "transactionId": 0
    }
  ],
  "taxRate": {
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "notes": "string",
    "rate": 0,
    "rateSource": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "name": "string",
      "notes": "string",
      "type": "TAX_RATE"
    },
    "startDate": "string",
    "userKey": "string"
  },
  "technicalOverdraftAmount": 0,
  "technicalOverdraftInterestAmount": 0,
  "tillKey": "string",
  "transactionId": 0,
  "type": "LOAN_FRACTION_SOLD",
  "userKey": "string",
  "valueDate": "string"
}

Properties

Name	Type	Description	Restrictions
amount	number	none	none
balance	number	none	none
bookingDate	string	none	none
branchKey	string	none	none
centreKey	string	none	none
comment	string	none	none
creationDate	string	the date and time when this savings transaction was created	none
currencyCode	string	none	none
customInformation	[CustomFieldValueApiV1]	none	none
details	TransactionDetailsApiV1	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
entryDate	string	none	none
feesAmount	number	none	none
feesPaid	number	none	none
fractionAmount	number	none	none
fundsAmount	number	none	none
interestAmount	number	none	none
interestPaid	number	none	none
interestRate	number	none	none
linkedLoanTransactionKey	string	none	none
linkedSavingsTransactionKey	string	none	none
migrationEvent	DataMigrationEventApiV1	details about an import or export operation	none
overdraftAmount	number	none	none
overdraftIndexRate	IndexRateApiV1	none	none
overdraftInterestRate	number	none	none
overdraftLimit	number	none	none
parentAccountKey	string	none	none
preciseInterestAmount	number	none	none
productTypeKey	string	none	none
reversalTransactionKey	string	none	none
savingsPredefinedFeeAmounts	[PredefinedFeeAmountApiV1]	none	none
taxRate	IndexRateApiV1	none	none
technicalOverdraftAmount	number	none	none
technicalOverdraftInterestAmount	number	none	none
tillKey	string	none	none
transactionId	number	none	none
type	string	none	none
userKey	string	none	none
valueDate	string	none	none

Enumerated Values

Property	Value
type	`LOAN_FRACTION_SOLD`
type	`WRITE_OFF_ADJUSTMENT`
type	`LOAN_FUNDED_ADJUSTMENT`
type	`LOAN_FRACTION_SOLD_ADJUSTMENT`
type	`DEPOSIT`
type	`LOAN_REPAID_ADJUSTMENT`
type	`FEE_REDUCTION_ADJUSTMENT`
type	`IMPORT`
type	`LOAN_FUNDED`
type	`TRANSFER_ADJUSTMENT`
type	`TRANSFER`
type	`LOAN_FRACTION_BOUGHT_ADJUSTMENT`
type	`WRITE_OFF`
type	`WITHDRAWAL_ADJUSTMENT`
type	`LOAN_FRACTION_BOUGHT`
type	`FEE_APPLIED`
type	`FEES_DUE_REDUCED`
type	`WITHHOLDING_TAX`
type	`CARD_TRANSACTION_REVERSAL`
type	`OVERDRAFT_LIMIT_CHANGED`
type	`INTEREST_APPLIED`
type	`INTEREST_APPLIED_ADJUSTMENT`
type	`ADJUSTMENT`
type	`WITHHOLDING_TAX_ADJUSTMENT`
type	`FEE_ADJUSTED`
type	`LOAN_REPAID`
type	`BRANCH_CHANGED`
type	`OVERDRAFT_INTEREST_RATE_CHANGED`
type	`WITHDRAWAL`
type	`INTEREST_RATE_CHANGED`

SortDetailsApiV1

{
  "dataFieldType": "string",
  "dataItemType": "string",
  "sortingColumn": "string",
  "sortingOrder": "string"
}

Properties

Name	Type	Description	Restrictions
dataFieldType	string	none	none
dataItemType	string	none	none
sortingColumn	string	none	none
sortingOrder	string	none	none

SummaryTotalsWrapperApiV1

{
  "customFieldValues": {
    "property1": {},
    "property2": {}
  },
  "dataItemType": "WRITTEN_OFF_LOANS",
  "values": {
    "property1": {},
    "property2": {}
  }
}

Properties

Name	Type	Description	Restrictions
customFieldValues	object	none	none
» additionalProperties	Object	none	none
dataItemType	string	none	none
values	object	none	none
» additionalProperties	Object	none	none

Enumerated Values

Property	Value
dataItemType	`WRITTEN_OFF_LOANS`
dataItemType	`LINE_OF_CREDIT`
dataItemType	`INVESTOR_FUND`
dataItemType	`TRANSACTION_DETAILS`
dataItemType	`DOCUMENT_TEMPLATE`
dataItemType	`PRODUCT`
dataItemType	`MCC_EXPIRATION`
dataItemType	`CENTRE`
dataItemType	`REPAYMENT_COLLECTION`
dataItemType	`TASK`
dataItemType	`OUTSTANDING_PORTFOLIO_AMOUNTS`
dataItemType	`REVENUE`
dataItemType	`COMPOSED_TRANSACTIONS`
dataItemType	`UNION_TRANSACTIONS`
dataItemType	`PRINCIPAL_PAYMENT_SETTINGS`
dataItemType	`LOANS`
dataItemType	`DISBURSEMENT_DETAILS`
dataItemType	`SAVINGS_TRANSACTION`
dataItemType	`IDENTIFICATION_DOCUMENT`
dataItemType	`LOAN_PRODUCT`
dataItemType	`DISBURSED_LOANS`
dataItemType	`LOAN_GROUP`
dataItemType	`TRANSACTION_CHANNEL`
dataItemType	`CUSTOM_PREDEFINED_FEE`
dataItemType	`JOURNAL_ENTRY`
dataItemType	`ATTACHMENT`
dataItemType	`PREDEFINED_FEE`
dataItemType	`TRANCHE`
dataItemType	`TRANSACTION`
dataItemType	`INDEX_RATE_SOURCE`
dataItemType	`GROUP_ROLE`
dataItemType	`LOAN_TRANSACTION`
dataItemType	`CLIENT_ROLE`
dataItemType	`GROUP`
dataItemType	`NOTIFICATION_MESSAGE`
dataItemType	`OUTSTANDING_PORTFOLIO_ACCOUNTS`
dataItemType	`REPAYMENT`
dataItemType	`LOAN_ACCOUNT_GUARANTY`
dataItemType	`BRANCH`
dataItemType	`CURRENCY`
dataItemType	`CARD_TRANSACTION_REVERSAL`
dataItemType	`INTEREST_PRODUCT_SETTINGS`
dataItemType	`CREATED_ACCOUNTS`
dataItemType	`USER`
dataItemType	`SAVINGS_PRODUCT`
dataItemType	`CLIENT`
dataItemType	`PRODUCT_ARREARS_SETTINGS`
dataItemType	`SAVINGS`
dataItemType	`EXPENSE`
dataItemType	`INDEX_RATE`
dataItemType	`NOTIFICATION_TEMPLATE`
dataItemType	`CUSTOM_FIELD_SELECTION`
dataItemType	`ACTIVITY`
dataItemType	`INTEREST_ACCRUAL_BREAKDOWN`

TaskApiV1

{
  "assignedUserKey": "string",
  "completionDate": "string",
  "createdByFullName": "string",
  "createdByUserKey": "string",
  "creationDate": "string",
  "daysUntilDue": 0,
  "description": "string",
  "dueDate": "string",
  "encodedKey": "string",
  "id": 0,
  "lastModifiedDate": "string",
  "status": "COMPLETED",
  "taskLinkKey": "string",
  "taskLinkName": "string",
  "taskLinkType": "BRANCH",
  "title": "string"
}

Properties

Name	Type	Description	Restrictions
assignedUserKey	string	the encoded key of the user to whom the task is assigned	none
completionDate	string	the date on which the task was marked as completed	none
createdByFullName	string	the full name of the Mambu user who created this task	none
createdByUserKey	string	the encoded key of the Mambu user who created the task	none
creationDate	string	the date on which the task was created	none
daysUntilDue	number	the number of days remaining until the task status will be set to `OVERDUE` if still incomplete	none
description	string	a rich text description of the task	none
dueDate	string	the date by which the task should be completed	none
encodedKey	string	the automatically generated encoded key of the task	none
id	number	the user provided ID of the task	none
lastModifiedDate	string	the date on which the task was last modified	none
status	string	the current status of the task	none
taskLinkKey	string	the encoded key of the entity associated with the task, for example, the client or account	none
taskLinkName	string	the name of the entity, for example client or user, linked to this task	none
taskLinkType	string	the type of entity linked to the task	none
title	string	the title of the task	none

Enumerated Values

Property	Value
status	`COMPLETED`
status	`OPEN`
status	`OVERDUE`
taskLinkType	`BRANCH`
taskLinkType	`LOAN_ACCOUNT`
taskLinkType	`GROUP`
taskLinkType	`DEPOSIT_ACCOUNT`
taskLinkType	`LINE_OF_CREDIT`
taskLinkType	`LOAN_PRODUCT`
taskLinkType	`GL_JOURNAL_ENTRY`
taskLinkType	`SAVINGS_PRODUCT`
taskLinkType	`USER`
taskLinkType	`CLIENT`
taskLinkType	`CENTRE`
taskLinkType	`ID_DOCUMENT`

TaskCreateApiV1

{
  "assignedUserKey": "string",
  "description": "string",
  "dueDate": "2019-08-24T14:15:22Z",
  "encodedKey": "string",
  "id": "string",
  "status": "OPEN",
  "taskLinkKey": "string",
  "taskLinkType": "CLIENT",
  "title": "string"
}

TaskCreateApiV1

Properties

Name	Type	Description	Restrictions
assignedUserKey (required)	string	The assigned user key.	none
description	string	The task description.	none
dueDate (required)	string(date-time)	The due date for the task.	none
encodedKey	string	EncodedKey of the task to update. If no key is provided a new Task will be created.	none
id	string	ID of the task. The parameter cannot be empty if the parameter itself is provided.	none
status	string	The task status.	none
taskLinkKey	string	The key of the client/group that is linked to this task. If null, means nobody is linked to this task. The parameter cannot be empty if the parameter itself is provided.	none
taskLinkType	string	The type of task link.	none
title (required)	string	The task title.	none

Enumerated Values

Property	Value
status	`OPEN`
status	`COMPLETED`
taskLinkType	`CLIENT`
taskLinkType	`GROUP`

TransactionChannelInTransactionDetailsApiV1

{
  "activated": true,
  "createdByUserKey": "string",
  "creationDate": "string",
  "customFields": [
    {
      "amounts": {
        "property1": 0,
        "property2": 0
      },
      "builtInCustomFieldId": "MOBILE_PHONE",
      "creationDate": "string",
      "customFieldProductSettings": [
        {
          "customFieldEncodedKey": "string",
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isDefault": true,
          "isRequired": true,
          "linkType": "CLIENT_ROLE",
          "productKey": "string"
        }
      ],
      "customFieldSelectionOptions": [
        {
          "constraint": {
            "customFieldKey": "string",
            "dataFieldType": "NATIVE",
            "dataFieldValue": "string",
            "dataItemType": "WRITTEN_OFF_LOANS",
            "dataType": "ENUM",
            "encodedKey": "string",
            "filterElement": "STARTS_WITH_CASE_SENSITIVE",
            "groupNumber": 0,
            "index": 0,
            "linkingOperator": "OR",
            "secondValue": "string",
            "value": "string"
          },
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "score": 0,
          "value": "string"
        }
      ],
      "customFieldSet": {
        "builtInType": "DETAILS",
        "createdDate": "string",
        "customFields": [
          {}
        ],
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "lastModifiedDate": "string",
        "name": "string",
        "notes": "string",
        "type": "USER_INFO",
        "usage": "SINGLE"
      },
      "dataType": "GROUP_LINK",
      "description": "string",
      "editRights": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "isAccessibleByAllUsers": true,
        "roles": [
          "string"
        ]
      },
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "id": "string",
      "indexInList": 0,
      "isDefault": true,
      "isRequired": true,
      "lastModifiedDate": "string",
      "name": "string",
      "state": "DEACTIVATED",
      "type": "USER_INFO",
      "unique": true,
      "validationPattern": "string",
      "valueLength": "SHORT",
      "values": [
        "string"
      ],
      "viewRights": {
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "isAccessibleByAllUsers": true,
        "roles": [
          "string"
        ]
      }
    }
  ],
  "encodedKey": "string",
  "id": "string",
  "index": 0,
  "loanConstraints": {
    "customConfigurationInfo": {
      "creationDate": "string",
      "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "lastModifiedDate": "string",
      "name": "string",
      "shared": true,
      "userKey": "string"
    },
    "encodedKey": "string",
    "filterConstraints": [
      {
        "customFieldKey": "string",
        "dataFieldType": "NATIVE",
        "dataFieldValue": "string",
        "dataItemType": "WRITTEN_OFF_LOANS",
        "dataType": "ENUM",
        "encodedKey": "string",
        "filterElement": "STARTS_WITH_CASE_SENSITIVE",
        "groupNumber": 0,
        "index": 0,
        "linkingOperator": "OR",
        "secondValue": "string",
        "value": "string"
      }
    ]
  },
  "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
  "name": "string",
  "savingsConstraints": {
    "customConfigurationInfo": {
      "creationDate": "string",
      "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "lastModifiedDate": "string",
      "name": "string",
      "shared": true,
      "userKey": "string"
    },
    "encodedKey": "string",
    "filterConstraints": [
      {
        "customFieldKey": "string",
        "dataFieldType": "NATIVE",
        "dataFieldValue": "string",
        "dataItemType": "WRITTEN_OFF_LOANS",
        "dataType": "ENUM",
        "encodedKey": "string",
        "filterElement": "STARTS_WITH_CASE_SENSITIVE",
        "groupNumber": 0,
        "index": 0,
        "linkingOperator": "OR",
        "secondValue": "string",
        "value": "string"
      }
    ]
  },
  "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
  "transactionChannelAccountingRule": {
    "account": {
      "activated": true,
      "allowManualJournalEntries": true,
      "balance": 0,
      "creationDate": "2019-08-24T14:15:22Z",
      "currency": {
        "code": "string",
        "creationDate": "string",
        "currencySymbolPosition": "AFTER_NUMBER",
        "digitsAfterDecimal": 0,
        "isBaseCurrency": true,
        "lastModifiedDate": "string",
        "name": "string",
        "symbol": "string"
      },
      "description": "string",
      "encodedKey": "string",
      "glCode": "string",
      "lastModifiedDate": "2019-08-24T14:15:22Z",
      "migrationEvent": {
        "creationDate": "2019-08-24T14:15:22Z",
        "encodedKey": "string",
        "numCentresImported": 0,
        "numClientsImported": 0,
        "numGLAccountsImported": 0,
        "numGroupsImported": 0,
        "numLoanRepaymentsImported": 0,
        "numLoanTransactionsImported": 0,
        "numLoansImported": 0,
        "numSavingsImported": 0,
        "state": "REVERTED",
        "type": "IMPORT"
      },
      "name": "string",
      "stripTrailingZeros": true,
      "type": "INCOME",
      "usage": "HEADER"
    },
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "financialResource": "FEE_RECEIVABLE",
    "index": 0,
    "predefinedFeeKey": "string",
    "productKey": "string",
    "productType": "LOAN",
    "transactionChannelKey": "string"
  },
  "usageRights": {
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "isAccessibleByAllUsers": true,
    "roles": [
      "string"
    ]
  }
}

Properties

Name	Type	Description	Restrictions
activated	boolean	whether this transaction channel is enabled	none
createdByUserKey	string	the encoded key of the user who created this transaction channel	none
creationDate	string	the date on which this transaction channel was created	none
customFields	[CustomFieldApiV1]	none	none
encodedKey	string	the encoded key for this transaction channel	none
id	string	the user specified ID for this transaction channel	none
index	number	none	none
loanConstraints	CustomFilterApiV1	none	none
loanConstraintsUsage	string	whether there are any rules regarding usage of this transaction channel with loan accounts	none
name	string	the name of this transaction channel	none
savingsConstraints	CustomFilterApiV1	none	none
savingsConstraintsUsage	string	whether there are any rules regarding usage of this transaction channel with savings accounts	none
transactionChannelAccountingRule	GLAccountingRuleApiV1	none	none
usageRights	UsageRightsApiV1	none	none

Enumerated Values

Property	Value
loanConstraintsUsage	`UNCONSTRAINED_USAGE`
loanConstraintsUsage	`LIMITED_USAGE`
savingsConstraintsUsage	`UNCONSTRAINED_USAGE`
savingsConstraintsUsage	`LIMITED_USAGE`

TransactionDetailsApiV1

{
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "internalTransfer": true,
  "targetSavingsAccountKey": "string",
  "transactionChannel": {
    "activated": true,
    "createdByUserKey": "string",
    "creationDate": "string",
    "customFields": [
      {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      }
    ],
    "encodedKey": "string",
    "id": "string",
    "index": 0,
    "loanConstraints": {
      "customConfigurationInfo": {
        "creationDate": "string",
        "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexInList": 0,
        "lastModifiedDate": "string",
        "name": "string",
        "shared": true,
        "userKey": "string"
      },
      "encodedKey": "string",
      "filterConstraints": [
        {
          "customFieldKey": "string",
          "dataFieldType": "NATIVE",
          "dataFieldValue": "string",
          "dataItemType": "WRITTEN_OFF_LOANS",
          "dataType": "ENUM",
          "encodedKey": "string",
          "filterElement": "STARTS_WITH_CASE_SENSITIVE",
          "groupNumber": 0,
          "index": 0,
          "linkingOperator": "OR",
          "secondValue": "string",
          "value": "string"
        }
      ]
    },
    "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
    "name": "string",
    "savingsConstraints": {
      "customConfigurationInfo": {
        "creationDate": "string",
        "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "indexInList": 0,
        "lastModifiedDate": "string",
        "name": "string",
        "shared": true,
        "userKey": "string"
      },
      "encodedKey": "string",
      "filterConstraints": [
        {
          "customFieldKey": "string",
          "dataFieldType": "NATIVE",
          "dataFieldValue": "string",
          "dataItemType": "WRITTEN_OFF_LOANS",
          "dataType": "ENUM",
          "encodedKey": "string",
          "filterElement": "STARTS_WITH_CASE_SENSITIVE",
          "groupNumber": 0,
          "index": 0,
          "linkingOperator": "OR",
          "secondValue": "string",
          "value": "string"
        }
      ]
    },
    "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
    "transactionChannelAccountingRule": {
      "account": {
        "activated": true,
        "allowManualJournalEntries": true,
        "balance": 0,
        "creationDate": "2019-08-24T14:15:22Z",
        "currency": {
          "code": "string",
          "creationDate": "string",
          "currencySymbolPosition": "AFTER_NUMBER",
          "digitsAfterDecimal": 0,
          "isBaseCurrency": true,
          "lastModifiedDate": "string",
          "name": "string",
          "symbol": "string"
        },
        "description": "string",
        "encodedKey": "string",
        "glCode": "string",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "migrationEvent": {
          "creationDate": "2019-08-24T14:15:22Z",
          "encodedKey": "string",
          "numCentresImported": 0,
          "numClientsImported": 0,
          "numGLAccountsImported": 0,
          "numGroupsImported": 0,
          "numLoanRepaymentsImported": 0,
          "numLoanTransactionsImported": 0,
          "numLoansImported": 0,
          "numSavingsImported": 0,
          "state": "REVERTED",
          "type": "IMPORT"
        },
        "name": "string",
        "stripTrailingZeros": true,
        "type": "INCOME",
        "usage": "HEADER"
      },
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "financialResource": "FEE_RECEIVABLE",
      "index": 0,
      "predefinedFeeKey": "string",
      "productKey": "string",
      "productType": "LOAN",
      "transactionChannelKey": "string"
    },
    "usageRights": {
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "isAccessibleByAllUsers": true,
      "roles": [
        "string"
      ]
    }
  },
  "transactionChannelKey": "string"
}

Properties

Name	Type	Description	Restrictions
encodedKey	string	the automatically generated encoded ID for this item	none
internalTransfer	boolean	none	none
targetSavingsAccountKey	string	none	none
transactionChannel	TransactionChannelInTransactionDetailsApiV1	none	none
transactionChannelKey	string	none	none

UpdateClientRequest

{
  "client": {
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "birthDate": "string",
    "clientRoleId": "string",
    "emailAddress": "string",
    "firstName": "string",
    "gender": "MALE",
    "homePhone": "string",
    "id": "string",
    "lastName": "string",
    "middleName": "string",
    "mobilePhone1": "string",
    "notes": "string",
    "preferredLanguage": "PORTUGESE",
    "state": "PENDING_APPROVAL"
  }
}

Properties

Name	Type	Description	Restrictions
client	ClientOnUpdate	none	none

UpdateCustomInformationRequest

{
  "customInformation": [
    {
      "customFieldID": "string",
      "customFieldSetGroupIndex": 0,
      "value": "string"
    }
  ]
}

Properties

Name	Type	Description	Restrictions
customInformation	[CustomFieldValueOnUpdate]	none	none

UsageRightsApiV1

{
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "isAccessibleByAllUsers": true,
  "roles": [
    "string"
  ]
}

Properties

Name	Type	Description	Restrictions
encodedKey	string	the automatically generated encoded ID for this item	none
isAccessibleByAllUsers	boolean	none	none
roles	[string]	none	none

UserApiV1

{
  "accessRights": [
    "MAMBU"
  ],
  "apiConsumerType": "PAYMENTS",
  "assignedBranchKey": "string",
  "creationDate": "string",
  "customFields": [
    {
      "amount": 0,
      "customField": {
        "amounts": {
          "property1": 0,
          "property2": 0
        },
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "email": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "failedLoginsCount": 0,
  "failedLoginsDates": [
    "string"
  ],
  "firstName": "string",
  "homePhone": "string",
  "id": 0,
  "isAdministrator": true,
  "isCreditOfficer": true,
  "isSupport": true,
  "isTeller": true,
  "language": "PORTUGESE",
  "lastLoggedInDate": "string",
  "lastModifiedDate": "string",
  "lastName": "string",
  "managedBranches": [
    {
      "branchKey": "string",
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0
    }
  ],
  "mobilePhone1": "string",
  "notes": "string",
  "permissions": {
    "canManageAllBranches": true,
    "canManageEntitiesAssignedToOtherOfficers": true,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "permissions": [
      "CREATE_INVESTOR_FUNDS"
    ]
  },
  "provisionedThroughFederation": true,
  "role": {
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "id": "string"
  },
  "title": "string",
  "transactionLimits": {
    "property1": {
      "amount": 0
    },
    "property2": {
      "amount": 0
    }
  },
  "twoFactorAuthentication": true,
  "userState": "LOCKED",
  "username": "string"
}

Properties

Name	Type	Description	Restrictions
accessRights	[string]	none	none
apiConsumerType	string	none	none
assignedBranchKey	string	none	none
creationDate	string	the date and time when this user was created	none
customFields	[CustomFieldValueApiV1]	none	none
email	string	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
failedLoginsCount	number	none	none
failedLoginsDates	[string]	none	none
firstName	string	none	none
homePhone	string	none	none
id	number	none	none
isAdministrator	boolean	none	none
isCreditOfficer	boolean	none	none
isSupport	boolean	none	none
isTeller	boolean	none	none
language	string	none	none
lastLoggedInDate	string	none	none
lastModifiedDate	string	the date on which this user was last modified	none
lastName	string	none	none
managedBranches	[UserManagedBranchApiV1]	none	none
mobilePhone1	string	none	none
notes	string	none	none
permissions	PermissionsApiV1	none	none
provisionedThroughFederation	boolean	none	none
role	EncodedKeyAndIdRoleApiV1	none	none
title	string	none	none
transactionLimits	object	none	none
» additionalProperties	MoneyApiV1	none	none
twoFactorAuthentication	boolean	none	none
userState	string	none	none
username	string	none	none

Enumerated Values

Property	Value
apiConsumerType	`PAYMENTS`
apiConsumerType	`AUDIT_TRAIL`
apiConsumerType	`MAMBU_API`
apiConsumerType	`STREAMING_API`
language	`PORTUGESE`
language	`RUSSIAN`
language	`ROMANIAN`
language	`ENGLISH`
language	`SPANISH`
language	`GEORGIAN`
language	`BURMESE`
language	`PHRASE`
language	`CHINESE`
language	`FRENCH`
language	`INDONESIAN`
userState	`LOCKED`
userState	`ACTIVE`
userState	`INACTIVE`

UserCreateApiV1

{
  "customInformation": [
    {
      "customFieldId": "string",
      "customFieldSetGroupIndex": "string",
      "value": "string"
    }
  ],
  "user": {
    "assignedBranchKey": "string",
    "email": "user@example.com",
    "firstName": "string",
    "homePhone": "string",
    "language": "ENGLISH",
    "lastName": "string",
    "managedBranched": [
      {
        "branchKey": "string",
        "encodedKey": "8a19b7057471f4af017472dc0fd80472"
      }
    ],
    "mobilePhone1": "string",
    "notes": "string",
    "password": "string",
    "permissions": {
      "canManageAllBranches": true,
      "canManageEntitiesAssignedToOtherOfficers": true
    },
    "role": {
      "encodedKey": "string"
    },
    "title": "string",
    "transactionLimits": {
      "APPLY_FEE": {
        "amount": "string"
      },
      "APPROVE_LOAN": {
        "amount": "string"
      },
      "DISBURSE_LOAN": {
        "amount": "string"
      },
      "MAKE_DEPOSIT": {
        "amount": "string"
      },
      "MAKE_REPAYMENT": {
        "amount": "string"
      },
      "MAKE_WITHDRAWAL": {
        "amount": "string"
      }
    },
    "twoFactorAuthentication": true,
    "username": "string"
  }
}

UserCreateApiV1

Properties

Name	Type	Description	Restrictions
customInformation	[object]	List of custom field values for the user to be created.	none
» customFieldId	string	none	none
» customFieldSetGroupIndex	string	none	none
» value	string	none	none
user	object	none	none
» assignedBranchKey	string	User's assigned branch (encodedKey). Required if the user is a teller or credit officer.	none
» email	string(email)	User's email address. Must be valid.	none
» firstName	string	User's first name.	none
» homePhone	string	User's home phone.	none
» language	string	User's language, defaults to `ENGLISH` if not specified.	none
» lastName	string	User's last name.	none
» managedBranched	[object]	List of user's managed branched (with encoded keys).	none
»» branchKey	string	none	none
»» encodedKey	string	the automatically generated encoded ID for this item	none
» mobilePhone1	string	User's mobile phone number.	none
» notes	string	Notes for the user to be created.	none
» password	string	User's password. Must respect security restrictions defined in Mambu.	none
» permissions	object	none	none
»» canManageAllBranches (required)	boolean	States whether the user has access to all the branches in the application.	none
»» canManageEntitiesAssignedToOtherOfficers (required)	boolean	States whether the user has access to entities assigned to other credit officers.	none
» role	object	none	none
»» encodedKey (required)	string	The encoded key of the role to create the user with.	none
» title	string	User's title (Eg. Mr.).	none
» transactionLimits	object	Map specifying user transaction limits for various operations.	none
»» APPLY_FEE	object	none	none
»»» amount	string	none	none
»» APPROVE_LOAN	object	none	none
»»» amount	string	none	none
»» DISBURSE_LOAN	object	none	none
»»» amount	string	none	none
»» MAKE_DEPOSIT	object	none	none
»»» amount	string	none	none
»» MAKE_REPAYMENT	object	none	none
»»» amount	string	none	none
»» MAKE_WITHDRAWAL	object	none	none
»»» amount	string	none	none
» twoFactorAuthentication	boolean	Whether the user will use two factor authentication when logging in the application.	none
» username	string	User identifier used for accessing Mambu.	none

Enumerated Values

Property	Value
language	`ENGLISH`
language	`PORTUGESE`
language	`SPANISH`
language	`RUSSIAN`
language	`FRENCH`
language	`GEORGIAN`
language	`CHINESE`
language	`INDONESIAN`
language	`ROMANIAN`

UserManagedBranchApiV1

{
  "branchKey": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "indexInList": 0
}

Properties

Name	Type	Description	Restrictions
branchKey	string	none	none
encodedKey	string	the automatically generated encoded ID for this item	none
indexInList	number	none	none

activity

{
  "activity": {
    "activityChanges": [
      null
    ],
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "branchKey": "string",
    "centreKey": "string",
    "clientKey": "string",
    "encodedKey": "string",
    "fieldChanges": [
      {
        "fieldChangeName": "string",
        "fieldDetailKey": "string",
        "fieldDetailName": "string",
        "id": 0,
        "newValue": "string",
        "originalValue": "string"
      }
    ],
    "glAccountKey": "string",
    "glAccountsClosureKey": "string",
    "groupKey": "string",
    "lineOfCreditKey": "string",
    "loanAccountKey": "string",
    "loanProductKey": "string",
    "notes": "string",
    "savingsAccountKey": "string",
    "savingsProductKey": "string",
    "taskKey": "string",
    "timestamp": "string",
    "transactionID": 0,
    "type": "BRANCH_CREATED",
    "userKey": "string"
  },
  "branchName": "string",
  "centreName": "string",
  "clientName": "string",
  "groupName": "string",
  "loanAccountName": "string",
  "loanProductName": "string",
  "savingsAccountName": "string",
  "savingsProductName": "string",
  "taskName": "string",
  "userName": "string"
}

activity

Properties

Name	Type	Description	Restrictions
activity	object	an object containing details about the activity	none
» activityChanges	[any]	none	none
» assignedCentreKey	string	the encoded key of the centre an account associated with this activity is assigned to	none
» assignedUserKey	string	the encoded key of the user assigned to a task or account associated with this activity	none
» branchKey	string	the encoded key fo the branch associated with this activity	none
» centreKey	string	the encoded key of the centre associated with this activity	none
» clientKey	string	the key for the client associated with this activity	none
» encodedKey (required)	string	a unique key for this activity	none
» fieldChanges	[object]	an array of field changes detailing any fields which were updated or created by this activity	none
»» fieldChangeName	string	The name of the field which changed, note that if the field is a custom field definition this field will indicate `CUSTOM_FIELD_VALUE`, in this case the name of the custom field definition will be given on the `fieldDetailName` key.	none
»» fieldDetailKey	string	the encoded key of the custom field definition which changed	none
»» fieldDetailName	string	the name of the custom field definition that changed	none
»» id	integer	an ID for this change	none
»» newValue	string	the new value of the field	none
»» originalValue	string	the previous value of the field	none
» glAccountKey	string	the encoded key of the general ledger account associated with this activity	none
» glAccountsClosureKey	string	the encoded key of the accounting closure associated with this activity	none
» groupKey	string	the encoded key of the group associated with this activity	none
» lineOfCreditKey	string	the encoded key of the line of credit associated with this activity	none
» loanAccountKey	string	the encoded key of the loan account associated with this activity	none
» loanProductKey	string	the encoded key of the loan product associated with this activity	none
» notes	string	some notes about the activity	none
» savingsAccountKey	string	the encoded key of the savings account assoicated with this activity	none
» savingsProductKey	string	the encoded key of the savings product associated with this activity	none
» taskKey	string	the encoded key of the task associated with this activity	none
» timestamp (required)	string(timestamp)	the time at which the activity took place	none
» transactionID	integer	an ID for this activity	none
» type (required)	activityType	The types of activity which are recorded by the system	none
» userKey	string	the encoded key of the Mambu user associated with this activity	none
branchName	string	the name of the branch the activity concerns	none
centreName	string	the name of the centre the activity concerns	none
clientName	string	the name of the client the activity concerns	none
groupName	string	the name of the group the activity concerns	none
loanAccountName	string	the name of the loan account the activity concerns	none
loanProductName	string	the name of the loan product the activity concerns	none
savingsAccountName	string	the name of the savings account the activity concerns	none
savingsProductName	string	the name of the savings product the activity concerns	none
taskName	string	the name of the task the activity concerns	none
userName	string	the name of the user the activity concerns	none

activityType

"BRANCH_CREATED"

The types of activity which are recorded by the system

Properties

Name	Type	Description	Restrictions
*anonymous*	string	The types of activity which are recorded by the system	none

Enumerated Values

Property	Value
anonymous	`BRANCH_CREATED`
anonymous	`BRANCH_COMMENT_ADDED`
anonymous	`BRANCH_COMMENT_EDITED`
anonymous	`BRANCH_COMMENT_DELETED`
anonymous	`BRANCH_EDITED`
anonymous	`BRANCH_DELETED`
anonymous	`CENTRE_CREATED`
anonymous	`CENTRE_COMMENT_ADDED`
anonymous	`CENTRE_COMMENT_EDITED`
anonymous	`CENTRE_COMMENT_DELETED`
anonymous	`CENTRE_EDITED`
anonymous	`CENTRE_DELETED`
anonymous	`CLIENT_CREATED`
anonymous	`CLIENT_COMMENT_ADDED`
anonymous	`CLIENT_COMMENT_EDITED`
anonymous	`CLIENT_COMMENT_DELETED`
anonymous	`CLIENT_EDITED`
anonymous	`CLIENT_DELETED`
anonymous	`CLIENT_BRANCH_ASSIGNMENT`
anonymous	`CLIENT_BRANCH_UNASSIGNMENT`
anonymous	`CLIENT_CENTRE_ASSIGNMENT`
anonymous	`CLIENT_CENTRE_UNASSIGNMENT`
anonymous	`CLIENT_CREDIT_OFFICER_ASSIGNMENT`
anonymous	`CLIENT_CREDIT_OFFICER_UNASSIGNMENT`
anonymous	`CLIENT_SET_TO_PENDING`
anonymous	`CLIENT_SET_TO_ACTIVE`
anonymous	`CLIENT_SET_TO_INACTIVE`
anonymous	`CLIENT_SET_TO_BLACKLISTED`
anonymous	`CLIENT_SET_TO_REJECTED`
anonymous	`CLIENT_SET_TO_EXITED`
anonymous	`DATA_IMPORTED`
anonymous	`DATA_IMPORT_APPROVED`
anonymous	`DATA_IMPORT_REVERTED`
anonymous	`DOCUMENT_CREATED`
anonymous	`DOCUMENT_EDITED`
anonymous	`DOCUMENT_DELETED`
anonymous	`PRODUCT_DOCUMENT_TEMPLATE_CREATED`
anonymous	`PRODUCT_DOCUMENT_TEMPLATE_DELETED`
anonymous	`PRODUCT_DOCUMENT_TEMPLATE_EDITED`
anonymous	`FEDERATED_AUTHENTICATION_SETTINGS_EDITED`
anonymous	`ENTITY_CREATED`
anonymous	`ENTITY_EDITED`
anonymous	`ENTITY_DELETED`
anonymous	`GLACCOUNT_CREATED`
anonymous	`GLACCOUNT_EDITED`
anonymous	`GLACCOUNT_DELETED`
anonymous	`GLACCOUNTSCLOSURE_EXECUTED`
anonymous	`GLACCOUNTSCLOSURE_UNDONE`
anonymous	`CLIENT_JOINED_GROUP`
anonymous	`CLIENT_LEFT_GROUP`
anonymous	`GROUP_CREATED`
anonymous	`GROUP_COMMENT_ADDED`
anonymous	`GROUP_COMMENT_EDITED`
anonymous	`GROUP_COMMENT_DELETED`
anonymous	`GROUP_EDITED`
anonymous	`GROUP_DELETED`
anonymous	`GROUP_BRANCH_ASSIGNMENT`
anonymous	`GROUP_BRANCH_UNASSIGNMENT`
anonymous	`GROUP_CENTRE_ASSIGNMENT`
anonymous	`GROUP_CENTRE_UNASSIGNMENT`
anonymous	`GROUP_CREDIT_OFFICER_ASSIGNMENT`
anonymous	`GROUP_CREDIT_OFFICER_UNASSIGNMENT`
anonymous	`GROUP_SMS_MESSAGE_SENT`
anonymous	`GROUP_EMAIL_MESSAGE_SENT`
anonymous	`HOLIDAY_SETTINGS_CHANGED`
anonymous	`LINE_OF_CREDIT_CREATED`
anonymous	`LINE_OF_CREDIT_EDITED`
anonymous	`LINE_OF_CREDIT_DELETED`
anonymous	`ACCOUNT_ADDED_TO_LINE_OF_CREDIT`
anonymous	`ACCOUNT_REMOVED_FROM_LINE_OF_CREDIT`
anonymous	`LINE_OF_CREDIT_CLOSED`
anonymous	`LINE_OF_CREDIT_REOPENED`
anonymous	`LINE_OF_CREDIT_APPROVED`
anonymous	`LINE_OF_CREDIT_SET_TO_PENDING_APPROVAL`
anonymous	`LINE_OF_CREDIT_WITHDRAW`
anonymous	`LINE_OF_CREDIT_REJECT`
anonymous	`LOAN_ACCOUNT_CREATED`
anonymous	`LOAN_ACCOUNT_COMMENT_ADDED`
anonymous	`LOAN_ACCOUNT_COMMENT_EDITED`
anonymous	`LOAN_ACCOUNT_COMMENT_DELETED`
anonymous	`LOAN_ACCOUNT_EDITED`
anonymous	`LOAN_ACCOUNT_SET_TO_PARTIAL`
anonymous	`LOAN_ACCOUNT_SET_TO_PENDING_APPROVAL`
anonymous	`LOAN_ACCOUNT_SET_TO_APPROVED`
anonymous	`LOAN_ACCOUNT_SET_TO_CLOSED_CANCELLED`
anonymous	`LOAN_ACCOUNT_SET_TO_CLOSED_REJECTED`
anonymous	`LOAN_ACCOUNT_SET_TO_CLOSED_REFINANCED`
anonymous	`LOAN_ACCOUNT_SET_TO_CLOSED_RESCHEDULED`
anonymous	`LOAN_ACCOUNT_SET_TO_CLOSED_WRITTEN_OFF`
anonymous	`LOAN_ACCOUNT_SET_TO_ACTIVE`
anonymous	`LOAN_ACCOUNT_DISBURSED`
anonymous	`TRANCHE_DISBURSED`
anonymous	`TRANCHE_REVERSED`
anonymous	`LOAN_ACCOUNT_SET_TO_IN_ARREARS`
anonymous	`LOAN_ACCOUNT_DELETED`
anonymous	`LOAN_GROUP_DELETED`
anonymous	`LINKED_LOAN_ACCOUNT`
anonymous	`UNLINKED_LOAN_ACCOUNT`
anonymous	`LOAN_ACCOUNT_PAYED_OFF`
anonymous	`LOAN_ACCOUNT_LOCKED`
anonymous	`LOAN_ACCOUNT_UNLOCKED`
anonymous	`LOAN_ACCOUNT_LOCKED_OPERATIONS_EDITED`
anonymous	`LOAN_ACCOUNT_LOCKED_CAPPING`
anonymous	`LOAN_ACCOUNT_BRANCH_ASSIGNMENT`
anonymous	`LOAN_ACCOUNT_BRANCH_UNASSIGNMENT`
anonymous	`LOAN_ACCOUNT_CENTRE_ASSIGNMENT`
anonymous	`LOAN_ACCOUNT_CENTRE_UNASSIGNMENT`
anonymous	`LOAN_ACCOUNT_CREDIT_OFFICER_ASSIGNMENT`
anonymous	`LOAN_ACCOUNT_CREDIT_OFFICER_UNASSIGNMENT`
anonymous	`LOAN_ACCOUNT_SET_TO_CLOSED_OBLIGATIONS_MET`
anonymous	`LOAN_SCHEDULE_EDITED`
anonymous	`LOAN_PRODUCT_CREATED`
anonymous	`LOAN_PRODUCT_COMMENT_ADDED`
anonymous	`LOAN_PRODUCT_COMMENT_EDITED`
anonymous	`LOAN_PRODUCT_COMMENT_DELETED`
anonymous	`LOAN_PRODUCT_EDITED`
anonymous	`LOAN_PRODUCT_DEACTIVATED`
anonymous	`LOAN_PRODUCT_ACTIVATED`
anonymous	`LOAN_PRODUCT_DELETED`
anonymous	`ORGANIZATION_SETTINGS_CHANGED`
anonymous	`PORTAL_ACTIVATED`
anonymous	`PORTAL_DEACTIVATED`
anonymous	`PORTAL_EDITED`
anonymous	`SAVINGS_PRODUCT_CREATED`
anonymous	`SAVINGS_PRODUCT_COMMENT_ADDED`
anonymous	`SAVINGS_PRODUCT_COMMENT_EDITED`
anonymous	`SAVINGS_PRODUCT_COMMENT_DELETED`
anonymous	`SAVINGS_PRODUCT_EDITED`
anonymous	`SAVINGS_PRODUCT_ACTIVATED`
anonymous	`SAVINGS_PRODUCT_DEACTIVATED`
anonymous	`SAVINGS_PRODUCT_DELETED`
anonymous	`SAVING_ACCOUNT_CREATED`
anonymous	`SAVINGS_ACCOUNT_COMMENT_ADDED`
anonymous	`SAVINGS_ACCOUNT_COMMENT_EDITED`
anonymous	`SAVINGS_ACCOUNT_COMMENT_DELETED`
anonymous	`SAVING_ACCOUNT_EDITED`
anonymous	`SAVINGS_ACCOUNT_APPROVED`
anonymous	`SAVINGS_ACCOUNT_ACTIVATED`
anonymous	`SAVINGS_ACCOUNT_CLOSED_WITHDRAWN`
anonymous	`SAVINGS_ACCOUNT_CLOSED_REJECTED`
anonymous	`SAVINGS_ACCOUNT_CLOSED`
anonymous	`SAVINGS_ACCOUNT_MATURED`
anonymous	`SAVINGS_ACCOUNT_SET_TO_PENDING`
anonymous	`SAVINGS_ACCOUNT_MATURITY_SET`
anonymous	`SAVINGS_ACCOUNT_MATURITY_UNSET`
anonymous	`SAVINGS_ACCOUNT_SET_TO_ARREARS`
anonymous	`SAVINGS_ACCOUNT_WRITEN_OFF`
anonymous	`SAVINGS_ACCOUNT_SET_TO_LOCKED`
anonymous	`SAVINGS_ACCOUNT_DELETED`
anonymous	`SAVINGS_ACCOUNT_SET_TO_DORMANT`
anonymous	`SAVINGS_ACCOUNT_UNDO_DORMANT`
anonymous	`SMS_MESSAGE_SENT`
anonymous	`CLIENT_EMAIL_MESSAGE_SENT`
anonymous	`TASK_CREATED`
anonymous	`TASK_EDITED`
anonymous	`TASK_DELETED`
anonymous	`TASK_COMPLETED`
anonymous	`TASK_UNCOMPLETED`
anonymous	`LOAN_TRANSACTION_EDITED`
anonymous	`SAVINGS_TRANSACTION_EDITED`
anonymous	`USER_CREATED`
anonymous	`USER_EDITED`
anonymous	`USER_DELETED`
anonymous	`USER_COMMENT_ADDED`
anonymous	`USER_COMMENT_EDITED`
anonymous	`USER_COMMENT_DELETED`
anonymous	`USER_LOGGED_IN`
anonymous	`USER_BRANCH_ASSIGNMENT`
anonymous	`USER_BRANCH_UNASSIGNMENT`
anonymous	`USER_LOCKED`

filters

{
  "dataFieldType": "string",
  "dataItemType": "string",
  "filterElement": "string",
  "filterSelection": "string",
  "secondValue": "string",
  "value": "string"
}

filters

Properties

Name	Type	Description	Restrictions
dataFieldType	string	`NATIVE`(default)/`CUSTOM` for custom field searches	none
dataItemType	string	The entity where the field on which to apply the constraint is located. If the field is located in the same entity with the entity being searched, this field is optional.	none
filterElement	string	The constraint operator. Available filter elements can be found above.	none
filterSelection	string	The field on which the constraint will be applied. For custom fields, the custom field definition encoded key must be provided.	none
secondValue	string	The constraint second value. Required for filter elements with two values.	none
value	string	The constraint value. Required for filter elements with one or two values.	none

glAccountMinimal

{
  "activated": true,
  "allowManualJournalEntries": true,
  "creationDate": "2019-08-24T14:15:22Z",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "glCode": "string",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "name": "string",
  "stripTrailingZeroes": true,
  "type": "ASSET",
  "usage": "DETAIL"
}

glAccountMinimal

Properties

Name	Type	Description	Restrictions
activated	boolean	field indicating whether this general ledger account is available for use	none
allowManualJournalEntries	boolean	whether Mambu users can create manual journal entries using this account, if set to false, only automatic journal entries generated by movements into and out of loan and savings accounts can be associated with this account	none
creationDate	string(date-time)	the date and time when this general ledger account was created	none
encodedKey	string	the automatically generated encoded ID for this general ledger account	none
glCode	string	the numeric code for this general ledger account	none
lastModifiedDate	string(date-time)	the date on which this general ledger account was last modified	none
name	string	the name of this general ledger account	none
stripTrailingZeroes	boolean	controls how this account is organized into header accounts when there are trailing zeroes, for example, for the account code `1100`, if this field is set to true, only the first two numbers will be recognised	none
type	string	the category represented by amounts in this general ledger account, eg. `EXPENSE`, `INCOME`, `LIABILITY`, etc.	none
usage	string	the kind of general ledger account. `DETAIL` accounts hold their own value, `HEADER` accounts derive their value from the sum of detail accounts below them	none

Enumerated Values

Property	Value
type	`ASSET`
type	`LIABILITY`
type	`EQUITY`
type	`INCOME`
type	`EXPENSE`
usage	`DETAIL`
usage	`HEADER`

glJournalEntry

{
  " notes": "string",
  "amount": "string",
  "bookingDate": "2019-08-24T14:15:22Z",
  "creationDate": "2019-08-24T14:15:22Z",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "entryDate": "2019-08-24T14:15:22Z",
  "entryID": 0,
  "glAccount": {
    "activated": true,
    "allowManualJournalEntries": true,
    "creationDate": "2019-08-24T14:15:22Z",
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "glCode": "string",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "name": "string",
    "stripTrailingZeroes": true,
    "type": "ASSET",
    "usage": "DETAIL"
  },
  "transactionID": "string",
  "type": "DEBIT",
  "userKey": "string"
}

glJournalEntry

Properties

Name	Type	Description	Restrictions
notes	string	any notes relating to this journal entry	none
amount	string	the amount, in organization base currency, represented by this journal entry	none
bookingDate	string(date-time)	the date on which this entry was recognised on the ledger	none
creationDate	string(date-time)	the date and time when this journal entry was created	none
encodedKey	string	the automatically generated encoded ID for this item	none
entryDate	string(date-time)	the date on which thie entry was added to the ledger	none
entryID	integer	the ID for this journal entry	none
glAccount	glAccountMinimal	none	none
transactionID	string	the ID of the original transaction that generated this Journal Entry	none
type	string	the type of Journal Entry, ie. income or outgoing	none
userKey	string	the encoded key of the user who added this Journal Entry	none

Enumerated Values

Property	Value
type	`DEBIT`
type	`CREDIT`

indexInterestRate.v1

{
  "encodedKey": "string",
  "rate": "string",
  "rateSource": {
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "name": "string",
    "notes": "string",
    "type": "INTEREST_RATE"
  },
  "startDate": "2019-08-24T14:15:22Z",
  "userkey": "string"
}

indexInterestRate.v1

Properties

Name	Type	Description	Restrictions
encodedKey	string	the unique ID for this item	none
rate	string	the percentage charged for this interest or tax rate	none
rateSource	object	the type of rate, ie. an interest or tax rate	none
» encodedKey	string	the automatically generated encoded ID for this item	none
» name	string	the name of this rate source	none
» notes	string	any notes relating to the source of this rate	none
» type	string	none	none
startDate	string(date-time)	the first day on which this rate was valid	none
userkey	string	the encoded key of the user who added this index rate	none

Enumerated Values

Property	Value
type	`INTEREST_RATE`
type	`WITHHOLDING_TAX_RATE`
type	`TAX_RATE`

nonWorkingDays

{
  "creationDate": "string",
  "dayOfWeek": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472"
}

nonWorkingDays

Properties

Name	Type	Description	Restrictions
creationDate	string	the date and time when this non-working day was created	none
dayOfWeek	string	the day of the week, eg. `MONDAY`, `SUNDAY`	none
encodedKey	string	the automatically generated encoded ID for this item	none

notification

{
  "body": "string",
  "clientKey": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "destination": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "event": "string",
  "failureCause": "string",
  "failureReason": "string",
  "numRetries": 0,
  "sendDate": "2019-08-24T14:15:22Z",
  "state": "SENT",
  "templateKey": "string",
  "type": "EMAIL"
}

notification

Properties

Name	Type	Description	Restrictions
body	string	the actual content of the notification	none
clientKey	string	the encoded key of the client for whom the notification was intended	none
creationDate	string(date-time)	the date and time when this notification was created	none
destination	string	the target of the notification. for webhooks this will contain the destination endpoint URL, for emails, the email address of the recipient	none
encodedKey	string	the automatically generated encoded ID for this item	none
event	string	the event which triggered the notification, eg. `CLIENT_CREATED`, only for automated notifications	none
failureCause	string	if the message failed to send this will contain the http response code and message body, formatted as a JSON encoded string, received by the system.	none
failureReason	string	in cases of failure, this field will contain a reason derived from the http response, eg `INVALID_HTTP_RESPONSE`	none
numRetries	integer	the count of retries if the notifaction failed to be sent	none
sendDate	string(date-time)	the timestamp of when the notification was sent	none
state	string	indicates the status of the notification	none
templateKey	string	the encoded key of the template which was used to construct this notification	none
type	string	indicates which messaging channel was used for the notification, eg. `EMAIL`, `SMS`	none

Enumerated Values

Property	Value
state	`SENT`
state	`QUEUED`
state	`QUEUED_FOR_STREAM`
state	`SENDING_ASYNC`
state	`FAILED`
type	`EMAIL`
type	`SMS`
type	`WEB_HOOK`
type	`EVENT_STREAM`
type	`TASK`

role

{
  "accessRights": [
    "APIS"
  ],
  "creationDate": "2019-08-24T14:15:22Z",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "id": "string",
  "isAdministrator": true,
  "isCreditOfficer": true,
  "isDelivery": true,
  "isSupport": true,
  "isTeller": true,
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "name": "string",
  "permissions": {
    "canManageAllBranches": true,
    "canManageEntitiesAssignedToOtherOfficers": true,
    "encodedKey": "8a19b7057471f4af017472dc0fd80472",
    "permissions": [
      "string"
    ]
  }
}

role

Properties

Name	Type	Description	Restrictions
accessRights (required)	[string]	defines whether the user can access the UI, the API, or both.	none
creationDate (required)	string(date-time)	the date and time when this role was created	none
encodedKey (required)	string	the automatically generated encoded ID for this item	none
id (required)	string	the ID for this role	none
isAdministrator (required)	boolean	whether this role is for an administrator. Please note if this option is selected, the user will have blanket access, it is not possible to restict access for administrators using the permissions object.	none
isCreditOfficer (required)	boolean	whether this role represents a credit/loan officer type of user	none
isDelivery	boolean	whether this role relates to Mambu delivery users. Delivery teams need have accounts to assist you during the intitial setup stage, which will be disabled when you start using Mambu in production	none
isSupport (required)	boolean	whether this is a role for Mambu support users. Mambu users may, on request, be granted access to your system in order to troubleshoot problems	none
isTeller (required)	boolean	whether this role is for a 'teller' type user who will manage tills	none
lastModifiedDate (required)	string(date-time)	the date on which this role was last modified	none
name (required)	string	the name of this role	none
permissions (required)	object	none	none
» canManageAllBranches (required)	boolean	indicates whether the user can manage all branches or only they one they are assigned to	none
» canManageEntitiesAssignedToOtherOfficers (required)	boolean	indicates whether the user can edit clients and accounts which are assigned to other Mambu users	none
» encodedKey (required)	string	the automatically generated encoded ID for this item	none
» permissions (required)	[string]	a list of permissions	none

search-result

{
  "displayString": "string",
  "resultID": "string",
  "resultKey": "string",
  "selectionType": "string"
}

search-result

Properties

Name	Type	Description	Restrictions
displayString	string	none	none
resultID	string	none	none
resultKey	string	none	none
selectionType	string	none	none

Welcome

About Mambu API v1

Base URLs

HTTP Verbs

Authentication

Basic Authentication

API Keys

Payloads

Requests

Responses

Error response

Sandbox

Sandbox management

Pagination

limit

offset

Detail Level

Basic details

Full details

Audit Trail and the User-Agent Header

Posting Data

Example

Searching and Filtering

Filter Constraints

filterContraints array

sortDetails object

Filter Elements

Data Types and Examples

Clients

Groups

Loan Accounts

Tranches

Disbursement Details

Savings Accounts

Transactions

Notifications

General Ledger Journal Entries

Lines of Credit

Object Search

Custom View Filtering

Timezone Offsets

Activities

Get all Activities

Parameters

Responses

Response Schema

Enumerated Values

Branches

Get all Branches

Parameters

Responses

Response Schema

Enumerated Values

Get Branch by ID

Parameters

Responses

Update Custom Info for Branch

Parameters

Responses

Response Schema

Get Custom Info for Branch

Parameters

Responses

Response Schema

Update Custom Field Value for Branch

Parameters

Responses

Response Schema

Delete Custom Info for Branch

Parameters

Responses

Response Schema

Update Custom Info (grouped) for Branch

Parameters

Responses

Response Schema

Delete Custom Info (grouped) for Branch

Parameters

Responses

Response Schema

`limit`

`offset`

`filterContraints` array

`sortDetails` object