Appearance
Engagifii Revenue API Documentation
Overview
The Engagifii Revenue API is a comprehensive microservice designed for managing financial operations, revenue recognition, invoicing, payments, and subscription management. This RESTful API provides enterprise-grade capabilities for handling complex billing scenarios, credit management, and financial reporting.
Key Features
- Invoice Management: Create, manage, and track invoices with comprehensive billing workflows
- Payment Processing: Support for multiple payment methods including credit cards, ACH, and cash
- Subscription Management: Handle recurring billing, subscription tiers, and addon management
- Credit Note System: Issue and manage credit notes for refunds and adjustments
- Revenue Recognition: Automated revenue recognition and financial reporting
- Multi-tenant Architecture: Secure isolation of data across different tenants
- QuickBooks Integration: Seamless synchronization with QuickBooks accounting software
- Batch Processing: Efficient handling of bulk operations for invoices and payments
Quick Start
Get up and running with the Revenue API in under 30 minutes:
- Obtain API Credentials: Contact your account manager for API access credentials
- Set Headers: Configure required headers (
api-version,tenant-code) - Authenticate: Follow the authentication guide
- Make Your First Call: Test connectivity with a simple GET request
- Explore Endpoints: Review the API reference for available operations
Base URLs
| Environment | URL |
|---|---|
| Production | https://engagifii-prod-revenue.azurewebsites.net |
| Staging | Contact support for staging environment access |
| Development | Contact support for development environment access |
API Versioning
The Revenue API uses URL-based versioning to ensure backward compatibility:
- Current Version:
1.0 - Version Header:
api-version: 1.0 - URL Pattern:
/api/{api-version}/[controller]/[action]
Required Headers
All API requests must include these headers:
| Header | Description | Example |
|---|---|---|
api-version | API version number | 1.0 |
tenant-code | Your unique tenant identifier | YOUR_TENANT_CODE |
Authorization | Bearer token for authentication | Bearer YOUR_TOKEN |
Content-Type | Request content type | application/json |
Available Resources
The Revenue API provides access to the following resource categories:
Core Financial Operations
- Invoices - Invoice creation, management, and tracking
- Payments - Payment processing and reconciliation
- Credit Notes - Credit management and refunds
- Refunds - Refund processing and tracking
Subscription & Billing
- Subscriptions - Subscription lifecycle management
- Subscription Addons - Additional services and features
- Membership Management - Member billing and tracking
Configuration & Settings
- Account Codes - Chart of accounts management
- Payment Terms - Payment term configuration
- Tax Settings - Tax rate and rule management
Reporting & Analytics
- Reports - Financial and operational reports
- Revenue Recognition - Revenue tracking and reporting
- Transaction Activity - Audit trails and logs
Integration
- QuickBooks Integration - Accounting system sync
- Webhook Notifications - Real-time event notifications
Quick Links
- API Reference - Complete endpoint documentation
- Getting Started Guide - Step-by-step integration tutorial
- Authentication - Security and authentication details
- Data Models - Request/response schemas
- Error Handling - Error codes and troubleshooting
- Quick Reference - Common operations cheat sheet
- Postman Collection - Import ready-to-use requests
- OpenAPI Specification - Complete API specification
Integration Tools
Postman Collection
Download our Postman collection for quick testing and exploration of all endpoints.
OpenAPI Specification
Access the complete OpenAPI 3.0 specification for code generation and documentation tools.
SDKs and Libraries
While we don't provide official SDKs, the OpenAPI specification can be used with various code generation tools:
Support & Resources
Getting Help
- Technical Support: support@engagifii.com
- API Status: Check system status at our status page
- Bug Reports: Submit issues through your support portal
- Feature Requests: Contact your account manager
Response Times
- Critical Issues (Production Down): < 1 hour
- High Priority: < 4 hours
- Normal Priority: < 24 hours
- Low Priority: < 48 hours
Rate Limiting
To ensure fair usage and system stability:
| Tier | Requests/Minute | Requests/Hour | Requests/Day |
|---|---|---|---|
| Standard | 60 | 1,000 | 10,000 |
| Professional | 120 | 5,000 | 50,000 |
| Enterprise | Custom | Custom | Custom |
Rate limit headers are included in all responses:
X-RateLimit-Limit: Maximum requests allowedX-RateLimit-Remaining: Requests remaining in current windowX-RateLimit-Reset: Unix timestamp when limit resets
Security
The Revenue API implements multiple security layers:
- TLS 1.2+: All communications encrypted
- OAuth 2.0: Industry-standard authentication
- API Keys: Additional layer for service-to-service communication
- IP Whitelisting: Available for enterprise customers
- Audit Logging: Complete audit trail of all operations
Compliance
The Revenue API adheres to:
- PCI DSS for payment card data
- SOC 2 Type II certification
- GDPR compliance for EU data
- CCPA compliance for California residents
Changelog
Stay updated with API changes:
- API Changelog - Version history and updates
- Migration Guides - Upgrade instructions
- Deprecation Notices - Upcoming changes
Legal
© 2024 Engagifii. All rights reserved.