Legacy Cash Flow Analytics (Deprecated)

Analytics (Excel) (Deprecated)

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, 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 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, but in a different format. You can find a detailed reference of the JSON analytics object here, 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 for an example output.

get/v1/book/export/xlsx/analytics

Request

  • Base URL
    https://api.ocrolus.com
  • URL
    https://api.ocrolus.com/v1/book/export/xlsx/analytics
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.ocrolus.com/oauth/token

Query parameters

pkinteger

The <glossary:PK> of the <glossary:Book> that contains the bank statements you'd like to have analyzed.

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.