The Sales Invoice Timesheet object

Attributes

id string

Unique identifier for the object.

idx integer
parent_id string required
parent_type string required
time_sheet string
billing_hours number
billing_amount number
timesheet_detail string
activity_type string
description string
from_time string
to_time string
project_name string
The Sales Invoice Timesheet object 
{
  "id": "sales-invoice-timesheet_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "time_sheet": "time_sheet_example",
  "billing_hours": 0,
  "billing_amount": 0,
  "timesheet_detail": "timesheet_detail_example",
  "activity_type": "activity_type_example",
  "description": "description_example",
  "from_time": "from_time_example",
  "to_time": "to_time_example",
  "project_name": "project_name_example"
}
GET /api/accounts/sales-invoice-timesheet?parent_id={id}

List sales invoice timesheets by parent

Returns all sales invoice timesheets belonging to the specified parent.

Query parameters

parent_id string required

The ID of the parent to list children for.

Returns

A list of sales invoice timesheet objects belonging to the parent.

GET /api/accounts/sales-invoice-timesheet?parent_id={id} 
curl https://api.overplane.dev/api/accounts/sales-invoice-timesheet?parent_id=parent_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "sales-invoice-timesheet_abc123",
      "idx": 1,
      "parent_id": null,
      "parent_type": "parent_type_example",
      "time_sheet": "time_sheet_example",
      "billing_hours": 0,
      "billing_amount": 0,
      "timesheet_detail": "timesheet_detail_example",
      "activity_type": "activity_type_example",
      "description": "description_example",
      "from_time": "from_time_example",
      "to_time": "to_time_example",
      "project_name": "project_name_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/sales-invoice-timesheet

Create a sales invoice timesheet

Creates a new sales invoice timesheet object.

Body parameters

idx integer
parent_id string required
parent_type string required
time_sheet string
billing_hours number
billing_amount number
timesheet_detail string
activity_type string
description string
from_time string
to_time string
project_name string

Returns

Returns the newly created sales invoice timesheet object if the call succeeded.

POST /api/accounts/sales-invoice-timesheet 
curl https://api.overplane.dev/api/accounts/sales-invoice-timesheet \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"parent_id":null,"parent_type":"parent_type_example"}'
Response 
{
  "id": "sales-invoice-timesheet_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "time_sheet": "time_sheet_example",
  "billing_hours": 0,
  "billing_amount": 0,
  "timesheet_detail": "timesheet_detail_example",
  "activity_type": "activity_type_example",
  "description": "description_example",
  "from_time": "from_time_example",
  "to_time": "to_time_example",
  "project_name": "project_name_example"
}
PATCH /api/accounts/sales-invoice-timesheet/{id}

Update a sales invoice timesheet

Updates the specified sales invoice timesheet 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 sales invoice timesheet to update.

Body parameters

idx integer
parent_id string
parent_type string
time_sheet string
billing_hours number
billing_amount number
timesheet_detail string
activity_type string
description string
from_time string
to_time string
project_name string

Returns

Returns the updated sales invoice timesheet object.

PATCH /api/accounts/sales-invoice-timesheet/{id} 
curl https://api.overplane.dev/api/accounts/sales-invoice-timesheet/sales-invoice-timesheet_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"idx":1,"parent_id":null}'
Response 
{
  "id": "sales-invoice-timesheet_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "time_sheet": "time_sheet_example",
  "billing_hours": 0,
  "billing_amount": 0,
  "timesheet_detail": "timesheet_detail_example",
  "activity_type": "activity_type_example",
  "description": "description_example",
  "from_time": "from_time_example",
  "to_time": "to_time_example",
  "project_name": "project_name_example"
}
DELETE /api/accounts/sales-invoice-timesheet/{id}

Delete a sales invoice timesheet

Permanently deletes a sales invoice timesheet. This cannot be undone.

Path parameters

id string required

The identifier of the sales invoice timesheet to delete.

Returns

Returns a confirmation that the sales invoice timesheet has been deleted.

DELETE /api/accounts/sales-invoice-timesheet/{id} 
curl https://api.overplane.dev/api/accounts/sales-invoice-timesheet/sales-invoice-timesheet_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "sales-invoice-timesheet_abc123",
  "deleted": true
}
POST /api/accounts/sales-invoice-timesheet/reorder

Reorder sales invoice timesheets

Updates the sort order of sales invoice timesheets within their parent by setting new index values.

Returns

Returns the reordered list.

POST /api/accounts/sales-invoice-timesheet/reorder 
curl https://api.overplane.dev/api/accounts/sales-invoice-timesheet/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "sales-invoice-timesheet_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "time_sheet": "time_sheet_example",
  "billing_hours": 0,
  "billing_amount": 0,
  "timesheet_detail": "timesheet_detail_example",
  "activity_type": "activity_type_example",
  "description": "description_example",
  "from_time": "from_time_example",
  "to_time": "to_time_example",
  "project_name": "project_name_example"
}