Zoho Inventory purchaseorders API
PurchaseOrders Module
Zoho Inventory purchaseorders API is one of 37 APIs that Zoho Inventory publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include purchaseorders. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.
This API exposes 13 operations across 10 paths, and defines 145 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against a single base URL, https://www.zohoapis.com/inventory/v1.
13 operations
10 paths
145 schemas
1 DELETE2 GET9 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zoho Inventory purchaseorders API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (Zoho_Auth) using the implicit flow, exposing 4 scopes.
Paths & Operations 13
Across 10 paths, the API surfaces 13 operations — 1 DELETE, 2 GET, 9 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
purchaseorders 13
PurchaseOrders Module
POST
/purchaseorders
Create a Purchase Order
GET
/purchaseorders
List all Purchase Orders
GET
/purchaseorders/{purchaseorder_id}
Retrieve a Purchase Order
PUT
/purchaseorders/{purchaseorder_id}
Update a Purchase Order
DELETE
/purchaseorders/{purchaseorder_id}
Delete a Purchase Order
POST
/purchaseorders/{purchaseorder_id}/status/issued
Mark as Issued
POST
/purchaseorders/{purchaseorder_id}/status/cancelled
Mark as Cancelled
POST
/purchaseorders/{purchaseorder_id}/submit
Submit a purchase order for approval
POST
/purchaseorders/{purchaseorder_id}/approve
Approve a purchase order
POST
/purchaseorders/{purchaseorder_id}/reject
Reject a purchase order
POST
/purchaseorders/{purchaseorder_id}/approve/final
Final-approve a purchase order
POST
/purchaseorders/submit
Bulk submit purchase orders for approval
POST
/purchaseorders/approve
Bulk approve purchase orders
Schemas 145
The contract defines 145 schemas that model the data the API accepts and returns. The most detailed are purchase_order-response (62 properties), create-a-purchase-order-request (27 properties), update-a-purchase-order-request (23 properties), retrieve-a-purchase-order-response (3 properties). Each schema is shown below with its type and property counts.
item_custom_fields
array
List of custom fields associated with the line item
transaction_id
string
Unique ID generated by the server for the transaction. This is used as an identifier.
terms
string
Terms for the Purchase Order.
expected_delivery_date
string
Expected date of delivery for the items ordered.
contact_persons_associated
array
Contact Persons associated with the transaction.
bills
array
Bills raised for purchase order. Each bill contains these fields: billid , billnumber , status , date , duedate , total , balance .
reverse_charge_tax_amount
number
Tax amount for the reverse charge.
taxes
array
Number of taxes applied on the Purchase Order. Each tax contains: taxname and taxamount .
date_formatted
string
Indicates the date format.
vendor_name
string
Name of the vendor.
zip
string
Zip code of the customer's billing address.
item_id
string
Unique ID generated by the server for the item. This is used as an identifier.
sub_total
number
Sub total of the Purchase Order.
comments
array
History related to the purchase order.
approval-action-response
object
2 properties
account_id
string
Account ID of the item.
is_backorder
boolean
This indicates whether it is a Back order or not.
retrieve-a-purchase-order-response
object
3 properties
date
string
Date of Purchase Order
documents
array
Purchase order can have files attached to them. Each attachment has the following attributes cansendinmail , filename , filetype , filesizeformatted , attachme…
receive_id
string
Unique ID generated by the server for the Purchase Receive. This is used as identifier.
purchase_rate
number
Purchase Price of the line item.
item_total
number
Total of line item.
custom_fields
array
Custom fields for a purchaseorder.
value
string
Value of the Custom Field
reverse_charge_tax_id
string
Enter reverse charge tax ID
currency_symbol
string
The symbol for the selected currency.
is_drop_shipment
boolean
Default is FALSE , in case of drop shipment value must be TRUE .
delivery_customer_id
string
Customer ID for delivery address
contact_person_email
string
Email ID of the Contact Person.
expected_delivery_date_formatted
string
Indicates the date format.
reverse_charge_tax_percentage
number
Enter reverse charge tax percentage
status_formatted
string
Indicates the Format of the status.
mark-as-issued-response
object
2 properties
document_id
string
Unique ID generated by the server for the document. This is used as an identifier.
update-a-purchase-order-response
object
3 properties
country
string
Name of the country of the customer's billing address.
status
string
Status of Purchase Order.
create-a-purchase-order-response
object
3 properties
label
string
Label of the Custom Field
phone
string
Phone Number of the Contact Person.
transaction_type
string
Indicates the type of the transaction.
hsn_or_sac
string
HSN or SAC Code for the Item
attention
string
Name of the person, whose attention is required.
quantity
number
Quantity of the line item.
billing_address
array
Customer's billing address. It contains - address , city , state , zip , country and fax .
quantity_received
number
Quantity invoiced of the line item.
tax_percentage
number
Percentage of the tax.
name
string
Name of the line item.
bill_id
string
Unique ID generated by the server. This is used as identifier.
bill_number
string
Bill number of Purchase Order.
list-all-purchase-orders-response
object
3 properties
can_send_in_mail
boolean
Checks whether it can be sent in a mail or not.
gst_treatment
string
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are businessgst , businessnone , overseas , consumer .
source_of_supply
string
Place from where the goods/services are supplied. (If not given, place of contact given for the contact will be taken)
communication_preference
object
Preferred modes of communication for the contact person at transaction level.
2 properties
time
string
Indicates the time when the action was performed
line_item_id
string
Unique ID generated by the server for each line item. This is used as an identifier.
currency_id
string
Unique ID generated by the server for the currency. This is used as an identifier.
tax_total
number
Tax total of the Purchase Order.
receive_number
string
Number of the Purchase Receive.
reference_number
string
Reference number of purchase order.
location_id
string
Location ID
comment_id
string
Unique ID generated by the server for the comment(history). This is used as an identifier.
is_pre_gst
boolean
Applicable for transactions that fall before july 1, 2017
operation_type
string
Type of operation performed
description
string
Description of the line item.
mobile
string
Mobile Number of the Contact Person.
salesorder_item_id
string
Unique ID generated by the server for each line item in a sales order. This is used for creating backorder or dropshipment
purchase_order-response
object
62 properties
line_items
array
List of line items in a purchase order
ship_via_id
string
Unique ID generated by the server. This is used as identifier.
date_description
string
Indicates the time duration since the action was performed
notes
string
Notes for the Purchase Order.
currency_code
string
Currency code.
attachment_name
string
Name of attached file with Purchase Order.
billed_status
integer
Indiacates the Status of the bill.
last_modified_time
string
Time at which the Purchase Order details were last modified.
reject-request
object
1 property
address
string
Name of the street of the customer's billing address.
is_inclusive_tax
boolean
This indicates whether the tax is inclusive or not.
commented_by
string
Indicates the User who performed the action on the purchase oder
file_size
integer
this indicates the size of the attached file.
file_size_formatted
string
This indicates the size of the formatted file.
due_date
string
Due date of the Bill.
contact_person_name
string
Name of the Contact Person
tax_treatment
string
VAT treatment for the purchase order. Choose whether the vendor falls under: homecountrymexico , borderregionmexico , nonmexico supported only for MX .
image_id
number
Unique ID generated by the server for the item image. This is used an identifier.
destination_of_supply
string
Place where the goods/services are supplied to. (If not given, organisation's home state will be taken)
comment_type
string
Indicates the type of the action
exchange_rate
number
Exchange rate of the currency, with respect to the base currency.
fax
string
Fax number of the customer's billing address.
mark-as-cancelled-response
object
2 properties
last_name
string
Last Name of the Contact Person.
reverse_charge_tax_name
string
Enter reverse charge tax name
unit
string
Unit of line item.
image_type
string
The type (file format) of the image.
created_time
string
Time at which the Purchase Order was created.
sub_total_formatted
string
Format of the sub total.
item_order
integer
The order of the line items, starts from 0 by default.
template_name
string
Name of the template used for the Purchase Order.
is_whatsapp_enabled
boolean
Used to check if WhatsApp communication preference is enabled for the contact person at transaction level.
delivery_date_formatted
string
Indicates the delivery date format.
purchaseorder_number
string
Purchase Order number.
file_type
string
This indicates the type of the file.
tax_exemption_code
string
Code of the Tax Exemption
tax_exemption_id
string
ID of the Tax Exemption
delivery_address
array
Customer's delivery address. It contains - address , city , state , zip , country and fax .
attachment_order
integer
This indicates the chronological number of the attachment.
delivery_date
string
Date of delivery of the product.
is_reverse_charge_applied
boolean
Applicable for transactions where you pay reverse charge
update-a-purchase-order-request
object
23 properties
3 required
first_name
string
First Name of the Contact Person.
file_name
string
This indicates the name of the file.
tax_id
string
Unique ID generated by the server for the tax. This is used as an identifier.
contact_persons_associated_payload
array
Contact Persons associated with the transaction.
delete-a-purchase-order-response
object
2 properties
location_name
string
Name of the location
template_id
string
Unique ID generated by the server for the Template. This is used as an identifier.
template_type
string
Type of Template used to create Purchase Order.
balance
number
Balance amount for the Bill.
city
string
Name of the city of the customer's billing address.
pricebook_id
string
Unique ID generated by the server for the Pricebook. This is used as an identifier.
is_email_enabled
boolean
Used to check if Email communication preference is enabled for the contact person at transaction level.
price_precision
integer
The precision level for the price's decimal point in a Purchase Order.
purchaseorder_id
string
Unique ID generated by the server for the Purchase Order.
create-a-purchase-order-request
object
27 properties
3 required
delivery_org_address_id
string
Unique ID generated by the server. This is used as identifier.
customfield_id
string
Unique ID of the custom field.
total
number
Total amount of the Purchase Order.
is_emailed
boolean
Checks whether the purchase order has been emailed or not.
tds_tax_id
string
Unique identifier of the tds tax
bcy_rate
number
Item rate in the organization's base currency.
salesorder_id
string
Sales Order ID, in case of Drop Shipment.
image_name
string
Name of the image of the line item.
purchasereceives
array
Purchase receives for purchase order. Each Recieve contains- receiveid , receivenumber , date and note .
tax_amount
number
Amount of the tax.
tax_type
string
Denotes the type of the tax. This can either be a single tax or a tax group.
state
string
Name of the state of the customer's billing address.
gst_no
string
15 digit GST identification number of the vendor.
delivery_customer_name
string
Customer's name at the delivery address.
contact_person_id
string
Unique ID of the Contact Person
tax_name
string
Name of the tax applied on the line item.
vendor_id
string
Unique ID generated by the server for the vendor.
ship_via
string
Shipping method for the Purchase Order.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zoho Inventory 12
Other APIs Zoho Inventory publishes across the network.
Zoho Inventory batches API
Zoho Inventory bills API
Zoho Inventory compositeitems API
Zoho Inventory contact-persons API
Zoho Inventory contacts API
Zoho Inventory credit-notes API
Zoho Inventory currency API
Zoho Inventory customer-payments API
Zoho Inventory delivery-challans API
Zoho Inventory inventoryadjustments API
Zoho Inventory invoices API
Zoho Inventory itemgroups API
#purchaseorders