Sign in

v1

latestSwagger 2.02026-07-13107162315.5 KB
Estimate

Retrieves a single estimate by its Estimate ID, including line items, issuer/recipient details, and web links.

get/api/Estimate/{id}

Path parameters

idinteger required

Estimate Estimate ID number

Response

Returns the estimate details with line items, issuer/recipient, and links.

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.