Use Cases for Agreement

I want to	Request Type	Example URL
Retrieve and display details of a agreement instance.	GET by ID for Agreement	{{orgendpoint}}/services/data/{{version}}/connect/comms/agreementmanagement/v4/agreement/{id-of-the-resouce-to-be-retrieved} NOTE: For invalid customer ID, you will receive HTTP 404 error.
Based on the provided field values, retrieve and display details of agreement instance.	GET with Fields for Agreement	{{orgendpoint}}/services/data/{{version}}/connect/comms/agreementmanagement/v4/agreement?fields=name NOTE: The requested fields will be part of output, if they have value.
List all the agreement instances present in the system.	GET List of Agreements	{{orgendpoint}}/services/data/{{version}}/connect/comms/agreementmanagement/v4/aagreement
List agreement instances present in the system based on the filter applied.	GET List with Filtering for Agreement	{{orgendpoint}}/services/data/{{version}}/connect/comms/agreementmanagement/v4/agreement?name=testing NOTE: The requested fields will be part of output, if they have value.
List agreement instances, limit the number of agreement instances to a maximum of specified limit, and starts the results display from page specified by offset.	GET with Pagination for Agreement	{{orgendpoint}}/services/data/{{version}}/connect/comms/agreementmanagement/v4/agreement?pageLimit=2&offset=5
Create a new agreement instance by providing the required details.	POST an Agreement	{{orgendpoint}}/services/data/{{version}}/connect/comms/agreementmanagement/v4/agreement NOTE: A new agreement instances gets created based on the values mentioned for the mandatory fields.
Update details of particular agreement instance.	PATCH an Agreement	{{orgendpoint}}/services/data/{{version}}/connect/comms/agreementmanagement/v4/agreement/{ID}
Delete an agreement instance.	DELETE an Agreement	{{orgendpoint}}/services/data/{{version}}/connect/comms/agreementmanagement/v4/agreement/{ID}

GET by ID for Agreement

Consider you want to retrieve details of a particular agreement instance.

Sample URL

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v62.0/connect/comms/agreementmanagement/v4/agreement/800xx000000bp41AAA

Sample Response

1200 OK
2{
3    "id": "800xx000000bp41AAA",
4    "href": "/connect/comms/agreementmanagement/v4/agreement/800xx000000bp41AAA",
5    "name": "features",
6    "agreementType": "SampleContractType",
7    "description": "new statement",
8    "documentNumber": "00000156",
9    "status": "Draft",
10    "@type": "Agreement",
11    "completionDate": "Fri Oct 19 00:00:00 GMT 2018",
12    "agreementPeriod": {
13        "startDateTime": "Fri Apr 20 00:00:00 GMT 2018"
14    },
15    "engagedParty": [
16        {
17            "id": "001xx000003GYiBAAW",
18            "href": "/services/data/v60.0/sobjects/Account/001xx000003GYiBAAW",
19            "name": "Edge Communications",
20            "role": "Customer - Direct",
21            "referredType": "Account"
22        }
23    ],
24    "associatedAgreement": [
25        {
26            "id": "800xx000000bnlNAAQ",
27            "href": "/services/data/v60.0/sobjects/Contract/800xx000000bnlNAAQ",
28            "name": "full contract 1",
29            "referredType": "Parent Contract"
30        }
31    ],
32    "agreementSpecification": {
33        "id": "2dtxx0000000001AAA",
34        "href": "/connect/comms/AGREEMENTMANAGEMENT/v4/AGREEMENT/2dtxx0000000001AAA",
35        "name": "Test Document 2",
36        "referredType": "Document Template"
37    },
38    "agreementItem": [
39        {
40            "productOffering": [
41                {
42                    "id": "01txx0000006i2SAAQ",
43                    "href": "/services/data/v60.0/sobjects/Product2/01txx0000006i2SAAQ",
44                    "name": "GenWatt Diesel 200kW",
45                    "referredType": "ProductOffering"
46                },
47                {
48                    "id": "01txx0000006i2iAAA",
49                    "href": "/services/data/v60.0/sobjects/Product2/01txx0000006i2iAAA",
50                    "name": "Installation: Industrial - Medium",
51                    "referredType": "ProductOffering"
52                }
53            ],
54            "termOrCondition": [
55                {
56                    "description": "condition 1",
57                    "id": "1",
58                    "validFor": {
59                        "startDateTime": "Wed Apr 25 00:00:00 GMT 2018",
60                        "endDateTime": "Tue Nov 20 00:00:00 GMT 2018"
61                    }
62                },
63                {
64                    "description": "condition 2",
65                    "id": "2",
66                    "validFor": {
67                        "startDateTime": "Wed Apr 25 00:00:00 GMT 2018",
68                        "endDateTime": "Tue Nov 20 00:00:00 GMT 2018"
69                    }
70                }
71            ]
72        }
73    ]
74}

GET with Fields for Agreement

Consider you want to retrieve details of an agreement with requested attributes (id, href are always included).

Sample URL

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v62.0/connect/comms/agreementmanagement/v4/agreement?fields=name

Sample Response

1[
2    {
3        "@type": "Agreement",
4        "name": "testing",
5        "id": "800xx000000bni9AAA",
6        "href": "/connect/comms/agreementmanagement/v4/agreement/800xx000000bni9AAA"
7    },
8    {
9        "@type": "Agreement",
10        "name": "testing",
11        "id": "800xx000000bnjlAAA",
12        "href": "/connect/comms/agreementmanagement/v4/agreement/800xx000000bnjlAAA"
13    }
14]

GET List of Agreements

Consider there are agreement instances in the system and you want to list all of them.

Sample URL

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v62.0/connect/comms/agreementmanagement/v4/agreement

Sample Response

1200 OK
2
3[
4    {
5        "documentNumber": "00000154",
6        "@type": "Agreement",
7        "description": "new statement",
8        "name": "features",
9        "status": "Draft",
10        "completionDate": "Fri Oct 19 00:00:00 GMT 2018",
11        "id": "800xx000000bp2PAAQ",
12        "href": "/connect/comms/agreementmanagement/v4/agreement/800xx000000bp2PAAQ",
13        "agreementType": "SampleContractType",
14        "agreementPeriod": {
15            "startDateTime": "Fri Apr 20 00:00:00 GMT 2018"
16        },
17        "associatedAgreement": [
18            {
19                "id": "800xx000000bnlNAAQ",
20                "href": "/services/data/v60.0/sobjects/Contract/800xx000000bnlNAAQ",
21                "name": "full contract 1",
22                "referredType": "Parent Contract"
23            }
24        ],
25        "agreementItem": [
26            {
27                "productOffering": [],
28                "termOrCondition": [
29                    {
30                        "description": "condition 1",
31                        "id": "1",
32                        "validFor": {
33                            "startDateTime": "Wed Apr 25 00:00:00 GMT 2018",
34                            "endDateTime": "Tue Nov 20 00:00:00 GMT 2018"
35                        }
36                    },
37                    {
38                        "description": "condition 2",
39                        "id": "2",
40                        "validFor": {
41                            "startDateTime": "Wed Apr 25 00:00:00 GMT 2018",
42                            "endDateTime": "Tue Nov 20 00:00:00 GMT 2018"
43                        }
44                    }
45                ]
46            }
47        ],
48        "engagedParty": [
49            {
50                "id": "001xx000003GYiBAAW",
51                "href": "/services/data/v60.0/sobjects/Account/001xx000003GYiBAAW",
52                "name": "Edge Communications",
53                "role": "Customer - Direct",
54                "referredType": "Account"
55            }
56        ]
57    },
58    {
59        "agreementType": "SampleContractType",
60        "documentNumber": "00000156",
61        "@type": "Agreement",
62        "description": "new statement",
63        "name": "features",
64        "completionDate": "Fri Oct 19 00:00:00 GMT 2018",
65        "id": "800xx000000bp41AAA",
66        "status": "Draft",
67        "href": "/connect/comms/agreementmanagement/v4/agreement/800xx000000bp41AAA",
68        "agreementPeriod": {
69            "startDateTime": "Fri Apr 20 00:00:00 GMT 2018"
70        },
71        "associatedAgreement": [
72            {
73                "id": "800xx000000bnlNAAQ",
74                "href": "/services/data/v60.0/sobjects/Contract/800xx000000bnlNAAQ",
75                "name": "full contract 1",
76                "referredType": "Parent Contract"
77            }
78        ],
79        "agreementSpecification": {
80            "id": "2dtxx0000000001AAA",
81            "href": "/connect/comms/AGREEMENTMANAGEMENT/v4/AGREEMENT/2dtxx0000000001AAA",
82            "name": "Test Document 2",
83            "referredType": "Document Template"
84        },
85        "agreementItem": [
86            {
87                "productOffering": [
88                    {
89                        "id": "01txx0000006i2SAAQ",
90                        "href": "/services/data/v60.0/sobjects/Product2/01txx0000006i2SAAQ",
91                        "name": "GenWatt Diesel 200kW",
92                        "referredType": "ProductOffering"
93                    },
94                    {
95                        "id": "01txx0000006i2iAAA",
96                        "href": "/services/data/v60.0/sobjects/Product2/01txx0000006i2iAAA",
97                        "name": "Installation: Industrial - Medium",
98                        "referredType": "ProductOffering"
99                    }
100                ],
101                "termOrCondition": [
102                    {
103                        "description": "condition 1",
104                        "id": "1",
105                        "validFor": {
106                            "startDateTime": "Wed Apr 25 00:00:00 GMT 2018",
107                            "endDateTime": "Tue Nov 20 00:00:00 GMT 2018"
108                        }
109                    },
110                    {
111                        "description": "condition 2",
112                        "id": "2",
113                        "validFor": {
114                            "startDateTime": "Wed Apr 25 00:00:00 GMT 2018",
115                            "endDateTime": "Tue Nov 20 00:00:00 GMT 2018"
116                        }
117                    }
118                ]
119            }
120        ],
121        "engagedParty": [
122            {
123                "id": "001xx000003GYiBAAW",
124                "href": "/services/data/v60.0/sobjects/Account/001xx000003GYiBAAW",
125                "name": "Edge Communications",
126                "role": "Customer - Direct",
127                "referredType": "Account"
128            }
129        ]
130    }
131]

GET List with Filtering for Agreement

Consider you want to retrieve all the agreement instances in the system with applied filter values.

Sample URL

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v62.0/connect/comms/agreementmanagement/v4/agreement?name=testing

Sample Response

Response displays records filtered by testing for field name.

1[
2    {
3        "agreementType": "SampleContractType",
4        "agreementPeriod": {
5            "startDateTime": "Fri Apr 20 00:00:00 GMT 2018"
6        },
7        "associatedAgreement": [...],
8        "documentNumber": "00000141",
9        "@type": "Agreement",
10        "description": "Sample description",
11        "name": "testing",
12        "completionDate": "Wed Sep 19 00:00:00 GMT 2018",
13        "id": "800xx000000boj3AAA",
14        "href": "/connect/comms/agreementmanagement/v4/agreement/800xx000000boj3AAA",
15        "agreementItem": [
16            {
17                "productOffering": [...],
18                "termOrCondition": [...]
19            }
20        ],
21        "engagedParty": [...],
22        "status": "Draft"
23    },
24    {
25        "agreementType": "SampleContractType",
26        "agreementPeriod": {
27            "startDateTime": "Fri Apr 20 00:00:00 GMT 2018"
28        },
29        "associatedAgreement": [...],
30        "documentNumber": "00000142",
31        "@type": "Agreement",
32        "agreementSpecification": {.},
33        "description": "Sample description",
34        "name": "testing",
35        "completionDate": "Wed Sep 19 00:00:00 GMT 2018",
36        "id": "800xx000000bokfAAA",
37        "href": "/connect/comms/agreementmanagement/v4/agreement/800xx000000bokfAAA",
38        "agreementItem": [
39            {
40                "productOffering": [...],
41                "termOrCondition": [...]
42            }
43        ],
44        "engagedParty": [.],
45        "status": "Draft"
46    }
47]

GET with Pagination for Agreement

Consider you want to

Retrieve a list of agreement instances
Limit the number of results to a maximum of specified limit
Start the results display from page specified by offset

Sample URL

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v62.0/connect/comms/agreementmanagement/v4/agreement?pageLimit=2&offset=5

NOTE: The above pagination query displays maximum 2 records from 5th record onwards (skips first 4 records).

Sample Response

1200 OK
2
3[
4    {
5        "documentNumber": "00000154",
6        "@type": "Agreement",
7        "description": "new statement",
8        "name": "features",
9        "status": "Draft",
10        "completionDate": "Fri Oct 19 00:00:00 GMT 2018",
11        "id": "800xx000000bp2PAAQ",
12        "href": "/connect/comms/agreementmanagement/v4/agreement/800xx000000bp2PAAQ",
13        "agreementType": "SampleContractType",
14        "agreementPeriod": {
15            "startDateTime": "Fri Apr 20 00:00:00 GMT 2018"
16        },
17        "associatedAgreement": [
18            {
19                "id": "800xx000000bnlNAAQ",
20                "href": "/services/data/v60.0/sobjects/Contract/800xx000000bnlNAAQ",
21                "name": "full contract 1",
22                "referredType": "Parent Contract"
23            }
24        ],
25        "agreementItem": [
26            {
27                "productOffering": [],
28                "termOrCondition": [
29                    {
30                        "description": "condition 1",
31                        "id": "1",
32                        "validFor": {
33                            "startDateTime": "Wed Apr 25 00:00:00 GMT 2018",
34                            "endDateTime": "Tue Nov 20 00:00:00 GMT 2018"
35                        }
36                    },
37                    {
38                        "description": "condition 2",
39                        "id": "2",
40                        "validFor": {
41                            "startDateTime": "Wed Apr 25 00:00:00 GMT 2018",
42                            "endDateTime": "Tue Nov 20 00:00:00 GMT 2018"
43                        }
44                    }
45                ]
46            }
47        ],
48        "engagedParty": [
49            {
50                "id": "001xx000003GYiBAAW",
51                "href": "/services/data/v60.0/sobjects/Account/001xx000003GYiBAAW",
52                "name": "Edge Communications",
53                "role": "Customer - Direct",
54                "referredType": "Account"
55            }
56        ]
57    },
58    {
59        "agreementType": "SampleContractType",
60        "documentNumber": "00000156",
61        "@type": "Agreement",
62        "description": "new statement",
63        "name": "features",
64        "completionDate": "Fri Oct 19 00:00:00 GMT 2018",
65        "id": "800xx000000bp41AAA",
66        "status": "Draft",
67        "href": "/connect/comms/agreementmanagement/v4/agreement/800xx000000bp41AAA",
68        "agreementPeriod": {
69            "startDateTime": "Fri Apr 20 00:00:00 GMT 2018"
70        },
71        "associatedAgreement": [
72            {
73                "id": "800xx000000bnlNAAQ",
74                "href": "/services/data/v60.0/sobjects/Contract/800xx000000bnlNAAQ",
75                "name": "full contract 1",
76                "referredType": "Parent Contract"
77            }
78        ],
79        "agreementSpecification": {
80            "id": "2dtxx0000000001AAA",
81            "href": "/connect/comms/AGREEMENTMANAGEMENT/v4/AGREEMENT/2dtxx0000000001AAA",
82            "name": "Test Document 2",
83            "referredType": "Document Template"
84        },
85        "agreementItem": [
86            {
87                "productOffering": [
88                    {
89                        "id": "01txx0000006i2SAAQ",
90                        "href": "/services/data/v60.0/sobjects/Product2/01txx0000006i2SAAQ",
91                        "name": "GenWatt Diesel 200kW",
92                        "referredType": "ProductOffering"
93                    },
94                    {
95                        "id": "01txx0000006i2iAAA",
96                        "href": "/services/data/v60.0/sobjects/Product2/01txx0000006i2iAAA",
97                        "name": "Installation: Industrial - Medium",
98                        "referredType": "ProductOffering"
99                    }
100                ],
101                "termOrCondition": [
102                    {
103                        "description": "condition 1",
104                        "id": "1",
105                        "validFor": {
106                            "startDateTime": "Wed Apr 25 00:00:00 GMT 2018",
107                            "endDateTime": "Tue Nov 20 00:00:00 GMT 2018"
108                        }
109                    },
110                    {
111                        "description": "condition 2",
112                        "id": "2",
113                        "validFor": {
114                            "startDateTime": "Wed Apr 25 00:00:00 GMT 2018",
115                            "endDateTime": "Tue Nov 20 00:00:00 GMT 2018"
116                        }
117                    }
118                ]
119            }
120        ],
121        "engagedParty": [
122            {
123                "id": "001xx000003GYiBAAW",
124                "href": "/services/data/v60.0/sobjects/Account/001xx000003GYiBAAW",
125                "name": "Edge Communications",
126                "role": "Customer - Direct",
127                "referredType": "Account"
128            }
129        ]
130    }
131]

POST an Agreement

Consider you want to create a new agreement instance.

Prerequisites These are the prerequisites for the POST operation.

The agreementType attribute must be the name of ContractType. Perform the following steps to create ContractType.
- Create a RecordType on Contract entity.
- Create a ContractType by associating it with RecordType created previously.
These are mandatory fields.
- name
- agreementType
- agreementPeriod(startDateTime)
- engagedParty
- agreementItem (productOffering + termOrCondition)
Fields engagedParty and productOffering are validated for Id-Name pair
Fields associatedAgreement and agreementSpecification are only validated for Salesforce ID. The name can be passed but it is ignored.

Sample URL

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v62.0/connect/comms/agreementmanagement/v4/agreement

Sample Request

1{
2    "name" : "features",
3    "description" : "new statement",
4    "agreementType" : "SampleContractType",
5    "agreementTerm" : "6",
6    "agreementPeriod": {
7        "startDateTime": "2018-04-20T00:00"
8    },
9    "engagedParty": [
10        {
11         "id": "001xx000003GYiBAAW",
12         "name": "Edge Communications"
13         }
14    ],
15    "associatedAgreement":
16    [
17        {
18            "id" : "800xx000000bnlNAAQ",
19            "name": "full contract"
20        }
21    ],
22    "agreementSpecification":
23        {
24            "id" : "2dtxx0000000001AAA",
25            "name": "Test Document 2"
26        }
27    ,
28    "agreementItem":
29    [
30        {
31        "productOffering": [
32            {
33            "id": "01txx0000006i2SAAQ",
34            "name": "GenWatt Diesel 200kW"
35            },
36            {
37            "id": "01txx0000006i2iAAA",
38            "name": "Installation: Industrial - Medium"
39            }
40        ],
41        "termOrCondition": [
42            {
43                "description": "condition 1",
44                "id": "1",
45                "validFor": {
46                    "startDateTime": "2018-04-25T00:00",
47                    "endDateTime": "2018-11-20T00:00"
48                }
49            },
50            {
51                "description": "condition 2",
52                "id": "2",
53                "validFor": {
54                    "startDateTime": "2018-04-25T00:00",
55                    "endDateTime": "2018-11-20T00:00"
56                }
57            }
58        ]
59        }
60  ]
61
62}

Sample Response

1{
2    "id": "800xx000000bp41AAA",
3    "href": "/connect/comms/agreementmanagement/v4/agreement/800xx000000bp41AAA",
4    "name": "features",
5    "agreementType": "SampleContractType",
6    "description": "new statement",
7    "documentNumber": "00000156",
8    "status": "Draft",
9    "@type": "Agreement",
10    "completionDate": "Fri Oct 19 00:00:00 GMT 2018",
11    "agreementPeriod": {
12        "startDateTime": "Fri Apr 20 00:00:00 GMT 2018"
13    },
14    "engagedParty": [
15        {
16            "id": "001xx000003GYiBAAW",
17            "href": "/services/data/v60.0/sobjects/Account/001xx000003GYiBAAW",
18            "name": "Edge Communications",
19            "role": "Customer - Direct",
20            "referredType": "Account"
21        }
22    ],
23    "associatedAgreement": [
24        {
25            "id": "800xx000000bnlNAAQ",
26            "href": "/services/data/v60.0/sobjects/Contract/800xx000000bnlNAAQ",
27            "name": "full contract 1",
28            "referredType": "Parent Contract"
29        }
30    ],
31    "agreementSpecification": {
32        "id": "2dtxx0000000001AAA",
33        "href": "/connect/comms/AGREEMENTMANAGEMENT/v4/AGREEMENT/2dtxx0000000001AAA",
34        "name": "Test Document 2",
35        "referredType": "Document Template"
36    },
37    "agreementItem": [
38        {
39            "productOffering": [
40                {
41                    "id": "01txx0000006i2SAAQ",
42                    "href": "/services/data/v60.0/sobjects/Product2/01txx0000006i2SAAQ",
43                    "name": "GenWatt Diesel 200kW",
44                    "referredType": "ProductOffering"
45                },
46                {
47                    "id": "01txx0000006i2iAAA",
48                    "href": "/services/data/v60.0/sobjects/Product2/01txx0000006i2iAAA",
49                    "name": "Installation: Industrial - Medium",
50                    "referredType": "ProductOffering"
51                }
52            ],
53            "termOrCondition": [
54                {
55                    "description": "condition 1",
56                    "id": "1",
57                    "validFor": {
58                        "startDateTime": "Wed Apr 25 00:00:00 GMT 2018",
59                        "endDateTime": "Tue Nov 20 00:00:00 GMT 2018"
60                    }
61                },
62                {
63                    "description": "condition 2",
64                    "id": "2",
65                    "validFor": {
66                        "startDateTime": "Wed Apr 25 00:00:00 GMT 2018",
67                        "endDateTime": "Tue Nov 20 00:00:00 GMT 2018"
68                    }
69                }
70            ]
71        }
72    ]
73}

PATCH an Agreement

Consider you want to update details of a particular agreement instance.

NOTE:

Following are patchable attributes.
- description
- engagedParty
- associatedAgreement
- agreementSpecification
- agreementItem
Fields associatedAgreement and agreementSpecification are only validated for Salesforce ID. The name can be passed but it is ignored.

Sample URL

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v62.0/connect/comms/agreementmanagement/v4/agreement/2dtxx00000000eLAAQ

Sample Request

Request body will have fields that need to be updated.

1{
2    "description" : "Sample description - updated",
3    "engagedParty": [
4        {
5         "id": "001xx000003GYiGAAW",
6         "name": "United Oil & Gas Corp."
7         }
8    ],
9    "associatedAgreement":
10    [
11        {
12            "id" : "800xx000000bnmzAAA",
13            "name": "full contract 2"
14        }
15    ],
16    "agreementSpecification":
17        {
18            "id" : "2dtxx000000001dAAA",
19            "name": "Test Document 3"
20        }
21    ,
22    "agreementItem": [
23        {
24        "productOffering": [
25            {
26            "id": "01txx0000006i2TAAQ",
27            "name": "GenWatt Diesel 10kW"
28            }
29        ],
30        "termOrCondition": [
31            {
32            "description": "updated termOrCondition",
33            "id": "1",
34            "validFor": {
35                "startDateTime": "2018-04-25T00:00",
36                "endDateTime": "2019-11-20T00:00"
37            }
38            }
39      ]
40    }
41  ]
42}

Sample Response

1{
2    "id": "800xx000000bp41AAA",
3    "href": "/connect/comms/agreementmanagement/v4/agreement/800xx000000bp41AAA",
4    "name": "features",
5    "agreementType": "SampleContractType",
6    "description": "Sample description - updated",
7    "documentNumber": "00000156",
8    "status": "Draft",
9    "@type": "Agreement",
10    "completionDate": "Fri Oct 19 00:00:00 GMT 2018",
11    "agreementPeriod": {
12        "startDateTime": "Fri Apr 20 00:00:00 GMT 2018"
13    },
14    "engagedParty": [
15        {
16            "id": "001xx000003GYiGAAW",
17            "href": "/services/data/v60.0/sobjects/Account/001xx000003GYiGAAW",
18            "name": "United Oil &amp; Gas Corp.",
19            "role": "Customer - Direct",
20            "referredType": "Account"
21        }
22    ],
23    "associatedAgreement": [
24        {
25            "id": "800xx000000bnmzAAA",
26            "href": "/services/data/v60.0/sobjects/Contract/800xx000000bnmzAAA",
27            "name": "full contract 1",
28            "referredType": "Parent Contract"
29        }
30    ],
31    "agreementSpecification": {
32        "id": "2dtxx000000001dAAA",
33        "href": "/connect/comms/AGREEMENTMANAGEMENT/v4/AGREEMENT/2dtxx000000001dAAA",
34        "name": "Test Document 3",
35        "referredType": "Document Template"
36    },
37    "agreementItem": [
38        {
39            "productOffering": [
40                {
41                    "id": "01txx0000006i2TAAQ",
42                    "href": "/services/data/v60.0/sobjects/Product2/01txx0000006i2TAAQ",
43                    "name": "GenWatt Diesel 10kW",
44                    "referredType": "ProductOffering"
45                }
46            ],
47            "termOrCondition": [
48                {
49                    "description": "updated termOrCondition",
50                    "id": "1",
51                    "validFor": {
52                        "startDateTime": "Wed Apr 25 00:00:00 GMT 2018",
53                        "endDateTime": "Wed Nov 20 00:00:00 GMT 2019"
54                    }
55                }
56            ]
57        }
58    ]
59}

DELETE an Agreement

Consider you want to delete details of a particular agreement instance.

Sample URL

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v62.0/connect/comms/agreementmanagement/v5/agreement/2dtxx00000000eLAAQ

Sample Request

No request body.

Sample Response

Status code 204 with no response body