# Void Sales Order

> Perform Void Sales Order through Brightree.

Source: [https://genhealth.ai/docs/workflows/integrations/brightree/brightree_void_sales_order](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_void_sales_order)

Integration: [Brightree](https://genhealth.ai/docs/workflows/integrations/brightree.md)

- Handler: `brightree_void_sales_order`

- Connection type: `brightree`

## Inputs

- `sales_order_key` — Sales Order Key (expression, required)
  Required literal value or workflow expression.
- `reason_code` — Reason Code (number, required)
  Required numeric value.
- `dry_run` — Dry Run (boolean)
  Optional true-or-false value.
  Default: `false`

## Outputs

- `success` — Success
- `voided` — Voided
- `dry_run` — Dry Run
- `sales_order_key` — Sales Order Key
- `void_key` — Void Key
- `reason_code` — Reason Code
- `message` — Message
- `error` — Error
- `error_message` — Error 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

```json
{
  "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

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