Fields: Quotes
See the associated Accounting Quotes resource section for more information on how to use this resource and supported operations.
Additional references
| Type | Value | Additional information |
|---|---|---|
| Permissions resource | accounting/quotes | Permissions |
| Hooks filename | accounting.quotes.groovy | Pre- and Post-Processing Hooks |
| Tenant-supported | No | Tenants |
| Distinct query-supported | No | Distinct |
API version 3
Quotes can be used to determine how much it will cost to use a resource or service. Provided the cost-only option is not specified, this step will additionally verify that the submitter has sufficient funds and meets all the allocation policy requirements for the usage, and can be used at the submission of the usage request as an early filter to prevent the usage from getting blocked when it tries to obtain a lien to start later. If a guaranteed quote is requested, a quote id is returned and can be used in the subsequent charge to guarantee the rates that were used to form the original quote. A guaranteed quote has the side effect of creating a quote record and a permanent usage record. A quote id will be returned which can be used with the lien and charge to claim the quoted charge rates. A cost-only quote can be used to determine how much would be charged for usage without verifying sufficient funds or checking to see if the charge could succeed.
| Field Name | Type | Description |
|---|---|---|
| id | Long |
The unique quote identifier |
| amount | BigDecimal |
The total amount of the quote |
| chargeRates | Set<QuoteChargeRate> |
The applied charges that make up this quote. |
| creationTime | Date |
The date this quote was created |
| deleted | Boolean |
A boolean indicating whether this quote is deleted or not |
| description | String |
The quote description |
| duration | Long |
The expected duration of the quoted usage in seconds |
| endTime | Date |
The time the quote becomes inactive |
| instance | String |
The quote instance name. (i.e. job id) |
| modificationTime | Date |
The date this quote was last modified |
| pinned | Boolean |
Boolean indicating whether the quote is pinned or not |
| requestId | Long |
The id of the last modifying request |
| startTime | Date |
The time the quote becomes active |
| transactionId | Long |
The id of the last modifying transaction |
| usageRecord | Long |
The usage record id associated with this quote |
Saved charge rates to be used when the quote is referenced
| Field Name | Type | Description |
|---|---|---|
| id | Long | |
| amount | String |
The charge rate amount |
| name | String |
The child charge rate name |
| quote | String |
The parent quote id |
| value | String |
The child charge rate value |
API version 2
Quotes can be used to determine how much it will cost to use a resource or service. Provided the cost-only option is not specified, this step will additionally verify that the submitter has sufficient funds and meets all the allocation policy requirements for the usage, and can be used at the submission of the usage request as an early filter to prevent the usage from getting blocked when it tries to obtain a lien to start later. If a guaranteed quote is requested, a quote id is returned and can be used in the subsequent charge to guarantee the rates that were used to form the original quote. A guaranteed quote has the side effect of creating a quote record and a permanent usage record. A quote id will be returned which can be used with the lien and charge to claim the quoted charge rates. A cost-only quote can be used to determine how much would be charged for usage without verifying sufficient funds or checking to see if the charge could succeed.
| Field Name | Type | Description |
|---|---|---|
| id | Long |
The unique quote identifier |
| amount | BigDecimal |
The total amount of the quote |
| chargeRates | Set<QuoteChargeRate> |
The applied charges that make up this quote. |
| creationTime | Date |
The date this quote was created |
| deleted | Boolean |
A boolean indicating whether this quote is deleted or not |
| description | String |
The quote description |
| duration | Long |
The expected duration of the quoted usage in seconds |
| endTime | Date |
The time the quote becomes inactive |
| instance | String |
The quote instance name. (i.e. job id) |
| modificationTime | Date |
The date this quote was last modified |
| pinned | Boolean |
Boolean indicating whether the quote is pinned or not |
| requestId | Long |
The id of the last modifying request |
| startTime | Date |
The time the quote becomes active |
| transactionId | Long |
The id of the last modifying transaction |
| usageRecord | Long |
The usage record id associated with this quote |
Saved charge rates to be used when the quote is referenced
| Field Name | Type | Description |
|---|---|---|
| id | Long | |
| amount | String |
The charge rate amount |
| name | String |
The child charge rate name |
| quote | String |
The parent quote id |
| value | String |
The child charge rate value |
Related Topics