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

Clients​

Groups​

Loan Accounts​

Tranches​

Disbursement Details​

Savings Accounts​

Transactions​

Notifications​

General Ledger Journal Entries​

Lines of Credit​

Object Search​