Composite Collection Plan Creation (POST)

Create one or more collection plans, each with its collection plan items, in a single request.

This API creates each collection plan in the request together with its nested collection plan items. Each collection plan runs independently, so the request can partially succeed across plans. Within a single collection plan, if any of its collection plan items fail to create, the parent collection plan is rolled back. The response returns a result for each collection plan in the request that indicates whether the collection plan was created successfully and includes any errors.

A request can include up to 200 collection plans, and each collection plan can include up to 200 collection plan items.

Special Access Rules 

Set up collections and enable invoicing in your org.

Resource 

1/connect/collections/composite-collection-plan

Resource Example 

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/collections/composite-collection-plan

Available Version 

68.0

HTTP Methods 

POST

Request Body for POST 

JSON Example

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

Properties

NameTypeDescriptionRequired or OptionalAvailable Version
collection​PlansCollection Plan Input[]List of collection plans to create. Each plan can include a nested list of collection plan items to create with it. Specify at least 1 collection plan and up to 200 collection plans. Each collection plan can include up to 200 collection plan items.Required68.0

Response Body for POST 

Composite Collection Plan