Datasets · Buildertrend

Buildertrend Bills Dataset

Bills the builder owes its vendors and subs, with the amount, what has been paid, what is still owed and the purchase orders each bill is paid against.

Record type buildertrend:bills

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.

billIdstring
Buildertrend's id for the bill, unique across the account.
billNumberstring
The bill number Buildertrend shows, for example 1184-0017: the job's number followed by a sequence within the job.
titlestring
The bill's title.
builderIdstring
Buildertrend's id for the builder account the bill belongs to.
jobIdstring
Buildertrend's id for the bill's job. Joins to the Buildertrend Jobs Dataset.
jobNamestring
The name of the bill's job, as Buildertrend shows it.
payTostring
The vendor or sub the bill is owed to.
amountnumber
The bill total in the account's own currency, signed. A negative amount is a credit or a return from the vendor, not an error.
amountPaidnumber
How much of the bill has been paid.
remainingBalancenumber
What is still owed on the bill. 0 means the bill is settled.
paymentStatusnumber
Buildertrend's payment status code, sent without a label. Its Bills page groups 2, 4 and 5 as paid and 1 and 10 as ready for payment, so read remainingBalance to tell whether a bill is settled.
isSubRequestedboolean
True when the sub raised the bill through their portal rather than the builder entering it.
documentTypestring
Buildertrend's Type column for the bill. It has read Bill on every bill seen so far, credits included.
sourcestring
Where the bill came from, in Buildertrend's words. It has read Manual on every bill seen so far.
invoiceDatestring
The date on the vendor's invoice.
dueDatestring
When the bill is due.
datePaidstring
The date the bill is paid or scheduled to be paid. It is set on unpaid bills too, so read remainingBalance or amountPaid for proof of payment.
createdDatestring
When the bill was created in Buildertrend.
createdBystring
The name of the person who created the bill, when Buildertrend sends it.
createdByIdstring
Buildertrend's user id for the person who created the bill.
paidBystring
The name Buildertrend records as having paid the bill.
paymentMethodstring
The payment method recorded on the bill, as text.
descriptionstring
The payment notes entered on the bill in Buildertrend.
costCodesarray of strings
The cost codes on the bill, code and name together as Buildertrend displays them. Empty when there are none.
varianceCodesarray of strings
The bill's variance codes. Empty on every bill seen so far.
relatedPurchaseOrderIdsarray of strings
The purchase orders this bill is paid against. Each matches purchaseOrderId in the Buildertrend Purchase Orders Dataset.
relatedInvoiceIdsarray of strings
The owner invoices this bill was passed on to. Each matches invoiceId in the Buildertrend Invoices Dataset.
lienWaiversarray of objects
Every lien waiver on the bill, one entry each, sorted by lienWaiverId and empty when there are none. Read waivers here, not from lienWaiverStatus.

lienWaivers.lienWaiverIdstring
Buildertrend's id for the lien waiver.
lienWaivers.statusnumber
Buildertrend's code for the waiver's status: 0 Unreleased, 1 Pending, 2 Accepted, 4 Builder Accepted. Buildertrend's Bills page shows both 2 and 4 as Approved.
lienWaivers.statusTextstring
Buildertrend's own word for the waiver's status, for example Pending or Builder Accepted.
lienWaivers.lienWaiverTypenumber
The waiver's type code: 1 Conditional, 2 Unconditional.
lienWaivers.lienWaiverTypeTextstring
The waiver's type in words, Conditional or Unconditional, as Buildertrend's Bills page says it. Absent for any other code.
lienWaivers.purchaseOrderIdstring
The purchase order the waiver was raised from, absent when it came from the bill alone. Joins to the Buildertrend Purchase Orders Dataset.
lienWaivers.titlestring
The name of the waiver template, for example ALC Lien Waiver.
lienWaivers.statusLastUpdatedDatestring
When the waiver's status last changed. Buildertrend has not sent this on any waiver seen so far.
lienWaiverSummarystring
Set by Clickr for filtering: None when the bill has no waiver, otherwise the statusText of its least-advanced waiver (Unreleased, then Pending, then Builder Accepted, then Accepted).
lienWaiverStatusnumber
A second lien waiver cell Buildertrend includes on the row but has never been seen populated. Read lienWaivers and lienWaiverSummary instead.
lienWaiverStatusTextstring
The text that goes with lienWaiverStatus, which has never been seen populated. Read lienWaivers instead.
lienWaiverStatusUpdatedDatestring
The date that goes with lienWaiverStatus, which has never been seen populated. Read lienWaivers instead.
isOriginatedFromAccountingboolean
True when the bill was created in the accounting system rather than in Buildertrend.
attachedFileCountnumber
How many files are attached to the bill.
commentCountnumber
How many comments the bill has.
isDuplicatedboolean
Buildertrend's duplicate warning, raised when another bill looks the same. It can change when a different bill is added or deleted, so it never counts as a change to this bill.
isDeletedboolean
True once the bill has been removed in Buildertrend. Clickr keeps the record so you can see it went.
deletedAtdate and time
When Clickr saw the bill removed.