---
title: "POST /v1/portfolios/{portfolioSlug}/period-close/preview"
method: POST
path: "/v1/portfolios/{portfolioSlug}/period-close/preview"
tags: ["PeriodCloseCommands"]
---

# POST /v1/portfolios/{portfolioSlug}/period-close/preview

`POST /v1/portfolios/{portfolioSlug}/period-close/preview`

## 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}/period-close/preview`
- Auth: API key in header `x-api-key`

## Path parameters

- `portfolioSlug` string, required

## Request body

- PeriodClosePreviewRequestDto
  - `closeThroughDate` string, date, required

## Response `200`

- PeriodClosePreviewResponseDto
  - `result` object, required
    - `closeThroughDate` string, date, required
    - `bounds` object, required
      - `reportingTimezone` string, required
      - `periodStartExclusive` string, date-time, nullable, required
      - `periodEndInclusive` string, date-time, required
      - `nextMidnightBoundary` string, date-time, required
      - `maxCloseThroughDate` string, date, required
      - `functionalCurrency` string, required
    - `financialReportingFramework` 'TAX_ONLY' | 'US_GAAP_ASC350_60' | 'IFRS_IAS2_LCNRV' | 'IFRS_IAS2_BROKER_TRADER_FVLCTS', required
    - `frameworkStrategy` 'TAX_ONLY' | 'ASC_350_60_FAIR_VALUE' | 'IAS2_LOWER_OF_COST_AND_NRV' | 'IAS2_BROKER_TRADER_FVLCTS', required
    - `frameworkCapability` 'EXECUTABLE' | 'ACTIVATION_DISABLED' | 'UNSUPPORTED', required
    - `isFiscalYearEnd` boolean, required
    - `issues` object[], required
      - `code` 'FISCAL_YEAR_BOUNDARY_CROSSED' | 'FRAMEWORK_ACTIVATION_DISABLED' | 'ERROR_TX_AT_OR_BEFORE_PERIOD_END' | 'WALLETS_NOT_SYNCED_THROUGH_PERIOD_END' | 'STALE_CLOSE_EVIDENCE' | 'MATERIAL_UNPRICED_IN_SCOPE_HOLDING' | 'NEGATIVE_IN_SCOPE_HOLDING' | 'UNAVAILABLE_POSTING_ACCOUNT' | 'INVALID_POSTING_ACCOUNT' | 'MISSING_YEAR_END_LEGAL_ENTITY' | 'LEGACY_YEAR_END_LEGAL_ENTITY' | 'TRUST_YEAR_END_LEGAL_ENTITY' | 'UNSUPPORTED_YEAR_END_LEGAL_ENTITY' | 'PERIOD_CLOSE_PLAN_TOO_LARGE' | 'UNCATEGORIZED_TRANSACTIONS' | 'PENDING_ADJUSTMENTS' | 'RECONCILIATION_DIFFERENCE', required
      - `severity` 'BLOCKER' | 'WARNING', required
      - `message` string, required
      - `subject` 'PERIOD' | 'FRAMEWORK' | 'TRANSACTION' | 'WALLET' | 'EVIDENCE' | 'ACCOUNT' | 'LEGAL_ENTITY' | 'LEDGER' | 'ADJUSTMENT' | 'RECONCILIATION', required
      - `count` integer, required
      - `detailItems` object[], required
        - `id` string, required
        - `label` string, nullable, required
      - `detailItemsTruncated` boolean, required
    - `canClose` boolean, required
    - `plan` object, nullable, required
      - `functionalCurrency` string, required
      - `frameworkMeasurement` union, required
        - object
          - `action` 'NO_OP', required
        - object
          - `action` 'POSTED', required
          - `journals` object[], required
            - `lines` object[], required
              - …
            - `totalDebits` string, required
            - `totalCredits` string, required
            - `subType` 'fair_value_reversal' | 'fair_value_mark', required
      - `yearEndAction` union, required
        - object
          - `action` 'NOT_APPLICABLE', required
        - object
          - `action` 'NO_OP', required
        - object
          - `action` 'POSTED', required
          - `accountDisposition` object, nullable, required
            - `kind` 'STABLE', required
            - `stableLookupKey` object, required
              - …
            - `disposition` union, required
              - …
          - `journal` object, required
            - `lines` object[], required
              - …
            - `totalDebits` string, required
            - `totalCredits` string, required
            - `subType` 'YEAR_END_EARNINGS_TRANSFER', required
      - `counts` object, required
        - `sourceTransactionCount` integer, required
        - `frameworkMeasurementTransactionCount` integer, required
        - `yearEndTransactionCount` integer, required
      - `snapshotHash` string, required
      - `planHash` string, required
    - `accumulatedEarningsAccount` union, required
      - object
        - `disposition` 'REUSE', required
        - `name` string, required
        - `accountNumber` string, required
      - object
        - `disposition` 'CREATE', required
        - `creationName` string, required

---

[API](https://skmtc.dev/tokenbooks/apis/tokenbooks-public-api.md) · [All operations](https://skmtc.dev/tokenbooks/apis/tokenbooks-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tokenbooks/apis/tokenbooks-public-api/revisions/180622e6255e?raw)