Create a contract

post https://{hostname}/v1/contracts/create

Use this endpoint to create a new contract based on the selected template.

Body Params

Request body parameters for creating a contract.

workspace_id

integer

required

The unique ID of the workspace.

template_id

integer

required

The unique ID of the template.

data_fields

array of objects

The data fields to be included in the contract.

data_fields

folder_id

integer

The unique ID of the folder.

my_party

object

Legal entity representing the party of the current user's Oneflow account (the owner side party).

name

string

length between 0 and 130

parties

array of objects

length between 0 and 40

The list of parties in the contract, representing companies, organizations, government departments, etc. Each party object must follow the object representation of either the individual or the company type of party.

parties

product_groups

array of objects

The list of product groups (product tables) in the template or contract. It is possible to add products to multiple product groups if these product groups exist in the template. Ensure that the template for your contract contains at least one product table. Otherwise, the product_groups setting will fail. Note that if your template contains only one product table, it is not mandatory to include the product group id in the request. Note that by default, the limit for products per contract is 150 (includes all product tables). This can be increased for your account if desired by contacting Oneflow support.

product_groups

tags

array of objects

List of tags for contract.

tags

value

object | null

The deal size of a contract as an amount of money.

Headers

x-oneflow-api-token

string

required

length between 40 and 40

The API key of your Oneflow account.

x-oneflow-user-email

string

required

The email address of a registered Oneflow user.

Responses

Response body

object

_links

object

Links to related endpoints.

comments

object

contracts

object

contract

object

create

object

data_field

object

data_fields

object

events

object

event

object

files

object

file

object

next

object

parties

object

party

object

previous

object

publish

object

self

object

template_types

object

template_type

object

template

object

templates

object

workspaces

object

workspace

object

_permissions

object

required

This attribute contains the permissions for various operations possible on the contract. The format of the permission is 'contract:' followed by the specific operation, like 'contract:create.'

contract:delete

boolean

required

contract:download:pdf

boolean

required

contract:send

boolean

required

_integration_permissions

array of objects

A list of integration specific permissions. This exists only for specific integration tokens

_integration_permissions

object

key

string

required

value

string

required

_private

object

required

date_format

string

required

The date format of the contract.

value

object | null

required

See Contract value.

folder

object

required

A folder.

name

string

required

length between 0 and 130

The name of the contract.

signing_period_expiration

required

workspace_id

integer | null

required

The unique id of this workspace.

single_sign

boolean

State of the feature single sign

_private_ownerside

object | null

required

Contract data that is private to the ownerside.

created_time

string

required

template_id

integer | null

required

template_type_id

integer | null

required

attachment_file_groups

array of objects

required

A list of attachment type file groups in the contract.

attachment_file_groups*

object

_private_ownerside

object | null

required

File group data that is private to the ownerside.

files

array of objects

required

files*

object

_private_ownerside

object | null

required

File data that is private to the ownerside.

extension

string | null

required

The file extension.

id

integer

required

name

string | null

required

The name of the file.

size

integer | null

required

The size of the file in bytes.

id

integer

required

type

string

required

The file group type of the file group sections. There are only two types available, attachment and pdf.

attachment pdf

available_options

object

required

Available options in the contract. See Available options.

can_receive_attachments

boolean

required

can_receive_expanded_pdf

boolean

required

can_receive_products

boolean

required

delivery_channels

array of objects

required

delivery_channels*

object

name

string

required

One of the contract delivery channels.

email sms email_and_sms same_device none unknown

preferred

boolean

required

required_participant_attributes

array of strings

required

required_participant_attributes*

sign_methods

array of objects

required

sign_methods*

object

name

string

required

One of the sign methods.

standard_esign sms swedish_bankid norwegian_bankid danish_mitid finnish_bankid handwritten_signature eid_sign unknown

preferred

boolean

required

two_step_authentication_methods

array of objects

required

two_step_authentication_methods*

object

name

string

required

One of the two step authentication methods.

email sms personal_identification none unknown

preferred

boolean

required

required_participant_attributes

array of strings

required

required_participant_attributes*

data_fields

array of objects

required

The data fields that are part of the contract.

data_fields*

object

_links

object

Links to related endpoints.

_private_ownerside

object

required

Data field attributes that are private to the ownerside.

description

string

required

length between 0 and 300

id

integer

required

name

string

required

length between 1 and 100

placeholder

string

required

length between 0 and 100

value

string

required

length ≥ 0

draft_approval_workflow

object | null

Draft approval work flow details.

status

string | null

id

integer

required

lifecycle_settings

object | null

required

See Lifecycle settings.

duration

string | null

required

end_date

date | null

required

initial_duration

string | null

required

notice_period

string | null

required

start_date

date | null

required

type

string

required

One of the contract duration types.

no_duration single_period recurring recurring_two_periods unknown

lifecycle_state

object | null

required

Lifecycle information of the contract. See Lifecycle state.

composite

string

required

One of the lifecycle composites.

awaiting awaiting-recurring active active-recurring active-canceled-recurring ended ended-terminated ended-terminated-recurring

contract_end_time

string | null

required

contract_start_time

string | null

required

cancel_time

string | null

required

has_ended_by_termination

boolean

required

has_passed_notice_period_start_time

boolean

required

is_canceled

boolean

required

is_recurring

boolean

required

lifecycle_state

string

required

One of the lifecycle states.

awaiting active ended unknown

lifecycle_state_updated_time

string

required

notice_period_start_time

string | null

required

period

integer | null

required

period_end_time

string | null

required

period_start_time

string | null

required

links

array

All links on the contract. These links can be either internal or external (links is only available in the Get a contract by ID response)

links

marked_as_signed

boolean | null

A flag denoting whether the contract has been marked as signed or not.

parties

array

required

The parties involved in this contract.

parties*

pdf_file_groups

array of objects

required

A list of expanded pdf type file groups in the contract.

pdf_file_groups*

object

_private_ownerside

object | null

required

File group data that is private to the ownerside.

files

array of objects

required

files*

object

_private_ownerside

object | null

required

File data that is private to the ownerside.

extension

string | null

required

The file extension.

id

integer

required

name

string | null

required

The name of the file.

size

integer | null

required

The size of the file in bytes.

id

integer

required

type

string

required

The file group type of the file group sections. There are only two types available, attachment and pdf.

attachment pdf

product_groups

array of objects

required

A list of product groups.

product_groups*

object

_private_ownerside

object | null

required

Product group data that is private to the ownerside.

configuration

object

required

Updated product group configuration

created_from

integer | null

This will be only available in the contract create response.

enabled_columns

array of objects

required

enabled_columns*

object

enabled

boolean

required

key

string

required

length between 0 and 80

id

integer

required

products

array of objects

required

products*

object

_private_ownerside

object | null

required

Product data that is private to the ownerside.

counterparty_lock

boolean

created_from

integer | null

This will be only available in the contract create response.

description

string

length between 0 and 3000

id

integer

required

name

string

required

length between 0 and 80

price_1

object | null

required

An object that holds all price related information for an individual product.

price_2

object | null

required

An object that holds all price related information for an individual product.

quantity

object

required

The object holds information about the quantity of an individual product. The default quantity type is multiple_choice. If the quantity type is single_choice or multiple_choice, the amount must be set to 0 or 1. If the quantity type is set to single_choice, the amount must be set to 1 at least for one product, and 0 for the rest of the products in the same product group with the quantity type single_choice.

published_time

string | null

required

sign_later

boolean

A flag to indicate if the contract signing is postponed.

sign_order

array of objects

required

Sign order of the participants.

sign_order*

object

participant_id

integer

required

participant ID

order

integer

required

1 to 1000

Sign order

signing_period_expiry_time

string | null

required

state

string

required

One of the contract states.

draft pending overdue signed declined unknown

state_updated_time

string

required

tags

array of objects

required

All tags associated with the contract.

tags*

object

id

integer

required

name

string

required

length ≥ 1

updated_time

string | null

required

400

Invalid format or content of the request.

404

A required entity is missing.

409

A conflict occurred with the current state of the target resource.

Language

URL


xxxxxxxxxx
11
1
curl --request POST \
2
     --url https://api.oneflow.com/v1/contracts/create \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "my_party": {
8
    "creator_inherit_settings_from_template": false
9
  }
10
}
11
'

Choose an example:

application/json