Brightree integration

Search SO Worklist

Perform Search SO Worklist through Brightree.

View as Markdown

brightree_search_so_worklist

readbrightree

Inputs

wip_states
multi_selectdynamic options
Wip States
Optional list of selected values. Retrieve allowed values from the dynamic options endpoint.
page
number
Page
Optional numeric value.
Default: 1
fetch_all
boolean
Fetch All
Optional true-or-false value.
Default: false
include_unassigned
boolean
Include Unassigned
Optional true-or-false value.
Default: false
sort_by_time_in_wip
boolean
Sort By Time In Wip
Optional true-or-false value.
Default: false
actual_delivery_date_to
string
Actual Delivery Date To
Optional text value.

Outputs

ordersOrders

Output schema completeness: best_effort_declared

Safety

External effect: read
Confirmation recommended: No
Retry safe: Yes
Dry run supported: No

Schemas

These schemas are first-pass authoring guidance. Runtime validation remains authoritative.

Input schema

{
  "type": "object",
  "properties": {
    "page": {
      "type": "number",
      "default": 1,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "fetch_all": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "wip_states": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional list of selected values. Retrieve allowed values from the dynamic options endpoint.",
      "x-dynamic-options": true,
      "x-workflow-field-type": "multi_select"
    },
    "include_unassigned": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "sort_by_time_in_wip": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "actual_delivery_date_to": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "string"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "orders": {}
  },
  "additionalProperties": true
}

View all Brightree actions