The Activity Cost 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.

activity_type string required
employee string
employee_name string
department string
billing_rate number

Default: 0

costing_rate number

Default: 0

title string
The Activity Cost object 
{
  "id": "activity-cost_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "activity_type": "activity_type_example",
  "employee": "employee_example",
  "employee_name": "employee_name_example",
  "department": "department_example",
  "billing_rate": 0,
  "costing_rate": 0,
  "title": "title_example"
}
GET /api/projects/activity-cost/{id}

Retrieve a activity cost

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

Path parameters

id string required

The identifier of the activity cost to retrieve.

Returns

Returns the activity cost object if a valid identifier was provided.

GET /api/projects/activity-cost/{id} 
curl https://api.overplane.dev/api/projects/activity-cost/activity-cost_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "activity-cost_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "activity_type": "activity_type_example",
  "employee": "employee_example",
  "employee_name": "employee_name_example",
  "department": "department_example",
  "billing_rate": 0,
  "costing_rate": 0,
  "title": "title_example"
}
GET /api/projects/activity-cost

List all activity costs

Returns a list of activity costs. 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 activity cost objects.

GET /api/projects/activity-cost 
curl https://api.overplane.dev/api/projects/activity-cost \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "activity-cost_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "activity_type": "activity_type_example",
      "employee": "employee_example",
      "employee_name": "employee_name_example",
      "department": "department_example",
      "billing_rate": 0,
      "costing_rate": 0,
      "title": "title_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/projects/activity-cost

Create a activity cost

Creates a new activity cost object.

Body parameters

activity_type string required
employee string
employee_name string
department string
billing_rate number

Default: 0

costing_rate number

Default: 0

title string

Returns

Returns the newly created activity cost object if the call succeeded.

POST /api/projects/activity-cost 
curl https://api.overplane.dev/api/projects/activity-cost \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"activity_type":"activity_type_example"}'
Response 
{
  "id": "activity-cost_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "activity_type": "activity_type_example",
  "employee": "employee_example",
  "employee_name": "employee_name_example",
  "department": "department_example",
  "billing_rate": 0,
  "costing_rate": 0,
  "title": "title_example"
}
PATCH /api/projects/activity-cost/{id}

Update a activity cost

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

Body parameters

activity_type string
employee string
employee_name string
department string
billing_rate number

Default: 0

costing_rate number

Default: 0

title string

Returns

Returns the updated activity cost object.

PATCH /api/projects/activity-cost/{id} 
curl https://api.overplane.dev/api/projects/activity-cost/activity-cost_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"activity_type":"activity_type_example","employee":"employee_example"}'
Response 
{
  "id": "activity-cost_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "activity_type": "activity_type_example",
  "employee": "employee_example",
  "employee_name": "employee_name_example",
  "department": "department_example",
  "billing_rate": 0,
  "costing_rate": 0,
  "title": "title_example"
}
DELETE /api/projects/activity-cost/{id}

Delete a activity cost

Permanently deletes a activity cost. This cannot be undone.

Path parameters

id string required

The identifier of the activity cost to delete.

Returns

Returns a confirmation that the activity cost has been deleted.

DELETE /api/projects/activity-cost/{id} 
curl https://api.overplane.dev/api/projects/activity-cost/activity-cost_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "activity-cost_abc123",
  "deleted": true
}