Transactionchannelintransactiondetailsapiv1

activatedboolean

Description for activated in TransactionChannelInTransactionDetailsApiV1

createdByUserKeystring

Description for createdByUserKey in TransactionChannelInTransactionDetailsApiV1

creationDatestring

Description for creationDate in TransactionChannelInTransactionDetailsApiV1

customFields object[]

Description for customFields in TransactionChannelInTransactionDetailsApiV1

Array [

amounts object

Description for amounts in CustomFieldApiV1

property name*number

builtInCustomFieldIdstring

Description for builtInCustomFieldId in CustomFieldApiV1

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

creationDatestring

Description for creationDate in CustomFieldApiV1

customFieldProductSettings object[]

Description for customFieldProductSettings in CustomFieldApiV1

Array [

customFieldEncodedKeystring

Description for customFieldEncodedKey in CustomFieldLinkApiV1

encodedKeystring

Description for encodedKey in CustomFieldLinkApiV1

isDefaultboolean

Description for isDefault in CustomFieldLinkApiV1

isRequiredboolean

Description for isRequired in CustomFieldLinkApiV1

linkTypestring

Description for linkType in CustomFieldLinkApiV1

Possible values: [CLIENT_ROLE, CHANNEL, PRODUCT]

productKeystring

Description for productKey in CustomFieldLinkApiV1

]

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

Description for encodedKey in CustomFieldSelectionApiV1

idstring

Description for id in CustomFieldSelectionApiV1

scorenumber

Description for score in CustomFieldSelectionApiV1

valuestring

Description for value in CustomFieldSelectionApiV1

]

customFieldSet object

Description for customFieldSet in CustomFieldApiV1

builtInTypestring

Description for builtInType in CustomFieldSetApiV1

Possible values: [DETAILS, GENERAL]

createdDatestring

Description for createdDate in CustomFieldSetApiV1

customFieldsundefined[]

Description for customFields in CustomFieldSetApiV1

encodedKeystring

Description for encodedKey in CustomFieldSetApiV1

idstring

Description for id in CustomFieldSetApiV1

indexInListnumber

Description for indexInList in CustomFieldSetApiV1

lastModifiedDatestring

Description for lastModifiedDate in CustomFieldSetApiV1

namestring

Description for name in CustomFieldSetApiV1

notesstring

Description for notes in CustomFieldSetApiV1

typestring

Description for type in CustomFieldSetApiV1

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

Description for usage in CustomFieldSetApiV1

Possible values: [SINGLE, GROUPED]

dataTypestring

Description for dataType in CustomFieldApiV1

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

descriptionstring

Description for description in CustomFieldApiV1

editRights object

Description for editRights in CustomFieldApiV1

encodedKeystring

Description for encodedKey in UsageRightsApiV1

isAccessibleByAllUsersboolean

Description for isAccessibleByAllUsers in UsageRightsApiV1

rolesstring[]

Description for roles in UsageRightsApiV1

encodedKeystring

Description for encodedKey in CustomFieldApiV1

idstring

Description for id in CustomFieldApiV1

indexInListnumber

Description for indexInList in CustomFieldApiV1

isDefaultboolean

Description for isDefault in CustomFieldApiV1

isRequiredboolean

Description for isRequired in CustomFieldApiV1

lastModifiedDatestring

Description for lastModifiedDate in CustomFieldApiV1

namestring

Description for name in CustomFieldApiV1

statestring

Description for state in CustomFieldApiV1

Possible values: [DEACTIVATED, NORMAL]

typestring

Description for type in CustomFieldApiV1

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

Description for unique in CustomFieldApiV1

validationPatternstring

Description for validationPattern in CustomFieldApiV1

valueLengthstring

Description for valueLength in CustomFieldApiV1

Possible values: [SHORT, LONG]

valuesstring[]

Description for values in CustomFieldApiV1

viewRights object

Description for viewRights in CustomFieldApiV1

encodedKeystring

Description for encodedKey in UsageRightsApiV1

isAccessibleByAllUsersboolean

Description for isAccessibleByAllUsers in UsageRightsApiV1

rolesstring[]

Description for roles in UsageRightsApiV1

]

encodedKeystring

Description for encodedKey in TransactionChannelInTransactionDetailsApiV1

idstring

Description for id in TransactionChannelInTransactionDetailsApiV1

indexnumber

Description for index in TransactionChannelInTransactionDetailsApiV1

namestring

Description for name in TransactionChannelInTransactionDetailsApiV1

savingsConstraints object

Description for savingsConstraints in TransactionChannelInTransactionDetailsApiV1

customConfigurationInfo object

Description for customConfigurationInfo in CustomFilterApiV1

creationDatestring

Description for creationDate in CustomConfigurationInfoApiV1

dataViewTypestring

Description for dataViewType in CustomConfigurationInfoApiV1

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

Description for encodedKey in CustomConfigurationInfoApiV1

indexInListnumber

Description for indexInList in CustomConfigurationInfoApiV1

lastModifiedDatestring

Description for lastModifiedDate in CustomConfigurationInfoApiV1

namestring

Description for name in CustomConfigurationInfoApiV1

sharedboolean

Description for shared in CustomConfigurationInfoApiV1

userKeystring

Description for userKey in CustomConfigurationInfoApiV1

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

Description for savingsConstraintsUsage in TransactionChannelInTransactionDetailsApiV1

Possible values: [UNCONSTRAINED_USAGE, LIMITED_USAGE]

transactionChannelAccountingRule object

Description for transactionChannelAccountingRule in TransactionChannelInTransactionDetailsApiV1

account object

Description for account in GLAccountingRuleApiV1

activatedboolean

Description for activated in GLAccountApiV1

allowManualJournalEntriesboolean

Description for allowManualJournalEntries in GLAccountApiV1

balancenumber

Description for balance in GLAccountApiV1

creationDatestring

Description for creationDate in GLAccountApiV1

currency object

Description for currency in GLAccountApiV1

codestring

Description for code in CurrencyApiV1

creationDatestring

Description for creationDate in CurrencyApiV1

currencySymbolPositionstring

Description for currencySymbolPosition in CurrencyApiV1

Possible values: [AFTER_NUMBER, BEFORE_NUMBER]

digitsAfterDecimalnumber

Description for digitsAfterDecimal in CurrencyApiV1

isBaseCurrencyboolean

Description for isBaseCurrency in CurrencyApiV1

lastModifiedDatestring

Description for lastModifiedDate in CurrencyApiV1

namestring

Description for name in CurrencyApiV1

symbolstring

Description for symbol in CurrencyApiV1

descriptionstring

Description for description in GLAccountApiV1

encodedKeystring

Description for encodedKey in GLAccountApiV1

glCodestring

Description for glCode in GLAccountApiV1

lastModifiedDatestring

Description for lastModifiedDate in GLAccountApiV1

migrationEvent object

Description for migrationEvent in GLAccountApiV1

creationDatestring

Description for creationDate in DataMigrationEventApiV1

encodedKeystring

Description for encodedKey in DataMigrationEventApiV1

numCentresImportednumber

Description for numCentresImported in DataMigrationEventApiV1

numClientsImportednumber

Description for numClientsImported in DataMigrationEventApiV1

numGLAccountsImportednumber

Description for numGLAccountsImported in DataMigrationEventApiV1

numGroupsImportednumber

Description for numGroupsImported in DataMigrationEventApiV1

numLoanRepaymentsImportednumber

Description for numLoanRepaymentsImported in DataMigrationEventApiV1

numLoanTransactionsImportednumber

Description for numLoanTransactionsImported in DataMigrationEventApiV1

numLoansImportednumber

Description for numLoansImported in DataMigrationEventApiV1

numSavingsImportednumber

Description for numSavingsImported in DataMigrationEventApiV1

statestring

Description for state in DataMigrationEventApiV1

Possible values: [REVERTED, DRAFT, APPROVED]

typestring

Description for type in DataMigrationEventApiV1

Possible values: [IMPORT, EXPORT]

namestring

Description for name in GLAccountApiV1

stripTrailingZerosboolean

Description for stripTrailingZeros in GLAccountApiV1

typestring

Description for type in GLAccountApiV1

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

usagestring

Description for usage in GLAccountApiV1

Possible values: [HEADER, DETAIL]

encodedKeystring

Description for encodedKey in GLAccountingRuleApiV1

financialResourcestring

Description for financialResource in GLAccountingRuleApiV1

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

Description for index in GLAccountingRuleApiV1

predefinedFeeKeystring

Description for predefinedFeeKey in GLAccountingRuleApiV1

productKeystring

Description for productKey in GLAccountingRuleApiV1

productTypestring

Description for productType in GLAccountingRuleApiV1

Possible values: [LOAN, SAVINGS]

transactionChannelKeystring

Description for transactionChannelKey in GLAccountingRuleApiV1

usageRights object

Description for usageRights in TransactionChannelInTransactionDetailsApiV1

encodedKeystring

Description for encodedKey in UsageRightsApiV1

isAccessibleByAllUsersboolean

Description for isAccessibleByAllUsers in UsageRightsApiV1

rolesstring[]

Description for roles in UsageRightsApiV1

Transactionchannelintransactiondetailsapiv1

{
  "activated": true,
  "createdByUserKey": "string",
  "creationDate": "string",
  "customFields": [
    {
      "amounts": {},
      "builtInCustomFieldId": "MOBILE_PHONE",
      "creationDate": "string",
      "customFieldProductSettings": [
        {
          "customFieldEncodedKey": "string",
          "encodedKey": "string",
          "isDefault": true,
          "isRequired": true,
          "linkType": "CLIENT_ROLE",
          "productKey": "string"
        }
      ],
      "customFieldSelectionOptions": [
        {
          "constraint": {
            "customFieldKey": "string",
            "dataFieldType": "NATIVE",
            "dataFieldValue": "string",
            "dataItemType": "WRITTEN_OFF_LOANS",
            "dataType": "ENUM",
            "encodedKey": "string",
            "filterElement": "STARTS_WITH_CASE_SENSITIVE",
            "groupNumber": 0,
            "index": 0,
            "linkingOperator": "OR",
            "secondValue": "string",
            "value": "string"
          },
          "encodedKey": "string",
          "id": "string",
          "score": 0,
          "value": "string"
        }
      ],
      "customFieldSet": {
        "builtInType": "DETAILS",
        "createdDate": "string",
        "customFields": [
          null
        ],
        "encodedKey": "string",
        "id": "string",
        "indexInList": 0,
        "lastModifiedDate": "string",
        "name": "string",
        "notes": "string",
        "type": "USER_INFO",
        "usage": "SINGLE"
      },
      "dataType": "GROUP_LINK",
      "description": "string",
      "editRights": {
        "encodedKey": "string",
        "isAccessibleByAllUsers": true,
        "roles": [
          "string"
        ]
      },
      "encodedKey": "string",
      "id": "string",
      "indexInList": 0,
      "isDefault": true,
      "isRequired": true,
      "lastModifiedDate": "string",
      "name": "string",
      "state": "DEACTIVATED",
      "type": "USER_INFO",
      "unique": true,
      "validationPattern": "string",
      "valueLength": "SHORT",
      "values": [
        "string"
      ],
      "viewRights": {
        "encodedKey": "string",
        "isAccessibleByAllUsers": true,
        "roles": [
          "string"
        ]
      }
    }
  ],
  "encodedKey": "string",
  "id": "string",
  "index": 0,
  "name": "string",
  "savingsConstraints": {
    "customConfigurationInfo": {
      "creationDate": "string",
      "dataViewType": "PORTAL_ACCOUNT_TRANSACTION",
      "encodedKey": "string",
      "indexInList": 0,
      "lastModifiedDate": "string",
      "name": "string",
      "shared": true,
      "userKey": "string"
    },
    "encodedKey": "string",
    "filterConstraints": [
      {
        "customFieldKey": "string",
        "dataFieldType": "NATIVE",
        "dataFieldValue": "string",
        "dataItemType": "WRITTEN_OFF_LOANS",
        "dataType": "ENUM",
        "encodedKey": "string",
        "filterElement": "STARTS_WITH_CASE_SENSITIVE",
        "groupNumber": 0,
        "index": 0,
        "linkingOperator": "OR",
        "secondValue": "string",
        "value": "string"
      }
    ]
  },
  "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
  "transactionChannelAccountingRule": {
    "account": {
      "activated": true,
      "allowManualJournalEntries": true,
      "balance": 0,
      "creationDate": "string",
      "currency": {
        "code": "string",
        "creationDate": "string",
        "currencySymbolPosition": "AFTER_NUMBER",
        "digitsAfterDecimal": 0,
        "isBaseCurrency": true,
        "lastModifiedDate": "string",
        "name": "string",
        "symbol": "string"
      },
      "description": "string",
      "encodedKey": "string",
      "glCode": "string",
      "lastModifiedDate": "string",
      "migrationEvent": {
        "creationDate": "string",
        "encodedKey": "string",
        "numCentresImported": 0,
        "numClientsImported": 0,
        "numGLAccountsImported": 0,
        "numGroupsImported": 0,
        "numLoanRepaymentsImported": 0,
        "numLoanTransactionsImported": 0,
        "numLoansImported": 0,
        "numSavingsImported": 0,
        "state": "REVERTED",
        "type": "IMPORT"
      },
      "name": "string",
      "stripTrailingZeros": true,
      "type": "INCOME",
      "usage": "HEADER"
    },
    "encodedKey": "string",
    "financialResource": "FEE_RECEIVABLE",
    "index": 0,
    "predefinedFeeKey": "string",
    "productKey": "string",
    "productType": "LOAN",
    "transactionChannelKey": "string"
  },
  "usageRights": {
    "encodedKey": "string",
    "isAccessibleByAllUsers": true,
    "roles": [
      "string"
    ]
  }
}