ACacculynx
estimates

Get Estimate Section Item

Use this endpoint to get a specific estimate item.

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

Request

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

Path parameters

estimateIdstring uuid required

The estimate's unique identifier

estimateSectionIdstring uuid required

The estimate section's unique identifier

estimateItemIdstring uuid required

The estimate item's unique identifier

Response

OK

idstring uuid

The unique ID for the item.

namestring

The name of the item.

overrideNamestring

A custom, overridden name for the estimate item.

descriptionstring

Description of the estimate item.

materialCostnumber

Cost for materials.

laborCostnumber

Cost for labor.

wastenumber

Any waste recorded for the item.

estimateUnitstring

The unit of measurement for the item.

orderUnitstring

The unit of measurement to be ordered.

unitConversionnumber

A conversion between the estimate unit and the order unit.

selectedUnitnumber

Whether the item uses the estimate unit or order unit. Expected values: 1 - Order, 2 - Estimate.

type'SKU' | 'Product' | 'CustomSKU' | 'Labor' | 'SKUAndLabor'

The type of item in the catalog.

totalPricenumber

The total price for the item.

fixedPriceboolean

Whether the price for the item is fixed or calculated.

pricenumber

The price per unit of the item.

quantitynumber

The quantity of the item included in the estimate.

measurementQuantitynumber

The measured quantity of the item.

orderQuantitynumber

The ordered quantity of the item.

_linkstring

The unique URI of the Estimate Item.

Example response

{
  "id": "79bd84ff-a16a-4358-b1de-be5071c0f19c",
  "estimateUnit": "SF",
  "orderUnit": "EA",
  "unitConversion": 0.1,
  "selectedUnit": 1,
  "_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"
}

Changes

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