Estimate

Fields

typestringrequired
Always"estimate"
projectIdstringrequired
pricedOninteger(int64)required
The moment the prices were taken as of (noon UTC of date, or now).
currencystring
The currency of the largest subtotal, for a headline figure.
mixedCurrencyboolean
Whether the products are priced in more than one currency.
linesarray of EstimateLinerequired
subtotalsobject (any fields)required
Per currency.
taxesobject (any fields)required
Per currency.
totalsobject (any fields)required
Subtotal plus tax, per currency.
geometriesarray of object
What each shape and spot comes to on its own.

Example

{
  "type": "estimate",
  "projectId": "Xr7Lp2Qm9KdT4wZs",
  "pricedOn": 1792000000000,
  "currency": "GBP",
  "mixedCurrency": false,
  "lines": [
    {
      "productId": "prd_Lw7Qm2Xc",
      "productName": "Artificial turf",
      "count": 2,
      "area": {
        "quantity": 412.6,
        "unit": "m²"
      },
      "length": {
        "quantity": 0,
        "unit": ""
      },
      "amount": 11552.8,
      "currency": "GBP",
      "taxRate": 20,
      "tax": 2310.56
    }
  ],
  "subtotals": {
    "GBP": 11552.8
  },
  "taxes": {
    "GBP": 2310.56
  },
  "totals": {
    "GBP": 13863.36
  },
  "geometries": [
    {
      "id": "pg_4Rt8Wq2Z",
      "productName": "Artificial turf",
      "amount": 9178.4,
      "currency": "GBP"
    },
    {
      "id": "pg_7Yt2Ka9B",
      "productName": "Artificial turf",
      "amount": 2374.4,
      "currency": "GBP"
    }
  ]
}

Used by

GET Get a project's estimate