The contract objects allow you to associate contract data to your companies. Contracts can contain terms for both Services and Private offices.
The API allows you to create, delete, and update contracts.
You can retrieve individual contracts as well as a list of all your contracts.
Here is the list of some of the properties the contract object has:
Contract
| Property | Type | Required | Description |
|---|---|---|---|
| number | string | false | The contract number, if not specified the system will generate a number automatically by adding a 1 to the last greatest contract number. |
| notice | object | false | An object containing the months of notice for the contract. |
| documentType | string | false | The type of the contract. If none entered "leaseAgreement" will be used by default. |
| team | Company | true | Reference to the team the member belongs to. Contracts can only be created for companies. |
| member | Member | true | Reference to the member with which the contract is associated. All contracts have to be associated with a member. |
| office | Location | false | Reference to the location of the contract. It will default to the only location if left empty. |
| resources | array | true | Array containing all the resources that are part of the contract. A contract must have at least one primary item, i.e. a resource, plan or a one-off fee. A steps array must be specified as well as the resource _id in order to define the period and price of each resource in the contract. |
| plans | array | true | Array containing all the plans that are part of the contract. A contract must have at least one primary item, i.e. a resource, plan or a one-off plan. A steps array must be specified as well as the plan_id in order to define the period and price of each plan in the contract. |
| oneOffPlans | array | true | Array containing all the one-off plans that are part of the contract. A contract must have at least one primary item, i.e. a resource, plan or a one-off plan. A steps array must be specified as well as the plan_id in order to define the period and price of each plan in the contract. The steps array only needs a start date unlike plans and resources. |
| steps | array | true | An array that must be specified under resources/plans/oneOffPlans. Contains startDate, endDate (excluded for oneOffPlans) and price parameters. |
| createdAt | date | readonly | The date when the contract has been created. |
| createdBy | id | readonly | The user that created the contract. |
| status | enum | false | The contract status. By default a created contract is "not_signed" until signed manually through the UI or by using e-sign. |