Platform Documentation
Welcome to the SBL Invoice Platform documentation. This guide is organized into clear sections for developers, admins, and managers. Each section explains how to use and configure the platform's features, with practical steps and screenshots (add your own where indicated).
Getting Started
- Sign Up: Register with your email and verify your account.
- Login: Use your credentials to access the dashboard.
- Organization Creation: The first user becomes the admin of a new organization.
User Roles & Access
- Admin: Full access to all features, settings, and team management.
- Member: Limited access, as defined by the admin.
- Role Management: Admins can promote/demote users and set permissions.
Organization Setup
- Profile: Set organization name, industry, address, and branding.
- Subscription: Choose between Free and Pro plans.
- Storage: View and manage storage usage.
Helpful Tip
- Set your organization's contact email for payment confirmations.
- Add your bank details if you want customers to pay via transfer.
Payments & Integrations
- Setup: Enter your payment provider keys in Settings > Payment Integration.
- Test Mode: Toggle test/live mode for safe testing.
- Verification: Click "Test Connection" to verify your setup.
- Receiving Payments: Each organization's keys are used for their own payments. All payments go directly to your account.
- Webhook: The platform uses a single webhook endpoint. Payments are routed to the correct organization using metadata.
Helpful Tip
- Ensure your payment integration is enabled and configured before sending invoices.
- If a payment fails, check that your Paystack/Stripe/Coinbase keys are correct and active.
- For manual payments, always confirm with a receipt and mark the invoice as paid.
Invoices & Receipts
- Create Invoice: Fill in client details, services, and amounts.
- Send Invoice: Email invoices directly to clients.
- Receive Payment: Clients can pay online (if enabled) or via bank transfer.
- Mark as Paid: Payments are automatically verified via webhook or can be marked manually.
- Receipts: Generate and send receipts for completed payments.
Helpful Tip
- Free plan users can only create up to 15 invoices per month. Upgrade to Pro for unlimited invoices.
- Always double-check client email and amount before sending an invoice.
Documents & Storage
- Upload & Manage Documents: Upload, download, and organize files (PDF, DOCX, CSV, XLSX, TXT, images) for your organization. Tag documents for easy search and categorization.
- Storage Limits: Free Plan: 2GB total, 10MB per file. Pro Plan: 30GB total, 20MB per file. View your storage usage in the Documents section.
- Bulk Upload: Upload multiple files at once.
- Document Extraction: Use AI to extract data from documents (Pro feature).
- Security: All files are stored securely and access is restricted to your organization.
Currency & Exchange Rates
- Multi-Currency Support: Invoices and receipts can be issued in NGN or USD.
- Automatic Exchange Rates: The platform fetches and updates exchange rates automatically (default: every 6 hours).
- Custom Rates: Admins can set fallback rates if the API is unavailable.
- Currency Display: Choose your preferred dashboard display currency in Settings.
Audit & Compliance
- Comprehensive Audit Trail: All key actions (invoice creation, payment, user changes, settings updates) are logged for compliance.
- ISO 21378:2019 Compliance: Audit logs follow international standards for financial and access events.
- Event Risk Scoring: Each event is assigned a risk score for compliance monitoring.
- Data Encryption: Sensitive audit data is encrypted at rest.
Notifications & Emails
- Automated Emails: Invoice and receipt delivery, payment reminders, organization invites, subscription and plan updates.
- Custom Email Templates: Admins can customize certain email templates.
- Email Verification: All users must verify their email before accessing the platform.
Security & Rate Limiting
- Access Control: JWT tokens with short expiry, role-based permissions, and IP-based rate limiting.
- Rate Limiting: Prevents abuse with limits of "100 requests per minute" for normal endpoints and "30 requests per minute" for auth endpoints.
- Session Management: Secure session handling with automatic expiry and refresh tokens.
- Data Protection: All sensitive data is encrypted at rest and in transit.
AI Features
- Document Extraction: Extract data from invoices and receipts automatically.
- Smart Email Composer: AI-powered email suggestions for client communication.
- Usage Limits: Free Plan: 10 AI operations per month. Pro Plan: 100 AI operations per month.
Troubleshooting & Support
- Common Issues: Check our troubleshooting guide for quick solutions.
- Contact Support: Email support@southbytelabs.com for assistance.
- Response Time: We aim to respond within 24 hours on business days.
Notes
- Platform Updates: Regular updates bring new features and improvements.
- Feedback: Share your feedback to help us improve the platform.
End of Documentation