Add new contract

post

https://app.officernd.com/api/v2/organizations/{orgSlug}/contracts

Option 1 - Create a contract of a type, that requires at least one resource.
You can add secondary items such as recurring plans and one-off plans as well, if the contract type allows it.

Option 2 - Create a contract of a type, that requires at least one recurring plan.
You can add secondary items such as resources and one-off plans as well, if the contract type allows it

Option 3 - Create a contract of a type, that requires at least one one-off plan.
You can add secondary items such as recurring plans and resources as well, if the contract type allows it

Required scopes: flex.community.contracts.create

Path Params

orgSlug

string

required

organization slug

Body Params

notice

object

The number of months notice period for the contract.

properties

object

An object that contains all custom properties that can be applied to the item.

documentType

string

required

The type of the contract. Check "Settings"->"Platform"->"Contracts" to see what types are available.

company

string

required

The _id of the company associated with the contract.

member

string

required

The _id of the member associated with the contract.

location

string

The _id of the location associated with the contract.

deal

object

External CRM deal information associated with the contract.

startDate

string

required

The start date of the contract.

endDate

string

The end date of the contract.

plans

array of objects

required

An array containing all recurring plans that will be associated with the contract.

plans*

oneOffPlans

array of objects

required

An array containing all one-off plans that will be associated with the contract.

oneOffPlans*

resources

array of objects

required

An array containing all resources that will be associated with the contract.

resources*

legalDocuments

array of strings

An array with the ids of the legal documents attached to the contract.

legalDocuments

addendum

string

An addendum to the contract.

number

string

The number/name of the contract. If not written it will be automatically generated using organization's settings

isRolling

boolean

A true/false value that decides if the contract is rolling or not

percentagePriceIncrease

number

Percentage price increase of the contract.

type

string

enum

The type of the contract.

Allowed:

Response

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201