SalesOrders
Retrieves list of all sales 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:
- SalesorderId supports the '=' comparison.
- CustomerId supports the '=' comparison.
- CustomerName supports the '=' comparison.
- Date supports the '=,<,>' comparisons.
- ReferenceNumber supports the '=' comparison.
- SalesorderNumber supports the '=' comparison.
- ShipmentDate supports the '=,<,>' comparisons.
- Status supports the '=' comparison.
- Total supports the '=,<,<=,>,>=' comparisons.
- ItemId supports the '=' comparison.
- ItemName supports the '=' comparison.
- ItemDescription supports the '=' comparison.
- SalesOrderFilter supports the '=' comparison.
The rest of the filter is executed client-side in the add-in.
For example:
SELECT * FROM SalesOrders WHERE CustomerId = '1894553000000077328' AND CustomerName = 'Zylak' AND SalesOrderFilter = 'Status.All'
SELECT * FROM SalesOrders WHERE ShipmentDate > '2017-08-01'
SELECT * FROM SalesOrders WHERE CONTAINS (SalesorderNumber, 'SO-00')
Columns
| Name | Type | References | SupportedOperators | Description |
| SalesorderId [KEY] | String | Id of a sales order. | ||
| SalespersonName | String | Name of the sales order. | ||
| BcyTotal | Decimal | Total Base Currency. | ||
| ColorCode | String | Color code of Sales order. | ||
| CompanyName | String | Name of the company. | ||
| CreatedTime | Datetime | Time at which the sales 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 sales order. | ||
| CurrentSubStatusId | String | Current sub status Id of a sales order. | ||
| CustomerId | String |
Contacts.ContactId | Id of the customer or vendor. Search Sales Order based on customer_id. | |
| CustomerName | String | Name of the customer or vendor. . | ||
| Date | Date | =,<,> | Date of an sales order. | |
| DueByDays | String | Total number of day sales order is due by. | ||
| DueInDays | String | Total number of day the sales order is due in. | ||
| HasAttachment | Boolean | Check if the sales order has attachment. | ||
| InvoicedStatus | String | Status of invoiced sales orders. | ||
| IsEmailed | Boolean | Check if the sales order is emailed. | ||
| LastModifiedTime | Datetime | The time of last modification of the sales order. | ||
| OrderStatus | String | Status of order. | ||
| ReferenceNumber | String | Reference number of sales order. | ||
| SalesorderNumber | String | Number of a sales order. | ||
| ShipmentDate | Date | =,<,> | Date of shipment. | |
| ShipmentDays | String | Total number of days for shipment. | ||
| Status | String | Status of sales order.
The allowed values are draft, open, invoiced, partially_invoiced, void, overdue. | ||
| Total | Decimal | =,<,<=,>,>= | Total of sales orders. | |
| TotalInvoicedAmount | Decimal | Total amount which is invoiced. |
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 | |
| ItemId | String | Id of an item. | |
| ItemName | String | Name of an item. | |
| ItemDescription | String | Description of an item. | |
| SalesOrderFilter | String | Filter sales order by status. |