Getting Started with Fenerum API

Welcome to the Fenerum API documentation. This guide will help you get started with integrating Fenerum into your application.

Quick Start

Create an API token - Generate your authentication credentials
Make your first request - Test your API connection
Explore the API - Browse available endpoints and resources

Interactive API Explorer

Fenerum provides interactive tools to explore and test the API:

API Browser: https://app.fenerum.com/api/v1/
Swagger Console: https://app.fenerum.com/api/swagger/

The Swagger console includes a "Try it out" button on each endpoint, allowing you to make real API calls directly from your browser.

Essential Guides

Before diving into the API, we recommend reading these guides:

Authentication - Learn how to authenticate your requests
Errors - Understand error responses and status codes
Pagination - Work with paginated list responses
Filtering - Narrow down list results with query filters
Limitations - Rate limits and best practices
Logging - Debug and monitor your API usage

Common Workflows

Learn how to implement common integration patterns:

Accepting Payments - Integrate payment processing
Typical Workflow - Handle subscriptions and billing

API Resources

Browse the full API reference, grouped by domain.

Customers

Accounts - Manage customer accounts
Recipients - Notification destinations per account
Direct Debit Debtors - Bank-direct collection agreements

Subscriptions & plans

Subscriptions - Handle recurring billing
Subscription Changes - Schedule upgrades, downgrades, and early renewals
Plans - Product offerings with pricing variants
Plan Terms - Pricing variants attached to a plan
Contracts - Per-account pricing overrides
Contract Tiers - Volume-based pricing within a contract
Churn Reasons - Configurable cancellation labels

Billing & invoicing

Invoices - Issued invoice records
Invoice Lines - Line items on issued invoices
Draft Invoice Lines - Pending line items
Draft Invoice Lines Products - Product-catalog-templated draft lines
E-Invoice Field Mapping - Map Fenerum invoice fields to your e-invoicing operator

Catalog

Products - Define your product catalog
Product Pricings - Per-currency/interval price points
Revenue Groups - Group revenue for MRR/ARR slicing

Payments

Payment Cards - Manage payment methods

Reporting & activity

Activities - Subscription financial events
Reports - Saved KPI dashboards
KPIs - Metric definitions powering reports
Transactions - Bank-account movements

Accounting

Bank Accounts - Configured payout accounts
Receipts - Expense documents for reconciliation
Supplier Invoices - Invoices from your suppliers
Erp Accounts - Chart-of-accounts entries
Erp Account Lines - General-ledger postings
Erp Account Budgets - Planned amounts per account/period
Erp VAT Codes - VAT codes from your ERP

Webhooks

Webhooks - Receive real-time notifications
Webhook callbacks - Reference for async event payloads
Webhook Event Metadatas - Per-delivery audit log

Organization

Business Entities - Legal entities per country
Organization Members - Users linked to your organization

Self-service

Self-Service - Unauthenticated sign-up endpoints

Other

Other endpoints - Search, ERP imports, document uploads, exports, and one-off reports

Base URL

All API requests should be made to:

https://app.fenerum.com/

Authentication

Include your API token in every request:

Authorization: Token <your-token>

See the Authentication guide for detailed setup instructions.

Need Help?

If you encounter any issues or have questions:

Check our guides for common solutions
Review error responses for troubleshooting
Contact us at support@fenerum.com

We're here to help you succeed with your integration!

API Documentation