Billing Booth One icon

Billing Booth One

Interact with Billing Booth One API

Actions476

Overview

This node interacts with the Billing Booth One API to update customer access settings for an organisation. It allows users to configure various aspects of the customer access portal, such as theme preferences, theme colors, page access permissions, and additional customizable fields like domain, portal name, navigation colors, custom CSS, labels, and URLs. This node is useful for automating the management of customer portal settings in a billing system, enabling consistent and dynamic updates to the portal's appearance and functionality.

Use Case Examples

  1. Updating the theme and colors of the customer access portal for a specific organisation.
  2. Enabling or disabling access to invoices, payments, calls, and account pages for customers.
  3. Customizing labels and URLs for terms of service, privacy policy, and contact links on the customer portal.

Properties

Name Meaning
Organisation Id Unique identifier of the organisation whose customer access settings are being updated.
Theme The theme to be applied to the customer access portal, such as light, dark, or system default.
Light Theme Colour Theme colour used in the light theme.
Dark Theme Colour Theme colour used in the dark theme.
Allow Invoices Boolean flag to allow the invoices page to be displayed on the customer portal.
Allow Payments Boolean flag to allow the payments page to be displayed on the customer portal.
Allow Cdr Boolean flag to allow the calls page to be displayed on the customer portal.
Allow Account Boolean flag to allow the account page to be displayed on the customer portal.
Additional Body Fields Optional additional fields to customize the customer access portal, including domain, portal name, navigation colors, custom CSS, sign-in page texts, menu labels, links, and various permissions.

Output

JSON

  • json - The JSON response from the Billing Booth One API after updating the customer access settings, containing the updated settings or error information.

Dependencies

  • Requires an API key credential for Billing Booth One API authentication.

Troubleshooting

  • Common issues include missing or invalid API credentials, resulting in authentication errors.
  • Incorrect or missing required parameters such as organisationId or theme may cause the API request to fail.
  • Network or API endpoint issues can cause request failures; verify the base URL and network connectivity.
  • Error messages from the API are propagated; ensure to handle errors gracefully and check the error details in the node output.

Discussion