Brightree integration

Dispatch Sales Order Templates

Perform Dispatch Sales Order Templates through Brightree.

View as Markdown

brightree_dispatch_sales_order_templates

writebrightree

Inputs

account_key
text
Account Key
Optional text value.
classification
text
Classification
Optional text value.
confirm_date_after
date
Confirm Date After
Optional date in YYYY-MM-DD format.
confirm_date_lookback_days
number
Confirm Date Lookback Days
Optional numeric value.
Default: 90
report_limit
number
Report Limit
Optional numeric value.
Default: 15000
runs_per_order
number
Runs Per Order
Optional numeric value.
Default: 1
target_queue_depth
number
Target Queue Depth
Optional numeric value.
Default: 10
max_dispatch_per_run
number
Max Dispatch Per Run
Optional numeric value.
use_local_agent
boolean
Use Local Agent
Optional true-or-false value.
Default: false
http_only
boolean
Http Only
Optional true-or-false value.
Default: true

Outputs

successSuccess
job_idJob Id
orders_dispatchedOrders Dispatched
order_keysOrder Keys
queue_depth_beforeQueue Depth Before
queue_headroomQueue Headroom
target_queue_depthTarget Queue Depth
messageMessage
errorError

Output schema completeness: best_effort_declared

Safety

External effect: write
Confirmation recommended: No
Retry safe: No
Dry run supported: No

Schemas

These schemas are first-pass authoring guidance. Runtime validation remains authoritative.

Input schema

{
  "type": "object",
  "properties": {
    "http_only": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "account_key": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "report_limit": {
      "type": "number",
      "default": 15000,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "classification": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "runs_per_order": {
      "type": "number",
      "default": 1,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "use_local_agent": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "confirm_date_after": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "target_queue_depth": {
      "type": "number",
      "default": 10,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "max_dispatch_per_run": {
      "type": "number",
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "confirm_date_lookback_days": {
      "type": "number",
      "default": 90,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "job_id": {},
    "message": {},
    "success": {},
    "order_keys": {},
    "queue_headroom": {},
    "orders_dispatched": {},
    "queue_depth_before": {},
    "target_queue_depth": {}
  },
  "additionalProperties": true
}

View all Brightree actions