Skip to main content

Generalsettingsapiv1

General Organisation Settings

approvalDisbursalTwoManRuleEnabledboolean

whether loan disbursals need to be approved by another Mambu user

arrearsDaysBeforeWriteOffnumber

the number of days an account must be in arrears before the overdue loan is written off

assignmentConstraintsstring[]

Description for assignmentConstraints in GeneralSettingsApiV1

automatedAccountingClosuresIntervalnumber

the number of days between automatic accounting closures, if this is set to 0 closures will have to be made manually

clientIDFormatstring

the pattern for automatically generated client IDs where

dateFormatsstring

the date and time format that will be used, eg DATE_TIME_FORMAT dd-MM-yyyy hh:mm

decimalSeperatorstring

the character used to separate major and minor currency units as well as tenths, hundreths etc, such as for interest rates

defaultClientRoleKeystring

the default role assigned to new clients

defaultClientStatestring

the default state a new client will be given when created

defaultGroupRoleKeystring

the encoded key of the default role which will be assigned when adding members to groups

defaultLineOfCreditStatestring

the default state for new lines of credit

defaultTransactionChannelKeystring

the encoded key of the default channel which will be used for transactions

duplicateClientChecks object[]

a list of checks that will be carried out when creating a new client to identify duplicates

  • Array [
  • activeboolean

    whether this rule is currently active

    dataFieldstring

    what field will be checked by this rule

    dataItemTypestring

    what kind of entity this check will be performed on

    Possible values: [CLIENT, IDENTIFICATION_DOCUMENT]

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    groupIndexnumber

    index in list if there are multiple checks for the same entity

  • ]
  • duplicateClientConstraintActionstring

    Description for duplicateClientConstraintAction in GeneralSettingsApiV1

    enabledComponentsstring[]

    a list of features which are enabled for this Mambu tenant

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    eodProcessingMethodstring

    whether end of day processing will be started automatically at midnight local time or manually

    Possible values: [MANUAL, AUTOMATIC]

    exposureTypestring

    whether a client can take out an unlimited amount in loans or there are constraints

    Possible values: [UNLIMITED, SUM_OF_LOANS, SUM_OF_LOANS_MINUS_SAVINGS]

    exposireAmountstring

    a maximum exposure representing the most a given client can take out in loans

    generalHolidays object[]

    a list of holidays applying to the whole organisation

  • Array [
  • creationDatestring<date-time>

    the date and time when this holiday was created

    dayOfMonthnumber

    the day of the month on which this holiday occurs

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    isAnnualyRecurringboolean

    whether the holiday is a one-off or occurs every year

    keyIdstring

    an internal ID for this holiday

    monthOfYearnumber

    the month in which this holiday occurs

    namestring

    the name of this holiday

    yearnumber

    the year in this this holiday takes place

  • ]
  • groupIDFormatstring

    the pattern that will be used when generating IDs for new groups

    groupSizeLimitTypestring

    the maximum number of members who can be included in a group

    lineOfCreditIdFormatstring

    the pattern used to generate IDs for lines of credit

    maxAllowedIdDocumentAttachmentsnumber

    the maximum number of ID documents that can be associated with one client

    maxAllowedJournalEntryDocumentAttachmentsnumber

    the maximum number of documents that can be attached to one journal entry

    maxAllowedUndoClosurePeriodnumber

    the number of days before it is no longer possible to undo a closed loan

    multipleGroupMembershipstring

    whether a single client can be a member of multiple groups

    multipleLoansstring

    whether a single client can take out more than one loan

    nonWorkingDays object[]

    a list of non-working days

  • Array [
  • creationDatestring

    the date and time when this non-working day was created

    dayOfWeekstring

    the day of the week, eg. MONDAY, SUNDAY

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
  • ]
  • otherIdDocumentsEnabledboolean

    whether arbitrary ID documents can be attached to a client

    tillIDFormatstring

    the pattern used for generating IDs for tills

    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",
    "exposureType": "UNLIMITED",
    "exposireAmount": "string",
    "generalHolidays": [
    {
    "creationDate": "2024-07-29T15:51:28.071Z",
    "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"
    }