Skip to documentation
Brightree integration

Select Sales Order Templates

Perform Select Sales Order Templates through Brightree.

View as Markdown
brightree_select_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

  • 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

Outputs

  • successSuccess
  • orders_selectedOrders Selected
  • order_keysOrder Keys
  • queue_depth_beforeQueue Depth Before
  • queue_headroomQueue Headroom
  • target_queue_depthTarget Queue Depth
  • source_systemSource System
  • source_report_nameSource Report Name
  • source_report_base_urlSource Report Base Url
  • source_account_keySource Account Key
  • source_filter_summarySource Filter Summary
  • source_filter_rowsSource Filter Rows
  • source_confirm_date_after_configuredSource Confirm Date After Configured
  • source_confirm_date_after_effectiveSource Confirm Date After Effective
  • source_confirm_date_lookback_daysSource Confirm Date Lookback Days
  • raw_countRaw Count
  • deduped_countDeduped Count
  • candidate_countCandidate Count
  • text_filter_candidate_countText Filter Candidate Count
  • dispatchable_countDispatchable Count
  • recently_excludedRecently Excluded
  • in_flight_excludedIn Flight Excluded
  • exhausted_excludedExhausted Excluded
  • verification_excludedVerification Excluded
  • verification_excluded_order_keysVerification Excluded Order Keys
  • not_processed_ordersNot Processed Orders
  • not_processed_omitted_countNot Processed Omitted Count
  • not_processed_seen_countNot Processed Seen Count
  • exhausted_alert_sentExhausted Alert Sent
  • exhausted_alert_suppressedExhausted Alert Suppressed
  • exhausted_alert_job_idExhausted Alert Job Id
  • report_cap_alert_levelReport Cap Alert Level
  • report_cap_alert_sentReport Cap Alert Sent
  • report_cap_alert_suppressedReport Cap Alert Suppressed
  • report_cap_alert_job_idReport Cap Alert Job Id
  • 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": {
    "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"
    },
    "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": {},
    "message": {},
    "success": {},
    "raw_count": {},
    "order_keys": {},
    "deduped_count": {},
    "source_system": {},
    "queue_headroom": {},
    "candidate_count": {},
    "orders_selected": {},
    "recently_excluded": {},
    "dispatchable_count": {},
    "exhausted_excluded": {},
    "in_flight_excluded": {},
    "queue_depth_before": {},
    "source_account_key": {},
    "source_filter_rows": {},
    "source_report_name": {},
    "target_queue_depth": {},
    "exhausted_alert_sent": {},
    "not_processed_orders": {},
    "report_cap_alert_sent": {},
    "source_filter_summary": {},
    "verification_excluded": {},
    "exhausted_alert_job_id": {},
    "report_cap_alert_level": {},
    "source_report_base_url": {},
    "report_cap_alert_job_id": {},
    "not_processed_seen_count": {},
    "exhausted_alert_suppressed": {},
    "not_processed_omitted_count": {},
    "report_cap_alert_suppressed": {},
    "text_filter_candidate_count": {},
    "verification_excluded_order_keys": {},
    "source_confirm_date_lookback_days": {},
    "source_confirm_date_after_effective": {},
    "source_confirm_date_after_configured": {}
  },
  "additionalProperties": true
}
View all Brightree actions