Entity Management
The entity management endpoints allow you to create, retrieve, update, and delete entities in your Open Ledger account. An entity represents a financial entity (like a company or organization) that you want to manage accounting data for.
Entity Object
An entity in Open Ledger represents a financial entity with the following structure:
Create an Entity
Create a new entity in your Open Ledger account.
Request Body
Response
Get Entity Details
Retrieve entity details. You can get a specific entity by ID or all entities for a developer.
Query Parameters
Response - Single Entity
When entityId
is provided:
Response - Multiple Entities
When entityId
is omitted (paginated):
Update an Entity
Update an existing entity.
Query Parameters
Request Body
You only need to include the fields you want to update.
Response
Delete an Entity
Delete an entity by ID. This is a permanent operation and cannot be undone.
Deleting an entity will also delete all associated data, including accounts, transactions, and reports. This action cannot be undone.
Query Parameters
Response
Authentication
All entity management endpoints require a valid JWT token. Include it in the Authorization header:
You can generate a token using the Authentication API.
Error Handling
Example error response:
Next Steps
Now that you understand how to manage entities, you can explore other areas of the API: