Create a Contract

Prerequisites:

  • You have the Subscription Key and Account Key that are needed for authentication. If you need these, speak with your IntelAgree Account Manager or Implementation Manager.

  • You have a valid authentication token

Please see the Getting Started page for more information about how to obtain an authentication token, as well as a description of Business Keys and Impersonation, which are used when you create a Party. You can also download a Postman file from that page, which contains this and all other API operations so that you can test them.

Create Contract

To create a Contract from a ContractTemplate, you will call the POST /contracts operation with the following information:

Headers:

  • "ApiVersion": "2.0", Required to specifiy version 2 of the API.

  • "Ocp-Apim-Subscription-Key": Your subscription key. Required for all calls to the API

  • "Authorization": Your authorization Bearer token. Required for all authenticated calls to the API

  • "AsUserType": The BusinessKeyType for the user that is creating the contract. Required, since user impersonation is required to create a contract

  • "AsUserKey": The BusinessKey Value for the user that is creating the contract. Required, since user impersonation is required to create a contrac

Request Body:

  • "name": Required string. The name of the contract

  • "organizationId": Required integer. The ID of the Organization for this contract
    Note: You can call GET /organizations to get a list of Organizations with their IDs

  • "contractTemplateId": Required integer. The ID of the ContractTemplate to be used to generate the contract
    Note: You can call GET /contractTemplates to get a list of ContractTemplates with their IDs

  • "partyBusinessKey": Required BusinessKey identifying the party to associate the contract with

  • "parentContractKey": Optional BusinessKey identifying the contract that is the parent to the new contract

  • "ownerKey": Optional BusinessKey identifying the user that owns the contract in IntelAgree

  • "signers": Optional list of signers

  • "notificationRecipients": Optional list of people who should receive a copy of the final contract

  • "attributes": Optional list of contract attribute data to supply with the contract

  • "attachments": Optional list of files to attach to the contract

  • "legalEntityId": Optional integer. The ID of the Legal Entity to associate the contract with. If not provided, the default Legal Entity for the Organization will be used.
    Note: You can call GET /legalEntities to get a list of Legal Entities with their IDs

  • "submitForSigning": Optional boolean. If true, the contract will be sent out for signing immediately, if possible

  • "isRequest": Optional boolean. If true, this will be a contract Request that will require review and approval before getting generated

  • "currencyCode": Optional string. The 3-letter currency code for the currency used in the contract

  • "dueDate": Optional Date. The due date for contract request review and approval. Only applies if isRequest is true

  • "commant": Optional string. A comment to be included with the contract

  • "effectiveDate": Optional Date. The date that the contract is effective

  • "expirationDate": Optional Date. The date that the contract expires

  • "originUrl": Optional string. A URL that will display in IntelAgree to navigate users to the integrated system and object that originated this contract