Purchase Order
A purchase order is an official document that a buyer issues to a seller, indicating relevant information about what they want to buy, the quantity, the price agreed for that particular product or service.
Attribute
uk
. If the vendor 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
). business_gst
, business_none
, overseas
, consumer
.vat_registered
,vat_not_registered
,gcc_vat_not_registered
,gcc_vat_registered
,non_gcc
.dz_vat_registered
and dz_vat_not_registered
are 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).place of contact
given for the contact will be taken)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
.goods
, digital_service
and service
.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 KSA are
ksa_reimbursed_expense
.Create a purchase order
Create a purchase order for your vendor.
OAuth Scope : ZohoBooks.purchaseorders.CREATE
Arguments
business_gst
, business_none
, overseas
, consumer
.vat_registered
,vat_not_registered
,gcc_vat_not_registered
,gcc_vat_registered
,non_gcc
.dz_vat_registered
and dz_vat_not_registered
are 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).place of contact
given for the contact will be taken)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 vendor 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
).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 KSA are
ksa_reimbursed_expense
.Query Parameters
gif
, png
, jpeg
, jpg
, bmp
, pdf
, xls
, xlsx
, doc
and docx
.Update a purchase 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 purchase 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 purchase 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 purchase orders, a new purchase order will be created if the necessary payload details are available
OAuth Scope : ZohoBooks.purchaseorders.UPDATE
Arguments
business_gst
, business_none
, overseas
, consumer
.vat_registered
,vat_not_registered
,gcc_vat_not_registered
,gcc_vat_registered
,non_gcc
.dz_vat_registered
and dz_vat_not_registered
are 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).place of contact
given for the contact will be taken)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 vendor 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
).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 KSA are
ksa_reimbursed_expense
.List purchase orders
List all purchase orders.
OAuth Scope : ZohoBooks.purchaseorders.READ
Query Parameters
purchaseorder_number.startswith
and purchaseorder_number.contains
reference_number.startswith
and reference_number.contains
draft
, open
, billed
and cancelled
item_description.startswith
and item_description.contains
vendor_name.startswith
and vendor_name.contains
total.start
, total.end
, total.less_than
, total.less_equals
, total.greater_than
and total.greater_equals
Status.All
, Status.Draft
, Status.Open
, Status.Billed
and Status.Cancelled
.vendor_name
, purchaseorder_number
, date
, delivery_date
, total
and created_time
.custom_field_startswith
, custom_field_contains
Update a purchase order
Update an existing purchase order.
OAuth Scope : ZohoBooks.purchaseorders.UPDATE
Arguments
business_gst
, business_none
, overseas
, consumer
.vat_registered
,vat_not_registered
,gcc_vat_not_registered
,gcc_vat_registered
,non_gcc
.dz_vat_registered
and dz_vat_not_registered
are 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).place of contact
given for the contact will be taken)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 vendor 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
).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 KSA are
ksa_reimbursed_expense
.Query Parameters
gif
, png
, jpeg
, jpg
, bmp
, pdf
, xls
, xlsx
, doc
and docx
.Get a purchase order
Get the details of a purchase order.
OAuth Scope : ZohoBooks.purchaseorders.READ
Query Parameters
json
, pdf
and html
.Delete purchase order
Delete an existing purchase order.
OAuth Scope : ZohoBooks.purchaseorders.DELETE
Update custom field in existing purchaseorders
Update the value of the custom field in existing purchaseorders.
OAuth Scope : ZohoBooks.purchaseorders.UPDATE
Arguments
Query Parameters
Mark a purchase order as open
Mark a draft purchase order as open.
OAuth Scope : ZohoBooks.purchaseorders.CREATE
Mark as billed
Mark a purchase order as billed.
OAuth Scope : ZohoBooks.purchaseorders.CREATE
Cancel a purchase order
Mark a purchase order as cancelled.
OAuth Scope : ZohoBooks.purchaseorders.CREATE
Submit a purchase order for approval
Submit a purchase order for approval.
OAuth Scope : ZohoBooks.purchaseorders.CREATE
Approve a purchase order
Approve a purchase order.
OAuth Scope : ZohoBooks.purchaseorders.CREATE
Email a purchase order
Email a purchase order to the vendor. Input json string is not mandatory. If input json string is empty, mail will be send with default mail content.
OAuth Scope : ZohoBooks.purchaseorders.CREATE
Arguments
Query Parameters
Get purchase order email content
Get the email content of a purchase order.
OAuth Scope : ZohoBooks.purchaseorders.READ
Query Parameters
Update billing address
Updates the billing address for this purchase order alone.
OAuth Scope : ZohoBooks.purchaseorders.UPDATE
Arguments
List purchase order templates
Get all purchase order pdf templates.
OAuth Scope : ZohoBooks.purchaseorders.READ
Update purchase order template
Update the pdf template associated with the purchase order.
OAuth Scope : ZohoBooks.purchaseorders.UPDATE
Add attachment to a purchase order
Attach a file to a purchase order.
OAuth Scope : ZohoBooks.purchaseorders.CREATE
Query Parameters
gif
, png
, jpeg
, jpg
, bmp
, pdf
, xls
, xlsx
, doc
and docx
.Update attachment preference
Set whether you want to send the attached file while emailing the purchase order.
OAuth Scope : ZohoBooks.purchaseorders.UPDATE
Query Parameters
Get a purchase order attachment
Returns the file attached to the purchase order.
OAuth Scope : ZohoBooks.purchaseorders.READ
Query Parameters
Delete an attachment
Delete the file attached to the purchase order.
OAuth Scope : ZohoBooks.purchaseorders.DELETE
Add comment
Add a comment for a purchase order.
OAuth Scope : ZohoBooks.purchaseorders.CREATE
Arguments
List purchase order comments & history
Get the complete history and comments of purchase order.
OAuth Scope : ZohoBooks.purchaseorders.READ
Update comment
Update an existing comment of a purchase order.
OAuth Scope : ZohoBooks.purchaseorders.UPDATE
Arguments
Delete a comment
Delete a purchase order comment.
OAuth Scope : ZohoBooks.purchaseorders.DELETE