Billing Booth One icon

Billing Booth One

Interact with Billing Booth One API
Join our community

Actions476

Overview

This node interacts with the Billing Booth One API to create roles with specific permissions. It allows users to define a role's attributes and permissions such as customer management, payment processing, administrative controls, invoice handling, and more. This node is useful for automating role creation in billing and account management systems, ensuring consistent permission settings across an organization.

Use Case Examples

  1. Creating a new role with permissions to manage customers and process payments.
  2. Automating the setup of administrative roles with specific access to invoice and audit management.

Properties

Name Meaning
Id Unique identifier for the role.
Name Name of the role to be created.
Customer Write Gives customer create/edit/delete permissions.
Customer Post Adjustments Gives ledger post adjustments permissions.
Customer Notes Write Allows writing customer notes.
Customer Manage Customer Access Allows management of customer access portal for customers.
Customer Metadata Allows access to customer metadata.
Payments Read Gives payment read permissions.
Payments Process Gives payment processing permissions, e.g. taking payments.
Payments Mandates Gives payment mandate management permissions.
Payments Disable Mandates Gives payment enable/disable mandate permissions.
Admin General Gives administrative general management permissions.
Admin Organisations Gives the ability to create/modify organisations within the account.
Admin Payments Gives the ability to modify payment provider options.
Admin Cdr Gives administrative permissions for modifying Voice, Data & SMS settings.
Admin Data Policy Gives data policy settings permissions for all organisations.
Admin Integrations Allows app integrations to be added and modified on the account.
Admin Email Delivery Modify email delivery settings.
Admin Webhooks Gives settings for webhook event pushing.
Admin Users Manage and create users along with their permissions.
Admin Invoice Manage invoice templates.
Admin Audit Manage audit entry.
Admin Notifications Manage account notifications.
Charge Write Gives charge create/update/terminate permissions.
Charge Delete Gives charge delete/bulk delete/cancel/reactivate permissions.
Invoice Read Gives invoice get/get line items/get single/pdf/download/service file/attachments/send/bulk send/send reminder/bulk send reminder/export permissions.
Invoice Settle Gives invoice settle/bulk settle/batch settle/outstanding/bulk outstanding permissions.
Invoice Delete Gives invoice void/bulk void/delete/bulk delete permissions.
Credit Note Read Gives credit note get/pdf permissions.
Credit Note Write Gives credit note create/edit/delete permissions.
Product Write Gives product create/bulk create/update permissions.
Product Delete Gives product delete/bulk delete permissions.
Cdr Read Gives cdr read permissions.
Cdr Write Gives cdr write permissions.
Cdr Bundles Gives cdr bundles permissions.
Super User If true, a superuser can access and modify all data and settings across the account.

Output

JSON

  • json
    • id - Unique identifier of the created role.
    • name - Name of the created role.
    • customer_write - Permission for customer create/edit/delete.
    • customer_post_adjustments - Permission for ledger post adjustments.
    • customer_notes_write - Permission to write customer notes.
    • customer_manage_customer_access - Permission to manage customer access portal.
    • customer_metadata - Permission for customer metadata access.
    • payments_read - Permission to read payments.
    • payments_process - Permission to process payments.
    • payments_mandates - Permission to manage payment mandates.
    • payments_disable_mandates - Permission to enable/disable payment mandates.
    • admin_general - General administrative permissions.
    • admin_organisations - Permission to create/modify organisations.
    • admin_payments - Permission to modify payment provider options.
    • admin_cdr - Permission to modify Voice, Data & SMS settings.
    • admin_data_policy - Permission for data policy settings.
    • admin_integrations - Permission to add/modify app integrations.
    • admin_email_delivery - Permission to modify email delivery settings.
    • admin_webhooks - Permission for webhook event pushing settings.
    • admin_users - Permission to manage and create users.
    • admin_invoice - Permission to manage invoice templates.
    • admin_audit - Permission to manage audit entries.
    • admin_notifications - Permission to manage account notifications.
    • charge_write - Permission to create/update/terminate charges.
    • charge_delete - Permission to delete/cancel/reactivate charges.
    • invoice_read - Permission to read and manage invoices.
    • invoice_settle - Permission to settle invoices.
    • invoice_delete - Permission to void/delete invoices.
    • credit_note_read - Permission to read credit notes.
    • credit_note_write - Permission to create/edit/delete credit notes.
    • product_write - Permission to create/update products.
    • product_delete - Permission to delete products.
    • cdr_read - Permission to read call detail records (CDR).
    • cdr_write - Permission to write call detail records (CDR).
    • cdr_bundles - Permission for CDR bundles.
    • super_user - Superuser access to all data and settings.

Dependencies

  • Billing Booth One API key credential

Troubleshooting

  • Ensure the API key credential is correctly configured and has sufficient permissions to create roles.
  • Verify that all required fields, especially 'Name', are provided and valid.
  • Check the API base URL configuration to ensure it points to the correct Billing Booth One API endpoint.
  • If the node throws errors related to missing routing information, confirm that the resource is set to 'Roles' and operation to 'Create Role'.
  • Handle API errors gracefully by enabling 'Continue On Fail' to capture error details in the output.

Links

Discussion