Skip to main content

Loantransactionapiv1

advancePositionnumber

Description for advancePosition in LoanTransactionApiV1

amountnumber

Description for amount in LoanTransactionApiV1

arrearsPositionnumber

Description for arrearsPosition in LoanTransactionApiV1

balancenumber

Description for balance in LoanTransactionApiV1

bookingDatestring

Description for bookingDate in LoanTransactionApiV1

branchKeystring

Description for branchKey in LoanTransactionApiV1

centreKeystring

Description for centreKey in LoanTransactionApiV1

commentstring

Description for comment in LoanTransactionApiV1

creationDatestring

the date and time when this loan transaction was created

customInformation object[]

Description for customInformation in LoanTransactionApiV1

  • Array [
  • amountnumber

    Description for amount in CustomFieldValueApiV1

    customField object

    Description for customField in CustomFieldValueApiV1

    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

    property name*number
    builtInCustomFieldIdstring

    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

    Possible values: [MOBILE_PHONE, EMAIL_ADDRESS, GENDER, MIDDLE_NAME, HOME_PHONE, BIRTHDATE, LAST_NAME, FIRST_NAME]

    creationDatestring

    the date on which this custom field definition was created

    customFieldProductSettings object[]

    Description for customFieldProductSettings in CustomFieldApiV1

  • Array [
  • customFieldEncodedKeystring

    the key to the parent custom field definition

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    isDefaultboolean

    whether this field is displayed by default when creating a new record

    isRequiredboolean

    whether this field is required when creating a new record

    linkTypestring

    the type of entity this field represents a link to

    Possible values: [CLIENT_ROLE, CHANNEL, PRODUCT]

    productKeystring

    when the link type is product, this field should contain the encoded key of the linekd product

  • ]
  • customFieldSelectionOptions object[]

    Description for customFieldSelectionOptions in CustomFieldApiV1

  • Array [
  • constraint object

    Description for constraint in CustomFieldSelectionApiV1

    customFieldKeystring

    Description for customFieldKey in CustomFilterConstraintApiV1

    dataFieldTypestring

    Description for dataFieldType in CustomFilterConstraintApiV1

    Possible values: [NATIVE, CUSTOM]

    dataFieldValuestring

    Description for dataFieldValue in CustomFilterConstraintApiV1

    dataItemTypestring

    Description for dataItemType in CustomFilterConstraintApiV1

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

    dataTypestring

    Description for dataType in CustomFilterConstraintApiV1

    Possible values: [ENUM, MONEY, NUMBER, DATE_UTC, JAVA_BLOB, OBJECT, BOOLEAN, DATE, PERCENT, BIG_DECIMAL, STRING, KEY, LONG]

    encodedKeystring

    Description for encodedKey in CustomFilterConstraintApiV1

    filterElementstring

    Description for filterElement in CustomFilterConstraintApiV1

    Possible values: [STARTS_WITH_CASE_SENSITIVE, THIS_WEEK, EQUALS, STARTS_WITH, IN, TODAY, THIS_YEAR, BETWEEN, AFTER, LESS_THAN, DIFFERENT_THAN, THIS_MONTH, NOT_EMPTY, BEFORE, EQUALS_CASE_SENSITIVE, LAST_DAYS, MORE_THAN, EMPTY, ON]

    groupNumbernumber

    Description for groupNumber in CustomFilterConstraintApiV1

    indexnumber

    Description for index in CustomFilterConstraintApiV1

    linkingOperatorstring

    Description for linkingOperator in CustomFilterConstraintApiV1

    Possible values: [OR, AND]

    secondValuestring

    Description for secondValue in CustomFilterConstraintApiV1

    valuestring

    Description for value in CustomFilterConstraintApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    idstring

    the ID of this selectable item

    scorenumber

    the score assigned to this selection

    valuestring

    display name of this option

  • ]
  • customFieldSet object

    Description for customFieldSet in CustomFieldApiV1

    builtInTypestring

    if this set is part of the set of built-in custom field sets, its type will be shown here

    Possible values: [DETAILS, GENERAL]

    createdDatestring

    the date and time when this custom field set was created

    customFields object[]

    an array of custom field definitions included in this custom field set

  • Array [
  • 0
    1
    2
    3
    4
    5
    6
    7
    8
    9
  • ]
  • encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    idstring

    the ID of this custom field set

    indexInListnumber

    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

    lastModifiedDatestring

    the date on which this custom field set was last modified

    namestring

    the name of this custom field set

    notesstring

    any notes regarding this custom field set

    typestring

    the entity type that this custom field definition is attached to

    Possible values: [USER_INFO, ASSET_INFO, CLIENT_INFO, LINE_OF_CREDIT, GROUP_INFO, TRANSACTION_CHANNEL_INFO, BRANCH_INFO, SAVINGS_ACCOUNT_INFO, LOAN_ACCOUNT_INFO, GUARANTOR_INFO, CENTRE_INFO]

    usagestring

    whether this custom field set can only be used once, or added multiple times to the same entity

    Possible values: [SINGLE, GROUPED]

    dataTypestring

    the type of custom field definition

    Possible values: [GROUP_LINK, DATE, NUMBER, CHECKBOX, CLIENT_LINK, STRING, USER_LINK, SELECTION]

    descriptionstring

    a brief description of this custom field definition

    editRights object

    Description for editRights in CustomFieldApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    isAccessibleByAllUsersboolean

    Description for isAccessibleByAllUsers in UsageRightsApiV1

    rolesstring[]

    Description for roles in UsageRightsApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    idstring

    the ID for this custom field definition

    indexInListnumber

    Description for indexInList in CustomFieldApiV1

    isDefaultboolean

    whether this field will be included by default on new records

    isRequiredboolean

    whether this field is required when creating a new record

    lastModifiedDatestring

    the date on which this custom field definition was last modified

    namestring

    the name of this custom field definition

    statestring

    whether this field is available for use or has been deactivated

    Possible values: [DEACTIVATED, NORMAL]

    typestring

    the type of data this custom field definition will contain

    Possible values: [USER_INFO, ASSET_INFO, CLIENT_INFO, LINE_OF_CREDIT, GROUP_INFO, TRANSACTION_CHANNEL_INFO, BRANCH_INFO, SAVINGS_ACCOUNT_INFO, LOAN_ACCOUNT_INFO, GUARANTOR_INFO, CENTRE_INFO]

    uniqueboolean

    whether the data in this custom field definition needs to be a unique value

    validationPatternstring

    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 @@-##-$$$

    valueLengthstring

    whether this field needs to support a large number of characters

    Possible values: [SHORT, LONG]

    valuesstring[]

    a list of possible values when the field is a selection field

    viewRights object

    Description for viewRights in CustomFieldApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    isAccessibleByAllUsersboolean

    Description for isAccessibleByAllUsers in UsageRightsApiV1

    rolesstring[]

    Description for roles in UsageRightsApiV1

    customFieldIDstring

    Description for customFieldID in CustomFieldValueApiV1

    customFieldKeystring

    Description for customFieldKey in CustomFieldValueApiV1

    customFieldSetGroupIndexnumber

    Description for customFieldSetGroupIndex in CustomFieldValueApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    indexInListnumber

    Description for indexInList in CustomFieldValueApiV1

    linkedEntityKeyValuestring

    Description for linkedEntityKeyValue in CustomFieldValueApiV1

    parentKeystring

    Description for parentKey in CustomFieldValueApiV1

    selectionKeystring

    Description for selectionKey in CustomFieldValueApiV1

    valuestring

    Description for value in CustomFieldValueApiV1

  • ]
  • customPaymentAmounts object[]

    Description for customPaymentAmounts in LoanTransactionApiV1

  • Array [
  • amountnumber

    the amount of this custom payment

    customPaymentAmountTypestring

    the type of this custom payment

    Possible values: [PAYMENT_DUE_FEE, PENALTY, MANUAL_FEE, PRINCIPAL, UPFRONT_DISBURSEMENT_FEE, LATE_REPAYMENT_FEE, INTEREST]

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    indexnumber

    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

    loanTransactionKeystring

    the encoded key of the loan transaction this custom payment is part of

    taxOnAmountnumber

    the amount of tax charged for this payment

  • ]
  • deferredInterestAmountnumber

    Description for deferredInterestAmount in LoanTransactionApiV1

    deferredTaxOnInterestAmountnumber

    Description for deferredTaxOnInterestAmount in LoanTransactionApiV1

    details object

    Description for details in LoanTransactionApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    internalTransferboolean

    Description for internalTransfer in TransactionDetailsApiV1

    targetSavingsAccountKeystring

    Description for targetSavingsAccountKey in TransactionDetailsApiV1

    transactionChannel object

    Description for transactionChannel in TransactionDetailsApiV1

    activatedboolean

    whether this transaction channel is enabled

    createdByUserKeystring

    the encoded key of the user who created this transaction channel

    creationDatestring

    the date on which this transaction channel was created

    customFields object[]

    Description for customFields in TransactionChannelInTransactionDetailsApiV1

  • Array [
  • 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

    property name*number
    builtInCustomFieldIdstring

    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

    Possible values: [MOBILE_PHONE, EMAIL_ADDRESS, GENDER, MIDDLE_NAME, HOME_PHONE, BIRTHDATE, LAST_NAME, FIRST_NAME]

    creationDatestring

    the date on which this custom field definition was created

    customFieldProductSettings object[]

    Description for customFieldProductSettings in CustomFieldApiV1

  • Array [
  • customFieldEncodedKeystring

    the key to the parent custom field definition

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    isDefaultboolean

    whether this field is displayed by default when creating a new record

    isRequiredboolean

    whether this field is required when creating a new record

    linkTypestring

    the type of entity this field represents a link to

    Possible values: [CLIENT_ROLE, CHANNEL, PRODUCT]

    productKeystring

    when the link type is product, this field should contain the encoded key of the linekd product

  • ]
  • customFieldSelectionOptions object[]

    Description for customFieldSelectionOptions in CustomFieldApiV1

  • Array [
  • constraint object

    Description for constraint in CustomFieldSelectionApiV1

    customFieldKeystring

    Description for customFieldKey in CustomFilterConstraintApiV1

    dataFieldTypestring

    Description for dataFieldType in CustomFilterConstraintApiV1

    Possible values: [NATIVE, CUSTOM]

    dataFieldValuestring

    Description for dataFieldValue in CustomFilterConstraintApiV1

    dataItemTypestring

    Description for dataItemType in CustomFilterConstraintApiV1

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

    dataTypestring

    Description for dataType in CustomFilterConstraintApiV1

    Possible values: [ENUM, MONEY, NUMBER, DATE_UTC, JAVA_BLOB, OBJECT, BOOLEAN, DATE, PERCENT, BIG_DECIMAL, STRING, KEY, LONG]

    encodedKeystring

    Description for encodedKey in CustomFilterConstraintApiV1

    filterElementstring

    Description for filterElement in CustomFilterConstraintApiV1

    Possible values: [STARTS_WITH_CASE_SENSITIVE, THIS_WEEK, EQUALS, STARTS_WITH, IN, TODAY, THIS_YEAR, BETWEEN, AFTER, LESS_THAN, DIFFERENT_THAN, THIS_MONTH, NOT_EMPTY, BEFORE, EQUALS_CASE_SENSITIVE, LAST_DAYS, MORE_THAN, EMPTY, ON]

    groupNumbernumber

    Description for groupNumber in CustomFilterConstraintApiV1

    indexnumber

    Description for index in CustomFilterConstraintApiV1

    linkingOperatorstring

    Description for linkingOperator in CustomFilterConstraintApiV1

    Possible values: [OR, AND]

    secondValuestring

    Description for secondValue in CustomFilterConstraintApiV1

    valuestring

    Description for value in CustomFilterConstraintApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    idstring

    the ID of this selectable item

    scorenumber

    the score assigned to this selection

    valuestring

    display name of this option

  • ]
  • customFieldSet object

    Description for customFieldSet in CustomFieldApiV1

    builtInTypestring

    if this set is part of the set of built-in custom field sets, its type will be shown here

    Possible values: [DETAILS, GENERAL]

    createdDatestring

    the date and time when this custom field set was created

    customFieldsundefined[]

    an array of custom field definitions included in this custom field set

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    idstring

    the ID of this custom field set

    indexInListnumber

    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

    lastModifiedDatestring

    the date on which this custom field set was last modified

    namestring

    the name of this custom field set

    notesstring

    any notes regarding this custom field set

    typestring

    the entity type that this custom field definition is attached to

    Possible values: [USER_INFO, ASSET_INFO, CLIENT_INFO, LINE_OF_CREDIT, GROUP_INFO, TRANSACTION_CHANNEL_INFO, BRANCH_INFO, SAVINGS_ACCOUNT_INFO, LOAN_ACCOUNT_INFO, GUARANTOR_INFO, CENTRE_INFO]

    usagestring

    whether this custom field set can only be used once, or added multiple times to the same entity

    Possible values: [SINGLE, GROUPED]

    dataTypestring

    the type of custom field definition

    Possible values: [GROUP_LINK, DATE, NUMBER, CHECKBOX, CLIENT_LINK, STRING, USER_LINK, SELECTION]

    descriptionstring

    a brief description of this custom field definition

    editRights object

    Description for editRights in CustomFieldApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    isAccessibleByAllUsersboolean

    Description for isAccessibleByAllUsers in UsageRightsApiV1

    rolesstring[]

    Description for roles in UsageRightsApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    idstring

    the ID for this custom field definition

    indexInListnumber

    Description for indexInList in CustomFieldApiV1

    isDefaultboolean

    whether this field will be included by default on new records

    isRequiredboolean

    whether this field is required when creating a new record

    lastModifiedDatestring

    the date on which this custom field definition was last modified

    namestring

    the name of this custom field definition

    statestring

    whether this field is available for use or has been deactivated

    Possible values: [DEACTIVATED, NORMAL]

    typestring

    the type of data this custom field definition will contain

    Possible values: [USER_INFO, ASSET_INFO, CLIENT_INFO, LINE_OF_CREDIT, GROUP_INFO, TRANSACTION_CHANNEL_INFO, BRANCH_INFO, SAVINGS_ACCOUNT_INFO, LOAN_ACCOUNT_INFO, GUARANTOR_INFO, CENTRE_INFO]

    uniqueboolean

    whether the data in this custom field definition needs to be a unique value

    validationPatternstring

    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 @@-##-$$$

    valueLengthstring

    whether this field needs to support a large number of characters

    Possible values: [SHORT, LONG]

    valuesstring[]

    a list of possible values when the field is a selection field

    viewRights object

    Description for viewRights in CustomFieldApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    isAccessibleByAllUsersboolean

    Description for isAccessibleByAllUsers in UsageRightsApiV1

    rolesstring[]

    Description for roles in UsageRightsApiV1

  • ]
  • encodedKeystring

    the encoded key for this transaction channel

    idstring

    the user specified ID for this transaction channel

    indexnumber

    Description for index in TransactionChannelInTransactionDetailsApiV1

    loanConstraints object

    Description for loanConstraints in TransactionChannelInTransactionDetailsApiV1

    customConfigurationInfo object

    Description for customConfigurationInfo in CustomFilterApiV1

    creationDatestring

    the date on which this configuration was created

    dataViewTypestring

    the type of entity this configuration is for

    Possible values: [PORTAL_ACCOUNT_TRANSACTION, LOANS_AGING_ANALYSIS, CLOSED_ACCOUNTS, CLIENT_OVERVIEW, ADMIN_CENTRES, USER_NOTIFICATION_MESSAGES, LINE_OF_CREDIT, USER_OVERVIEW, CENTRE_OVERVIEW, REPAYMENT_REPAYMENTS_COLLECTION, GROUP_OVERVIEW, ACTIVITIES_LOOKUP, TRANSACTION, ADMIN_BRANCHES, GROUP, BRANCH_OVERVIEW, NOTIFICATION_MESSAGE, PORTFOLIO_REPORTS, GROUP_NOTIFICATION_MESSAGES, LOAN_ACCOUNT_SECURITIES_OVERVIEW, LINE_OF_CREDIT_OVERVIEW, CURRENCIES, REPAYMENT, TILL_TRANSACTIONS, ALL_TASKS, CENTRE, BRANCH, INDEX_RATES_LIST, USER_TASKS, DOCUMENT_TEMPLATES, SAVINGS_TRANSACTIONS_LOOKUP, LOAN_ACCOUNT_OVERVIEW, DEPOSITS_COLLECTION, USER, ADMIN_USERS, GROUP_TASKS, CLIENT, LOAN_TRANSACTIONS_LOOKUP, LOANS, LOANS_REPAYMENTS_COLLECTION, CLIENT_TASKS, OVERDRAFTS_AGING_ANALYSIS, LOAN_ACCOUNT_FUNDING_OVERVIEW, SAVINGS, SAVINGS_OVERVIEW, JOURNAL_ENTRY, CLIENT_NOTIFICATION_MESSAGES]

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    indexInListnumber

    if more than one configuration exists for a given type, this is its index in the list

    lastModifiedDatestring

    the date on which this configuration was last modified

    namestring

    the name for this configuration

    sharedboolean

    whether this configuration is private or can be used by other users of the system

    userKeystring

    the encoded key of the Mambu user who created this configuration

    encodedKeystring

    Description for encodedKey in CustomFilterApiV1

    filterConstraints object[]

    Description for filterConstraints in CustomFilterApiV1

  • Array [
  • customFieldKeystring

    Description for customFieldKey in CustomFilterConstraintApiV1

    dataFieldTypestring

    Description for dataFieldType in CustomFilterConstraintApiV1

    Possible values: [NATIVE, CUSTOM]

    dataFieldValuestring

    Description for dataFieldValue in CustomFilterConstraintApiV1

    dataItemTypestring

    Description for dataItemType in CustomFilterConstraintApiV1

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

    dataTypestring

    Description for dataType in CustomFilterConstraintApiV1

    Possible values: [ENUM, MONEY, NUMBER, DATE_UTC, JAVA_BLOB, OBJECT, BOOLEAN, DATE, PERCENT, BIG_DECIMAL, STRING, KEY, LONG]

    encodedKeystring

    Description for encodedKey in CustomFilterConstraintApiV1

    filterElementstring

    Description for filterElement in CustomFilterConstraintApiV1

    Possible values: [STARTS_WITH_CASE_SENSITIVE, THIS_WEEK, EQUALS, STARTS_WITH, IN, TODAY, THIS_YEAR, BETWEEN, AFTER, LESS_THAN, DIFFERENT_THAN, THIS_MONTH, NOT_EMPTY, BEFORE, EQUALS_CASE_SENSITIVE, LAST_DAYS, MORE_THAN, EMPTY, ON]

    groupNumbernumber

    Description for groupNumber in CustomFilterConstraintApiV1

    indexnumber

    Description for index in CustomFilterConstraintApiV1

    linkingOperatorstring

    Description for linkingOperator in CustomFilterConstraintApiV1

    Possible values: [OR, AND]

    secondValuestring

    Description for secondValue in CustomFilterConstraintApiV1

    valuestring

    Description for value in CustomFilterConstraintApiV1

  • ]
  • loanConstraintsUsagestring

    whether there are any rules regarding usage of this transaction channel with loan accounts

    Possible values: [UNCONSTRAINED_USAGE, LIMITED_USAGE]

    namestring

    the name of this transaction channel

    savingsConstraints object

    Description for savingsConstraints in TransactionChannelInTransactionDetailsApiV1

    customConfigurationInfo object

    Description for customConfigurationInfo in CustomFilterApiV1

    creationDatestring

    the date on which this configuration was created

    dataViewTypestring

    the type of entity this configuration is for

    Possible values: [PORTAL_ACCOUNT_TRANSACTION, LOANS_AGING_ANALYSIS, CLOSED_ACCOUNTS, CLIENT_OVERVIEW, ADMIN_CENTRES, USER_NOTIFICATION_MESSAGES, LINE_OF_CREDIT, USER_OVERVIEW, CENTRE_OVERVIEW, REPAYMENT_REPAYMENTS_COLLECTION, GROUP_OVERVIEW, ACTIVITIES_LOOKUP, TRANSACTION, ADMIN_BRANCHES, GROUP, BRANCH_OVERVIEW, NOTIFICATION_MESSAGE, PORTFOLIO_REPORTS, GROUP_NOTIFICATION_MESSAGES, LOAN_ACCOUNT_SECURITIES_OVERVIEW, LINE_OF_CREDIT_OVERVIEW, CURRENCIES, REPAYMENT, TILL_TRANSACTIONS, ALL_TASKS, CENTRE, BRANCH, INDEX_RATES_LIST, USER_TASKS, DOCUMENT_TEMPLATES, SAVINGS_TRANSACTIONS_LOOKUP, LOAN_ACCOUNT_OVERVIEW, DEPOSITS_COLLECTION, USER, ADMIN_USERS, GROUP_TASKS, CLIENT, LOAN_TRANSACTIONS_LOOKUP, LOANS, LOANS_REPAYMENTS_COLLECTION, CLIENT_TASKS, OVERDRAFTS_AGING_ANALYSIS, LOAN_ACCOUNT_FUNDING_OVERVIEW, SAVINGS, SAVINGS_OVERVIEW, JOURNAL_ENTRY, CLIENT_NOTIFICATION_MESSAGES]

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    indexInListnumber

    if more than one configuration exists for a given type, this is its index in the list

    lastModifiedDatestring

    the date on which this configuration was last modified

    namestring

    the name for this configuration

    sharedboolean

    whether this configuration is private or can be used by other users of the system

    userKeystring

    the encoded key of the Mambu user who created this configuration

    encodedKeystring

    Description for encodedKey in CustomFilterApiV1

    filterConstraints object[]

    Description for filterConstraints in CustomFilterApiV1

  • Array [
  • customFieldKeystring

    Description for customFieldKey in CustomFilterConstraintApiV1

    dataFieldTypestring

    Description for dataFieldType in CustomFilterConstraintApiV1

    Possible values: [NATIVE, CUSTOM]

    dataFieldValuestring

    Description for dataFieldValue in CustomFilterConstraintApiV1

    dataItemTypestring

    Description for dataItemType in CustomFilterConstraintApiV1

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

    dataTypestring

    Description for dataType in CustomFilterConstraintApiV1

    Possible values: [ENUM, MONEY, NUMBER, DATE_UTC, JAVA_BLOB, OBJECT, BOOLEAN, DATE, PERCENT, BIG_DECIMAL, STRING, KEY, LONG]

    encodedKeystring

    Description for encodedKey in CustomFilterConstraintApiV1

    filterElementstring

    Description for filterElement in CustomFilterConstraintApiV1

    Possible values: [STARTS_WITH_CASE_SENSITIVE, THIS_WEEK, EQUALS, STARTS_WITH, IN, TODAY, THIS_YEAR, BETWEEN, AFTER, LESS_THAN, DIFFERENT_THAN, THIS_MONTH, NOT_EMPTY, BEFORE, EQUALS_CASE_SENSITIVE, LAST_DAYS, MORE_THAN, EMPTY, ON]

    groupNumbernumber

    Description for groupNumber in CustomFilterConstraintApiV1

    indexnumber

    Description for index in CustomFilterConstraintApiV1

    linkingOperatorstring

    Description for linkingOperator in CustomFilterConstraintApiV1

    Possible values: [OR, AND]

    secondValuestring

    Description for secondValue in CustomFilterConstraintApiV1

    valuestring

    Description for value in CustomFilterConstraintApiV1

  • ]
  • savingsConstraintsUsagestring

    whether there are any rules regarding usage of this transaction channel with savings accounts

    Possible values: [UNCONSTRAINED_USAGE, LIMITED_USAGE]

    transactionChannelAccountingRule object

    Description for transactionChannelAccountingRule in TransactionChannelInTransactionDetailsApiV1

    account object

    Description for account in GLAccountingRuleApiV1

    activatedboolean

    whether this general ledger account is in use

    allowManualJournalEntriesboolean

    whether manual entries are allowed for this general ledger account

    balancenumber

    the current balance of this general ledger account

    creationDatestring<date-time>

    the date on which this general ledger account was created

    currency object

    Description for currency in GLAccountApiV1

    codestring

    the three letter ISO code for this currency

    creationDatestring

    the date on which this currency was created

    currencySymbolPositionstring

    indicates where the currency symbol should appear in relation to the numeric value

    Possible values: [AFTER_NUMBER, BEFORE_NUMBER]

    digitsAfterDecimalnumber

    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.

    isBaseCurrencyboolean

    whether this currency is the base currency for your banking institution

    lastModifiedDatestring

    the date on which this currency was last modified

    namestring

    the name of this currency

    symbolstring

    the currency symnbol used for this currency

    descriptionstring

    an optional description for this general ledger account

    encodedKeystring

    the encoded key of this general ledger account

    glCodestring

    the numeric code for this general ledger account

    lastModifiedDatestring<date-time>

    the date on which this general ledger account was last modified

    migrationEvent object

    Description for migrationEvent in GLAccountApiV1

    creationDatestring<date-time>

    the date on which the data import was made

    encodedKeystring

    the encoded key of this data migration event

    numCentresImportednumber

    the number of centres which were imported during the data migration

    numClientsImportednumber

    the number of clients which were imported as part of the data migration

    numGLAccountsImportednumber

    the number of general ledger accounts which were imported as part of the data migration

    numGroupsImportednumber

    the number of groups which were imported as part of the data migration

    numLoanRepaymentsImportednumber

    the number of loan repayment transations which were imported as part of the data migration

    numLoanTransactionsImportednumber

    the number of loan transactions which were imported as part of the data migration

    numLoansImportednumber

    the number of loan accounts which were imported as part of the data migration

    numSavingsImportednumber

    the number of savings accounts which were imported as part of the data migration

    statestring

    whether the data import was accepted, is still in a draft state, or was rejected and all data reverted

    Possible values: [REVERTED, DRAFT, APPROVED]

    typestring

    the type of migration event

    Possible values: [IMPORT, EXPORT]

    namestring

    the name of this general ledger account

    stripTrailingZerosboolean

    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

    typestring

    the type of general ledger account

    Possible values: [INCOME, EXPENSE, LIABILITY, ASSET, EQUITY]

    usagestring

    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.

    Possible values: [HEADER, DETAIL]

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    financialResourcestring

    the type of transaction governed by this rule

    Possible values: [FEE_RECEIVABLE, OVERDRAFT_INTEREST_INCOME, OVERDRAFT_INTEREST_RECEIVABLE, FEE_INCOME, INTEREST_PAYABLE, INTEREST_EXPENSE, PENALTY_RECEIVABLE, INTEREST_INCOME, DEFERRED_TAXES, DEFERRED_FEE_INCOME, PORTFOLIO_CONTROL, DEFERRED_INTERESTS_INCOME, OVERDRAFT_WRITE_OFF_EXPENSE, PENALTY_INCOME, OVERDRAFT_PORTFOLIO_CONTROL, SAVINGS_CONTROL, TAXES_RECEIVABLE, INTEREST_RECEIVABLE, INTER_BRANCH_TRANSFER, FUND_SOURCE, WRITE_OFF_EXPENSE, DEPOSIT_REFERENCE, TAXES_PAYABLE]

    indexnumber

    the index in list when there are multiple rules for the same type of transaction

    predefinedFeeKeystring

    the encoded key of the predefined key this rule relates to

    productKeystring

    the encoded key of the product this rule relates to

    productTypestring

    the type of account this rule relates to

    Possible values: [LOAN, SAVINGS]

    transactionChannelKeystring

    the encoded key of the transaction channel that this rule relates to

    usageRights object

    Description for usageRights in TransactionChannelInTransactionDetailsApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    isAccessibleByAllUsersboolean

    Description for isAccessibleByAllUsers in UsageRightsApiV1

    rolesstring[]

    Description for roles in UsageRightsApiV1

    transactionChannelKeystring

    Description for transactionChannelKey in TransactionDetailsApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    entryDatestring

    Description for entryDate in LoanTransactionApiV1

    expectedPrincipalRedrawnumber

    Description for expectedPrincipalRedraw in LoanTransactionApiV1

    feesPaidnumber

    Description for feesPaid in LoanTransactionApiV1

    fundersInterestAmountnumber

    Description for fundersInterestAmount in LoanTransactionApiV1

    indexInterestRate object

    Description for indexInterestRate in LoanTransactionApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    notesstring

    any notes relating to this index rate

    ratenumber

    the percentage rate for this tax or interest rate

    rateSource object

    Description for rateSource in IndexRateApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    namestring

    the name of this index rate source, eg. LIBOR

    notesstring

    any notes relating to this index rate

    typestring

    what kind of rate this source provides, eg. tax, interest, withholding tax

    Possible values: [TAX_RATE, INTEREST_RATE, WITHHOLDING_TAX_RATE]

    startDatestring

    the first day on which this rate is considered valid

    userKeystring

    the encoded key of the user who added this index rate

    interestFromArrearsAmountnumber

    Description for interestFromArrearsAmount in LoanTransactionApiV1

    interestPaidnumber

    Description for interestPaid in LoanTransactionApiV1

    interestRatenumber

    Description for interestRate in LoanTransactionApiV1

    loanPredefinedFeeAmounts object[]

    Description for loanPredefinedFeeAmounts in LoanTransactionApiV1

  • Array [
  • amortizedAmounts object[]

    Description for amortizedAmounts in PredefinedFeeAmountApiV1

  • Array [
  • amountnumber

    the amount to be amortized

    branchKeystring

    the encoded key of the branch owning the amount

    centreKeystring

    the encoded key of the centre owning the amount

    creationDatestring

    the date on which the amortization amount was created

    encodedKeystring

    the automatically generated encoded ID for this item

    entryDatestring

    the date when this amount was recognised as amortized (in organization time)

    reversalAmountKeystring

    if the amount was reversed, this field will contain the encoded key of the reversal record

    taxAmountnumber

    the amount of tax included in the amortized amount

    typestring

    the type of entry represented by this object

    Possible values: [AMORTIZATION_ADJUSTMENT, AMORTIZATION_CORRECTION, AMORTIZATION]

  • ]
  • amountnumber

    Description for amount in PredefinedFeeAmountApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    fee object

    Description for fee in PredefinedFeeAmountApiV1

    activeboolean

    Description for active in PredefinedFeeApiV1

    amortizationIntervalSettings object

    Description for amortizationIntervalSettings in PredefinedFeeApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    frequencystring

    Description for frequency in PeriodIntervalSettingsApiV1

    Possible values: [ACCOUNT_INSTALLMENTS_DUE_DATES_DAILY_BOOKING, ACCOUNT_INSTALLMENTS_DUE_DATES, CUSTOM_INTERVAL]

    intervalCountnumber

    Description for intervalCount in PeriodIntervalSettingsApiV1

    intervalTypestring

    Description for intervalType in PeriodIntervalSettingsApiV1

    Possible values: [FULL_TERM, PREDEFINED_INTERVALS]

    periodCountnumber

    Description for periodCount in PeriodIntervalSettingsApiV1

    periodUnitstring

    Description for periodUnit in PeriodIntervalSettingsApiV1

    Possible values: [MONTHS, YEARS, WEEKS, DAYS]

    amortizationProfilestring

    Description for amortizationProfile in PredefinedFeeApiV1

    Possible values: [STRAIGHT_LINE, SUM_OF_YEARS_DIGITS, EFFECTIVE_INTEREST_RATE, NONE]

    amountnumber

    Description for amount in PredefinedFeeApiV1

    amountCalculationMethodstring

    Description for amountCalculationMethod in PredefinedFeeApiV1

    Possible values: [LOAN_AMOUNT_PERCENTAGE, LOAN_AMOUNT_PERCENTAGE_NUMBER_OF_INSTALLMENTS, REPAYMENT_PRINCIPAL_AMOUNT_PERCENTAGE, FLAT_NUMBER_OF_INSTALLMENTS, FLAT]

    applyDateMethodstring

    Description for applyDateMethod in PredefinedFeeApiV1

    Possible values: [MONTHLY_FROM_ACTIVATION, FIRST_OF_EVERY_MONTH]

    creationDatestring

    the date and time when this fee was created

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    feeAmortizationUponRescheduleOptionstring

    Description for feeAmortizationUponRescheduleOption in PredefinedFeeApiV1

    Possible values: [CONTINUE_AMORTIZATION_ON_THE_RESCHEDULED_REFINANCED_ACCOUNT, END_AMORTIZATION_ON_THE_ORIGINAL_ACCOUNT]

    feeApplicationstring

    Description for feeApplication in PredefinedFeeApiV1

    Possible values: [OPTIONAL, REQUIRED]

    feeProductRules object[]

    Description for feeProductRules in PredefinedFeeApiV1

  • Array [
  • account object

    Description for account in GLAccountingRuleApiV1

    activatedboolean

    whether this general ledger account is in use

    allowManualJournalEntriesboolean

    whether manual entries are allowed for this general ledger account

    balancenumber

    the current balance of this general ledger account

    creationDatestring<date-time>

    the date on which this general ledger account was created

    currency object

    Description for currency in GLAccountApiV1

    codestring

    the three letter ISO code for this currency

    creationDatestring

    the date on which this currency was created

    currencySymbolPositionstring

    indicates where the currency symbol should appear in relation to the numeric value

    Possible values: [AFTER_NUMBER, BEFORE_NUMBER]

    digitsAfterDecimalnumber

    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.

    isBaseCurrencyboolean

    whether this currency is the base currency for your banking institution

    lastModifiedDatestring

    the date on which this currency was last modified

    namestring

    the name of this currency

    symbolstring

    the currency symnbol used for this currency

    descriptionstring

    an optional description for this general ledger account

    encodedKeystring

    the encoded key of this general ledger account

    glCodestring

    the numeric code for this general ledger account

    lastModifiedDatestring<date-time>

    the date on which this general ledger account was last modified

    migrationEvent object

    Description for migrationEvent in GLAccountApiV1

    creationDatestring<date-time>

    the date on which the data import was made

    encodedKeystring

    the encoded key of this data migration event

    numCentresImportednumber

    the number of centres which were imported during the data migration

    numClientsImportednumber

    the number of clients which were imported as part of the data migration

    numGLAccountsImportednumber

    the number of general ledger accounts which were imported as part of the data migration

    numGroupsImportednumber

    the number of groups which were imported as part of the data migration

    numLoanRepaymentsImportednumber

    the number of loan repayment transations which were imported as part of the data migration

    numLoanTransactionsImportednumber

    the number of loan transactions which were imported as part of the data migration

    numLoansImportednumber

    the number of loan accounts which were imported as part of the data migration

    numSavingsImportednumber

    the number of savings accounts which were imported as part of the data migration

    statestring

    whether the data import was accepted, is still in a draft state, or was rejected and all data reverted

    Possible values: [REVERTED, DRAFT, APPROVED]

    typestring

    the type of migration event

    Possible values: [IMPORT, EXPORT]

    namestring

    the name of this general ledger account

    stripTrailingZerosboolean

    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

    typestring

    the type of general ledger account

    Possible values: [INCOME, EXPENSE, LIABILITY, ASSET, EQUITY]

    usagestring

    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.

    Possible values: [HEADER, DETAIL]

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    financialResourcestring

    the type of transaction governed by this rule

    Possible values: [FEE_RECEIVABLE, OVERDRAFT_INTEREST_INCOME, OVERDRAFT_INTEREST_RECEIVABLE, FEE_INCOME, INTEREST_PAYABLE, INTEREST_EXPENSE, PENALTY_RECEIVABLE, INTEREST_INCOME, DEFERRED_TAXES, DEFERRED_FEE_INCOME, PORTFOLIO_CONTROL, DEFERRED_INTERESTS_INCOME, OVERDRAFT_WRITE_OFF_EXPENSE, PENALTY_INCOME, OVERDRAFT_PORTFOLIO_CONTROL, SAVINGS_CONTROL, TAXES_RECEIVABLE, INTEREST_RECEIVABLE, INTER_BRANCH_TRANSFER, FUND_SOURCE, WRITE_OFF_EXPENSE, DEPOSIT_REFERENCE, TAXES_PAYABLE]

    indexnumber

    the index in list when there are multiple rules for the same type of transaction

    predefinedFeeKeystring

    the encoded key of the predefined key this rule relates to

    productKeystring

    the encoded key of the product this rule relates to

    productTypestring

    the type of account this rule relates to

    Possible values: [LOAN, SAVINGS]

    transactionChannelKeystring

    the encoded key of the transaction channel that this rule relates to

  • ]
  • namestring

    Description for name in PredefinedFeeApiV1

    percentageAmountnumber

    Description for percentageAmount in PredefinedFeeApiV1

    triggerstring

    Description for trigger in PredefinedFeeApiV1

    Possible values: [DISBURSEMENT, ARBITRARY, CAPITALIZED_DISBURSEMENT, MONTHLY_FEE, UPFRONT_DISBURSEMENT, LATE_REPAYMENT, MANUAL, PAYMENT_DUE, PAYMENT_DUE_APPLIED_ON_DUE_DATES]

    taxAmountnumber

    Description for taxAmount in PredefinedFeeAmountApiV1

    transactionIdnumber

    Description for transactionId in PredefinedFeeAmountApiV1

  • ]
  • loanTransactionTerms object

    Description for loanTransactionTerms in LoanTransactionApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    principalPaymentAmountnumber

    Description for principalPaymentAmount in LoanTransactionTermsApiV1

    principalPaymentPercentagenumber

    Description for principalPaymentPercentage in LoanTransactionTermsApiV1

    migrationEvent object

    Description for migrationEvent in LoanTransactionApiV1

    creationDatestring<date-time>

    the date on which the data import was made

    encodedKeystring

    the encoded key of this data migration event

    numCentresImportednumber

    the number of centres which were imported during the data migration

    numClientsImportednumber

    the number of clients which were imported as part of the data migration

    numGLAccountsImportednumber

    the number of general ledger accounts which were imported as part of the data migration

    numGroupsImportednumber

    the number of groups which were imported as part of the data migration

    numLoanRepaymentsImportednumber

    the number of loan repayment transations which were imported as part of the data migration

    numLoanTransactionsImportednumber

    the number of loan transactions which were imported as part of the data migration

    numLoansImportednumber

    the number of loan accounts which were imported as part of the data migration

    numSavingsImportednumber

    the number of savings accounts which were imported as part of the data migration

    statestring

    whether the data import was accepted, is still in a draft state, or was rejected and all data reverted

    Possible values: [REVERTED, DRAFT, APPROVED]

    typestring

    the type of migration event

    Possible values: [IMPORT, EXPORT]

    organizationCommissionAmountnumber

    Description for organizationCommissionAmount in LoanTransactionApiV1

    originalAmountnumber

    Description for originalAmount in LoanTransactionApiV1

    originalCurrencyCodestring

    Description for originalCurrencyCode in LoanTransactionApiV1

    parentAccountKeystring

    Description for parentAccountKey in LoanTransactionApiV1

    parentLoanTransactionKeystring

    Description for parentLoanTransactionKey in LoanTransactionApiV1

    penaltyPaidnumber

    Description for penaltyPaid in LoanTransactionApiV1

    principalBalancenumber

    Description for principalBalance in LoanTransactionApiV1

    principalPaidnumber

    Description for principalPaid in LoanTransactionApiV1

    productTypeKeystring

    Description for productTypeKey in LoanTransactionApiV1

    redrawBalancenumber

    Description for redrawBalance in LoanTransactionApiV1

    reversalTransactionKeystring

    Description for reversalTransactionKey in LoanTransactionApiV1

    taxOnFeesAmountnumber

    Description for taxOnFeesAmount in LoanTransactionApiV1

    taxOnInterestFromArrearsAmountnumber

    Description for taxOnInterestFromArrearsAmount in LoanTransactionApiV1

    taxOnInterestPaidnumber

    Description for taxOnInterestPaid in LoanTransactionApiV1

    taxOnPenaltyAmountnumber

    Description for taxOnPenaltyAmount in LoanTransactionApiV1

    taxRate object

    Description for taxRate in LoanTransactionApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    notesstring

    any notes relating to this index rate

    ratenumber

    the percentage rate for this tax or interest rate

    rateSource object

    Description for rateSource in IndexRateApiV1

    encodedKeystring

    the automatically generated encoded ID for this item

    Example: 8a19b7057471f4af017472dc0fd80472
    namestring

    the name of this index rate source, eg. LIBOR

    notesstring

    any notes relating to this index rate

    typestring

    what kind of rate this source provides, eg. tax, interest, withholding tax

    Possible values: [TAX_RATE, INTEREST_RATE, WITHHOLDING_TAX_RATE]

    startDatestring

    the first day on which this rate is considered valid

    userKeystring

    the encoded key of the user who added this index rate

    tillKeystring

    Description for tillKey in LoanTransactionApiV1

    transactionIdnumber

    Description for transactionId in LoanTransactionApiV1

    typestring

    Description for type in LoanTransactionApiV1

    Possible values: [PENALTY_UNLOCKED, INTEREST_UNLOCKED, INTEREST_LOCKED, DISBURSMENT, INTEREST_APPLIED, DISBURSMENT_ADJUSTMENT, FEE, INTEREST_APPLIED_ADJUSTMENT, FEE_ADJUSTMENT, REPAYMENT_ADJUSTMENT, PENALTY_LOCKED, REPAYMENT, WRITE_OFF, FEE_CHARGED, PENALTY_APPLIED, PENALTY_ADJUSTMENT, INTEREST_RATE_CHANGED]

    userKeystring

    Description for userKey in LoanTransactionApiV1

    valueDatestring

    Description for valueDate in LoanTransactionApiV1

    Loantransactionapiv1
    {
    "advancePosition": 0,
    "amount": 0,
    "arrearsPosition": 0,
    "balance": 0,
    "bookingDate": "string",
    "branchKey": "string",
    "centreKey": "string",
    "comment": "string",
    "creationDate": "string",
    "customInformation": [
    {
    "amount": 0,
    "customField": {
    "amounts": {},
    "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": {},
    "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": [
    null
    ],
    "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": "2024-07-29T15:51:28.071Z",
    "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": "2024-07-29T15:51:28.071Z",
    "migrationEvent": {
    "creationDate": "2024-07-29T15:51:28.071Z",
    "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": "2024-07-29T15:51:28.071Z",
    "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": "2024-07-29T15:51:28.071Z",
    "migrationEvent": {
    "creationDate": "2024-07-29T15:51:28.071Z",
    "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": "2024-07-29T15:51:28.071Z",
    "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"
    }