Skip to documentation
Brightree integration

Search Sales Orders by Created Date

Perform Search Sales Orders by Created Date through Brightree.

View as Markdown
brightree_search_sales_orders_by_created_date
readbrightree

Use in a workflow

Copy the discovered node config and fill its params from the input contract. Validate the complete graph before publishing. Integration results use {{node_id.default.field}}. Check business success before dependent writes; completion alone does not prove success.

{
  "_group": "Brightree",
  "params": {
    "page": 1,
    "fetch_all": false,
    "page_size": 50,
    "include_orders": false
  },
  "handler": "brightree_search_sales_orders_by_created_date"
}

Action contracts and connections · Run recovery

Inputs

  • created_from
    daterequired
    Created From

    Required date in YYYY-MM-DD format.

  • created_to
    daterequired
    Created To

    Required date in YYYY-MM-DD format.

  • classification
    selectdynamic options
    Classification

    Optional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.

  • order_branches
    multi_select
    Order Branches

    Optional list of selected values.

  • 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
  • created_fromCreated From
  • created_toCreated 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": [
    "created_from",
    "created_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"
    },
    "created_to": {
      "type": "string",
      "format": "date",
      "description": "Required date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "created_from": {
      "type": "string",
      "format": "date",
      "description": "Required date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "classification": {
      "type": "string",
      "description": "Optional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.",
      "x-dynamic-options": true,
      "x-workflow-field-type": "select"
    },
    "include_orders": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "order_branches": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional list of selected values.",
      "x-workflow-field-type": "multi_select"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "page": {},
    "count": {},
    "error": {},
    "orders": {},
    "message": {},
    "success": {},
    "complete": {},
    "fetch_all": {},
    "page_size": {},
    "created_to": {},
    "total_items": {},
    "total_pages": {},
    "created_from": {},
    "current_page": {},
    "error_message": {},
    "pages_fetched": {},
    "html_row_count": {},
    "include_orders": {},
    "sales_order_keys": {},
    "completion_evidence": {},
    "duplicate_key_count": {},
    "unique_record_count": {}
  },
  "additionalProperties": true
}
View all Brightree actions