Choose where you’d like to start

Get organization from Zoho Billing

Table of Contents

Note: This task is applicable to all Zoho services except Zoho Creator.

Overview

The zoho.subscriptions.getOrganizations task is used to fetch all the organizations associated with your Zoho Billing account. This task is based on the Zoho Billing API - Organization ID.

Syntax

<response> = zoho.subscriptions.getOrganizations(<connection>);
where:
ParamsData typeDescription

<response>

KEY-VALUE

The details of the organizations that you are part of.

<connection>

TEXT

The link name of the connection.

Note:

  • In view of stopping new authtoken generation, a Zoho OAuth connection with appropriate scopes is mandatory in order for new integration tasks (created after the deadline specified in the post) to work as expected. Existing integration tasks will continue to work with or without the connections parameter until you manually delete the authtoken from accounts.
  • Add relevant scopes mentioned in Zoho Billing - Organization ID while creating the connection.
  • Refer to this post for the list of Zoho services that support the connections page.
  • Learn more about connections

Example

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

 response = zoho.subscriptions.getOrganizations("subscriptions_connection");

where:

response
The KEY-VALUE response that represents the details of the organizations that you are part of.
"subscriptions_connection"
The TEXT that represents the link name of the connection.

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": 0,
      "plan_name": "FREE",
      "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": [
      "books",
      "inventory"
      ],
      "is_default_org": false
      },
      {
      "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": "FREE",
      "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": "Travel India",
      "contact_name": "Travel Desk",
      "email": "donotreply@travel.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": "FREE",
      "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") ;
}

Related Links

Get Started Now

Execute