The Budget represents a financial budget from your ledger, including its name, period cadence, category, overall end date and the individual budget lines that make it up. Each budget line holds the planned (budgeted) amount for an account in a given period, so you can set up alerts that watch budgeted figures, account types and budget timing.
The AI will only look back at 24 months' worth of data.
Key Properties:
SourceLink: A stable identifier that links the budget back to its source record in the ledger. Use it for traceability, not as a numeric value.
BudgetName: The budget's display name as configured in the ledger.
EntryType: The budget period granularity (how each budget line is bucketed): Empty, Monthly, Quarterly or Yearly. This is the cadence of the lines, not the budget's category — see BudgetType for that.
BudgetType: The free-text budget category or label as configured in the ledger. This is not the period granularity — see EntryType for cadence.
BudgetEndDate: The budget header's overall end date, not a per-line period date. There is no start-date field; to detect a budget ending soon, compare BudgetEndDate against the current date.
Lines: A list of budget lines, each detailing the planned amount for an account in a particular period.
BudgetLine
BudgetDate: The period date this budget line applies to. A budget has one line per account per period bucket (see EntryType for cadence); the budgeted amount is the planned figure for this period, not a running total.
AccountName: The account name from the chart of accounts. May be empty when no matching account record exists.
AccountClassification: The top-level account classification for this budget line: ASSET, LIABILITY, EQUITY, REVENUE or EXPENSE. This is the only income-versus-expense signal on Budget data. May be empty when no matching account record exists.
AccountType: The account type from the chart of accounts. May be empty when no matching account record exists.
AccountCode: The account code from the chart of accounts. May be empty when no matching account record exists.
BudgetedAmount: The budgeted (planned) amount for this budget line, in the organisation's base currency. This is the budget figure — not actual or spent activity. Defaults to 0 when the source value is empty.
Notes: Free-text notes attached to this budget line in the ledger. May be empty.
TrackingCategories: A list of tracking category items applied to this budget line.
TrackingCategoryItem
TrackingCategoryName: The name of the tracking category.
TrackingCategoryOption: The selected option for the tracking category.
📝 Example Alerts
Alert me when a budget line amount exceeds $10,000.
Alert me when a budget is about to end within the next week.
Alert me when a Monthly budget has a REVENUE line budgeted at $0.
Alert me when an EXPENSE budget line is budgeted above $50,000 in any period.