1. SuiteCloud Platform
  2. SuiteTalk Web Services
  3. SuiteTalk REST Web Services Records Guide
  4. REST Web Services Supported Records
  5. Estimate

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

Note:

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

Usage Notes

To use the Choose Team and Update Customer fields in the Sales Team subtab, the Team Selling feature must be enabled. To enable Team Selling, go to Setup > Company > Enable Features > CRM. Check the Team Selling box, and then click Save.

The Multi-Partner Management Feature must also be enabled to use the Update Customer field in the Relationships subtab. An administrator can enable the Multi-Partner Management feature at Setup > Company > Setup Tasks > Enable Features. Click the CRM subtab, and then under Partners, check the Multi-Partner Management box. Click Save.

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

Setting the Sales Order's Sales Team Members to Match Sales Group 164

              "salesGroup": {
    "id": 164 }

Update the Customer's Partner Team to Match the Transaction Partners

              "syncPartnerTeams": true

Update the Customer's Sales Team to Match the Transaction Sales Team

              "syncSalesTeams": true

Related Topics

General Notices