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

# PitchBook: Get Fund Cash Flows

> Fund Cash Flows. PitchBook Get Fund Cash Flows reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.

Fund Cash Flows.

<Info>
  Tool ID: `pitchbook_get_fund_cash_flows`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'pitchbook_get_fund_cash_flows',
  {
    "pbId": "pb_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={null}
deepline tools execute pitchbook_get_fund_cash_flows --input '{
  "pbId": "pb_123"
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "fundId": "fund_123",
    "fundName": "Example",
    "fundStructure": "example"
  }
}
```

Use `deepline tools get pitchbook_get_fund_cash_flows --json` for the latest machine-readable contract.

## Input reference

Retrieves fund cash flow data for the specified fund across all supported reporting periods. Quarterly data is returned by default.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.pbId` | `string` | Yes | — | Fund pbId |
| `payload.periodType` | `"MTH" \| "QTR" \| "ANN"` | No | `"QTR"` | Type of the period in which data will be presented. The list of types could be found here Allowed: `MTH`, `QTR`, `ANN`. |
| `payload.sinceDate` | `string` | No | — | Searches for data by fiscal period date using the > operator for dates after a specified date, the \< operator for dates before a specified date, and the ^ operator for dates between two dates. Format: YYYY-MM-DD |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Retrieves fund cash flow data for the specified fund across all supported reporting periods. Quarterly data is returned by default.",
    "properties": {
      "pbId": {
        "type": "string",
        "description": "Fund pbId"
      },
      "periodType": {
        "type": "string",
        "description": "Type of the period in which data will be presented. The list of types could be found here",
        "default": "QTR",
        "enum": [
          "MTH",
          "QTR",
          "ANN"
        ]
      },
      "sinceDate": {
        "type": "string",
        "description": "Searches for data by fiscal period date using the > operator for dates after a specified date, the < operator for dates before a specified date, and the ^ operator for dates between two dates. Format: YYYY-MM-DD"
      }
    },
    "required": [
      "pbId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.fundId` | `string` | No | — | — |
| `result.data.fundName` | `string` | No | — | — |
| `result.data.fundStructure` | `string` | No | — | — |
| `result.data.items` | `array` | No | — | — |
| `result.data.items[].period` | `string` | No | — | — |
| `result.data.items[].endDate` | `string` | No | — | Format: `date`. |
| `result.data.items[].capitalActivity` | `object` | No | — | — |
| `result.data.items[].capitalActivity.remainingValue` | `number \| null` | No | — | Format: `double`. |
| `result.data.items[].capitalActivity.contributed` | `number` | No | — | Format: `double`. |
| `result.data.items[].capitalActivity.percentCalledDown` | `number` | No | — | Format: `double`. |
| `result.data.items[].capitalActivity.dryPowder` | `number` | No | — | Format: `double`. |
| `result.data.items[].capitalActivity.percentDryPowder` | `number` | No | — | Format: `double`. |
| `result.data.items[].capitalActivity.distributed` | `number` | No | — | Format: `double`. |
| `result.data.items[].capitalActivity.distributedRemaining` | `number \| null` | No | — | Format: `double`. |
| `result.data.items[].investorActivity` | `object` | No | — | — |
| `result.data.items[].investorActivity.sales` | `number` | No | — | Format: `double`. |
| `result.data.items[].investorActivity.redemptions` | `number` | No | — | Format: `double`. |
| `result.data.items[].investorActivity.reinvestedDividends` | `number` | No | — | Format: `double`. |
| `result.data.items[].investorActivity.netCashFlow` | `number` | No | — | Format: `double`. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "fundId": {
            "type": "string"
          },
          "fundName": {
            "type": "string"
          },
          "fundStructure": {
            "type": "string"
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "period": {
                  "type": "string"
                },
                "endDate": {
                  "type": "string",
                  "format": "date"
                },
                "capitalActivity": {
                  "type": "object",
                  "properties": {
                    "remainingValue": {
                      "type": [
                        "number",
                        "null"
                      ],
                      "format": "double"
                    },
                    "contributed": {
                      "type": "number",
                      "format": "double"
                    },
                    "percentCalledDown": {
                      "type": "number",
                      "format": "double"
                    },
                    "dryPowder": {
                      "type": "number",
                      "format": "double"
                    },
                    "percentDryPowder": {
                      "type": "number",
                      "format": "double"
                    },
                    "distributed": {
                      "type": "number",
                      "format": "double"
                    },
                    "distributedRemaining": {
                      "type": [
                        "number",
                        "null"
                      ],
                      "format": "double"
                    }
                  },
                  "additionalProperties": false
                },
                "investorActivity": {
                  "type": "object",
                  "properties": {
                    "sales": {
                      "type": "number",
                      "format": "double"
                    },
                    "redemptions": {
                      "type": "number",
                      "format": "double"
                    },
                    "reinvestedDividends": {
                      "type": "number",
                      "format": "double"
                    },
                    "netCashFlow": {
                      "type": "number",
                      "format": "double"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [PitchBook provider guide](/docs/providers/pitchbook/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)


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