Estimate
An estimate record exposes an estimate to REST web services. This record is not a subrecord. This record has one subrecord: record ID item.
The REST API Browser includes information about the field names and field types of the estimate record. It also includes information about the HTTP methods, request parameters, and operations available to this record. For details, see the REST API Browser’s estimate reference page.
For information about using the REST API Browser, see The REST API Browser.
Record ID
The record ID for the estimate REST record is estimate.
Prerequisites
You must enable estimates before you can use this record through REST web services. To do so, go to Setup > Company > Enable Features. On the Transactions subtab under Basic Features, check the Estimates box, and then click Save.
Actions
The estimates record has the following actions through REST web services:
-
New
-
Make Copy
-
Email
-
Show Activity
-
Go To Register
-
GL Impact
Field Exposure
Fields exposed through SuiteScript should all be exposed through REST web services. Some fields may be hidden on the UI.
Taxation
REST web services do not support legacy tax features. To work with taxation through REST web services, you must have the SuiteTax feature enabled. For more information about using SuiteTax, see SuiteTax.
The following fields on the estimate REST record are related to taxation:
-
tax code
-
tax rate
-
shipping tax code
-
shipping tax rate
Code Samples
These samples show common use cases for estimates. The example ID is 6.
Creating an Estimate Using a POST Request
POST {{REST_SERVICES}}/record/v1/estimate
{ "altSalesTotal": 0.0, "canHaveStackable": false, "currency": { "id": "1", "refName": "USA" }, "discountItem": { "id": "-6", "refName": "Partner Discount" }, "discountRate": -5.0, "discountTotal": -5.0, "dueDate": "2023-08-09", "entity": { "id": "110", "refName": "Anonymous Customer" }, "entityStatus": { "id": "10", "refName": "Proposal" }, "exchangeRate": 1.0, "expectedCloseDate": "2023-07-10", "forecastType": { "id": "2", "refName": "Most Likely" }, "item": { "items": [{ "line": 1, "item": { "id": 98}, "rate": 39.95, "quantity": 1 }] }, "subsidiary": { "id": "1", "refName": "Parent Company" }, "subtotal": 39.95, "toBeEmailed": false, "toBeFaxed": false, "toBePrinted": false, "total": 34.95, "tranDate": "2023-07-10", "tranId": "1", "visibleToCustomer": true
}
Retrieving an Estimate Using a GET Request
GET {{REST_SERVICES}}/record/v1/estimate/6
Updating an Estimate Using a PATCH Request
PATCH {{REST_SERVICES}}/record/v1/estimate/6
{ "altSalesTotal": 0.0, "canHaveStackable": false, "currency": { "id": "1", "refName": "USA" }, "discountItem": { "id": "-6", "refName": "Partner Discount" }, "discountRate": -5.0, "discountTotal": -5.0, "dueDate": "2023-08-09", "entity": { "id": "110", "refName": "Anonymous Customer" }, "entityStatus": { "id": "10", "refName": "Proposal" }, "exchangeRate": 1.0, "expectedCloseDate": "2023-07-10", "forecastType": { "id": "2", "refName": "Most Likely" }, "item": { "items": [{ "line": 1, "item": { "id": 98}, "rate": 39.95, "quantity": 1 }, { "line": 2, "item": { "id": 5}, "rate": 10, "quantity": 2 }] }, "subsidiary": { "id": "1", "refName": "Parent Company" }, "subtotal": 39.95, "toBeEmailed": false, "toBeFaxed": false, "toBePrinted": false, "total": 34.95, "tranDate": "2023-07-10", "tranId": "1", "visibleToCustomer": true
}
Deleting an Estimate Using a DELETE Request
DELETE {{REST_SERVICES}}/record/v1/estimate/6