Sherweb icon

Sherweb

Interact with Sherweb API

Actions19

Overview

This node interacts with the Sherweb API to retrieve receivable charge information for a specified customer. Specifically, the "Get Receivable Charges" operation fetches billing charges associated with a customer either for a particular billing period that includes a given date or for the most recent invoiced billing period if no date is specified.

Common scenarios where this node is useful include:

  • Financial reconciliation by fetching detailed charge data for customers.
  • Automating billing reports based on specific billing periods.
  • Integrating Sherweb billing data into other systems such as accounting or CRM platforms.

For example, you can use this node to get all receivable charges for a customer for the billing period that includes March 15, 2024, or simply retrieve the latest invoiced charges if no date is provided.

Properties

Name Meaning
API Type Selects which Sherweb API to use:
- Service Provider API
- Distributor API
Customer ID The unique identifier of the customer whose receivable charges you want to retrieve. This is a required field.
Date Optional date in yyyy-MM-dd format (UTC). When specified, returns charges for the billing period that includes this date. If omitted, returns charges for the most recent invoiced billing period.

Output

The node outputs JSON data containing details about the receivable charges for the specified customer and billing period. The output typically includes fields such as:

  • Billing period start and end dates (periodFrom, periodTo)
  • Charge amounts and descriptions
  • Invoice references
  • Other metadata related to the customer's receivable charges

No binary data output is indicated for this operation.

Dependencies

  • Requires an active Sherweb API credential configured in n8n, including an OAuth2 token and subscription key.
  • The node uses the base URL https://api.sherweb.com.
  • Proper permissions on the Sherweb account to access customer billing data are necessary.

Troubleshooting

  • Missing or invalid Customer ID: The node requires a valid customer ID; ensure it is correctly provided.
  • Invalid date format: The date must be in yyyy-MM-dd format (UTC). Incorrect formats may cause errors or unexpected results.
  • Authentication errors: Verify that the API credentials are correctly set up and have not expired.
  • API rate limits or connectivity issues: Network problems or exceeding API quotas can cause failures; check network connectivity and Sherweb API usage limits.
  • Empty or unexpected response: Confirm that the customer has invoiced charges for the requested period or that the correct API type is selected.

Links and References

Discussion