Estimates
Retrieves list of all estimates.
Table Specific Information
Select
The cmdlet uses the Zoho Books API to process WHERE clause conditions built with the following columns and operators:
- CustomerId supports the '=' comparison.
- CustomerName supports the '=' comparison.
- Date supports the '=,<,>' comparisons.
- EstimateNumber supports the '=' comparison.
- ExpiryDate supports the '=' comparison.
- ReferenceNumber supports the '=' comparison.
- Status supports the '=' comparison.
- Total supports the '=,<,<=,>,>=' comparisons.
- ItemId supports the '=' comparison.
- ItemName supports the '=' comparison.
- ItemDescription supports the '=' comparison.
The rest of the filter is executed client-side in the cmdlet.
For example:
SELECT * FROM Estimates WHERE Total >= 500 AND Total <= 600
SELECT * FROM Estimates WHERE Date <= '2019-02-26'
SELECT * FROM Estimates ORDER BY CustomerName
SELECT * FROM Estimates WHERE CONTAINS (EstimateNumber, '006')
Columns
| Name | Type | References | SupportedOperators | Description |
| EstimateId [KEY] | String | Id of an estimate. | ||
| AcceptedDate | Date | Accepted date of an estimate. | ||
| ClientViewedTime | Datetime | Time when client viewed the estimate. | ||
| ColorCode | String | Color code of estimates. | ||
| CompanyName | String | Name of the company. | ||
| CreatedTime | Datetime | Time at which the estimate was created. | ||
| CurrencyCode | String | Currency code of the customer's currency. | ||
| CurrencyId | String |
Currencies.CurrencyId | Currency Id of the customer's currency. | |
| CustomerId | String |
Contacts.ContactId | Id of the customer or vendor. Search estimates by customer id.. | |
| CustomerName | String | Name of the customer or vendor. Search estimates by customer name. | ||
| Date | Date | =,<,> | Date of an estimate. | |
| DeclinedDate | Date | Declined date of the estimate. | ||
| EstimateNumber | String | Number of the estimate. | ||
| ExpiryDate | Date | The date of expiration of the estimates. | ||
| HasAttachment | Boolean | Check if the estimate has attachment. | ||
| IsEmailed | Boolean | Check if the estimate is emailed. | ||
| ReferenceNumber | String | Reference number of the estimate. | ||
| Status | String | Status of the estimate.
The allowed values are draft, sent, invoiced, accepted, declined, expired. | ||
| Total | Decimal | =,<,<=,>,>= | Total of estimates. Search estimates by estimate total. |
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 the item. | |
| ItemName | String | Name of an item. | |
| ItemDescription | String | Description of an item. | |
| EstimateFilter | String | Filter estimates by status.
The allowed values are Status.All, Status.Sent, Status.Draft, Status.Invoiced, Status.Accepted, Status.Declined, Status.Expired. |