Get Purchase Order Cash Forecast
GET/api/purchase-orders/:purchaseOrder/cash-forecast
Get a purchase order's cash forecast: the saved forecast inputs (or, when none are saved, inputs prefilled from the order's payment schedule, its own sell-through, its realized payout per unit and the payout lag), where each prefilled value came from (default_sources), the actual cash to date, and the projection.
purchase-orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
What the forecast is. The purchase order's actual cash to date (payments made, payouts and sales received; never remaining stock at cost or estimated payments) plus a projection for the units still to sell: the expected cost outflows at their dates, then sales at sales_per_day from the day the stock is sellable (start_date + production_days + transit_days + inbound_days, never before tomorrow), grouped into weekly blocks each paid out at net_payout_per_unit after payout_lag_days.
Cash SKU Return. projection.cash_return_multiple is cash back ÷ cash out; projection.days_to_cash_return counts from the first cash out to projection.payback_date, the day the running position (cash back − cash out) reaches zero and stays there — null when the forecast never gets there, with cash_returned_pct saying how much comes back. projection.irr is the annualized money-weighted return (MIRR at the tenant's hurdle rate); projection.xirr the exact XIRR when it solves.
Basis. Purchase orders received into Amazon (FBA or AWD) are projected on the Amazon payout basis, others on sales revenue.
Needs permission to view the purchase order. Requires a Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.