Groupexpandedapiv1
a group object with full details
addresses object[]
a list of addresses for this group
the type of the address, eg. home, office. Deprecated.
the city
the country
the automatically generated encoded ID for this item
the index of this address when there are multiple addresses assigned for a single entity
the latitude of the address point
the first line of the address
the second line of the address
the longitude of the address point
the encoded key of the entity to whom this address belongs, for example, the client of group
the postal (zip) code of the address
the region of the address
whether this address is marked to be deleted
customInformation object[]
custom information associated with this group
Description for amount in CustomFieldValueApiV1
customField object
Description for customField in CustomFieldValueApiV1
amounts object
used when options available for a custom field definition translate to predefined amounts, for example, when the custom field value is used to generate a score
if this field is one of the built in custom fiel definitions, this will have a value. These names are reserved and you can not use them for your own custom field definitions
Possible values: [MOBILE_PHONE, EMAIL_ADDRESS, GENDER, MIDDLE_NAME, HOME_PHONE, BIRTHDATE, LAST_NAME, FIRST_NAME]
the date on which this custom field definition was created
customFieldProductSettings object[]
Description for customFieldProductSettings in CustomFieldApiV1
the key to the parent custom field definition
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472whether this field is displayed by default when creating a new record
whether this field is required when creating a new record
the type of entity this field represents a link to
Possible values: [CLIENT_ROLE, CHANNEL, PRODUCT]
when the link type is product, this field should contain the encoded key of the linekd product
customFieldSelectionOptions object[]
Description for customFieldSelectionOptions in CustomFieldApiV1
constraint object
Description for constraint in CustomFieldSelectionApiV1
Description for customFieldKey in CustomFilterConstraintApiV1
Description for dataFieldType in CustomFilterConstraintApiV1
Possible values: [NATIVE, CUSTOM]
Description for dataFieldValue in CustomFilterConstraintApiV1
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]
Description for dataType in CustomFilterConstraintApiV1
Possible values: [ENUM, MONEY, NUMBER, DATE_UTC, JAVA_BLOB, OBJECT, BOOLEAN, DATE, PERCENT, BIG_DECIMAL, STRING, KEY, LONG]
Description for encodedKey in CustomFilterConstraintApiV1
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]
Description for groupNumber in CustomFilterConstraintApiV1
Description for index in CustomFilterConstraintApiV1
Description for linkingOperator in CustomFilterConstraintApiV1
Possible values: [OR, AND]
Description for secondValue in CustomFilterConstraintApiV1
Description for value in CustomFilterConstraintApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472the ID of this selectable item
the score assigned to this selection
display name of this option
customFieldSet object
Description for customFieldSet in CustomFieldApiV1
if this set is part of the set of built-in custom field sets, its type will be shown here
Possible values: [DETAILS, GENERAL]
the date and time when this custom field set was created
customFields object[]
an array of custom field definitions included in this custom field set
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472the ID of this custom field set
for field sets that can be added to an entity more than once, this number represents the index in the list and is used when changing values
the date on which this custom field set was last modified
the name of this custom field set
any notes regarding this custom field set
the entity type that this custom field definition is attached to
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]
whether this custom field set can only be used once, or added multiple times to the same entity
Possible values: [SINGLE, GROUPED]
the type of custom field definition
Possible values: [GROUP_LINK, DATE, NUMBER, CHECKBOX, CLIENT_LINK, STRING, USER_LINK, SELECTION]
a brief description of this custom field definition
editRights object
Description for editRights in CustomFieldApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for isAccessibleByAllUsers in UsageRightsApiV1
Description for roles in UsageRightsApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472the ID for this custom field definition
Description for indexInList in CustomFieldApiV1
whether this field will be included by default on new records
whether this field is required when creating a new record
the date on which this custom field definition was last modified
the name of this custom field definition
whether this field is available for use or has been deactivated
Possible values: [DEACTIVATED, NORMAL]
the type of data this custom field definition will contain
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]
whether the data in this custom field definition needs to be a unique value
a user-provided pattern to which data in this custom field definition must conform where @ represents numbers, # represents letters and $ is either a number or letter. Other special characters used as separators are allowed, for example @@-##-$$$
whether this field needs to support a large number of characters
Possible values: [SHORT, LONG]
a list of possible values when the field is a selection field
viewRights object
Description for viewRights in CustomFieldApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for isAccessibleByAllUsers in UsageRightsApiV1
Description for roles in UsageRightsApiV1
Description for customFieldID in CustomFieldValueApiV1
Description for customFieldKey in CustomFieldValueApiV1
Description for customFieldSetGroupIndex in CustomFieldValueApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for indexInList in CustomFieldValueApiV1
Description for linkedEntityKeyValue in CustomFieldValueApiV1
Description for parentKey in CustomFieldValueApiV1
Description for selectionKey in CustomFieldValueApiV1
Description for value in CustomFieldValueApiV1
groupMembers object[]
a list of members of this group
the encoded key of this group member. Members must have an existing client record
the date and time when this group member was added
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472the key of the group of which this client is a member
if a group contains more than one member, this number represents the index in the list for this member
groupRoles object[]
a list of roles which members of this group can have
the encoded key of the group member who has this role
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472the encoded key of the group which uses this role
the encoded key of the group role
Description for indexInList in GroupRoleApiV1
the name of this role
theGroup object
Description for theGroup in GroupExpandedApiV1
the encoded key of the branch to which this group is assigned
the encoded key of the centre to which this group is assigned
the encoded key of the Mambu user to which this group is assigned
clientRole object
Description for clientRole in GroupApiV1
the automatically generated encoded ID for this client or group type
the date and time when this group was created
the email address for this group. This address will be used for automated and manually sent email notifications
the automatically generated encoded ID for this group
8a19b7057471f4af017472dc0fd80472the name of the group
the primary landline contact number for this group
the ID for this group
the pattern used to generate IDs
the date on which this group was last modified
this number will increment each time this group takes out and fully pays back a loan
migrationEvent object
Description for migrationEvent in GroupApiV1
the date on which the data import was made
the encoded key of this data migration event
the number of centres which were imported during the data migration
the number of clients which were imported as part of the data migration
the number of general ledger accounts which were imported as part of the data migration
the number of groups which were imported as part of the data migration
the number of loan repayment transations which were imported as part of the data migration
the number of loan transactions which were imported as part of the data migration
the number of loan accounts which were imported as part of the data migration
the number of savings accounts which were imported as part of the data migration
whether the data import was accepted, is still in a draft state, or was rejected and all data reverted
Possible values: [REVERTED, DRAFT, APPROVED]
the type of migration event
Possible values: [IMPORT, EXPORT]
the primiary mobile contact number for this group
the language which shoudl ideally be used when communicating with this group
Possible values: [PORTUGESE, RUSSIAN, ROMANIAN, ENGLISH, SPANISH, GEORGIAN, BURMESE, PHRASE, CHINESE, FRENCH, INDONESIAN]
{
"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
}
],
"customInformation": [
{
"amount": 0,
"customField": {
"amounts": {},
"builtInCustomFieldId": "MOBILE_PHONE",
"creationDate": "string",
"customFieldProductSettings": [
{
"customFieldEncodedKey": "string",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"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": "8a19b7057471f4af017472dc0fd80472",
"id": "string",
"score": 0,
"value": "string"
}
],
"customFieldSet": {
"builtInType": "DETAILS",
"createdDate": "string",
"customFields": [
{}
],
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"id": "string",
"indexInList": 0,
"lastModifiedDate": "string",
"name": "string",
"notes": "string",
"type": "USER_INFO",
"usage": "SINGLE"
},
"dataType": "GROUP_LINK",
"description": "string",
"editRights": {
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"isAccessibleByAllUsers": true,
"roles": [
"string"
]
},
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"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": "8a19b7057471f4af017472dc0fd80472",
"isAccessibleByAllUsers": true,
"roles": [
"string"
]
}
},
"customFieldID": "string",
"customFieldKey": "string",
"customFieldSetGroupIndex": 0,
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"indexInList": 0,
"linkedEntityKeyValue": "string",
"parentKey": "string",
"selectionKey": "string",
"value": "string"
}
],
"groupMembers": [
{
"clientKey": "string",
"creationDate": "string",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"groupKey": "string",
"indexInList": 0
}
],
"groupRoles": [
{
"clientKey": "string",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"groupKey": "string",
"groupRoleNameKey": "string",
"indexInList": 0,
"roleName": "string"
}
],
"theGroup": {
"assignedBranchKey": "string",
"assignedCentreKey": "string",
"assignedUserKey": "string",
"clientRole": {
"encodedKey": "string"
},
"creationDate": "2024-07-29T15:51:28.071Z",
"emailAddress": "string",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"groupName": "string",
"homePhone": "string",
"id": "string",
"idPattern": "string",
"lastModifiedDate": "2024-07-29T15:51:28.071Z",
"loanCycle": 0,
"migrationEvent": {
"creationDate": "2024-07-29T15:51:28.071Z",
"encodedKey": "string",
"numCentresImported": 0,
"numClientsImported": 0,
"numGLAccountsImported": 0,
"numGroupsImported": 0,
"numLoanRepaymentsImported": 0,
"numLoanTransactionsImported": 0,
"numLoansImported": 0,
"numSavingsImported": 0,
"state": "REVERTED",
"type": "IMPORT"
},
"mobilePhone1": "string",
"preferredLanguage": "PORTUGESE"
}
}