Brightree integration

Append Order Note

Perform Append Order Note through Brightree.

View as Markdown

brightree_append_order_note

writebrightree

Inputs

sales_order_key
expression
Sales Order Key
Optional literal value or workflow expression.
note_text
textarea
Note Text
Optional text value.
condition_value
expression
Condition Value
Optional literal value or workflow expression.
condition_expected_value
text
Condition Expected Value
Optional text value.
guard_value
expression
Guard Value
Optional literal value or workflow expression.
guard_expected_value
text
Guard Expected Value
Optional text value.
guard_label
text
Guard Label
Optional text value.
skip_if_present_text
text
Skip If Present Text
Optional text value.
order_lease
json
Order Lease
Optional JSON value.
dry_run
boolean
Dry Run
Optional true-or-false value.
Default: false

Outputs

successSuccess
statusStatus
attemptedAttempted
updatedUpdated
already_presentAlready Present
sales_order_keySales Order Key
note_textNote Text
reasonReason
messageMessage
order_leaseOrder Lease
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",
  "properties": {
    "dry_run": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "note_text": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "textarea"
    },
    "guard_label": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "guard_value": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "order_lease": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "condition_value": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "sales_order_key": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "guard_expected_value": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "skip_if_present_text": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "condition_expected_value": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "reason": {},
    "status": {},
    "message": {},
    "success": {},
    "updated": {},
    "attempted": {},
    "note_text": {},
    "order_lease": {},
    "already_present": {},
    "sales_order_key": {}
  },
  "additionalProperties": true
}

View all Brightree actions