Brightree integration

Void Sales Order

Perform Void Sales Order through Brightree.

View as Markdown

brightree_void_sales_order

irreversiblebrightree

Inputs

sales_order_key
expressionrequired
Sales Order Key
Required literal value or workflow expression.
reason_code
numberrequired
Reason Code
Required numeric value.
dry_run
boolean
Dry Run
Optional true-or-false value.
Default: false

Outputs

successSuccess
voidedVoided
dry_runDry Run
sales_order_keySales Order Key
void_keyVoid Key
reason_codeReason Code
messageMessage
errorError
error_messageError Message

Output schema completeness: best_effort_declared

Safety

External effect: irreversible
Confirmation recommended: Yes
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",
    "reason_code"
  ],
  "properties": {
    "dry_run": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "reason_code": {
      "type": "number",
      "description": "Required numeric value.",
      "x-workflow-field-type": "number"
    },
    "sales_order_key": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "voided": {},
    "dry_run": {},
    "message": {},
    "success": {},
    "void_key": {},
    "reason_code": {},
    "error_message": {},
    "sales_order_key": {}
  },
  "additionalProperties": true
}

View all Brightree actions