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

# Prop Trading Get Org Payout Summary

> Aggregates org-wide prop-trader payment counts by unified status for the payouts page summary cards.

Required scope: `payments:read`

## OpenAPI

````yaml api-reference/openapi.json GET /hris/prop-trading-get-org-payout-summary
openapi: 3.1.0
info:
  title: Toku API
  version: 1.0.0
servers:
  - url: https://api.toku.com
security:
  - bearerAuth: []
paths:
  /hris/prop-trading-get-org-payout-summary:
    get:
      operationId: propTradingGetOrgPayoutSummary
      summary: Prop Trading Get Org Payout Summary
      x-toku-required-scope: payments:read
      description: >-
        Aggregates org-wide prop-trader payment counts by unified status for the
        payouts page summary cards.


        Required scope: `payments:read`
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropTradingGetOrgPayoutSummaryResponse'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '409':
          description: Conflict
        '429':
          description: Response 429
components:
  schemas:
    PropTradingGetOrgPayoutSummaryResponse:
      type: object
      properties:
        total:
          type: integer
        statusCounts:
          type: object
          properties:
            IN_REVIEW:
              type: integer
            FAILED:
              type: integer
            CANCELLED:
              type: integer
            PAID:
              type: integer
            PARTIALLY_PAID:
              type: integer
            IN_PROGRESS:
              type: integer
            AWAITING_PAYMENT:
              type: integer
            PENDING:
              type: integer
          required:
            - IN_REVIEW
            - FAILED
            - CANCELLED
            - PAID
            - PARTIALLY_PAID
            - IN_PROGRESS
            - AWAITING_PAYMENT
            - PENDING
      required:
        - total
        - statusCounts
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
````
