Datasets · Buildertrend

Buildertrend Change Orders Dataset

Change orders with their job, client, approval status and amounts.

Record type buildertrend:changeOrders

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.

changeOrderIdstring
Buildertrend's id for the change order, unique across the account.
coNumberstring
The change order number the builder typed, for example #003 or 0052, with surrounding spaces trimmed. It is neither unique nor consistently formatted.
builderIdstring
Buildertrend's id for the builder account the change order belongs to.
jobIdstring
Buildertrend's id for the change order's job. Joins to the Buildertrend Jobs Dataset.
jobNamestring
The name of the change order's job, as Buildertrend shows it.
ownerNamestring
The client the change order is addressed to, as Buildertrend shows the name.
titlestring
The change order's title.
approvalStatusnumber
Buildertrend's approval status code. Codes seen so far are 0 Draft, 1 Pending, 3 Approved, 4 Approved and 5 Declined, so read approvalStatusText for the label.
approvalStatusTextstring
Buildertrend's own label for the approval status, for example Draft, Pending, Approved or Declined.
statusChangedDatestring
When the status last changed, in the account's own time zone. On a draft it is the creation date, and declined change orders carry one too, so it is not an approval date.
statusChangedBystring
The name of the person who last changed the status. Absent on a draft.
builderCostnumber
The builder's cost for the change order, in the account's own currency.
subtotalnumber
The change order's subtotal, from Buildertrend's Subtotal column.
totalPricenumber
The change order's total price, from Buildertrend's Total price column.
totalMarkupnumber
The total markup on the change order.
purchaseOrderCostnumber
The cost of the purchase orders raised against the change order.
poCustomerVariancenumber
Buildertrend's PO customer variance: one of 2 variances it reports between purchaseOrderCost and what was quoted.
poBuilderVariancenumber
Buildertrend's PO builder variance: one of 2 variances it reports between purchaseOrderCost and what was quoted.
percentInvoicednumber
How much of the change order has been invoiced, as a percentage.
dateAddedstring
When the change order was created, in the account's own time zone.
deadlinestring
The change order's deadline.
ownerLastViewedstring
When the client last opened the change order.
createdBystring
The name of the person who created the change order, when Buildertrend sends it.
createdByIdstring
Buildertrend's user id for the person who created the change order.
relatedPurchaseOrderIdsarray of strings
The purchase orders raised against this change order. Each matches purchaseOrderId in the Buildertrend Purchase Orders Dataset.
isInvoiceableboolean
Whether the change order can be turned into an owner invoice.
attachedFileCountnumber
How many files are attached to the change order.
commentCountnumber
How many comments the change order has.
rfiCountnumber
How many RFIs (requests for information) the change order has.
isDeletedboolean
True once the change order has been removed in Buildertrend. Clickr keeps the record so you can see it went.
deletedAtdate and time
When Clickr saw the change order removed.