Get a project's estimate

GET/projects/{pid}/estimate

projects:read products:read EnterpriseOpen GuestSince v2

What the measured work comes to, priced from the catalogue: a line per product, the subtotal, tax and total per currency (never added across currencies), and what each shape and spot comes to on its own. The same numbers as the app's estimate and the report. Quantities are in each product's own pricing unit; a product's cost price is never included.

Needs Products: read as well as Projects: read.

Request

curl 'https://api.measuremaponline.com/api/v2/projects/Xr7Lp2Qm9KdT4wZs/estimate' \
  -H "Authorization: $MMO_API_KEY"

Response

{
  "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"
    }
  ]
}

Path parameters

pidstringrequired
The project's ID, the part after /p/ in its address in the app.

Query parameters

datestring(date)
Price the work as on this day (YYYY-MM-DD), which decides the seasonal prices in force. Today when left out.

Responses

Estimate:
- 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.

Errors

A failed request answers with one of these, in an Error body.

400invalid_bodyA value in the request body is missing, has the wrong type, is too long or is not one of the accepted values.

401unauthorized_actionThe item is not on your account or your members', the request came from a web page on a website the key does not allow, or the action is not allowed for this person.

403insufficient_scopeThe key does not have the access this endpoint needs. Create a key with that access.

403invalid_api_keyNo key was sent in the Authorization header, or the key is unknown, revoked, or past the time it kept working after being replaced.

404project_not_foundThe project does not exist.

Try it

API key

This key is

The key stays in this tab and goes only to the API. Use a sandbox key while you try things: requests are real, and what they change is changed.

pid required

date

GET https://api.measuremaponline.com/api/v2/projects/Xr7Lp2Qm9KdT4wZs/estimate

Fill in your API key to send.

As a cURL command

Shell

curl 'https://api.measuremaponline.com/api/v2/projects/Xr7Lp2Qm9KdT4wZs/estimate' \
  -H "Authorization: $MMO_API_KEY"