GroupsApi

Activate a Group | Associate Clients | Disassociate Clients | Transfer Clients across groups | Generate Collection Sheet | Save Collection Sheet | Unassign a Staff | Assign a Staff | Close a Group | Unassign a Role | Update a Role Activate a Group: Groups can be created in a Pending state. This API exists to enable group activation. If the group happens to be already active this API will result in an error. Mandatory Fields: activationDate Associate Clients: This API allows to associate existing clients to a group. The clients are listed from the office to which the group is associated. If client(s) is already associated with group then API will result in an error. Mandatory Fields: clientMembers Disassociate Clients: This API allows to disassociate clients from a group. Disassociating a client with active joint liability group loans results in an error. Mandatory Fields: clientMembers Transfer Clients across groups: This API allows to transfer clients from one group to another Mandatory Fields: destinationGroupId and clients Optional Fields: inheritDestinationGroupLoanOfficer (defaults to true) and transferActiveLoans (defaults to true) Generate Collection Sheet: This API retrieves repayment details of all jlg loans of all members of a group on a specified meeting date. Mandatory Fields: calendarId and transactionDate Save Collection Sheet: This api allows the loan officer to perform bulk repayments of JLG loans for a group on its meeting date. Mandatory Fields: calendarId, transactionDate, actualDisbursementDate Optional Fields: clientsAttendance, bulkRepaymentTransaction, bulkDisbursementTransactions Unassign a Staff: Allows you to unassign the Staff. Mandatory Fields: staffId Assign a Staff: Allows you to assign Staff to an existing Group. The selected Staff should be belong to the same office (or an office higher up in the hierarchy) as this groupMandatory Fields: staffId Optional Fields: inheritStaffForClientAccounts (Optional: Boolean if true all members of the group (i.e all clients with active loans and savings ) will inherit the staffId) Close a Group: This API exists to close a group. Groups can be closed if they don't have any non-closed clients/loans/savingsAccounts. If the group has any active clients/loans/savingsAccount, this API will result in an error.Assign a Role: Allows you to assign a Role to an existing member of a group. We can define the different roles applicable to group members by adding code values to the pre-defined system code GROUPROLE. Example:Group leader etc. Mandatory Fields: clientId, role Unassign a Role: Allows you to unassign Roles associated tp Group members. Update a Role: Allows you to update the member Role. Mandatory Fields: role Showing request/response for Transfer Clients across groups Responses:

Create a Group Creates a Group Mandatory Fields: name, officeId, active, activationDate (if active=true) Optional Fields: externalId, staffId, clientMembers Responses:

Delete a Group A group can be deleted if it is in pending state and has no associations - clients, loans or savings Responses:

Responses:

Responses:

Retrieve Group accounts overview Retrieves details of all Loan and Savings accounts associated with this group. Example Requests: groups/1/accounts groups/1/accounts?fields=loanAccounts,savingsAccounts,memberLoanAccounts, memberSavingsAccounts Responses:

List Groups The default implementation of listing Groups returns 200 entries with support for pagination and sorting. Using the parameter limit with description -1 returns all entries. Example Requests: groups groups?fields=name,officeName,joinedDate groups?offset=10&limit=50 groups?orderBy=name&sortOrder=DESC Responses:

Responses:

Responses:

Retrieve a Group Retrieve group information. Example Requests: groups/1 groups/1?associations=clientMembers Responses:

Retrieve Group Template This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Requests: groups/template groups/template?officeId=2 groups/template?centerId=1 groups/template?centerId=1&staffInSelectedOfficeOnly=true Responses:

Unassign a Staff Allows you to unassign the Staff. Mandatory Fields: staffId Responses:

Update a Group Updates a Group Responses: