PurchaseOrders
Stores purchase orders issued to vendors, including product details, terms, and order status. Restricted in free and standard accounts.
Table-Specific Information
The PurchaseOrders table is only accessible when connected to a ZohoCRM Enterprise Edition account. If using a different edition, this table may not be available.Select
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
Insert
The following example demonstrates a basic insert operation with line item details:
-- Insert a new purchase order with a subject and product line items
INSERT INTO PurchaseOrders (Subject, ProductDetails) VALUES (
-- This is the value for the Subject column
'Purchase Order',
-- This is the JSON string for ProductDetails
'[
{
"product": {
"Product_Code": "12342321",
"name": "Egg",
"id": "3276571000000184076"
},
"quantity": 1024,
"Discount": 0,
"total_after_discount": 1239.04,
"net_total": 1239.04,
"book": null,
"Tax": 0,
"list_price": 1.21,
"unit_price": 1.21,
"quantity_in_stock": -1024,
"total": 1239.04,
"id": "3276571000000184104",
"product_description": null,
"line_tax": []
}
]'
)
Required fields: Subject and ProductDetails are required. These provide the order summary and the line item information needed to create a purchase order.
Any field which is not read-only (ReadOnly = false in the table schema) can be inserted.
Delete
You must specify the Id column in the WHERE clause to delete a record. The following example demonstrates a delete operation:
-- Delete a purchase order by its unique ID
DELETE FROM PurchaseOrders WHERE Id = '3152079000000153079'
Update
You must specify the Id column in the WHERE clause to update a record. The following example demonstrates an update operation:
-- Update the description for a specific purchase order using its ID
UPDATE PurchaseOrders SET Description = 'Changed from the API.' WHERE Id = '3152079000000492001'
Required fields: Id is required. The update must target a specific record.
Any field which is not read-only (ReadOnly = false in the table schema) can be updated.
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
Unique identifier for the purchase order record. |
| RequisitionNumber | String | False |
Internal requisition number associated with the purchase order. |
| TrackingNumber | String | False |
Shipping or delivery tracking number for the purchase order. |
| PONumber | String | False |
Official purchase order number assigned to the order. |
| Subject | String | False |
Title or subject line of the purchase order. |
| VendorName_Id | String | False |
Identifier of the vendor supplying the products or services. |
| VendorName_Name | String | True |
Name of the vendor associated with the purchase order. |
| ContactName_Id | String | False |
Identifier of the contact person linked to the purchase order. |
| ContactName_Name | String | True |
Name of the contact associated with the purchase order. |
| PODate | Date | False |
Date when the purchase order was created or issued. |
| DueDate | Date | False |
Due date for receiving goods or making payment. |
| Carrier | String | False |
Shipping carrier responsible for delivery. |
| ExciseDuty | Decimal | False |
Amount of excise duty applied to the purchase order. |
| SalesCommission | Decimal | False |
Sales commission related to the purchase order, if applicable. |
| Status | String | False |
Current status of the purchase order, such as open, received, or closed. |
| PurchaseOrderOwner_Id | String | False |
Identifier of the user who owns the purchase order. |
| PurchaseOrderOwner_FirstName | String | True |
First name of the purchase order owner. |
| PurchaseOrderOwner_LastName | String | True |
Last name of the purchase order owner. |
| PurchaseOrderOwner_Email | String | True |
Email address of the purchase order owner. |
| PurchaseOrderOwner_Name | String | True |
Full name of the purchase order owner. |
| CreatedBy_Id | String | False |
Identifier of the user who created the purchase order. |
| CreatedBy_FirstName | String | True |
First name of the user who created the purchase order. |
| CreatedBy_LastName | String | True |
Last name of the user who created the purchase order. |
| CreatedBy_Email | String | True |
Email address of the user who created the purchase order. |
| CreatedBy_Name | String | True |
Full name of the user who created the purchase order. |
| ModifiedBy_Id | String | False |
Identifier of the user who last modified the purchase order. |
| ModifiedBy_FirstName | String | True |
First name of the user who last modified the purchase order. |
| ModifiedBy_LastName | String | True |
Last name of the user who last modified the purchase order. |
| ModifiedBy_Email | String | True |
Email address of the user who last modified the purchase order. |
| ModifiedBy_Name | String | True |
Full name of the user who last modified the purchase order. |
| CreatedTime | Datetime | False |
Timestamp indicating when the purchase order was created. |
| ModifiedTime | Datetime | False |
Timestamp indicating when the purchase order was last modified. |
| Tag | String | False |
Comma-separated list of tags associated with the purchase order. |
| BillingStreet | String | False |
Street address for billing purposes. |
| ShippingStreet | String | False |
Street address for shipping purposes. |
| BillingCity | String | False |
City listed in the billing address. |
| ShippingCity | String | False |
City listed in the shipping address. |
| BillingState | String | False |
State or region listed in the billing address. |
| ShippingState | String | False |
State or region listed in the shipping address. |
| BillingCode | String | False |
Postal or ZIP code for the billing address. |
| ShippingCode | String | False |
Postal or ZIP code for the shipping address. |
| BillingCountry | String | False |
Country listed in the billing address. |
| ShippingCountry | String | False |
Country listed in the shipping address. |
| ProductDetails | String | False |
Details of the products or services listed in the purchase order. |
| SubTotal | Decimal | True |
Subtotal amount before applying taxes, discounts, or adjustments. |
| Discount | Decimal | False |
Discount applied to the purchase order. |
| Tax | Decimal | True |
Total tax amount applied to the purchase order. |
| Adjustment | Decimal | False |
Manual adjustments applied to the purchase order total. |
| GrandTotal | Decimal | True |
Final total amount after taxes, discounts, and adjustments. |
| TermsandConditions | String | False |
Terms and conditions associated with the purchase order. |
| Description | String | False |
Additional notes or description related to the purchase order. |
| Locked | Bool | True |
Indicates whether the purchase order is locked from editing. |
| LastActivityTime | Datetime | False |
Timestamp of the most recent activity on the purchase order. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| DuplicateCheckFields | String |
Field or fields used to identify duplicate purchase orders during an upsert. Multiple fields are supported in the REST API, but only one is allowed in the BULK API. |
| Trigger | String |
Specifies whether to trigger automation or workflow rules when inserting the record. |
| CustomViewId | Long |
Identifier of the custom view used to filter this record. Applies only when the useCOQL parameter is set to false. |