ACacculynx
estimates

Get Estimate Section

Use this endpoint to get a specific estimate section. Supported includes: createdBy, modifiedBy, items.

get/estimates/{estimateId}/sections/{estimateSectionId}

Request

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

Path parameters

estimateIdstring uuid required

The estimate's unique identifier

estimateSectionIdstring uuid required

The estimate section'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

OK

idstring uuid

The unique ID for the estimate section.

titlestring

The title of the estimate section.

descriptionstring

A description of the estimate section.

createdDatestring

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

modifiedDatestring

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

profitMarginRatenumber

The rate of profit on the estimate section.

profitMarginTotalnumber

The total profit for the estimate section.

_linkstring

The unique URI of the Estimate Section.

Example response

{
  "id": "43bc3071-8701-4514-92d2-0ab6934bbacc",
  "title": "Roofing",
  "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",
  "items": [
    {
      "id": "79bd84ff-a16a-4358-b1de-be5071c0f19c",
      "_link": "https://api.acculynx.com/api/v2/estimates/01a7cfc1-2231-4589-9657-7f3004c06bd3/sections/43bc3071-8701-4514-92d2-0ab6934bbacc/items/79bd84ff-a16a-4358-b1de-be5071c0f19c"
    }
  ],
  "_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.