Portfolios

post/v1/portfolios

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
  • Auth: API key in header x-api-key

Request body

namestring required

Portfolio name

slugstring

Portfolio slug (auto-generated if not supplied)

currencystring

Functional currency (default USD)

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

Legal entity classification for an explicit country profile

financialReportingFramework'TAX_ONLY' | 'US_GAAP_PRE_2025' | 'US_GAAP_ASC350_60' | 'IFRS_IAS38' | 'IFRS_IAS38_REVAL' | 'IFRS_IAS2_LCNRV' | 'IFRS_IAS2_BROKER_TRADER_FVLCTS' | 'ASPE' | 'FRS_102' | 'AASB_138' | 'OTHER'

Financial reporting framework (default TAX_ONLY)

reportingTimezonestring

Canonical IANA reporting timezone (default UTC)

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.