Skip to documentation
Brightree integration

Void Sales Order Batches

Perform Void Sales Order Batches through Brightree.

View as Markdown
brightree_void_sales_order_batches
irreversiblebrightree

Inputs

  • void_requests
    jsonrequired
    Void Requests

    Required JSON value.

  • dry_run
    boolean
    Dry Run

    Optional true-or-false value.

    Default: false

Outputs

  • successSuccess
  • resultsResults
  • voided_countVoided Count
  • failed_countFailed Count
  • dry_runDry Run
  • 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": [
    "void_requests"
  ],
  "properties": {
    "dry_run": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "void_requests": {
      "description": "Required JSON value.",
      "x-workflow-field-type": "json"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "dry_run": {},
    "results": {},
    "success": {},
    "failed_count": {},
    "voided_count": {},
    "error_message": {}
  },
  "additionalProperties": true
}
View all Brightree actions