The Generate Payment Plan Details agent action returns the payment installment schedule for an invoice so that users can understand how an invoice is paid over time, including installment amounts, dates, and statuses.
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 | GeneratePaymentDetails |
| Reference Action Type | Flow |
| Reference Action | Generate Payment Plan Details |
| Does this action execute one or more prompt templates? | No |
| Required Setup |
Input
- Invoice Reference – The invoice the user is asking about.
Output
- Payment Plan Summary – Installment details, including dates, amounts, and statuses.
- 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 results only for invoices that have an associated payment plan.
- If the invoice reference is incomplete or invalid, the subagent can request additional details.