Top

Organization

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.

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": "10229182",
      "name": "Zillium Inc",
      "contact_name": "John Smith",
      "email": "johnsmith@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
    },
    {
      "organization_id": "10231283",
      "name": "Winston Longbridge",
      "contact_name": "Lara",
      "email": "lara@winstonlongbridge.com",
      "is_default_org": false,
      "plan_type": 5,
      "tax_group_enabled": true,
      "zi_migration_status": 0,
      "plan_name": "UNLIMITEDPLAN",
      "plan_period": "Monthly",
      "language_code": "en",
      "fiscal_year_start_month": 0,
      "account_created_date": "2012-02-16",
      "account_created_date_formatted": "16 Feb 2012",
      "time_zone": "Asia/Calcutta",
      "is_org_active": true,
      "currency_id": "993000000000190",
      "currency_code": "USD",
      "currency_symbol": "$",
      "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": "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": "january",
    "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,
    "address": {
      "street_address1": "",
      "street_address2": "",
      "city": "",
      "state": "",
      "country": "U.S.A",
      "zip": ""
    },
    "org_address": "",
    "remit_to_address": "",
    "phone": "",
    "fax": "",
    "website": "",
    "email": "johnsmith@zilliuminc.com",
    "custom_fields": [
      {
        "index": 1,
        "value": "",
        "label": ""
      },
      {
        "index": 2,
        "value": "",
        "label": ""
      },
      {
        "index": 3,
        "value": "",
        "label": ""
      },
      {
        "index": 4,
        "value": "",
        "label": ""
      },
      {
        "index": 5,
        "value": "",
        "label": ""
      }
    ],
    "is_org_active": true
  }
}

Create an organization

POST  /organizations

Create an organization.

Parameters

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

Sample Request

{
  "name": "Zillium Inc",
  "address": {
    "street_address1": "",
    "street_address2": "",
    "city": "",
    "state": "",
    "country": "U.S.A",
    "zip": ""
  },
  "industry_type": "Services",
  "industry_size": "",
  "fiscal_year_start_month": "january",
  "currency_code": "USD",
  "time_zone": "PST",
  "date_format": "dd MMM yyyy",
  "field_separator": "",
  "language_code": "en",
  "tax_basis": "",
  "portal_name": "",
  "org_address": "",
  "remit_to_address": ""
}

Sample Response

Status: 201 Created
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "The organization has been added.",
  "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": "january",
    "tax_group_enabled": "",
    "user_status": "",
    "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,
    "address": {
      "street_address1": "",
      "street_address2": "",
      "city": "",
      "state": "",
      "country": "U.S.A",
      "zip": ""
    },
    "org_address": "",
    "remit_to_address": "",
    "phone": "",
    "fax": "",
    "website": "",
    "email": "johnsmith@zilliuminc.com",
    "unverified_email": "",
    "tax_basis": "",
    "is_org_active": true,
    "is_transaction_available": "",
    "show_org_address_as_one_field": "",
    "_links": ""
  }
}

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
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

Sample Request

{
  "name": "Zillium Inc",
  "is_logo_uploaded": "",
  "industry_type": "Services",
  "industry_size": "",
  "address": {
    "street_address1": "",
    "street_address2": "",
    "city": "",
    "state": "",
    "country": "U.S.A",
    "zip": ""
  },
  "org_address": "",
  "remit_to_address": "",
  "contact_name": "John Smith",
  "phone": "",
  "fax": "",
  "website": "",
  "email": "johnsmith@zilliuminc.com",
  "fiscal_year_start_month": "january",
  "currency_id": "982000000000190",
  "language_code": "en",
  "time_zone": "PST",
  "date_format": "dd MMM yyyy",
  "field_separator": "",
  "companyid_label": "",
  "companyid_value": "",
  "taxid_label": "",
  "taxid_value": "",
  "tax_basis": "",
  "custom_fields": [
    {
      "index": 1,
      "label": "",
      "value": ""
    },
    {
      "index": 2,
      "label": "",
      "value": ""
    },
    {
      "index": 3,
      "label": "",
      "value": ""
    },
    {
      "index": 4,
      "label": "",
      "value": ""
    },
    {
      "index": 5,
      "label": "",
      "value": ""
    }
  ]
}

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "Your organization profile has been saved.",
  "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": "january",
    "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,
    "address": {
      "street_address1": "",
      "street_address2": "",
      "city": "",
      "state": "",
      "country": "U.S.A",
      "zip": ""
    },
    "org_address": "",
    "remit_to_address": "",
    "phone": "",
    "fax": "",
    "website": "",
    "email": "johnsmith@zilliuminc.com",
    "custom_fields": [
      {
        "index": 1,
        "value": "",
        "label": ""
      },
      {
        "index": 2,
        "value": "",
        "label": ""
      },
      {
        "index": 3,
        "value": "",
        "label": ""
      },
      {
        "index": 4,
        "value": "",
        "label": ""
      },
      {
        "index": 5,
        "value": "",
        "label": ""
      }
    ],
    "is_org_active": true
  }
}