OSS-first docs

These docs teach the open system first: contracts, generated surfaces, runtimes, governance, and incremental adoption. Studio shows up as the operating layer on top, not as the source of truth.

AI index

openbanking.balances.get

Retrieve the latest cached balances for a bank account.

  • Type: operation (query)
  • Version: 1.0.0
  • Stability: experimental
  • Owners: @platform.finance
  • Tags: open-banking, powens, balances
    • field.key.label
    openbanking.balances.get
    field.version.label
    1.0.0
    field.type.label
    operation (query)
    field.title.label
    openbanking.balances.get
    field.description.label

    Retrieve the latest cached balances for a bank account.

  • Type: operation (query)
  • Version: 1.0.0
  • Stability: experimental
  • Owners: @platform.finance
  • Tags: open-banking, powens, balances
    • field.tags.label
    open-banking,powens,balances
    field.owners.label
    @platform.finance
    field.stability.label
    experimental

    Retrieve the latest cached balances for a bank account.

    Goal

    Expose current and available balances required by dashboards and analytics.

    Context

    Used by Pocket Family Office UI surfaces and automation steps that require balance totals prior to generating summaries.

    Source Definition

    import {
	type AnyOperationSpec,
	defineCommand,
	defineQuery,
} from '@lssm-tech/lib.contracts-spec/operations';
import type { OperationSpecRegistry } from '@lssm-tech/lib.contracts-spec/operations/registry';
import { ScalarTypeEnum, SchemaModel } from '@lssm-tech/lib.schema';
import { AccountBalanceRecord } from '../models';
import { OPENBANKING_TELEMETRY_EVENTS } from '../telemetry';

export const OpenBankingGetBalances = defineQuery({
	meta: {
		key: 'openbanking.balances.get',
		version: '1.0.0',
		description: 'Retrieve the latest cached balances for a bank account.',
		goal: 'Expose current and available balances required by dashboards and analytics.',
		context:
			'Used by Pocket Family Office UI surfaces and automation steps that require balance totals prior to generating summaries.',
		owners: ['@platform.finance'],
		tags: ['open-banking', 'powens', 'balances'],
		stability: 'experimental',
	},
	io: {
		input: OpenBankingGetBalancesInput,
		output: OpenBankingGetBalancesOutput,
	},
	policy: {
		auth: 'user',
	},
});