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

project_name string required

status string

Default: Open

project_type string

is_active string

percent_complete_method string

Default: Task Completion

percent_complete number

project_template string

expected_start_date string

expected_end_date string

priority string

department string

customer string

sales_order string

copied_from string

notes string

actual_start_date string

actual_time number

actual_end_date string

estimated_costing number

total_costing_amount number

total_purchase_cost number

company string required

total_sales_amount number

total_billable_amount number

total_billed_amount number

total_consumed_material_cost number

cost_center string

gross_margin number

per_gross_margin number

collect_progress boolean

Default: false

holiday_list string

frequency string

from_time string

to_time string

first_email string

second_email string

daily_time_to_send string

day_to_send string

weekly_time_to_send string

message string

subject string

The Project object

{
  "id": "project_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "project_name": "project_name_example",
  "status": "Open",
  "project_type": "project_type_example",
  "is_active": "is_active_example",
  "percent_complete_method": "Task Completion",
  "percent_complete": 0,
  "project_template": "project_template_example",
  "expected_start_date": "2024-01-15",
  "expected_end_date": "2024-01-15",
  "priority": "priority_example",
  "department": "department_example",
  "customer": "customer_example",
  "sales_order": "sales_order_example",
  "copied_from": "copied_from_example",
  "notes": "notes_example",
  "actual_start_date": "2024-01-15",
  "actual_time": 0,
  "actual_end_date": "2024-01-15",
  "estimated_costing": 0,
  "total_costing_amount": 0,
  "total_purchase_cost": 0,
  "company": "Example Corp",
  "total_sales_amount": 0,
  "total_billable_amount": 0,
  "total_billed_amount": 0,
  "total_consumed_material_cost": 0,
  "cost_center": "cost_center_example",
  "gross_margin": 0,
  "per_gross_margin": 0,
  "collect_progress": false,
  "holiday_list": "holiday_list_example",
  "frequency": "frequency_example",
  "from_time": "from_time_example",
  "to_time": "to_time_example",
  "first_email": "user@example.com",
  "second_email": "user@example.com",
  "daily_time_to_send": "daily_time_to_send_example",
  "day_to_send": "day_to_send_example",
  "weekly_time_to_send": "weekly_time_to_send_example",
  "message": "message_example",
  "subject": "subject_example"
}

GET /api/projects/project/{id}

Retrieve a project

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

Path parameters

id string required

The identifier of the project to retrieve.

Returns

Returns the project object if a valid identifier was provided.

GET /api/projects/project/{id}

curl https://api.overplane.dev/api/projects/project/project_abc123 \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "id": "project_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "project_name": "project_name_example",
  "status": "Open",
  "project_type": "project_type_example",
  "is_active": "is_active_example",
  "percent_complete_method": "Task Completion",
  "percent_complete": 0,
  "project_template": "project_template_example",
  "expected_start_date": "2024-01-15",
  "expected_end_date": "2024-01-15",
  "priority": "priority_example",
  "department": "department_example",
  "customer": "customer_example",
  "sales_order": "sales_order_example",
  "copied_from": "copied_from_example",
  "notes": "notes_example",
  "actual_start_date": "2024-01-15",
  "actual_time": 0,
  "actual_end_date": "2024-01-15",
  "estimated_costing": 0,
  "total_costing_amount": 0,
  "total_purchase_cost": 0,
  "company": "Example Corp",
  "total_sales_amount": 0,
  "total_billable_amount": 0,
  "total_billed_amount": 0,
  "total_consumed_material_cost": 0,
  "cost_center": "cost_center_example",
  "gross_margin": 0,
  "per_gross_margin": 0,
  "collect_progress": false,
  "holiday_list": "holiday_list_example",
  "frequency": "frequency_example",
  "from_time": "from_time_example",
  "to_time": "to_time_example",
  "first_email": "user@example.com",
  "second_email": "user@example.com",
  "daily_time_to_send": "daily_time_to_send_example",
  "day_to_send": "day_to_send_example",
  "weekly_time_to_send": "weekly_time_to_send_example",
  "message": "message_example",
  "subject": "subject_example"
}

GET /api/projects/project

List all projects

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

GET /api/projects/project

curl https://api.overplane.dev/api/projects/project \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "data": [
    {
      "id": "project_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "project_name": "project_name_example",
      "status": "Open",
      "project_type": "project_type_example",
      "is_active": "is_active_example",
      "percent_complete_method": "Task Completion",
      "percent_complete": 0,
      "project_template": "project_template_example",
      "expected_start_date": "2024-01-15",
      "expected_end_date": "2024-01-15",
      "priority": "priority_example",
      "department": "department_example",
      "customer": "customer_example",
      "sales_order": "sales_order_example",
      "copied_from": "copied_from_example",
      "notes": "notes_example",
      "actual_start_date": "2024-01-15",
      "actual_time": 0,
      "actual_end_date": "2024-01-15",
      "estimated_costing": 0,
      "total_costing_amount": 0,
      "total_purchase_cost": 0,
      "company": "Example Corp",
      "total_sales_amount": 0,
      "total_billable_amount": 0,
      "total_billed_amount": 0,
      "total_consumed_material_cost": 0,
      "cost_center": "cost_center_example",
      "gross_margin": 0,
      "per_gross_margin": 0,
      "collect_progress": false,
      "holiday_list": "holiday_list_example",
      "frequency": "frequency_example",
      "from_time": "from_time_example",
      "to_time": "to_time_example",
      "first_email": "user@example.com",
      "second_email": "user@example.com",
      "daily_time_to_send": "daily_time_to_send_example",
      "day_to_send": "day_to_send_example",
      "weekly_time_to_send": "weekly_time_to_send_example",
      "message": "message_example",
      "subject": "subject_example"
    }
  ],
  "has_more": false,
  "total": 1
}

POST /api/projects/project

Create a project

Creates a new project object.

Body parameters

project_name string required

status string

Default: Open

project_type string

is_active string

percent_complete_method string

Default: Task Completion

percent_complete number

project_template string

expected_start_date string

expected_end_date string

priority string

department string

customer string

sales_order string

copied_from string

notes string

actual_start_date string

actual_time number

actual_end_date string

estimated_costing number

total_costing_amount number

total_purchase_cost number

company string required

total_sales_amount number

total_billable_amount number

total_billed_amount number

total_consumed_material_cost number

cost_center string

gross_margin number

per_gross_margin number

collect_progress boolean

Default: false

holiday_list string

frequency string

from_time string

to_time string

first_email string

second_email string

daily_time_to_send string

day_to_send string

weekly_time_to_send string

message string

subject string

Returns

Returns the newly created project object if the call succeeded.

POST /api/projects/project

curl https://api.overplane.dev/api/projects/project \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"project_name":"project_name_example","company":"Example Corp"}'

Response

{
  "id": "project_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "project_name": "project_name_example",
  "status": "Open",
  "project_type": "project_type_example",
  "is_active": "is_active_example",
  "percent_complete_method": "Task Completion",
  "percent_complete": 0,
  "project_template": "project_template_example",
  "expected_start_date": "2024-01-15",
  "expected_end_date": "2024-01-15",
  "priority": "priority_example",
  "department": "department_example",
  "customer": "customer_example",
  "sales_order": "sales_order_example",
  "copied_from": "copied_from_example",
  "notes": "notes_example",
  "actual_start_date": "2024-01-15",
  "actual_time": 0,
  "actual_end_date": "2024-01-15",
  "estimated_costing": 0,
  "total_costing_amount": 0,
  "total_purchase_cost": 0,
  "company": "Example Corp",
  "total_sales_amount": 0,
  "total_billable_amount": 0,
  "total_billed_amount": 0,
  "total_consumed_material_cost": 0,
  "cost_center": "cost_center_example",
  "gross_margin": 0,
  "per_gross_margin": 0,
  "collect_progress": false,
  "holiday_list": "holiday_list_example",
  "frequency": "frequency_example",
  "from_time": "from_time_example",
  "to_time": "to_time_example",
  "first_email": "user@example.com",
  "second_email": "user@example.com",
  "daily_time_to_send": "daily_time_to_send_example",
  "day_to_send": "day_to_send_example",
  "weekly_time_to_send": "weekly_time_to_send_example",
  "message": "message_example",
  "subject": "subject_example"
}

PATCH /api/projects/project/{id}

Update a project

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

Body parameters

project_name string

status string

Default: Open

project_type string

is_active string

percent_complete_method string

Default: Task Completion

percent_complete number

project_template string

expected_start_date string

expected_end_date string

priority string

department string

customer string

sales_order string

copied_from string

notes string

actual_start_date string

actual_time number

actual_end_date string

estimated_costing number

total_costing_amount number

total_purchase_cost number

company string

total_sales_amount number

total_billable_amount number

total_billed_amount number

total_consumed_material_cost number

cost_center string

gross_margin number

per_gross_margin number

collect_progress boolean

Default: false

holiday_list string

frequency string

from_time string

to_time string

first_email string

second_email string

daily_time_to_send string

day_to_send string

weekly_time_to_send string

message string

subject string

Returns

Returns the updated project object.

PATCH /api/projects/project/{id}

curl https://api.overplane.dev/api/projects/project/project_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"project_name":"project_name_example","status":"Open"}'

Response

{
  "id": "project_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "project_name": "project_name_example",
  "status": "Open",
  "project_type": "project_type_example",
  "is_active": "is_active_example",
  "percent_complete_method": "Task Completion",
  "percent_complete": 0,
  "project_template": "project_template_example",
  "expected_start_date": "2024-01-15",
  "expected_end_date": "2024-01-15",
  "priority": "priority_example",
  "department": "department_example",
  "customer": "customer_example",
  "sales_order": "sales_order_example",
  "copied_from": "copied_from_example",
  "notes": "notes_example",
  "actual_start_date": "2024-01-15",
  "actual_time": 0,
  "actual_end_date": "2024-01-15",
  "estimated_costing": 0,
  "total_costing_amount": 0,
  "total_purchase_cost": 0,
  "company": "Example Corp",
  "total_sales_amount": 0,
  "total_billable_amount": 0,
  "total_billed_amount": 0,
  "total_consumed_material_cost": 0,
  "cost_center": "cost_center_example",
  "gross_margin": 0,
  "per_gross_margin": 0,
  "collect_progress": false,
  "holiday_list": "holiday_list_example",
  "frequency": "frequency_example",
  "from_time": "from_time_example",
  "to_time": "to_time_example",
  "first_email": "user@example.com",
  "second_email": "user@example.com",
  "daily_time_to_send": "daily_time_to_send_example",
  "day_to_send": "day_to_send_example",
  "weekly_time_to_send": "weekly_time_to_send_example",
  "message": "message_example",
  "subject": "subject_example"
}

DELETE /api/projects/project/{id}

Delete a project

Permanently deletes a project. This cannot be undone.

Path parameters

id string required

The identifier of the project to delete.

Returns

Returns a confirmation that the project has been deleted.

DELETE /api/projects/project/{id}

curl https://api.overplane.dev/api/projects/project/project_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE

Response

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

The Project object

Attributes

Retrieve a project

Path parameters

Returns

List all projects

Query parameters

Returns

Create a project

Body parameters

Returns

Update a project

Path parameters

Body parameters

Returns

Delete a project

Path parameters

Returns

Coming Soon