Sales Order
A sales order is a financial document that confirms an impending sale. It is raised when an initial estimate is approved and the transaction is underway, and details the exact quantity, price and delivery details of the products or services being sold.
Attribute
business_gst
, business_none
, overseas
, consumer
.place of contact
given for the contact will be taken)Supported codes for UAE emirates are :
Abu Dhabi -
AB
,Ajman -
AJ
,Dubai -
DU
,Fujairah -
FU
,Ras al-Khaimah -
RA
,Sharjah -
SH
,Umm al-Quwain -
UM
Supported codes for the GCC countries are :
United Arab Emirates -
AE
,Saudi Arabia -
SA
,Bahrain -
BH
,Kuwait -
KW
,Oman -
OM
,Qatar -
QA
.uk
. If the customer is in an EU country & VAT registered, you are resides in Northen Ireland and purchasing Goods then his VAT treatment is eu_vat_registered
and if he resides outside the UK then his VAT treatment is overseas
(For Pre Brexit, this can be split as eu_vat_registered
, eu_vat_not_registered
and non_eu
).vat_registered
,vat_not_registered
,gcc_vat_not_registered
,gcc_vat_registered
,non_gcc
.dz_vat_registered
and dz_vat_not_registered
supported only for UAE.home_country_mexico
,border_region_mexico
,non_mexico
supported only for MX. For Kenya Edition:
vat_registered
,vat_not_registered
,non_kenya
(A business that is located outside Kenya).For SouthAfrica Edition:
vat_registered
, vat_not_registered
, overseas
(A business that is located outside SouthAfrica).entity_level
and item_level
.goods
or services
.For SouthAfrica Edition:
service
, goods
, capital_service
and capital_goods
Supported values for UAE are
uae_same_tax_group
, uae_reimbursed_expense
and uae_others
.Supported values for Bahrain are
bahrain_same_tax_group
, bahrain_transfer_of_concern
, bahrain_disbursement
, bahrain_head_to_branch_transaction
, bahrain_warranty_repair_services
and bahrain_others
.Supported values for Saudi Arabia are
ksa_pvt_health
, ksa_pvt_edu
, ksa_reimbursed_expense
and ksa_house_sales
.Create a sales order
Create a sales order for your customer.
OAuth Scope : ZohoBooks.salesorders.CREATE
Arguments
place of contact
given for the contact will be taken)Supported codes for UAE emirates are :
Abu Dhabi -
AB
,Ajman -
AJ
,Dubai -
DU
,Fujairah -
FU
,Ras al-Khaimah -
RA
,Sharjah -
SH
,Umm al-Quwain -
UM
Supported codes for the GCC countries are :
United Arab Emirates -
AE
,Saudi Arabia -
SA
,Bahrain -
BH
,Kuwait -
KW
,Oman -
OM
,Qatar -
QA
. business_gst
, business_none
, overseas
, consumer
.goods
or services
.For SouthAfrica Edition:
service
, goods
, capital_service
and capital_goods
Supported values for UAE are
uae_same_tax_group
, uae_reimbursed_expense
and uae_others
.Supported values for Bahrain are
bahrain_same_tax_group
, bahrain_transfer_of_concern
, bahrain_disbursement
, bahrain_head_to_branch_transaction
, bahrain_warranty_repair_services
and bahrain_others
.Supported values for Saudi Arabia are
ksa_pvt_health
, ksa_pvt_edu
, ksa_reimbursed_expense
and ksa_house_sales
.uk
. If the customer is in an EU country & VAT registered, you are resides in Northen Ireland and purchasing Goods then his VAT treatment is eu_vat_registered
and if he resides outside the UK then his VAT treatment is overseas
(For Pre Brexit, this can be split as eu_vat_registered
, eu_vat_not_registered
and non_eu
).vat_registered
,vat_not_registered
,gcc_vat_not_registered
,gcc_vat_registered
,non_gcc
.dz_vat_registered
and dz_vat_not_registered
supported only for UAE.home_country_mexico
,border_region_mexico
,non_mexico
supported only for MX. For Kenya Edition:
vat_registered
,vat_not_registered
,non_kenya
(A business that is located outside Kenya).For SouthAfrica Edition:
vat_registered
, vat_not_registered
, overseas
(A business that is located outside SouthAfrica).vat_registered
)Used to specify whether the transaction is applicable for Domestic Reverse Charge (DRC) or not.
entity_level
and item_level
.Query Parameters
Update a sales order using a custom field's unique value
A custom field will have unique values if it's configured to not accept duplicate values. Now, you can use that custom field's value to update a sales order by providing its API name in the X-Unique-Identifier-Key header and its value in the X-Unique-Identifier-Value header. Based on this value, the corresponding sales order will be retrieved and updated. Additionally, there is an optional X-Upsert header. If the X-Upsert header is true and the custom field's unique value is not found in any of the existing sales orders, a new sales order will be created if the necessary payload details are available
OAuth Scope : ZohoBooks.salesorders.UPDATE
Arguments
place of contact
given for the contact will be taken)Supported codes for UAE emirates are :
Abu Dhabi -
AB
,Ajman -
AJ
,Dubai -
DU
,Fujairah -
FU
,Ras al-Khaimah -
RA
,Sharjah -
SH
,Umm al-Quwain -
UM
Supported codes for the GCC countries are :
United Arab Emirates -
AE
,Saudi Arabia -
SA
,Bahrain -
BH
,Kuwait -
KW
,Oman -
OM
,Qatar -
QA
. business_gst
, business_none
, overseas
, consumer
.Supported values for UAE are
uae_same_tax_group
, uae_reimbursed_expense
and uae_others
.Supported values for Bahrain are
bahrain_same_tax_group
, bahrain_transfer_of_concern
, bahrain_disbursement
, bahrain_head_to_branch_transaction
, bahrain_warranty_repair_services
and bahrain_others
.Supported values for Saudi Arabia are
ksa_pvt_health
, ksa_pvt_edu
, ksa_reimbursed_expense
and ksa_house_sales
.uk
. If the customer is in an EU country & VAT registered, you are resides in Northen Ireland and purchasing Goods then his VAT treatment is eu_vat_registered
and if he resides outside the UK then his VAT treatment is overseas
(For Pre Brexit, this can be split as eu_vat_registered
, eu_vat_not_registered
and non_eu
).vat_registered
,vat_not_registered
,gcc_vat_not_registered
,gcc_vat_registered
,non_gcc
.dz_vat_registered
and dz_vat_not_registered
supported only for UAE.home_country_mexico
,border_region_mexico
,non_mexico
supported only for MX. For Kenya Edition:
vat_registered
,vat_not_registered
,non_kenya
(A business that is located outside Kenya).For SouthAfrica Edition:
vat_registered
, vat_not_registered
, overseas
(A business that is located outside SouthAfrica).vat_registered
)Used to specify whether the transaction is applicable for Domestic Reverse Charge (DRC) or not.
entity_level
and item_level
.List sales orders
List all sales orders.
OAuth Scope : ZohoBooks.salesorders.READ
Query Parameters
customer_name
, salesorder_number
, shipment_date
, last_modified_time
, reference_number
, total
, date
and created_time
.Status.All
, Status.Open
, Status.Draft
, Status.OverDue
, Status.PartiallyInvoiced
, Status.Invoiced
, Status.Void
and Status.Closed
salesorder_number_startswith
, salesorder_number_not_in
, salesorder_number_in
, salesorder_number_contains
. Maximum Length : 100
item_name_startswith
, item_name_not_in
,item_name_in
and item_name_contains
. Maximum Length : 100
item_description_startswith
, item_description_not_in
, item_description_in
and item_description_contains
. Maximum Length: 100
reference_number_startswith
, reference_number_not_in
, reference_number_in
and reference_number_contains
.customer_name_startswith
, customer_name_not_in
, customer_name_in
and customer_name_contains
. Maximum Length : 100
total_start
, total_end
, total_less_than
, total_less_equals
, total_greater_than
and total_greater_equals
.date_start
, date_end
, date_before
and date_after
. Default date format : yyyy-mm-dd
shipment_date_start
, shipment_date_end
, shipment_date_before
and shipment_date_after
. Default date format : yyyy-mm-dd
draft
, open
, invoiced
, partially_invoiced
, void
and overdue
.Maximum Length : 200
json
, csv
, xml
, xls
, xlsx
, pdf
, jhtml
and html
. It will be used when accept = pdf and atleast one value in salesorder_ids
Update a sales order
Update an existing sales order. To delete a line item just remove it from the line_items list.
OAuth Scope : ZohoBooks.salesorders.UPDATE
Arguments
place of contact
given for the contact will be taken)Supported codes for UAE emirates are :
Abu Dhabi -
AB
,Ajman -
AJ
,Dubai -
DU
,Fujairah -
FU
,Ras al-Khaimah -
RA
,Sharjah -
SH
,Umm al-Quwain -
UM
Supported codes for the GCC countries are :
United Arab Emirates -
AE
,Saudi Arabia -
SA
,Bahrain -
BH
,Kuwait -
KW
,Oman -
OM
,Qatar -
QA
. business_gst
, business_none
, overseas
, consumer
.Supported values for UAE are
uae_same_tax_group
, uae_reimbursed_expense
and uae_others
.Supported values for Bahrain are
bahrain_same_tax_group
, bahrain_transfer_of_concern
, bahrain_disbursement
, bahrain_head_to_branch_transaction
, bahrain_warranty_repair_services
and bahrain_others
.Supported values for Saudi Arabia are
ksa_pvt_health
, ksa_pvt_edu
, ksa_reimbursed_expense
and ksa_house_sales
.uk
. If the customer is in an EU country & VAT registered, you are resides in Northen Ireland and purchasing Goods then his VAT treatment is eu_vat_registered
and if he resides outside the UK then his VAT treatment is overseas
(For Pre Brexit, this can be split as eu_vat_registered
, eu_vat_not_registered
and non_eu
).vat_registered
,vat_not_registered
,gcc_vat_not_registered
,gcc_vat_registered
,non_gcc
.dz_vat_registered
and dz_vat_not_registered
supported only for UAE.home_country_mexico
,border_region_mexico
,non_mexico
supported only for MX. For Kenya Edition:
vat_registered
,vat_not_registered
,non_kenya
(A business that is located outside Kenya).For SouthAfrica Edition:
vat_registered
, vat_not_registered
, overseas
(A business that is located outside SouthAfrica).vat_registered
)Used to specify whether the transaction is applicable for Domestic Reverse Charge (DRC) or not.
entity_level
and item_level
.Query Parameters
Get a sales order
Get the details of a sales order.
OAuth Scope : ZohoBooks.salesorders.READ
Query Parameters
json
, csv
, xml
, xls
, xlsx
, pdf
, jhtml
and html
.Delete a sales order
Delete an existing sales order. Invoiced sales order cannot be deleted.
OAuth Scope : ZohoBooks.salesorders.DELETE
Update custom field in existing salesorders
Update the value of the custom field in existing salesorders.
OAuth Scope : ZohoBooks.salesorders.UPDATE
Arguments
Query Parameters
Mark a sales order as open
Mark a draft sales order as open.
OAuth Scope : ZohoBooks.salesorders.CREATE
Mark a sales order as void
Mark a sales order as void.
OAuth Scope : ZohoBooks.salesorders.CREATE
Arguments
Maximum Length: 500
Update a sales order sub status
Update a sales order sub status.
OAuth Scope : ZohoBooks.salesorders.CREATE
Email a sales order
Email a sales order to the customer. Input json string is not mandatory. If input json string is empty, mail will be send with default mail content.
OAuth Scope : ZohoBooks.salesorders.CREATE
Arguments
Query Parameters
Get sales order email content
Get the email content of a sales order.
OAuth Scope : ZohoBooks.salesorders.READ
Query Parameters
Submit a sales order for approval
Submit a sales order for approval.
OAuth Scope : ZohoBooks.salesorders.CREATE
Approve a sales order.
Approve a sales order.
OAuth Scope : ZohoBooks.salesorders.CREATE
Bulk export sales orders
Maximum of 25 sales orders can be exported in a single pdf.
OAuth Scope : ZohoBooks.salesorders.READ
Bulk print sales orders
Export sales orders as pdf and print them. Maximum of 25 sales orders can be printed.
OAuth Scope : ZohoBooks.salesorders.READ
Update billing address
Updates the billing address for this sales order alone.
OAuth Scope : ZohoBooks.salesorders.UPDATE
Arguments
Update shipping address
Updates the shipping address for this sales order alone.
OAuth Scope : ZohoBooks.salesorders.UPDATE
Arguments
List sales order templates
Get all sales order pdf templates.
OAuth Scope : ZohoBooks.salesorders.READ
Update sales order template
Update the pdf template associated with the sales order.
OAuth Scope : ZohoBooks.salesorders.UPDATE
Add attachment to a sales order
Attach a file to a sales order.
OAuth Scope : ZohoBooks.salesorders.CREATE
Query Parameters
Update attachment preference
Set whether you want to send the attached file while emailing the sales order.
OAuth Scope : ZohoBooks.salesorders.UPDATE
Query Parameters
Get a sales order attachment
Returns the file attached to the sales order.
OAuth Scope : ZohoBooks.salesorders.READ
Query Parameters
Delete an attachment
Delete the file attached to the sales order.
OAuth Scope : ZohoBooks.salesorders.DELETE
Add comment
Add a comment for a sales order.
OAuth Scope : ZohoBooks.salesorders.CREATE
Arguments
List sales order comments & history
Get the complete history and comments of sales order.
OAuth Scope : ZohoBooks.salesorders.READ
Update comment
Update existing comment of a sales order.
OAuth Scope : ZohoBooks.salesorders.UPDATE
Arguments
Delete a comment
Delete a sales order comment.
OAuth Scope : ZohoBooks.salesorders.DELETE