Brightree Margin Review integration

Evaluate Sales Order Margin Queue

Perform Evaluate Sales Order Margin Queue through Brightree Margin Review.

View as Markdown

brightree_evaluate_historical_payment_margin_queue

writebrightree

Inputs

current_status
textrequired
Current Status
Required text value.
Default: "6"
max_orders
numberrequired
Max Orders
Required numeric value.
Default: 10
max_queue_pages
number
Max Queue Pages
Optional numeric value.
Default: 20
orders_created_after
date
Orders Created After
Optional date in YYYY-MM-DD format.
history_cutoff
daterequired
History Cutoff
Required date in YYYY-MM-DD format.
Default: "2025-01-01"
dry_run
booleanrequired
Dry Run
Required true-or-false value.
Default: true

Outputs

successSuccess
evaluation_run_idEvaluation Run Id
dry_runDry Run
evaluated_ordersEvaluated Orders
evaluated_itemsEvaluated Items
matched_itemsMatched Items
unverified_itemsUnverified Items
error_itemsError Items
updated_ordersUpdated Orders
queue_pages_scannedQueue Pages Scanned
queue_exhaustedQueue Exhausted
order_resultsOrder Results
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": [
    "current_status",
    "max_orders",
    "history_cutoff",
    "dry_run"
  ],
  "properties": {
    "dry_run": {
      "type": "boolean",
      "default": true,
      "description": "Required true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "max_orders": {
      "type": "number",
      "default": 10,
      "description": "Required numeric value.",
      "x-workflow-field-type": "number"
    },
    "current_status": {
      "type": "string",
      "default": "6",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "history_cutoff": {
      "type": "string",
      "format": "date",
      "default": "2025-01-01",
      "description": "Required date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "max_queue_pages": {
      "type": "number",
      "default": 20,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "orders_created_after": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "dry_run": {},
    "success": {},
    "error_items": {},
    "matched_items": {},
    "order_results": {},
    "updated_orders": {},
    "evaluated_items": {},
    "queue_exhausted": {},
    "evaluated_orders": {},
    "unverified_items": {},
    "evaluation_run_id": {},
    "queue_pages_scanned": {}
  },
  "additionalProperties": true
}

View all Brightree Margin Review actions