Package Information
Documentation
n8n-nodes-billingboothone
This is an n8n community node for Billing Booth One.
n8n is a fair-code licensed workflow automation platform.
Overview

Table of Contents
Installation
Follow the installation guide in the n8n community nodes documentation.
Community Nodes (Recommended)
- Go to Settings > Community Nodes in your n8n instance
- Select Install
- Enter
n8n-nodes-billingboothonein the Enter npm package name field - Click Install
Manual Installation
To manually install the node in an n8n instance:
npm install n8n-nodes-billingboothone
Operations
This node provides access to all Billing Booth One API resources.
Customer
- Customers - Manage customer records and relationships
- Notes - Manage Notes against customer
- Customer Groups - Create, retrieve, and manage Customer Croups
- Cost Centres - Allocate costs across departments
- Charges - Handle billing charges and subscriptions
- Products - Manage product catalog and pricing
- Credit Notes - Issue and manage credit notes
Financial Management
- Billing Run - Execute and manage billing runs
- Ledgers - Track financial transactions
- Revenue - Analyze revenue and financial metrics
- Tariffs - Configure pricing structures
- Price Adjustments - Manage pricing changes
- Product Prices - Set and update product pricing
Customer Management
- Customer Access - Manage customer portal access
- Customer Commissions - Track commission structures
- Contacts - Manage customer contacts
- Notes - Add notes to customer records
- Tags - Organize with tags
Billing & Usage
- CDR (Call Detail Records) - Manage telecommunications usage
- CDR Analytics - Analyze call data
- Service Files - Process service usage files
- Service Charges - Handle service-based billing
- Bundles - Manage usage bundles and allowances
Organization & Setup
- Organisations - Multi-tenant organization management
- Suppliers - Manage supplier relationships
- Categories - Categorize products and services
- Regions - Geographic configuration
- Metadata - Custom field management
Automation & Integration
- Auto Collection Endpoints - Configure automatic data collection
- Auto Collection History - Track collection history
- Integration Logs - Monitor integration activity
- Integrations - Manage external integrations
- Events - Track system events
System & Configuration
- Users - User management
- Roles - Role-based access control
- Email Settings - Configure email notifications
- Invoice Template - Customize invoice templates
- Data Retention - Configure data retention policies
- Account - Account-level settings
Additional Resources
And many more including: CLI management, Charge Imports, Commission Plans, Destinations, Destination Groups, Endpoints, Time Schedules, Audit Entries, Support Attachments, and more.
Each resource supports standard operations like:
- Get All - Retrieve lists with filtering and pagination
- Get - Retrieve single records by ID
- Create - Create new records
- Update - Modify existing records
- Delete - Remove records
- Upload - Binary file uploads (for CDR and Service Files)
Optional query parameters are organized under Additional Fields
Credentials
To use this node, you need Billing Booth One API credentials:
Prerequisites
- A Billing Booth One account
- API access credentials (email and password) without 2FA
- Your API base URL (defaults to
https://api.billingbooth.app)
Setting up credentials
- In n8n, go to Credentials > New
- Search for "Billing Booth One API"
- Enter your credentials:
- Email: Your Billing Booth One account email
- Password: Your account password
- Base URL: API endpoint
- Click Test to verify your credentials
- Click Save
The node automatically handles authentication and token caching (55-minute expiry).
This node does not support the 2FA authentication method.
Compatibility
- Minimum n8n version: 1.0.0
- Tested with: n8n v1.119.1
Usage
Basic Example: Get All Customers
- Add the Billing Booth One node to your workflow
- Select Customers as the resource
- Select Get All Customers as the operation
- Optionally add filters in Additional Fields:
- Set
limitto control pagination - Add search terms or filters
- Set
- Execute the node
Advanced Example: Create a Bundle, and a Bundle Allowance
- Add Billing Booth One node
- Select Bundles resource
- Select Create Bundle operation
- Fill in a name
- Select the mode (Allowance or Spend)
- Add optional parameters in Additional Fields e.g. Inclusive Spend amount (if mode is Spend)
- Add Billing Booth One node
- Select Bundles resource
- Select Create Bundle Allowance operation
- Add the bundle Id (from output of Create Bundle)
- Add the quantity (number in minutes)
- Select the Unit Type
- Add additional fields to filter the allowance e.g. Desintation Ids, Desintation Group Ids
File Upload Example: Upload CDR
- Use Extract From File node to load your CSV file
- Connect to Billing Booth One node
- Select CDR resource
- Select Upload Cdr operation
- Set Binary Property to the name of your binary property (usually "data")
- Add query parameters like
supplier_idin Additional Fields
Webhook Trigger
The Billing Booth One node allows your workflows to start automatically when events occur in Billing Booth One.
Setting Up a Webhook Trigger
- Add the Billing Booth One node as a trigger on your workflow.
- Under triggers, select On New Billing Booth One Event
- Select your Billing Booth One API credentials
- Choose which Events to subscribe to:
- Invoices - Trigger on invoice events (created, updated, sent, etc.)
- Payments - Trigger on payment events (received, failed, etc.)
- Mandates - Trigger on mandate events (created, cancelled, etc.)
- Customers - Trigger on customer events (created, updated, etc.)
- Ledger - Trigger on ledger events
- Audit - Trigger on audit events
- Credit Notes - Trigger on credit note events
- You can execute the workflow to test events are being handled correctly
- Activate your workflow
- You can trigger test events using the Send Test Event action from another workflow.
When you activate the workflow, the trigger node will:
- Automatically register a webhook endpoint with Billing Booth One
- Billing Booth generates a secure secret for the webhook
- Start receiving events for your selected event types
When you deactivate the workflow, the webhook is automatically removed from Billing Booth One.
Building
npm run build # Build the node
Key Features
- Auto-generated Properties - Generated from OpenAPI spec
- Token Caching - Automatic authentication token management
- Binary File Support - Multipart form-data uploads for CDR and service files
- Webhook Support - Trigger node for webhooks.
Resources
- Billing Booth One API Documentation
- n8n Community Nodes Documentation
- GitHub Repository
- Report Issues
License
Version History
0.3.0
- Implemented loadoptions for customers and bundles (allows selecting customer or bundle by name instead of CustomerId or BundleId)
- Updated OrganisationId to default to 1 instead of 0
- Update From and To query params to use date picker
0.2.6
- Bump version for README
0.2.5
- Fix node name
0.2.4
- Resolve circular response issue
0.2.3
- Fix issue with Webhooks, update README
0.2.2
- Minor bug fixes
0.2.1
- Update Webhook Trigger node name
- Update README
0.2.0
- New Feature: Webhook Trigger node for receiving real-time events from Billing Booth One
- Support for all webhook trigger types
- Webhook subscirptions are individually selectable
0.1.3
- Remove duplicate metadata resource
- Remove unnecessary Home resource
- Internal fixes for properties generation to better support future API updates
0.1.2
- Fix for additional fields collections
0.1.1
- Fix issue with binary file upload
0.1.0
- Initial release
- Support for all API resources
- Modular resource-based architecture
- Query parameters organized in Additional Fields collections
- Binary file upload support for CDR and Service Files
- Automatic token caching and refresh