Get Contract Type
Purpose
To get the details of a contract type.
Endpoints
Request Details
Request URL
https://contracts.zoho.com/api/v1/contracttypes/{apiName}
Authorization
Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6
Scope
contracts.contracts.READ, contracts.contracts.ALL
Possible Operation Types
ALL - Full access to contract types details
READ - Get contract types details
Sample Request
Copiedcurl "https://contracts.zoho.com/api/v1/contracttypes/NDA"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"Response JSON Keys
- modifiedTimestring
Represents the time of modification.
- namestring
Represents the name of the contract type.
- idstring
Represents the unique ID of the contract type.
- addedBystring
Represents the user who created the contract type.
- apiNamestring
Represents the name of the contract type in the API.
- addedTimestring
Represents the time when the contract type is created.
- modifiedByuser
Represents the last user who modified the contract type.
- versionStateinteger
Represents the status of the contract type.
Value Description 1 Draft 2 Published 3 Published and Modified
- descriptionstring
Represents the description of the contract type.
- intentinteger
Represents whether the contract created using this contract type is for buying goods/services or selling goods/services or any other purpose.
Value Description 0 Others 1 Buy 2 Sell
- party Ainteger
Represents the contracting party in a contract.
Value Description 0 My Company 1 Counterparty
- party Binteger
Represents the contracting party in a contract.
Value Description 0 My Company 1 Counterparty
- isCustomboolean
Represents whether the contract type is custom build.
- categoriesstring
Represents the category of the contract type.
- approvalWorkflowstring
Represents the approval workflow assigned to the contract type.
- stateinteger
Represents the working status of the contract type template.
Value Description 0 Disabled 1 Enabled
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.contracts.READ 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{
"contracttypes": [
{
"modifiedTime": String,
"apiName": String,
"versionState": Integer,
"addedBy": {
"role": String,
"displayName": String,
"emailId": String,
"id": String,
"status": String,
"zuid": Long
},
"description": String,
"intent": Integer,
"partyA": Integer,
"partyB": Integer,
"name": String,
"addedTime": String,
"isCustom": Boolean,
"modifiedBy": {
"role": String,
"displayName": String,
"emailId": String,
"id": String,
"status": String,
"zuid": Long
},
"categories": [
{
"apiName": String,
"name": String
}
],
"id": String,
"state": Integer,
"approvalWorkflow": {
"apiName": String,
"name": String
}
}
]
}
Legend
versionState
DRAFT - 1
PUBLISHED - 2
PUBLISHED_MODIFIED - 3
intent
OTHERS - 0
BUY - 1
SELL - 2
partyA
MY_COMPANY - 0
COUNTERPARTY - 1
partyB
MY_COMPANY - 0
COUNTERPARTY - 1
state
DISABLED - 0
ENABLED - 1