Skip to main content

Activity

an activity is an action that has taken place, either initiated by a user or the mambu system

activity object

an object containing details about the activity

encodedKeystringrequired

a unique key for this activity

transactionIDinteger

an ID for this activity

timestampstring<timestamp>required

the time at which the activity took place

typeactivityType (string)required

The types of activity which are recorded by the system

Possible values: [BRANCH_CREATED, BRANCH_COMMENT_ADDED, BRANCH_COMMENT_EDITED, BRANCH_COMMENT_DELETED, BRANCH_EDITED, BRANCH_DELETED, CENTRE_CREATED, CENTRE_COMMENT_ADDED, CENTRE_COMMENT_EDITED, CENTRE_COMMENT_DELETED, CENTRE_EDITED, CENTRE_DELETED, CLIENT_CREATED, CLIENT_COMMENT_ADDED, CLIENT_COMMENT_EDITED, CLIENT_COMMENT_DELETED, CLIENT_EDITED, CLIENT_DELETED, CLIENT_BRANCH_ASSIGNMENT, CLIENT_BRANCH_UNASSIGNMENT, CLIENT_CENTRE_ASSIGNMENT, CLIENT_CENTRE_UNASSIGNMENT, CLIENT_CREDIT_OFFICER_ASSIGNMENT, CLIENT_CREDIT_OFFICER_UNASSIGNMENT, CLIENT_SET_TO_PENDING, CLIENT_SET_TO_ACTIVE, CLIENT_SET_TO_INACTIVE, CLIENT_SET_TO_BLACKLISTED, CLIENT_SET_TO_REJECTED, CLIENT_SET_TO_EXITED, DATA_IMPORTED, DATA_IMPORT_APPROVED, DATA_IMPORT_REVERTED, DOCUMENT_CREATED, DOCUMENT_EDITED, DOCUMENT_DELETED, PRODUCT_DOCUMENT_TEMPLATE_CREATED, PRODUCT_DOCUMENT_TEMPLATE_DELETED, PRODUCT_DOCUMENT_TEMPLATE_EDITED, FEDERATED_AUTHENTICATION_SETTINGS_EDITED, ENTITY_CREATED, ENTITY_EDITED, ENTITY_DELETED, GLACCOUNT_CREATED, GLACCOUNT_EDITED, GLACCOUNT_DELETED, GLACCOUNTSCLOSURE_EXECUTED, GLACCOUNTSCLOSURE_UNDONE, CLIENT_JOINED_GROUP, CLIENT_LEFT_GROUP, GROUP_CREATED, GROUP_COMMENT_ADDED, GROUP_COMMENT_EDITED, GROUP_COMMENT_DELETED, GROUP_EDITED, GROUP_DELETED, GROUP_BRANCH_ASSIGNMENT, GROUP_BRANCH_UNASSIGNMENT, GROUP_CENTRE_ASSIGNMENT, GROUP_CENTRE_UNASSIGNMENT, GROUP_CREDIT_OFFICER_ASSIGNMENT, GROUP_CREDIT_OFFICER_UNASSIGNMENT, GROUP_SMS_MESSAGE_SENT, GROUP_EMAIL_MESSAGE_SENT, HOLIDAY_SETTINGS_CHANGED, LINE_OF_CREDIT_CREATED, LINE_OF_CREDIT_EDITED, LINE_OF_CREDIT_DELETED, ACCOUNT_ADDED_TO_LINE_OF_CREDIT, ACCOUNT_REMOVED_FROM_LINE_OF_CREDIT, LINE_OF_CREDIT_CLOSED, LINE_OF_CREDIT_REOPENED, LINE_OF_CREDIT_APPROVED, LINE_OF_CREDIT_SET_TO_PENDING_APPROVAL, LINE_OF_CREDIT_WITHDRAW, LINE_OF_CREDIT_REJECT, LOAN_ACCOUNT_CREATED, LOAN_ACCOUNT_COMMENT_ADDED, LOAN_ACCOUNT_COMMENT_EDITED, LOAN_ACCOUNT_COMMENT_DELETED, LOAN_ACCOUNT_EDITED, LOAN_ACCOUNT_SET_TO_PARTIAL, LOAN_ACCOUNT_SET_TO_PENDING_APPROVAL, LOAN_ACCOUNT_SET_TO_APPROVED, LOAN_ACCOUNT_SET_TO_CLOSED_CANCELLED, LOAN_ACCOUNT_SET_TO_CLOSED_REJECTED, LOAN_ACCOUNT_SET_TO_CLOSED_REFINANCED, LOAN_ACCOUNT_SET_TO_CLOSED_RESCHEDULED, LOAN_ACCOUNT_SET_TO_CLOSED_WRITTEN_OFF, LOAN_ACCOUNT_SET_TO_ACTIVE, LOAN_ACCOUNT_DISBURSED, TRANCHE_DISBURSED, TRANCHE_REVERSED, LOAN_ACCOUNT_SET_TO_IN_ARREARS, LOAN_ACCOUNT_DELETED, LOAN_GROUP_DELETED, LINKED_LOAN_ACCOUNT, UNLINKED_LOAN_ACCOUNT, LOAN_ACCOUNT_PAYED_OFF, LOAN_ACCOUNT_LOCKED, LOAN_ACCOUNT_UNLOCKED, LOAN_ACCOUNT_LOCKED_OPERATIONS_EDITED, LOAN_ACCOUNT_LOCKED_CAPPING, LOAN_ACCOUNT_BRANCH_ASSIGNMENT, LOAN_ACCOUNT_BRANCH_UNASSIGNMENT, LOAN_ACCOUNT_CENTRE_ASSIGNMENT, LOAN_ACCOUNT_CENTRE_UNASSIGNMENT, LOAN_ACCOUNT_CREDIT_OFFICER_ASSIGNMENT, LOAN_ACCOUNT_CREDIT_OFFICER_UNASSIGNMENT, LOAN_ACCOUNT_SET_TO_CLOSED_OBLIGATIONS_MET, LOAN_SCHEDULE_EDITED, LOAN_PRODUCT_CREATED, LOAN_PRODUCT_COMMENT_ADDED, LOAN_PRODUCT_COMMENT_EDITED, LOAN_PRODUCT_COMMENT_DELETED, LOAN_PRODUCT_EDITED, LOAN_PRODUCT_DEACTIVATED, LOAN_PRODUCT_ACTIVATED, LOAN_PRODUCT_DELETED, ORGANIZATION_SETTINGS_CHANGED, PORTAL_ACTIVATED, PORTAL_DEACTIVATED, PORTAL_EDITED, SAVINGS_PRODUCT_CREATED, SAVINGS_PRODUCT_COMMENT_ADDED, SAVINGS_PRODUCT_COMMENT_EDITED, SAVINGS_PRODUCT_COMMENT_DELETED, SAVINGS_PRODUCT_EDITED, SAVINGS_PRODUCT_ACTIVATED, SAVINGS_PRODUCT_DEACTIVATED, SAVINGS_PRODUCT_DELETED, SAVING_ACCOUNT_CREATED, SAVINGS_ACCOUNT_COMMENT_ADDED, SAVINGS_ACCOUNT_COMMENT_EDITED, SAVINGS_ACCOUNT_COMMENT_DELETED, SAVING_ACCOUNT_EDITED, SAVINGS_ACCOUNT_APPROVED, SAVINGS_ACCOUNT_ACTIVATED, SAVINGS_ACCOUNT_CLOSED_WITHDRAWN, SAVINGS_ACCOUNT_CLOSED_REJECTED, SAVINGS_ACCOUNT_CLOSED, SAVINGS_ACCOUNT_MATURED, SAVINGS_ACCOUNT_SET_TO_PENDING, SAVINGS_ACCOUNT_MATURITY_SET, SAVINGS_ACCOUNT_MATURITY_UNSET, SAVINGS_ACCOUNT_SET_TO_ARREARS, SAVINGS_ACCOUNT_WRITEN_OFF, SAVINGS_ACCOUNT_SET_TO_LOCKED, SAVINGS_ACCOUNT_DELETED, SAVINGS_ACCOUNT_SET_TO_DORMANT, SAVINGS_ACCOUNT_UNDO_DORMANT, SMS_MESSAGE_SENT, CLIENT_EMAIL_MESSAGE_SENT, TASK_CREATED, TASK_EDITED, TASK_DELETED, TASK_COMPLETED, TASK_UNCOMPLETED, LOAN_TRANSACTION_EDITED, SAVINGS_TRANSACTION_EDITED, USER_CREATED, USER_EDITED, USER_DELETED, USER_COMMENT_ADDED, USER_COMMENT_EDITED, USER_COMMENT_DELETED, USER_LOGGED_IN, USER_BRANCH_ASSIGNMENT, USER_BRANCH_UNASSIGNMENT, USER_LOCKED]

clientKeystring

the key for the client associated with this activity

groupKeystring

the encoded key of the group associated with this activity

branchKeystring

the encoded key fo the branch associated with this activity

centreKeystring

the encoded key of the centre associated with this activity

lineOfCreditKeystring

the encoded key of the line of credit associated with this activity

loanProductKeystring

the encoded key of the loan product associated with this activity

loanAccountKeystring

the encoded key of the loan account associated with this activity

savingsProductKeystring

the encoded key of the savings product associated with this activity

savingsAccountKeystring

the encoded key of the savings account assoicated with this activity

userKeystring

the encoded key of the Mambu user associated with this activity

assignedUserKeystring

the encoded key of the user assigned to a task or account associated with this activity

notesstring

some notes about the activity

assignedCentreKeystring

the encoded key of the centre an account associated with this activity is assigned to

glAccountKeystring

the encoded key of the general ledger account associated with this activity

glAccountsClosureKeystring

the encoded key of the accounting closure associated with this activity

taskKeystring

the encoded key of the task associated with this activity

fieldChanges object[]

an array of field changes detailing any fields which were updated or created by this activity

  • Array [
  • idinteger

    an ID for this change

    fieldChangeNamestring

    The name of the field which changed, note that if the field is a custom field definition this field will indicate CUSTOM_FIELD_VALUE, in this case the name of the custom field definition will be given on the fieldDetailName key.

    fieldDetailNamestring

    the name of the custom field definition that changed

    fieldDetailKeystring

    the encoded key of the custom field definition which changed

    originalValuestring

    the previous value of the field

    newValuestring

    the new value of the field

  • ]
  • activityChangesundefined[]
    branchNamestring

    the name of the branch the activity concerns

    centreNamestring

    the name of the centre the activity concerns

    clientNamestring

    the name of the client the activity concerns

    loanProductNamestring

    the name of the loan product the activity concerns

    loanAccountNamestring

    the name of the loan account the activity concerns

    savingsProductNamestring

    the name of the savings product the activity concerns

    savingsAccountNamestring

    the name of the savings account the activity concerns

    userNamestring

    the name of the user the activity concerns

    groupNamestring

    the name of the group the activity concerns

    taskNamestring

    the name of the task the activity concerns

    Activity
    {
    "activity": {
    "encodedKey": "string",
    "transactionID": 0,
    "timestamp": "string",
    "type": "BRANCH_CREATED",
    "clientKey": "string",
    "groupKey": "string",
    "branchKey": "string",
    "centreKey": "string",
    "lineOfCreditKey": "string",
    "loanProductKey": "string",
    "loanAccountKey": "string",
    "savingsProductKey": "string",
    "savingsAccountKey": "string",
    "userKey": "string",
    "assignedUserKey": "string",
    "notes": "string",
    "assignedCentreKey": "string",
    "glAccountKey": "string",
    "glAccountsClosureKey": "string",
    "taskKey": "string",
    "fieldChanges": [
    {
    "id": 0,
    "fieldChangeName": "string",
    "fieldDetailName": "string",
    "fieldDetailKey": "string",
    "originalValue": "string",
    "newValue": "string"
    }
    ],
    "activityChanges": [
    null
    ]
    },
    "branchName": "string",
    "centreName": "string",
    "clientName": "string",
    "loanProductName": "string",
    "loanAccountName": "string",
    "savingsProductName": "string",
    "savingsAccountName": "string",
    "userName": "string",
    "groupName": "string",
    "taskName": "string"
    }