Skip to documentation
Brightree integration

Search Deposits

Perform Search Deposits through Brightree.

View as Markdown
brightree_search_deposits
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": {
    "status": "2",
    "max_pages": 1
  },
  "handler": "brightree_search_deposits"
}

Action contracts and connections · Run recovery

Inputs

  • status
    text
    Status

    Optional text value.

    Default: "2"

  • reference
    expression
    Reference

    Optional literal value or workflow expression.

  • deposit_id
    expression
    Deposit Id

    Optional literal value or workflow expression.

  • posted_date_from
    date
    Posted Date From

    Optional date in YYYY-MM-DD format.

  • posted_date_to
    date
    Posted Date To

    Optional date in YYYY-MM-DD format.

  • max_pages
    number
    Max Pages

    Optional numeric value.

    Default: 1

Outputs

  • depositsDeposits
  • countCount
  • current_pageCurrent Page
  • total_pagesTotal Pages
  • has_moreHas More
  • messageMessage
  • errorError

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",
  "properties": {
    "status": {
      "type": "string",
      "default": "2",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "max_pages": {
      "type": "number",
      "default": 1,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "reference": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "deposit_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "posted_date_to": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "posted_date_from": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "count": {},
    "error": {},
    "message": {},
    "deposits": {},
    "has_more": {},
    "total_pages": {},
    "current_page": {}
  },
  "additionalProperties": true
}
View all Brightree actions