Actions59
- Blacklist Actions
- Call Actions
- Client Actions
- Entity Actions
- Import Actions
- Lead Actions
- PBX Actions
- Queue Actions
- Report Actions
- Get Daily Managements
- Get Dropped Calls
- Get Summary
- Get Time Slot
- Get Users Management
- Get Calls
- Get Client Management
- Get Forms
- Get Incoming Call
- Get IVR Survey
- Get Log ACW
- Get Managements by ACW
- Get Managements per Hour
- Get Messaging Tickets
- Get PDP Control
- Get List PDP
- Get PDP Ranking
- Get Phones
- Get Platform Detailed
- Get Platform Summarized
- Get Product Managements
- Get Products
- Get Progress Managements
- Get Strategies
- Get Tickets Tracking
- Sequence Actions
- Template Actions
- Ticket Actions
- User Actions
Report → Get List PDP
AI-generatedOverview
This node operation fetches a list of Payment Promises (PDP) reports from the Beex Contact Center API. It is useful for retrieving detailed information about payment promises filtered by campaign portfolio, date range, and optionally by user. This can help in monitoring and managing payment promises within a specified timeframe and campaign context.
Use Case Examples
- Retrieve all payment promises for a specific campaign portfolio between two dates.
- Fetch a paginated list of payment promises filtered by user ID within a campaign portfolio.
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. |
| Start Date | Start date for filtering the report data, in YYYY-MM-DD format. |
| End Date | End date for filtering the report data, in YYYY-MM-DD format. |
| User ID | Optional ID of the user who logged the typing, used to filter the report data. |
| Return All | Boolean flag indicating whether to return all results or only up to a given limit. |
| Limit | Size of the page you want to obtain, applicable if Return All is false. |
| Offset | Page number you wish to obtain, starting from 0, in descending order by creation date. |
Output
JSON
json- Each item contains a JSON object representing a payment promise report entry from the Beex API.
Dependencies
- Beex Contact Center API with an API key credential
Troubleshooting
- Common errors include invalid or missing parameters, which result in error messages from the Beex API. Ensure all required fields like Portfolio ID, Start Date, and End Date are correctly set.
- API authentication errors may occur if the API key credential is missing or invalid. Verify the API key is correctly configured in the node credentials.
- Rate limiting or request throttling may happen due to the enforced delay between requests (1 second). Adjust usage accordingly to avoid hitting API limits.
Links
- Beex Contact Center API Documentation - Official API documentation for understanding available endpoints and parameters.