- 26 Jun 2023
- 1 Minute To Read
- Print
- DarkLight
- PDF
Native Fields
- Updated On 26 Jun 2023
- 1 Minute To Read
- Print
- DarkLight
- PDF
Fields in Mambu entities like clients, groups, or loan accounts store values. Native fields are default fields provided by Mambu and cannot be edited. Custom field definitions are needed for organization-specific fields. Native fields are visible in the Mambu UI and API v1 and v2 JSON objects. Native fields are distinguished from custom fields by their property names. To change the display language of native fields in the Mambu UI, adjust language settings.
Fields are values associated with a Mambu entity such as a client, group, or loan account. For example, the client entity includes several fields by default for storing information about each client, such as ID, email address, and creation date. Native fields are fields Mambu provides by default.
As a general rule, you are not able to edit native fields. If you want to create specific fields for your organization then you must use custom field definitions. For more information, see Custom Fields.
The exception to this rule is a set of native fields that are associated with the client entity. For more information, see Client native fields.
Native fields in the Mambu UI
Native fields are visible throughout the Mambu UI. If the field is outlined in green, then it is a required field.
Native fields when using Mambu API v1 and v2
Native fields are also present in the JSON objects that you use to work with Mambu API v1 and API v2. Native fields always come before custom field values in a JSON object. Custom field values are always nested inside custom field sets.
To distinguish a native field from a custom field value, you must look at the property name in the JSON object. If the property name starts with an underscore _
, it is a custom field set and the values nested within it are custom field values - otherwise a property in the JSON object is a native field. For more information, see our API Reference.
Managing native fields
To change the display language of all the native fields in the Mambu UI, you may edit your language settings. For more information, see Language Settings.
Custom field definitions and a specific set of client native fields are not translated when the Mambu display language changes. You must edit them by going to Administration > Fields. For more information, see Client native fields and Custom Fields.