> ## Documentation Index
> Fetch the complete documentation index at: https://docs.activeviam.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve portfolio transactions for a date range.

> Returns a tabular portfolio view between the supplied dates, with the end evaluated at end of day in the caller's time zone. `Counterparties` narrows rows when supplied. `IncludeZeroQuantities` defaults to `false`; set it to `true` to retain positions that net to zero. This is read-only.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/Position/GetTransactionTable
openapi: 3.0.4
info:
  title: Derivitec Api 1.0
  version: '1.0'
servers:
  - url: https://api.riskportal.activeviam.com
security:
  - oauth2: []
  - apikey: []
tags:
  - name: AdminUser
  - name: AtotiReport
  - name: AtotiSession
  - name: BloombergOAuth
  - name: Bond
  - name: BondYieldCurvePage
  - name: BookAccess
  - name: Books
  - name: Commodity
  - name: Counterparties
  - name: Currencies
  - name: Equity
  - name: EquityDividend
  - name: EquityPage
  - name: FeatureFlag
  - name: Fx
  - name: FxPage
  - name: GroupAccess
  - name: Home
  - name: LegacyPosition
  - name: MarketData
  - name: MarketDataProvider
  - name: MarketDataProviderAccess
  - name: Meta
  - name: Notification
  - name: Organisation
  - name: PnLReport
  - name: PortfolioAccess
  - name: Portfolios
  - name: Position
  - name: PositionFilter
  - name: PricingEnvironment
  - name: PricingEnvironmentAccess
  - name: RateAsset
  - name: RateAssetPage
  - name: Report
  - name: ReportDefinition
  - name: ReportHistoryLauncherQuery
  - name: ReportLauncher
  - name: ReportQuery
  - name: ReportQueryViewUser
  - name: ReportRestriction
  - name: ReportView
  - name: RiskReport
  - name: Tradable
  - name: TradeBooking
  - name: User
  - name: VarReport
  - name: VarReportQuery
  - name: YieldCurvePage
paths:
  /api/Position/GetTransactionTable:
    post:
      tags:
        - Position
      summary: Retrieve portfolio transactions for a date range.
      description: >-
        Returns a tabular portfolio view between the supplied dates, with the
        end evaluated at end of day in the caller's time zone. `Counterparties`
        narrows rows when supplied. `IncludeZeroQuantities` defaults to `false`;
        set it to `true` to retain positions that net to zero. This is
        read-only.
      operationId: GetTransactionTable
      requestBody:
        description: >-
          JSON request with non-empty `PortfolioName`, optional unambiguous
          `PortfolioType`, `StartDate`, `EndDate`, optional `Counterparties`,
          and `IncludeZeroQuantities`. A default start date has no effective
          lower bound; provide an end date for a meaningful result. Date
          ordering is not explicitly constrained.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiGetTransactionTableRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiGetTransactionTableRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiGetTransactionTableRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiGetTransactionTableRequest'
      responses:
        '200':
          description: >-
            Returns the transaction data table, or an unsuccessful payload when
            the portfolio is unavailable to the caller.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiGetTransactionTableResponse'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiGetTransactionTableRequest:
      required:
        - $type
      type: object
      properties:
        portfolio_name:
          type: string
          description: >-
            Name of the portfolio to select. The value must not be null or
            empty.
          nullable: true
          example: Example portfolio
        portfolio_type:
          enum:
            - derivitec
            - enfusion
            - orchestrade
            - liquidity_book
            - maia
            - fund_studio
            - not_set
          type: string
          description: >-
            Portfolio category used to resolve the requested portfolio. It may
            be omitted when the portfolio name resolves unambiguously.
          nullable: true
        counterparties:
          type: array
          items:
            type: string
          description: Optional counterparty names that restrict the returned rows.
          nullable: true
        end_date:
          type: string
          description: >-
            Inclusive final calendar date, evaluated at end of day in the
            caller's time zone.
          format: date-time
        include_zero_quantities:
          type: boolean
          description: >-
            Whether to retain positions whose quantities net to zero; defaults
            to false.
        start_date:
          type: string
          description: >-
            Initial calendar date; its default value applies no effective lower
            date bound.
          format: date-time
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.Positions.ApiGetTransactionTableRequest,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Portfolio, date window, counterparty filter, and zero-quantity choice
        used to retrieve a transaction table.
    ApiGetTransactionTableResponse:
      description: >-
        Tabular portfolio positions or transactions produced by a position-table
        query.
      discriminator:
        propertyName: $type
        mapping:
          Derivitec.Web.Core.Positions.ApiGetTransactionTableResponse, Derivitec.Web.Core: '#/components/schemas/ApiGetTransactionTableResponseMintlifyShape'
          Derivitec.Web.Core.Positions.ApiGetPortfolioTableResponse, Derivitec.Web.Core: '#/components/schemas/ApiGetPortfolioTableResponse'
      oneOf:
        - $ref: '#/components/schemas/ApiGetTransactionTableResponseMintlifyShape'
        - $ref: '#/components/schemas/ApiGetPortfolioTableResponse'
    ApiGetTransactionTableResponseMintlifyShape:
      required:
        - $type
      type: object
      properties:
        is_success:
          type: boolean
          description: >-
            Whether the operation completed successfully. The default is `true`;
            error outcomes set it to `false`.
          example: true
        error_messages:
          type: array
          items:
            type: string
          description: >-
            Messages explaining operation-level failures. The collection is
            empty by default.
          nullable: true
        data_table:
          description: >-
            JSON row table using the caller's organisation-specific columns and
            grouping when configured.
          type: array
          items:
            type: object
            additionalProperties: true
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.Positions.ApiGetTransactionTableResponse,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Tabular portfolio positions or transactions produced by a position-table
        query.
    ApiGetPortfolioTableResponse:
      required:
        - $type
      type: object
      additionalProperties: false
      description: Aggregated position table returned for the selected portfolio date.
      properties:
        is_success:
          type: boolean
          description: >-
            Whether the operation completed successfully. The default is `true`;
            error outcomes set it to `false`.
          example: true
        error_messages:
          type: array
          items:
            type: string
          description: >-
            Messages explaining operation-level failures. The collection is
            empty by default.
          nullable: true
        data_table:
          description: >-
            JSON row table using the caller's organisation-specific columns and
            grouping when configured.
          type: array
          items:
            type: object
            additionalProperties: true
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.Positions.ApiGetPortfolioTableResponse,
              Derivitec.Web.Core
  securitySchemes:
    oauth2:
      type: oauth2
      description: >-
        OAuth2 access-token requested from AWS Cognito and provided as a Auth
        Bearer header
      flows:
        implicit:
          authorizationUrl: https://auth.riskportal.derivitec.com/oauth2/authorize
          scopes: {}
    apikey:
      type: apiKey
      description: API-Key requested via the site and provided as a header
      name: x-api-key
      in: header

````