Skip to main content

Group

Represents a group. A group is a type of client that can represent a non-physical person such as a company client or a grouping of individual clients. A group can have its own accounts and can optionally have individual clients as members, in which case they also need to have an individual profile in Mambu.

addresses object[]

The addresses associated with this group.

  • Array [
    • citystring

    The city for the address.

    countrystring

    The country.

    encodedKeystring

    The address encoded key, which is unique and generated.

    indexInListint32

    The index of this address in the list of addresses.

    latitudenumber

    The GPS latitude of this address in signed degrees format (DDD.dddd) with 6 decimal positions, ranging from -90 to +90.

    line1string

    The first line of the address.

    line2string

    The second line of the address.

    longitudenumber

    The GPS longitude of this address in signed degrees format (DDD.dddd) with 6 decimal positions, ranging from -180 to +180.

    parentKeystring

    The address parent key indicating the object owning this address. For example: client, centre, or branch.

    postcodestring

    The post code.

    regionstring

    The region for the address.

  • ]
    • assignedBranchKeystring

    Key of the branch this group is assigned to.

    assignedCentreKeystring

    Key of the centre this group is assigned to.

    assignedUserKeystring

    Key of the user this group is assigned to.

    creationDatedate-time

    The date the group was created.

    Example: 2016-09-06T13:37:50+03:00
    emailAddressstring

    The email address associated with the group.

    encodedKeystring

    The encoded key of the group, which is auto generated, and must be unique.

    groupMembers object[]

    The members of this group.

  • Array [
    • clientKeystringrequired

    The encoded key of the client assigned as member of the group.

    roles object[]

    The group role name associated with a group member.

  • Array [
    • encodedKeystring

    The encoded key of the group role name, which is auto generated, and unique.

    groupRoleNameKeystringrequired

    The group role name key.

    roleNamestring

    The group role name.

    roleNameIdstring

    The group role name ID.

  • ]
  • ]
    • groupNamestringrequired

    The name of the group.

    groupRoleKeystring

    A role which describes the intended use of a group in the system.

    homePhonestring

    The home phone number associated with the group.

    idstring

    The ID of the group, which can be generated and customized, but must be unique.

    lastModifiedDatedate-time

    The last date the group was updated.

    Example: 2016-09-06T13:37:50+03:00
    loanCycleint32

    Number of paid and closed (with 'obligations met') accounts for this client. When the closing operation is reverted, this is reduced.

    migrationEventKeystring

    The migration event encoded key associated with this group.

    mobilePhonestring

    The mobile phone number associated with the group.

    notesstring

    Extra notes about this group.

    preferredLanguagestring

    The preferred language associated with the group (used for the notifications).

    Possible values: [ENGLISH, PORTUGESE, SPANISH, RUSSIAN, FRENCH, GEORGIAN, CHINESE, INDONESIAN, ROMANIAN, BURMESE, GERMAN, PORTUGUESE_BRAZIL, VIETNAMESE, ITALIAN, THAI, NORWEGIAN, PHRASE]

    Group
    {
      "addresses": [
        {
          "city": "string",
          "country": "string",
          "encodedKey": "string",
          "indexInList": 0,
          "latitude": 0,
          "line1": "string",
          "line2": "string",
          "longitude": 0,
          "parentKey": "string",
          "postcode": "string",
          "region": "string"
        }
      ],
      "assignedBranchKey": "string",
      "assignedCentreKey": "string",
      "assignedUserKey": "string",
      "creationDate": "2016-09-06T13:37:50+03:00",
      "emailAddress": "string",
      "encodedKey": "string",
      "groupMembers": [
        {
          "clientKey": "string",
          "roles": [
            {
              "encodedKey": "string",
              "groupRoleNameKey": "string",
              "roleName": "string",
              "roleNameId": "string"
            }
          ]
        }
      ],
      "groupName": "string",
      "groupRoleKey": "string",
      "homePhone": "string",
      "id": "string",
      "lastModifiedDate": "2016-09-06T13:37:50+03:00",
      "loanCycle": 0,
      "migrationEventKey": "string",
      "mobilePhone": "string",
      "notes": "string",
      "preferredLanguage": "ENGLISH"
    }