Get Contract
Purpose
To get the meta details of a contract.
Endpoints
Request Details
Request URL
https://contracts.zoho.com/api/v1/contracts/{apiName}
Authorization
Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6
Scope
contracts.contracts.READ, contracts.contracts.ALL
Possible Operation Types
ALL - Full access to contract details
READ - Get contract
Sample Request
Copiedcurl "https://contracts.zoho.com/api/v1/contracts/sla-with-zylker"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"Response JSON Keys
- ownerJSON Object
Represents the name, email ID, and unique ID of the contract owner.
- modifiedTimestring
Represents the last modified time of the contract.
- apiNamestring
Represents the API name of the contract.
- endInnumber
Represents the number of months or years the contract will end from the start date.
- endInTypenumber
Represents whether the contract period ends by Months or Years (i.e., N Months/Years).
Value Description 0 Months 1 Years - contractTypeJSON Object
Represents the API name and name of the contract type.
- descriptionstring
Represents the description of the contract.
- amendmentsJSON Array
The array represents the lifecycle details of the contract, and each object in the array points to a particular phase. The phase can be that of the original contract, an amendment, renewal, or an extension. The details include the status of that particular phase, which can be the status of an original contract, an amendment, a renewal, or an extension. Refer to the Amendments section below for the explanations of the keys in each object.
- sourcenumber
Represents the source of the contract creation.
Value Description 5 The contract was created. 2 The contract was imported. 3 The contract was created from an external source (e.g., Zoho CRM). - isActivenumber
Represents the contract's presence in the system.
Value Description 1 The contract is present in the system. 5 The contract is present in the system and set as read-only due to plan downgrade. - intentnumber
Represents the contract's intent, which is based on the respective contract type's intent.
Value Description 0 Others 1 Buy 2 Sell - partyAnumber
Represents whether Party A of the contract is the organization or the counterparty.
Value Description 0 Organization 1 Counterparty - isRenewableboolean
Represents whether the contract is renewable or not.
Value Description True Renewable False Non-Renewable - renewalTypenumber
Represents whether the contract is of manual or evergreen renewal type.
Value Description 0 Manual Renewal 1 Evergreen Renewal - expirationNoticePeriodnumber
Represents the minimum period required before the contract expiry to renew a contract through manual renewal.
- expirationReminderPeriodnumber
Represents the timed notification to be sent before the contract expiry in manual renewal.
- terminationNoticePeriodnumber
Represents the minimum number of days required before the contract's expiration to terminate the contract.
- amountBigDecimal
Represents the contract amount to be paid or received, which is based on the contract type's intent (i.e., Buy or Sell).
- taxOptionnumber
Represents whether the contract amount is inclusive of tax or the tax is as per the payment terms.
Value Description 0 All Taxes Included 1 As Per Payment Terms - requesterNamestring
Represents the name of the person who requested the contract.
- primaryContactJSON Object
Represents the name, email ID, and unique ID of the counterparty's primary contact.
- contractTermboolean
Represents whether the contract's term is definite or indefinite.
Value Description True Definite False Indefinite - systemStatusnumber
Represents the overall status of the contract.
Value Description 12 The contract is in any status from Draft to before Active. 1 The contract is active. 9 The contract is terminated. 10 The contract is expired. 7 The contract is on hold. 3 The termination of the contract is initiated. - partyBnumber
Represents whether Party B of the contract is the organization or the counterparty.
Value Description 0 Organization 1 Counterparty - contractIdstring
Represents the unique ID of the contract.
- namestring
Represents the contract title.
- counterPartyJSON Object
Represents the name and API name of the counterparty.
- requesterDepartmentJSON Object
Represents the name and API name of the department to which the requested person belongs to.
- endEventDescriptionstring
Represents the description of the event on which the contract's term ends.
- endFulfillmentDescriptionstring
Represents the description of the order/service that will end the contract's term when fulfilled.
- endConditionDescriptionstring
Represents the description of the condition on which the contract's term ends.
- endDatestring
Represents the end date of the contract term.
Amendments
- numbernumber
Represents the ordinal number of the particular phase in the contract's chronology. The particular phase can be the original contract, an amendment, a renewal, or an extension.
- modifiedTimestring
Represents the last modified time of the particular phase of the contract.
- isCurrentboolean
Represents whether the particular phase (original contract, an amendment, a renewal, or an extension) is completed or in progress.
Value Description True The particular phase is completed. False The particular phase is in progress. - stageJSON Object
Represents the name and the API name of the particular phase's status. The particular phase can be the original contract, an amendment, a renewal, or an extension.
Stage API Name Stage draft Draft draft-complete Draft Completed approval-pending Approval Pending approval-recalled, sign-draft-after-approval-recalled Approval Recalled approval-rejected, sign-draft-after-approval-rejected Approval Rejected approved, sign-draft-after-approval-approved Approved negotiation-review-pending In Negotiation Review Pending negotiation-review-received In Negotiation Review Received negotiation-review-completed In Negotiation Review Completed negotiated Negotiated sign-pending, sign-draft Sign Pending sign-recalled, sign-draft-after-recall Sign Recalled sign-declined, sign-draft-after-denied Sign Declined sign-draft-no-workflow Draft Completed sign-expired, sign-draft-after-sign-expired Sign Expired signed Signed active Active expired Expired renewal-draft Pending extension-draft Pending renewal Renewed extended Extended - systemStatusnumber
Represents the overall status of the particular phase. The particular phase can be a contract's amendment, a renewal, or an extension. It does not apply to the original contract phase.
Value Description 6 The amendment, renewal, or extension is active. 7 The amendment is on hold because a renewal is in progress. 8 The amendment, renewal, or extension has been cancelled. 41 The amendment, renewal, or extension has been cancelled due to the termination of the contract. 42 The amendment, renewal, or extension has been cancelled due to the expiration of the contract. 43 The amendment, renewal, or extension has been cancelled due to the change in the contract's term. - latestCycleNumbernumber
Represents the number of times the contract has been moved to draft in a particular phase. The phase can be the original contract or an amendment. For example, the contract could be moved to draft for editing purposes based on approval or negotiation review.
- idstring
Represents the unique ID of the particular phase of the contract.
- typenumber
Represents whether the particular phase of the contract is the original contract, an amendment, a renewal, or an extension.
Value Description 1 Original Contract 2 Contract Amendment 3 Contract Renewal 4 Contract Extension - startOptionnumber
Represents the effective date options of the original contract, an amendment, a renewal, or an extension.
Value Description 0 Specific Date 1 On Execution 2 Amendment Effective Date (applicable only for Amendments) - endOptionnumber
Represents the end date options of a contract.
Value Description 0 Specific Date 1 On Condition 2 On Event 3 N Months/Years 4 On Fulfillment of Order/Service - docSourcenumber
Represents the document source of the original contract, an amendment, or a renewal.
Value Description 1 The original contract's document was created based on the contract type template. 2 The document of the original contract or an amendment was an imported document. 3 Indicates the imported contract's previous amendments/renewals have the respective signed PDF documents uploaded. 4 Indicates the imported contract's previous amendments/renewals don't have any documents.
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{
"contracts": [
{
"owner": {
"displayName": “Smith Jones”,
"emailId": “smith.jones@zylker.com”,
"id": 596000000183025
},
"modifiedTime": “Dec 15, 2021 04:26 PM”,
"apiName": “sla-with-zillum”,
"endIn": 1,
"endInType": 0,
"resourceId": “9a57560bbf7b48628acdc2fe41317ee0”,
"contractType": {
"apiName": “sla”,
"name": “SLA”,
},
"description": “This is a service level agreement for buying specific services.”,
"amendments": [
{
"number": 4,
"modifiedTime": “Dec 15, 2021 04:26 PM”,
"isCurrent": false,
"stage": {
"apiName": “active”,
"name": “Active”,
},
"systemStatus": 6,
"latestCycleNumber": 1,
"id": “596000000415223”,
"type": 1,
"startOption": 0,
"endOption": 0,
"docSource": 3
}
],
"source": 2,
"isActive": 1,
"partyA": 0,
"isRenewable": true,
"renewalType": 0,
"expirationNoticePeriod": 1,
"expirationReminderPeriod": 2,
"terminationNoticePeriod": 12,
"intent": 1,
"amount": 1200,
"currency": 65
"taxOption": 0,
"resourceUrl": String,
"requesterName": “Kevin Smith”,
"primaryContact": {
"displayName": "Laura Holmes",
"emailId": "laura.holmes@zylker.com",
"id": “200989”
},
"contractTerm": true,
"systemStatus": 1,
"partyB": 1,
"contractId": “596000000413741”,
"name": “SLA with Zillum”,
"counterParty": {
"organizationApiName": “zillum”,
"name": “Zillum”
},
"requesterDepartment": {
"apiName": “accounts”,
"name": “Accounts”
}
}
]
}