BillRun icon

BillRun

Open-Source Billing Designed For Big-Data (v.0.2.3)
Join our community

Overview

This node integrates with the BillRun billing system, enabling various billing-related operations such as creating, updating, retrieving, closing, and deleting entities across multiple modules like customers, subscribers, products, plans, services, discounts, lines, bills, balances, and billruns. It supports actions like charging, refunding, collecting payments, generating invoices, and triggering real-time events. This node is useful for automating billing workflows, managing customer accounts, handling payments, and generating billing documents within the BillRun platform.

Use Case Examples

  1. Create or update customer accounts or subscribers with detailed fields and custom user data.
  2. Retrieve billing information such as invoices, balances, or audit logs for reporting or integration purposes.
  3. Perform financial operations like charging, refunding, collecting payments, or generating one-time invoices.
  4. Trigger real-time billing events or rebalance account subscriber balances based on billing cycles.

Properties

Name Meaning
action The billing operation to perform, such as create, update, get, delete, charge, pay, rebalance, etc.
module The module on which to perform the action, such as customers, subscribers, products, plans, services, discounts, lines, bills, balances, billrun, or audit.
description Node's description.
returnFullResponse Return the full response object instead of only the details.
useFieldsJson Send all fields data as JSON.
fullBodyJson Send the full JSON of the body (with update, query and options parameters).
entityId Entity's ID for update, delete, close, or reopen actions.
fieldsJson JSON representing all data fields when useFieldsJson is true.
getActive Get active entities (for get action on certain modules).
getFuture Get future entities (for get action on certain modules).
getInactive Get inactive entities (for get action on certain modules).
invoiceAction Action for account invoices such as download, query, expected_invoice, or search.
aid Account ID for various actions like account invoices, one-time invoice, collect, etc.
billrun_key Billrun key of desired date for account invoices or rebalance.
additionalFields Additional fields specific to certain actions, e.g., invoice ID for account invoices.
op_method Payment method for offline payments (cash, wire transfer, cheque).
op_aid Customer ID for offline payments.
op_amount Amount for offline payments.
op_invoices Invoices to pay for offline payments.
charge_aid Customer ID for charge/refund action.
charge_sid Subscriber ID for charge/refund action (0 for customer level).
charge_usagev Volume for charge/refund action.
charge_rate Product for charge/refund action.
ic_aid Customer ID for immediate charge/refund action.
ic_sid Subscriber ID for immediate charge/refund action (0 for customer level).
ic_usagev Volume for immediate charge/refund action.
ic_rate Product for immediate charge/refund action.
fileType File type for realtime action.
request Request content for realtime action.
rebalance_aids Customer IDs for rebalance action.
rebalance_billrun_key Billrun key for rebalance action.
collect_aid Customer ID for collect action.
collect_amount Amount for collect action.
collect_invoices Comma separated invoice IDs for collect action.
to Date for close action.
from Date for reopen action.
cdrs CDR (Call Detail Records) metadata for one-time invoice action.
additionalParameters Additional parameters for one-time invoice action such as send email, allow bill, step, invoice unix time, and user fields.
additionalFields Additional fields for pay action including payment details, user fields, and options for cancelling or merging installments.
fields Individual fields for various modules and actions when useFieldsJson is false.
options Options for get action such as sorting and pagination.
price Pricing details for plans and services modules during create or update actions.
priceWithInterval Pricing with intervals for rates module during create or update actions.

Output

JSON

  • details - The main response details from the BillRun API call, containing the result of the requested action.

Dependencies

  • BillRun API with required API key credential

Troubleshooting

  • Common errors include unsupported payment methods, invalid entity IDs, or malformed JSON in fieldsJson.
  • Errors may also occur if required parameters for specific actions are missing or incorrectly formatted.
  • Ensure that the API credentials are correctly configured and that the BillRun API endpoint is reachable.
  • If the node returns a general error message, check the message property in the response for more details.

Links

Discussion