Brightree integration

Find Sales Orders in WIP State

Perform Find Sales Orders in WIP State through Brightree.

brightree_search_sales_orders_by_wip_state

readbrightree

Use in a workflow

Copy the discovered node config and fill its params from the input contract. Validate the complete graph before publishing. Integration results use {{node_id.default.field}}. Check business success before dependent writes; completion alone does not prove success.

{
  "_group": "Brightree",
  "params": {
    "shard_count": 1,
    "shard_index": 0,
    "order_statuses": [
      "New",
      "Active"
    ],
    "max_orders_to_read": 1000,
    "created_within_days": 0
  },
  "handler": "brightree_search_sales_orders_by_wip_state"
}

Action contracts and connections · Run recovery

Inputs

wip_states
multi_selectrequireddynamic options
Wip States
Required list of selected values. Retrieve allowed values from the dynamic options endpoint.
order_statuses
multi_select
Order Statuses
Optional list of selected values.
Default: ["New","Active"]
Options: New ("New"), Active ("Active"), On-Hold ("On-Hold"), Delivered ("Delivered"), Closed ("Closed"), Stopped ("Stopped")
classification
selectdynamic options
Classification
Optional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.
order_branches
multi_select
Order Branches
Optional list of selected values.
created_within_days
number
Created Within Days
Optional numeric value.
Default: 0
max_orders_to_read
number
Max Orders To Read
Optional numeric value.
Default: 1000
shard_count
number
Shard Count
Optional numeric value.
Default: 1
shard_index
number
Shard Index
Optional numeric value.
Default: 0

Outputs

successSuccess
completeComplete
ordersOrders
sales_order_keysSales Order Keys
countCount
scanned_countScanned Count
searched_countSearched Count
searched_statusesSearched Statuses
created_fromCreated From
wip_statesWip States
shard_indexShard Index
shard_countShard Count
messageMessage
errorError
error_messageError Message

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",
  "required": [
    "wip_states"
  ],
  "properties": {
    "wip_states": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Required list of selected values. Retrieve allowed values from the dynamic options endpoint.",
      "x-dynamic-options": true,
      "x-workflow-field-type": "multi_select"
    },
    "shard_count": {
      "type": "number",
      "default": 1,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "shard_index": {
      "type": "number",
      "default": 0,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "classification": {
      "type": "string",
      "description": "Optional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.",
      "x-dynamic-options": true,
      "x-workflow-field-type": "select"
    },
    "order_branches": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional list of selected values.",
      "x-workflow-field-type": "multi_select"
    },
    "order_statuses": {
      "type": "array",
      "items": {
        "enum": [
          "New",
          "Active",
          "On-Hold",
          "Delivered",
          "Closed",
          "Stopped"
        ],
        "type": "string"
      },
      "default": [
        "New",
        "Active"
      ],
      "description": "Optional list of selected values.",
      "x-workflow-field-type": "multi_select"
    },
    "max_orders_to_read": {
      "type": "number",
      "default": 1000,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "created_within_days": {
      "type": "number",
      "default": 0,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "count": {},
    "error": {},
    "orders": {},
    "message": {},
    "success": {},
    "complete": {},
    "wip_states": {},
    "shard_count": {},
    "shard_index": {},
    "created_from": {},
    "error_message": {},
    "scanned_count": {},
    "searched_count": {},
    "sales_order_keys": {},
    "searched_statuses": {}
  },
  "additionalProperties": true
}

View all Brightree actions