eoCreateTransaction

Action Parameter eoCreateTransaction
Purpose To establish a new transaction within the organization
Description A transaction "folder" is created in the client application which enables the application to manage all the documents for a business transaction, such as a loan, rental agreement, lease, etc.
Type Granular
Preconditions None
Implementation Notes Prior to implementing workflow to create and facilitate document execution on subsequent new Transaction records for the same business exchange, please consult with your eOriginal Professional Services Project Manager, Implementation Engineer, or Solutions Architect for specific guidance on your use-case.
If a Transaction Type has been established for your Transactions, ensure that the Transaction Type value is passed within the transactionTypeName parameter.

Parameters

Required Parameter Value Description
required transactionName Transaction's name
loanOriginationId Loan Origination ID
transactionDescription Transaction's description; if not provided, the default is null.
transactionTypeName A pre-configured template that can set a default name, description, task template, state, business process, and DPTs.
transactionBusinessProcessName Container Permission name applied to transaction; if not provided, the default is the organization's default Container Permission.
transactionRetentionPolicyName Retention policy applied to a transaction
transactionStateName The state to use for this transaction.
transactionXRef1 Transaction's cross-reference (first); if not provided, the default is null.
transactionXRef2 Transaction's cross-reference (second); if not provided, the default is null.
transactionXRef3 Transaction's cross-reference (third); if not provided, the default is null.
customField Name of custom field configured for organization
transactionExtraData Transaction's extra data; if not provided, the default is null.
Note 1 dptName Name of the DPT used to create the document profile
dpName Name of the DP to be created
configureSmartSign When true and a transaction type is used, default sort order and role information will be configured.
sendInviteTemplate Email template to be used for any default role configurations with a routing order of 1. Requires a transaction type and configureSmartSign set to true.

Note 1: If dptName is not passed, a Document Profile will not be created.

Response

We recommend using the most recent version of FireFox while testing API calls via your web browser. Microsoft Edge and Google Chrome require 3rd party XML extensions to display the XML response natively in your browser.