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

# Get partner payout details

> Returns detailed payout information for a specific partner, broken down by period.



## OpenAPI

````yaml api-reference/v1/openapi.yaml get /v1/admin/partners/payouts/{partnerId}
openapi: 3.1.0
info:
  title: Goods API
  version: 1.0.0
  description: >-
    API for Goods grocery operations - scanner app, admin dashboard, and
    customer features
  contact:
    name: Goods Team
    url: https://goods.app
servers:
  - url: http://localhost:3000
    description: Local development
  - url: https://dev.api.switchyard.run
    description: Development
  - url: https://api.switchyard.run
    description: Production
security: []
tags:
  - name: v1
    description: API v1 - unified domain-based endpoints
  - name: Scanner
    description: Scanner app endpoints for drivers and pickers
  - name: Sweeps
    description: Sweep management - retail store pickup operations
  - name: RFC Picks
    description: Ready-for-checkout picking operations
  - name: Inventory
    description: Inventory management and barcode lookup
  - name: Admin
    description: Admin dashboard endpoints
  - name: Orders
    description: Order management
  - name: Products
    description: Product catalog management
  - name: Notifications
    description: Push, email, SMS, and Slack notification management
paths:
  /v1/admin/partners/payouts/{partnerId}:
    get:
      tags:
        - Admin - Partner Payouts
      summary: Get partner payout details
      description: >-
        Returns detailed payout information for a specific partner, broken down
        by period.
      parameters:
        - schema:
            type: string
            format: uuid
            description: Partner brand ID
          required: true
          name: partnerId
          in: path
      responses:
        '200':
          description: Partner payout details
          content:
            application/json:
              schema:
                type: object
                properties:
                  partner_brand_id:
                    type: string
                    format: uuid
                  company_name:
                    type: string
                  contact_email:
                    type: string
                  payout_method:
                    type: string
                    nullable: true
                  periods:
                    type: array
                    items:
                      type: object
                      properties:
                        period:
                          type: string
                        sale_count:
                          type: number
                        total_units:
                          type: number
                        gross_sales:
                          type: number
                        total_commission:
                          type: number
                        net_to_partner:
                          type: number
                        status:
                          type: string
                          enum:
                            - pending
                            - included
                            - paid
                      required:
                        - period
                        - sale_count
                        - total_units
                        - gross_sales
                        - total_commission
                        - net_to_partner
                        - status
                  totals:
                    type: object
                    properties:
                      pending_amount:
                        type: number
                      included_amount:
                        type: number
                      paid_amount:
                        type: number
                      lifetime_sales:
                        type: number
                    required:
                      - pending_amount
                      - included_amount
                      - paid_amount
                      - lifetime_sales
                required:
                  - partner_brand_id
                  - company_name
                  - contact_email
                  - payout_method
                  - periods
                  - totals
        '404':
          description: Partner not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - error
        '500':
          description: Server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - error

````