Magidoc

Estimate
Object

An Estimate is a calculation of the cost of a job, based on the properties of the job and the production process. An estimate can be created, updated, and deleted, and can be approved to apply its properties to the job. It is normal to create many estimates for a single job, and to compare them to find the best option.

Estimates can also provide character overrides to the Job, such as quantity, to allow options or upsells to be displayed to the customer.

Fields

#

id

ID !
Non-null

The unique identifier for the estimate.

externalId

An external identifier for the estimate, if available - for example a quote number from another system

jobId

ID !
Non-null

The ID of the Job this estimate is associated with.

job

Non-null

The Job this estimate is associated with.

tactic

Non-null

The tactic used to calculate this estimate.

approved

Non-null

Whether the estimate is approved

name

The name of the estimate - for display purposes

description

The description of the estimate - for example to use on a quote document

customerCurrency

The currency to display the estimate in.

exchangeRate

The exchange rate used for display purposes (if blank, a live bank rate will be used).

overrides

Any overrides to the Job specification

customerId

The ID of the customer attached to this Estimate, if available.

customer

The customer attached to this Estimate, if available.

preparedById

The ID of the user who created this estimate.

preparedBy

The user who created this estimate.

items

Non-null

The items included in this estimate.

costs

Non-null

The costs associated with this estimate.

subtotal

The total net costs of this estimate.

tax

The tax to apply to this estimate

total

The gross cost of this estimate, including tax.

emissions

A report on the total emissions of this estimate for sustainability or compliance reporting

createdAt

Non-null

When the estimate was created.

updatedAt

Non-null

When the estimate was last updated.

Usages

#

References

#