1 of 4

Update custom fields

In this section, we will learn how to update custom fields for the Loan API entities.

Similarly, you can update custom fields for other modules using the module-specific API endpoints.

Update field set

Use case

We want to update the name of an existing field set in the loan contract header entity.

You can only update the name of a field set. The ID cannot be updated.

Use case data

API parameter with values

The first path parameter is the entity name (in this case, LOAN.CONTRACT_HEADER).

The second path parameter is the field set ID whose name you want to update.

In the body, we will enter the new field name.

Sample API call

To update the field set name, use the following endpoint:

Sample request

The sample request body is as follows:

{
  "name": "Extra details for contract headers"
}

curl -X 'PUT' \
  'https://loan-api.sandbox.tuumplatform.com/api/v1/custom-fields/LOAN.CONTRACT_HEADER/field-set/Contract%20Extras' \
  -H 'accept: */*' \
  -H 'x-channel-code: SYSTEM' \
  -H 'x-tenant-code: MB' \
  -H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDgtMjZUMTE6Mzg6MTQiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2OTMwNDk4OTR9.h1D0THssTHbFygVvRpwI6Bcz9TrogtS80wvf8IqTrI4' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Extra details for contract headers"
}'

Sample response

Below you will find the response to the sample request:

Response

{
  "errors": null,
  "validationErrors": null,
  "data": {
    "entityName": "LOAN.CONTRACT_HEADER",
    "fieldSetId": "Contract Extras",
    "name": "Extra details for contract headers"
  }
}

Result

We have now updated the field set name:

From the previous name "Contracts",
To the new name "Extra details for contract headers".

Update field

Use case

We will update an existing field in the loan header contract entity. In this case, we will mark the field as required.

Use case data

API parameter with values

The first path parameter is the entity name (in this case, LOAN.CONTRACT_HEADER).

The second path parameter is the field ID that you want to update.

In the body, we will enter the required parameters with the updated values.

Sample API call

To update the field, use the following endpoint:

Sample request

The sample request body is as follows:

{
  "name": "Residual Value",
  "fieldSetId": "Contract Extras",
  "unique": false,
  "required": true,
  "active": true
}

curl -X 'PUT' \
  'https://loan-api.sandbox.tuumplatform.com/api/v1/custom-fields/LOAN.CONTRACT_HEADER/field/ResVal' \
  -H 'accept: */*' \
  -H 'x-channel-code: SYSTEM' \
  -H 'x-tenant-code: MB' \
  -H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDgtMjZUMTE6Mzg6MTQiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2OTMwNDk4OTR9.h1D0THssTHbFygVvRpwI6Bcz9TrogtS80wvf8IqTrI4' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Residual Value",
  "fieldSetId": "Contract Extras",
  "unique": false,
  "required": true,
  "active": true
}'

Sample response

Below you will find the response to the sample request:

Response

{
  "errors": null,
  "validationErrors": null,
  "data": {
    "fieldId": "ResVal",
    "name": "Residual Value",
    "fieldSetId": "Contract Extras",
    "entityName": "LOAN.CONTRACT_HEADER",
    "valueType": "NUMBER",
    "unique": false,
    "required": true,
    "active": true,
    "copyFromEntityName": null,
    "copyFromFieldId": null,
    "activityCode": null,
    "lookupEntityName": null,
    "lookupTypeCode": null
  }
}

Result

We have now updated the field Residual Value as a required field.

Update custom field value

Use case

We want to update the value of a custom field in a particular loan contract.

Use case data

API parameter with values

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

The entity name and the contract number for which you want to update the custom value.

Sample API call

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

Sample request

The sample request body is as follows:

{
  "source": {
    "sourceName": "LOAN.CONTRACT_HEADER",
    "sourceRef": "INST2-1000"
  },
  "fieldId": "AssetVal",
  "fieldValue": "4500"
}

curl -X 'PUT' \
  '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 '{
  "source": {
    "sourceName": "LOAN.CONTRACT_HEADER",
    "sourceRef": "INST2-1000"
  },
  "fieldId": "AssetVal",
  "fieldValue": "4500"
}'

Sample response

Below you will find the response to the sample request:

Response

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

Result

We have now updated the value of the custom field fieldValue for the loan contract:

From the previous value 5000,
To the new value 4500.

Update custom field value

Use case

We want to update the value of a custom field in a particular loan contract.

Use case data

API parameter with values

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

"fieldId": "AssetVal",
"fieldValue": "4500"

The entity name and the contract number for which you want to update the custom value.

"sourceName": "LOAN.CONTRACT_HEADER",
"sourceRef": "INST2-1000"

Sample API call

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

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

Learn more about the endpoint in the Tuum developer portal.

Sample request

The sample request body is as follows:

{
  "source": {
    "sourceName": "LOAN.CONTRACT_HEADER",
    "sourceRef": "INST2-1000"
  },
  "fieldId": "AssetVal",
  "fieldValue": "4500"
}

curl -X 'PUT' \
  '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 '{
  "source": {
    "sourceName": "LOAN.CONTRACT_HEADER",
    "sourceRef": "INST2-1000"
  },
  "fieldId": "AssetVal",
  "fieldValue": "4500"
}'

Sample response

Below you will find the response to the sample request:

Response

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

Result

We have now updated the value of the custom field fieldValue for the loan contract:

From the previous value 5000,
To the new value 4500.

Update field set

Use case

We want to update the name of an existing field set in the loan contract header entity.

You can only update the name of a field set. The ID cannot be updated.

Use case data

API parameter with values

The first path parameter is the entity name (in this case, LOAN.CONTRACT_HEADER).

".../custom-fields/LOAN.CONTRACT_HEADER..."

The second path parameter is the field set ID whose name you want to update.

".../field-set/Contract%20Extras"

In the body, we will enter the new field name.

"name": "Extra details for contract headers"

Sample API call

To update the field set name, use the following endpoint:

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

Learn more about the endpoint in the Tuum developer portal.

Sample request

The sample request body is as follows:

{
  "name": "Extra details for contract headers"
}

curl -X 'PUT' \
  'https://loan-api.sandbox.tuumplatform.com/api/v1/custom-fields/LOAN.CONTRACT_HEADER/field-set/Contract%20Extras' \
  -H 'accept: */*' \
  -H 'x-channel-code: SYSTEM' \
  -H 'x-tenant-code: MB' \
  -H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDgtMjZUMTE6Mzg6MTQiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2OTMwNDk4OTR9.h1D0THssTHbFygVvRpwI6Bcz9TrogtS80wvf8IqTrI4' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Extra details for contract headers"
}'

Sample response

Below you will find the response to the sample request:

Response

{
  "errors": null,
  "validationErrors": null,
  "data": {
    "entityName": "LOAN.CONTRACT_HEADER",
    "fieldSetId": "Contract Extras",
    "name": "Extra details for contract headers"
  }
}

Result

We have now updated the field set name:

From the previous name "Contracts",
To the new name "Extra details for contract headers".

Update field

Use case

We will update an existing field in the loan header contract entity. In this case, we will mark the field as required.

Use case data

API parameter with values

The first path parameter is the entity name (in this case, LOAN.CONTRACT_HEADER).

".../custom-fields/LOAN.CONTRACT_HEADER..."

The second path parameter is the field ID that you want to update.

".../field/ResVal"

In the body, we will enter the required parameters with the updated values.

"required": true

Sample API call

To update the field, use the following endpoint:

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

Learn more about the endpoint in the Tuum developer portal.

Sample request

The sample request body is as follows:

{
  "name": "Residual Value",
  "fieldSetId": "Contract Extras",
  "unique": false,
  "required": true,
  "active": true
}

curl -X 'PUT' \
  'https://loan-api.sandbox.tuumplatform.com/api/v1/custom-fields/LOAN.CONTRACT_HEADER/field/ResVal' \
  -H 'accept: */*' \
  -H 'x-channel-code: SYSTEM' \
  -H 'x-tenant-code: MB' \
  -H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDgtMjZUMTE6Mzg6MTQiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2OTMwNDk4OTR9.h1D0THssTHbFygVvRpwI6Bcz9TrogtS80wvf8IqTrI4' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Residual Value",
  "fieldSetId": "Contract Extras",
  "unique": false,
  "required": true,
  "active": true
}'

Sample response

Below you will find the response to the sample request:

Response

{
  "errors": null,
  "validationErrors": null,
  "data": {
    "fieldId": "ResVal",
    "name": "Residual Value",
    "fieldSetId": "Contract Extras",
    "entityName": "LOAN.CONTRACT_HEADER",
    "valueType": "NUMBER",
    "unique": false,
    "required": true,
    "active": true,
    "copyFromEntityName": null,
    "copyFromFieldId": null,
    "activityCode": null,
    "lookupEntityName": null,
    "lookupTypeCode": null
  }
}

Result

We have now updated the field Residual Value as a required field.