Price Lists

Price list is a list containing a set of different prices for the items you sell.

End Points

POST

/pricebooks

GET

/pricebooks

PUT

/pricebooks/{pricebook_id}

GET

/pricebooks/{pricebook_id}

DELETE

/pricebooks/{pricebook_id}

Attribute

pricebook_id

string

Unique ID generated by the server for a price list.

name

string

Name of the price list. Maximum length of the name [100]

description

string

Description for the price list. Maximum characters to be used for describing the price list [2000]

currency_id

string

A unique ID for the currency.

currency_code

string

A unique code for the currency. Maximum length [100]

pricebook_items

array

Items of a price book. It is mandatory for the price list type "per_item".

Show Sub-Attributes

item_id

string

ID of the item for which the price list is created.

pricebook_rate

double

The rate of the item for your price list.

status

string

Status of the price list. It can be active or inactive. It tells whether the Item is available for transactions.

is_default

boolean

Is default.

pricebook_type

string

Type of the Pricebook. Allowed Values fixed_percentage, per_item

is_increase

boolean

Markup or Markdown the item rates by a percentage. Allowed Values true, false

rounding_type

string

Type of the Rounding type. Allowed Values no_rounding, round_to_dollar_minus_01, round_to_half_dollar, round_to_half_dollar_minus_01 and round_to_dollar

sales_or_purchase_type

string

Sales Type.

{
    "pricebook_id": 1152891000000265000,
    "name": "Price List Per Item",
    "description": "checktest",
    "currency_id": 982000000004012,
    "currency_code": "INR",
    "pricebook_items": [
        {
            "item_id": 982000000030049,
            "pricebook_rate": 120
        }
    ],
    "status": "active",
    "is_default": false,
    "pricebook_type": "per_item",
    "is_increase": false,
    "rounding_type": "no_rounding",
    "sales_or_purchase_type": "sales"
}

Create a Price List

Create a new Price List.
OAuth Scope : ZohoInvoice.settings.CREATE

Arguments

name

string

(Required)

Name of the price list. Maximum length of the name [100]

pricebook_items

array

Items of a price book. It is mandatory for the price list type "per_item".

Show Sub-Attributes

item_id

string

ID of the item for which the price list is created.

pricebook_rate

double

The rate of the item for your price list.

currency_id

string

A unique ID for the currency.

pricebook_type

string

(Required)

Type of the Pricebook. Allowed Values fixed_percentage, per_item

is_increase

boolean

(Required)

Markup or Markdown the item rates by a percentage. Allowed Values true, false

rounding_type

string

(Required)

Type of the Rounding type. Allowed Values no_rounding, round_to_dollar_minus_01, round_to_half_dollar, round_to_half_dollar_minus_01 and round_to_dollar

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("X-com-zoho-invoice-organizationid", "10234695");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/invoice/v3/pricebooks"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/invoice/v3/pricebooks")
  .post(body)
  .addHeader("X-com-zoho-invoice-organizationid", "10234695")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    'X-com-zoho-invoice-organizationid': '10234695',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/invoice/v3/pricebooks', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'X-com-zoho-invoice-organizationid': "10234695",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/invoice/v3/pricebooks", payload, headers)

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

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/invoice/v3/pricebooks",
  "headers": {
    "X-com-zoho-invoice-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

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.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url https://www.zohoapis.com/invoice/v3/pricebooks \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'X-com-zoho-invoice-organizationid: 10234695' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "name": "Price List Per Item",
    "pricebook_items": [
        {
            "item_id": 982000000030049,
            "pricebook_rate": 120
        }
    ],
    "currency_id": 982000000004012,
    "pricebook_type": "per_item",
    "is_increase": false,
    "rounding_type": "no_rounding"
}

{
    "code": 0,
    "message": "Price list has been created.",
    "pricebook": {
        "pricebook_id": 1152891000000265000,
        "name": "Price List Per Item",
        "description": "checktest",
        "currency_id": 982000000004012,
        "currency_code": "INR",
        "pricebook_items": [
            {
                "item_id": 982000000030049,
                "pricebook_rate": 120
            }
        ],
        "status": "active",
        "is_default": false,
        "pricebook_type": "per_item",
        "is_increase": false,
        "rounding_type": "no_rounding",
        "sales_or_purchase_type": "sales"
    }
}

List of all the Price Lists

Get the list of all the Price Lists with pagination.
OAuth Scope : ZohoInvoice.settings.READ

headers_data = Map();
headers_data.put("X-com-zoho-invoice-organizationid", "10234695");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/invoice/v3/pricebooks"
type: GET
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/invoice/v3/pricebooks")
  .get()
  .addHeader("X-com-zoho-invoice-organizationid", "10234695")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    'X-com-zoho-invoice-organizationid': '10234695',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/invoice/v3/pricebooks', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = {
    'X-com-zoho-invoice-organizationid': "10234695",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
    }

conn.request("GET", "/invoice/v3/pricebooks", headers=headers)

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

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/invoice/v3/pricebooks",
  "headers": {
    "X-com-zoho-invoice-organizationid": "10234695",
    "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();

curl --request GET \
  --url https://www.zohoapis.com/invoice/v3/pricebooks \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'X-com-zoho-invoice-organizationid: 10234695'

{
    "code": 0,
    "message": "success",
    "pricebooks": [
        {
            "pricebook_id": 1152891000000265000,
            "name": "Price List Per Item",
            "description": "checktest",
            "currency_id": 982000000004012,
            "currency_code": "INR",
            "pricebook_items": [
                {
                    "item_id": 982000000030049,
                    "pricebook_rate": 120
                }
            ],
            "status": "active",
            "is_default": false,
            "pricebook_type": "per_item",
            "is_increase": false,
            "rounding_type": "no_rounding",
            "sales_or_purchase_type": "sales"
        },
        {...},
        {...}
    ]
}

Update a Price List

Update an existing Price List.
OAuth Scope : ZohoInvoice.settings.UPDATE

Arguments

name

string

(Required)

Name of the price list. Maximum length of the name [100]

currency_id

string

A unique ID for the currency.

pricebook_type

string

(Required)

Type of the Pricebook. Allowed Values fixed_percentage, per_item

is_increase

boolean

(Required)

Markup or Markdown the item rates by a percentage. Allowed Values true, false

rounding_type

string

(Required)

Type of the Rounding type. Allowed Values no_rounding, round_to_dollar_minus_01, round_to_half_dollar, round_to_half_dollar_minus_01 and round_to_dollar

pricebook_items

array

Items of a price book. It is mandatory for the price list type "per_item".

Show Sub-Attributes

item_id

string

ID of the item for which the price list is created.

pricebook_rate

double

The rate of the item for your price list.

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("X-com-zoho-invoice-organizationid", "10234695");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/invoice/v3/pricebooks/1152891000000265000"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/invoice/v3/pricebooks/1152891000000265000")
  .put(body)
  .addHeader("X-com-zoho-invoice-organizationid", "10234695")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    'X-com-zoho-invoice-organizationid': '10234695',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/invoice/v3/pricebooks/1152891000000265000', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'X-com-zoho-invoice-organizationid': "10234695",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/invoice/v3/pricebooks/1152891000000265000", payload, headers)

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

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/invoice/v3/pricebooks/1152891000000265000",
  "headers": {
    "X-com-zoho-invoice-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

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.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request PUT \
  --url https://www.zohoapis.com/invoice/v3/pricebooks/1152891000000265000 \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'X-com-zoho-invoice-organizationid: 10234695' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "name": "Price List Per Item",
    "currency_id": 982000000004012,
    "pricebook_type": "per_item",
    "is_increase": false,
    "rounding_type": "no_rounding",
    "pricebook_items": [
        {
            "item_id": 982000000030049,
            "pricebook_rate": 120
        }
    ]
}

{
    "code": 0,
    "message": "Price list has been updated.",
    "pricebook": {
        "pricebook_id": 1152891000000265000,
        "name": "Price List Per Item",
        "description": "checktest",
        "currency_id": 982000000004012,
        "currency_code": "INR",
        "pricebook_items": [
            {
                "item_id": 982000000030049,
                "pricebook_rate": 120
            }
        ],
        "status": "active",
        "is_default": false,
        "pricebook_type": "per_item",
        "is_increase": false,
        "rounding_type": "no_rounding",
        "sales_or_purchase_type": "sales"
    }
}

Retrieve a Price list

Fetch the details of an existing Price List.
OAuth Scope : ZohoInvoice.settings.READ

headers_data = Map();
headers_data.put("X-com-zoho-invoice-organizationid", "10234695");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/invoice/v3/pricebooks/1152891000000265000"
type: GET
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/invoice/v3/pricebooks/1152891000000265000")
  .get()
  .addHeader("X-com-zoho-invoice-organizationid", "10234695")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    'X-com-zoho-invoice-organizationid': '10234695',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/invoice/v3/pricebooks/1152891000000265000', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = {
    'X-com-zoho-invoice-organizationid': "10234695",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
    }

conn.request("GET", "/invoice/v3/pricebooks/1152891000000265000", headers=headers)

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

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/invoice/v3/pricebooks/1152891000000265000",
  "headers": {
    "X-com-zoho-invoice-organizationid": "10234695",
    "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();

curl --request GET \
  --url https://www.zohoapis.com/invoice/v3/pricebooks/1152891000000265000 \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'X-com-zoho-invoice-organizationid: 10234695'

{
    "code": 0,
    "message": "success",
    "pricebook": {
        "pricebook_id": 1152891000000265000,
        "name": "Price List Per Item",
        "description": "checktest",
        "currency_id": 982000000004012,
        "currency_code": "INR",
        "pricebook_items": [
            {
                "item_id": 982000000030049,
                "pricebook_rate": 120
            }
        ],
        "status": "active",
        "is_default": false,
        "pricebook_type": "per_item",
        "is_increase": false,
        "rounding_type": "no_rounding",
        "sales_or_purchase_type": "sales"
    }
}

Delete a Price List

Delete a Price List.
OAuth Scope : ZohoInvoice.settings.DELETE

headers_data = Map();
headers_data.put("X-com-zoho-invoice-organizationid", "10234695");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/invoice/v3/pricebooks/1152891000000265000"
type: DELETE
headers: headers_data
connection: <connection_name>
]
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/invoice/v3/pricebooks/1152891000000265000")
  .delete(null)
  .addHeader("X-com-zoho-invoice-organizationid", "10234695")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'DELETE',
  headers: {
    'X-com-zoho-invoice-organizationid': '10234695',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/invoice/v3/pricebooks/1152891000000265000', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = {
    'X-com-zoho-invoice-organizationid': "10234695",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
    }

conn.request("DELETE", "/invoice/v3/pricebooks/1152891000000265000", headers=headers)

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

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "DELETE",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/invoice/v3/pricebooks/1152891000000265000",
  "headers": {
    "X-com-zoho-invoice-organizationid": "10234695",
    "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();

curl --request DELETE \
  --url https://www.zohoapis.com/invoice/v3/pricebooks/1152891000000265000 \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'X-com-zoho-invoice-organizationid: 10234695'

{
    "code": 0,
    "message": "Price list has been deleted."
}