v1
Swagger 2.02026-07-13107162315.5 KBCreates a new draft estimate (quote). Optionally creates a new customer company and contact if no matching company is found.
Request body
A prefix for the Estimate number. e.g. 'INV'. If left blank it will be set to the account default. Max length 20 characters.
Pass any string. If left blank it will use the next number in the auto incrementing sequence. If an integer is passed then the largest integer will be use as the seed to auto generate the next Estimate number in the sequence.
If left blank then you must specify Company Name.
If left blank then you must specify Company ID. Specified Name will be used to match existing customer record. If not matched then it will be used to create a new customer. First Name, Last Name and Email will only be used if it is a new company. If the Company name appears multiple times we will check the email address to find a matching company. If email address doesn't identify a matching company then the Estimate creation will be rejected.
Specified value will be used to create a new customer contact only if a new customer is being created.
Specified value will be used to create a new customer contact only if a new customer is being created.
Specified value will be used to create a new customer contact only if a new customer is being created.
Expects ISO Standard 3 character currency code. If left blank the currency will default to account's currency in general setting. For existing companies this field will be ignored and the Estimate will use the currency of the customer. For new customers if the currency is not specified then account currency will be used otherwise the specified currency will be used.
Exchange rate is only valid for Estimates in currency other than default account currency. If not specified it will get the market rate based on the Date Issued.
If left blank the account default Estimate template will be used.
Plain UTF8 text. (no HTML). 255 characters max
Plain UTF8 text. 100 characters max
If not specified it will use today's date. The date should be specified as local date.
It will be auto calculated based on the payment term and issue date. Due Date must be greater than or equal to Issue Date. If the Due Date is specified then Payment Terms will be set to -1 (Custom)
Possible values are (EX --- Tax Exclusive, INC --- Tax Inclusive). If left empty it will use the account default.
Plain UTF8 text. (no HTML). Max 2000 characters
If true, fires the estimate_created webhook event to any subscribed endpoints. Defaults to false to preserve existing integration behaviour.
Response
Returns the created estimate with assigned Estimate ID and line items.
Unique identifier for the estimate.
The Avaza account this estimate belongs to.
Prefix used in the estimate number.
The estimate number (without prefix).
The customer company ID this estimate is for.
Name of the customer company.
Subject line for the estimate.
Date the estimate was created/issued.
Date the estimate was sent to the customer.
Expiry date for the estimate.
Current status. Values: Draft, Sent, Accepted, Converted, Expired, Rejected.
Total tax amount across all line items.
Tax configuration: 'EX' (exclusive) or 'INC' (inclusive).
Remaining balance on the estimate.
ISO 3-character currency code for the estimate.
Total estimate amount including tax.
Exchange rate to the account's base currency.
Additional notes on the estimate.
Date and time the record was created.
Date and time the record was last updated.