Get Supplier Cash-Flow Proof
GET/api/reporting/irr/suppliers/:supplier/cash-flows
The full proof behind a supplier's pooled return: the pooled metrics, a monthly cash-flow shape (money-in/out + running cumulative for charts), the dated cash-flow ledger (every flow the MIRR is solved on, each linked to its source document), and a per-purchase-order contribution breakdown.
Authentication: 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.