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 update commission plans. It allows users to modify existing commission plans by specifying details such as the plan's ID, name, type (sale price or profit), items, and bands. This is useful for businesses that need to dynamically adjust commission structures based on sales or profit metrics, enabling tailored commission schemes for different tariffs or sales scenarios.

Use Case Examples

  1. Updating a commission plan to change its name and type from sale price to profit.
  2. Modifying the bands and items of a commission plan to reflect new commission rates or tiers.

Properties

Name Meaning
Id Unique identifier of the commission plan to update.
Name Description or name of the commission plan.
Type The basis for commission calculation, either 'Sale Price' or 'Profit'.
Items JSON array defining custom sell prices by tariff for the commission plan.
Bands JSON array defining commission bands or tiers for the plan.
Additional Body Fields Optional additional fields to include in the update request body, such as 'Id' and 'Include Loses' (whether to include losses in profit calculations).

Output

JSON

  • data - The response data from the Billing Booth One API after updating the commission plan.

Dependencies

  • Billing Booth One API
  • An API key credential for authentication

Troubleshooting

  • Ensure the 'Id' property is correctly set to the commission plan's unique identifier; otherwise, the update will fail.
  • The 'Items' and 'Bands' properties must be valid JSON arrays; invalid JSON will cause errors.
  • If the API returns authorization errors, verify that the API key credential is correctly configured and has necessary permissions.
  • Common error messages include missing routing information for the specified resource and operation, which indicates misconfiguration in the node parameters.

Discussion