Search Deposits
Perform Search Deposits through Brightree.
brightree_search_depositsreadbrightree
Inputs
- Status
statustextOptional text value.
Default:
"2" - Reference
referenceexpressionOptional literal value or workflow expression.
- Deposit Id
deposit_idexpressionOptional literal value or workflow expression.
- Posted Date From
posted_date_fromdateOptional date in YYYY-MM-DD format.
- Posted Date To
posted_date_todateOptional date in YYYY-MM-DD format.
- Max Pages
max_pagesnumberOptional numeric value.
Default:
1
Outputs
depositsDepositscountCountcurrent_pageCurrent Pagetotal_pagesTotal Pageshas_moreHas MoremessageMessageerrorError
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
}