Datasets · Buildertrend

Buildertrend Estimates Dataset

Estimate line items with their job, cost code, quantities, cost and owner price.

Record type buildertrend:estimates

Read it with List records, or the MCP tool list_dataset_records.

Request

curl -G https://api.clickr.cloud/v2/datasets/{datasetId}/records \
  -H "Authorization: Bearer $CLICKR_API_KEY" \
  --data-urlencode "limit=10"

const response = await fetch(`https://api.clickr.cloud/v2/datasets/{datasetId}/records?${new URLSearchParams({
  "limit": "10"
})}`, {
  headers: {
    Authorization: `Bearer ${process.env.CLICKR_API_KEY}`,
  },
});
const data = await response.json();

import os
import requests

response = requests.get(
    "https://api.clickr.cloud/v2/datasets/{datasetId}/records",
    headers={"Authorization": f"Bearer {os.environ['CLICKR_API_KEY']}"},
    params={
        "limit": "10"
    },
)
data = response.json()

Fields

Every field a record can carry. Filter and sort on them by name, as in filter[jobName][contains]=patel. A field without a value can be missing from a record.

lineItemIdstring
Buildertrend's id for the estimate line item. Unique across the account, not just within a job.
jobIdstring
Buildertrend's id for the job the estimate belongs to. Joins to the Buildertrend Jobs Dataset.
worksheetIdstring
Buildertrend's id for the job's estimate worksheet. Repeated on every line item of the job.
builderIdstring
Buildertrend's id for the builder account the line item belongs to.
jobNamestring
The job's name. Repeated on every line item of the job.
contractPricenumber
The contract price on the job's estimate worksheet, in the account's currency. Repeated on every line item, and editing it alone does not fire pipelines watching line items.
proposalStatusnumber
Buildertrend's code for the status of the owner proposal built from this worksheet, repeated on every line item of the job. Not mapped to labels.
worksheetLockedboolean
Whether the estimate worksheet is locked. It can flip when someone simply opens the worksheet, so it alone does not fire pipelines watching line items.
isSentToBudgetboolean
Whether the estimate worksheet has been sent to the job's budget. Repeated on every line item of the job.
groupIdstring
Buildertrend's id for the worksheet group the line sits in. -1 is Buildertrend's catch-all Unassigned group.
groupTitlestring
The title of the group the line sits in. Unassigned is Buildertrend's catch-all group, not one an estimator created.
groupPatharray of strings
The titles of the groups from the top of the worksheet down to this line's group, which tells apart subgroups with the same name.
itemTitlestring
The line item's title.
descriptionstring
The line item's description.
internalNotesstring
Builder-only notes on the line. Buildertrend can fill this with the cost category label, so it is not always text an estimator typed.
lineItemTypenumber
Buildertrend's code for the kind of line item. Not mapped to labels.
parentIdstring
Buildertrend's id for the line item's parent, when it has one.
costCodeIdstring
Buildertrend's id for the line's cost code.
costCodeTitlestring
The name of the line's cost code.
costCategoryIdstring
Buildertrend's id for the line's cost category.
costCategoryNamestring
The name of the line's cost category, looked up from the worksheet's list of cost categories.
costItemIdstring
Buildertrend's id for the line's cost item.
costTypesany
Buildertrend's split of the line by cost type, such as labour, material or subcontractor, passed through as Buildertrend sends it.
unitstring
The unit of measure for the quantity, as entered in Buildertrend.
quantitynumber
How many units the line covers.
unitCostnumber
The builder's cost per unit, in the account's currency.
builderCostnumber
The line's total cost to the builder, quantity times unit cost, in the account's currency.
markupTypenumber
Buildertrend's code for which kind of markup the estimator entered: a percentage, a per-unit amount or a flat amount. The other markup fields are worked out from it.
markupPercentnumber
The markup as a percentage of cost, so 20 means 20%.
markupPerUnitnumber
The markup per unit, in the account's currency.
markupAmountnumber
The line's total markup, in the account's currency.
marginnumber
The line's margin as a percentage of the owner price, so 16.67 means 16.67%.
unitPricenumber
The owner price per unit, in the account's currency.
ownerPricenumber
The price the owner is charged for the line, cost plus markup, in the account's currency.
amountInvoicednumber
How much has been invoiced against the line so far, in the account's currency.
retainageWithheldnumber
The retainage withheld on the line, in the account's currency.
taxGroupIdstring
Buildertrend's id for the tax group applied to the line.
totalWithTaxnumber
The line's total including tax, in the account's currency, as Buildertrend calculates it.
hasRelatedPurchaseOrderboolean
Whether the line is already on a purchase order.
relatedPurchaseOrderLineItemIdstring
Buildertrend's id for the purchase order line item linked to this line.
relatedItemsany
Buildertrend's links from this line to related items, passed through as Buildertrend sends them.
selectionOptionGroupIdstring
Buildertrend's id for the selection option group linked to this line.
assemblyIdstring
Buildertrend's id for the assembly the line belongs to.
takeoffLineItemIdstring
Buildertrend's id for the takeoff line item linked to this line.
importedFromProposalFormatItemIdstring
Buildertrend's id for the proposal format item this line was imported from.
productIdstring
Buildertrend's id for the product, on lines added from a supplier catalogue.
productUrlstring
A link to the product, on lines added from a supplier catalogue.
productLinkany
Buildertrend's product link details, passed through as sent. Present only on lines added from a supplier catalogue.
vendorTypenumber
Buildertrend's code for the catalogue vendor type, on lines added from a supplier catalogue. Not mapped to labels.
discontinuedboolean
Whether the catalogue product is marked discontinued, on lines added from a supplier catalogue.
markedAsnumber
Buildertrend's code for how the line is marked. Not mapped to labels.
formatIdstring
Buildertrend's id for the line's entry in the worksheet layout.
displayOrdernumber
The line's position within its group on the worksheet.
dateAddedstring
When the line was added to the worksheet, as the date string Buildertrend sends.
isDeletedboolean
True once the line has been removed from the job's estimate in Buildertrend, and Clickr keeps the record. Only open jobs are rechecked, so a line on a closed job keeps its last state.
deletedAtdate and time
When Clickr saw the line removed.