Userapiv1
Description for accessRights in UserApiV1
Possible values: [MAMBU, APIS, MOBILE]
Description for apiConsumerType in UserApiV1
Possible values: [PAYMENTS, AUDIT_TRAIL, MAMBU_API, STREAMING_API]
Description for assignedBranchKey in UserApiV1
Description for creationDate in UserApiV1
customFields object[]
Description for customFields in UserApiV1
Description for amount in CustomFieldValueApiV1
customField object
Description for customField in CustomFieldValueApiV1
amounts object
Description for amounts in CustomFieldApiV1
Description for builtInCustomFieldId in CustomFieldApiV1
Possible values: [MOBILE_PHONE, EMAIL_ADDRESS, GENDER, MIDDLE_NAME, HOME_PHONE, BIRTHDATE, LAST_NAME, FIRST_NAME]
Description for creationDate in CustomFieldApiV1
customFieldProductSettings object[]
Description for customFieldProductSettings in CustomFieldApiV1
Description for customFieldEncodedKey in CustomFieldLinkApiV1
Description for encodedKey in CustomFieldLinkApiV1
Description for isDefault in CustomFieldLinkApiV1
Description for isRequired in CustomFieldLinkApiV1
Description for linkType in CustomFieldLinkApiV1
Possible values: [CLIENT_ROLE, CHANNEL, PRODUCT]
Description for productKey in CustomFieldLinkApiV1
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
Description for encodedKey in CustomFieldSelectionApiV1
Description for id in CustomFieldSelectionApiV1
Description for score in CustomFieldSelectionApiV1
Description for value in CustomFieldSelectionApiV1
customFieldSet object
Description for customFieldSet in CustomFieldApiV1
Description for builtInType in CustomFieldSetApiV1
Possible values: [DETAILS, GENERAL]
Description for createdDate in CustomFieldSetApiV1
customFields object[]
Description for customFields in CustomFieldSetApiV1
Description for encodedKey in CustomFieldSetApiV1
Description for id in CustomFieldSetApiV1
Description for indexInList in CustomFieldSetApiV1
Description for lastModifiedDate in CustomFieldSetApiV1
Description for name in CustomFieldSetApiV1
Description for notes in CustomFieldSetApiV1
Description for type in CustomFieldSetApiV1
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]
Description for usage in CustomFieldSetApiV1
Possible values: [SINGLE, GROUPED]
Description for dataType in CustomFieldApiV1
Possible values: [GROUP_LINK, DATE, NUMBER, CHECKBOX, CLIENT_LINK, STRING, USER_LINK, SELECTION]
Description for description in CustomFieldApiV1
editRights object
Description for editRights in CustomFieldApiV1
Description for encodedKey in UsageRightsApiV1
Description for isAccessibleByAllUsers in UsageRightsApiV1
Description for roles in UsageRightsApiV1
Description for encodedKey in CustomFieldApiV1
Description for id in CustomFieldApiV1
Description for indexInList in CustomFieldApiV1
Description for isDefault in CustomFieldApiV1
Description for isRequired in CustomFieldApiV1
Description for lastModifiedDate in CustomFieldApiV1
Description for name in CustomFieldApiV1
Description for state in CustomFieldApiV1
Possible values: [DEACTIVATED, NORMAL]
Description for type in CustomFieldApiV1
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]
Description for unique in CustomFieldApiV1
Description for validationPattern in CustomFieldApiV1
Description for valueLength in CustomFieldApiV1
Possible values: [SHORT, LONG]
Description for values in CustomFieldApiV1
viewRights object
Description for viewRights in CustomFieldApiV1
Description for encodedKey in UsageRightsApiV1
Description for isAccessibleByAllUsers in UsageRightsApiV1
Description for roles in UsageRightsApiV1
Description for customFieldID in CustomFieldValueApiV1
Description for customFieldKey in CustomFieldValueApiV1
Description for customFieldSetGroupIndex in CustomFieldValueApiV1
Description for encodedKey in CustomFieldValueApiV1
Description for indexInList in CustomFieldValueApiV1
Description for linkedEntityKeyValue in CustomFieldValueApiV1
Description for parentKey in CustomFieldValueApiV1
Description for selectionKey in CustomFieldValueApiV1
Description for value in CustomFieldValueApiV1
Description for email in UserApiV1
Description for encodedKey in UserApiV1
Description for failedLoginsCount in UserApiV1
Description for failedLoginsDates in UserApiV1
Description for firstName in UserApiV1
Description for homePhone in UserApiV1
Description for id in UserApiV1
Description for isAdministrator in UserApiV1
Description for isCreditOfficer in UserApiV1
Description for isSupport in UserApiV1
Description for isTeller in UserApiV1
Description for language in UserApiV1
Possible values: [PORTUGESE, RUSSIAN, ROMANIAN, ENGLISH, SPANISH, GEORGIAN, BURMESE, PHRASE, CHINESE, FRENCH, INDONESIAN]
Description for lastLoggedInDate in UserApiV1
Description for lastModifiedDate in UserApiV1
Description for lastName in UserApiV1
managedBranches object[]
Description for managedBranches in UserApiV1
Description for branchKey in UserManagedBranchApiV1
Description for encodedKey in UserManagedBranchApiV1
Description for indexInList in UserManagedBranchApiV1
Description for mobilePhone1 in UserApiV1
Description for notes in UserApiV1
permissions object
Description for permissions in UserApiV1
Description for canManageAllBranches in PermissionsApiV1
Description for canManageEntitiesAssignedToOtherOfficers in PermissionsApiV1
Description for encodedKey in PermissionsApiV1
Description for permissions in PermissionsApiV1
Possible values: [CREATE_INVESTOR_FUNDS, EDIT_CLIENT, EDIT_PRODUCT_DOCUMENT_TEMPLATES, WRITE_OFF_LOAN_ACCOUNTS, APPLY_SAVINGS_FEES, UNDO_APPROVE_LINE_OF_CREDIT, EDIT_PENALTY_RATE, CREATE_SAVINGS_PRODUCT, MAKE_EARLY_WITHDRAWALS, APPROVE_SAVINGS, CREATE_COMMENTS, EDIT_GROUP, BOOKING_DATE_LOANS_GL, CREATE_DOCUMENTS, ENTER_REPAYMENT, LOCK_LOAN_ACCOUNTS, CLOSE_LINES_OF_CREDIT, CREATE_BRANCH, CREATE_SAVINGS_ACCOUNT, WITHDRAW_LOAN_ACCOUNTS, CREATE_SECURITIES, EXPORT_TO_EXCEL, EDIT_REPAYMENT_SCHEDULE, BULK_LOAN_CORRECTIONS, ACTIVATE_MATURITY, EDIT_INVESTOR_FUNDS, UNDO_WITHDRAW_LINE_OF_CREDIT, UNDO_REJECT_LINE_OF_CREDIT, VIEW_CARDS, VIEW_JOURNAL_ENTRIES, APPROVE_LINE_OF_CREDIT, REOPEN_SAVINGS_ACCOUNT, VIEW_COMMENTS, RESCHEDULE_LOAN_ACCOUNT, delete_SECURITIES, CREATE_CENTRE, BLACKLIST_CLIENT, BACKDATE_LOAN_TRANSACTIONS, REVERSE_LOAN_ACCOUNT_WRITE_OFF, UNLOCK_SAVINGS_ACCOUNT, APPLY_SAVINGS_ADJUSTMENTS, VIEW_AUTHORIZATION_HOLD, MANAGE_CLIENT_ASSOCIATION, EDIT_COMMUNICATION_TEMPLATES, SELL_LOAN_FRACTION, REJECT_LINE_OF_CREDIT, EDIT_CLIENT_ID, MAKE_ACCOUNTING_CLOSURE, delete_PRODUCT_DOCUMENT_TEMPLATES, EDIT_TASK, RESEND_FAILED_MESSAGES, delete_CARDS, VIEW_LINE_OF_CREDIT_DETAILS, delete_LINES_OF_CREDIT, EDIT_USER, CREATE_TASK, VIEW_GROUP_DETAILS, CREATE_PRODUCT_DOCUMENT_TEMPLATES, CREATE_REPORTS, UNDO_WITHDRAW_LOAN_ACCOUNTS, EDIT_BRANCH, CHANGE_CLIENT_TYPE, ADD_ACCOUNTS_TO_LINE_OF_CREDIT, delete_SAVINGS_PRODUCT, EXIT_CLIENT, BACKDATE_SAVINGS_TRANSACTIONS, VIEW_SAVINGS_ACCOUNT_DETAILS, MAKE_DEPOSIT, VIEW_LOAN_ACCOUNT_DETAILS, APPLY_ACCRUED_SAVINGS_INTEREST, MANAGE_LOAN_ASSOCIATION, CREATE_GROUP, UNDO_CLIENT_STATE_CHANGED, delete_INVESTOR_FUNDS, VIEW_INTELLIGENCE, delete_LOAN_ACCOUNT, REVERSE_SAVINGS_ACCOUNT_WRITE_OFF, VIEW_BRANCH_DETAILS, VIEW_ACCOUNTING_REPORTS, APPROVE_CLIENT, REFINANCE_LOAN_ACCOUNT, VIEW_LOAN_PRODUCT_DETAILS, VIEW_SAVINGS_PRODUCT_DETAILS, EDIT_SAVINGS_PRODUCT, VIEW_CLIENT_DETAILS, UNDO_REJECT_LOANS, LOCK_SAVINGS_ACCOUNT, LOG_JOURNAL_ENTRIES, CLOSE_TILL, VIEW_DOCUMENTS, CREATE_COMMUNICATION_TEMPLATES, PAY_OFF_LOAN, CREATE_TRANSACTION_CHANNEL, EDIT_COMMENTS, SET_DISBURSEMENT_CONDITIONS, EDIT_SECURITIES, EDIT_DOCUMENTS, EDIT_SAVINGS_TRANSACTIONS, REMOVE_CASH, ANONYMIZE_CLIENT, CREATE_USER, ADD_CASH, CREATE_CARDS, EDIT_PRINCIPAL_PAYMENT_ACTIVE_REVOLVING_CREDIT, WITHDRAW_LINE_OF_CREDIT, CLOSE_SAVINGS_ACCOUNTS, delete_DOCUMENTS, OPEN_TILL, VIEW_REPORTS, delete_LOAN_PRODUCTS, DOWNLOAD_BACKUPS, VIEW_CHART_OF_ACCOUNTS, BOOKING_DATE_SAVINGS_GL, delete_CLIENTS, IMPORT_DATA, EDIT_GROUP_ID, APPLY_ACCOUNTING_ADJUSTMENTS, MAKE_WITHDRAWAL, post_TRANSACTIONS_ON_DORMANT_ACCOUNTS, EDIT_LOAN_TRANSACTIONS, CREATE_LOAN_PRODUCT, delete_TASK, EDIT_LOAN_PRODUCT, EDIT_LOAN_TRANCHES, PERFORM_REPAYMENTS_WITH_CUSTOM_AMOUNTS_ALLOCATION, CREATE_LOAN_ACCOUNT, MAKE_INTER_CLIENTS_TRANSFERS, VIEW_ADMINISTRATION_DETAILS, EDIT_LOAN_ACCOUNT, MAKE_TRANSFER, RECTIFY_ADJUSTMENT, REMOVE_ACCOUNTS_FROM_LINE_OF_CREDIT, VIEW_INVESTOR_FUNDS_DETAILS, MANAGE_ACCOUNTS, EDIT_INTEREST_RATE, EDIT_LINES_OF_CREDIT, APPLY_LOAN_FEES, APPLY_LOAN_ADJUSTMENTS, CREATE_AUTHORIZATION_HOLD, VIEW_TASK, VIEW_CENTRE_DETAILS, REJECT_CLIENT, DIBURSE_LOANS, MAKE_WITHDRAWAL_REDRAW, EDIT_REPORTS, delete_REPORTS, VIEW_EXCHANGE_RATES, CLOSE_LOAN_ACCOUNTS, VIEW_USER_DETAILS, EDIT_SAVINGS_ACCOUNT, delete_TRANSACTION_CHANNEL, REQUEST_LOAN_APPROVAL, APPROVE_LOANS, VIEW_TRANSACTION_CHANNEL, delete_COMMENTS, CREATE_CLIENT, delete_SAVINGS_ACCOUNT, BULK_DEPOSIT_CORRECTIONS, post_TRANSACTIONS_ON_LOCKED_LOAN_ACCOUNTS, APPLY_ACCRUED_LOAN_INTEREST, REJECT_LOANS, COLLECT_GUARANTIES, LINK_ACCOUNTS, CREATE_INDEX_RATE, delete_GROUP, UPDATE_AUTHORIZATION_HOLD, AUDIT_TRANSACTIONS, MANAGE_GROUP_ASSOCIATION, CREATE_LINES_OF_CREDIT, delete_USER, SEND_MANUAL_SMS, SEND_MANUAL_EMAIL, SET_LOAN_INCOMPLETE, VIEW_SECURITIES_DETAILS, CREATE_EXCHANGE_RATE, CREATE_CARD_TRANSACTION, EDIT_CENTRE, VIEW_COMMUNICATION_HISTORY, CHANGE_GROUP_TYPE, EDIT_TRANSACTION_CHANNEL, UNDO_LOAN_ACCOUNT_CLOSURE, REVERSE_CARD_TRANSACTION]
Description for provisionedThroughFederation in UserApiV1
role object
Description for role in UserApiV1
Description for encodedKey in EncodedKeyAndIdRoleApiV1
Description for id in EncodedKeyAndIdRoleApiV1
transactionLimits object
Description for transactionLimits in UserApiV1
property name* MoneyApiV1
Description for amount in MoneyApiV1
Description for twoFactorAuthentication in UserApiV1
Description for userState in UserApiV1
Possible values: [LOCKED, ACTIVE, INACTIVE]
Description for username in UserApiV1
{
"accessRights": [
"MAMBU"
],
"apiConsumerType": "PAYMENTS",
"assignedBranchKey": "string",
"creationDate": "string",
"customFields": [
{
"amount": 0,
"customField": {
"amounts": {},
"builtInCustomFieldId": "MOBILE_PHONE",
"creationDate": "string",
"customFieldProductSettings": [
{
"customFieldEncodedKey": "string",
"encodedKey": "string",
"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": "string",
"id": "string",
"score": 0,
"value": "string"
}
],
"customFieldSet": {
"builtInType": "DETAILS",
"createdDate": "string",
"customFields": [
{}
],
"encodedKey": "string",
"id": "string",
"indexInList": 0,
"lastModifiedDate": "string",
"name": "string",
"notes": "string",
"type": "USER_INFO",
"usage": "SINGLE"
},
"dataType": "GROUP_LINK",
"description": "string",
"editRights": {
"encodedKey": "string",
"isAccessibleByAllUsers": true,
"roles": [
"string"
]
},
"encodedKey": "string",
"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": "string",
"isAccessibleByAllUsers": true,
"roles": [
"string"
]
}
},
"customFieldID": "string",
"customFieldKey": "string",
"customFieldSetGroupIndex": 0,
"encodedKey": "string",
"indexInList": 0,
"linkedEntityKeyValue": "string",
"parentKey": "string",
"selectionKey": "string",
"value": "string"
}
],
"email": "string",
"encodedKey": "string",
"failedLoginsCount": 0,
"failedLoginsDates": [
"string"
],
"firstName": "string",
"homePhone": "string",
"id": 0,
"isAdministrator": true,
"isCreditOfficer": true,
"isSupport": true,
"isTeller": true,
"language": "PORTUGESE",
"lastLoggedInDate": "string",
"lastModifiedDate": "string",
"lastName": "string",
"managedBranches": [
{
"branchKey": "string",
"encodedKey": "string",
"indexInList": 0
}
],
"mobilePhone1": "string",
"notes": "string",
"permissions": {
"canManageAllBranches": true,
"canManageEntitiesAssignedToOtherOfficers": true,
"encodedKey": "string",
"permissions": [
"CREATE_INVESTOR_FUNDS"
]
},
"provisionedThroughFederation": true,
"role": {
"encodedKey": "string",
"id": "string"
},
"transactionLimits": {},
"twoFactorAuthentication": true,
"userState": "LOCKED",
"username": "string"
}