Skip to main content

Clientapiv1

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]

Clientapiv1
{
"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"
}