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

# Get a customer's portfolio

> Holdings, and totals per currency (never summed across currencies).



## OpenAPI

````yaml /api-reference/openapi.json get /api/v3/partners/{shortName}/customers/{externalUserId}/portfolio
openapi: 3.0.0
info:
  title: Ndovu Partner API
  description: API for partners distributing Ndovu investment products to their customers.
  version: '3'
  contact: {}
servers:
  - url: https://be-dev-1.dev.ndovu.co
    description: Development
security: []
tags: []
paths:
  /api/v3/partners/{shortName}/customers/{externalUserId}/portfolio:
    get:
      tags:
        - partners
      summary: Get a customer's portfolio
      description: Holdings, and totals per currency (never summed across currencies).
      operationId: PartnerMoneyController_getPortfolio_v3
      parameters:
        - name: shortName
          required: true
          in: path
          description: Your partner short name
          schema:
            type: string
        - name: externalUserId
          required: true
          in: path
          description: Your own ID for the customer
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerPortfolioDto'
      security:
        - bearer: []
components:
  schemas:
    PartnerPortfolioDto:
      type: object
      properties:
        holdings:
          type: array
          items:
            $ref: '#/components/schemas/PartnerHoldingDto'
        totals:
          description: One per currency; never summed across currencies
          type: array
          items:
            $ref: '#/components/schemas/PartnerPortfolioTotalDto'
      required:
        - holdings
        - totals
    PartnerHoldingDto:
      type: object
      properties:
        plan:
          $ref: '#/components/schemas/PartnerHoldingPlanDto'
        units:
          type: number
        currentValue:
          type: number
          description: >-
            Value now, in the plan currency, including money received but not
            yet invested
        investedToDate:
          type: number
        withdrawnToDate:
          type: number
        pendingAmount:
          type: number
          description: Payments not yet confirmed
        reconciledAmount:
          type: number
          description: Money received, not yet invested
        allTimeReturnValue:
          type: number
        allTimeReturnPercentage:
          type: number
      required:
        - plan
        - units
        - currentValue
        - investedToDate
        - withdrawnToDate
        - pendingAmount
        - reconciledAmount
        - allTimeReturnValue
        - allTimeReturnPercentage
    PartnerPortfolioTotalDto:
      type: object
      properties:
        currency:
          type: string
          example: KES
        currentValue:
          type: number
        investedToDate:
          type: number
        allTimeReturnValue:
          type: number
        allTimeReturnPercentage:
          type: number
      required:
        - currency
        - currentValue
        - investedToDate
        - allTimeReturnValue
        - allTimeReturnPercentage
    PartnerHoldingPlanDto:
      type: object
      properties:
        id:
          type: number
          example: 12
        identifier:
          type: string
          example: NDV-MMF
        name:
          type: string
          example: Ndovu Money Market Fund
        currency:
          type: string
          example: KES
      required:
        - id
        - identifier
        - name
        - currency
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.