Datasets · Buildertrend

Buildertrend Job Costing Budget Dataset

Every cost code on a job budget, with what was budgeted, what is committed, what has been spent and what the job is projected to make on it.

Record type buildertrend:jobCostingBudget

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()

Record

Example record

{
  "budgetLineId": "6300001",
  "jobId": "7310422",
  "jobName": "Ortega Kitchen Remodel",
  "title": "Demolition & haul-off",
  "costCategoryId": "41",
  "costCategoryTitle": "Site work",
  "costCodePath": [],
  "isMarkedComplete": false,
  "hasAdjustments": false,
  "originalBudgetCosts": 3200,
  "revisedBudgetCosts": 3200,
  "pendingCosts": 0,
  "committedCosts": 0,
  "actualCosts": 3050,
  "projectedCosts": 3200,
  "costToComplete": 150,
  "revisedVsProjected": 0,
  "jobRevisedBudgetCosts": 68400,
  "jobActualCosts": 43850,
  "jobCommittedCosts": 12000,
  "jobProjectedCosts": 68400,
  "isDeleted": false
}

From the sample builder, Halvorsen & Styke.

Ask Claude or ChatGPT about the same records: add https://api.clickr.cloud/mcp/playground as a connector, with no sign-in. Try it on a sample builder ›

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.

budgetLineIdstring
Buildertrend's id for this cost code on this job's budget. Each record is one cost code on one job, and the same cost code has a different id on each job.
jobIdstring
Buildertrend's id for the job the budget belongs to. Joins to the Buildertrend Jobs Dataset.
jobNamestring
The job's name. Kept current, but a rename is not reported as a change to this line.
titlestring
The cost code's title as it appears on the job's budget.
costCategoryIdstring
Buildertrend's id for the cost category this cost code sits under.
costCategoryTitlestring
The name of the cost category this cost code sits under. Kept current, but a rename is not reported as a change to this line.
parentBudgetLineIdstring
The budgetLineId of the cost code this one is nested under. Absent on a top-level cost code.
costCodePatharray of strings
The titles of the cost codes above this one, from the top level down. Empty on a top-level cost code.
isMarkedCompleteboolean
Whether the cost code has been marked complete in Buildertrend.
projectedCostTypenumber
Buildertrend's own code for how the projected cost is worked out. It is not a status, and Buildertrend sends no label with it.
isProjectedCostAutoCalculatedboolean
True when Buildertrend calculates the projected cost rather than someone typing it in.
hasAdjustmentsboolean
Whether Buildertrend shows adjustments on this cost code.
originalBudgetCostsnumber
The budget for this cost code before any revisions.
revisedBudgetCostsnumber
The current budget for this cost code, after any revisions.
baselineCostsnumber
Buildertrend's baseline cost for this cost code.
pendingCostsnumber
Buildertrend's pending costs for this cost code.
committedCostsnumber
Money promised but not yet spent on this cost code, from released purchase orders. Not included in actualCosts.
actualCostsnumber
What has been spent against this cost code so far.
projectedCostsnumber
The total cost Buildertrend projects for this cost code.
projectedCostsWithoutAdjustmentsnumber
The projected cost for this cost code with adjustments left out.
costToCompletenumber
What Buildertrend expects is still to be spent on this cost code.
revisedVsProjectednumber
The revised budget minus the projected cost. Negative when the cost code is projected to go over budget.
builderVariancenumber
Buildertrend's builder variance for this cost code.
standaloneBillBuilderVariancenumber
Buildertrend's builder variance from standalone bills on this cost code.
standaloneActualCostsnumber
Buildertrend's standalone actual costs for this cost code.
originalOwnerPricenumber
The price to the client for this cost code before any revisions.
revisedOwnerPricenumber
The price to the client for this cost code after any revisions.
totalOriginalPricenumber
Buildertrend's total original price for this cost code.
totalRevisedPricenumber
Buildertrend's total revised price for this cost code. projectedProfit is this minus projectedCosts.
taxesnumber
The taxes Buildertrend shows on this cost code.
percentInvoicednumber
The share of this cost code's price invoiced so far.
amountInvoicednumber
How much has been invoiced against this cost code so far.
remainingToInvoicenumber
How much of this cost code's price is still to be invoiced.
retainageHeldnumber
The retainage held on this cost code.
projectedProfitnumber
What the job is projected to make on this cost code: totalRevisedPrice minus projectedCosts.
projectedProfitMarginnumber
The projected profit as a percentage of the revised price, so 4.52 means 4.52%.
estimatedGrossProfitnumber
Buildertrend's estimated gross profit for this cost code.
profitPercentOverEstimatednumber
Buildertrend's profit percentage over the estimate for this cost code.
originalBudgetQuantitynumber
The quantity budgeted for this cost code before any revisions. The record does not carry its unit.
revisedBudgetQuantitynumber
The quantity budgeted for this cost code after any revisions. The record does not carry its unit.
actualLaborHoursnumber
Hours of labour Buildertrend records against this cost code.
jobRevisedBudgetCostsnumber
The whole job's revised budget. Copied onto every line of the job, and not reported as a change to this line.
jobCommittedCostsnumber
The whole job's committed costs. Copied onto every line of the job, and not reported as a change to this line.
jobActualCostsnumber
The whole job's actual costs. Copied onto every line of the job, and not reported as a change to this line.
jobProjectedCostsnumber
The whole job's projected costs. Copied onto every line of the job, and not reported as a change to this line.
jobProjectedProfitnumber
The whole job's projected profit. Copied onto every line of the job, and not reported as a change to this line.
jobProjectedProfitMarginnumber
The whole job's projected profit as a percentage of its revised price, so 12.5 means 12.5%. Copied onto every line, and not reported as a change to it.
jobTotalRevisedPricenumber
The whole job's total revised price. Copied onto every line of the job, and not reported as a change to this line.
jobAmountInvoicednumber
How much has been invoiced on the whole job. Copied onto every line of the job, and not reported as a change to this line.
isDeletedboolean
True once the cost code has been removed from the job's budget in Buildertrend. Clickr keeps the record, and rechecks open jobs only.
deletedAtdate and time
When Clickr saw the cost code removed from the job's budget.