estimates

Get Estimate

Use this endpoint to get a specific estimate. Supported includes: job, createdBy, modifiedBy, sections.

get/estimates/{estimateId}

Request

Base URL
https://api.acculynx.com/api/v2
URL
https://api.acculynx.com/api/v2/estimates/{estimateId}
Auth
HTTP bearer

Path parameters

estimateIdstring uuid required

The estimate's unique identifier

Query parameters

includesstring

A comma-separated list of related resources to expand inline in the response. Valid values vary by endpoint and are documented in each operation description.

Response

idstring uuid

The unique identifier of the estimate.

isPrimaryboolean

Whether the estimate is primary for the job.

_linkstring

The unique URI of the Estimate for the specified Job.

titlestring

The title of the estimate.

descriptionstring

A description of the estimate.

estimateNumberstring

An identifier that can be set to match other internal documentation. By default each new estimate will increment the estimateNumber by 1

createdDatestring

The date/time the estimate was created, in UTC format.

modifiedDatestring

The date/time the estimate was modified, in UTC format.

profitMarginRatenumber

The rate of profit on the estimate total.

profitMarginTotalnumber

The total profit for the estimate.

notesstring

Additional notes about the estimate.

Example response

{
  "id": "01a7cfc1-2231-4589-9657-7f3004c06bd3",
  "job": {
    "id": "e591bf22-9828-4144-bca8-42cbb8c6e2c0",
    "_link": "https://api.acculynx.com/api/v2/jobs/e591bf22-9828-4144-bca8-42cbb8c6e2c0"
  },
  "_link": "https://api.acculynx.com/api/v2/estimates/01a7cfc1-2231-4589-9657-7f3004c06bd3",
  "title": "Estimate 1",
  "estimateNumber": "'3' - or - 'Some Meaningful String'",
  "createdBy": {
    "id": "228db892-3b49-4455-b839-ffd8576d8731",
    "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
  },
  "createdDate": "2015-07-28T17:48:59Z",
  "modifiedBy": {
    "id": "228db892-3b49-4455-b839-ffd8576d8731",
    "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
  },
  "modifiedDate": "2015-07-29T17:48:59Z",
  "sections": [
    {
      "id": "43bc3071-8701-4514-92d2-0ab6934bbacc",
      "_link": "https://api.acculynx.com/api/v2/estimates/01a7cfc1-2231-4589-9657-7f3004c06bd3/sections/43bc3071-8701-4514-92d2-0ab6934bbacc"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.