Getting Started

Quickstart

Get up and running with Open Ledger in minutes.

Prerequisites:
  • Node.js v16+ for React integration
  • React v18+ for React Hooks
  • Package manager (npm, yarn, or pnpm)
  • Open Ledger account with API credentials
1

Request an API Key

Contact our team at openledger.com/contact to request API credentials for your integration.

Your API secret will only be provided once. Make sure to store it securely. If lost, you’ll need to contact us for a new key.

Open Ledger provides different environments for development and production:

EnvironmentBase URLPurpose
Staginghttps://api-staging.openledger.comPre-production testing with your actual data
Productionhttps://api.openledger.comLive production environment
2

Create Your First Entity

An “entity” in Open Ledger represents a set of financial records for your business:

  1. From your dashboard, click Add New Entity
  2. Specify your fiscal year start date (often January 1)
  3. Select your base currency (USD, EUR, GBP, etc.)
  4. Choose an industry-specific template for your chart of accounts
3

Testing API Endpoints

We provide a Postman collection that you can import to quickly get started:

  1. Download the Open Ledger API Postman Collection
  2. Import the collection into Postman
  3. Create an environment with your API credentials
  4. Start testing the endpoints

Next Steps

Now that you’ve implemented Open Ledger, explore these resources to enhance your integration:

Install the React SDK

Set up Open Ledger’s React SDK

Core Concepts

Learn core accounting concepts

Support

For enterprise support and custom integrations, please contact our sales team.