How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ocrolus Legacy Cash Flow Analytics (Deprecated) API

The Legacy Cash Flow Analytics (Deprecated) API from Ocrolus — 4 operation(s) for legacy cash flow analytics (deprecated).

Ocrolus Legacy Cash Flow Analytics (Deprecated) API is one of 16 APIs that Ocrolus publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Legacy Cash Flow Analytics (Deprecated). The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and rate-limit docs.

This API exposes 4 operations across 4 paths, and defines 15 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://api.ocrolus.com.

4 operations 4 paths 15 schemas 3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.ocrolus.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Ocrolus Legacy Cash Flow Analytics (Deprecated) API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth) using the clientCredentials flow. By default, every request must be authenticated.

  • oauth — OAuth 2.0 support via client credentials flow. See [here](doc:using-api-credentials) for usage information.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Legacy Cash Flow Analytics (Deprecated) 4
GET
/v1/book/summarydeprecated
Analytics (JSON) (Deprecated)
analytics 3 params → 200400
GET
/v1/book/export/xlsx/analyticsdeprecated
Analytics (Excel) (Deprecated)
legacy-analytics-excel 1 param → 200400
POST
/v1/book/analytics/async/requestdeprecated
Async Analytics Request (Deprecated)
async-analytics-request body → 200400
GET
/v1/book/analytics/async/resultdeprecated
Async Analytics Result (Deprecated)
async-analytics-result 1 param → 200400

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are BankAccountAnalytics (129 properties), PeriodAnalytics (36 properties), BookAnalytics (23 properties), Transaction (9 properties). Each schema is shown below with its type and property counts.

pk
integer
The of the that contains the bank statements you'd like to have analyzed.
EstimatedRevenueCalculationTransactionsByMonth
object
The list of credit transactions used to calculate estimated revenues grouped by category and calendar month. estimatedrevenue = all credits - revenuededucted -…
6 properties 6 required
PeriodBalanceMismatch
object
An indication of gaps between statement periods captured in the bank account.
4 properties
BookAnalytics
object
Detailed analytics computed on the requested . All monetary amounts are given in USD.
23 properties 23 required
ActivityInfo
object
A series of date ranges indicating periods of activity and inactivity in a bank account.
2 properties 2 required
BankAccountAnalytics
object
Detailed analytics computed on a particular bank account. A may contain bank statements from multiple bank accounts, therefore the Book analytics may contain m…
129 properties 90 required
AnalyticsRequestStatus
string
The current state of the asynchronous analytics request. The possible values are defined as follows: - COMPLETED: The request has completed and the resulting a…
Transaction
object
Detailed information about a specific credit or debit within a bank account.
9 properties 9 required
SuspiciousActivities
object
Suspicious activity flags. Deprecated because this represents legacy detection. We suggest using our dedicated [Suspicious Activity Flags](ref:suspicious-activ…
6 properties 6 required
EstimatedRevenueCalculationTransactions
object
The list of credit transactions that comprise the estimated revenue calculations for the business.
6 properties
Transfers
object
The list of all transfers to or from a bank account.
2 properties 2 required
ExtraFields
array
A list of extra analytics fields to include in the result. See [here](doc:extra-fields) for a full list. These fields are also listed in this documentation. Fu…
DateParts
object
An object encoding of dates in activity ranges.
3 properties 3 required
PeriodAnalytics
object
Analytics for a contiguous time period described on a bank statement. Non-contiguous periods are represented with multiple objects of this type.
36 properties 35 required
DatePartRange
object
A range of dates within activity info.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ocrolus-legacy-cash-flow-analytics-deprecated-api-openapi.yml Raw ↑

Other APIs Ocrolus publishes across the network.

Ocrolus Book Commands API
Ocrolus Book Queries API
Ocrolus Business history API
Ocrolus Business Verification (Deprecated) API
Ocrolus Capture API
Ocrolus Cash Flow Analytics API
Ocrolus Detect API
Ocrolus Encore API
Ocrolus File Uploads API
Ocrolus Income API
Ocrolus Oauth API
Ocrolus Org Level Webhooks API
Where this information came from

This is an independent, third-party profile of Ocrolus Legacy Cash Flow Analytics (Deprecated) API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.