@dszp/n8n-nodes-onebill
v0.3.0
Published
n8n community node for the OneBill billing and subscription management API
Readme
n8n-nodes-onebill
This is an n8n community node for the OneBill billing and subscription management API.
n8n is a fair-code licensed workflow automation platform.
Installation | Operations | Credentials | API Coverage | Resources
Installation
Follow the installation guide in the n8n community nodes documentation.
Operations
Quotes and orders are the same object. A quote is an order in a quote state, so both are read through the Order resource.
Get Manyreturns every order except quotes and reports a total for that narrowed set, so the omission is invisible — turn on Include Quotes for the full history, or pick a quote state in the State filter. The search matches one field per request, so Include Quotes cannot be combined with another filter.
Reading an order reports its state differently from listing one. In a list the field is
state(a number) and the status keeps its spaces; a single read renames it toorderState(a string), removes the spaces (Pending BillingbecomesPendingBilling), and reports an expired quote as1007rather than1034. An expression comparing a status literal works while iterating a list and stops working after a Get. Treat1002,1007and1034as "is a quote".
netAmountincludes tax — the opposite of the usual convention. Usesubtotalfor the pre-tax figure.currencyis a symbol ($), not an ISO code.
Subscriber
- Create, Get, Get Many, Update, Close, Suspend, Resume, Reopen
- Get Balance, Get Subscriptions, Get Documents
- Get Contacts, Add Contact, Update Contact, Remove Contact
Lead
- Create, Get, Get Many, Update, Convert to Subscriber
Order
- Create, Get, Get Many, Validate, Activate, Update Quote, Get Quote Document
Invoice
- Get, Get Many, Modify
Payment
- Create, Get Many, Get for Subscriber
Product
- Create, Get, Get Many, Update, Delete
Bundle
- Create, Get, Get Many, Update
Ticket
- Create, Get, Update, Get History
Partner
- Create, Get, Update, Delete, Delete Contacts, Suspend, Resume
Vendor
- Create, Get, Update
Credentials
To use this node, you need the following credentials from your OneBill account:
| Field | Description |
|-------|-------------|
| Base URL | Your OneBill instance URL (default: https://app.onebillsoftware.com) |
| Tenant ID | Found in Config > Settings > Business Profile > Tenant ID |
| Client Secret | Found in the Business Profile section |
| Username | Your OneBill account username |
| Password | Your OneBill account password (SHA256-hashed automatically) |
| Scope | OAuth scope (default: trust) |
API Coverage
The OneBill API has approximately 135 endpoints across 13 services. This node currently implements 56 operations across 10 resources (~41% coverage), focusing on the most common billing and subscription management tasks.
Implemented Endpoints
| Resource | Service | Operations | |----------|---------|------------| | Subscriber | SubscriberService | Create, Get, Get Many, Update, Close, Suspend, Resume, Reopen, Get Balance, Get Subscriptions, Get Documents, Get Contacts, Add Contact, Update Contact, Remove Contact | | Lead | SubscriberService | Create, Get, Get Many, Update, Convert to Subscriber | | Order | OrderService | Create, Get, Get Many, Validate, Activate, Update Quote, Get Quote Document | | Invoice | InvoiceService | Get, Get Many, Modify | | Payment | PaymentService | Create, Get Many, Get for Subscriber | | Product | ProductService | Create, Get, Get Many, Update, Delete | | Bundle | ProductService | Create, Get, Get Many, Update | | Ticket | TicketManagementService | Create, Get, Update, Get History | | Partner | PartnerService | Create, Get, Update, Delete, Delete Contacts, Suspend, Resume | | Vendor | PartnerService | Create, Get, Update |
Not Yet Implemented
| Service | Endpoints | Description | |---------|-----------|-------------| | PromotionService | ~13 | Coupon, Discount, Grant, Trial, Counter CRUD | | RuleService | ~48 | Rules for billing, collections, late fees, order validation, etc. | | UserService | 5 | User CRUD and roles listing | | UtilityService | 3 | Transaction and usage exports | | BillingService | 1 | Transaction-level bill now | | CommonService | 1 | Custom lists with hierarchy |
Additional missing operations on implemented services:
| Service | Missing Operations | |---------|-------------------| | SubscriberService | Bill, Get Documents, Swap/Modify Provisioning Attributes | | OrderService | Re-rate | | ProductService | Delete Price Plan, Resell Templates | | TicketManagementService | Templates, Classifications, Response Templates, Departments, Incident Types, Tags |
