Top

Organizations

List organizations
GET /organizations
Get the list of organizations.
Get an organization
GET /organizations/:organization_id
Get the details of an organization.
Create an organization
POST /organizations
Create an organization.
Update an organization
PUT /organizations/:organization_id
Update the details of an organization.
Add a organization address
POST /organizations/address
Add a organization address
Update a organization address
PUT /organizations/address/:organization_address_id
Update an existing organization address

List organizations

GET  /organizations

Get the list of organizations.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "organizations": [
    {
      "organization_id": "10234695",
      "name": "Zillium Inc",
      "contact_name": "John Smith",
      "email": "johnsmith@zilliuminc.com",
      "is_default_org": false,
      "plan_type": 0,
      "tax_group_enabled": true,
      "plan_name": "TRIAL",
      "plan_period": "",
      "language_code": "en",
      "fiscal_year_start_month": 0,
      "account_created_date": "2012-02-18",
      "account_created_date_formatted": "18 Feb 2012",
      "time_zone": "Asia/Calcutta",
      "is_org_active": true,
      "currency_id": "460000000000097",
      "currency_code": "USD",
      "currency_symbol": "$",
      "currency_format": "###,##0.00",
      "price_precision": 2
    },
    {
      "organization_id": "10407630",
      "name": "Winston Longbridge",
      "contact_name": "John Smith",
      "email": "johnsmith@zilliuminc.com",
      "is_default_org": false,
      "plan_type": 0,
      "tax_group_enabled": true,
      "plan_name": "TRIAL",
      "plan_period": "",
      "language_code": "en",
      "fiscal_year_start_month": 0,
      "account_created_date": "2012-07-11",
      "account_created_date_formatted": "11 Jul 2012",
      "time_zone": "Asia/Calcutta",
      "is_org_active": true,
      "currency_id": "541000000000099",
      "currency_code": "INR",
      "currency_symbol": "Rs.",
      "currency_format": "###,##0.00",
      "price_precision": 2
    }
  ]
}

Get an organization

GET  /organizations/:organization_id

Get the details of an organization.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "organization": {
    "organization_id": "10234695",
    "name": "Zillium Inc",
    "is_default_org": false,
    "account_created_date": "2012-02-18",
    "time_zone": "Asia/Calcutta",
    "language_code": "en",
    "date_format": "dd MMM yyyy",
    "field_separator": "",
    "fiscal_year_start_month": "january",
    "contact_name": "John Smith",
    "industry_type": "",
    "industry_size": "",
    "company_id_label": "Company ID :",
    "company_id_value": "",
    "tax_id_label": "Tax ID :",
    "tax_id_value": "",
    "currency_id": "460000000000097",
    "currency_code": "USD",
    "currency_symbol": "$",
    "currency_format": "###,##0.00",
    "price_precision": 2,
    "version" : "global",
    "address": {
      "street_address1": "9390 Research Blvd",
      "street_address2": "Bldg II, Suite 440",
      "city": "Austin",
      "state": "Texas",
      "country": "U.S.A",
      "zip": "78759"
    },
    "org_address": "",
    "remit_to_address": "",
    "phone": "",
    "fax": "",
    "website": "",
    "email": "johnsmith@zilliuminc.com",
    "tax_basis": "accrual",
    "is_org_active": true
  }
}

Create an organization

POST  /organizations

Create an organization.

Request attributes

name* string
[100]
Name of the organization.
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
[100]
Standard code for currency.
time_zone* string
[100]
Time zone in with the organization is located geographically.
date_format string
[100]
Format for representing the date.
field_separator string
[100]
Field separator for components in date.
language_code string
[2]
language code for organization.For instance en represents english.
tax_basis string Tax basis based on accrual(tax as of invoice date) or cash(tax upon payment receipt).
Allowed Values: accrual and cash.
tax_type string Type to determine whether it is a simple or compound tax.
Allowed Values: tax and compound_tax.
version string A string to specify the country specific version of Zoho Books, version can be either global or us.
is_registered_for_tax (US Edition only) boolean A boolean to enable or disable sales tax. This node is takes effect only if the version is us.
tax_payment_period (US Edition only) string Denotes tax payment period, it can be monthly, quarterly, halfyearly or yearly.

Sample Request

{
      "name": "Zillium Inc",
      "address": {
        "street_address1": "9390 Research Blvd",
        "street_address2": "Bldg II, Suite 440",
        "city": "Austin",
        "state": "Texas",
        "country": "U.S.A",
        "zip": "78759"
      },
      "industry_type": "",
      "industry_size": "",
      "fiscal_year_start_month": "january",
      "currency_code": "USD",
      "time_zone": "Asia/Calcutta",
      "date_format": "dd MMM yyyy",
      "field_separator": "",
      "language_code": "en",
      "tax_basis": "accrual",
      "org_address": "",
      "remit_to_address": "",
      "version" : "global"
    }

Sample Response

Status: 201 Created
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "The organization has been added.",
      "organization": {
        "organization_id": "10234695",
        "name": "Zillium Inc",
        "is_logo_uploaded": "",
        "is_default_org": false,
        "user_role": "",
        "account_created_date": "2012-02-18",
        "time_zone": "Asia/Calcutta",
        "language_code": "en",
        "date_format": "dd MMM yyyy",
        "field_separator": "",
        "fiscal_year_start_month": "january",
        "tax_group_enabled": "",
        "user_status": "",
        "contact_name": "John Smith",
        "industry_type": "",
        "industry_size": "",
        "company_id_label": "Company ID :",
        "company_id_value": "",
        "tax_id_label": "Tax ID :",
        "tax_id_value": "",
        "currency_id": "460000000000097",
        "currency_code": "USD",
        "currency_symbol": "$",
        "currency_format": "###,##0.00",
        "price_precision": 2,
        "address": {
          "street_address1": "9390 Research Blvd",
          "street_address2": "Bldg II, Suite 440",
          "city": "Austin",
          "state": "Texas",
          "country": "U.S.A",
          "zip": "78759"
        },
        "version" : "global",
        "org_address": "",
        "remit_to_address": "",
        "phone": "",
        "fax": "",
        "website": "",
        "email": "johnsmith@zilliuminc.com",
        "unverified_email": "",
        "tax_basis": "accrual",
        "is_org_active": true,
        "is_transaction_available": "",
        "show_org_address_as_one_field": ""
      }
    }

Update an organization

PUT  /organizations/:organization_id

Update the details of an organization.

Request attributes

name string
[100]
Name of the organization.
is_logo_uploaded boolean To determine whether logo is uploaded.
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
[100]
Standard code for currency.
language_code string
[2]
language code for organization.For instance en represents english.
time_zone string
[100]
Time zone in with the organization is located geographically.
date_format string
[100]
Format for representing the date.
field_separator string
[100]
Field separator for components in date.
tax_basis string Tax basis based on accrual(tax as of invoice date) or cash(tax upon payment receipt).
Allowed Values: accrual and cash
version string A string to specify the country specific version of Zoho Books, version can be either global or us.
is_registered_for_tax boolean A boolean to enable or disable sales tax. This node is takes effect only if the version is us.
tax_payment_period string Denotes tax payment period, it can be monthly, quarterly, halfyearly or yearly. This node is available only if is_registered_for_tax is true.

Sample Request

{
      "name": "Zillium Inc",
      "is_logo_uploaded": "",
      "industry_type": "",
      "industry_size": "",
      "address": {
        "street_address1": "9390 Research Blvd",
        "street_address2": "Bldg II, Suite 440",
        "city": "Austin",
        "state": "Texas",
        "country": "U.S.A",
        "zip": "78759"
      },
      "org_address": "",
      "remit_to_address": "",
      "contact_name": "John Smith",
      "phone": "",
      "fax": "",
      "website": "",
      "email": "johnsmith@zilliuminc.com",
      "fiscal_year_start_month": "january",
      "currency_code": "USD",
      "language_code": "en",
      "time_zone": "Asia/Calcutta",
      "date_format": "dd MMM yyyy",
      "field_separator": "",
      "companyid_label": "",
      "companyid_value": "",
      "taxid_label": "",
      "taxid_value": "",
      "tax_basis": "accrual"
    }

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "Your organization profile has been saved.",
      "organization": {
        "organization_id": "10234695",
        "name": "Zillium Inc",
        "is_default_org": false,
        "account_created_date": "2012-02-18",
        "time_zone": "Asia/Calcutta",
        "language_code": "en",
        "date_format": "dd MMM yyyy",
        "field_separator": "",
        "fiscal_year_start_month": "january",
        "contact_name": "John Smith",
        "industry_type": "",
        "industry_size": "",
        "company_id_label": "Company ID :",
        "company_id_value": "",
        "tax_id_label": "Tax ID :",
        "tax_id_value": "",
        "currency_id": "460000000000097",
        "currency_code": "USD",
        "currency_symbol": "$",
        "currency_format": "###,##0.00",
        "version" : "global",
        "price_precision": 2,
        "address": {
          "street_address1": "9390 Research Blvd",
          "street_address2": "Bldg II, Suite 440",
          "city": "Austin",
          "state": "Texas",
          "country": "U.S.A",
          "zip": "78759"
        },
        "org_address": "",
        "remit_to_address": "",
        "phone": "",
        "fax": "",
        "website": "",
        "email": "johnsmith@zilliuminc.com",
        "tax_basis": "accrual",
        "is_org_active": true
      }
    }

Add a organization address

POST  /organizations/address

Add a organization address

Request attributes

attention string
[100]
Contact person in that address.

Sample Request

{
        "attention": "Mr.John Smith",
        "address": "9390 Research Blvd,Bldg II, Suite 440",
        "city": "Austin",
        "state": "Texas",
        "country": "U.S.A",
        "phone": "",
        "zip": "78759"
    }

Sample Response

Status: 201 Created
Content Type: application/json;charset=UTF-8
{
    "code": 0,
    "message": "The address has been saved.",
    "organization_address": {
        "organization_address_id": "460000000043001",
        "attention": "Mr.John Smith",
        "address": "9390 Research Blvd,Bldg II, Suite 440",
        "city": "Austin",
        "state": "Texas",
        "country": "U.S.A",
        "zip": "78759",
        "phone": ""
    }
}

Update a organization address

PUT  /organizations/address/:organization_address_id

Update an existing organization address

Request attributes

attention string
[100]
Contact person in that address.

Sample Request

{
        "attention": "Mr.John Smith",
        "address": "9390 Research Blvd,Bldg II, Suite 440",
        "city": "Austin",
        "state": "Texas",
        "country": "U.S.A",
        "phone": "",
        "zip": "78759"
    }

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
    "code": 0,
    "message": "The address has been updated.",
    "organization_address": {
        "organization_address_id": "460000000043001",
        "attention": "Mr.John Smith",
        "address": "9390 Research Blvd,Bldg II, Suite 440",
        "city": "Austin",
        "state": "Texas",
        "country": "U.S.A",
        "zip": "78759",
        "phone": ""
    }
}