Get custom field value

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.

Use case data	API parameters with values
The first query parameter is the entity name (in this case, LOAN.CONTRACT_HEADER).	"...sourceName=LOAN.CONTRACT_HEADER..."
The second query parameter is the loan contract number whose custom field values you want to find.	"...&sourceRef=INST2-1000"

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

Learn more about the get custom field value endpoint in the Tuum developer portal.

Sample response

Below you will find the response to the sample request:

Response

{
  "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.