The Contract Template object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

title string
contract_terms string
requires_fulfilment boolean

Default: false

The Contract Template object 
{
  "id": "contract-template_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "title": "title_example",
  "contract_terms": "contract_terms_example",
  "requires_fulfilment": false
}
GET /api/crm/contract-template/{id}

Retrieve a contract template

Retrieves the details of an existing contract template. Supply the unique contract template ID that was returned from a previous request.

Path parameters

id string required

The identifier of the contract template to retrieve.

Returns

Returns the contract template object if a valid identifier was provided.

GET /api/crm/contract-template/{id} 
curl https://api.overplane.dev/api/crm/contract-template/contract-template_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "contract-template_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "title": "title_example",
  "contract_terms": "contract_terms_example",
  "requires_fulfilment": false
}
GET /api/crm/contract-template

List all contract templates

Returns a list of contract templates. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of contract template objects.

GET /api/crm/contract-template 
curl https://api.overplane.dev/api/crm/contract-template \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "contract-template_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "title": "title_example",
      "contract_terms": "contract_terms_example",
      "requires_fulfilment": false
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/crm/contract-template

Create a contract template

Creates a new contract template object.

Body parameters

title string
contract_terms string
requires_fulfilment boolean

Default: false

Returns

Returns the newly created contract template object if the call succeeded.

POST /api/crm/contract-template 
curl https://api.overplane.dev/api/crm/contract-template \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "contract-template_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "title": "title_example",
  "contract_terms": "contract_terms_example",
  "requires_fulfilment": false
}
PATCH /api/crm/contract-template/{id}

Update a contract template

Updates the specified contract template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the contract template to update.

Body parameters

title string
contract_terms string
requires_fulfilment boolean

Default: false

Returns

Returns the updated contract template object.

PATCH /api/crm/contract-template/{id} 
curl https://api.overplane.dev/api/crm/contract-template/contract-template_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"title":"title_example","contract_terms":"contract_terms_example"}'
Response 
{
  "id": "contract-template_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "title": "title_example",
  "contract_terms": "contract_terms_example",
  "requires_fulfilment": false
}
DELETE /api/crm/contract-template/{id}

Delete a contract template

Permanently deletes a contract template. This cannot be undone.

Path parameters

id string required

The identifier of the contract template to delete.

Returns

Returns a confirmation that the contract template has been deleted.

DELETE /api/crm/contract-template/{id} 
curl https://api.overplane.dev/api/crm/contract-template/contract-template_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "contract-template_abc123",
  "deleted": true
}

Line items

Child objects that belong to this contract template. These are accessed via the parent's ID.

Contract Template Fulfilment Terms

Attributes

idx integer
contract_template_id string required
requirement string

Endpoints

GET /api/crm/contract-template-fulfilment-terms?parent_id={id}
POST /api/crm/contract-template-fulfilment-terms
PATCH /api/crm/contract-template-fulfilment-terms/{id}
DELETE /api/crm/contract-template-fulfilment-terms/{id}
POST /api/crm/contract-template-fulfilment-terms/reorder
Contract Template Fulfilment Terms object 
{
  "id": "contract-template-fulfilment-terms_abc123",
  "idx": 1,
  "contract_template_id": "contract_template_id_example",
  "requirement": "requirement_example"
}