The contract template is used as a model to create a new contract. Templates are created using the Template editor in the Oneflow app.

🚧

Note:

Templates cannot be created or edited via the API.

Template attributes

The table below contains the list of all the attributes available for each template.

AttributeTypeDescription
_linksobjectContains links to endpoints associated with the parent object. See Links.
available_optionsobjectProvides information about the capabilities of the contract. See Available options.
configurationobjectThe configuration details of the template. See Configuration.
created_timestring(datetime)The time the template was created.
idinteger(signed_integer_id)The ID of the template.
namestring or nullA short descriptive name of the template, like "Shoe sales proposal".
partiesarrayThe list of parties in the contract, representing companies, organizations, individuals, government departments, etc. See Party.
product_groupsarrayThe list of product groups. See Product group.
template_typeobjectThe type of template. See Template type.
updated_timestring(datetime)The time the template was last updated.
workspacesarryThe list of workspaces to which the template belongs or has been shared, and which the current user has accessed, along with their respective workspace names and IDs.

Configuration

AttributeTypeDescription
default_creator_rolesobjectThe default creator role of the template. This decides which role the creator will get when a contract is created. This is indicated using a combination of attributes. See Default_creator_roles.

Default_creator_roles

AttributeTypeDescription
_permissionsobjectDefines the permission for the default creator role. See Permissions.
organizerbooleanA flag to indicate the creator is an owner-side internal participant.
signatorybooleanIndicates if the creator can sign the contract.

πŸ“˜

Note:

See Combining participant flags and permissions for more details on Roles in the Oneflow application.