Datasets · Buildertrend

Buildertrend Invoices Dataset

Owner invoices the builder bills its clients, with amounts, tax, retainage, what has been paid and what is still owed.

Record type buildertrend:invoices

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.

invoiceIdstring
Buildertrend's id for the invoice, unique across the account.
invoiceNumberstring
The invoice number shown in Buildertrend, such as 0833-0001.
builderIdstring
Buildertrend's id for the builder account.
jobIdstring
Buildertrend's id for the job the invoice is on. Joins to the Buildertrend Jobs Dataset.
jobNamestring
The job's name in Buildertrend.
ownerNamestring
The client being billed, whom Buildertrend calls the owner.
titlestring
The invoice's title, a short free-text label such as Down Payment.
invoiceAmountnumber
The invoice total, in the account's own currency (351.7 means 351.70).
totalTaxnumber
The tax on the invoice.
retainagenumber
The portion of invoiceAmount withheld until the work is accepted. Part of the invoice, not an extra charge on top of it.
amountPaidnumber
What has been received against the invoice, net of refunds. Not the invoice total, which is invoiceAmount.
invoiceBalancenumber
What is still owed on the invoice. The field to read to tell whether an invoice is settled.
amountRefundednumber
How much has been refunded on the invoice.
paymentStatusTypenumber
Buildertrend's payment-status code, sent with no label and not a published vocabulary. To tell whether the invoice is settled, read invoiceBalance.
hasPaymentProcessingboolean
True while a payment on the invoice is being processed.
hasPaymentIssueboolean
True when a payment on the invoice has hit a problem.
isInApprovalboolean
True while the invoice is waiting on an approver.
isRejectedboolean
True when an approver has refused the invoice.
scheduledReleaseDatestring
The scheduled release date Buildertrend shows in the invoice's payment status.
dueDatestring
The date the invoice is due.
viewedByOwnerOnstring
When the client last opened the invoice in Buildertrend's owner portal. Absent means they have not opened it, not that it was never sent.
datePaidstring
The paid date Buildertrend shows for the invoice. To tell whether it is settled, read invoiceBalance.
dateReleasedstring
The invoice's release date as Buildertrend reports it.
createdDatestring
When the invoice was created in Buildertrend.
createdBystring
The name of the Buildertrend user who created the invoice.
createdByIdstring
Buildertrend's user id for whoever created the invoice.
accountingStatusnumber
Buildertrend's code from its QuickBooks column for the invoice. Its values are not documented, so treat it as a code rather than a status.
isPendingSyncboolean
True while the invoice is waiting its turn to sync to the accounting system.
isOriginatedFromAccountingboolean
True when the invoice was created in the accounting system rather than in Buildertrend.
attachedFileCountnumber
How many files are attached to the invoice. The files themselves are not in this dataset.
commentCountnumber
How many comments the invoice has.
isDeletedboolean
True once the invoice has been voided or deleted in Buildertrend, never because it was paid. Clickr keeps the record so you can see it went.
deletedAtdate and time
When Clickr saw the invoice removed.