Void Sales Order Batches
Perform Void Sales Order Batches through Brightree.
brightree_void_sales_order_batchesirreversiblebrightree
Inputs
- Void Requests
void_requestsjsonrequiredRequired JSON value.
- Dry Run
dry_runbooleanOptional true-or-false value.
Default:
false
Outputs
successSuccessresultsResultsvoided_countVoided Countfailed_countFailed Countdry_runDry Runerror_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
}