Skip to main content

Groupapiv1

A group object

assignedBranchKeystring

the encoded key of the branch to which this group is assigned

assignedCentreKeystring

the encoded key of the centre to which this group is assigned

assignedUserKeystring

the encoded key of the Mambu user to which this group is assigned

clientRole object

Description for clientRole in GroupApiV1

encodedKeystring

the automatically generated encoded ID for this client or group type

creationDatestring<date-time>

the date and time when this group was created

emailAddressstring

the email address for this group. This address will be used for automated and manually sent email notifications

encodedKeystring

the automatically generated encoded ID for this group

Example: 8a19b7057471f4af017472dc0fd80472
groupNamestring

the name of the group

homePhonestring

the primary landline contact number for this group

idstring

the ID for this group

idPatternstring

the pattern used to generate IDs

lastModifiedDatestring<date-time>

the date on which this group was last modified

loanCyclenumber

this number will increment each time this group takes out and fully pays back a loan

migrationEvent object

Description for migrationEvent in GroupApiV1

creationDatestring<date-time>

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]

mobilePhone1string

the primiary mobile contact number for this group

preferredLanguagestring

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]

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