PurchaseOrders
Retrieves list of all purchase orders.
Table Specific Information
Select
The add-in uses the Zoho Books API to process WHERE clause conditions built with the following columns and operators:
- Date supports the '=' comparison.
- LastModifiedTime supports the '=' comparison.
- PurchaseorderNumber supports the '=' comparison.
- ReferenceNumber supports the '=' comparison.
- Status supports the '=' comparison.
- Total supports the '=,<,<=,>,>=' comparisons.
- VendorId supports the '=' comparison.
- VendorName supports the '=' comparison.
- PurchaseOrderFilter supports the '=' comparison.
- ItemId supports the '=' comparison.
- ItemDescription supports the '=' comparison.
The rest of the filter is executed client-side in the add-in.
For example:
SELECT * FROM PurchaseOrders WHERE VendorId = 1894553000000077963 SELECT * FROM PurchaseOrders WHERE Total < 300 SELECT * FROM PurchaseOrders WHERE CONTAINS (PurchaseorderNumber, 'PO-')
Columns
Name | Type | References | SupportedOperators | Description |
PurchaseorderId [KEY] | String | Id of a purchase order. | ||
BilledStatus | String | Billed status of a purchase order. | ||
ClientViewedTime | Datetime | Last time when the client has viewed purchase order. | ||
ColorCode | String | Color code of this purchase order. | ||
CompanyName | String | Name of the company. | ||
CreatedTime | Datetime | Time at which the purchase order was created. | ||
CurrencyCode | String | Currency code of the customer's currency. | ||
CurrencyId | String |
Currencies.CurrencyId | Currency Id of the customer's currency. | |
CurrentSubStatus | String | Current sub status of a purchase order. | ||
CurrentSubStatusId | String | Current sub status Id of a purchase order. | ||
Date | Date | The date the purchase order is created. | ||
DeliveryDate | Date | Delivery date of the order. | ||
HasAttachment | Boolean | Check if the purchase order has attachment. | ||
IsDropShipment | Boolean | Check if it has drop shipment. | ||
IsViewedByClient | Boolean | Check if the purchase order is viewed by client. | ||
LastModifiedTime | Datetime | Last modified time of a purchase order. | ||
OrderStatus | String | Status of purchase order. | ||
PricePrecision | String | The precision for the price. | ||
PurchaseorderNumber | String | Number of the purchase order. | ||
QuantityYetToReceive | Decimal | Number of quantity yet to receive from purchase order. | ||
ReferenceNumber | String | Reference number of a purchase order. | ||
Status | String | Status of a purchase order.
The allowed values are draft, open, billed, cancelled. | ||
Total | Decimal | =,<,<=,>,>= | Total of purchase orders. Search by purchase order total. | |
VendorId | String | Id of the vendor the purchase orders has been made. Search by vendor id. | ||
VendorName | String | Name of the vendor the purchase orders has been made. Search by vendor name. |
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 | |
PurchaseOrderFilter | String | Filter purchase order by any status.
The allowed values are Status.All, Status.Draft, Status.Open, Status.Billed, Status.Cancelled. | |
ItemId | String | Id of an item. | |
ItemDescription | String | Description of an item. |