Brightree integration

Search Order

Perform Search Order through Brightree.

brightree_search_order

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": {
    "page": 1,
    "fetch_all": false,
    "page_size": 50
  },
  "handler": "brightree_search_order"
}

Action contracts and connections · Run recovery

Inputs

patient_key
number
Patient Key
Optional numeric value.
order_status
select
Order Status
Optional selected identifier or value.
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.
fetch_all
boolean
Fetch All
Optional true-or-false value.
Default: false
page
number
Page
Optional numeric value.
Default: 1
page_size
select
Page Size
Optional selected identifier or value.
Default: 50
Options: 10 (10), 25 (25), 50 (50)

Outputs

successSuccess
completeComplete
ordersOrders
sales_order_keysSales Order Keys
countCount
total_itemsTotal Items
total_pagesTotal Pages
current_pageCurrent Page
pagePage
page_sizePage Size
fetch_allFetch All
order_statusOrder Status
patient_keyPatient Key
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",
  "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"
    },
    "page_size": {
      "enum": [
        10,
        25,
        50
      ],
      "type": "number",
      "default": 50,
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "patient_key": {
      "type": "number",
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "order_status": {
      "enum": [
        "New",
        "Active",
        "On-Hold",
        "Delivered",
        "Closed",
        "Stopped"
      ],
      "type": "string",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "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"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "page": {},
    "count": {},
    "error": {},
    "orders": {},
    "message": {},
    "success": {},
    "complete": {},
    "fetch_all": {},
    "page_size": {},
    "patient_key": {},
    "total_items": {},
    "total_pages": {},
    "current_page": {},
    "order_status": {},
    "error_message": {},
    "sales_order_keys": {}
  },
  "additionalProperties": true
}

View all Brightree actions