Update a estimate
PUT/api/estimates/{id}
Headers
| Field | Type | Description |
|---|---|---|
| authtoken | String | Authentication token, generated from admin area |
Parameters
| Field | Type | Description |
|---|---|---|
| clientid | String | Mandatory. Customer. |
| billing_street | String | Mandatory. Street Address |
| billing_city | String | optional Optional. City Name for billing |
| billing_state | String | optional Optional. Name of state for billing |
| billing_zip | Number | optional Optional. Zip code |
| billing_country | Number | optional Optional. Country code |
| include_shipping | boolean | optional Optional. set yes if you want add Shipping Address
|
| show_shipping_on_estimate | boolean | optional Optional. Shows shipping details in estimate. |
| shipping_street | String | optional Optional. Address of shipping |
| shipping_city | String | optional Optional. City name for shipping |
| shipping_state | String | optional Optional. Name of state for shipping |
| shipping_zip | Number | optional Optional. Zip code for shipping |
| shipping_country | Number | optional Optional. Country code |
| number | Number | Mandatory. Estimate Number |
| date | Date | Mandatory. Estimate Date |
| expirydate | Date | optional Optional. Expiry Date of Estimate |
| tags | String | optional Optional. TAGS comma separated |
| currency | Number | Mandatory. currency field |
| status | Number | Mandatory. Estimate Status(eg. Draft, Sent) |
| reference_no | String | optional Optional. Reference # |
| sale_agent | Number | optional Optional. Sale Agent name |
| discount_type | String | optional Optional. before_tax / after_tax discount type |
| adminnote | String | optional Optional. notes by admin |
| items | Array | optional Mandatory. Existing items with Id |
| removed_items | Array | optional Optional. Items to be removed |
| newitems | Array | optional Optional. New Items to be added |
| subtotal | Decimal | Mandatory. calculation based on item Qty, Rate and Tax |
| total | Decimal | Mandatory. calculation based on subtotal, Discount and Adjustment |
| clientnote | String | optional Optional. client notes |
| terms | String | optional Optional. Terms |
curl -X PUT "https://yoursite.com/api/estimates/123" \
-H "authtoken: YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "clientid": "...", "billing_street": "...", "number": "...", "date": "...", "currency": "...", "status": "...", "subtotal": "...", "total": "..." }'Success-Response:
HTTP/1.1 200 OK
{
"status": false,
"message": "Estimate Updated Successfully"
}Error-Response:
HTTP/1.1 404 Not Found
{
"status": false,
"message": "Estimate Update Fail"
}Error-Response:
HTTP/1.1 409 Conflict
{
"status": false,
"error": {
"number":"The Estimate number is already in use"
},
"message": "The Estimate number is already in use"
}