Transactionchannelintransactiondetailsapiv1

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

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

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

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

]

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

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

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

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

a 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

the date on which this general ledger account was last modified

migrationEvent object

Description for migrationEvent in GLAccountApiV1

creationDatestring

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

whether '0' characters should be ignored for this general ledger account. This has an impact on how general ledger accounts are grouped under header accounts

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

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,
  "loanConstraints": {
    "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"
      }
    ]
  },
  "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
  "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"
    ]
  }
}