Reference
Introduction to the Open Ledger API.
The Open Ledger API provides a comprehensive set of endpoints for managing your financial data. Our REST API allows you to seamlessly integrate with our platform and build custom solutions that meet your specific needs.
API Structure
Our API is organized around the following core resources:
Generate API tokens for secure access
Create and manage financial entities
Record and categorize financial transactions
Generate financial reports and statements
Connect and manage bank accounts
Connect third-party services
Access AI-powered financial insights
Test and develop with sample data
Base URL
All API requests should be made to the following base URL:
For development and testing, you can use our sandbox environment:
API Versioning
The Open Ledger API uses URL versioning. The current version is v1
. Always include the version in your API requests:
Core API Resources
Authentication
Authenticate with the Open Ledger API to receive a JWT token for API access.
Entities (Financial Entities)
Entities represent financial entities like companies or organizations.
Transactions
Transactions record financial activities between accounts.
Reports
Generate financial reports and statements.
Banks
Manage bank connections and accounts.
Integrations
Connect and manage third-party integrations.
AI Features
AI-powered analysis and tools.
Sandbox
Set up a testing environment with sample data.
Authentication
Open Ledger uses bearer token authentication. Include your JWT token in the Authorization
header:
Common Parameters
Most endpoints require a entityId
to specify which financial entity’s data you’re working with. This can be provided as a query parameter:
Pagination
List endpoints in the Open Ledger API support pagination. You can control pagination using the following query parameters:
page
: Page number to retrieve (default: 1)limit
: Number of items per page (default: 25, max: 100)
Paginated responses include metadata about the total number of items and pagination information:
API Documentation
For complete API documentation, you can refer to our: