Brightree integration

Search Sales Orders by Actual Delivery Date

Perform Search Sales Orders by Actual Delivery Date through Brightree.

View as Markdown

brightree_search_sales_orders_by_actual_delivery

readbrightree

Inputs

actual_delivery_from
daterequired
Actual Delivery From
Required date in YYYY-MM-DD format.
actual_delivery_to
daterequired
Actual Delivery To
Required date in YYYY-MM-DD format.
page
number
Page
Optional numeric value.
Default: 1
page_size
select
Page Size
Optional selected identifier or value.
Default: 50
Options: 10 (10), 25 (25), 50 (50)
fetch_all
boolean
Fetch All
Optional true-or-false value.
Default: false
include_orders
boolean
Include Orders
Optional true-or-false value.
Default: false

Outputs

successSuccess
completeComplete
ordersOrders
sales_order_keysSales Order Keys
countCount
total_itemsTotal Items
total_pagesTotal Pages
pages_fetchedPages Fetched
current_pageCurrent Page
pagePage
page_sizePage Size
fetch_allFetch All
include_ordersInclude Orders
actual_delivery_fromActual Delivery From
actual_delivery_toActual Delivery To
duplicate_key_countDuplicate Key Count
completion_evidenceCompletion Evidence
html_row_countHtml Row Count
unique_record_countUnique Record Count
messageMessage
errorError
error_messageError Message

Output schema completeness: best_effort_declared

Safety

External effect: read
Confirmation recommended: No
Retry safe: Yes
Dry run supported: No

Schemas

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

Input schema

{
  "type": "object",
  "required": [
    "actual_delivery_from",
    "actual_delivery_to"
  ],
  "properties": {
    "page": {
      "type": "number",
      "default": 1,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "fetch_all": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "page_size": {
      "enum": [
        10,
        25,
        50
      ],
      "type": "number",
      "default": 50,
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "include_orders": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "actual_delivery_to": {
      "type": "string",
      "format": "date",
      "description": "Required date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "actual_delivery_from": {
      "type": "string",
      "format": "date",
      "description": "Required date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "page": {},
    "count": {},
    "error": {},
    "orders": {},
    "message": {},
    "success": {},
    "complete": {},
    "fetch_all": {},
    "page_size": {},
    "total_items": {},
    "total_pages": {},
    "current_page": {},
    "error_message": {},
    "pages_fetched": {},
    "html_row_count": {},
    "include_orders": {},
    "sales_order_keys": {},
    "actual_delivery_to": {},
    "completion_evidence": {},
    "duplicate_key_count": {},
    "unique_record_count": {},
    "actual_delivery_from": {}
  },
  "additionalProperties": true
}

View all Brightree actions