Top

Estimates

Get estimate settings
GET /settings/estimates
Get the details of estimate settings.
Update estimate settings
PUT /settings/estimates
Update the settings that are configured for estimates.
Get estimate notes and terms
GET /settings/estimates/notesandterms
Get the details of estimate notes and terms.
Update estimate notes and terms
PUT /settings/estimates/notesandterms
Update the details of the estimate notes and terms.

Get estimate settings

GET  /settings/estimates

Get the details of estimate settings.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "estimate_settings": {
    "auto_generate": true,
    "prefix_string": "EST-",
    "start_at": 1,
    "next_number": "000005",
    "quantity_precision": 2,
    "discount_type": "item_level",
    "is_discount_before_tax": true,
    "reference_text": "",
    "notes": "Looking forward for your business.",
    "terms": "",
    "terms_to_invoice": false,
    "notes_to_invoice": false,
    "warn_estimate_to_invoice": true,
    "is_sales_person_required": true
  }
}

Update estimate settings

PUT  /settings/estimates

Update the settings that are configured for estimates.

Request attributes

auto_generate boolean To enable or disable auto number generation.
prefix_string string
[50]
Prefix string for entity auto number generation.
start_at long Number at which the auto number generation should begin with.
next_number string
[100]
Number that will be next updated while creating an entity.
quantity_precision int
[1]
Number of decimal places to be configured for quantity.
discount_type string Select between the type of discounts applicable for invoice with either entity level or item level or no discount.
Allowed Values: entity_level, item_level and no_discount
reference_text string
[100]
Label for the reference number.
default_template_id string ID of the template that has been used as default template for an entity.
notes string
[5000]
Notes to the customer.
terms string
[10000]
Terms and conditions.
terms_to_invoice boolean To determine whether terms and conditions field is to be copied from estimate to invoice.
notes_to_invoice boolean To determine whether customer notes field is to be copied from estimate to invoice.
warn_estimate_to_invoice boolean To warn estimate to invoice conversion.
is_sales_person_required boolean To determine whether a field for sales person is required.

Sample Request

{
  "auto_generate": true,
  "prefix_string": "EST-",
  "start_at": 1,
  "next_number": "000005",
  "quantity_precision": 2,
  "discount_type": "item_level",
  "reference_text": "",
  "default_template_id": "",
  "notes": "Looking forward for your business.",
  "terms": "",
  "terms_to_invoice": false,
  "notes_to_invoice": false,
  "warn_estimate_to_invoice": true,
  "is_sales_person_required": true
}

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "Your estimate preferences have been saved.",
  "estimate_settings": {
    "auto_generate": true,
    "prefix_string": "EST-",
    "start_at": 1,
    "next_number": "000005",
    "quantity_precision": 2,
    "discount_type": "item_level",
    "is_discount_before_tax": true,
    "reference_text": "",
    "notes": "Looking forward for your business.",
    "terms": "",
    "terms_to_invoice": false,
    "notes_to_invoice": false,
    "warn_estimate_to_invoice": true,
    "is_sales_person_required": true
  }
}

Get estimate notes and terms

GET  /settings/estimates/notesandterms

Get the details of estimate notes and terms.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "notes_and_terms": {
    "notes": "Looking forward for your business.",
    "terms": ""
  }
}

Update estimate notes and terms

PUT  /settings/estimates/notesandterms

Update the details of the estimate notes and terms.

Request attributes

notes string
[5000]
Notes to the customer.
terms string
[10000]
Terms and conditions.

Sample Request

{
  "notes": "Looking forward for your business.",
  "terms": ""
}

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "Your estimate preferences have been saved.",
  "notes_and_terms": {
    "notes": "Looking forward for your business.",
    "terms": ""
  }
}