Refresh Historical Order Index
Perform Refresh Historical Order Index through Brightree.
brightree_refresh_historical_order_indexwritebrightree
Inputs
- Days Back
days_backnumberrequiredRequired numeric value.
Default:
120 - Skip Recent Days
skip_recent_daysnumberOptional numeric value.
Default:
0 - Date From
date_fromdateOptional date in YYYY-MM-DD format.
- Date To
date_todateOptional date in YYYY-MM-DD format.
- Max Orders
max_ordersnumberrequiredRequired numeric value.
Default:
25 - Reobserve Unpaid After Days
reobserve_unpaid_after_daysnumberrequiredRequired numeric value.
Default:
7 - Include Actual Financials
include_actual_financialsbooleanrequiredRequired true-or-false value.
Default:
true - Reprocess Paid
reprocess_paidbooleanOptional true-or-false value.
Default:
false - Continue On Error
continue_on_errorbooleanrequiredRequired true-or-false value.
Default:
true
Outputs
successSuccessdate_fromDate Fromdate_toDate Towindow_exhaustedWindow Exhausteddays_completedDays Completedorders_seenOrders Seenorders_processedOrders Processedorders_skipped_settledOrders Skipped Settledorders_skipped_freshOrders Skipped Freshorder_lines_seenOrder Lines SeeninsertedInsertedupdatedUpdatedorders_without_indexable_itemsOrders Without Indexable Itemsfinancial_estimates_unavailableFinancial Estimates Unavailableorder_errorsOrder ErrorserrorError
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
}