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).
OpenAPI Specification
openapi: 3.0.0
info:
title: Account Level Webhooks Book Commands Legacy Cash Flow Analytics (Deprecated) API
version: 1.0.0
servers:
- url: https://api.ocrolus.com
security:
- oauth: []
tags:
- name: Legacy Cash Flow Analytics (Deprecated)
paths:
/v1/book/summary:
get:
summary: Analytics (JSON) (Deprecated)
operationId: analytics
deprecated: true
tags:
- Legacy Cash Flow Analytics (Deprecated)
description: 'Retrieves analytics for a <<glossary:Book>> in JSON format, for use within your own application workflows.
---
> 🚧 We have a better version!
> This product was deprecated in December 2023 and has been superseded by our [new Analytics 2.0 offering](ref:book-summary), which we recommend for all new work.
> 📘 Multiple endpoints, one object
> This endpoint and [the asynchronous version](ref:async-analytics-result) return analytics objects in the same format. The [XLSX endpoint](ref:analytics-excel) logically returns most of the same information, but does not use the same schema since JSON schemas don''t apply to XLSX files. You can find a detailed reference of the returned analytics object [here](doc:analytics-type).
'
parameters:
- name: book_uuid
in: query
description: 'The unique identifier of the <<glossary:Book>> that contains the bank statements you''d like to have analyzed. Mutually exclusive with the `pk` parameter (i.e. don''t provide both).
'
schema:
type: string
format: uuid
- $ref: '#/components/parameters/pk'
- $ref: '#/components/parameters/extra_fields'
x-readme:
samples-languages:
- curl
- python
explorer-enabled: false
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
required:
- status
- message
- response
properties:
status:
type: integer
default: 200
description: 'Numerical code indicating the status of this request. Will be 200 for a successful response.
'
code:
type: integer
description: 'Numerical code indicating the nature of an error. Will not be present if the response is successful.
'
message:
type: string
default: OK
description: 'A textual description that indicates details about this response''s status. Will be "OK" for a successful request.
'
response:
$ref: '#/components/schemas/BookAnalytics'
examples:
Success:
$ref: '#/components/examples/SuccessV1AnalyticsResponse'
'400':
description: Client Errors
content:
application/json:
examples:
Book not found:
value:
status: 400
code: 1401
response: null
message: Book not found
meta:
status: 400
msg: Book not found
code: 1401
Missing Required Parameters:
value:
status: 400
code: 1103
response: null
message: Required pk or book uuid
meta:
status: 400
msg: Required pk or book uuid
code: 1103
No Permission:
value:
status: 400
code: 2102
response: null
message: No permission to access this book
meta:
status: 400
msg: No permission to access this book
code: 2102
AnalyticsNotSupportError:
$ref: '#/components/examples/AnalyticsNotSupportError'
AnalyticsOnlySupportBankStatementsError:
$ref: '#/components/examples/AnalyticsOnlySupportBankStatementsError'
schema:
oneOf:
- title: Book not found
type: object
properties:
status:
type: integer
description: A numerical code that indicates the status of the request.
example: 400
code:
type: integer
description: A numerical code that indicates the nature of an error.
example: 1401
response:
type: object
description: An object received from the server that potentially contains data.
example: null
message:
type: string
default: OK
description: A textual description that indicates details about this response's status.
example: Book not found
meta:
type: object
description: An object received from the server that potentially contains information about the request.
properties:
status:
type: integer
description: A numerical code that indicates the status of the request.
example: 400
message:
type: string
description: A textual description that indicates details about this response's status.
example: Book not found
code:
type: integer
example: 1401
description: A numerical code that indicates the nature of an error.
- title: Missing Required Parameter
type: object
properties:
status:
type: integer
example: 400
description: A numerical code that indicates the status of the request.
code:
type: integer
example: 1103
description: A numerical code that indicates the nature of an error.
response:
type: object
example: null
description: An object received from the server that potentially contains data.
message:
type: string
example: Required pk or book uuid
description: A textual description that indicates details about this response's status.
meta:
type: object
description: An object received from the server that potentially contains information about the request.
properties:
status:
type: integer
example: 400
description: A numerical code that indicates the status of the request.
msg:
type: string
example: Required pk or book uuid
description: A textual description that indicates details about this response's status.
code:
type: integer
example: 1103
description: A numerical code that indicates the nature of an error.
- title: No Permission
type: object
properties:
status:
type: integer
example: 400
description: A numerical code that indicates the status of the request.
code:
type: integer
example: 2102
description: A numerical code that indicates the nature of an error.
response:
type: object
example: null
description: An object received from the server that potentially contains data.
message:
type: string
example: No permission to access this book
description: A textual description that indicates details about this response's status.
meta:
type: object
description: An object received from the server that potentially contains information about the request.
properties:
status:
type: integer
example: 400
description: A numerical code that indicates the status of the request.
msg:
type: string
example: No permission to access this book
description: A textual description that indicates details about this response's status.
code:
type: integer
example: 2102
description: A numerical code that indicates the nature of an error.
- title: Analytics Not Supported
type: object
properties:
status:
type: integer
example: 400
description: A numerical code that indicates the status of the request.
code:
type: integer
example: 2102
description: A numerical code that indicates the nature of an error.
response:
type: object
example: null
description: An object received from the server that potentially contains data.
message:
type: string
example: No permission to access this book
description: A textual description that indicates details about this response's status.
meta:
type: object
description: An object received from the server that potentially contains information about the request.
properties:
status:
type: integer
example: 400
description: A numerical code that indicates the status of the request.
msg:
type: string
example: No permission to access this book
description: A textual description that indicates details about this response's status.
code:
type: integer
example: 2102
description: A numerical code that indicates the nature of an error.
- title: Bank Statements Only
type: object
properties:
status:
type: integer
example: 400
description: A numerical code that indicates the status of the request.
code:
type: integer
example: 2102
description: A numerical code that indicates the nature of an error.
response:
type: object
example: null
description: An object received from the server that potentially contains data.
message:
type: string
example: No permission to access this book
description: A textual description that indicates details about this response's status.
meta:
type: object
description: An object received from the server that potentially contains information about the request.
properties:
status:
type: integer
example: 400
description: A numerical code that indicates the status of the request.
msg:
type: string
example: No permission to access this book
description: A textual description that indicates details about this response's status.
code:
type: integer
example: 2102
description: A numerical code that indicates the nature of an error.
/v1/book/export/xlsx/analytics:
get:
summary: Analytics (Excel) (Deprecated)
operationId: legacy-analytics-excel
deprecated: true
tags:
- Legacy Cash Flow Analytics (Deprecated)
description: 'Retrieves analytics for a <<glossary:Book>> in Excel-compatible XLSX format (not to be confused with the legacy XLS format).
---
> 🚧 We have a better version!
> This product was deprecated in December 2023 and has been superseded by our [new Analytics 2.0 offering](ref:book-summary), which we recommend for all new work.
The output of this endpoint is intended for manual review, as opposed to automated consumption by your application.
Some fields provided in the [JSON output](doc:analytics) are not listed in the XLSX output. This behavior may change in future revisions of this endpoint.
> 📘 Multiple endpoints, one object
> This endpoint returns the same information as the [JSON versions](ref:analytics), but in a different format. You can find a detailed reference of the JSON analytics object [here](doc:analytics-type), although it doesn''t strictly apply to the file returned by this endpoint.
> 🚧
> The response will have a MIME type of `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`, hence there is no JSON response schema. See [here](https://docs.google.com/spreadsheets/d/1tCjC3ZmmGWyZnF18YMfhOVFBnt_MZ_58) for an example output.
'
parameters:
- $ref: '#/components/parameters/pk'
required: true
x-readme:
samples-languages:
- curl
- python
explorer-enabled: false
responses:
'200':
description: Success
content:
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
examples:
ExampleSpreadsheet:
summary: Success
externalValue: https://docs.google.com/spreadsheets/d/1tCjC3ZmmGWyZnF18YMfhOVFBnt_MZ_58
'400':
description: Client Errors
content:
application/json:
examples:
Book not found:
value:
status: 400
code: 1401
response: null
message: Book not found
meta:
status: 400
msg: Book not found
code: 1401
Missing Required Parameters:
value:
status: 400
code: 1103
response: null
message: Required pk or book uuid
meta:
status: 400
msg: Required pk or book uuid
code: 1103
No Permission:
value:
status: 400
code: 2102
response: null
message: No permission to access this book
meta:
status: 400
msg: No permission to access this book
code: 2102
AnalyticsNotSupportError:
$ref: '#/components/examples/AnalyticsNotSupportError'
AnalyticsOnlySupportBankStatementsError:
$ref: '#/components/examples/AnalyticsOnlySupportBankStatementsError'
schema:
oneOf:
- title: Book not found
type: object
properties:
status:
type: integer
description: A numerical code that indicates the status of the request.
example: 400
code:
type: integer
description: A numerical code that indicates the nature of an error.
example: 1401
response:
type: object
description: An object received from the server that potentially contains data.
example: null
message:
type: string
default: OK
description: A textual description that indicates details about this response's status.
example: Book not found
meta:
type: object
description: An object received from the server that potentially contains information about the request.
properties:
status:
type: integer
description: A numerical code that indicates the status of the request.
example: 400
message:
type: string
description: A textual description that indicates details about this response's status.
example: Book not found
code:
type: integer
example: 1401
description: A numerical code that indicates the nature of an error.
- title: Missing Required Parameter
type: object
properties:
status:
type: integer
example: 400
description: A numerical code that indicates the status of the request.
code:
type: integer
example: 1103
description: A numerical code that indicates the nature of an error.
response:
type: object
example: null
description: An object received from the server that potentially contains data.
message:
type: string
example: Required pk or book uuid
description: A textual description that indicates details about this response's status.
meta:
type: object
description: An object received from the server that potentially contains information about the request.
properties:
status:
type: integer
example: 400
description: A numerical code that indicates the status of the request.
msg:
type: string
example: Required pk or book uuid
description: A textual description that indicates details about this response's status.
code:
type: integer
example: 1103
description: A numerical code that indicates the nature of an error.
- title: No Permission
type: object
properties:
status:
type: integer
example: 400
description: A numerical code that indicates the status of the request.
code:
type: integer
example: 2102
description: A numerical code that indicates the nature of an error.
response:
type: object
example: null
description: An object received from the server that potentially contains data.
message:
type: string
example: No permission to access this book
description: A textual description that indicates details about this response's status.
meta:
type: object
description: An object received from the server that potentially contains information about the request.
properties:
status:
type: integer
example: 400
description: A numerical code that indicates the status of the request.
msg:
type: string
example: No permission to access this book
description: A textual description that indicates details about this response's status.
code:
type: integer
example: 2102
description: A numerical code that indicates the nature of an error.
- title: Analytics Not Supported
type: object
properties:
status:
type: integer
example: 400
description: A numerical code that indicates the status of the request.
code:
type: integer
example: 2102
description: A numerical code that indicates the nature of an error.
response:
type: object
example: null
description: An object received from the server that potentially contains data.
message:
type: string
example: No permission to access this book
description: A textual description that indicates details about this response's status.
meta:
type: object
description: An object received from the server that potentially contains information about the request.
properties:
status:
type: integer
example: 400
description: A numerical code that indicates the status of the request.
msg:
type: string
example: No permission to access this book
description: A textual description that indicates details about this response's status.
code:
type: integer
example: 2102
description: A numerical code that indicates the nature of an error.
- title: Bank Statements Only
type: object
properties:
status:
type: integer
example: 400
description: A numerical code that indicates the status of the request.
code:
type: integer
example: 2102
description: A numerical code that indicates the nature of an error.
response:
type: object
example: null
description: An object received from the server that potentially contains data.
message:
type: string
example: No permission to access this book
description: A textual description that indicates details about this response's status.
meta:
type: object
description: An object received from the server that potentially contains information about the request.
properties:
status:
type: integer
example: 400
description: A numerical code that indicates the status of the request.
msg:
type: string
example: No permission to access this book
description: A textual description that indicates details about this response's status.
code:
type: integer
example: 2102
description: A numerical code that indicates the nature of an error.
/v1/book/analytics/async/request:
post:
summary: Async Analytics Request (Deprecated)
operationId: async-analytics-request
deprecated: true
tags:
- Legacy Cash Flow Analytics (Deprecated)
description: 'Request analytics for a <<glossary:Book>> to be computed behind the scenes. You''ll be notified when they''re ready.
---
> 🚧 We have a better version!
> This product was deprecated in December 2023 and has been superseded by our [new Analytics 2.0 offering](ref:book-summary), which we recommend for all new work.
You can retrieve the results when they''re ready by [registering a webhook](doc:registering-webhook-endpoint) that listens for the `ANALYTICS_COMPLETED` event. You can also poll the [Async Analytics Result endpoint](ref:async-analytics-result) regularly if you don''t mind exchanging precision for simplicity.
> 📘 Multiple endpoints, one object
> The [asynchronous results endpoint](ref:async-analytics-result) and [the synchronous version](ref:analytics) return analytics objects in the same format. The [XLSX endpoint](ref:analytics-excel) logically returns most of the same information, but does not use the same schema since JSON schemas don''t apply to Excel files. You can find a detailed reference of the returned analytics object [here](doc:analytics-type).
'
requestBody:
content:
application/json:
schema:
type: object
required:
- pk
properties:
pk:
$ref: '#/components/schemas/pk'
extra_fields:
$ref: '#/components/schemas/ExtraFields'
x-readme:
samples-languages:
- curl
- python
explorer-enabled: false
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
status:
type: integer
description: 'Numerical code indicating the status of this request.
'
example: 200
message:
type: string
description: 'A textual description that indicates details about this response''s status.
'
example: OK
response:
properties:
analytics_request_id:
type: string
format: uuid
description: 'A unique identifier for this analytics request. Provide it to the [Result](ref:async-analytics-result) endpoint to retrieve the results.
'
examples:
Success:
summary: Successful Request
description: Successful request for async analytics
value:
status: 200
message: OK
response:
analytics_request_id: e2b1051e-570a-43ba-8104-1bcc0a3ad2a0
'400':
description: Client Errors
content:
application/json:
examples:
Book not found:
value:
status: 400
code: 1401
response: null
message: Book not found
meta:
status: 400
msg: Book not found
code: 1401
Missing Required Parameters:
value:
status: 400
code: 1103
response: null
message: Required pk
meta:
status: 400
msg: Required pk
code: 1103
No Permission:
value:
status: 400
code: 2102
response: null
message: No permission to access this book
meta:
status: 400
msg: No permission to access this book
code: 2102
AnalyticsNotSupportError:
$ref: '#/components/examples/AnalyticsNotSupportError'
AnalyticsOnlySupportBankStatementsError:
$ref: '#/components/examples/AnalyticsOnlySupportBankStatementsError'
schema:
oneOf:
- title: Book not found
type: object
properties:
status:
type: integer
description: A numerical code that indicates the status of the request.
example: 400
code:
type: integer
description: A numerical code that indicates the nature of an error.
example: 1401
response:
type: object
description: An object received from the server that potentially contains data.
example: null
message:
type: string
default: OK
description: A textual description that indicates details about this response's status.
example: Book not found
meta:
type: object
description: An object received from the server that potentially contains information about the request.
properties:
status:
type: integer
description: A numerical code that indicates the status of the request.
example: 400
message:
type: string
description: A textual description that indicates details about this response's status.
example: Book not found
code:
type: integer
example: 1401
description: A numerical code that indicates the nature of an error.
- title: Missing Require
# --- truncated at 32 KB (2018 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ocrolus/refs/heads/main/openapi/ocrolus-legacy-cash-flow-analytics-deprecated-api-openapi.yml