Estimates - Add New Estimates
POST yourdomain.com/api/estimates
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String |
Basic Access Authentication token. |
Parameter
| Field | Type | Description |
|---|---|---|
| clientid | Number |
Mandatory. Customer id |
| number | Number |
Mandatory. Estimates Number |
| date | Date |
Mandatory. Estimates Date |
| duedate (optional) | Date |
Optional. Expiry Date of Estimates |
| currency | Number |
Mandatory. currency field |
| newitems | Array |
Mandatory. 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 |
| billing_street | String |
Optional. Street Address |
| billing_city (optional) | String |
Optional. City Name for billing |
| billing_state (optional) | String |
Optional. Name of state for billing |
| billing_zip (optional) | Number |
Optional. Zip code |
| billing_country (optional) | Number |
Optional. Country code |
| shipping_street (optional) | String |
Optional. Address of shipping |
| shipping_city (optional) | String |
Optional. City name for shipping |
| shipping_state (optional) | String |
Optional. Name of state for shipping |
| shipping_zip (optional) | Number |
Optional. Zip code for shipping |
| shipping_country (optional) | Number |
Optional. Country code |
| tags (optional) | String |
Optional. TAGS comma separated |
| status (optional) | Number |
Optional. Status id (default status is Accepted) |
| Reference (optional) | String |
Optional. Reference name |
| sale_agent (optional) | Number |
Optional. Sale Agent name |
| adminnote (optional) | String |
Optional. notes by admin |
| clientnote (optional) | String |
Optional. client notes |
| terms (optional) | String |
Optional. Terms |
Success 200
| Field | Type | Description |
|---|---|---|
| status | Boolean |
Request status. |
| message | String |
Estimates Added Successfully |
Error 4xx
| Name | Type | Description |
|---|---|---|
| status | Boolean |
Request status. |
| message | String |
Estimates add fail |
| newitems[] | String |
The Items field is required |
| number | String |
The Estimates number is already in use |
| subtotal | String |
The Sub Total field is required |
| total | String |
The Total field is required |
HTTP/1.1 200 OK
{
"status": true,
"message": "Estimates Added Successfully"
} HTTP/1.1 404 Not Found
{
"status": false,
"error": {
"total": "The Total field is required"
},
"message": "<p>The Total field is required</p>\n"
}