v2

latestSwagger 2.02026-08-04108164321.0 KB
Estimate

Updates an existing estimate. Only fields listed in the FieldsToUpdate array will be modified. When LineItems is included in FieldsToUpdate, all existing line items not present in the array are deleted.

Estimates with a status of Accepted, Converted or Void cannot be updated.

put/api/Estimate

Request body

FieldsToUpdatestring[] required

Required: The collection of Field Names you wish to update. Possible Values: EstimateNumber, CustomerPONumber, DateIssued, DueDate, Subject, Notes, EstimateTaxConfigCode, ExchangeRate, InvoiceTemplateIDFK, LineItems

EstimateIDinteger required

The ID of the Estimate to update

EstimateNumberstring

Pass a string or integer. Must remain unique within the account. Max 30 characters.

CustomerPONumberstring

Plain UTF8 text. 100 characters max

DateIssuedstring date-time

The Date the Estimate is issued. Date should be specified as local date.

DueDatestring date-time

The Expiry Date of the Estimate. Must be greater than or equal to the Issue Date. Pass null to clear the Expiry Date.

Subjectstring

Estimate Subject in plain UTF8 text. (no HTML). 255 characters max

Notesstring

Estimate Notes in plain UTF8 text. (no HTML). Max 2000 characters

EstimateTaxConfigCodestring

Possible values are (EX --- Tax Exclusive, INC --- Tax Inclusive). Changing this triggers recalculation of tax on all line items.

ExchangeRatenumber double

Exchange rate is only valid for estimates in currency other than default account currency.

InvoiceTemplateIDFKinteger

An id for an invoice template in the account.

SendWebhooksboolean

If true, fires the estimate_updated webhook event to any subscribed endpoints. Defaults to false to preserve existing integration behaviour.

Response

Returns the updated estimate details.

EstimateIDinteger

Unique identifier for the estimate.

AccountIDFKinteger

The Avaza account this estimate belongs to.

EstimatePrefixstring

Prefix used in the estimate number.

EstimateItemNumberstring

The estimate number (without prefix).

CompanyIDFKinteger

The customer company ID this estimate is for.

CompanyNamestring

Name of the customer company.

Subjectstring

Subject line for the estimate.

DateIssuedstring date-time

Date the estimate was created/issued.

DateSentstring date-time

Date the estimate was sent to the customer.

DueDatestring date-time

Expiry date for the estimate.

EstimateStatusCodestring

Current status. Values: Draft, Sent, Accepted, Converted, Expired, Rejected.

TaxAmountnumber double

Total tax amount across all line items.

EstimateTaxConfigCodestring

Tax configuration: 'EX' (exclusive) or 'INC' (inclusive).

Balancenumber double

Remaining balance on the estimate.

CurrencyCodestring

ISO 3-character currency code for the estimate.

TotalAmountnumber double

Total estimate amount including tax.

ExchangeRatenumber double

Exchange rate to the account's base currency.

Notesstring

Additional notes on the estimate.

DateCreatedstring date-time

Date and time the record was created.

DateUpdatedstring date-time

Date and time the record was last updated.