GET /agreementmanagement/agreement/{id}
The Agreemenr is mapped to a Salesforce Contract object and will retrieve an individual Agreement.
| RESOURCE | ELEMENT | SALESFORCE FIELD | OTB MAPPING |
|---|---|---|---|
| { | |||
| agreementPeriod.StartDate | Contract.StartDate | YES | |
| agreementPeriod.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.statementOfIntent | NEW | |
| status | Contract.status | YES | |
| type | Contract.type | NEW | |
| version | Contract.version | NEW | |
| agreementSpecification[] | NO | ||
| agreementItem[] | NO | ||
| engagePartyRole[] | Contract.AccountID | YES | |
| agreementAuthorisation.signatureRepresentation | Contract.CustomerSignedId.name | YES | |
| agreementAuthorisation.state | NO | ||
| characteristic[] | NO | ||
| associatedAgreement[] | NO | ||
| } |
POST /agreementManagement/agreement
Creating an Agreement is supported (not all fields) - this in trun will create a Salesforce Contract object.
| RESOURCE | ELEMENT | SALESFORCE FIELD | OTB MAPPING |
|---|---|---|---|
| { | |||
| name | Contract.name | YES | |
| type | Contract.type | NEW | |
| agreementItem[] | NO | ||
| engagedPartyRole.id | Contract.AccountId | YES (required) | |
| engagedPartyRole.Name | NO | ||
| engagedPartyRole.partyId | NO | ||
| engagedPartyRole.partyName | NO | ||
| startDate | Contract.StartDate | (required by Salesforce) | |
| } |
PATCH /agreement/{id}
Partial update supported (not all fields)
| RESOURCE | ELEMENT | SALESFORCE FIELD | OTB MAPPING |
|---|---|---|---|
| { | |||
| agreementPeriod.StartDate | Contract.StartDate | YES | |
| agreementPeriod.EndDate | ContractEndDate | YES | |
| description | Contract.description | YES | |
| documentNumber | Contract.contractNumber | YES | |
| name | Contract.name | YES | |
| statementOfIntent | Contract.statementOfIntent | NEW | |
| status | Contract.status | YES | |
| type | Contract.type | NEW | |
| version | Contract.version | NEW | |
| agreementSpecification[] | NO | ||
| agreementItem[] | NO | ||
| engagePartyRole[] | Contract.AccountID | YES | |
| agreementAuthorisation.signatureRepresentation | Contract.CustomerSignedId.name | YES | |
| agreementAuthorisation.state | NO | ||
| characteristic[] | NO | ||
| associatedAgreement[] | NO | ||
| } |
DELETE /agreement/{id}
Delete agreement by ID is supported
agreement Specification Operations
Salesforce does not have the concept of a specification out of the box - these OPEN API operations are not currently supported