Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
startingCash
number
required

Beginning Cash Balance

Required range: -99999999 <= x <= 99999999
months
number
required

Number of Months to Project

Required range: 1 <= x <= 60
operatingIncome
number

Operating / Sales Income

Required range: 0 <= x <= 99999999
otherIncome
number

Other Income

Required range: 0 <= x <= 99999999
operatingExpenses
number

Operating Expenses

Required range: 0 <= x <= 99999999
debtPayments
number

Loan / Debt Payments

Required range: 0 <= x <= 99999999
taxPayments
number

Taxes

Required range: 0 <= x <= 99999999
otherExpenses
number

Other Expenses

Required range: 0 <= x <= 99999999
includeSchedule
boolean

Show Month-by-Month Breakdown

currency
enum<string>

Currency

Available options:
USD,
EUR,
GBP,
AUD,
JPY,
CAD

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.