Get Contract Document Fields with Values

Purpose

To get the details of a contract's document fields and their values.

Endpoints

GET /contracts/{apiName}/fields

Request Details

Request URL

https://contracts.zoho.com/api/v1/contracts/{apiName}/fields

Authorization

Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6

Scope

contracts.clm.ALL

Possible Operation Types

READ - Get contract document fields with their values

Sample Request

Copiedcurl "https://contracts.zoho.com/api/v1/contracts/msa-with-zenith-dynamics/fields
-X GET
-H "Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"

Response JSON Keys

dataTypeNumber
Represents the data type of the field.
Value Description
2 Number
3 String
4 Date
5 Array
7 Currency
9 Percent
10 Phone
11 Email
namestring
Represents the name of the field.
idstring
Represents the ID of the field.
valuestring
Represents the value of the field.
currencySymbolstring
Represents the currency symbol applicable to the currency field.
currencyISOCodestring
Represents the ISO 4217 code for the currency being used.

Value	Description
2	Number
3	String
4	Date
5	Array
7	Currency
9	Percent
10	Phone
11	Email

Possible Errors

INVALID_URL_PATTERNHTTP 404

Request URL is incorrect

Resolution: Specify a valid request URL. Refer to the Request URL section above.

OAUTH_SCOPE_MISMATCHHTTP 401

Unauthorized

Resolution: Client does not have contracts.clm.ALL scope. Create a new client with valid scope. Refer to the Scope section above.

NO_PERMISSIONHTTP 403

Permission denied to read

Resolution: The user does not have permission to read records. Contact your organization administrator.

INTERNAL_ERRORHTTP 500

Internal Server Error

Resolution: Unexpected and unhandled exception in the server.

INVALID_REQUEST_METHODHTTP 400

The HTTP request method is not a valid one.

Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to the Endpoints section above.

AUTHORIZATION_FAILEDHTTP 400

The user does not have sufficient privilege to read module details.

Resolution: The user does not have permission to retrieve module details. Contact your organization administrator.

Sample Response

Copied[
    {
        "dataType": 2,
        "name": "Contract Term in Year",
        "subType": "number",
        "id": "m87nfkyoufic",
        "value": "2"
    },
    {
        "dataType": 3,
        "name": "Party A Name",
        "subType": "singleline",
        "id": "9m7x5iesjjg7",
        "value": "Zylker Technologies"
    },
    {
        "dataType": 7,
        "name": "Adjustment Fee",
        "subType": "currency",
        "id": "to5v30ax7iq7",
        "value": "100",
        "currencySymbol": "$",
        "currencyISOCode": "USD"    
    },
    {
        "dataType": 11,
        "name": "Party A Contact email",
        "subType": "email",
        "id": "i8mjqst3r8c5",
        "value": "smith.jones@zylker.com"
    },
    {
        "dataType": 10,
        "name": "Party A Contact Number",
        "subType": "phone",
        "id": "ehhur0ojjbah",
        "value": "555555555"
    },
    {
        "dataType": 4,
        "name": "Contract Effective Date",
        "subType": "date",
        "id": "udr541d8m3ws",
        "value": "1737570600000"    
	},
    {
        "dataType": 9,
        "name": "Late Fee Percentage",
        "subType": "percent",
        "id": "t3cosoiwy5pt",
        "value": "12"
    },
    {
        "dataType": 5,
        "name": "Escalation Type",
        "subType": "selectbox",
        "id": "h8rtkyl34ma4",
        "value": "Level 2"
    }
]