Create a Contract

Prerequisites: Provided Subscription Key and Account Key.

Authentication

Click here to view the request to authorize an account.

1.      Click “Try it” to begin building the authorize account request.

2.      Enter your Subscription Key into the the Subscription Key header field.

3.      In the request body paste your Account Key.

4.      Click the send button at the bottom of the screen.

5.      The response is a json object that contains the authentication token.

The authentication token and the subscription key are required on subsequent requests to the IntelAgree API.

Get Organizations

Click here to view the request to get a collection of Organizations.

1.      Click “Try it” to begin building the Get Organizations request.

2.      Enter your Subscription Key into the the Subscription Key header field.

3.      Add an Authorization header to the request and paste the previously requested authentication token into the value of the header.

  1. Example - Authorization: Bearer {{authToken}}

4.      The request takes two parameters

  1. userKey – Business key value for a user

  2. userKeyType – Business system of the user’s Business Key

5.      The response is a collection of Organizations the user is authorized to read.

6.      Store the desired Organization Id and a Legal Entity Id for the Create Contract request.

Get Contract Templates

Click here to view the request to get a collection of Contract Templates.

1.      Click “Try it” to begin building the Get Contract Templates request.

2.      Enter your Subscription Key into the the Subscription Key header field.

3.      Add an Authorization header to the request and paste the previously requested authentication token into the value of the header.

  1. Example - Authorization: Bearer {{authToken}}

4.      The request takes two parameters

  1. userKey – The user’s Business Key value

  2. userKeyType –The Business Key’s System name

5.      The response is a collection of Contract Templates user is authorized to read.

6.      Store the desired Contract Template Id for the Create Contract request. The Contract Template’s Organization Id must match the Organization Id from the Get Organizations request.

Create Contract

Click here to view the request to create a contract.

1.      Click “Try it” to begin building the Create Contract request.

2.      Enter your Subscription Key into the the Subscription Key header field.

3.      Add an Authorization header to the request and paste the previously requested authentication token into the value of the header.

  1. a.      Example - Authorization: Bearer {{authToken}}

4.      Build the request body.

  1. contractTemplateId – use the value from the Get Contract Templates request

  2. name - name of the contract

  3. organizationId - use the value from the Get Organizations request

  4. legalEntityId - use the value from the Get Organizations request

  5. effectiveDate(optional) - a string representation of the effective date

  6. expirationDate(optional) - a string representation of the expiration date

  7. parentBusinessKey(optional) – this object can be used to identify the parent Contract Key

  8. attributes – a collection of attributes and values to include on this contract

    1. mappedId – business key value of the attribute

    2. value – the attribute’s value on the contract to be created

  9. businessKeys – a collection of business keys to identify the Party Key and the Created User Key

    1. Example – [{"entity": "Party", "name": "{{businessSystem}}", "value": "{{businessKey}}" }, {"entity": "User", "name": "{{businessSystem}}", "value": "{{businessKey}}"}]

Additional Documentation:

https://apim-portal.intelagree.com/apis