---
title: "Get financial flow analytics"
method: GET
path: "/analytics/financial-flow"
tags: ["Analytics AI — Analytics & BI"]
---

# Get financial flow analytics

`GET /analytics/financial-flow`

## Request

- Base URL: `https://api.paperoffice.ai/latest`
- URL: `https://api.paperoffice.ai/latest/analytics/financial-flow`
- Auth: HTTP bearer

Cash-flow style analysis — money movement between business partners (Sankey-style aggregates) for the selected period. Permissions: Requires Analytics AI module access on the bearer token.

## Query parameters

- `period` '7d' | '30d' | '90d' | '365d' | 'all'

## Response `200`

Success

- object
  - `_billing` object
    - `credits` object
      - `total_monthly` integer
      - `remaining_monthly` integer
      - `credit_source` string
      - `api_handler` string
      - `tier_info` object
        - `tier` string
        - `name` string
        - `initial_credits` integer
        - `price_monthly` integer
        - `price_overage_per_credit` integer
      - `notice` string
      - `renewal_days` integer
      - `subscription_status` string
    - `job` object
      - `api_job_name` string
      - `app` string
      - `action` string
      - `default_credits` integer
      - `token` string
      - `credits_billed` integer
      - `pricing` object
        - `credits_per_unit` integer
        - `unit` string
        - `unit_count` integer
        - `addons` string
    - `requests` object
      - `limits` object
        - `second` integer
        - `minute` integer
        - `hour` integer
        - `day` integer
      - `current` object
        - `second` integer
        - `minute` integer
        - `hour` integer
        - `day` integer
      - `remaining` object
        - `second` integer
        - `minute` integer
        - `hour` integer
        - `day` integer
      - `next_possible_request_seconds` integer
    - `remaining_credits` integer
    - `total_monthly` integer
    - `account_id` integer
    - `plan` object
      - `tier` string
      - `name` string
    - `credits_billed` integer
  - `date_basis` string
  - `flow_rows` unknown[]
    - unknown
  - `has_custom_meta_keys` boolean
  - `meta_mapping` object
    - `configured` boolean
    - `ready` object
      - `amounts` boolean
      - `partners` boolean
      - `due_dates` boolean
      - `document_types` boolean
      - `location` boolean
    - `feature_ready` boolean
    - `reason` string
  - `metric_basis` string
  - `period` string
  - `processing_time` string
  - `sankey` object
    - `nodes` unknown[]
      - unknown
    - `links` unknown[]
      - unknown
  - `scope_contract` string
  - `status` string
  - `workspace_id` string
  - `workspace_scope` string

## Other responses

- `4XX`: Error
- `5XX`: Error

---

[API](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api.md) · [All operations](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/revisions/c6a6228a4509?raw)