Brightree integration

Update Sales Order Aftercare

Perform Update Sales Order Aftercare through Brightree.

View as Markdown

brightree_update_sales_order_aftercare

writebrightree

Inputs

sales_order_key
expressionrequired
Sales Order Key
Required literal value or workflow expression.
wip_state
selectdynamic options
Wip State
Optional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.
assigned_to_key
expression
Assigned To Key
Optional literal value or workflow expression.
assigned_to_name
expression
Assigned To Name
Optional literal value or workflow expression.
date_needed
expression
Date Needed
Optional literal value or workflow expression.
expected_current_wip_state
expression
Expected Current Wip State
Optional literal value or workflow expression.
expected_current_classification
expression
Expected Current Classification
Optional literal value or workflow expression.
order_note_append
textarea
Order Note Append
Optional text value.
dry_run
boolean
Dry Run
Optional true-or-false value.
Default: false

Outputs

successSuccess
updatedUpdated
noopNoop
dry_runDry Run
sales_order_keySales Order Key
resolved_assigned_to_keyResolved Assigned To Key
resolved_assigned_to_nameResolved Assigned To Name
fields_updatedFields Updated
actualActual
mismatchesMismatches
messageMessage
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": [
    "sales_order_key"
  ],
  "properties": {
    "dry_run": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "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"
    },
    "date_needed": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "assigned_to_key": {
      "description": "Optional 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"
    },
    "assigned_to_name": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "order_note_append": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "textarea"
    },
    "expected_current_wip_state": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "expected_current_classification": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "noop": {},
    "error": {},
    "actual": {},
    "dry_run": {},
    "message": {},
    "success": {},
    "updated": {},
    "mismatches": {},
    "fields_updated": {},
    "sales_order_key": {},
    "resolved_assigned_to_key": {},
    "resolved_assigned_to_name": {}
  },
  "additionalProperties": true
}

View all Brightree actions