List Product IRR Ranking
GET/api/reporting/irr/products
Rank every product by the internal rate of return on its purchasing cash flows (each order's flows prorated to the product by its cost share of the order).
Each row's xirr is the annualized money-weighted return (0.549 = 54.9%), pooled across all the entity's non-draft purchase orders — deposit and balance payments out, then net sales proceeds in as the received units sell through, plus remaining stock valued at cost as of today. Also returns the cash multiple (moic), profit, capital deployed, days deployed, and units sold. Rows are ranked by IRR (unsolvable rows sort last with is_rankable=false). Amounts are in the account's base currency. Requires a Bearer token.
Request
Responses
- 200
- 401
- 403
- 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.
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.