x-cpod-domain: investments

Investments

Tech portfolio items and cost centers.

Try in explorer client.investments

TechPortfolioItem

A budgeted technology investment line.

REST path/api/v1/investments/portfolio

Operations

listgetcreateupdate

SDK

// list — returns only your records; add filters/search:
await client.investments.portfolio.list()

// create:
await client.investments.portfolio.create({
  id: "rec_01HXEXAMPLE",
  tenant_id: "example tenant_id",
  created_at: "2026-01-01T00:00:00Z",
  updated_at: "2026-01-01T00:00:00Z",
  app_id: "example app_id",
  created_by: "rec_01HXEXAMPLE",
})

Field	Type	Description
id*	uuid	Server-assigned ULID with type prefix (e.g. per_…).
tenant_id*	string	Tenant scope — auto-stamped from the caller's JWT.
app_id	string	App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*	date-time	Server stamp.
updated_at*	date-time	Server stamp; updated on every patch.
created_by	uuid	Person id from the caller's JWT (sub).
updated_by	uuid	Person id from the last writer's JWT (sub).
source	string	Provenance tag — defaults to 'edm'.
source_type	enum	Where the write originated. Defaults to 'api'.`frontendbackendserversystemapi`
is_deleted	boolean	Soft-delete flag. Excluded from default list queries.
deleted_at	date-time	Stamped when soft-deleted; null otherwise.
deleted_by	uuid	Person id who soft-deleted; null otherwise.
schema_version	number	Document schema version. Bumped on incompatible writes.
name	string	Human-readable name for this portfolio item or investment initiative.
description	string	Optional free-text description of the initiative's scope and objectives.
business_capability	string	Business capability this investment supports (e.g. 'Collaboration', 'Security', 'Developer Productivity').
strategic_priority	string	Strategic importance of this investment as assessed by business or IT leadership.
owner_id	uuid	UUID of the Person accountable for this portfolio item.
linked_license_ids	json	UUIDs of SoftwareLicense records that belong to this portfolio item.
linked_asset_ids	json	UUIDs of TechnologyAsset or PhysicalAsset records that belong to this portfolio item.
budgeted_cost_amount	number	Approved budget for this portfolio item in the specified currency.
actual_cost_amount	number	Actual spend to date for this portfolio item in the specified currency.
currency	string	ISO 4217 three-letter currency code for budgeted and actual cost amounts.
initiative_tag	string	Optional free-form tag linking this item to an external programme or initiative tracker.
status	string	Current lifecycle status of this portfolio item.

CostCenter

A cost center for chargebacks.

REST path/api/v1/investments/cost-centers

Operations

listgetcreateupdate

SDK

// list — returns only your records; add filters/search:
await client.investments.costCenters.list()

// create:
await client.investments.costCenters.create({
  id: "rec_01HXEXAMPLE",
  tenant_id: "example tenant_id",
  created_at: "2026-01-01T00:00:00Z",
  updated_at: "2026-01-01T00:00:00Z",
  app_id: "example app_id",
  created_by: "rec_01HXEXAMPLE",
})

Field	Type	Description
id*	uuid	Server-assigned ULID with type prefix (e.g. per_…).
tenant_id*	string	Tenant scope — auto-stamped from the caller's JWT.
app_id	string	App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*	date-time	Server stamp.
updated_at*	date-time	Server stamp; updated on every patch.
created_by	uuid	Person id from the caller's JWT (sub).
updated_by	uuid	Person id from the last writer's JWT (sub).
source	string	Provenance tag — defaults to 'edm'.
source_type	enum	Where the write originated. Defaults to 'api'.`frontendbackendserversystemapi`
is_deleted	boolean	Soft-delete flag. Excluded from default list queries.
deleted_at	date-time	Stamped when soft-deleted; null otherwise.
deleted_by	uuid	Person id who soft-deleted; null otherwise.
schema_version	number	Document schema version. Bumped on incompatible writes.
code	string	Unique human-readable cost center code, as used in the financial system (e.g. 'CC-ENG-001').
name	string	Human-readable display name for this cost center.
owner_id	uuid	UUID of the Person who is the budget owner for this cost center.
parent_cost_center_id	uuid	UUID of the parent CostCenter, if this is a child node in a cost center hierarchy.
budget_amount	number	Annual budget allocated to this cost center in the specified currency.
currency	string	ISO 4217 three-letter currency code for the budget amount.
fiscal_year	string	Fiscal year to which the budgetAmount applies (e.g. '2026').
status	string	Whether this cost center is actively in use.

Docs

TechPortfolioItem

CostCenter