Skip to main content

Generalsetup

Represents the general setup for an organization.

accountingCutOffTimestring

The accounting cut off time.

approvalDisbursalTwoManRuleEnabledboolean

TRUE if separate users are required for approval and disbursal, FALSE otherwise.

arrearsDaysBeforeWriteOffinteger<int32>

The number of days that are required before an account can be written off.

assignmentConstraintsstring[]

The list of required assignments for clients and groups.

Possible values: [BRANCH, CENTRE, CREDIT_OFFICER, GROUP]

automatedAccountingClosuresIntervalinteger<int32>

The interval (number of days) between the execution of automated accounting closures. If this number is 0, automated closure is performed.

clientIdFormatstring

The pattern for generating individual client IDs.

configurationData object

Configuration data

property name*object

Configuration data

dashboardConfigurations object[]

The dashboard configuration.

  • Array [
  • creationDatestring<date-time>

    The date dashboard configuration was created

    Example: 2016-09-06T13:37:50+03:00
    encodedKeystring

    The encoded key of the dashboard configuration, auto generated, unique

    namestring

    Response representation of the dashboard option

    Possible values: [LATEST_ACTIVITY, TASKS, FAVOURITE_VIEWS, INDICATORS, CURRENT_TILLS, CLIENTS, UPCOMING_REPAYMENTS, NONE]

  • ]
  • dateFormats object

    The date (dd-MM-yyyy) or date time (dd-MM-yyyy HH:mm:ss) formats.

    property name*string

    The date (dd-MM-yyyy) or date time (dd-MM-yyyy HH:mm:ss) formats.

    decimalSeparatorstring

    Response representation of the decimal separator

    Possible values: [COMMA, POINT]

    defaultClientRoleKeystring

    The client role used as default.

    defaultClientStatestring

    The client default state.

    Possible values: [PENDING_APPROVAL, INACTIVE, ACTIVE, EXITED, BLACKLISTED, REJECTED]

    defaultGroupRoleKeystring

    The group role used as default.

    defaultLineOfCreditStatestring

    Response representation of a Line of Credit

    Possible values: [PENDING_APPROVAL, APPROVED, ACTIVE, CLOSED, WITHDRAWN, REJECTED]

    defaultTransactionChannelKeystring

    The transaction channel that is used as the default.

    duplicateClientChecks object[]

    The list of duplicate client constraints that are available in the administration and can be performed.

  • Array [
  • activeboolean

    The check will be performed if the field is true

    dataFieldstring

    The ENUM data field when the field is an ENUM

    dataItemTypestring

    Represents the type of the owner (entity) to whom a data field belongs to (loans, savings, client, group, repayments, transactions, activities etc.)

    Possible values: [LOANS, SAVINGS, CLIENT, CLIENT_ROLE, GROUP, GROUP_ROLE, TRANSACTION, JOURNAL_ENTRY, INTEREST_ACCRUAL_BREAKDOWN, BRANCH, CENTRE, USER, LOAN_PRODUCT, SAVINGS_PRODUCT, NOTIFICATION_MESSAGE, NOTIFICATION_TEMPLATE, REPAYMENT, REPAYMENT_COLLECTION, ACTIVITY, LINE_OF_CREDIT, IDENTIFICATION_DOCUMENT, ATTACHMENT, CURRENCY, PRODUCT, REVENUE, EXPENSE, OUTSTANDING_PORTFOLIO_ACCOUNTS, OUTSTANDING_PORTFOLIO_AMOUNTS, CREATED_ACCOUNTS, WRITTEN_OFF_LOANS, DISBURSED_LOANS, LOAN_GROUP, TRANCHE, DISBURSEMENT_DETAILS, TRANSACTION_DETAILS, TRANSACTION_CHANNEL, CUSTOM_PREDEFINED_FEE, CUSTOM_FIELD_SELECTION, PREDEFINED_FEE, LOAN_TRANSACTION, SAVINGS_TRANSACTION, CARD_TRANSACTION_REVERSAL, COMPOSED_TRANSACTIONS, UNION_TRANSACTIONS, INVESTOR_FUND, PRINCIPAL_PAYMENT_SETTINGS, LOAN_ACCOUNT_GUARANTY, TASK, DOCUMENT_TEMPLATE, INDEX_RATE, INDEX_RATE_SOURCE, INTEREST_PRODUCT_SETTINGS, MCC_EXPIRATION, PRODUCT_ARREARS_SETTINGS, ACCOUNT_INTEREST_RATE_SETTINGS, LENDING_ACCOUNT_CONTRACT, REVOLVING_ACCOUNT, LENDING_PRODUCT_CONTRACT]

    encodedKeystring

    The encoded key of the duplicate field constraint, auto generated, unique

    groupIndexinteger<int32>

    Used for creating an AND clause between constraints

  • ]
  • duplicateClientConstraintActionstring

    Represents the action to be taken when a duplicate field constraint failed

    Possible values: [NONE, WARNING, ERROR]

    enabledComponentsstring[]

    The list of all the enabled components for the current tenant.

    Possible values: [LOANS, DEPOSITS, BRANCHES, CENTRES, CLIENTS, GROUPS, ACCOUNTING, CREDIT_OFFICERS]

    encodedKeystring

    The encoded key of the general setup, which is auto generated, and unique.

    eodProcessingMethodstring

    Response representation of the EOD processing settings whether is automatic, runs every midnight or manual

    Possible values: [AUTOMATIC, MANUAL, EARLY_MANUAL]

    exposureAmountnumber

    The maximum exposure amount.

    exposureTypestring

    Response representation of the maximum exposure is a hard cap of how much a client can have in outstanding loans with the organization at any time

    Possible values: [UNLIMITED, SUM_OF_LOANS, SUM_OF_LOANS_MINUS_SAVINGS]

    groupIdFormatstring

    The pattern for generating group client IDs.

    groupSizeLimitTypestring

    Response representation of group size limitation type

    Possible values: [HARD, WARNING, NONE]

    interBranchTransferGLAccountKeystring

    The key of the general ledger (GL) account which will be used for inter-branch transfers.

    lineOfCreditIdFormatstring

    The unique pattern after which all the lines of credit IDs should be created.

    maxAllowedIdDocumentAttachmentsinteger<int32>

    The maximum allowed ID document attachments.

    maxAllowedJournalEntryDocumentAttachmentsinteger<int32>

    The maximum allowed journal entry attachments.

    maxAllowedUndoClosurePeriodinteger<int32>

    The maximum number of days users are allowed to undo of close obligations met for a loan account.

    maxGroupSizeLimitinteger<int32>

    The maximum group size allowed. A null value means the limit is ignored.

    minGroupSizeLimitinteger<int32>

    The minimum group size allowed. A null value means the limit is ignored.

    multipleGroupMembershipsstring

    Response representation on whether clients can belong to more than one group or not

    Possible values: [UNLIMITED, ONE_GROUP]

    multipleLoansstring

    Response representation of whether multiple loans are allowed or not

    Possible values: [UNLIMITED, ONE_LOAN]

    otherIdDocumentsEnabledboolean

    TRUE if other ID documents are enabled, FALSE otherwise.

    overdraftInterestEodBalanceDatestring<date-time>

    The date used when computing overdraft interest for savings accounts.

    Example: 2016-09-06T13:37:50+03:00
    tillIdFormatstring

    The unique pattern after which all the till IDs should be created.

    Generalsetup
    {
    "accountingCutOffTime": "string",
    "approvalDisbursalTwoManRuleEnabled": true,
    "arrearsDaysBeforeWriteOff": 0,
    "assignmentConstraints": [
    "BRANCH"
    ],
    "automatedAccountingClosuresInterval": 0,
    "clientIdFormat": "string",
    "configurationData": {},
    "dashboardConfigurations": [
    {
    "creationDate": "2016-09-06T13:37:50+03:00",
    "encodedKey": "string",
    "name": "LATEST_ACTIVITY"
    }
    ],
    "dateFormats": {},
    "decimalSeparator": "COMMA",
    "defaultClientRoleKey": "string",
    "defaultClientState": "PENDING_APPROVAL",
    "defaultGroupRoleKey": "string",
    "defaultLineOfCreditState": "PENDING_APPROVAL",
    "defaultTransactionChannelKey": "string",
    "duplicateClientChecks": [
    {
    "active": true,
    "dataField": "string",
    "dataItemType": "LOANS",
    "encodedKey": "string",
    "groupIndex": 0
    }
    ],
    "duplicateClientConstraintAction": "NONE",
    "enabledComponents": [
    "LOANS"
    ],
    "encodedKey": "string",
    "eodProcessingMethod": "AUTOMATIC",
    "exposureAmount": 0,
    "exposureType": "UNLIMITED",
    "groupIdFormat": "string",
    "groupSizeLimitType": "HARD",
    "interBranchTransferGLAccountKey": "string",
    "lineOfCreditIdFormat": "string",
    "maxAllowedIdDocumentAttachments": 0,
    "maxAllowedJournalEntryDocumentAttachments": 0,
    "maxAllowedUndoClosurePeriod": 0,
    "maxGroupSizeLimit": 0,
    "minGroupSizeLimit": 0,
    "multipleGroupMemberships": "UNLIMITED",
    "multipleLoans": "UNLIMITED",
    "otherIdDocumentsEnabled": true,
    "overdraftInterestEodBalanceDate": "2016-09-06T13:37:50+03:00",
    "tillIdFormat": "string"
    }