{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Cash Flow Insights"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"cash-flow-insights","__idx":0},"children":["Cash Flow Insights"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Beta"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Cash Flow Insights is in Beta. It follows the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v1"]}," compatibility rules -"," ","additive-only, with breaking changes reserved for a new API version - but the"," ","shape may still widen as the resource settles. See"," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/v1/versioning"},"children":["Versioning and compatibility"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These endpoints show money moving in and out of the business linked to your"," ","API Access Token. Both require the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactions:read"]}," scope."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"cash-flow-over-time","__idx":1},"children":["Cash flow over time"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v1/insights/cashflow"]}," shows how much money came in and went out over"," ","time. You can view it by day, week, or month to spot busy periods and see"," ","whether more money came in than went out."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl \"https://rhoapi.rho.co/api/v1/insights/cashflow?from=2026-05-01T00:00:00Z&to=2026-05-31T23:59:59Z&group=week\" \\\n  -H \"Authorization: Bearer $RHO_API_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["group"]}," can be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["day"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["week"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["month"]},". It defaults to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["day"]},". If you omit"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["from"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["to"]},", the response covers the last 90 days."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"buckets\": [\n    {\n      \"bucket_start\": \"2026-05-04T00:00:00Z\",\n      \"inflow_amount\": {\"amount\": 250000, \"currency\": \"USD\"},\n      \"outflow_amount\": {\"amount\": 175000, \"currency\": \"USD\"},\n      \"net_amount\": {\"amount\": 75000, \"currency\": \"USD\"}\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"largest-money-movements","__idx":2},"children":["Largest money movements"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v1/insights/money-movement"]}," shows who sent you the most money and"," ","who you paid the most. Use it to quickly find your biggest sources of income"," ","and largest payments without looking through every transaction."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl \"https://rhoapi.rho.co/api/v1/insights/money-movement?from=2026-05-01T00:00:00Z&to=2026-07-10T00:00:00Z&limit=10\" \\\n  -H \"Authorization: Bearer $RHO_API_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]}," can be from 1 to 100 and defaults to 10. It limits each list, not"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["total_in"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["total_out"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"top_inflows\": [\n    {\n      \"counterparty_name\": \"Customer A\",\n      \"total_amount\": {\"amount\": 1000000, \"currency\": \"USD\"}\n    }\n  ],\n  \"top_outflows\": [\n    {\n      \"counterparty_name\": \"Example Vendor\",\n      \"total_amount\": {\"amount\": 10306, \"currency\": \"USD\"}\n    }\n  ],\n  \"total_in\": {\"amount\": 1010000, \"currency\": \"USD\"},\n  \"total_out\": {\"amount\": 23806, \"currency\": \"USD\"}\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"reference","__idx":3},"children":["Reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Full endpoint catalogue - paths, parameters, response shapes, and required scopes - lives in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api/v1/openapi/insights"},"children":["API Reference"]},"."]}]},"headings":[{"value":"Cash Flow Insights","id":"cash-flow-insights","depth":1},{"value":"Cash flow over time","id":"cash-flow-over-time","depth":2},{"value":"Largest money movements","id":"largest-money-movements","depth":2},{"value":"Reference","id":"reference","depth":2}],"frontmatter":{"seo":{"title":"Cash Flow Insights"}},"lastModified":"2026-09-17T12:13:28.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/v1/cashflow-insights","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}