Overview

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.
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

In general, we can consider the following use cases listed based on the operation you want to perform.

Starting from the Winter ’27 release, only the Direct Access option will be supported. The MuleSoft gateway option will be deprecated, and customers must update their integrations to use the Connect/Apex REST endpoints for continued access to the inbound APIs.

Important

Assumptions

It is assumed that you have completed the following.

Enabling Access to Industry APIs
Ensuring that the required licenses and data packs are installed. For more information.

Sequence of Operations

Following block diagram provides a sequence of operations involved.

NOTE:

For mandatory fields and resource mappings, refer TMF651 Resource Mappings.