Get financial overview | Open Ledger Documentation

curl -G https://api-staging.openledger.com/v1/reports/overview \
     -H "Authorization: Bearer <token>" \
     -d entityId=entityId

{
  "monthlyRevenue": [
    [
      "string"
    ]
  ],
  "monthlyExpenses": [
    [
      "string"
    ]
  ],
  "monthlyProfit": [
    [
      "string"
    ]
  ],
  "monthlyCashBalance": [
    [
      "string"
    ]
  ],
  "totalRevenue": 1.1,
  "totalExpenses": 1.1,
  "totalProfit": 1.1,
  "currentCashBalance": 1.1,
  "chartData": [
    {
      "date": "string",
      "Revenue": 1.1,
      "Expenses": 1.1,
      "Profit": 1.1,
      "value": 1.1
    }
  ],
  "latestMonthStats": {
    "revenue": 1.1,
    "expenses": 1.1,
    "profit": 1.1,
    "revenueChange": 1.1,
    "expensesChange": 1.1,
    "profitChange": 1.1
  },
  "plaidAccounts": [
    {
      "account_id": "string",
      "balances": {
        "available": 1.1,
        "current": 1.1,
        "iso_currency_code": "string",
        "limit": 1.1,
        "unofficial_currency_code": "string"
      },
      "holder_category": "string",
      "mask": "string",
      "name": "string",
      "official_name": "string",
      "subtype": "string",
      "type": "string"
    }
  ],
  "filterInfo": {
    "statusFilter": "posted",
    "dateRange": {
      "startDate": "2024-01-15T09:30:00Z",
      "endDate": "2024-01-15T09:30:00Z"
    },
    "interval": "daily"
  }
}

Retrieves a high-level overview of financial data including balances, trends, and key metrics

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

entityIdstringRequired

The ID of the entity to get the overview for

startDatestringOptionalformat: "date-time"

Start date for the report period

endDatestringOptionalformat: "date-time"

End date for the report period (defaults to current date)

intervalenumOptionalDefaults to monthly

Time interval for aggregating data

Allowed values:

statusFilterenumOptionalDefaults to posted

Filter transactions by their status

Allowed values:

Response

Financial overview retrieved successfully

monthlyRevenuelist of lists of strings or doubles

Monthly revenue data points [month, amount]

monthlyExpenseslist of lists of strings or doubles

Monthly expenses data points [month, amount]

monthlyProfitlist of lists of strings or doubles

Monthly profit data points [month, amount]

monthlyCashBalancelist of lists of strings or doubles

Monthly cash balance data points [month, amount]

totalRevenuedouble

Total revenue for the period

totalExpensesdouble

Total expenses for the period

totalProfitdouble

Total profit for the period

currentCashBalancedouble

Current cash balance across all accounts

chartDatalist of objects

Data formatted for charts

latestMonthStatsobject

plaidAccountslist of objects

Connected Plaid accounts

filterInfoobject

Errors

400

Bad Request Error

404

Not Found Error

500

Internal Server Error