Brightree integration

Read Sales Order

Perform Read Sales Order through Brightree.

View as Markdown

brightree_read_sales_order

readbrightree

Inputs

sales_order_key
expressionrequired
Sales Order Key
Required literal value or workflow expression.
tabs
multi_select
Tabs
Optional list of selected values.
Options: Order ("order"), Clinical ("clinical"), Insurance ("insurance"), Items ("items"), Purchasing ("purchasing"), Schedule ("schedule"), Proof of Delivery ("pod"), Messages ("messages"), Custom Fields ("custom_fields"), Forms ("forms"), History ("history"), Documents ("documents")

Outputs

successSuccess
sales_order_keySales Order Key
patient_idPatient Id
patient_keyPatient Key
patient_namePatient Name
order_numberOrder Number
headerHeader
orderOrder
clinicalClinical
insuranceInsurance
itemsItems
purchasingPurchasing
scheduleSchedule
podPod
messagesMessages
custom_fieldsCustom Fields
formsForms
historyHistory
documentsDocuments
urlUrl
patient_key_errorPatient Key Error
errorError

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": [
    "sales_order_key"
  ],
  "properties": {
    "tabs": {
      "type": "array",
      "items": {
        "enum": [
          "order",
          "clinical",
          "insurance",
          "items",
          "purchasing",
          "schedule",
          "pod",
          "messages",
          "custom_fields",
          "forms",
          "history",
          "documents"
        ],
        "type": "string"
      },
      "description": "Optional list of selected values.",
      "x-workflow-field-type": "multi_select"
    },
    "sales_order_key": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "pod": {},
    "url": {},
    "error": {},
    "forms": {},
    "items": {},
    "order": {},
    "header": {},
    "history": {},
    "success": {},
    "clinical": {},
    "messages": {},
    "schedule": {},
    "documents": {},
    "insurance": {},
    "patient_id": {},
    "purchasing": {},
    "patient_key": {},
    "order_number": {},
    "patient_name": {},
    "custom_fields": {},
    "sales_order_key": {},
    "patient_key_error": {}
  },
  "additionalProperties": true
}

View all Brightree actions