The Bisect Nodes 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.

root string
left_child string
right_child string
period_from_date string
period_to_date string
difference number
balance_sheet_summary number
profit_loss_summary number
generated boolean

Default: false

The Bisect Nodes object 
{
  "id": "bisect-nodes_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "root": "root_example",
  "left_child": "left_child_example",
  "right_child": "right_child_example",
  "period_from_date": "2024-01-15",
  "period_to_date": "2024-01-15",
  "difference": 0,
  "balance_sheet_summary": 0,
  "profit_loss_summary": 0,
  "generated": false
}
GET /api/accounts/bisect-nodes/{id}

Retrieve a bisect nodes

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

Path parameters

id string required

The identifier of the bisect nodes to retrieve.

Returns

Returns the bisect nodes object if a valid identifier was provided.

GET /api/accounts/bisect-nodes/{id} 
curl https://api.overplane.dev/api/accounts/bisect-nodes/bisect-nodes_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "bisect-nodes_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "root": "root_example",
  "left_child": "left_child_example",
  "right_child": "right_child_example",
  "period_from_date": "2024-01-15",
  "period_to_date": "2024-01-15",
  "difference": 0,
  "balance_sheet_summary": 0,
  "profit_loss_summary": 0,
  "generated": false
}
GET /api/accounts/bisect-nodes

List all bisect nodess

Returns a list of bisect nodess. 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 bisect nodes objects.

GET /api/accounts/bisect-nodes 
curl https://api.overplane.dev/api/accounts/bisect-nodes \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "bisect-nodes_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "root": "root_example",
      "left_child": "left_child_example",
      "right_child": "right_child_example",
      "period_from_date": "2024-01-15",
      "period_to_date": "2024-01-15",
      "difference": 0,
      "balance_sheet_summary": 0,
      "profit_loss_summary": 0,
      "generated": false
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/bisect-nodes

Create a bisect nodes

Creates a new bisect nodes object.

Body parameters

root string
left_child string
right_child string
period_from_date string
period_to_date string
difference number
balance_sheet_summary number
profit_loss_summary number
generated boolean

Default: false

Returns

Returns the newly created bisect nodes object if the call succeeded.

POST /api/accounts/bisect-nodes 
curl https://api.overplane.dev/api/accounts/bisect-nodes \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "bisect-nodes_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "root": "root_example",
  "left_child": "left_child_example",
  "right_child": "right_child_example",
  "period_from_date": "2024-01-15",
  "period_to_date": "2024-01-15",
  "difference": 0,
  "balance_sheet_summary": 0,
  "profit_loss_summary": 0,
  "generated": false
}
PATCH /api/accounts/bisect-nodes/{id}

Update a bisect nodes

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

Body parameters

root string
left_child string
right_child string
period_from_date string
period_to_date string
difference number
balance_sheet_summary number
profit_loss_summary number
generated boolean

Default: false

Returns

Returns the updated bisect nodes object.

PATCH /api/accounts/bisect-nodes/{id} 
curl https://api.overplane.dev/api/accounts/bisect-nodes/bisect-nodes_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"root":"root_example","left_child":"left_child_example"}'
Response 
{
  "id": "bisect-nodes_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "root": "root_example",
  "left_child": "left_child_example",
  "right_child": "right_child_example",
  "period_from_date": "2024-01-15",
  "period_to_date": "2024-01-15",
  "difference": 0,
  "balance_sheet_summary": 0,
  "profit_loss_summary": 0,
  "generated": false
}
DELETE /api/accounts/bisect-nodes/{id}

Delete a bisect nodes

Permanently deletes a bisect nodes. This cannot be undone.

Path parameters

id string required

The identifier of the bisect nodes to delete.

Returns

Returns a confirmation that the bisect nodes has been deleted.

DELETE /api/accounts/bisect-nodes/{id} 
curl https://api.overplane.dev/api/accounts/bisect-nodes/bisect-nodes_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "bisect-nodes_abc123",
  "deleted": true
}