Entities

Budget

B2B spending allowance with lifecycle, usage, reset period, and validity

A Budget is a spending allowance granted to a cost center, employee, or business unit and drawn down as orders are placed.

Available since v0.26.0 in @laioutr-core/canonical-types

Components

Base

BudgetBase

base
Budget identity, code, source identifier, and custom fields.
name
stringrequired

Human-readable display name, e.g. "Marketing 2026".

code
string

Human/ERP identifier distinct from the internal id, e.g. "BUD-2026-01".

externalId
string

Identifier of this budget in the source system it was imported from.

customFields
Record<string, unknown>

Custom fields are a way for implementations to pass arbitrary data to actions, queries, etc.

Status

BudgetStatus

status
Whether the budget is active or inactive.
status
"active" | "inactive"required

The status value set — shared with the b2b/organization/budget-* actions so the vocabulary has a single source.

Info

BudgetInfo

info
Short summary fields for budget lists.
description
string

Short plain-text description shown as a list subtitle. Not HTML.

Allowance

BudgetAllowance

allowance
Spending limit, amount spent, reset period, and notification threshold.
period
string
periodLabel
string

Connector-resolved display label for period — the fallback shown when the period key is not mapped to a localized label.

notificationThreshold
number

Notify the responsible party once consumption reaches this percentage of limit (0–100), when the source supports spend alerts (B2B Sellers notificationPercentage).

Validity

BudgetValidity

validity
Optional absolute validity window, separate from the recurring allowance period.
  • BudgetCostCentersCostCenter multi — Resolves cost centers that draw against the budget.
Copyright © 2026 Laioutr GmbH