API Docs
/
No Results Found
FAQ
Help Docs
All Resources
Price Lists

Price Lists

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

End Points
Create a Price List
List of all the Price Lists
Update a Price List
Retrieve a Price list
Delete a Price List

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

Example

{ "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.
oauthscope : 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 arrow
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

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/pricebooks -X POST -H "X-com-zoho-invoice-organizationid: 10234695" -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "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" }

Response Example

{ "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.
oauthscope : ZohoInvoice.settings.READ

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/pricebooks -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "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.
oauthscope : 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 arrow
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.

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/pricebooks/{pricebook_id} -X PUT -H "X-com-zoho-invoice-organizationid: 10234695" -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "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 } ] }

Response Example

{ "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.
oauthscope : ZohoInvoice.settings.READ

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/pricebooks/{pricebook_id} -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "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.
oauthscope : ZohoInvoice.settings.DELETE

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/pricebooks/{pricebook_id} -X DELETE -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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