Clientexpandedapiv1

addresses object[]

Description for addresses in ClientExpandedApiV1

Array [

addressTypestring

Description for addressType in AddressApiV1

citystring

Description for city in AddressApiV1

countrystring

Description for country in AddressApiV1

encodedKeystring

Description for encodedKey in AddressApiV1

indexInListnumber

Description for indexInList in AddressApiV1

latitudenumber

Description for latitude in AddressApiV1

line1string

Description for line1 in AddressApiV1

line2string

Description for line2 in AddressApiV1

longitudenumber

Description for longitude in AddressApiV1

parentKeystring

Description for parentKey in AddressApiV1

postcodestring

Description for postcode in AddressApiV1

regionstring

Description for region in AddressApiV1

toBeDeletedboolean

Description for toBeDeleted in AddressApiV1

]

centreIdstring

Description for centreId in ClientExpandedApiV1

client object

Description for client in ClientExpandedApiV1

activationDatestring

Description for activationDate in ClientApiV1

approvedDatestring

Description for approvedDate in ClientApiV1

assignedBranchKeystring

Description for assignedBranchKey in ClientApiV1

assignedCentreKeystring

Description for assignedCentreKey in ClientApiV1

assignedUserKeystring

Description for assignedUserKey in ClientApiV1

birthDatestring

Description for birthDate in ClientApiV1

clientRole object

Description for clientRole in ClientApiV1

encodedKeystring

Description for encodedKey in ClientRoleBasicApiV1

closedDatestring

Description for closedDate in ClientApiV1

creationDatestring

Description for creationDate in ClientApiV1

emailAddressstring

Description for emailAddress in ClientApiV1

encodedKeystring

Description for encodedKey in ClientApiV1

firstNamestring

Description for firstName in ClientApiV1

genderstring

Description for gender in ClientApiV1

Possible values: [MALE, FEMALE]

groupLoanCyclenumber

Description for groupLoanCycle in ClientApiV1

homePhonestring

Description for homePhone in ClientApiV1

idstring

Description for id in ClientApiV1

idPatternstring

Description for idPattern in ClientApiV1

lastModifiedDatestring

Description for lastModifiedDate in ClientApiV1

lastNamestring

Description for lastName in ClientApiV1

loanCyclenumber

Description for loanCycle in ClientApiV1

middleNamestring

Description for middleName in ClientApiV1

migrationEvent object

Description for migrationEvent in ClientApiV1

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]

mobilePhone1string

Description for mobilePhone1 in ClientApiV1

mobilePhone2string

Description for mobilePhone2 in ClientApiV1

notesstring

Description for notes in ClientApiV1

portalPreferences object

Description for portalPreferences in ClientApiV1

encodedKeystring

Description for encodedKey in PortalPreferencesApiV1

lastLoggedInDatestring

Description for lastLoggedInDate in PortalPreferencesApiV1

passwordstring

Description for password in PortalPreferencesApiV1

portalStatestring

Description for portalState in PortalPreferencesApiV1

Possible values: [DISABLED, ENABLED]

preferredLanguagestring

Description for preferredLanguage in ClientApiV1

Possible values: [PORTUGESE, RUSSIAN, ROMANIAN, ENGLISH, SPANISH, GEORGIAN, BURMESE, PHRASE, CHINESE, FRENCH, INDONESIAN]

profilePictureKeystring

Description for profilePictureKey in ClientApiV1

profileSignatureKeystring

Description for profileSignatureKey in ClientApiV1

statestring

Description for state in ClientApiV1

Possible values: [PENDING_APPROVAL, ACTIVE, INACTIVE, EXITED, BLACKLISTED, REJECTED]

clientTypeIdstring

Description for clientTypeId in ClientExpandedApiV1

customInformation object[]

Description for customInformation in ClientExpandedApiV1

Array [

amountnumber

Description for amount in CustomFieldValueApiV1

customField object

Description for customField in CustomFieldValueApiV1

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

customFields object[]

Description for customFields in CustomFieldSetApiV1

Array [

]

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

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

customFieldIDstring

Description for customFieldID in CustomFieldValueApiV1

customFieldKeystring

Description for customFieldKey in CustomFieldValueApiV1

customFieldSetGroupIndexnumber

Description for customFieldSetGroupIndex in CustomFieldValueApiV1

encodedKeystring

Description for encodedKey in CustomFieldValueApiV1

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

]

groupKeysstring[]

Description for groupKeys in ClientExpandedApiV1

idDocuments object[]

Description for idDocuments in ClientExpandedApiV1

Array [

clientKeystring

Description for clientKey in IdentificationDocumentApiV1

documentIdstring

Description for documentId in IdentificationDocumentApiV1

documentTypestring

Description for documentType in IdentificationDocumentApiV1

encodedKeystring

Description for encodedKey in IdentificationDocumentApiV1

identificationDocumentTemplateKeystring

Description for identificationDocumentTemplateKey in IdentificationDocumentApiV1

indexInListnumber

Description for indexInList in IdentificationDocumentApiV1

issuingAuthoritystring

Description for issuingAuthority in IdentificationDocumentApiV1

toBeDeletedboolean

Description for toBeDeleted in IdentificationDocumentApiV1

validUntilstring

Description for validUntil in IdentificationDocumentApiV1

validUntilDTOdate object

Description for validUntilDTOdate in IdentificationDocumentApiV1

dayOfMonthnumber

Description for dayOfMonth in DateDTOApiV1

monthOfYearnumber

Description for monthOfYear in DateDTOApiV1

yearnumber

Description for year in DateDTOApiV1

]

notificationTemplates object[]

Description for notificationTemplates in ClientExpandedApiV1

Array [

activatedboolean

Description for activated in MessageTemplateApiV1

authorizationstring

Description for authorization in MessageTemplateApiV1

Possible values: [NO_AUTHORIZATION, BASIC_AUTHORIZATION]

contentTypestring

Description for contentType in MessageTemplateApiV1

Possible values: [PLAIN_TEXT, APPLICATION_JSON, APPLICATION_XML]

creationDatestring

Description for creationDate in MessageTemplateApiV1

customFilter object

Description for customFilter in MessageTemplateApiV1

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

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

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 MessageTemplateApiV1

eventstring

Description for event in MessageTemplateApiV1

Possible values: [LOAN_CREATED, SAVINGS_ACCOUNT_REJECTION, SAVINGS_ACCOUNT_ACTIVATED, DATA_ACCESS_STATE_CHANGED, REPAYMENT_REMINDER, LOAN_ANTICIPATED_DISBURSEMENT, CREDIT_ARRANGEMENT_deleteD, SAVINGS_APPROVAL, PORTAL_ACTIVATED, SAVINGS_DEPOSIT, PORTAL_PASSWORD_RESET, CREDIT_ARRANGEMENT_REJECTED, LOAN_REPAYMENT_REVERSAL, SAVINGS_ACCOUNT_CLOSURE, LOAN_ACCOUNT_REJECTION, LOAN_ACCOUNT_RESCHEDULED, ACCOUNT_IN_ARREARS, LOAN_DISBURSEMENT_REVERSAL, SAVINGS_DEPOSIT_REVERSAL, CLIENT_APPROVED, LOAN_REPAYMENT, LOAN_ACCOUNT_ACTIVITY, GROUP_CREATED, LOAN_DISBURSEMENT, CREDIT_ARRANGEMENT_APPROVED, MANUAL, END_OF_DAY_PROCESSING_COMPLETED, CREDIT_ARRANGEMENT_ACCOUNT_ADDED, CLIENT_REJECTED, CLIENT_ACTIVITY, LOAN_ACCOUNT_REFINANCED, SAVINGS_CREATED, CLIENT_CREATED, LOAN_APPROVAL, GROUP_ACTIVITY, LOAN_ACCOUNT_CLOSURE, SAVINGS_WITHDRAWAL_REVERSAL, CREDIT_ARRANGEMENT_WITHDRAWN, CREDIT_ARRANGEMENT_CREATED, SAVINGS_WITHDRAWAL, SAVINGS_ACCOUNT_ACTIVITY, LOAN_ACCOUNT_WRITE_OFF, CREDIT_ARRANGEMENT_ACCOUNT_REMOVED, CREDIT_ARRANGEMENT_CLOSED]

isInUseboolean

Description for isInUse in MessageTemplateApiV1

lastModifiedDatestring

Description for lastModifiedDate in MessageTemplateApiV1

namestring

Description for name in MessageTemplateApiV1

optionstring

Description for option in MessageTemplateApiV1

Possible values: [OPT_IN, OPT_OUT]

recipient object

Description for recipient in MessageTemplateApiV1

customField object

Description for customField in MessageTemplateRecipientApiV1

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

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

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

customFields object[]

Description for customFields in CustomFieldSetApiV1

Array [

]

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

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

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 MessageTemplateRecipientApiV1

groupRole object

Description for groupRole in MessageTemplateRecipientApiV1

encodedKeystring

Description for encodedKey in GroupRoleNameApiV1

namestring

Description for name in GroupRoleNameApiV1

recipientTypestring

Description for recipientType in MessageTemplateRecipientApiV1

Possible values: [CREDIT_OFFICER, CUSTOM_FIELD, GROUP_ROLE, CLIENT]

requestTypestring

Description for requestType in MessageTemplateApiV1

Possible values: [HEAD, delete, post, get, put, patch]

subjectstring

Description for subject in MessageTemplateApiV1

targetTypestring

Description for targetType in MessageTemplateApiV1

Possible values: [LOANS, GROUP, SAVINGS, DATA_ACCESS, BACKGROUND_PROCESS, CLIENT]

templatestring

Description for template in MessageTemplateApiV1

topicstring

Description for topic in MessageTemplateApiV1

triggerstring

Description for trigger in MessageTemplateApiV1

Possible values: [AUTOMATIC, MANUAL]

triggerDaysnumber

Description for triggerDays in MessageTemplateApiV1

typestring

Description for type in MessageTemplateApiV1

Possible values: [EVENT_STREAM, TASK, SMS, EMAIL, WEB_HOOK]

urlstring

Description for url in MessageTemplateApiV1

usernamestring

Description for username in MessageTemplateApiV1

]

Clientexpandedapiv1
{
  "addresses": [
    {
      "addressType": "string",
      "city": "string",
      "country": "string",
      "encodedKey": "string",
      "indexInList": 0,
      "latitude": 0,
      "line1": "string",
      "line2": "string",
      "longitude": 0,
      "parentKey": "string",
      "postcode": "string",
      "region": "string",
      "toBeDeleted": true
    }
  ],
  "centreId": "string",
  "client": {
    "activationDate": "string",
    "approvedDate": "string",
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "birthDate": "string",
    "clientRole": {
      "encodedKey": "string"
    },
    "closedDate": "string",
    "creationDate": "string",
    "emailAddress": "string",
    "encodedKey": "string",
    "firstName": "string",
    "gender": "MALE",
    "groupLoanCycle": 0,
    "homePhone": "string",
    "id": "string",
    "idPattern": "string",
    "lastModifiedDate": "string",
    "lastName": "string",
    "loanCycle": 0,
    "middleName": "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"
    },
    "mobilePhone1": "string",
    "mobilePhone2": "string",
    "notes": "string",
    "portalPreferences": {
      "encodedKey": "string",
      "lastLoggedInDate": "string",
      "password": "string",
      "portalState": "DISABLED"
    },
    "preferredLanguage": "PORTUGESE",
    "profilePictureKey": "string",
    "profileSignatureKey": "string",
    "state": "PENDING_APPROVAL"
  },
  "clientTypeId": "string",
  "customInformation": [
    {
      "amount": 0,
      "customField": {
        "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": [
            {}
          ],
          "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"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "string",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "groupKeys": [
    "string"
  ],
  "idDocuments": [
    {
      "clientKey": "string",
      "documentId": "string",
      "documentType": "string",
      "encodedKey": "string",
      "identificationDocumentTemplateKey": "string",
      "indexInList": 0,
      "issuingAuthority": "string",
      "toBeDeleted": true,
      "validUntil": "string",
      "validUntilDTOdate": {
        "dayOfMonth": 0,
        "monthOfYear": 0,
        "year": 0
      }
    }
  ],
  "notificationTemplates": [
    {
      "activated": true,
      "authorization": "NO_AUTHORIZATION",
      "contentType": "PLAIN_TEXT",
      "creationDate": "string",
      "customFilter": {
        "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"
          }
        ]
      },
      "encodedKey": "string",
      "event": "LOAN_CREATED",
      "isInUse": true,
      "lastModifiedDate": "string",
      "name": "string",
      "option": "OPT_IN",
      "recipient": {
        "customField": {
          "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": [
              {}
            ],
            "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",
        "groupRole": {
          "encodedKey": "string",
          "name": "string"
        },
        "recipientType": "CREDIT_OFFICER"
      },
      "requestType": "HEAD",
      "subject": "string",
      "targetType": "LOANS",
      "template": "string",
      "topic": "string",
      "trigger": "AUTOMATIC",
      "triggerDays": 0,
      "type": "EVENT_STREAM",
      "url": "string",
      "username": "string"
    }
  ]
}