ERP.net Domain API

Getting Started

1. Start from the service root.
2. Explore available entities using the Query Builder.
3. Execute GET, POST, PATCH, and DELETE requests using the Query Tool.
4. Import data using the Import Tool.
5. Inspect relationships via the metadata endpoint.
6. View detailed entity information by appending the entity name to Current Model.
7. Review full usage examples at the ERP.net Domain API documentation.

The Domain API is based on the OData v4 standard, providing full RESTful access to business objects such as Products, Customers, Orders, and more. You can use standard HTTP methods — GET, POST, PATCH, and DELETE — to query and update data.

Each entity (resource) represents a business object with defined properties and relationships. You can filter, sort, and navigate between entities using standard OData query options.

Service Root

The OData service root for this instance is:

https://demodb.my.erp.net/api/domain/odata/

All API requests start from this root. For example:

https://demodb.my.erp.net/api/domain/odata/General_Products_Products?$top=10

Model and Metadata

These endpoints describe the business model and entity structure of the current ERP.net instance. They are primarily intended for programmatic use by systems, integration tools, or AI assistants that generate applications or workflows automatically.

1. Standard Model – Lists the default entities without instance-specific extensions. The result is returned as JSON and is intended for automated consumption.
2. Current Model – Lists all entities, including custom and calculated attributes for this instance. The result is returned as JSON for programmatic use.

For detailed information about a specific entity, append the entity name to the Current Model URL. For example, to view details of the Sales Orders entity:

https://demodb.my.erp.net/api/domain/currentmodel/Crm_Sales_SalesOrders
The entity detail is returned as JSON and is intended for automated tools or AI systems that generate applications.

OData metadata for the full model is also available at: ~/domain/odata/$metadata

Documentation

Full developer documentation is available at: https://docs.erp.net/dev/domain-api/index.html

You can also browse the instance-specific API reference, which includes custom fields and calculated attributes for E1_DEMODB.

Built-in Tools

• Domain API Query Builder – Visual tool to build and test OData queries with filters, selects, and expands.
• Domain API Query Tool – Execute GET, POST, PATCH, and DELETE requests directly.
• Domain API Import Tool – Import data using the JSON Import Format.

Each executed query’s full URL appears in your browser address bar — you can copy and share it for collaboration or debugging.