Table of Contents

Building Apps with the Domain API

Note

Full technical documentation is available here:
Domain API Reference

The Domain API is the primary interface for integrating with ERP.net business logic.

It provides structured, object-oriented access to data and operations through the OData protocol, ensuring that all business rules, standard validation, permissions, and workflow rules are applied.

This makes it the ideal API for applications, integrations, and automation that need to interact with ERP.net in the same way as the native client does.

When to Use the Domain API

Use the Domain API when your app needs to:

  • Work with business objects such as documents, items, customers, or orders.
  • Automatically follow ERP.net business rules, validations, and relationships.
  • Create, update, or delete entities securely with full data integrity.
  • Build integrations, web apps, or backend services that extend ERP.net behavior.

It is not recommended for large-scale analytics or raw data extraction - use the Table API instead.

Technical Summary

  • Protocol: OData (v4 compliant)
  • Base URL:
    https://<instance>.my.erp.net/api/domain/
  • Authentication: OAuth 2.0 access token (Bearer)
  • Formats: JSON by default
  • Respects: Business logic, security roles, and license sessions.
Note

The Domain API automatically applies ERP.net's internal rules and triggers.
This ensures data consistency but may make it slower than raw table access - ideal for transactional integrity.

Learn More

Suggest improvement to this page