Customfieldapiv1

encodedKeystring

Description for encodedKey in CustomFieldApiV1

idstring

Description for id in CustomFieldApiV1

creationDatestring

Description for creationDate in CustomFieldApiV1

lastModifiedDatestring

Description for lastModifiedDate in CustomFieldApiV1

namestring

Description for name in CustomFieldApiV1

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]

dataTypestring

Description for dataType in CustomFieldApiV1

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

valueLengthstring

Description for valueLength in CustomFieldApiV1

Possible values: [SHORT, LONG]

isDefaultboolean

Description for isDefault in CustomFieldApiV1

isRequiredboolean

Description for isRequired in CustomFieldApiV1

descriptionstring

Description for description in CustomFieldApiV1

customFieldSet object

Description for customFieldSet in CustomFieldApiV1

encodedKeystring

Description for encodedKey in CustomFieldSetApiV1

idstring

Description for id in CustomFieldSetApiV1

namestring

Description for name in CustomFieldSetApiV1

notesstring

Description for notes in CustomFieldSetApiV1

createdDatestring

Description for createdDate in CustomFieldSetApiV1

lastModifiedDatestring

Description for lastModifiedDate in CustomFieldSetApiV1

indexInListnumber

Description for indexInList 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]

builtInTypestring

Description for builtInType in CustomFieldSetApiV1

Possible values: [DETAILS, GENERAL]

customFieldsundefined[]

Description for customFields in CustomFieldSetApiV1

indexInListnumber

Description for indexInList in CustomFieldApiV1

statestring

Description for state in CustomFieldApiV1

Possible values: [DEACTIVATED, NORMAL]

customFieldSelectionOptions object[]

Description for customFieldSelectionOptions in CustomFieldApiV1

Array [

encodedKeystring

Description for encodedKey in CustomFieldSelectionApiV1

idstring

Description for id in CustomFieldSelectionApiV1

valuestring

Description for value in CustomFieldSelectionApiV1

scorenumber

Description for score in CustomFieldSelectionApiV1

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

]

validationPatternstring

Description for validationPattern 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

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

uniqueboolean

Description for unique in CustomFieldApiV1

valuesstring[]

Description for values in CustomFieldApiV1

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]

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

]

Customfieldapiv1

{
  "encodedKey": "string",
  "id": "string",
  "creationDate": "string",
  "lastModifiedDate": "string",
  "name": "string",
  "type": "USER_INFO",
  "dataType": "GROUP_LINK",
  "valueLength": "SHORT",
  "isDefault": true,
  "isRequired": true,
  "description": "string",
  "customFieldSet": {
    "encodedKey": "string",
    "id": "string",
    "name": "string",
    "notes": "string",
    "createdDate": "string",
    "lastModifiedDate": "string",
    "indexInList": 0,
    "type": "USER_INFO",
    "usage": "SINGLE",
    "builtInType": "DETAILS",
    "customFields": [
      null
    ]
  },
  "indexInList": 0,
  "state": "DEACTIVATED",
  "customFieldSelectionOptions": [
    {
      "encodedKey": "string",
      "id": "string",
      "value": "string",
      "score": 0,
      "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"
      }
    }
  ],
  "validationPattern": "string",
  "viewRights": {
    "encodedKey": "string",
    "isAccessibleByAllUsers": true,
    "roles": [
      "string"
    ]
  },
  "editRights": {
    "encodedKey": "string",
    "isAccessibleByAllUsers": true,
    "roles": [
      "string"
    ]
  },
  "unique": true,
  "values": [
    "string"
  ],
  "amounts": {},
  "builtInCustomFieldId": "MOBILE_PHONE",
  "customFieldProductSettings": [
    {
      "customFieldEncodedKey": "string",
      "encodedKey": "string",
      "isDefault": true,
      "isRequired": true,
      "linkType": "CLIENT_ROLE",
      "productKey": "string"
    }
  ]
}