Brightree integration

Resolve CMN-Linked Sales Order

Perform Resolve CMN-Linked Sales Order through Brightree.

View as Markdown

brightree_resolve_cmn_linked_sales_order

readbrightree

Inputs

patient_key
expressionrequired
Patient Key
Required literal value or workflow expression.
cmn_key
expressionrequired
Cmn Key
Required literal value or workflow expression.
statuses
multi_select
Statuses
Optional list of selected values.
Options: New ("New"), Active ("Active"), On-Hold ("On-Hold"), Delivered ("Delivered"), Closed ("Closed"), Stopped ("Stopped")
required_wip_state
selectdynamic options
Required Wip State
Optional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.
require_actual_delivery
boolean
Require Actual Delivery
Optional true-or-false value.
Default: false
allow_multiple
boolean
Allow Multiple
Optional true-or-false value.
Default: false
max_candidates
number
Max Candidates
Optional numeric value.
Default: 25

Outputs

successSuccess
patient_keyPatient Key
cmn_keyCmn Key
sales_order_keySales Order Key
statusStatus
created_dateCreated Date
scheduled_delivery_dateScheduled Delivery Date
actual_delivery_dateActual Delivery Date
wip_stateWip State
candidate_countCandidate Count
linked_order_keysLinked Order Keys
matching_order_keysMatching Order Keys
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": [
    "patient_key",
    "cmn_key"
  ],
  "properties": {
    "cmn_key": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "statuses": {
      "type": "array",
      "items": {
        "enum": [
          "New",
          "Active",
          "On-Hold",
          "Delivered",
          "Closed",
          "Stopped"
        ],
        "type": "string"
      },
      "description": "Optional list of selected values.",
      "x-workflow-field-type": "multi_select"
    },
    "patient_key": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "allow_multiple": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "max_candidates": {
      "type": "number",
      "default": 25,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "required_wip_state": {
      "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"
    },
    "require_actual_delivery": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "status": {},
    "cmn_key": {},
    "success": {},
    "wip_state": {},
    "patient_key": {},
    "created_date": {},
    "candidate_count": {},
    "sales_order_key": {},
    "linked_order_keys": {},
    "matching_order_keys": {},
    "actual_delivery_date": {},
    "scheduled_delivery_date": {}
  },
  "additionalProperties": true
}

View all Brightree actions