Skip to main content

Customfieldsetmeta

Model representation of a Custom Field Set

availableForstring

Indicates the entity that the custom field set is associated with (eg. clients or any entity that allows CF definition)

Possible values: [CLIENT, GROUP, CREDIT_ARRANGEMENT, LOAN_ACCOUNT, GUARANTOR, ASSET, DEPOSIT_ACCOUNT, DEPOSIT_PRODUCT, TRANSACTION_CHANNEL, TRANSACTION_TYPE, BRANCH, CENTRE, USER]

creationDatedate-time

Date at which the custom field set was created

Example: 2016-09-06T13:37:50+03:00
customFields object[]

This section lists all the custom fields associated with this set

  • Array [
  • encodedKeystring

    The encoded key of the entity, generated, globally unique

    idstring

    User-provided ID of the custom field

  • ]
  • descriptionstring

    Free text field to store eventual notes with regard to custom field group purpose/details

    displaySettings object

    Wrapper holds the display properties of a Custom Field Set

    builtInboolean

    This is used only for builtIn custom field sets and can have two possible values: True - when this is a "mambu" field set, False - when this is a tenant-defined field set

    displayNamestring

    User-provided name of the custom field set

    positionint32

    Represents the order of the custom field set (starts from 0)

    encodedKeystring

    The encoded key of the entity, generated, globally unique

    fieldSetTypestring

    The usage decides how the custom field set will be used in the UI and how the custom field values will be stored. For STANDARD set type the custom field set can be used only once (i.e Personal Information). For GROUPED set type the custom field set can be used multiple times (i.e Addresses). For further details please see here

    Possible values: [STANDARD, GROUPED]

    idstring

    User-defined ID, gobally unique

    Customfieldsetmeta
    {
    "availableFor": "CLIENT",
    "creationDate": "2016-09-06T13:37:50+03:00",
    "customFields": [
    {
    "encodedKey": "string",
    "id": "string"
    }
    ],
    "description": "string",
    "displaySettings": {
    "builtIn": true,
    "displayName": "string",
    "position": 0
    },
    "encodedKey": "string",
    "fieldSetType": "STANDARD",
    "id": "string"
    }