In this section, we will learn how to find the custom fields for the Loan API:

• Find the field sets that have been created.

• Find the details of the fields for a particular field set.

• Perform a search for custom field sources.

• Get the value of a custom field.

Use case

Here we will find the details of all the fields for the loan contract header entity.

Sample API call

To find the fields, use the following endpoint:

https://loan-api.sandbox.tuumplatform.com/api/v1/custom-fields/LOAN.CONTRACT_HEADER/field

Sample response

Below you will find the response to the sample request:

Result

From the response, we can see the details of the defined fields for the loan contract header entity.

Use case

For a particular loan contract, a value has been entered for one of the custom fields. In this scenario, we will find the value of the custom field for that loan contract.

Sample API call

To find the custom field value, use the following endpoint:

Get custom field values

https://loan-api.sandbox.tuumplatform.com/api/v1/custom-fields/value?sourceName=LOAN.CONTRACT_HEADER&sourceRef=INST2-1000

Sample response

Below you will find the response to the sample request:

{
  "errors": null,
  "validationErrors": null,
  "data": [
    {
      "fieldId": "AssetVal",
      "fieldName": "AssetAmount",
      "valueType": "NUMBER",
      "fieldValue": "4500",
      "fieldSetName": "Extra details for contract headers",
      "lookupEntityName": null,
      "lookupTypeCode": null
    }
  ]
}

Result

From the response, we can see the custom field value for the loan contract.

Use case

Here we will find the existing field sets for the loan contract entity.

Sample API call

To find the field sets, use the following endpoint:

https://loan-api.sandbox.tuumplatform.com/api/v1/custom-fields/LOAN.CONTRACT_HEADER/field-set

Sample response

Below you will find the response to the sample request:

{
  "errors": null,
  "validationErrors": null,
  "data": [
    {
      "entityName": "LOAN.CONTRACT_HEADER",
      "fieldSetId": "Contract Extras",
      "name": "Contracts"
    }
  ]
}

Result

From the response, we can see that the entity LOAN.CONTRACT_HEADER has one field set with ID Contract Extras. Next, we will find the details of all the fields for this entity.

Use case

Consider that we have additional codes as custom fields for loan applications. Here we want to find the applications with the code number 55.

Sample API call

To search the values for the parameters we have specified, use the following endpoint:

https://loan-api.sandbox.tuumplatform.com/api/v1/custom-fields/source/search

Sample request

The sample request body is as follows:

{
  "pageNumber": 1,
  "pageSize": 3,
  "sourceName": "LOAN.APPLICATION",
  "fields": [
    {
      "fieldId": "codeNumber",
      "fieldValue": 55
    }
  ]
}

curl -X 'POST' \
  'https://loan-api.sandbox.tuumplatform.com/api/v1/custom-fields/source/search' \
  -H 'accept: */*' \
  -H 'x-channel-code: SYSTEM' \
  -H 'x-tenant-code: MB' \
  -H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDgtMjdUMTg6MDQ6MDAiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2OTMxNTk0NDB9.BANujXLC6EGVcD2lVe5vtr2Tbwz5gzGpQkA8gCOPSlc' \
  -H 'Content-Type: application/json' \
  -d '{
  "pageNumber": 1,
  "pageSize": 3,
  "sourceName": "LOAN.APPLICATION",
  "fields": [
    {
      "fieldId": "codeNumber",
      "fieldValue": 55
    }
  ]
}'

Sample response

Below you will find the response to the sample request:

{
  "errors": null,
  "validationErrors": null,
  "data": {
    "values": [
      {
        "sourceName": "LOAN.APPLICATION",
        "sourceRef": "ID-1664282430",
        "sourceLink": null
      },
      {
        "sourceName": "LOAN.APPLICATION",
        "sourceRef": "ID-1664282446",
        "sourceLink": null
      }
    ],
    "pageNumber": 1,
    "pageSize": 3,
    "endReached": true,
    "sort": null
  }
}

Result

From the response, we can see the list of loan applications with the code number 55.