All pages
Powered by GitBook
1 of 1

Loading...

Insert custom field values

Use case

We want to enter values for a custom field in a particular loan contract.

Use case data
API parameter with values

The field ID and the value you want to enter for the field.

The entity name and the contract for which you want to enter the value.

Sample API call

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

Sample request

The sample request body is as follows:

{
  "fieldValues": [
    {
      "fieldId": "AssetVal",
      "fieldValue": "5000"
    }
  ],
  "source": {
    "sourceName": "LOAN.CONTRACT_HEADER",
    "sourceRef": "INST2-1000"
  }
}
curl -X 'POST' \
  'https://loan-api.sandbox.tuumplatform.com/api/v1/custom-fields/value' \
  -H 'accept: */*' \
  -H 'x-channel-code: SYSTEM' \
  -H 'x-tenant-code: MB' \
  -H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDgtMjZUMTM6MjE6NDIiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2OTMwNTYxMDJ9.Z1frJzD4gdb6P9sQ_D74s7tjj4Httc5cXEKuihXEHP4' \
  -H 'Content-Type: application/json' \
  -d '{
  "fieldValues": [
    {
      "fieldId": "AssetVal",
      "fieldValue": "5000"
    }
  ],
  "source": {
    "sourceName": "LOAN.CONTRACT_HEADER",
    "sourceRef": "INST2-1000"
  }
}'

Sample response

Below you will find the response to the sample request:

Response
{
  "errors": null,
  "validationErrors": null,
  "data": null
}

Result

We have entered a custom field value for a loan contract. The field ID is AssetVal with the value 5000.

  • You can also enter values for other fields in the same request.

  • You cannot enter more than one value for the same custom field ID.

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

Learn more about the endpoint in the Tuum developer portal.

"fieldId": "AssetVal",
"fieldValue": "5000"
"sourceName": "LOAN.CONTRACT_HEADER",
"sourceRef": "INST2-1000"
insert custom field values