Portfolios

get/v1/portfolios/{portfolioSlug}

Request

  • Base URL: https://api.tokenbooks.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.tokenbooks.io/v1/portfolios/{portfolioSlug}
  • Auth: API key in header x-api-key

Path parameters

portfolioSlugstring required

Workspace-scoped portfolio slug

Response

slugstring required

Portfolio slug

namestring required

Portfolio name

createdAtstring date-time required

Creation timestamp (ISO 8601)

updatedAtstring date-time required

Last update timestamp (ISO 8601)

currencystring required

Base currency

legalEntityType'BUSINESS' | 'CORPORATION' | 'INDIVIDUAL' | 'TRUST' | 'PARTNERSHIP' | 'null' nullable required

Legal entity type, or null when none is configured

reportingTimezonestring required

Reporting timezone

hasPostedActivityboolean required

True when the portfolio has at least one POSTED or CLOSED transaction. Accounting-policy fields that would reinterpret existing entries cannot be changed once this is true, so callers use it to decide which settings to offer.

Changes

No recorded changes to this operation across all 1 revision of this API.