Get Contracts List
Purpose
To get the list of contracts owned by the user.
Endpoints
Request Details
Request URL
https://contracts.zoho.com/api/v1/contracts
Authorization
Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6
Scope
contracts.contracts.GET, contracts.contracts.ALL
Possible Operation Types
ALL - Full access to contracts
GET - Get contracts
Sample Request
Copiedcurl "https://contracts.zoho.com/api/v1/contracts"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"Response JSON Keys
- owneruser(short)
Represents the name of the contract owner.
- modifiedTimestring
Represents the time of modification.
- apiNamestring
Represents the name of the contract in the API.
- contractTypeJSON Object
Represents the API name and name of the contract type.
- descriptionstring
Represents the contract description.
- amendmentsJSON Object
Represents the changes made to the contract in all four amendment phases, namely Defaulft Contract, Amendment Contract, Renewal Contract and Extension Contract.
- sequenceNumberJSON Object
Represents the ordinal number of the amendment phase.
- typenumber
Represents the four amendment phases of the contract.
Value Description 1 Default Contract 2 Amendment Contract 3 Renewal Contract 4 Extension Contract
- startoptionnumber
Represents the time when the contract starts.
Value Description 0 Specific Date 1 Execution 2 Contract Start Date
- endoptionnumber
Represents the time when the contract ends.
Value Description 0 Specific Date 1 On Condition 2 On Event 3 Month or Year 4 Fulfillment
- docsourcenumber
Represents the source of the contract document in the particular stage of the amendment cycle.
Value Description 1 DOC 2 DOC_IMPORTED 3 PDF 4 NO_LETTER_IMPORTED
- numbernumber
Represents a unique number given to each contract amendment.
- is currentboolean
Represents whether any amendment is active for this contract or not.
Value Description True Yes False No
- stagestring
Represents the API name and name of the particular stage in the contract.
- systemstatusnumber
Represents the reason for the termination of amendment.
Value Description 6 Default 7 On Hold 8 Cancelled 41 Cancelled due to Termination 42 Cancelled due to Expiration 43 Cancelled due to Term Change
- lastcyclenumbernumber
Represents the cycle number of the previous amendment.
- idstring
Represents the unique ID of a contract amendment.
- effectivedate & startdatestring
Represents the date on which the contract amendment becomes active.
- sourcenumber
Represents the source of the contract.
- isActivenumber
Represents whether the contract is active.
Value Description 1 Active 0 Deleted 5 Archived
- intentnumber
Represents the intent of the contract.
Value Description 0 Others 1 Buy 2 Sell
- taxOptionnumber
Represents the tax to be paid by the contracting parties in the contract.
Value Description 0 All Tax Included 1 As Per Payment Terms
- partyAnumber
Represents the contracting party in a contract.
Value Description 0 My Company 1 Counterparty
- isRenewableboolean
Represents the contracting party in a contract.
Value Description True Renewable False Non Renewable
- requesterNamestring
Represents the name and name of the user who initiates the contract.
- contractTermboolean
Represents the contracting party in a contract.
Value Description True Definite False Indefinite
- systemStatusnumber
Represents the status of the contract.
Value Description 12 In Progress 1 Active 9 Terminated 10 Expired 7 On Hold 3 Termination Initiated
- partyBnumber
Represents the contracting party in a contract.
Value Description 0 My Company 1 Counterparty
- contractIDstring
Represents the unique ID of the contract.
- namestring
Represents the name of the contract.
- counterPartyJSON Object
Represents the name and API name of the counterparty.
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.GET 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"contracts":[
{
"owner":{
"displayName": String,
"emailId": String,
"id": String
},
"modifiedTime": String
"apiName": String
"contractType":{
"apiName": String
"name": String
},
"description": String
"amendments":[
{
"sequenceNumber": Integer,
"modifiedTime": String
"type": Integer,
"startOption": Integer,
"endOption": Integer,
"docSource": Integer,
"number": Integer,
"isCurrent": Boolean,
"stage":{
"apiName": String,
"name": String
},
"systemStatus": Integer,
"latestCycleNumber": Integer,
"id": String,
"effectiveDate": String,
"startDate": String
},
{
"sequenceNumber": Integer,
"modifiedTime": String,
"type": Integer,
"startOption": Integer,
"endOption": Integer,
"docSource": Integer,
"number": Integer,
"isCurrent": Boolean,
"stage":{
"apiName": String,
"name": String
},
"systemStatus": Integer
"latestCycleNumber": Integer
"id": String,
"effectiveDate": String
"startDate": String
},
{
"sequenceNumber": Integer,
"modifiedTime": String
"type": Integer,
"startOption": Integer,
"endOption": Integer,
"docSource": Integer,
"number": Integer,
"isCurrent": Boolean,
"stage":{
"apiName": String
"name": String
},
"systemStatus": Integer,
"latestCycleNumber": Integer,
"id": String,
"effectiveDate": String,
"startDate": String
}
],
"source": Integer,
"isActive": Integer,
"intent": Integer,
"partyA": Integer,
"isRenewable": Boolean,
"requesterName": String,
"contractTerm": Boolean,
"systemStatus": Integer,
"partyB": Integer,
"contractId": String,
"name": String,
"counterParty":{
"organizationApiName": String,
"name": String
}
},
]
LEGEND
type
DEFAULT_CONTRACT = 1
AMENDMENT_CONTRACT = 2
RENEWAL_CONTRACT = 3
EXTENSION_CONTRACT = 4
startoption
SPECIFIC_DATE = 0
EXECUTION = 1
CONTRACT_START_DATE = 2
endoption
SPECIFIC_DATE = 0
ON_CONDITION = 1
ON_EVENT = 2
MONTH_OR_YEAR = 3
FULFILLMENT = 4
docsource
DOC = 1
DOC_IMPORTED = 2
PDF = 3
NO_LETTER_IMPORTED = 4
systemstatus(amendment)
DEFAULT = 6
ON_HOLD = 7
CANCELLED = 8
CANCELLED_DUE_TO_TERMINATION = 41
CANCELLED_DUE_TO_EXPIRATION = 42
CANCELLED_DUE_TO_TERM_CHANGE = 43
isActive
ACTIVE - 1
DELETED - 0
ARCHIVED - 5
intent
OTHERS - 0
BUY - 1
SELL - 2
taxoption
ALL_TAX_INCLUDED - 0
AS_PER_PAYMENT_TERMS - 1
partyA
MY_COMPANY - 0
COUNTERPARTY - 1
systemstatus
IN_PROGRESS - 12
ACTIVE - 1
TERMINATED - 9
EXPIRED - 10
ON_HOLD - 7
TERMINATION_INITIATED - 3
partyB
MY_COMPANY - 0
COUNTERPARTY - 1