Skip to main content

Shumoul Developer Portal

Build enterprise applications on the Shumoul Cloud Platform.

APIs, Frameworks, SDKs, integration guides and technical documentation for building enterprise business solutions on the Shumoul Cloud Platform.

0
Frameworks Published
0
API Endpoints
0
Documentation Pages
0
Architecture Docs

Automatically generated from the documentation repository.

Press Ctrl+K to search everything

Official Frameworks

Every framework module in the Shumoul Cloud ERP platform, documented the same way.

Notification Framework

Production Ready

Multi-channel notification, delivery, retry, and campaign engine โ€” Email, SMS, WhatsApp, Push, SignalR, and In-App.

Status
Production Ready
Documentation
Official Developer Guide
Version
Latest

Background Jobs Framework

Production Ready

Generic, host-agnostic recurring-job execution runtime โ€” scheduling, tenant context, distributed locking, and failure classification.

Status
Production Ready
Documentation
Official Developer Guide
Version
Latest

WhatsApp Integration

Production Ready

Meta Cloud API v1.0.1 โ€” standalone provider library for WhatsApp messaging, webhooks, and templates, consumed by the ERP Inbox and Communication modules.

Status
Production Ready
Documentation
Official Developer Guide
Version
Latest

E-Invoicing Framework

Production Ready

ZATCA Phase 2 (Fatoora) e-invoicing SDK โ€” UBL 2.1 generation, XAdES/ECDSA signing, QR/TLV encoding, OTP-based onboarding, and clearance/reporting submission.

Status
Production Ready
Documentation
Official Developer Guide
Version
Latest

Payments Framework

Coming Soon

Payment processing and reconciliation.

Identity Framework

Coming Soon

Authentication, authorization, and permissions.

Multi-Tenancy Framework

Coming Soon

Tenant isolation, provisioning, and shared/dedicated database routing.

Quick Start

Three steps from zero to integrated.

01

Pick a framework

Start from the Frameworks index โ€” each module is self-contained, with its own architecture, packages, and API reference.

02

Read the architecture

Understand how the module fits the platform's Clean Architecture and Framework First conventions before writing any code.

03

Call the API

Every framework ships a complete API reference with real request/response examples โ€” REST endpoints or public .NET types, documented the same way.

Architecture

Every Shumoul framework follows the same Clean Architecture layering and the same Framework First principle โ€” Contracts โ†’ Abstractions โ†’ Core โ†’ Adapters, with no circular dependencies and no leaked ERP types.

Platform Architecture โ†’

APIs

A cross-framework API index โ€” 120 documented REST actions for the Notification Framework, 36 documented public .NET types for the Background Jobs Framework, with real request/response examples throughout and generated OpenAPI references prepared for future frameworks.

APIs Overview โ†’

Latest Releases

v1.2 โ€” 2026-07-04

Official Shumoul brand identity applied platform-wide โ€” the same logo, colors, and typography as platform.shumoul.com, dark mode as the primary experience, and a documented brand system at /docs/branding.

Developer Resources

Use the search box in the navigation bar to find anything on this portal instantly โ€” every page, every API endpoint, every code sample is indexed.