Get Purchase Order Cash Flow
GET/api/purchase-orders/:purchaseOrder/cash-flow
Get a purchase order's dated cash flow: every amount it paid out and brought back, by date and category, plus where its received units went.
purchase-orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Unlike the return metrics, this needs only permission to view the purchase order, and it carries no annualized return (no IRR or NPV). It is computed on request and never stored.
Basis. For stock received into Amazon (FBA or AWD) the default is payout: Amazon-sold units bring back what each settlement paid out, net of per-order fees, on its disbursement date; landed-cost fees Amazon deducted from payouts are dated outflows; reimbursements for lost units are cash back; and the fully_loaded variant charges the order's share of FBA storage. revenue reads order revenue at the sale date. Moves from AWD to FBA, to the seller's own warehouse and between fulfillment centres are followed to where the units sold.
Response. variants.product (payments and cash back) and variants.fully_loaded (also allocated cost entries and, on the payout basis, FBA storage), each with cash_flows (date, amount, type, category, category_label, is_estimated, units, source), category_totals, disposition (where every received unit went), total_cash_out, total_cash_in (including remaining stock at cost) and profit.
Cash SKU Return. Each variant also carries cash_return_multiple (cash back ÷ cash out, the same figure as moic, including remaining stock at cost), payback_date (the day cumulative realized cash back reached cumulative cash out and stayed there; null while not yet), days_to_cash_return (days from the first cash out to payback_date), cash_returned_pct (realized cash back ÷ cash out, e.g. 0.64 = 64% returned) and is_cash_returned.
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 — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.