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".
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.
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".
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
List of all the Price Lists
Get the list of all the Price Lists with pagination.
OAuth Scope : ZohoInvoice.settings.READ
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".
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.
Retrieve a Price list
Fetch the details of an existing Price List.
OAuth Scope : ZohoInvoice.settings.READ
Delete a Price List
Delete a Price List.
OAuth Scope : ZohoInvoice.settings.DELETE