Decline a contract by ID

post https://{hostname}/v1/contracts/{contract_id}/decline

Use this endpoint to decline a contract by contract ID via API.

Responses

Response body

object

declined_by

object

required

Details of the ownerside participant who declined the contract

name

string

required

string

required

declined_date

string

required

contract

object

required

See Contract.

_links

object

Links to related endpoints.

_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.'

_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

See Private

_private_ownerside

object | null

required

Contract data that is private to the ownerside.

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.

integer

required

name

string | null

required

The name of the file.

size

integer | null

required

The size of the file in bytes.

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.

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

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.

integer

required

lifecycle_settings

object | null

required

See Lifecycle settings.

lifecycle_state

object | null

required

Lifecycle information of the contract. See Lifecycle state.

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.

integer

required

name

string | null

required

The name of the file.

size

integer | null

required

The size of the file in bytes.

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

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

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

200Returns the declined contract response.