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

# Get accounting yield period summary

> Returns an accounting performance summary for a period, scoped to either one wallet or the authenticated organization. Period performance metrics can be negative and are distinct from customer-facing displayed yield.




## OpenAPI

````yaml swagger/swagger-combined.yaml GET /v2/accounting/yield/period-summary
openapi: 3.0.0
info:
  title: Ground API
  description: Core API for portfolio wallets, deposits, withdrawals, and webhooks.
  version: 2.0.0
servers:
  - url: https://sandbox.groundtech.co
  - url: https://production.groundtech.co
security:
  - bearerAuth: []
tags:
  - name: System
    description: System health and utility endpoints.
  - name: Sandbox Faucets
    description: Sandbox-only test token faucets.
  - name: Portfolio Wallets
    description: >-
      Portfolio wallets with strategy allocation, deposits, withdrawals, and
      yield positions.
  - name: Webhook Endpoints
    description: Webhook endpoint management for portfolio wallet notifications.
paths:
  /v2/accounting/yield/period-summary:
    get:
      tags:
        - Accounting
      summary: Get accounting yield period summary
      description: >
        Returns an accounting performance summary for a period, scoped to either
        one wallet or the authenticated organization. Period performance metrics
        can be negative and are distinct from customer-facing displayed yield.
      operationId: getAccountingYieldPeriodSummary
      parameters:
        - name: walletId
          in: query
          required: false
          schema:
            type: string
            format: uuid
          description: >-
            Wallet ID for a wallet-scoped report. Provide exactly one of
            `walletId` or `scope=organization`.
        - name: scope
          in: query
          required: false
          schema:
            type: string
            enum:
              - organization
          description: >-
            Use `organization` for an organization-wide report. Provide exactly
            one of `walletId` or `scope=organization`.
        - name: start
          in: query
          required: true
          schema:
            type: string
            format: date-time
          description: Inclusive ISO-8601 UTC period start.
        - name: end
          in: query
          required: true
          schema:
            type: string
            format: date-time
          description: Exclusive ISO-8601 UTC period end.
        - name: costBasisMethod
          in: query
          required: false
          schema:
            type: string
            default: fifo
            enum:
              - fifo
              - average_cost
          description: Cost basis method used for realized performance calculations.
      responses:
        '200':
          description: Yield period summary
          content:
            application/json:
              schema:
                type: object
                properties:
                  periodStart:
                    type: string
                    format: date-time
                  periodEnd:
                    type: string
                    format: date-time
                  scope:
                    type: string
                    enum:
                      - wallet
                      - all
                  portfolioWalletId:
                    type: string
                    format: uuid
                    nullable: true
                  costBasisMethod:
                    type: string
                    enum:
                      - fifo
                      - average_cost
                  status:
                    type: string
                    enum:
                      - exact
                      - incomplete
                  reason:
                    type: string
                    nullable: true
                  summary:
                    type: object
                    properties:
                      startingValueUsd:
                        type: string
                        nullable: true
                      endingValueUsd:
                        type: string
                        nullable: true
                      externalDepositsUsd:
                        type: string
                      externalPayoutsUsd:
                        type: string
                      groundCreditsUsd:
                        type: string
                      explicitFeesUsd:
                        type: string
                      protocolSlippageUsd:
                        type: string
                      realizedPerformanceUsd:
                        type: string
                        nullable: true
                      unrealizedPerformanceUsd:
                        type: string
                        nullable: true
                      investmentPerformanceUsd:
                        type: string
                        nullable: true
                      grossYieldGeneratedUsd:
                        type: string
                        nullable: true
                      netYieldEarnedUsd:
                        type: string
                        nullable: true
                      reconciliationStatus:
                        type: string
                        enum:
                          - exact
                          - incomplete
                  yieldSources:
                    type: array
                    items:
                      type: object
                      properties:
                        walletId:
                          type: string
                          format: uuid
                        walletLabel:
                          type: string
                          nullable: true
                        yieldSourceId:
                          type: string
                        yieldSourceLabel:
                          type: string
                          nullable: true
                        costBasisMethod:
                          type: string
                          enum:
                            - fifo
                            - average_cost
                        startingNativeUnits:
                          type: string
                          nullable: true
                        endingNativeUnits:
                          type: string
                          nullable: true
                        startingValuationUsd:
                          type: string
                          nullable: true
                        endingValuationUsd:
                          type: string
                          nullable: true
                        startingValuedAt:
                          type: string
                          format: date-time
                          nullable: true
                        endingValuedAt:
                          type: string
                          format: date-time
                          nullable: true
                        startingPriceUsd:
                          type: string
                          nullable: true
                        endingPriceUsd:
                          type: string
                          nullable: true
                        startingPriceSource:
                          type: string
                          nullable: true
                        endingPriceSource:
                          type: string
                          nullable: true
                        startingValueUsd:
                          type: string
                        endingValueUsd:
                          type: string
                        entryValueUsd:
                          type: string
                          nullable: true
                        exitValueUsd:
                          type: string
                          nullable: true
                        realizedPerformanceUsd:
                          type: string
                          nullable: true
                        unrealizedPerformanceUsd:
                          type: string
                          nullable: true
                        explicitFeesUsd:
                          type: string
                          nullable: true
                        protocolSlippageUsd:
                          type: string
                          nullable: true
                        groundCreditsUsd:
                          type: string
                          nullable: true
                        grossYieldGeneratedUsd:
                          type: string
                          nullable: true
                        netYieldEarnedUsd:
                          type: string
                          nullable: true
                        timeWeightedCapitalUsd:
                          type: string
                          nullable: true
                          description: >-
                            Modified Dietz-style capital exposure for the source
                            over the report period.
                        netPeriodPerformanceBps:
                          type: string
                          nullable: true
                          description: >-
                            Net period performance in basis points over the
                            report period, not annualized.
                        netPeriodPerformanceApyBps:
                          type: string
                          nullable: true
                          description: Net period performance annualized into basis points.
                        grossPeriodPerformanceApyBps:
                          type: string
                          nullable: true
                          description: >-
                            Gross period performance annualized into basis
                            points.
                        status:
                          type: string
                          nullable: true
                        reason:
                          type: string
                          nullable: true
              example:
                periodStart: '2026-05-01T00:00:00.000Z'
                periodEnd: '2026-06-01T00:00:00.000Z'
                scope: wallet
                portfolioWalletId: b1c2d3e4-0000-4000-8000-000000000001
                costBasisMethod: fifo
                status: exact
                reason: null
                summary:
                  startingValueUsd: '10000.000000'
                  endingValueUsd: '10482.310000'
                  externalDepositsUsd: '250.000000'
                  externalPayoutsUsd: '0.000000'
                  groundCreditsUsd: '0.000000'
                  explicitFeesUsd: '1.120000'
                  protocolSlippageUsd: '0.000000'
                  realizedPerformanceUsd: '41.250000'
                  unrealizedPerformanceUsd: '192.180000'
                  investmentPerformanceUsd: '233.430000'
                  grossYieldGeneratedUsd: '234.550000'
                  netYieldEarnedUsd: '233.430000'
                  reconciliationStatus: exact
                yieldSources:
                  - walletId: b1c2d3e4-0000-4000-8000-000000000001
                    walletLabel: Corporate Treasury
                    yieldSourceId: syrup-usdc
                    yieldSourceLabel: Syrup USDC
                    costBasisMethod: fifo
                    startingNativeUnits: '4000000000'
                    endingNativeUnits: '4212430000'
                    startingValuationUsd: '4000.000000'
                    endingValuationUsd: '4212.430000'
                    startingValuedAt: '2026-05-01T00:00:00.000Z'
                    endingValuedAt: '2026-06-01T00:00:00.000Z'
                    startingPriceUsd: '1.000000'
                    endingPriceUsd: '1.053108'
                    startingPriceSource: reference_price
                    endingPriceSource: reference_price
                    startingValueUsd: '4000.000000'
                    endingValueUsd: '4212.430000'
                    entryValueUsd: '4000.000000'
                    exitValueUsd: '4212.430000'
                    realizedPerformanceUsd: '0.000000'
                    unrealizedPerformanceUsd: '212.430000'
                    explicitFeesUsd: '0.000000'
                    protocolSlippageUsd: '0.000000'
                    groundCreditsUsd: '0.000000'
                    grossYieldGeneratedUsd: '212.430000'
                    netYieldEarnedUsd: '212.430000'
                    timeWeightedCapitalUsd: '4018.250000'
                    netPeriodPerformanceBps: '528.665588'
                    netPeriodPerformanceApyBps: '6225.204231'
                    grossPeriodPerformanceApyBps: '6225.204231'
                    status: exact
                    reason: null
        '400':
          description: Invalid query parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalid_period:
                  value:
                    error: start must be earlier than end
                    code: validation_error
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    ErrorResponse:
      type: object
      required:
        - error
        - code
      properties:
        error:
          type: string
          description: >-
            Human-readable error message. May change without notice; do not
            parse programmatically.
        code:
          type: string
          description: >-
            Machine-readable error code. Stable across API versions — safe to
            switch on in client code.
          enum:
            - validation_error
            - unknown_parameters
            - unsupported_chain
            - unsupported_token
            - invalid_destination_address
            - precision_overflow
            - invalid_cursor
            - unauthenticated
            - forbidden
            - wallet_not_found
            - wallet_limit_reached
            - withdrawal_not_found
            - deposit_not_found
            - yield_source_not_found
            - wallet_projection_unavailable
            - insufficient_funds
            - duplicate_request_id
            - request_id_conflict
            - invalid_position_weight
            - invalid_withdrawal_plan
            - payout_not_found
            - webhook_not_found
            - webhook_duplicate_url
            - withdrawal_not_cancellable
            - withdrawal_already_cancelled
            - withdrawal_payout_in_progress
            - withdrawal_policy_required
            - workflow_conflict
            - payout_already_terminal
            - payout_in_progress
            - payout_not_retryable
            - address_book_entry_not_found
            - address_book_duplicate_entry
            - address_book_whitelist_violation
            - rate_limited
            - rate_limit_exceeded
            - internal_error
            - wallet_creation_failed
            - service_temporarily_unavailable
    AuthErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Authentication or authorization error message.
        message:
          type: string
          nullable: true
          description: Additional auth middleware detail, when present.
        code:
          type: string
          nullable: true
          enum:
            - unauthenticated
            - forbidden
          description: >-
            Some auth and scope failures include a stable code; middleware
            errors may omit it.
  responses:
    Unauthorized:
      description: >-
        The request is missing a valid bearer token, or the token is invalid or
        expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthErrorResponse'
          example:
            error: Unauthenticated request
            message: Missing or invalid bearer token
    TooManyRequests:
      description: >-
        Rate limit exceeded. Limits are enforced by API key/customer identity
        and by endpoint class. Retry with backoff; rate-limit headers are not
        currently emitted.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Rate limit exceeded
            code: rate_limited
    InternalServerError:
      description: >-
        An unexpected error occurred while processing the request. The request
        can be safely retried with the same `requestId`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Internal server error
            code: internal_error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````