The Retrieve Next Due Payment agent action identifies the next upcoming payment for an account by returning the earliest due date and the total amount due so that users can quickly understand what a customer needs to pay next.
Required Editions
| Available in: Lightning Experience |
| Available in: Enterprise, Unlimited, and Developer Editions of Revenue Cloud Advanced and Revenue Cloud Billing with the Agentforce Employee Agent add-on. It also requires the Flex Credits Metering add-on and the Usage Management add-on. |
| User Permissions Needed | |
|---|---|
| To execute actions in Employee agents: | See Manage Employee Agent Access |
| To run flows: | Run Flows |
Action Details
| API Name | RetrieveNextDuePayment |
| Reference Action Type | Flow |
| Reference Action | Retrieve Next Due Payment |
| Does this action execute one or more prompt templates? | No |
| Required Setup |
Input
- Account Context – The account the user wants the details for.
Output
- Next Payment Due Date – The earliest upcoming due date.
- Amount Due – Total amount associated with that due date.
- Supporting Details – Invoice identifiers or billing items contributing to the amount.
- Is Successful – Boolean flag that indicates whether retrieval was successful.
- Error Message – String with error details if the action fails.
Guidelines and Considerations
- The action returns a result only when outstanding amounts have due dates.
- If no payments are due, the action indicates that no upcoming payment was found.