Developer Center

Custom Fields API

Last Updated: Oct 24, 2017 05:19PM CEST

URL

/api/customfields/{customFieldId}
/api/customfieldsets

Description

Allows you to retrieve the defined custom fields and custom field sets. A custom field set can contain custom fields.

Populating custom fields

Custom fields are attached to an entity, and needs to be populated as part of a post to such entity. In Mambu custom fields can be created, in the user interface, for:
Custom fields can be grouped by sets. Mambu uses the parameter customFieldSetGroupIndex to refer to a custom field set. The index is consecutive, starts in index 0 and corresponds, in order, to the list of custom fields returned when querying the identity. Currently custom fields cannot be created via API.
{
    "customInformation":[
       {
          "value":"1",
          "customFieldID":"Family_Members",
          "customFieldSetGroupIndex":"0"
       },
       {
          "value":"TRUE",
          "customFieldID":"Has_children",
          "customFieldSetGroupIndex":"1"
       }
    ]
}
When editing a custom field which is linked to a client or group, this link can be specified using the linkedEntityKeyValue field. Example:
POST /api/loans/MBM8392 
{
    "client": {...},
    "customInformation": [
        {
        "linkedEntityKeyValue": "40228ab578f90bc38b6700a",
        "customFieldID": "Income"
        }
    ]
}
When editing or creating a custom field which of type checkbox the value needs to be specified as TRUE or FALSE. Example:
POST /api/loans/MBM8392 
{
    "client": {...},
    "customInformation": [
        {
        "value":"FALSE",
        "customFieldID":"checboxCustomFieldID",
        }
    ]
}

Methods

GET Custom Fields

Allows retrieving of a custom field based on id/key. The custom field can be fetched only based on id/key.

Usage examples

//get the custom field with JOB_TITLE id
GET /api/customfields/JOB_TITLE

//get the custom field with 8a54e5b44449337 encoded key
GET /api/customfields/8a54e5b44449337

Samples responses:

//response containing the custom field with JOB_TITLE id
{
    "encodedKey":"8a54e5b44449337f01444a6db5d40006",
    "id":"JOB_TITLE",
    "name":"Current Job Title",
    "type":"CLIENT_INFO",
    "dataType":"STRING",
    "valueLength":"LONG",
    "isDefault":true,
    "isRequired":true,
    "description":"The current job title for the client.",
    "indexInList":8,
    "state":"NORMAL"
}

// get information about an account with dependant custom fields (constraint) section
{
   "encodedKey":"8abcd7a84b7cb5a1014b7d3d18de019d",
   "id":"Selection_Clients",
   "name":"Selection",
   "type":"CLIENT_INFO",
   "dataType":"SELECTION",
   "valueLength":"SHORT",
   "isDefault":false,
   "isRequired":false,
   "description":"The current job title for the client.",
   "indexInList":8,
   "state":"NORMAL",
   "customFieldSelectionOptions":[
      {
         "encodedKey":"40288a134b9c2ff3014b9cf8573c03f6",
         "value":"Berlin",
         "score":"12",
         "constraint":{
            "encodedKey":"40288a134b9c2ff3014b9cf8573c03f7",
            "dataFieldType":"CUSTOM",
            "dataItemType":"CLIENT",
            "dataType":"STRING",
            "customFieldKey":"40288a134b9c2ff3014b9cf7850c03f0",
            "filterElement":"EQUALS",
            "value":"40288a134b9c2ff3014b9cf7851003f2",
            "linkingOperator":"AND"
         }
      },
      {
         "encodedKey":"40288a134b9c2ff3014b9cf8573d03f8",
         "value":"Frankfurt",
         "constraint":{
            "encodedKey":"40288a134b9c2ff3014b9cf8573d03f9",
            "dataFieldType":"CUSTOM",
            "dataItemType":"CLIENT",
            "dataType":"STRING",
            "customFieldKey":"40288a134b9c2ff3014b9cf7850c03f0",
            "filterElement":"EQUALS",
            "value":"40288a134b9c2ff3014b9cf7851003f2",
            "linkingOperator":"AND"
         }
      }
   ]
}

GET Custom Field Sets

Allows retrieving of a list custom field sets that can be optionaly filtered by type.

Parameters

type The custom field set type. Posible values:
  • CLIENT_INFO
  • GROUP_INFO
  • LOAN_ACCOUNT_INFO
  • SAVINGS_ACCOUNT_INFO
  • BRANCH_INFO
  • CENTRE_INFO
  • USER_INFO
  • LINE_OF_CREDIT

Usage examples

 //get all custom field sets
GET /api/customfieldsets

//get all USER_INFO type custom field sets
GET /api/customfieldsets?type=USER_INFO

Samples responses:

//response containing the custom field sets for USER INFO type
[
   {
      "encodedKey":"8a54e5b4443e9c94014440858e350011",
      "name":"User_CS",
      "notes":"",
      "createdDate":"2014-02-17T15:44:58+0000",
      "indexInList":0,
      "type":"USER_INFO",
      "customFields":[
         {
            "encodedKey":"8a54e5b4443e9c9401444085e75e0012",
            "id":"ucf",
            "name":"user_cf",
            "type":"USER_INFO",
            "dataType":"STRING",
            "valueLength":"SHORT",
            "isDefault":false,
            "isRequired":false,
            "description":"",
            "indexInList":0,
            "state":"NORMAL"
         },
         {
            "encodedKey":"8a54e5b44449337f01444a8402930007",
            "id":"IP",
            "name":"Internal Position",
            "type":"USER_INFO",
            "dataType":"SELECTION",
            "valueLength":"SHORT",
            "isDefault":true,
            "isRequired":true,
            "values":[
               "Manager",
               "Developer"
            ],
            "amounts":{
               "Manager":"1",
               "Developer":"2"
            },
            "description":"",
            "indexInList":1,
            "state":"NORMAL"
         }
      ]
   },
   {
      "encodedKey":"8a54e5b44449337f01444a84a5640008",
      "name":"Emprt User CFS",
      "notes":"User Custom Field Set",
      "createdDate":"2014-02-19T14:20:10+0000",
      "indexInList":1,
      "type":"USER_INFO",
      "customFields":[

      ]
   }
]
//response containing the custom field sets for LOAN_ACCOUNT_INFO type. If a productKey field is present then the custom field set is assigned to a loan product.
[
   {
      "encodedKey":"8a54e5b4444e245501444f3bab160538",
      "name":"Loan Product CFS",
      "notes":"Custom field set for agriculture loan product",
      "createdDate":"2014-02-20T12:18:34+0000",
      "indexInList":0,
      "type":"LOAN_ACCOUNT_INFO",
      "customFields":[
         {
            "encodedKey":"8a54e5b4444e245501444f3df73c0539",
            "id":"T_C_F_A_L",
            "name":"Test Custom Field Agriculutre Loan",
            "type":"LOAN_ACCOUNT_INFO",
            "dataType":"STRING",
            "valueLength":"LONG",
            "isDefault":true,
            "isRequired":true,
            "description":"Test Custom filed for agriculture loan used for internal testing",
            "indexInList":4,
            "state":"NORMAL"
         }
      ],
      "productKey":"8a33ae49441c4fe101441c7154600340"
   }
]
//response containing the custom field sets for LINE_OF_CREDIT type
[
  {
    "encodedKey": "402880b858d95c8e0158d95cfe4b0480",
    "name": "LoC CF Set",
    "notes": "",
    "createdDate": "2016-12-07T12:58:39+0000",
    "indexInList": 0,
    "type": "LINE_OF_CREDIT",
    "customFields": [
      {
        "encodedKey": "402880b858d95c8e0158d95cfe4b0481",
        "id": "loccf1",
        "creationDate": "2016-12-07T12:59:15+0000",
        "lastModifiedDate": "2016-12-07T14:48:17+0000",
        "name": "LoC CF",
        "type": "LINE_OF_CREDIT",
        "dataType": "STRING",
        "valueLength": "SHORT",
        "isDefault": false,
        "isRequired": false,
        "description": "",
        "indexInList": 0,
        "customFieldProductSettings": [],
        "state": "NORMAL",
        "customFieldSelectionOptions": [],
        "viewRights": {
          "encodedKey": "402880b858d95c8e0158d95cfe4b0482",
          "isAccessibleByAllUsers": true,
          "roles": []
        },
        "editRights": {
          "encodedKey": "402880b858d95c8e0158d95dd4a40483",
          "isAccessibleByAllUsers": true,
          "roles": []
        },
        "unique": false,
        "values": [],
        "amounts": {}
      }
    ],
    "usage": "SINGLE"
  }
]
support@mambu.com
https://cdn.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete