The quote object represents a saved or submitted quote. Quote objects are injected as parameters for workflow, custom action, and output rules.
All properties of a quote are read-only.
Properties
| Name | Type | Description |
|---|---|---|
| id | number | The numeric identifier for the quote. This is the same id which appears in the URL when accessing it. |
| idWorkflow | number | The id of the workflow this quote belongs to. If the quote has not been submitted yet, this value is 0. |
| state | text | The name of the state the workflow is in. If the quote has not been submitted yet, this value is an empty string. |
| createdBy | number | The id of the user that created this quote. |
| modifiedBy | number | The id of the user which last modified this quote. |
| ownedBy | number | The id of the user which owns the quote. (for the name of the owner, see the owner property) |
| idCustomer | number | The id of the customer that was selected for the quote. If the quote has not been associated with a customer, this value is 0. (for the name of the customer see the customer property) |
| idContact | number | The id of the contact that was selected for the quote. If the quote has not been associated with a contact, this value is 0. (for the name of the contact see the contact property) |
| hasError | boolean | True if the quote has a validation error, such as a discount percentage that is too high or an invalid quantity. Quotes with these errors cannot be submitted until they have been corrected. |
| name | text | |
| description | text | |
| currency | text | Expressed as the ISO currency code. |
| discountPercentage | number | The entered discount percentage for the entire quote. |
| shipping | number | The entered shipping price. |
| createdDate | Date | |
| modifiedDate | Date | |
| owner | text | The name of the owner of the quote. |
| customer | text | The name of the customer for the quote. |
| contact | text | The full name of the contact for the quote. |
| products | QuoteProduct[] | An array of QuoteProduct objects which have been added to the quote. |
| files | QuoteFile[] | An array of QuoteFile objects which have been added to the quote. Note that these are only the files which have been attached directly to the quote, as opposed to one of the quote products, in which case the file would be found in that quote product object's files array. |
| pendingApprovals | PendingApproval | An array of PendingApproval objects. If this quote is in an Approval State, this array will be filled in. |
| subtotal | number | The full subtotal price for the quote. |
| totalPrice | number | The full price for the quote (includes shipping and discount). |
| totalCost | number | The full cost, summed up from the products in the quote. |