Refresh IRR Metrics
POST/api/reporting/irr/refresh
Recompute every eligible purchase order's return metric in the background so the supplier and product IRR leaderboards reflect fresh figures. The leaderboards read these persisted metrics, so a refresh is what updates last_refreshed_at and clears any pending (not-yet-computed) purchase orders.
Runs as a background job and returns immediately. Idempotent: if a refresh is already running, started is false and no second run is queued. Requires a Bearer token with reports write access.
Request
Responses
- 200
- 401
- 403
- 422
- 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.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.