Search Receipt Invoices
Perform Search Receipt Invoices through Brightree.
brightree_search_receipt_invoicesreadbrightree
Inputs
- Deposit Key
deposit_keyexpressionOptional literal value or workflow expression.
- Receipt Key
receipt_keyexpressionOptional literal value or workflow expression.
- Search Criteria
search_criteriaexpressionOptional literal value or workflow expression.
- Exclude Zero Balances
exclude_zero_balancesbooleanOptional true-or-false value.
Default:
true - Include Patient
include_patientbooleanOptional true-or-false value.
Default:
true - Include Insurance
include_insurancebooleanOptional true-or-false value.
Default:
true - Include Facility
include_facilitybooleanOptional true-or-false value.
Default:
false
Outputs
deposit_keyDeposit Keyreceipt_keyReceipt KeyinvoicesInvoicescountCountmessageMessageerrorError
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": {
"deposit_key": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"receipt_key": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"include_patient": {
"type": "boolean",
"default": true,
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
},
"search_criteria": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"include_facility": {
"type": "boolean",
"default": false,
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
},
"include_insurance": {
"type": "boolean",
"default": true,
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
},
"exclude_zero_balances": {
"type": "boolean",
"default": true,
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
}
},
"additionalProperties": false
}Output schema
{
"type": "object",
"properties": {
"count": {},
"error": {},
"message": {},
"invoices": {},
"deposit_key": {},
"receipt_key": {}
},
"additionalProperties": true
}