Ocrolus API

Ocrolus API Documentation

Welcome to Ocrolus' API Documentation. You'll find comprehensive guides and documentation here to help you get started with the Ocrolus API. Let's jump right in!

Analytics

{

Attribute

Data Type

Description

pk

Book PKPK - PK stands for Primary Key, a unique value assigned to specific objects. A PK is used to identify an object using one of the Query Endpoints.

Book PK

name

Text

Book name

bank_accounts

List of Bank Account Analytics

List of Bank Account Analytics

average_daily_balance

Money

The average daily ending balance (including weekends).

average_daily_balance_weekday

Money

The average daily ending balance of weekdays.

average_daily_balance_by_month

Month Map

The average daily ending balance (including weekends) in a calendar month.

average_daily_balance_weekday_by_month

Month Map

The average daily balance of weekdays in a calendar month (measured at the end of each weekday).

average_by_month

Month Map

The average absolute value of all transactions in a calendar month.

average_deposit_by_month

Month Map

The average value of credit transactions in a calendar month.

estimated_revenue_by_month

Month Map

The estimated revenue of the business in a calendar month. This is calculated by summing together all credit transactions, then removing all transfer credits (except for wire transfers), all alternative lender credits (except for factoring credits), and all transactions that contain words that signify that they are not revenue deposits. This includes words such as Refund, Reversal, Cash Back, Return, and about 20 others.

}

Sample Analytics Response

{
  "status": 200, 
  "message" : "OK",
  "response": {
    "average_by_month": {
      "03/2014": "695.78",
      "04/2014": "658.02"
    },
    "average_daily_balance_weekday": "1273.91",
    "average_daily_balance_weekday_by_month": {
      "11/2016": "1279.77",
      "10/2016": "1254.76",
      "09/2016": "1229.76",
      "12/2016": "1304.78"
    },
    "pk": 10399,
    "name": "Case Size",
    "bank_accounts": [
      {
        "average_by_month": { 
          "03/2014": "695.78", 
          "04/2014": "658.02"
        },
        "average_daily_balance" : "5365.29",
      
      "average_daily_balance_weekday": "1273.91",
      "average_daily_balance_weekday_by_month": {
          "11/2016": "1279.77",
          "10/2016": "1254.76",
          "09/2016": "1229.76",
          "12/2016": "1304.78"
      },
    
        "average_deposit_by_month": { 
          "03/2014": "695.78",
          "04/2014": "658.02"
        },
        "daily_balances" : {
          "03/28/2014" : "675.88",
          "04/05/2014" : "-534.66",
          "03/29/2014" : "100.53"
        },
        "nsf_transactions": [], 
        "deposit_max_by_month": {
          "03/2014": [ 
            { 
              "amount": "1302.89", 
              "bank_account_pk": 7538,
              "bbox": [
                112,
                1600,
                2359,
                1661
              ],
              "description": "Test Description",
              "page_doc_pk": 300492,
              "page_idx": 1,
              "pk": 642713,
              "txn_date": "03/28/2014",
              "uploaded_doc_pk": 8598
            }
          ],
          "04/2014": [{...}]
        },
        "deposit_min_by_month": {
          "03/2014": [ 
            { 
              "amount": "88.66", 
              "bank_account_pk": 7538,
              "bbox": [
                112,
                1674,
                2360,
                1734
              ],
              "description": "Test Description",
              "page_doc_pk": 300492,
              "page_idx": 1,
              "pk": 642714,
              "txn_date": "03/31/2014",
              "uploaded_doc_pk": 8598
            }
          ],
          "04/2014": [{...}]
        },
        "interbank_transactions": [], 
        "name": "Test Bank Checking", 
        "minimum_balance_by_month": {
          "03/2014": "100.00",
          "04/2014": "0.00"
        },
        "negative_balances_by_month" : { 
          "03/2014": [], 
          "04/2014": []
        },

        "negative_balances_by_month_weekday": {
          "11/2016": [],
          "10/2016": [],
          "09/2016": [],
          "12/2016": []
        },
        "outside_source_deposits": [
          {
            "amount": "88.66",
            "bank_account_pk": 7538,
            "bbox": [
              112,
              1674,
              2360,
              1734
            ],
            "description": "Test Description",
            "page_doc_pk": 300492,
            "page_idx": 1,
            "pk": 642714,
            "txn_date": "03/31/2014",
            "uploaded_doc_pk": 8598
          },
          {...},
          {...},
          {...},
          {...}
        ],
        "period_balance_mismatches" : [], 
        "pk": 7538, 
        "round_number_txns": [], 
        "alternative_lender_transactions": [], 
        "total_days" : 30,
        "activity_info": {
          "active": [
            {
              "start": {
                "year": 2014,
                "month": 3
              },
              "end": {
                "year": 2014,
                "month": 4
              }
            }
          ],
          "missing": []
        },
        "book_pk": 10399,
        "account_type": "Checking" ,
        "account_category": "PERSONAL ACCOUNT",
        "account_holder": "Jane Doe",
        "account_number": "00000000",
        "holder_zip": "10005",
        "holder_state": "NY",
        "holder_city": "New York",
        "holder_address_1": "44 Wall Street" ,
        "holder_address_2": "Suite 703",
        "periods": [
          { 
            "pk" : 1050,
            "begin_date" : "03/28/2014",
            "end_date" : "04/11/2014",
            "begin_balance" : "5000.00",
            "end_balance" : "1000.00",
            "primary_recon_error_reason": "Incomplete Information",
            "secondary_recon_error_reason": "Missing page(s)",
            "period_month_days": {
              "03/2014": 2,
              "04/2014": 24
            },
            "period_month_txns": {
              "03/2014": 5,
              "04/2014": 43
            }
          }
        ],
        "average_daily_balance_by_month" : {
          "03/2014": "4410.29",
          "04/2014": "1200.82"
        },
        "estimated_revenue_by_month" : {
          "03/2014": "114410.19",
          "04/2014": "121200.42"
        }

      }
    ],
    "average_deposit_by_month": {
      "03/2014": "695.78",
      "04/2014": "658.02"
    },
    "average_daily_balance_by_month" : {
      "03/2014": "4410.29",
      "04/2014": "1200.82"
    },
    "estimated_revenue_by_month" : {
      "03/2014": "114410.19",
      "04/2014": "121200.42"
    }
  }
}

Updated 9 months ago


Analytics


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.