The Contract 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.

status string

Default: draft

party_type string

Default: Customer

is_signed boolean

Default: false

party_name string required

party_user string

fulfilment_status string

start_date string

end_date string

signee string

signed_on string

ip_address string

contract_template string

contract_terms string required

requires_fulfilment boolean

Default: false

fulfilment_deadline string

document_type string

document_name string

signee_company string

signed_by_company string

party_full_name string

signing_document_id string

The Contract object

{
  "id": "contract_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "party_type": "Customer",
  "is_signed": false,
  "party_name": "party_name_example",
  "party_user": "party_user_example",
  "fulfilment_status": "fulfilment_status_example",
  "start_date": "2024-01-15",
  "end_date": "2024-01-15",
  "signee": "signee_example",
  "signed_on": "signed_on_example",
  "ip_address": "ip_address_example",
  "contract_template": "contract_template_example",
  "contract_terms": "contract_terms_example",
  "requires_fulfilment": false,
  "fulfilment_deadline": "fulfilment_deadline_example",
  "document_type": "document_type_example",
  "document_name": "document_name_example",
  "signee_company": "Example Corp",
  "signed_by_company": "Example Corp",
  "party_full_name": "party_full_name_example",
  "signing_document_id": "signing_document_id_example"
}

GET /api/crm/contract/{id}

Retrieve a contract

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

Path parameters

id string required

The identifier of the contract to retrieve.

Returns

Returns the contract object if a valid identifier was provided.

GET /api/crm/contract/{id}

curl https://api.overplane.dev/api/crm/contract/contract_abc123 \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "id": "contract_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "party_type": "Customer",
  "is_signed": false,
  "party_name": "party_name_example",
  "party_user": "party_user_example",
  "fulfilment_status": "fulfilment_status_example",
  "start_date": "2024-01-15",
  "end_date": "2024-01-15",
  "signee": "signee_example",
  "signed_on": "signed_on_example",
  "ip_address": "ip_address_example",
  "contract_template": "contract_template_example",
  "contract_terms": "contract_terms_example",
  "requires_fulfilment": false,
  "fulfilment_deadline": "fulfilment_deadline_example",
  "document_type": "document_type_example",
  "document_name": "document_name_example",
  "signee_company": "Example Corp",
  "signed_by_company": "Example Corp",
  "party_full_name": "party_full_name_example",
  "signing_document_id": "signing_document_id_example"
}

GET /api/crm/contract

List all contracts

Returns a list of contracts. 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 objects.

GET /api/crm/contract

curl https://api.overplane.dev/api/crm/contract \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "data": [
    {
      "id": "contract_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "party_type": "Customer",
      "is_signed": false,
      "party_name": "party_name_example",
      "party_user": "party_user_example",
      "fulfilment_status": "fulfilment_status_example",
      "start_date": "2024-01-15",
      "end_date": "2024-01-15",
      "signee": "signee_example",
      "signed_on": "signed_on_example",
      "ip_address": "ip_address_example",
      "contract_template": "contract_template_example",
      "contract_terms": "contract_terms_example",
      "requires_fulfilment": false,
      "fulfilment_deadline": "fulfilment_deadline_example",
      "document_type": "document_type_example",
      "document_name": "document_name_example",
      "signee_company": "Example Corp",
      "signed_by_company": "Example Corp",
      "party_full_name": "party_full_name_example",
      "signing_document_id": "signing_document_id_example"
    }
  ],
  "has_more": false,
  "total": 1
}

POST /api/crm/contract

Create a contract

Creates a new contract object.

Body parameters

status string

Default: draft

party_type string

Default: Customer

is_signed boolean

Default: false

party_name string required

party_user string

fulfilment_status string

start_date string

end_date string

signee string

signed_on string

ip_address string

contract_template string

contract_terms string required

requires_fulfilment boolean

Default: false

fulfilment_deadline string

document_type string

document_name string

signee_company string

signed_by_company string

party_full_name string

signing_document_id string

Returns

Returns the newly created contract object if the call succeeded.

POST /api/crm/contract

curl https://api.overplane.dev/api/crm/contract \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"party_name":"party_name_example","contract_terms":"contract_terms_example"}'

Response

{
  "id": "contract_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "party_type": "Customer",
  "is_signed": false,
  "party_name": "party_name_example",
  "party_user": "party_user_example",
  "fulfilment_status": "fulfilment_status_example",
  "start_date": "2024-01-15",
  "end_date": "2024-01-15",
  "signee": "signee_example",
  "signed_on": "signed_on_example",
  "ip_address": "ip_address_example",
  "contract_template": "contract_template_example",
  "contract_terms": "contract_terms_example",
  "requires_fulfilment": false,
  "fulfilment_deadline": "fulfilment_deadline_example",
  "document_type": "document_type_example",
  "document_name": "document_name_example",
  "signee_company": "Example Corp",
  "signed_by_company": "Example Corp",
  "party_full_name": "party_full_name_example",
  "signing_document_id": "signing_document_id_example"
}

PATCH /api/crm/contract/{id}

Update a contract

Updates the specified contract 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 to update.

Body parameters

status string

Default: draft

party_type string

Default: Customer

is_signed boolean

Default: false

party_name string

party_user string

fulfilment_status string

start_date string

end_date string

signee string

signed_on string

ip_address string

contract_template string

contract_terms string

requires_fulfilment boolean

Default: false

fulfilment_deadline string

document_type string

document_name string

signee_company string

signed_by_company string

party_full_name string

signing_document_id string

Returns

Returns the updated contract object.

PATCH /api/crm/contract/{id}

curl https://api.overplane.dev/api/crm/contract/contract_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","party_type":"Customer"}'

Response

{
  "id": "contract_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "party_type": "Customer",
  "is_signed": false,
  "party_name": "party_name_example",
  "party_user": "party_user_example",
  "fulfilment_status": "fulfilment_status_example",
  "start_date": "2024-01-15",
  "end_date": "2024-01-15",
  "signee": "signee_example",
  "signed_on": "signed_on_example",
  "ip_address": "ip_address_example",
  "contract_template": "contract_template_example",
  "contract_terms": "contract_terms_example",
  "requires_fulfilment": false,
  "fulfilment_deadline": "fulfilment_deadline_example",
  "document_type": "document_type_example",
  "document_name": "document_name_example",
  "signee_company": "Example Corp",
  "signed_by_company": "Example Corp",
  "party_full_name": "party_full_name_example",
  "signing_document_id": "signing_document_id_example"
}

DELETE /api/crm/contract/{id}

Delete a contract

Permanently deletes a contract. This cannot be undone.

Path parameters

id string required

The identifier of the contract to delete.

Returns

Returns a confirmation that the contract has been deleted.

DELETE /api/crm/contract/{id}

curl https://api.overplane.dev/api/crm/contract/contract_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE

Response

{
  "id": "contract_abc123",
  "deleted": true
}

POST /api/crm/contract/{id}/submit

Submit a contract

Submits a draft contract, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the contract to act on.

Returns

Returns the contract object with updated status.

POST /api/crm/contract/{id}/submit

curl https://api.overplane.dev/api/crm/contract/contract_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST

Response

{
  "id": "contract_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "party_type": "Customer",
  "is_signed": false,
  "party_name": "party_name_example",
  "party_user": "party_user_example",
  "fulfilment_status": "fulfilment_status_example",
  "start_date": "2024-01-15",
  "end_date": "2024-01-15",
  "signee": "signee_example",
  "signed_on": "signed_on_example",
  "ip_address": "ip_address_example",
  "contract_template": "contract_template_example",
  "contract_terms": "contract_terms_example",
  "requires_fulfilment": false,
  "fulfilment_deadline": "fulfilment_deadline_example",
  "document_type": "document_type_example",
  "document_name": "document_name_example",
  "signee_company": "Example Corp",
  "signed_by_company": "Example Corp",
  "party_full_name": "party_full_name_example",
  "signing_document_id": "signing_document_id_example"
}

POST /api/crm/contract/{id}/cancel

Cancel a contract

Cancels a submitted contract, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the contract to act on.

Returns

Returns the contract object with updated status.

POST /api/crm/contract/{id}/cancel

curl https://api.overplane.dev/api/crm/contract/contract_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST

Response

{
  "id": "contract_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "party_type": "Customer",
  "is_signed": false,
  "party_name": "party_name_example",
  "party_user": "party_user_example",
  "fulfilment_status": "fulfilment_status_example",
  "start_date": "2024-01-15",
  "end_date": "2024-01-15",
  "signee": "signee_example",
  "signed_on": "signed_on_example",
  "ip_address": "ip_address_example",
  "contract_template": "contract_template_example",
  "contract_terms": "contract_terms_example",
  "requires_fulfilment": false,
  "fulfilment_deadline": "fulfilment_deadline_example",
  "document_type": "document_type_example",
  "document_name": "document_name_example",
  "signee_company": "Example Corp",
  "signed_by_company": "Example Corp",
  "party_full_name": "party_full_name_example",
  "signing_document_id": "signing_document_id_example"
}

Line items

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

Contract Fulfilment Checklist

Attributes

idx integer

contract_id string required

fulfilled boolean

requirement string

notes string

Endpoints

GET /api/crm/contract-fulfilment-checklist?parent_id={id}

POST /api/crm/contract-fulfilment-checklist

PATCH /api/crm/contract-fulfilment-checklist/{id}

DELETE /api/crm/contract-fulfilment-checklist/{id}

POST /api/crm/contract-fulfilment-checklist/reorder

Contract Fulfilment Checklist object

{
  "id": "contract-fulfilment-checklist_abc123",
  "idx": 1,
  "contract_id": "contract_id_example",
  "fulfilled": false,
  "requirement": "requirement_example",
  "notes": "notes_example"
}

The Contract object

Attributes

Retrieve a contract

Path parameters

Returns

List all contracts

Query parameters

Returns

Create a contract

Body parameters

Returns

Update a contract

Path parameters

Body parameters

Returns

Delete a contract

Path parameters

Returns

Submit a contract

Path parameters

Returns

Cancel a contract

Path parameters

Returns

Line items

Contract Fulfilment Checklist

Attributes

Endpoints

Coming Soon