TMF651 v4 Agreement Management API

• The TMF651 API provides a standardized mechanism for managing agreements, especially in the context of partnerships between partners.
• The TMF651 API allows the following operations.
  • Creating, updating, and querying of agreement instances.
  • Creating, updating, and querying of agreement specifications, that act as templates for agreement instances.

The Agreement Management API is certified by TM Forum.

• Following block diagram provides a high-level overview of how the various components are involved in handling TMF651 API operations (GET, POST, PATCH, and DELETE).
• Using TMF651 API for agreement specification you can perform the following operations.
  • Retrieve the list of agreement specifications from the system
  • Get the agreement specification details
  • Create an agreement specification
  • Update an existing agreement specification
  • Delete an existing agreement specification
• Using TMF651 API for agreements you can perform the following operations.
  • Retrieve the list of agreement instances from the system
  • Get the agreement instance details
  • Create an agreement instance
  • Update an existing agreement instance
  • Delete an existing agreement instance

• Required Platform license: Contract Management.
• Required Addon: ContractManagementAddon, DocGenDesigner.
• Enable Salesforce Contracts on the org.
• Required Org permissions: ContractMgmt, DocGen, and CommsCloud.

Refer the following table, which lists sample URL for the respective TMF651 API resources.

To access and use the TMF651 API:

1. Read and accept the terms and conditions of usage. See Accept Terms and Enable Access.
2. Authorize and use a connected app and an OAuth 2.0 authorization flow. See Authorize Access.
3. Trigger the API call. Refer the above section for sample URL.
4. Use the TMF651 API endpoints. See TMF651 API Endpoints.