Get organization from Zoho Inventory

Overview
Syntax
Example
Response Format
Related Links

Note:

Each time the zoho.inventory.getOrganizations integration task is executed, it triggers an API request in the back-end. This call is deducted from the external calls limit available for the service from which the task is executed, based on your pricing plan.
Only actual executions that receive a response (whether success or failure) are counted, not the number of times the task appears in the script. For example, if zoho.inventory.getOrganizations integration task is placed inside a for each task that iterates five times, the number of external calls consumed will be five, even though the task appears only once in the script.

Overview

The zoho.inventory.getOrganizations task is used to fetch all the organizations associated with your Zoho Inventory account.

Syntax

<response> = zoho.inventory.getOrganizations([<connection>]);

where:

Params

Data type

Description

KEY-VALUE

The details of the organizations that you are part of.

(optional)*

TEXT

The name of the connection.

*Note: This parameter is mandatory in Zoho Cliq.

Example

The following example fetches all the organizations associated with your Zoho Inventory account:

 response = zoho.inventory.getOrganizations();

where:

response

The KEY-VALUE response that represents the details of the organizations that you are part of.

Response Format

Success Response

The success response will be returned in the following format:
  {
  "code": 0,
  "message": "success",
  "organizations": [
  {
  "isOrgNotSupported": false,
  "organization_id": "67XXXXX41",
  "name": "Sample",
  "contact_name": "Shawn",
  "email": "shawn@zylker.com",
  "source": 2,
  "country": "India",
  "country_code": "IN",
  "org_settings": true,
  "is_ziedition": false,
  "custom_field_type": 2,
  "is_sku_enabled": true,
  "zoho_one_org": "",
  "zi_zb_edition": 1,
  "org_created_app_source": 1,
  "zi_zb_client": 1,
  "partners_domain": "",
  "version": "india",
  "version_formatted": "India",
  "is_search360_enabled": "true",
  "is_registered_for_composite_scheme": false,
  "is_sales_reverse_charge_enabled": false,
  "is_export_with_payment_enabled": false,
  "state_code": "TN",
  "is_registered_for_tax": false,
  "is_sales_inclusive_tax_enabled": false,
  "sales_tax_type": "exclusive",
  "is_gst_india_version": false,
  "is_registered_for_gst": false,
  "tax_group_enabled": true,
  "language_code": "en",
  "fiscal_year_start_month": 3,
  "time_zone": "Asia/Calcutta",
  "field_separator": "/",
  "time_zone_formatted": "(GMT 5:30) India Standard Time (Asia/Calcutta)",
  "can_change_timezone": true,
  "digital_signature_mode": "none",
  "is_dsign_required": false,
  "can_sign_invoice": false,
  "is_user_dsign_mandatory": true,
  "currency_id": "1649636000000000099",
  "currency_code": "INR",
  "currency_symbol": "\u20b9",
  "currency_format": "#,##,##0.00",
  "price_precision": 2,
  "org_joined_app_list": [
  "books",
  "inventory"
  ],
  "is_tax_registered": false,
  "is_international_trade_enabled": false,
  "is_designated_zone": false,
  "isOrgActive": true,
  "plan_type": 100,
  "plan_name": "FREE",
  "plan_period": "",
  "account_created_date": "2019-07-04",
  "account_created_date_formatted": "04/07/2019",
  "is_org_active": true,
  "is_quick_setup_completed": false,
  "is_trial_period_extended": false,
  "is_invoice_pmt_tds_allowed": true,
  "is_hsn_or_sac_enabled": false,
  "mode": "live",
  "org_action": "goto",
  "AppList": [
  "books",
  "inventory"
  ],
  "is_default_org": true
  },
  {
  "isOrgNotSupported": false,
  "organization_id": "69XXXXX37",
  "name": "Test24",
  "contact_name": "Shawn",
  "email": "shawn@zylker.com",
  "source": 2,
  "country": "India",
  "country_code": "IN",
  "org_settings": true,
  "is_ziedition": false,
  "custom_field_type": 2,
  "is_sku_enabled": false,
  "zoho_one_org": "",
  "zi_zb_edition": 0,
  "org_created_app_source": 0,
  "zi_zb_client": 0,
  "partners_domain": "",
  "version": "india",
  "version_formatted": "India",
  "is_search360_enabled": "true",
  "is_registered_for_composite_scheme": false,
  "is_sales_reverse_charge_enabled": false,
  "is_export_with_payment_enabled": false,
  "state_code": "TN",
  "is_registered_for_tax": false,
  "is_sales_inclusive_tax_enabled": false,
  "sales_tax_type": "exclusive",
  "is_gst_india_version": false,
  "is_registered_for_gst": false,
  "tax_group_enabled": true,
  "language_code": "en",
  "fiscal_year_start_month": 3,
  "time_zone": "Asia/Calcutta",
  "field_separator": "/",
  "time_zone_formatted": "(GMT 5:30) India Standard Time (Asia/Calcutta)",
  "can_change_timezone": true,
  "digital_signature_mode": "none",
  "is_dsign_required": false,
  "can_sign_invoice": false,
  "is_user_dsign_mandatory": true,
  "currency_id": "1923321000000000099",
  "currency_code": "INR",
  "currency_symbol": "\u20b9",
  "currency_format": "#,##,##0.00",
  "price_precision": 2,
  "org_joined_app_list": [
  "invoice"
  ],
  "is_designated_zone": false,
  "isOrgActive": true,
  "plan_type": 0,
  "plan_name": "TRIAL",
  "plan_period": "",
  "is_org_active": true,
  "is_quick_setup_completed": false,
  "is_trial_period_extended": false,
  "is_invoice_pmt_tds_allowed": true,
  "is_hsn_or_sac_enabled": false,
  "mode": "read_only",
  "org_action": "join",
  "AppList": [
  "invoice"
  ],
  "is_default_org": false
  },
  {
  "isOrgNotSupported": false,
  "organization_id": "63XXXXX22",
  "name": "Zoho Travel India",
  "contact_name": "Travel Desk",
  "email": "donotreply@zylkertravel.com",
  "source": 2,
  "country": "India",
  "country_code": "IN",
  "org_settings": true,
  "is_ziedition": false,
  "custom_field_type": 2,
  "is_sku_enabled": true,
  "zoho_one_org": "",
  "zi_zb_edition": 1,
  "org_created_app_source": 3,
  "zi_zb_client": 1,
  "partners_domain": "null",
  "version": "india",
  "version_formatted": "India",
  "is_search360_enabled": "true",
  "is_registered_for_composite_scheme": false,
  "is_sales_reverse_charge_enabled": false,
  "is_export_with_payment_enabled": false,
  "state_code": "TN",
  "is_registered_for_tax": false,
  "is_sales_inclusive_tax_enabled": false,
  "sales_tax_type": "exclusive",
  "is_gst_india_version": false,
  "is_registered_for_gst": false,
  "tax_group_enabled": true,
  "language_code": "en",
  "fiscal_year_start_month": 3,
  "time_zone": "Asia/Calcutta",
  "field_separator": "-",
  "time_zone_formatted": "(GMT 5:30) India Standard Time (Asia/Calcutta)",
  "can_change_timezone": true,
  "digital_signature_mode": "none",
  "is_dsign_required": false,
  "can_sign_invoice": false,
  "is_user_dsign_mandatory": true,
  "currency_id": "420519000000000099",
  "currency_code": "INR",
  "currency_symbol": "Rs.",
  "currency_format": "#,##,##0.00",
  "price_precision": 2,
  "org_joined_app_list": [
  "books",
  "expense",
  "financeplus"
  ],
  "is_tax_registered": false,
  "is_international_trade_enabled": false,
  "is_designated_zone": false,
  "isOrgActive": true,
  "plan_type": 0,
  "plan_name": "TRIAL",
  "plan_period": "",
  "is_org_active": true,
  "is_quick_setup_completed": false,
  "is_trial_period_extended": false,
  "is_invoice_pmt_tds_allowed": true,
  "is_hsn_or_sac_enabled": true,
  "mode": "read_only",
  "org_action": "no_access",
  "AppList": [
  "expense"
  ],
  "is_default_org": false
  }
  ]
  }

To get the ID of the organizations, execute the following script:

organizations_details = response.get("organizations");
for each org in organizations_details
{
info org.get("organization_id") ;
}

Get organization from Zoho Inventory

Table of Contents

Overview

Syntax

Example

Response Format

Related Links