Organizations
An Organisation represents a company or an institution running a business.
End Points
Create an organization
List organizations
Update an organization
Get an organization
Attribute
organization_id
string
ID of the organisation generated by the server
name
string
Name of the Organisation
is_logo_uploaded
string
Boolean to check if logo of the organisation if available
is_default_org
boolean
user_role
string
Role of the user(s). A user can be an admin or a non-admin user, accountant, staff member, special user ( this includes custom users)
account_created_date
string
Date of creation of the account
time_zone
string
Time Zone of the Organisation's country
language_code
string
Language for use
date_format
string
field_separator
string
Separator used to classify fields
fiscal_year_start_month
double
Starting month of teh financial year
tax_group_enabled
boolean
user_status
string
Status of the user
contact_name
string
Name of the contact person of the organisation
industry_type
string
Business type
address
array
Billing address of the organisation
street_address1
string
Street name of the Billing address of the Organisation
street_address2
string
Continyed billing address of the organisation
city
string
City of the organisation
state
string
State where the organisation is located
country
string
Country of the Organisation
zip
string
ZIP/Postal code of the organisation's location
{
"organization_id": "10229182",
"name": "Zillium Inc",
"is_logo_uploaded": " ",
"is_default_org": false,
"user_role": " ",
"account_created_date": "2012-02-15",
"time_zone": "PST",
"language_code": "en",
"date_format": "dd MMM yyyy",
"field_separator": " ",
"fiscal_year_start_month": 0,
"tax_group_enabled": true,
"user_status": " ",
"contact_name": "John Smith",
"industry_type": "Services",
"address": [
{
"street_address1": " ",
"street_address2": " ",
"city": " ",
"state": " ",
"country": "U.S.A",
"zip": "U.S.A"
}
]
}
Create an organization
Create an organization.
OAuth Scope : ZohoInventory.settings.CREATE
Arguments
name
string
(Required)
Name of the project.
fiscal_year_start_month
string
Fiscal or financial starting year of your business. Allowed Values:
january, february, march, april, may, june, july, august, september, october, november and december currency_code
string
(Required)
Standard code for currency.
time_zone
string
(Required)
Time zone in with the organization is located geographically.
date_format
string
Format for representing the date.
field_separator
string
Field separator for components in date.
language_code
string
language code for organization.For instance
en represents english. industry_type
string
Business type
industry_size
string
The size of the industry. The possibe values could be "small scale", "medium scale", "large scale"
portal_name
string
(Required)
Poratal name for the organisation. Length of the portal name should be greater than 4 and less than 31. Allowed chars [a-z][A-Z][0-9]
org_address
string
Billing address of the organisation
remit_to_address
string
Shipping address of the organisation
address
array
Billing address of the organisation
street_address1
string
Street name of the Billing address of the Organisation
street_address2
string
Continyed billing address of the organisation
city
string
City of the organisation
state
string
State where the organisation is located
country
string
Country of the Organisation
zip
string
ZIP/Postal code of the organisation's location
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/organizations?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
]
info response;
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.zohoapis.com/inventory/v1/organizations?organization_id=10234695")
.post(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'POST',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
'content-type': 'application/json'
},
body: '{"field1":"value1","field2":"value2"}'
};
fetch('https://www.zohoapis.com/inventory/v1/organizations?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.com")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("POST", "/inventory/v1/organizations?organization_id=10234695", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "POST",
"hostname": "www.zohoapis.com",
"port": null,
"path": "/inventory/v1/organizations?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
"content-type": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();
curl --request POST \
--url 'https://www.zohoapis.com/inventory/v1/organizations?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"name": "Zillium Inc",
"fiscal_year_start_month": "january",
"currency_code": "USD",
"time_zone": "PST",
"date_format": "dd MMM yyyy",
"field_separator": " ",
"language_code": "en",
"industry_type": "Services",
"industry_size": " ",
"portal_name": "zilluminc",
"org_address": " ",
"remit_to_address": " ",
"address": [
{
"street_address1": " ",
"street_address2": " ",
"city": " ",
"state": " ",
"country": "U.S.A",
"zip": "U.S.A"
}
]
}
{
"code": 0,
"message": "success",
"organization": {
"organization_id": "10229182",
"name": "Zillium Inc",
"is_logo_uploaded": " ",
"is_default_org": false,
"user_role": " ",
"account_created_date": "2012-02-15",
"time_zone": "PST",
"language_code": "en",
"date_format": "dd MMM yyyy",
"field_separator": " ",
"fiscal_year_start_month": 0,
"tax_group_enabled": true,
"user_status": " ",
"contact_name": "John Smith",
"industry_type": "Services",
"address": [
{
"street_address1": " ",
"street_address2": " ",
"city": " ",
"state": " ",
"country": "U.S.A",
"zip": "U.S.A"
}
]
}
}
List organizations
Get the list of organizations.
OAuth Scope : ZohoInventory.settings.READ
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/organizations?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
]
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.com/inventory/v1/organizations?organization_id=10234695")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'GET',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.com/inventory/v1/organizations?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.com")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/inventory/v1/organizations?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "GET",
"hostname": "www.zohoapis.com",
"port": null,
"path": "/inventory/v1/organizations?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request GET \
--url 'https://www.zohoapis.com/inventory/v1/organizations?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "success",
"organizations": [
{
"organization_id": "10229182",
"name": "Zillium Inc",
"contact_name": "John Smith",
"email": "johndavid@zilliuminc.com",
"is_default_org": false,
"plan_type": 130,
"tax_group_enabled": true,
"zi_migration_status": 0,
"plan_name": "PROFESSIONAL",
"plan_period": "Monthly",
"language_code": "en",
"fiscal_year_start_month": 0,
"account_created_date": "2012-02-15",
"account_created_date_formatted": "15 Feb 2012",
"time_zone": "PST",
"is_org_active": true,
"currency_id": "982000000000190",
"currency_code": "USD",
"currency_symbol": "$",
"currency_format": "###,##0.00",
"price_precision": 2
},
{...},
{...}
]
}
Update an organization
Update the details of an organization.
OAuth Scope : ZohoInventory.settings.UPDATE
Arguments
name
string
Name of the project.
fiscal_year_start_month
string
Fiscal or financial starting year of your business. Allowed Values:
january, february, march, april, may, june, july, august, september, october, november and december is_logo_uploaded
boolean
To determine whether logo is uploaded.
time_zone
string
Time zone in with the organization is located geographically.
date_format
string
Format for representing the date.
field_separator
string
Field separator for components in date.
language_code
string
language code for organization.For instance
en represents english. org_address
string
Billing address of the organisation
remit_to_address
string
Shipping address of the organisation
address
array
Billing address of the organisation
street_address1
string
Street name of the Billing address of the Organisation
street_address2
string
Continyed billing address of the organisation
city
string
City of the organisation
state
string
State where the organisation is located
country
string
Country of the Organisation
zip
string
ZIP/Postal code of the organisation's location
contact_name
string
Name of the contact person of the organisation
phone
string
Contact number of the organisation
fax
string
FAX number of the organisation
website
string
Organisation's website
email
string
email ID of the contact person of the organisation
currency_id
string
ID of the organisation curreency
companyid_label
string
Label " Company ID "
companyid_value
string
value in field "company ID"
taxid_label
string
Label "tax ID"
taxid_value
string
Value in "tax ID"
custom_fields
array
Additional fields to describe an organisation
index
double
Index used to list
value
string
Value of the list
label
string
Label of each column
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/organizations/10229182?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
]
info response;
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.zohoapis.com/inventory/v1/organizations/10229182?organization_id=10234695")
.put(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'PUT',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
'content-type': 'application/json'
},
body: '{"field1":"value1","field2":"value2"}'
};
fetch('https://www.zohoapis.com/inventory/v1/organizations/10229182?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.com")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("PUT", "/inventory/v1/organizations/10229182?organization_id=10234695", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "PUT",
"hostname": "www.zohoapis.com",
"port": null,
"path": "/inventory/v1/organizations/10229182?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
"content-type": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();
curl --request PUT \
--url 'https://www.zohoapis.com/inventory/v1/organizations/10229182?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"name": "Zillium Inc",
"fiscal_year_start_month": "january",
"is_logo_uploaded": true,
"time_zone": "PST",
"date_format": "dd MMM yyyy",
"field_separator": " ",
"language_code": "en",
"org_address": " ",
"remit_to_address": " ",
"address": [
{
"street_address1": " ",
"street_address2": " ",
"city": " ",
"state": " ",
"country": "U.S.A",
"zip": "U.S.A"
}
],
"contact_name": "John Smith",
"phone": " ",
"fax": " ",
"website": " ",
"email": "johndavid@zilliuminc.com",
"currency_id": "982000000000190",
"companyid_label": " ",
"companyid_value": " ",
"taxid_label": " ",
"taxid_value": " ",
"custom_fields": [
{
"index": 1,
"value": " ",
"label": " "
}
]
}
{
"code": 0,
"message": "success",
"organization": {
"organization_id": "10229182",
"name": "Zillium Inc",
"is_default_org": false,
"account_created_date": "2012-02-15",
"time_zone": "PST",
"language_code": "en",
"date_format": "dd MMM yyyy",
"field_separator": " ",
"fiscal_year_start_month": 0,
"contact_name": "John Smith",
"industry_type": "Services",
"industry_size": " ",
"company_id_label": "Company ID",
"company_id_value": " ",
"tax_id_label": "Tax ID",
"tax_id_value": " ",
"currency_id": "982000000000190",
"currency_code": "USD",
"currency_symbol": "$",
"currency_format": "###,##0.00",
"price_precision": 2,
"org_address": " ",
"remit_to_address": " ",
"phone": " ",
"fax": " ",
"website": " ",
"email": "johndavid@zilliuminc.com",
"is_org_active": true,
"address": [
{
"street_address1": " ",
"street_address2": " ",
"city": " ",
"state": " ",
"country": "U.S.A",
"zip": "U.S.A"
}
],
"custom_fields": [
{
"index": 1,
"value": " ",
"label": " "
}
]
}
}
Get an organization
Get the details of an organization.
OAuth Scope : ZohoInventory.settings.READ
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/organizations/10229182?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
]
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.com/inventory/v1/organizations/10229182?organization_id=10234695")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'GET',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.com/inventory/v1/organizations/10229182?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.com")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/inventory/v1/organizations/10229182?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "GET",
"hostname": "www.zohoapis.com",
"port": null,
"path": "/inventory/v1/organizations/10229182?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request GET \
--url 'https://www.zohoapis.com/inventory/v1/organizations/10229182?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "success",
"organization": {
"organization_id": "10229182",
"name": "Zillium Inc",
"is_default_org": false,
"account_created_date": "2012-02-15",
"time_zone": "PST",
"language_code": "en",
"date_format": "dd MMM yyyy",
"field_separator": " ",
"fiscal_year_start_month": 0,
"contact_name": "John Smith",
"industry_type": "Services",
"industry_size": " ",
"company_id_label": "Company ID",
"company_id_value": " ",
"tax_id_label": "Tax ID",
"tax_id_value": " ",
"currency_id": "982000000000190",
"currency_code": "USD",
"currency_symbol": "$",
"currency_format": "###,##0.00",
"price_precision": 2,
"org_address": " ",
"remit_to_address": " ",
"phone": " ",
"fax": " ",
"website": " ",
"email": "johndavid@zilliuminc.com",
"is_org_active": true,
"address": [
{
"street_address1": " ",
"street_address2": " ",
"city": " ",
"state": " ",
"country": "U.S.A",
"zip": "U.S.A"
}
],
"custom_fields": [
{
"index": 1,
"value": " ",
"label": " "
}
]
}
}