The terminateAgreementsAsync API allows you to bulk terminate agreements based on the agreement status.

API

Signature

terminateAgreementsAsync

webService static Id terminateAgreementsAsync(List agreementIds)

Request Parameters

Name

Type

Description

Required?

agreementIds

List<ID>

List of agreement Ids

Yes


Code Sample

List<ID> agreementIdList = new List<ID> ();
Boolean response = Apttus.AgreementWebService.terminateAgreementsAsync(agreementIdList);
CODE

Use Case

Bulk terminate agreements and their related agreements with the same agreement number.

Order of Execution

  1. Check permissions.
  2. Get the agreement object.
  3. Register the terminate indicator.
  4. Terminate the agreement.
  5. Save the terminated agreement.
  6. Reset the terminate indicator.
  7. Refresh the original agreement.
  8. Post-termination updates.

Integration Details

Use the following information in your integrations with Apttus Contract Management Web Services API. For information on how to get started, refer to Integrating Conga CLM with External Systems.

API Prerequisites

None.

Request/Response XML

Example Request

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
	xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
	xmlns:agr="http://soap.sforce.com/schemas/class/Apttus/AgreementWebService">
	<soapenv:Header>
		<agr:SessionHeader>
			<agr:sessionId>00D020000008lUh!AQYAQEEW..3lVJKVa9atZ.0B6NtzfwyA.27WJEfZds4IqJX8uzm8O7.VdNoOTWwjGFxgbrF03ylztaIg6VvFl_EeKVGaQccY</agr:sessionId>
		</agr:SessionHeader>
	</soapenv:Header>
	<soapenv:Body>
		<agr:terminateAgreement>
			<agr:agreementId>a07020000008w9GAAQ</agr:agreementId>
		</agr:terminateAgreement>
	</soapenv:Body>
</soapenv:Envelope>
XML

Example Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="http://soap.sforce.com/schemas/class/Apttus/AgreementWebService">
   <soapenv:Body>
      <terminateAgreement>
         <result>a09R000000Alm7iIAB</result>
      </terminateAgreement>
   </soapenv:Body>
</soapenv:Envelope>
XML