Skip to content

Admin Namespace

The Admin namespace provides full administrative access to all ERPax resources. Administrators can manage all aspects of the system including invoices, addresses, items, accounting, users, domains, and more.

Base Path: /admin
Access Level: Full administrative access

Overview

The Admin namespace is the primary interface for managing all ERPax resources. It provides complete control over business operations, accounting, inventory, catalog, and system administration.

See also: Platform Overview for a comprehensive introduction to ERPax's unified document model and API architecture.

Key Features

  • Complete Resource Access: Full access to all ERPax resources
  • Multi-Tenant Management: Manage domains, users, and tenant-specific resources
  • Business Operations: Complete control over invoices, addresses, items, payments
  • Accounting Integration: Full access to accounting resources and reports
  • System Administration: Manage users, domains, integrations, and system settings

Core Business Resources

Invoices

Complete invoice management including sales invoices, purchase orders, quotations, bills, credit notes, and debit notes.

Addresses

Business partner management including customers, suppliers, sellers, buyers, and other business entities.

Items

Product and inventory management with pricing, stock tracking, and accounting integration.

Payments

Payment tracking and management for invoices and transactions.

Accounting Resources

Accounting

Complete accounting management including chart of accounts, double-entry transactions, and accounting entries.

Catalog Resources

Catalog

Complete product catalog management including products, properties, property types, and product-property associations.

System Resources

Domains

Multi-tenant domain management for business isolation and configuration.

Users

User account management with authentication, roles, and access control.

User Logs

User activity and system log tracking.

Supporting Resources

Sales Agreements

Sales agreement management for contracts and terms.

Resources

Inventory resource tracking for sourceable and usable resources.

Item Transfers

Inventory transfer management between locations.

Reports

Business intelligence and reporting including sales reports, daily sales, usage reports, and accounting turnover reports.

Integrations

External system integration management.

Web Pages

Content management for web pages and public content.

Comments

Comment and annotation management.

Common Operations

All resources support:

  • Filtering: Use Ransack query syntax for advanced filtering
  • Scoping: Predefined scopes for common use cases
  • Batch Actions: Bulk operations on selected records
  • Custom Actions: Resource-specific member actions
  • Nested Resources: Related resources accessible via parent resources

API Examples

The Admin namespace provides a RESTful JSON API for all resources. Here are common API operations:

List Resources

For complete API patterns including Create, Update, Show, and Delete operations, see API Reference.

Multi-Tenancy

All admin resources respect multi-tenancy:

  • Data is scoped to the current domain
  • Resources are isolated by domain
  • Users can only access their domain's data

Released under an open source license.