Skip to documentation
Brightree integration

Refresh Historical Order Index

Perform Refresh Historical Order Index through Brightree.

View as Markdown
brightree_refresh_historical_order_index
writebrightree

Inputs

  • days_back
    numberrequired
    Days Back

    Required numeric value.

    Default: 120

  • skip_recent_days
    number
    Skip Recent Days

    Optional numeric value.

    Default: 0

  • date_from
    date
    Date From

    Optional date in YYYY-MM-DD format.

  • date_to
    date
    Date To

    Optional date in YYYY-MM-DD format.

  • max_orders
    numberrequired
    Max Orders

    Required numeric value.

    Default: 25

  • reobserve_unpaid_after_days
    numberrequired
    Reobserve Unpaid After Days

    Required numeric value.

    Default: 7

  • include_actual_financials
    booleanrequired
    Include Actual Financials

    Required true-or-false value.

    Default: true

  • reprocess_paid
    boolean
    Reprocess Paid

    Optional true-or-false value.

    Default: false

  • continue_on_error
    booleanrequired
    Continue On Error

    Required true-or-false value.

    Default: true

Outputs

  • successSuccess
  • date_fromDate From
  • date_toDate To
  • window_exhaustedWindow Exhausted
  • days_completedDays Completed
  • orders_seenOrders Seen
  • orders_processedOrders Processed
  • orders_skipped_settledOrders Skipped Settled
  • orders_skipped_freshOrders Skipped Fresh
  • order_lines_seenOrder Lines Seen
  • insertedInserted
  • updatedUpdated
  • orders_without_indexable_itemsOrders Without Indexable Items
  • financial_estimates_unavailableFinancial Estimates Unavailable
  • order_errorsOrder Errors
  • 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",
  "required": [
    "days_back",
    "max_orders",
    "reobserve_unpaid_after_days",
    "include_actual_financials",
    "continue_on_error"
  ],
  "properties": {
    "date_to": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "date_from": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "days_back": {
      "type": "number",
      "default": 120,
      "description": "Required numeric value.",
      "x-workflow-field-type": "number"
    },
    "max_orders": {
      "type": "number",
      "default": 25,
      "description": "Required numeric value.",
      "x-workflow-field-type": "number"
    },
    "reprocess_paid": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "skip_recent_days": {
      "type": "number",
      "default": 0,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "continue_on_error": {
      "type": "boolean",
      "default": true,
      "description": "Required true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "include_actual_financials": {
      "type": "boolean",
      "default": true,
      "description": "Required true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "reobserve_unpaid_after_days": {
      "type": "number",
      "default": 7,
      "description": "Required numeric value.",
      "x-workflow-field-type": "number"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "date_to": {},
    "success": {},
    "updated": {},
    "inserted": {},
    "date_from": {},
    "orders_seen": {},
    "order_errors": {},
    "days_completed": {},
    "order_lines_seen": {},
    "orders_processed": {},
    "window_exhausted": {},
    "orders_skipped_fresh": {},
    "orders_skipped_settled": {},
    "orders_without_indexable_items": {},
    "financial_estimates_unavailable": {}
  },
  "additionalProperties": true
}
View all Brightree actions