Beex icon

Beex

Beex Contact Center API Interaction and Consumption

Report → Get PDP Control

AI-generated

Overview

This node interacts with the Beex Contact Center API to retrieve the Payment Promises (PDP) Control report. It is useful for obtaining detailed information about payment promises filtered by campaign portfolio and promise date. This can help in monitoring and managing payment commitments within a contact center environment.

Use Case Examples

  1. Retrieve PDP Control report for a specific campaign portfolio and promise date to analyze payment promises.
  2. Use the report to track and follow up on payment promises made by clients on a given date.

Properties

Name Meaning
Portfolio ID ID of the campaign in which the information will be filtered, obtained from the ID column in the Campaigns module on the platform.
Payment Promise Date Date of promise to pay. Format: YYYY-MM-DD.
Return All Whether to return all results or only up to a given limit.
Limit Size of the page you want to obtain. From 1 to XX.
Offset Page number you wish to obtain. In descending order to the creation date and starting from 0.

Output

JSON

  • json - The JSON output contains the PDP Control report data retrieved from the Beex API, including details about payment promises filtered by portfolio and promise date.

Dependencies

  • Requires an API key credential for Beex Contact Center API authentication.

Troubleshooting

  • Common issues include invalid or missing parameters resulting in API errors. Ensure that the Portfolio ID and Payment Promise Date are correctly provided in the required format (YYYY-MM-DD).
  • API request failures may occur due to network issues or invalid API key. Verify the API key credential and network connectivity.
  • Error messages from the API are captured and presented with details to help diagnose issues. Review the error message and description for guidance.

Discussion