Get Counterparty
Purpose
To get the details of a counterparty.
Request Details
Request URL
https://contracts.zoho.com/api/v1/counterparties/{organizationApiName}
Authorization
Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6
Scope
contracts.contracts.READ, contracts.contracts.ALL
Possible Operation Types
ALL - Full access to counterparty details
READ - Get counterparty details
Sample Request
Copiedcurl "https://contracts.zoho.com/api/v1/counterparties/ABCcompany"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"Response JSON Keys
- modifiedTimestring
Represents the time of modification.
- namestring
Represents the name of the counterparty.
- idstring
Represents the unique ID of the counterparty.
- organizationApiNamestring
Represents the name of the counterparty in the API.
- addedTimestring
Represents the time when the counterparty is created.
- modifiedByuser
Represents the last user who modified the counterparty.
- counterPartyTypeshort
Represents the API name of the counterparty type.
- usersJSON Object
Represents the counterparty contact details.
- country, city, state, address, zipCodestring
Represents the address details of the counterparty.
- websitestring
Represents the website of the counterparty.
- statusnumber
Represents the status of the counterparty.
Value Description 1 Active 5 Disabled
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[
{
"website": String,
"modifiedTime": String,
"addedBy": {{User short}},
"counterPartyType": CounterpartyType(Short),
"id": String,
"name": String,
"country": String,
"organizationApiName": String,
"zipCode": String,
"state": String,
"city": String,
"users": [
String of email addresses
],
"addedTime": String,
"modifiedBy": {{User short}},
"address": String,
"status": Number
}
]