20.1 Technical Reference Index
Comprehensive technical appendices providing detailed specifications, examples, and reference materials to support implementation teams, auditors, and evaluators.
Complete index of technical reference materials organized by category
Professional Documentation Standards: All appendices follow enterprise consulting methodology with detailed cross-references and audit trails
20.2 API Documentation
Complete SmartAPI endpoint specifications with request/response examples for technical teams.
| Endpoint | Description |
|---|---|
/invoices/submit |
Submit invoice payload in canonical schema |
/invoices/status/{id} |
Retrieve clearance status |
/invoices/archive/{id} |
Download evidence bundle (payload, signature, receipt, QR) |
/invoices/replay/{id} |
Resubmit failed or pending invoices |
/reconciliation/daily |
Trigger reconciliation job and download signed report |
/reference/hs-codes |
Query or sync HS code library |
/reference/tax-codes |
Query or sync tax code mappings |
/reference/customers |
Maintain customer-TIN mappings |
Note: Full details, request/response examples, authentication headers, and error codes will be provided in a separate API Specification.
20.3 Sample Payload Transformations
Before and after examples showing how invoices are transformed from ERP formats to FIRS-compliant schemas.
Invoice Submission (Canonical JSON)
{
"invoiceNumber": "INV-2025-0001",
"supplierTIN": "12345678",
"buyerTIN": "98765432",
"issueDate": "2025-08-28",
"currency": "NGN",
"lineItems": [
{
"description": "Product A",
"quantity": 10,
"unitPrice": 1000,
"taxCode": "VAT15",
"hsCode": "1001.90.10"
}
],
"totalAmount": 11500,
"sourceSystem": "SAP_ECC"
}Clearance Response
{
"status": "CLEARED",
"irn": "IRN-XYZ-2025",
"qrCode": "base64-encoded-qr-string",
"signature": "PKCS7-digital-signature",
"timestamp": "2025-08-28T14:12:00Z"
}20.4 Connector Configuration Rules
Detailed configuration specifications for Email Connector and BlueBox capture technology.
- Accepted formats: PDF, XML, CSV, ZIP bundles Supported
- Subject line optional, body ignored
- Rejected attachments returned with structured error message
- Clearance receipts attached to reply email as PDF/XML
- Inbound invoices (received from customers) routed back to client distribution list
20.5 Deployment Guides
Step-by-step deployment procedures for different enterprise scenarios and environments.
- Install capture agent on Windows or Linux server
- Configure printer spooler redirection or folder watcher
- Define parsing rules (file naming, document recognition)
- Secure HTTPS connection to SmartAPI configured with certificate
- Monitor via local dashboard and central SmartAPI logs
20.6 Glossary of Terms
Comprehensive glossary of technical and regulatory terms used throughout the proposal.
- IRN
- Invoice Reference Number – Unique identifier generated by FIRS for every cleared invoice
- QR Code
- Machine-readable code linking to FIRS record of the invoice
- TIN
- Taxpayer Identification Number – Unique identifier for businesses registered with FIRS
- HS Code
- Harmonized System classification for goods
- UBL
- Universal Business Language – XML schema standard for e-invoicing
- SIT
- System Integration Testing – Phase of testing where system components are validated together
- UAT
- User Acceptance Testing – Client validation phase to confirm solution meets business needs
- RPO
- Recovery Point Objective – Maximum acceptable data loss measured in time
- RTO
- Recovery Time Objective – Maximum acceptable downtime to restore service
- WORM
- Write Once, Read Many – Immutable storage method preventing tampering
20.7 Compliance Evidence Structure
Detailed breakdown of audit evidence bundles and compliance documentation structure.
Each archived invoice record contains:
- ✓ Canonical JSON payload
- ✓ Signed submission file
- ✓ FIRS clearance receipt with IRN and QR
- ✓ Digital signature for integrity and non-repudiation
- ✓ Audit log extract (submission, clearance, error events)
- ✓ Reconciliation report references
20.8 Contact Matrix
Support escalation procedures and contact information for different phases of the project lifecycle.
Project Phase Contacts
- Onboarding Manager – Primary liaison for project setup
- Solution Architect – Integration and mapping oversight
- Finance Liaison – Finance workflows, reconciliation, training
- Compliance Lead – Regulator alignment, evidence bundles
- Support Desk – 24x7 SLA-backed incident management
Escalation Paths
| Level 1: | Client IT and Finance analysts |
| Level 2: | Softrust Integration Engineers |
| Level 3: | Bluelight SmartAPI Operations |
| Level 4: | FIRS regulator contact (as last resort) |
20.9 Complete Diagram Reference Index
Comprehensive list of all technical diagrams included throughout the FIRS Nigeria E-Invoicing proposal, organized by section.
| Diagram Name | Section | Purpose & Description |
|---|---|---|
| Solution Landscape Overview | Section 1 | High-level architecture showing SmartAPI, BlueInvoice, Email Connector, BlueBox integration |
| Product Suite Decision Matrix | Section 2 | Comparison matrix helping enterprises choose the right e-invoicing solution |
| Compliance Lifecycle Flow | Section 3 | Step-by-step compliance process from submission to archive |
| Systems Architecture Overview | Section 4 | Technical architecture showing data flow and system components |
| Security Architecture Framework | Section 5 | End-to-end security controls, encryption, and PKI implementation |
| Data Mapping and Transformation | Section 6 | Canonical schema mapping from ERP formats to FIRS requirements |
| ERP Integration Decision Tree | Section 7 | Decision flowchart for selecting optimal integration method |
| Invoice Processing Pipeline | Section 8 | Complete invoice lifecycle from receipt to clearance |
| Monitoring Dashboard Layout | Section 9 | Real-time tracking and reconciliation interface design |
| Onboarding Process Flow | Section 10 | Step-by-step client onboarding and training methodology |
| Implementation Methodology | Section 11 | Project phases from discovery through hypercare |
| Governance Structure | Section 11 | Project governance model and escalation hierarchy |
| Scope Pyramid | Section 12 | Visual representation of project scope and deliverables |
| SmartAPI Services Lifecycle | Section 13 | API service architecture and processing flow |
| Compatibility Matrix | Section 14 | ERP system compatibility and integration requirements |
| Risk Heat Map | Section 15 | Risk likelihood vs impact analysis with mitigation strategies |
| Risk Management Cycle | Section 15 | Continuous risk monitoring and response process |
| Risk Assessment Grid | Section 15 | Structured risk evaluation framework |
| Delivery Lifecycle Timeline | Section 16 | Project delivery phases and milestone timeline |
| Cutover Timeline | Section 16 | Mission control approach to go-live cutover process |
| Testing Cycle | Section 16 | Comprehensive testing methodology and validation process |
| Operations Cycle | Section 17 | 6-stage operational lifecycle: Monitor, Detect, Respond, Resolve, Reconcile, Review |
| Incident Workflow | Section 17 | Incident management process with severity levels and escalation |
| Reconciliation Loop | Section 17 | Daily reconciliation process ensuring data integrity |
| Global Footprint | Section 18 | World map showing successful deployments across 8+ countries |
| Performance Case Study | Section 18 | High-volume processing capabilities and performance metrics |
| Requirements Traceability Matrix | Section 19 | Complete RFP requirements coverage mapping |
| Appendix Index | Section 20 | Technical reference materials organized by category |
Professional Documentation Standards: All diagrams follow enterprise consulting methodology with consistent visual hierarchy, professional color schemes, and audit-ready quality for technical evaluation teams.