Documentation
Complete functional, operational, security and reviewer documentation for Al Yamamah ASP Core.

Documentation

Al Yamamah ASP Core Documentation

Full documentation for architecture, use cases, lifecycle, evidence package, operational tools, security controls, developer integration and troubleshooting.

System Design

Architecture overview

Accreditation-Ready

ERP → ASP Intake

External ERP systems submit PINT AE JSON payloads through authenticated API endpoints.

Validation Layer

The ASP validates invoice terms, UAE business rules, use-case-specific flags, totals, tax categories and mandatory fields.

XML Generation

Accepted payloads are converted into UBL/PINT AE XML evidence with trust hash and QR payload.

Lifecycle Evidence

Each accepted document receives Exchange, TDD and MLS evidence records and downloadable ZIP artifacts.

Reviewer Evidence Package

The final package contains JSON, XML, metadata, validation events, exchange jobs, TDD reports and MLS messages for all 16 use cases.

Document Lifecycle

From ERP payload to completed evidence

1
API Intake
Receive authenticated JSON payload from ERP.
2
Validation
Apply base PINT AE and use-case-specific rules.
3
XML + Trust Hash
Generate XML, calculate SHA-256 trust hash and QR payload.
4
Exchange Job
Create C2/C3 exchange evidence record.
5
TDD Report
Create tax data document reporting evidence.
6
MLS Messages
Create message level status evidence and complete lifecycle.

Coverage

Official UAE eInvoicing use cases 1–16

PASS 16/16
Case Use Case Document Type Rule / Flag Lifecycle Exchange TDD MLS Evidence
1 UAE Standard tax invoice standard_tax_invoice 00000000 completed 1 1 2 Lifecycle ZIP
2 Supply under reverse charge mechanism reverse_charge_invoice 00000000 + Reverse Charge Tax Category completed 1 1 2 Lifecycle ZIP
3 Zero rated supplies zero_rated_invoice VAT Category Z completed 1 1 2 Lifecycle ZIP
4 Deemed supply deemed_supply_invoice 01000000 completed 1 1 2 Lifecycle ZIP
5 Disclosed agent billing disclosed_agent_invoice 00000100 completed 1 1 2 Lifecycle ZIP
6 Summary tax invoice summary_tax_invoice 00010000 completed 1 1 2 Lifecycle ZIP
7 Continuous supplies continuous_supply_invoice 00001000 completed 1 1 2 Lifecycle ZIP
8 Free trade zone free_trade_zone_invoice 10000000 completed 1 1 2 Lifecycle ZIP
9 E-commerce ecommerce_invoice 00000010 completed 1 1 2 Lifecycle ZIP
10 Exports exports_invoice 00000001 completed 1 1 2 Lifecycle ZIP
11 Margin scheme margin_scheme_invoice 00100000 completed 1 1 2 Lifecycle ZIP
12 Standard tax credit note credit_note CreditNote Type 381 completed 1 1 2 Lifecycle ZIP
13 Disclosed agent billing tax credit note disclosed_agent_credit_note 00000100 + CreditNote 381 completed 1 1 2 Lifecycle ZIP
14 Commercial invoice commercial_invoice Commercial / Non-tax evidence completed 1 1 2 Lifecycle ZIP
15 Self-billing self_billing_invoice Self-billing agreement evidence completed 1 1 2 Lifecycle ZIP
16 Self-billing tax credit note self_billing_credit_note Self-billing + CreditNote 381 completed 1 1 2 Lifecycle ZIP

Operations Manual

Pages and operational responsibilities

Control Center

Dashboard

Public and admin evaluation overview.

/

Accreditation

Accreditation Center

Final PASS 16/16 dashboard, ZIP, SHA256, and evidence status.

/admin/accreditation-center

Accreditation

Readiness Matrix

Controls and readiness checklist for ASP evaluation.

/admin/accreditation-readiness

Accreditation

Use Case Coverage

Official use case coverage matrix.

/admin/use-case-coverage

Accreditation

Submission Package

Build and download evidence submission package.

/admin/accreditation-submission-package

Evidence

Documents

Accepted/rejected eInvoice documents and XML/JSON evidence.

/admin/documents

Evidence

Evidence Vault

Stored evidence artifacts and reviewer files.

/admin/evidence-vault

Evidence

Audit Ledger

Tamper-evident operational records.

/admin/audit-ledger

Operations

Exchange Center

C2/C3 exchange simulation, dispatch and status lifecycle.

/admin/exchange-center

Operations

TDD Reports

Tax data document reporting evidence.

/admin/tdd-reports

Operations

MLS Messages

Message level status evidence from C3/C5 simulation.

/admin/mls-messages

Operations

Webhooks

Signed outbound webhooks and delivery attempts.

/admin/webhooks

Operations

API Logs

Incoming API request logging and traceability.

/admin/api-logs

Security

API Clients

API keys, source-domain allowlist and client onboarding.

/admin/api-clients

Security

Onboard Client

Create and configure new API clients.

/admin/onboard-client

Security

Security Alerts

Security events and warnings.

/admin/security-alerts

System

Health Center

Runtime, database, storage and queue health checks.

/admin/health-center

System

Backups

Backup records and release evidence.

/admin/backups

System

Page Registry

Registered ASP pages and route visibility.

/admin/page-registry

System

UI Check

Unified UI visual verification.

/admin/ui-check

Security Model

Controls and trust evidence

✓ API key authentication

✓ Source tenant domain allowlist

✓ Idempotency key support

✓ Validation event logging

✓ Tamper-evident trust hash

✓ Audit ledger evidence

✓ Redacted operational logs

✓ Admin-only operational pages

Submission Package

Final evidence ZIP and SHA256

Download ZIP

SHA256

0466feccaea714774b38f5d5993799386360c5b061929b865c19b760f9c14626

Download SHA256 file

Support

Troubleshooting guide

Problem Fix
401 Unauthorized Check X-ASP-API-KEY and active API client status.
403 Source domain not allowed Add source domain to API client allowlist.
422 Validation failed Review errors array, missing business terms, totals, tax breakdown or BTUAE flags.
Lifecycle not completed Run lifecycle simulation or inspect Exchange/TDD/MLS records.
Sample not found Submit one accepted document or rebuild final submission package.