Home/Tools/@tpmjs/official-cash-flow-project

cashFlowProjectTool

@tpmjs/official-cash-flow-project

Projects cash flow based on receivables, payables, and recurring items

Official
finance
v0.1.1
MIT

Interactive Playground

Test @tpmjs/official-cash-flow-project (cashFlowProjectTool) with AI-powered execution

0/2000 characters

Installation & Usage

Install this tool and use it with the AI SDK

1. Install the package

npm install @tpmjs/official-cash-flow-project
pnpm add @tpmjs/official-cash-flow-project
yarn add @tpmjs/official-cash-flow-project
bun add @tpmjs/official-cash-flow-project
deno add npm:@tpmjs/official-cash-flow-project

2. Import the tool

import { cashFlowProjectTool } from '@tpmjs/official-cash-flow-project';

3. Use with AI SDK

import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { cashFlowProjectTool } from '@tpmjs/official-cash-flow-project';

const result = await generateText({
  model: openai('gpt-4o'),
  tools: { cashFlowProjectTool },
  prompt: 'Your prompt here...',
});

console.log(result.text);

Signature

(payables: { amount: number; dueDate: string; frequency: string; recurring: boolean; description: string }[], currentCash: number, receivables: { amount: number; dueDate: string; description: string; probability: number }[], recurringItems?: { type: string; amount: number; endDate: string; frequency: string; startDate: string }[], projectionMonths?: number) => Promise<unknown>

Tags

based
cash
cash-flow
finance
flow
items
official
payables
project
projection
projects
receivables
recurring
runway
tpmjs

Parameters

Available configuration options

Auto-extracted
currentCash
Required
Type: number

Current cash balance

receivables
Required
Type: array

Expected receivables with due dates

payables
Required
Type: array

Expected payables with due dates

recurringItems
Optional
Type: array

Recurring revenue or expenses

projectionMonths
Optional
Type: number

Number of months to project

Schema extracted: 2/23/2026, 4:30:15 AM

README

ERROR: No README data found!

Statistics

Downloads/month

24

GitHub Stars

0

Quality Score

76%

Bundle Size

NPM Keywords

tpmjs
finance
cash-flow
projection
runway

Maintainers

thomasdavis(thomasalwyndavis@gmail.com)

Frameworks

vercel-ai
cashFlowProjectTool | TPMJS | TPMJS