---
title: "Retrieve projected cash flow"
method: GET
path: "/api/ProjectedCashFlow"
tags: ["ProjectedCashFlow"]
---

# Retrieve projected cash flow

`GET /api/ProjectedCashFlow`

This operation retrieves an object containing cash flow information 
              for each year of the projected plan.

## Query parameters

- `planId` string, required

## Response `200`

Success

- CashFlowProjectionsModel
  - `links` ObjectLink[]
    - `href` string
    - `rel` string
  - `projections` CashFlowProjectionModel[]
    - `cashFlow` ProjectedCashFlowSummary
      - `cashFlow` ICashFlowByOwner
        - `clientCashFlow` ICashFlow
          - `incomes` ICashFlowIncomes
            - `annuityPayments` ICashFlowCategory
              - …
            - `disabilityIncomes` Currency
              - …
            - `earnedIncome` ICashFlowCategory
              - …
            - `insuranceBenefits` ICashFlowCategory
              - …
            - `investmentIncomes` ICashFlowCategory
              - …
            - `lifestyleAssetLiquidations` ICashFlowCategory
              - …
            - `lockedInLiquidations` Currency
              - …
            - `longTermCareBenefits` Currency
              - …
            - `miscellaneousIncomes` ICashFlowCategory
              - …
            - `nonQualifiedLiquidations` ICashFlowCategory
              - …
            - `pension` ICashFlowCategory
              - …
            - `privateCorporations` ICashFlowCategory
              - …
            - `qualifiedLiquidations` ICashFlowCategory
              - …
            - `qualifiedLiquidationsNonRequiredMinimumDistributions` ICashFlowCategory
              - …
            - `requiredMinimumDistributions` ICashFlowCategory
              - …
            - `retirementIncome` Currency
              - …
            - `rothLiquidations` Currency
              - …
            - `socialSecurity` ICashFlowCategory
              - …
            - `tfsaLiquidations` Currency
              - …
            - `total` ICashFlowCategory
              - …
            - `withdrawals` Currency
              - …
          - `outflows` ICashFlowOutflows
            - `contributions` Currency
              - …
            - `educationExpenses` ICashFlowCategory
              - …
            - `employerExpenses` ICashFlowCategory
              - …
            - `employmentBusinessExpenses` ICashFlowCategory
              - …
            - `investmentExpenses` ICashFlowCategory
              - …
            - `lifestyleExpenses` ICashFlowCategory
              - …
            - `lifestyleExpensesDiscretionary` ICashFlowCategory
              - …
            - `lifestyleExpensesFixed` ICashFlowCategory
              - …
            - `lockedInContributions` Currency
              - …
            - `medicalExpenses` ICashFlowCategory
              - …
            - `miscellaneousExpenses` ICashFlowCategory
              - …
            - `miscellaneousExpensesDiscretionary` ICashFlowCategory
              - …
            - `miscellaneousExpensesFixed` ICashFlowCategory
              - …
            - `nonQualifiedContributions` ICashFlowCategory
              - …
            - `nonQualifiedReinvestments` ICashFlowCategory
              - …
            - `privateCorporationOutflows` ICashFlowCategory
              - …
            - `qualifiedContributions` ICashFlowCategory
              - …
            - `rothContributions` Currency
              - …
            - `surplusOutflows` ICashFlowCategory
              - …
            - `surplusSavings` Currency
              - …
            - `tfsaContributions` Currency
              - …
            - `totalNeeds` Currency
              - …
            - `totalWithTaxes` Currency
              - …
            - `totalWithoutTaxes` Currency
              - …
          - `surplusDeficit` Currency
            - `formattedDecimal` string
            - `formattedNoDecimal` string
            - `raw` number, double
          - `taxes` ITaxes
            - `estate` Currency
              - …
            - `federalIncome` Currency
              - …
            - `giftAndGenerationSkippingTransfer` Currency
              - …
            - `medicare` Currency
              - …
            - `pensionEarlyDistributionPenalty` Currency
              - …
            - `pensionPenaltyOnExcessDistributions` Currency
              - …
            - `refundableCredits` Currency
              - …
            - `socialSecurityEmployer` Currency
              - …
            - `socialSecuritySelfEmployed` Currency
              - …
            - `stateIncome` Currency
              - …
            - `total` Currency
              - …
        - `coClientCashFlow` ICashFlow
          - `incomes` ICashFlowIncomes
            - `annuityPayments` ICashFlowCategory
              - …
            - `disabilityIncomes` Currency
              - …
            - `earnedIncome` ICashFlowCategory
              - …
            - `insuranceBenefits` ICashFlowCategory
              - …
            - `investmentIncomes` ICashFlowCategory
              - …
            - `lifestyleAssetLiquidations` ICashFlowCategory
              - …
            - `lockedInLiquidations` Currency
              - …
            - `longTermCareBenefits` Currency
              - …
            - `miscellaneousIncomes` ICashFlowCategory
              - …
            - `nonQualifiedLiquidations` ICashFlowCategory
              - …
            - `pension` ICashFlowCategory
              - …
            - `privateCorporations` ICashFlowCategory
              - …
            - `qualifiedLiquidations` ICashFlowCategory
              - …
            - `qualifiedLiquidationsNonRequiredMinimumDistributions` ICashFlowCategory
              - …
            - `requiredMinimumDistributions` ICashFlowCategory
              - …
            - `retirementIncome` Currency
              - …
            - `rothLiquidations` Currency
              - …
            - `socialSecurity` ICashFlowCategory
              - …
            - `tfsaLiquidations` Currency
              - …
            - `total` ICashFlowCategory
              - …
            - `withdrawals` Currency
              - …
          - `outflows` ICashFlowOutflows
            - `contributions` Currency
              - …
            - `educationExpenses` ICashFlowCategory
              - …
            - `employerExpenses` ICashFlowCategory
              - …
            - `employmentBusinessExpenses` ICashFlowCategory
              - …
            - `investmentExpenses` ICashFlowCategory
              - …
            - `lifestyleExpenses` ICashFlowCategory
              - …
            - `lifestyleExpensesDiscretionary` ICashFlowCategory
              - …
            - `lifestyleExpensesFixed` ICashFlowCategory
              - …
            - `lockedInContributions` Currency
              - …
            - `medicalExpenses` ICashFlowCategory
              - …
            - `miscellaneousExpenses` ICashFlowCategory
              - …
            - `miscellaneousExpensesDiscretionary` ICashFlowCategory
              - …
            - `miscellaneousExpensesFixed` ICashFlowCategory
              - …
            - `nonQualifiedContributions` ICashFlowCategory
              - …
            - `nonQualifiedReinvestments` ICashFlowCategory
              - …
            - `privateCorporationOutflows` ICashFlowCategory
              - …
            - `qualifiedContributions` ICashFlowCategory
              - …
            - `rothContributions` Currency
              - …
            - `surplusOutflows` ICashFlowCategory
              - …
            - `surplusSavings` Currency
              - …
            - `tfsaContributions` Currency
              - …
            - `totalNeeds` Currency
              - …
            - `totalWithTaxes` Currency
              - …
            - `totalWithoutTaxes` Currency
              - …
          - `surplusDeficit` Currency
            - `formattedDecimal` string
            - `formattedNoDecimal` string
            - `raw` number, double
          - `taxes` ITaxes
            - `estate` Currency
              - …
            - `federalIncome` Currency
              - …
            - `giftAndGenerationSkippingTransfer` Currency
              - …
            - `medicare` Currency
              - …
            - `pensionEarlyDistributionPenalty` Currency
              - …
            - `pensionPenaltyOnExcessDistributions` Currency
              - …
            - `refundableCredits` Currency
              - …
            - `socialSecurityEmployer` Currency
              - …
            - `socialSecuritySelfEmployed` Currency
              - …
            - `stateIncome` Currency
              - …
            - `total` Currency
              - …
        - `totalCashFlow` ICashFlow
          - `incomes` ICashFlowIncomes
            - `annuityPayments` ICashFlowCategory
              - …
            - `disabilityIncomes` Currency
              - …
            - `earnedIncome` ICashFlowCategory
              - …
            - `insuranceBenefits` ICashFlowCategory
              - …
            - `investmentIncomes` ICashFlowCategory
              - …
            - `lifestyleAssetLiquidations` ICashFlowCategory
              - …
            - `lockedInLiquidations` Currency
              - …
            - `longTermCareBenefits` Currency
              - …
            - `miscellaneousIncomes` ICashFlowCategory
              - …
            - `nonQualifiedLiquidations` ICashFlowCategory
              - …
            - `pension` ICashFlowCategory
              - …
            - `privateCorporations` ICashFlowCategory
              - …
            - `qualifiedLiquidations` ICashFlowCategory
              - …
            - `qualifiedLiquidationsNonRequiredMinimumDistributions` ICashFlowCategory
              - …
            - `requiredMinimumDistributions` ICashFlowCategory
              - …
            - `retirementIncome` Currency
              - …
            - `rothLiquidations` Currency
              - …
            - `socialSecurity` ICashFlowCategory
              - …
            - `tfsaLiquidations` Currency
              - …
            - `total` ICashFlowCategory
              - …
            - `withdrawals` Currency
              - …
          - `outflows` ICashFlowOutflows
            - `contributions` Currency
              - …
            - `educationExpenses` ICashFlowCategory
              - …
            - `employerExpenses` ICashFlowCategory
              - …
            - `employmentBusinessExpenses` ICashFlowCategory
              - …
            - `investmentExpenses` ICashFlowCategory
              - …
            - `lifestyleExpenses` ICashFlowCategory
              - …
            - `lifestyleExpensesDiscretionary` ICashFlowCategory
              - …
            - `lifestyleExpensesFixed` ICashFlowCategory
              - …
            - `lockedInContributions` Currency
              - …
            - `medicalExpenses` ICashFlowCategory
              - …
            - `miscellaneousExpenses` ICashFlowCategory
              - …
            - `miscellaneousExpensesDiscretionary` ICashFlowCategory
              - …
            - `miscellaneousExpensesFixed` ICashFlowCategory
              - …
            - `nonQualifiedContributions` ICashFlowCategory
              - …
            - `nonQualifiedReinvestments` ICashFlowCategory
              - …
            - `privateCorporationOutflows` ICashFlowCategory
              - …
            - `qualifiedContributions` ICashFlowCategory
              - …
            - `rothContributions` Currency
              - …
            - `surplusOutflows` ICashFlowCategory
              - …
            - `surplusSavings` Currency
              - …
            - `tfsaContributions` Currency
              - …
            - `totalNeeds` Currency
              - …
            - `totalWithTaxes` Currency
              - …
            - `totalWithoutTaxes` Currency
              - …
          - `surplusDeficit` Currency
            - `formattedDecimal` string
            - `formattedNoDecimal` string
            - `raw` number, double
          - `taxes` ITaxes
            - `estate` Currency
              - …
            - `federalIncome` Currency
              - …
            - `giftAndGenerationSkippingTransfer` Currency
              - …
            - `medicare` Currency
              - …
            - `pensionEarlyDistributionPenalty` Currency
              - …
            - `pensionPenaltyOnExcessDistributions` Currency
              - …
            - `refundableCredits` Currency
              - …
            - `socialSecurityEmployer` Currency
              - …
            - `socialSecuritySelfEmployed` Currency
              - …
            - `stateIncome` Currency
              - …
            - `total` Currency
              - …
      - `clientAge` integer
      - `coClientAge` integer
      - `year` integer
    - `links` ObjectLink[]
      - `href` string
      - `rel` string

## Other responses

- `202` — Plan migration is processing
- `400` — Invalid request
- `401` — Unauthorized for plan data access
- `404` — Object not found

---

[API](https://skmtc.net/naviplancentral/apis/plan.md) · [All operations](https://skmtc.net/naviplancentral/apis/plan/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/naviplancentral/plan/versions/97b0a0a95023/schema)