Collection Plan Input
Input representation of a single collection plan, including its optional nested collection plan items.
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
accountId | String | ID of the account associated with the collection plan. | Required | 68.0 |
collectionPlanItems | Collection Plan Item Input[] | List of collection plan items to create under this collection plan. You can specify up to 200 collection plan items. If an item fails to create, the parent collection plan is rolled back. | Optional | 68.0 |
collectionPlanReasonId | String | ID of the collection plan reason associated with the collection plan. | Optional | 68.0 |
collectionPlanSegment | String | Predefined segment associated with the collection plan. The segment is derived from criteria such as the collection amount and the number of days past due. Because this segment is a dynamic value that you define, the valid values vary by org. | Optional | 68.0 |
contactId | String | ID of the contact associated with the collection plan. | Optional | 68.0 |
dueDate | String | Date by which the payment toward the outstanding amount is expected, in YYYY-MM-DD format. | Optional | 68.0 |
initialDueAmount | Double | Initial due amount of the collection. | Optional | 68.0 |
overdueRiskIndicator | String | Overdue risk level for the collection plan. Valid values are:
| Optional | 68.0 |
usageType | String | Usage type of the collection plan. Valid value is Billing. | Required | 68.0 |