Get Purchase Order Return Metrics
GET/api/purchase-orders/:purchaseOrder/return-metrics
Get the annualized return (Annualized ROI / IRR) for a purchase order.
Models the purchase as a dated cash-flow series — vendor deposit and balance payments out, then net sales proceeds in as the received units sell through, plus any remaining stock valued at cost as of today — and solves the money-weighted annualized rate (XIRR).
Two variants are returned: product (purchase payments and sales proceeds only) and fully_loaded (also charges allocated time-based cost entries). Each variant includes the rate, cash multiple (moic), days held, realized fraction, profit, an NPV at the tenant hurdle rate, a maturity status (provisional, interim, final, or nm), presentation caveats, and the full signed cash-flow series.
Requires a Bearer token.
Each variant includes a disposition breakdown accounting for every received unit — bucketed into sold (direct / after transfer or kitting), still-owned (on hand / held elsewhere), and lost (written off / stock-taken) — so the sell-through figure is fully reconciled to units received.
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.