Add New Estimate

Creates a new estimate in the system.

Request Body Fields:

Required fields are marked with an asterisk (*)

Estimate Object:

client_id* (integer): ID of the client being estimated

store_id* (integer): ID of the store/location

currency_code* (string): 3-letter currency code (e.g., USD, EUR)

date* (string): Estimate date (YYYY-MM-DD)

expiry_date (string): Expiry date (YYYY-MM-DD)

draft (integer): Draft status (0: active, 1: draft)

notes (string): Estimate notes

discount (number): Estimate-level discount amount

discount_type (integer): Discount type (1: percentage, 2: fixed amount)

InvoiceItem Array (at least one item required):

product_id (integer): ID of the product (optional if description is provided)

quantity* (number): Quantity of items

unit_price* (number): Price per unit

description* (string): Item description (required if product_id not provided)

discount (number): Item-level discount

discount_type (integer): Discount type (1: percentage, 2: fixed amount)

Response:

{
  "result": "success",
  "code": 201,
  "data": {
    "Estimate": {
      "id": 235,
      "number": "EST-2023-003",
      // Other estimate fields...
    }
  },
  "message": "Estimate created successfully"
}

curl --location -g --request POST '{{subdomain}}/api2/api2/estimates.json' \ --header 'Content-Type: text/plain' \ --data-raw '{ "Estimate": { "client_id": 15, "store_id": 1, "currency_code": "USD", "date": "2023-03-23", "expiry_date": "2023-04-22", "draft": 0, "notes": "Proposal for new services", "discount": 0, "discount_type": 1, "InvoiceItem": [ { "product_id": 1, "quantity": 1, "unit_price": 100, "description": "Premium Widget", "discount": 0, "discount_type": 1 }, { "product_id": 2, "quantity": 2, "unit_price": 50, "description": "Standard Widget", "discount": 0, "discount_type": 1 } ] } }'

{ "result": "success", "code": 201, "data": { "Estimate": { "id": 235, "number": "EST-2023-003", "client_id": 15, "store_id": 1, "date": "2023-03-23", "currency_code": "USD", "total": 120, "status": 1, "draft": 0, "created": "2023-03-23 15:30:42", "modified": "2023-03-23 15:30:42" } }, "message": "Estimate created successfully" }

Request

Responses