Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Contracts / Contract Create

  • Article
  • 4 minutes to read

Operation Information

Creates a Salesforce Contract.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type oAuth 2.0.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose oAuth 2.0 in the Type pick list;
  • Give the oAuth 2.0 KeySafe key a Title (this is the name / identifier for the oAuth 2.0 account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
Client Id string Application Client Id
Client Secret string Application Client Secret
oAuth Scope string Application oAuth Scope
Authorize URL string Application Authorize URL
Access URL string Application Access UR
Response Type string Application Response Type
Additional Params string Application Additional Params
Additional Access Token Params string Application Additional Access Token Request Params
Grant Type string Application Grant Type
Refresh URL string Application Refresh URL
Refresh Grant Type string Application Refresh Grant Type
Refresh Body string Application Refresh Body
Revoke URL string Token Revoke URL
Token string Authentication Token
Refresh Token string Refresh Token
API Endpoint string Optional API Endpoint

Tip

Client ID and Client Secret should be populated with a valid Consumer Key and Consumer Secret. Values for the Authorize, Access, Refresh and Revoke URLs can be found on the Salesforce website.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked oAuth 2.0 account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Account ID accountId string ID of the account this contract will be associated with Yes None provided
Billing City billingCity string Details for the billing address. Maximum size is 40 characters No None provided
Billing Country billingCountry string Details for the billing address of this contract. Maximum size is 80 characters No None provided
Billing Country Code billingCountryCode string The ISO country code for the contract’s billing address No None provided
Billing Postal Code billingPostalCode string Details for the billing address of this contract. Maximum size is 20 characters No None provided
Billing State billingState string Details for the billing address. Maximum size is 80 characters No None provided
Billing State Code billingStateCode string The ISO state code for the contract’s billing address No None provided
Billing Street billingStreet string Street address for the billing address No None provided
Company Signed Date companySignedDate string Date on which the contract was signed by your organization No None provided
Company Signed ID companySignedId string ID of the User who signed the contract No None provided
Contract Term contractTerm number Number of months that the contract is valid No None provided
Customer Signed Date customerSignedDate string Date on which the customer signed the contract No None provided
Customer Signed ID customerSignedId string ID of the Contact who signed this contract No None provided
Customer Signed Title customerSignedTitle string Title of the customer who signed the contract No None provided
Description description string Mailing Country for the contact No None provided
Owner Expiration Notice ownerExpirationNotice number Number of days ahead of the contract end date (15, 30, 45, 60, 90, and 120). Used to notify the owner in advance that the contract is ending No 15, 30, 45, 60, 90, 120
Owner ID ownerId string ID of the user who owns the contract No None provided
Shipping City shippingCity string Details of the shipping address. City maximum size is 40 characters No None provided
Shipping Country shippingCountry string Details of the shipping address. Country maximum size is 80 characters No None provided
Shipping Country Code shippingCountryCode string The ISO country code for the contract’s shipping address No None provided
Shipping Postal Code shippingPostalCode string Details of the shipping address. Postal code maximum size is 20 characters No None provided
Shipping State shippingState string Details of the shipping address. State maximum size is 80 characters No None provided
Shipping State Code shippingStateCode string The ISO state code for the contract’s shipping address No None provided
Shipping Street shippingStreet string The street address of the shipping address. Maximum of 255 characters No None provided
Special Terms specialTerms string Special terms that apply to the contract No None provided
Start Date startDate string Start date for this contract No None provided
Status status string Contract status No None provided
Status Code statusCode string The status category for the contract No Draft, InApproval, Activated

Output Parameters

Display Name ID Type Description
ID id string ID of the contract that was generated
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document