Toll free - 1800 102 9944Mon - Sat 9am to 6pm IST+91 7305654908Contact Us

Organizations - Zakya API

An Organisation represents a company or an institution running a business.

Attribute

  • organization_idstring

    ID of the organisation generated by the server

  • namestring

    Name of the Organisation

  • contact_namestring

    Name of the contact person of the organisation

  • emailstring

    email ID of the contact person of the organisation

  • is_default_orgboolean
  • plan_typedouble

    Type of the plan subscribed

  • tax_group_enabledboolean
  • zi_migration_statusdouble
  • plan_namestring

    Name of the subscribed plan

  • plan_periodstring

    Duration/Cycle of the plan cycle

  • language_codestring

    Language for use

  • fiscal_year_start_monthdouble

    Starting month of teh financial year

  • account_created_datestring

    Date of creation of the account

  • account_created_date_formattedstring
  • time_zonestring

    Time Zone of the Organisation's country

  • is_org_activeboolean
  • currency_idstring

    ID of the organisation curreency

  • currency_codestring

    Code of the organisation's base currency

  • currency_symbolstring

    Symbol used to denote currency of a country

  • currency_formatstring

    Format of the organisation's currency

  • price_precisiondouble

    Precision of the number of places of decimal in price

  • gst_registartion_typestring

    Type of GST registration

  • gst_nostring

    GST number of the organisation

  • business_typestring

    Type of business

  • is_orgDeletion_allowedboolean

    To check if deletion of the organisation is allowed

End Points
ExampleCopy
[
    {
        "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": "Trial",
        "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,
        "gst_registartion_type": "Regular",
        "gst_no": "22AAAAA0000A1Z5",
        "business_type": "Apparel, Footwear & Accessories",
        "is_orgDeletion_allowed": false
    }
]

List organizations

Get the list of organizations.

OAuth Scope : Zakya.organizations.READ

Request ExampleCopy
curl --request GET \
  --url 'https://api.zakya.com/v1/organizations?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://api.zakya.com/v1/organizations?organization_id=10234695"
type: GET
headers: headers_data
connection: 
]
info response;
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.zakya.com/v1/organizations?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();
const http = require("https");

const options = {
  "method": "GET",
  "hostname": "api.zakya.com",
  "port": null,
  "path": "/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();
const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://api.zakya.com/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("api.zakya.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/v1/organizations?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
Response ExampleCopy
{
    "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": "Trial",
            "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,
            "gst_registartion_type": "Regular",
            "gst_no": "22AAAAA0000A1Z5",
            "business_type": "Apparel, Footwear & Accessories",
            "is_orgDeletion_allowed": false
        },
        {...},
        {...}
    ]
}

Get an organization

Get the details of an organization.

OAuth Scope : Zakya.organizations.READ

Request ExampleCopy
curl --request GET \
  --url 'https://api.zakya.com/pos/v1/organizations/10229182?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://api.zakya.com/pos/v1/organizations/10229182?organization_id=10234695"
type: GET
headers: headers_data
connection: 
]
info response;
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.zakya.com/pos/v1/organizations/10229182?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();
const http = require("https");

const options = {
  "method": "GET",
  "hostname": "api.zakya.com",
  "port": null,
  "path": "/pos/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();
const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://api.zakya.com/pos/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("api.zakya.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/pos/v1/organizations/10229182?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
Response ExampleCopy
{
    "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": " "
            }
        ],
        "gst_registartion_type": "Regular",
        "gst_no": "22AAAAA0000A1Z5",
        "business_type": "Apparel, Footwear & Accessories",
        "is_orgDeletion_allowed": false
    }
}