Brightree integration

Ensure Sales Order Items

Perform Ensure Sales Order Items through Brightree.

brightree_ensure_sales_order_items

writebrightree

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": {
    "dry_run": true
  },
  "handler": "brightree_ensure_sales_order_items"
}

Action contracts and connections · Run recovery

Inputs

document_id
expressionrequired
Document Id
Required literal value or workflow expression.
patient_key
expressionrequired
Patient Key
Required literal value or workflow expression.
sales_order_key
expressionrequired
Sales Order Key
Required literal value or workflow expression.
items
repeatable_grouprequired
Items
Required list of structured items.
- item_code
  textrequired
  Item Code
  Required text value.
- procedure_code
  textrequired
  Procedure Code
  Required text value.
- quantity
  numberrequired
  Quantity
  Required numeric value.
- sale_type
  selectrequired
  Sale Type
  Required selected identifier or value.
  Options: Purchase ("purchase"), Rental ("rental")
dry_run
boolean
Dry Run
Optional true-or-false value.
Default: true

Outputs

successSuccess
document_idDocument Id
verifiedVerified
dry_runDry Run
changedChanged
added_itemsAdded Items
missing_itemsMissing Items
errorError

Output schema completeness: best_effort_declared

Safety

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

Schemas

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

Input schema

{
  "type": "object",
  "required": [
    "document_id",
    "patient_key",
    "sales_order_key",
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "item_code",
          "procedure_code",
          "quantity",
          "sale_type"
        ],
        "properties": {
          "quantity": {
            "type": "number",
            "description": "Required numeric value.",
            "x-workflow-field-type": "number"
          },
          "item_code": {
            "type": "string",
            "description": "Required text value.",
            "x-workflow-field-type": "text"
          },
          "sale_type": {
            "enum": [
              "purchase",
              "rental"
            ],
            "type": "string",
            "description": "Required selected identifier or value.",
            "x-workflow-field-type": "select"
          },
          "procedure_code": {
            "type": "string",
            "description": "Required text value.",
            "x-workflow-field-type": "text"
          }
        },
        "additionalProperties": false
      },
      "description": "Required list of structured items.",
      "x-workflow-field-type": "repeatable_group"
    },
    "dry_run": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "document_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "patient_key": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "sales_order_key": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "changed": {},
    "dry_run": {},
    "success": {},
    "verified": {},
    "added_items": {},
    "document_id": {},
    "missing_items": {}
  },
  "additionalProperties": true
}

View all Brightree actions