Create Collection Plan Action

Create one or more collection plans, each with its optional nested collection plan items.

Create multiple collection plans in a single request, each with optional nested collection plan items. If an item fails to create, its parent collection plan is rolled back.

This action is available in API version 68.0 and later.

Special Access Rules

The Create Collection Plan action is available in Enterprise, Developer, and Unlimited Editions where Billing is enabled.

Supported REST HTTP Methods

URI: /services/data/v68.0/actions/standard/createCollectionPlan
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer TOKEN

Where TOKEN is a placeholder for your OAuth access token.

Inputs

Input	Type	Description
`compositeCollectionPlanInput`	`CompositeCollectionPlanInput`	Required. Composite input that contains a `collectionPlans` list of collection plans to create. Each collection plan can include a nested list of collection plan items. collectionPlans — list of Collection Plan objects: collectionPlanItems — Collection Plan Item objects:

Outputs

Output	Type	Description
`compositeCollectionPlanResult`	`CompositeCollectionPlanResult`	Composite result that contains a `results` list, with one result for each collection plan in the request. results — Collection Plan Result objects:

Example

POST

This example shows a sample request for the Create Collection Plan action.

1{
2  "inputs": [
3    {
4      "compositeCollectionPlanInput": {
5        "collectionPlans": [
6          {
7            "accountId": "001xx000003DGXYA2",
8            "contactId": "003xx000004TXYZA1",
9            "initialDueAmount": 7500.00,
10            "collectionPlanSegment": "High Risk",
11            "dueDate": "2026-06-15",
12            "collectionPlanReasonId": "0cR000000000001",
13            "usageType": "Billing",
14            "overdueRiskIndicator": "High",
15            "collectionPlanItems": [
16              { "invoiceId": "inv000000000001" },
17              { "invoiceId": "inv000000000002" }
18            ]
19          }
20        ]
21      }
22    }
23  ]
24}

This example shows a sample response for the Create Collection Plan action.

1[
2  {
3    "actionName": "createCollectionPlan",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outputValues": {
8      "compositeCollectionPlanResult": {
9        "results": [
10          {
11            "collectionPlanId": "1Eu000000000001AAA",
12            "collectionPlanItemIds": [
13              "1Ev000000000001AAA",
14              "1Ev000000000002AAA"
15            ],
16            "isSuccess": true,
17            "errors": null
18          }
19        ]
20      }
21    },
22    "sortOrder": -1,
23    "version": 1
24  }
25]