...
/agreementmanagement/agreement/{id}
Supporetd Methods
GET, PATCH, PUT
Description
The
...
agreement service is primarily mapped to
...
the Salesforce Contract objects. The service can either be used to retrieved a collection or a specific record (using {ID} at the end of the service). This service is partially supported (i.e. only fields and sub entities that conform to Salesforce model are mapped).
| RESOURCE | ELEMENT | SALESFORCE FIELD | OTB MAPPING |
|---|---|---|---|
| { | |||
| StartDate | Contract.StartDate | YES |
| EndDate | ContractEndDate | YES | |
| completionDate | NO | ||
| description | Contract.description | YES | |
| documentNumber | Contract.contractNumber | YES | |
| href | GENERATED | ||
| id | Contract.id | YES | |
| name | Contract.name | YES | |
| statementOfIntent | Contract. |
| TMF_Statement_of_Intent__c | NEW | ||
| status | Contract.status | YES | |
| type | Contract.type | NEW | |
| version | Contract. |
| TMF_Version__c | NEW | ||
| agreementSpecification[] | NO | ||
| agreementItem[] | NO | ||
| engagePartyRole[] | Contract.AccountID |
| NO | ||
| agreementAuthorisation.signatureRepresentation | Contract.CustomerSignedId |
POST /agreementManagement/agreement
...
| . |
...
| name |
| NO | |
PATCH /agreement/{id}
Partial update supported (not all fields)
| agreementAuthorisation.state | NO | ||
| characteristic[] | NO | ||
| associatedAgreement[] | NO | ||
| } |
...
DELETE /agreement/{id}
Delete agreement by ID is supported
agreement Specification Operations
...