Get Counterparty Types List

Purpose

To get the counterparty types list maintained in Choice Lists.

Endpoints

GET /counterpartytypes

Request Details

Request URL

https://contracts.zoho.com/api/v1/counterpartytypes

Authorization

Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6

Scope

contracts.contracts.READ, contracts.contracts.ALL

Possible Operation Types

ALL - Full access to counterparty types
READ - Get counterparty types

Sample Request

Copiedcurl "https://contracts.zoho.com/api/v1/counterpartytypes"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"

Response JSON Keys

namestring
Represents the name of the counterparty type.
idstring
Represents the unique ID of the counterparty type.
apiNamestring
Represents the API name of the counterparty type.

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{
   "counterpartytypes":[
      {
         "apiName":"customer",
         "name":"Customer",         
         "id":"683000000008857"
      },
      {
         "apiName":"partner",
         "name":"Partner",
         "id":"683000000008860"
      },
      {
         "apiName":"reseller",
         "name":"Reseller",
         "id":"683000000008863"
      },
      {
         "apiName":"supplier",
         "name":"Supplier",
         "id":"683000000008866"
      },
      {
         "apiName":"vendor",
         "name":"Vendor",
         "id":"683000000008869"
      },
      {
         "apiName":"employee",
         "name":"Employee",
         "id":"683000000112075"
      }
   ]
}