Generate financial reports | Open Ledger Documentation

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

{
  "reportPeriod": {
    "month": 1,
    "year": 1,
    "startDate": "2024-01-15T09:30:00Z",
    "endDate": "2024-01-15T09:30:00Z"
  },
  "balanceSheet": {
    "hierarchical": {
      "assets": [
        "string"
      ],
      "liabilities": [
        "string"
      ],
      "equity": [
        "string"
      ],
      "totals": {
        "totalAssets": 1.1,
        "totalLiabilities": 1.1,
        "totalEquity": 1.1,
        "liabilitiesAndEquity": 1.1
      }
    },
    "totalCurrentAssets": 1.1,
    "totalNonCurrentAssets": 1.1,
    "totalAssets": 1.1,
    "totalCurrentLiabilities": 1.1,
    "totalNonCurrentLiabilities": 1.1,
    "totalLiabilities": 1.1,
    "totalEquity": 1.1,
    "liabilitiesAndEquity": 1.1
  },
  "incomeStatement": {
    "hierarchical": {
      "revenue": [
        "string"
      ],
      "expenses": [
        "string"
      ],
      "totals": {
        "totalRevenue": 1.1,
        "totalExpenses": 1.1,
        "netIncome": 1.1
      }
    },
    "revenue": 1.1,
    "expenses": 1.1,
    "grossProfit": 1.1,
    "operatingIncome": 1.1,
    "incomeBeforeTax": 1.1,
    "netIncome": 1.1
  },
  "cashFlowStatement": {
    "hierarchical": {
      "operatingActivities": {
        "netIncome": 1.1,
        "adjustments": {
          "depreciation": 1.1,
          "changeInAccountsReceivable": 1.1,
          "changeInInventory": 1.1,
          "changeInAccountsPayable": 1.1,
          "changeInAccruedLiabilities": 1.1
        }
      },
      "investingActivities": {
        "purchaseOfFixedAssets": 1.1,
        "purchaseOfInvestments": 1.1,
        "saleOfInvestments": 1.1
      },
      "financingActivities": {
        "proceedsFromDebt": 1.1,
        "repaymentOfDebt": 1.1,
        "issuanceOfStock": 1.1,
        "dividendsPaid": 1.1
      },
      "totals": {
        "totalOperatingActivities": 1.1,
        "totalInvestingActivities": 1.1,
        "totalFinancingActivities": 1.1,
        "netChangeInCash": 1.1
      }
    },
    "netCashFromOperatingActivities": 1.1,
    "netCashFromInvestingActivities": 1.1,
    "netCashFromFinancingActivities": 1.1,
    "netChangeInCash": 1.1
  },
  "reconciliation": {
    "plaidAccountsTotal": 1.1,
    "ledgerCashBalance": 1.1,
    "difference": 1.1,
    "plaidAccounts": [
      "string"
    ]
  },
  "accountHierarchy": [
    "string"
  ],
  "pdf_urls": {
    "profit_loss": "string",
    "balance_sheet": "string",
    "cash_flow": "string"
  }
}

Generates comprehensive financial statements for an entity, including balance sheet, income statement, and cash flow statement

Authentication

AuthorizationBearer

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

Query parameters

entityIdstringRequired

The ID of the entity to generate reports for

monthintegerOptional1-12

Month number (1-12) for the report period

yearintegerOptional

Year for the report period (e.g., 2024)

startDatestringOptionalformat: "date-time"

Start date for filtering transactions (ISO 8601 format)

endDatestringOptionalformat: "date-time"

End date for filtering transactions (ISO 8601 format, defaults to current date)

typeenumOptional

Type of report to generate

Allowed values:

ledgerIdstringOptional

Optional ledger ID (if not provided, will use entityId)

Response

Reports generated successfully

reportPeriodobject

balanceSheetobject

incomeStatementobject

cashFlowStatementobject

reconciliationobject

accountHierarchylist of any

Hierarchical structure of all accounts

pdf_urlsobject

Errors

400

Bad Request Error

404

Not Found Error

500

Internal Server Error