# Brightree integration

> Build workflow automations with 88 public Brightree actions.

Source: [https://genhealth.ai/docs/workflows/integrations/brightree](https://genhealth.ai/docs/workflows/integrations/brightree)

## Available actions

88 actions. Connection types: brightree.

### [Add Insurance Policy](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_add_insurance_policy.md)

- Handler: `brightree_add_insurance_policy`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`, `carrier_id`, `payor_level`, `subscriber_first_name`, `subscriber_last_name`, `subscriber_state`, `start_date`
- Outputs: `success`, `policy_key`, `message`, `error`

Perform Add Insurance Policy through Brightree.

### [Add Sales Order Diagnosis Batches](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_add_sales_order_diagnosis_batches.md)

- Handler: `brightree_add_sales_order_diagnosis_batches`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `diagnosis_batches`
- Outputs: `success`, `results`, `updated_count`, `failed_count`, `error_message`

Perform Add Sales Order Diagnosis Batches through Brightree.

### [Adjust Item Quantity](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_adjust_item_quantity.md)

- Handler: `brightree_adjust_item_quantity`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `sales_order_key`, `proc_code`, `quantity`, `billing_quantity`, `dry_run`

Perform Adjust Item Quantity through Brightree.

### [Append Order Note](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_append_order_note.md)

- Handler: `brightree_append_order_note`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `sales_order_key`, `note_text`, `condition_value`, `condition_expected_value`, `guard_value`, `guard_expected_value`, `guard_label`, `skip_if_present_text`, `order_lease`, `dry_run`
- Outputs: `success`, `status`, `attempted`, `updated`, `already_present`, `sales_order_key`, `note_text`, `reason`, `message`, `order_lease`, `error`

Perform Append Order Note through Brightree.

### [Append Patient Custom Field Value](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_append_patient_custom_field_value.md)

- Handler: `brightree_append_patient_custom_field_value`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`, `field_label`, `value`, `delimiter`
- Outputs: `success`, `message`, `updated_fields`, `field_label`, `value`, `error`

Perform Append Patient Custom Field Value through Brightree.

### [Apply Invoice Payment](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_apply_invoice_payment.md)

- Handler: `brightree_apply_invoice_payment`
- Connection type: `brightree`
- External effect: `irreversible`
- Inputs: `deposit_key`, `receipt_key`, `invoice_key`, `amount`, `proc_line_index`, `payment_type`, `reason`, `note`, `expected_balance`, `dry_run`
- Outputs: `success`, `dry_run`, `invoice_key`, `invoice_number`, `payments_applied`, `observed_balance`, `gate_passed`, `message`, `error`

Perform Apply Invoice Payment through Brightree.

### [Assign Fax to User](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_assign_fax_to_user.md)

- Handler: `brightree_assign_fax_to_user`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `fax_key`, `user_name`, `user_key`, `received_date_from`, `received_date_to`, `work_status`, `show_unassigned`, `branch_offices`
- Outputs: `success`, `fax_key`, `error`

Perform Assign Fax to User through Brightree.

### [Calculate Resupply Dates](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_calculate_resupply_dates.md)

- Handler: `brightree_calculate_resupply_dates`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `carrier_name`, `task_date_needed`, `scheduled_date`, `source_so_key`
- Outputs: `new_so_actual_date`, `source_so_key`, `new_so_scheduled_date`, `next_task_date_needed`

Perform Calculate Resupply Dates through Brightree.

### [Check Autoship](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_check_autoship.md)

- Handler: `brightree_check_autoship`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`, `patient_note_key`
- Outputs: `is_autoship`

Perform Check Autoship through Brightree.

### [Check CMN](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_check_cmn.md)

- Handler: `brightree_check_cmn`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`
- Outputs: `has_active`

Perform Check CMN through Brightree.

### [Check CMN Active](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_check_cmn_active.md)

- Handler: `brightree_check_cmn_active`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `items_records`
- Outputs: `is_valid`, `reason`

Perform Check CMN Active through Brightree.

### [Check Coverage Verified](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_check_coverage_verified.md)

- Handler: `brightree_check_coverage_verified`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `verification`
- Outputs: `is_verified`, `reason`

Perform Check Coverage Verified through Brightree.

### [Check Delivery Proof](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_check_delivery_proof.md)

- Handler: `brightree_check_delivery_proof`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `documents`, `delivery_proof_document_types`
- Outputs: `has_match`, `reason`

Perform Check Delivery Proof through Brightree.

### [Check Eligibility](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_check_eligibility.md)

- Handler: `brightree_check_eligibility`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`, `patient_note_key`, `check_secondary`

Perform Check Eligibility through Brightree.

### [Check Patient Exists](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_check_patient_exists.md)

- Handler: `brightree_check_patient_exists`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `document_id`, `force`
- Outputs: `success`, `document_id`, `patient_id`, `patient_name`, `birth_date`, `exists`, `ready_for_patient_create`, `external_id`, `patient_key`, `patient_url`, `status`, `error_message`

Perform Check Patient Exists through Brightree.

### [Check Sales Order Messages](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_check_sales_order_messages.md)

- Handler: `brightree_check_sales_order_messages`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `sales_order_key`, `ignored_message_codes`
- Outputs: `has_blocking_messages`, `reason`

Perform Check Sales Order Messages through Brightree.

### [Check Unresolved Messages](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_check_unresolved_messages.md)

- Handler: `brightree_check_unresolved_messages`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `messages`
- Outputs: `has_unresolved`, `reason`

Perform Check Unresolved Messages through Brightree.

### [Clear Patient Inactivation Reason](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_clear_patient_inactivation_reason.md)

- Handler: `brightree_clear_patient_inactivation_reason`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`, `skip`, `skip_if_missing`, `dry_run`
- Outputs: `success`, `message`, `updated_fields`, `verification_details`, `skipped`, `error`

Perform Clear Patient Inactivation Reason through Brightree.

### [Confirm Sales Order](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_confirm_sales_order.md)

- Handler: `brightree_confirm_sales_order`
- Connection type: `brightree`
- External effect: `irreversible`
- Inputs: `sales_order_key`, `dry_run`
- Outputs: `confirmed`, `error`

Perform Confirm Sales Order through Brightree.

### [Copy Sales Order](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_copy_sales_order.md)

- Handler: `brightree_copy_sales_order`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`, `source_so_key`, `scheduled_date`, `actual_date`, `wip_state`, `classification`, `dry_run`
- Outputs: `new_so_key`

Perform Copy Sales Order through Brightree.

### [Create Doctor from NPI Registry](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_create_doctor_from_npi_registry.md)

- Handler: `brightree_create_doctor_from_npi_registry`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `first_name`, `last_name`, `npi`
- Outputs: `success`, `message`, `doctor_key`, `doctor_name`, `created`, `pecos_verified`, `error`, `error_message`

Perform Create Doctor from NPI Registry through Brightree.

### [Create Drop Ship PO](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_create_drop_ship_po.md)

- Handler: `brightree_create_drop_ship_po`
- Connection type: `brightree`
- External effect: `irreversible`
- Inputs: `sales_order_key`, `vendor`, `priority`, `ship_method`, `signature_required`, `submit_po`, `verification_max_wait_seconds`, `verification_poll_interval_seconds`, `workflow_outcome_mode`
- Outputs: `success`, `manual_review_required`, `outcome_category`, `message`, `purchase_requests`, `items_not_on_pr_count`, `url`, `failure_reason`, `failure_detail`, `error`, `error_message`

Perform Create Drop Ship PO through Brightree.

### [Create Facility](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_create_facility.md)

- Handler: `brightree_create_facility`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`, `name`, `address_1`, `address_2`, `city`, `state`, `postal_code`, `phone`, `fax`, `facility_group_value`, `marketing_rep_text`, `marketing_rep_value`, `country_value`
- Outputs: `success`, `message`, `facility`, `facility_key`, `error`

Perform Create Facility through Brightree.

### [Create Patient](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_create_patient.md)

- Handler: `brightree_create_patient`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `first_name`, `last_name`, `date_of_birth`

Perform Create Patient through Brightree.

### [Create Patient Address](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_create_patient_address.md)

- Handler: `brightree_create_patient_address`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`, `address_line_1`, `address_line_2`, `city`, `state`, `zip_code`
- Outputs: `success`, `message`, `error`

Perform Create Patient Address through Brightree.

### [Create Patient From Document](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_create_patient_from_document.md)

- Handler: `brightree_create_patient_from_document`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `document_id`
- Outputs: `success`, `document_id`, `patient_id`, `patient_name`, `birth_date`, `patient_key`, `external_id`, `created`, `message`, `error_message`

Perform Create Patient From Document through Brightree.

### [Create Patient Note](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_create_patient_note.md)

- Handler: `brightree_create_patient_note`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`, `note_reason`, `subject`, `description`, `severity`, `state`, `status`, `date_needed`, `assigned_to_name`, `dry_run`

Perform Create Patient Note through Brightree.

### [Create Patient Note (If Not Exists)](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_create_patient_note_if_not_exists.md)

- Handler: `brightree_create_patient_note_if_not_exists`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`, `note_reason`, `subject`, `description`, `severity`, `state`, `status`, `date_needed`, `assigned_to_name`, `condition_field`, `skip_if_match`, `description_prepend_if_exists`, `description_append_if_exists`, `skip_if_match_fields`, `skip_if_entry_present`, `dry_run`

Perform Create Patient Note (If Not Exists) through Brightree.

### [Download Fax](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_download_fax.md)

- Handler: `brightree_download_fax`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `fax_key`, `assign_owner_name`, `assign_owner_key`, `received_date_from`, `received_date_to`, `work_status`, `show_unassigned`, `branch_offices`
- Outputs: `success`, `document_id`, `fax_key`, `filename`, `skipped`, `should_process`, `error`

Perform Download Fax through Brightree.

### [Edit Coverage Verified](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_edit_coverage_verified.md)

- Handler: `brightree_edit_coverage_verified`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `sales_order_key`, `checked`, `expected_current_wip_state`, `expected_current_classification`, `dry_run`
- Outputs: `success`, `dry_run`, `checked`, `was_already_checked`, `sales_order_key`, `message`, `error`

Perform Edit Coverage Verified through Brightree.

### [Edit Delivery Dates](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_edit_delivery_dates.md)

- Handler: `brightree_edit_delivery_dates`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `sales_order_key`, `scheduled_date`, `actual_date`

Perform Edit Delivery Dates through Brightree.

### [Edit Patient Insurance Policy Batches](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_edit_patient_insurance_policy_batches.md)

- Handler: `brightree_edit_patient_insurance_policy_batches`

- External effect: `write`
- Inputs: `policy_edit_batches`
- Outputs: `success`, `results`, `updated_count`, `failed_count`, `error_message`

Perform Edit Patient Insurance Policy Batches through Brightree.

### [Edit WIP State](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_edit_wip_state.md)

- Handler: `brightree_edit_wip_state`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `sales_order_key`, `target_wip_state`, `dry_run`

Perform Edit WIP State through Brightree.

### [Ensure Brightree Session](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_ensure_session.md)

- Handler: `brightree_ensure_session`
- Connection type: `brightree`
- External effect: `write`

- Outputs: `available`, `status`, `reason`, `announcement_decision`, `announcement_ids`, `matched_pattern_ids`, `announcement_capture_status`, `announcement_source_state_id`, `announcement_page_hash`, `announcement_warning_alert_sent`

Perform Ensure Brightree Session through Brightree.

### [Ensure Sales Order Status](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_ensure_sales_order_status.md)

- Handler: `brightree_ensure_sales_order_status`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `sales_order_key`, `current_status`, `target_status`, `dry_run`

Perform Ensure Sales Order Status through Brightree.

### [Fetch Sales Order Documents](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_fetch_sales_order_documents.md)

- Handler: `brightree_fetch_sales_order_documents`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `sales_order_key`, `document_types`, `document_types_expression`, `patient_id`
- Outputs: `success`, `document_ids`, `documents`, `missing_types`, `errors`, `error`

Perform Fetch Sales Order Documents through Brightree.

### [Fetch Sales Order Void Reasons](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_fetch_sales_order_void_reasons.md)

- Handler: `brightree_fetch_sales_order_void_reasons`

- External effect: `write`

- Outputs: `success`, `reasons`, `reason_count`, `raw_reasons`, `error`, `error_message`

Perform Fetch Sales Order Void Reasons through Brightree.

### [Find or Create Facility](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_ensure_facility.md)

- Handler: `brightree_ensure_facility`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`, `facility_name`, `address_1`, `city`, `state`, `postal_code`, `match_address_1`, `match_city`, `match_state`, `match_postal_code`, `match_address_source`, `phone`, `fax`, `create_if_missing`, `require_address`
- Outputs: `success`, `message`, `facility`, `facility_text`, `facility_value`, `facility_key`, `created`, `found`, `skipped`, `action_required`, `action_required_message`, `selection_reason`, `missing_fields`, `error`

Perform Find or Create Facility through Brightree.

### [Get Deposit Balance](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_get_deposit_balance.md)

- Handler: `brightree_get_deposit_balance`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `deposit_key`
- Outputs: `deposit_key`, `balance`, `is_balanced`, `reference`, `description`, `brightree_url`, `error`

Perform Get Deposit Balance through Brightree.

### [Get Latest Sales Order](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_get_latest_sales_order.md)

- Handler: `brightree_get_latest_sales_order`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `patient_key`, `status`, `created_date_from`, `created_date_to`, `read_detail`
- Outputs: `sales_order_key`, `scheduled_date`, `found`, `error`

Perform Get Latest Sales Order through Brightree.

### [Get Patient Notes](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_get_patient_notes.md)

- Handler: `brightree_get_patient_notes`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `patient_key`, `note_types`, `status`
- Outputs: `notes_by_type`, `notes`

Perform Get Patient Notes through Brightree.

### [Identify Vendor](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_identify_vendor.md)

- Handler: `brightree_identify_vendor`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `new_so_key`, `patient_key`, `patient_note_key`
- Outputs: `reason`, `status`, `has_vendor`, `vendor_name`

Perform Identify Vendor through Brightree.

### [List Deposit Receipts](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_list_deposit_receipts.md)

- Handler: `brightree_list_deposit_receipts`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `deposit_key`
- Outputs: `deposit_key`, `receipts`, `count`, `error`

Perform List Deposit Receipts through Brightree.

### [List Inbound Faxes](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_list_inbound_faxes.md)

- Handler: `brightree_list_inbound_faxes`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `received_date_from`, `received_date_to`, `work_status`, `show_unassigned`, `branch_offices`, `exclude_nonempty_report_type`, `max_pages`, `max_items`
- Outputs: `faxes`, `count`, `total_items`, `total_pages`, `has_more`, `message`

Perform List Inbound Faxes through Brightree.

### [Post Deposit](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_post_deposit.md)

- Handler: `brightree_post_deposit`
- Connection type: `brightree`
- External effect: `irreversible`
- Inputs: `deposit_key`, `funds_confirmed`, `dry_run`
- Outputs: `success`, `dry_run`, `deposit_key`, `message`, `posted`, `balance`, `is_balanced`, `was_already_posted`, `failure_category`, `brightree_url`, `error`

Perform Post Deposit through Brightree.

### [Push Diagnosis Codes](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_push_diagnosis_codes_to_patient.md)

- Handler: `brightree_push_diagnosis_codes_to_patient`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`, `diagnosis_codes`, `document_id`
- Outputs: `success`, `document_id`, `patient_key`, `pushed`, `icd10_added`, `icd9_added`, `icd10_duplicates`, `icd9_duplicates`, `icd10_failed`, `icd9_failed`, `icd10_no_slot`, `icd9_no_slot`, `message`, `error_message`

Perform Push Diagnosis Codes through Brightree.

### [Read CMN Detail](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_read_cmn_detail.md)

- Handler: `brightree_read_cmn_detail`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `patient_key`, `cmn_key`, `cmn_form_key`, `status_filter`, `occurrence`, `cmn_form_contains`
- Outputs: `success`, `branchable_error`, `error`, `patient_key`, `cmn_key`, `cmn_form_key`, `cmn_status`, `cmn_initial_date`, `cmn_recertification_date`, `cmn_length_of_need_months`, `cmn_expiration`, `cmn_signature_date`, `doctor_name`, `doctor_key`, `cmn_type`, `cmn_type_key`, `branch_name`, `branch_key`, `policy_key`, `policy_text`, `payer_name`, `payer_id`, `policy_level`, `policy_effective_date`, `records`, `count`, `total_records`, `filtered_records`, `selected_row`, `detail_url`

Perform Read CMN Detail through Brightree.

### [Read Deposit ERN Tab](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_read_deposit_ern.md)

- Handler: `brightree_read_deposit_ern`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `deposit_key`
- Outputs: `deposit_key`, `claims`, `count`, `provider`, `batch`, `brightree_url`, `error`

Perform Read Deposit ERN Tab through Brightree.

### [Read Invoice Payment Page](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_read_invoice_payment_page.md)

- Handler: `brightree_read_invoice_payment_page`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `deposit_key`, `receipt_key`, `invoice_key`
- Outputs: `invoice_key`, `invoice_number`, `patient_name`, `date_of_service`, `payer`, `total_balance`, `total_balance_amount`, `proc_lines`, `insurance_tiers`, `brightree_url`, `error`

Perform Read Invoice Payment Page through Brightree.

### [Read Patient Facility](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_read_patient_facility.md)

- Handler: `brightree_read_patient_facility`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `patient_key`
- Outputs: `success`, `facility_found`, `facility`, `facility_name`, `facility_source`, `error`

Perform Read Patient Facility through Brightree.

### [Read Patient Insurance](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_read_patient_insurance.md)

- Handler: `brightree_read_patient_insurance`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `patient_key`, `include_inactive`

Perform Read Patient Insurance through Brightree.

### [Read Patient Personal State](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_read_patient_personal_state.md)

- Handler: `brightree_read_patient_personal_state`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `patient_key`
- Outputs: `success`, `personal_state`, `branch_office`, `account_group`, `pos`, `error`

Perform Read Patient Personal State through Brightree.

### [Read Sales Order](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_read_sales_order.md)

- Handler: `brightree_read_sales_order`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `sales_order_key`, `tabs`
- Outputs: `success`, `sales_order_key`, `patient_id`, `patient_key`, `patient_name`, `order_number`, `header`, `order`, `clinical`, `insurance`, `items`, `purchasing`, `schedule`, `pod`, `messages`, `custom_fields`, `forms`, `history`, `documents`, `url`, `patient_key_error`, `error`

Perform Read Sales Order through Brightree.

### [Read Task Detail](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_read_task_detail.md)

- Handler: `brightree_read_task_detail`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `patient_key`, `patient_note_key`, `patient_note_type_key`
- Outputs: `patient`

Perform Read Task Detail through Brightree.

### [Reassign Tasks by Name](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_reassign_tasks_by_name.md)

- Handler: `brightree_reassign_tasks_by_name`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `source_assigned_to_name`, `target_assigned_to_name`, `task_type`, `task_status`, `date_needed_from`, `date_needed_to`, `subject_contains`, `max_tasks`
- Outputs: `found`, `reassigned`

Perform Reassign Tasks by Name through Brightree.

### [Resolve Patient Context](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_resolve_patient_context.md)

- Handler: `brightree_resolve_patient_context`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `patient_id`
- Outputs: `success`, `patient_id`, `patient_key`, `demographics`, `patient_state_snapshot`, `ordering_doctor`, `ordering_doctor_found`, `marketing_rep_key`, `marketing_rep_name`, `marketing_rep_found`, `warnings`, `error`

Perform Resolve Patient Context through Brightree.

### [Resolve Patient Facility](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_resolve_patient_facility.md)

- Handler: `brightree_resolve_patient_facility`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `patient_key`, `facility_name`, `expected_address`, `facility`, `delivery_info`, `facility_source`, `is_private_residence`, `skip_address_validation`, `skip_if_missing`
- Outputs: `success`, `facility_found`, `is_private_residence`, `delivery_info`, `facility`, `facility_source`, `expected_facility_address`, `facility_text`, `facility_value`, `facility_key`, `skip_facility_write`, `skip_address_sync`, `facility_search_name`, `facility_search_count`, `facility_selection_reason`, `selected_facility`, `action_required`, `action_required_message`, `error`

Perform Resolve Patient Facility through Brightree.

### [Search Deposits](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_search_deposits.md)

- Handler: `brightree_search_deposits`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `status`, `reference`, `deposit_id`, `posted_date_from`, `posted_date_to`, `max_pages`
- Outputs: `deposits`, `count`, `current_page`, `total_pages`, `has_more`, `message`, `error`

Perform Search Deposits through Brightree.

### [Search Marketing Referral Facility Options](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_search_marketing_referral_facility_options.md)

- Handler: `brightree_search_marketing_referral_facility_options`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `patient_key`, `search_text`
- Outputs: `success`, `facilities`, `count`, `error`

Perform Search Marketing Referral Facility Options through Brightree.

### [Search Order](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_search_order.md)

- Handler: `brightree_search_order`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `patient_key`, `order_status`

Perform Search Order through Brightree.

### [Search Patient](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_search_patient.md)

- Handler: `brightree_search_patient`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `first_name`, `last_name`

Perform Search Patient through Brightree.

### [Search Patient Facility Options](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_search_patient_facility_options.md)

- Handler: `brightree_search_patient_facility_options`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `patient_key`, `search_text`
- Outputs: `success`, `facilities`, `count`, `error`

Perform Search Patient Facility Options through Brightree.

### [Search Private ERNs](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_search_private_erns.md)

- Handler: `brightree_search_private_erns`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `status`, `trace_number`, `deposit_id`, `insurance`
- Outputs: `deposits`, `count`, `current_page`, `total_pages`, `has_more`, `message`, `error`

Perform Search Private ERNs through Brightree.

### [Search Receipt Invoices](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_search_receipt_invoices.md)

- Handler: `brightree_search_receipt_invoices`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `deposit_key`, `receipt_key`, `search_criteria`, `exclude_zero_balances`, `include_patient`, `include_insurance`, `include_facility`
- Outputs: `deposit_key`, `receipt_key`, `invoices`, `count`, `message`, `error`

Perform Search Receipt Invoices through Brightree.

### [Search Sales Orders by Actual Delivery Date](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_search_sales_orders_by_actual_delivery.md)

- Handler: `brightree_search_sales_orders_by_actual_delivery`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `actual_delivery_from`, `actual_delivery_to`, `page`, `page_size`, `fetch_all`, `include_orders`
- Outputs: `success`, `complete`, `orders`, `sales_order_keys`, `count`, `total_items`, `total_pages`, `pages_fetched`, `current_page`, `page`, `page_size`, `fetch_all`, `include_orders`, `actual_delivery_from`, `actual_delivery_to`, `duplicate_key_count`, `completion_evidence`, `html_row_count`, `unique_record_count`, `message`, `error`, `error_message`

Perform Search Sales Orders by Actual Delivery Date through Brightree.

### [Search SO Worklist](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_search_so_worklist.md)

- Handler: `brightree_search_so_worklist`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `wip_states`, `page`, `fetch_all`, `include_unassigned`, `sort_by_time_in_wip`, `actual_delivery_date_to`
- Outputs: `orders`

Perform Search SO Worklist through Brightree.

### [Search Tasks](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_search_tasks.md)

- Handler: `brightree_search_tasks`
- Connection type: `brightree`
- External effect: `read`
- Inputs: `date_needed_from`, `date_needed_to`, `task_type`, `status`, `severity`, `assigned_to_key`, `subject`, `description`, `page_size`, `max_pages`
- Outputs: `tasks`

Perform Search Tasks through Brightree.

### [Set Fax Work Status](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_set_fax_work_status.md)

- Handler: `brightree_set_fax_work_status`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `fax_key`, `target_status`, `received_date_from`, `received_date_to`, `work_status_filter`, `show_unassigned`, `branch_offices`
- Outputs: `success`, `fax_key`, `error`

Perform Set Fax Work Status through Brightree.

### [Set Patient Account Group](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_set_patient_account_group.md)

- Handler: `brightree_set_patient_account_group`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`, `account_group`
- Outputs: `success`, `message`, `updated_fields`, `account_group`, `error`

Perform Set Patient Account Group through Brightree.

### [Set Patient Delivery Address Same As Billing](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_set_patient_delivery_address_same_as_billing.md)

- Handler: `brightree_set_patient_delivery_address_same_as_billing`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`, `max_validation_attempts`, `dry_run`, `failure_alert_channel`
- Outputs: `success`, `message`, `updated_fields`, `verification_details`, `error`

Perform Set Patient Delivery Address Same As Billing through Brightree.

### [Set Patient Dropdowns](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_set_patient_dropdowns.md)

- Handler: `brightree_set_patient_dropdowns`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`, `branch_office`, `account_group`, `pos`, `skip`, `dry_run`
- Outputs: `success`, `message`, `updated_fields`, `verification_details`, `branch_office`, `account_group`, `pos`, `skipped`, `error`

Perform Set Patient Dropdowns through Brightree.

### [Set Patient Facility](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_set_patient_facility.md)

- Handler: `brightree_set_patient_facility`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`, `facility_text`, `facility_value`, `skip_if_missing`, `dry_run`
- Outputs: `success`, `message`, `updated_fields`, `skipped`, `error`

Perform Set Patient Facility through Brightree.

### [Set Patient Hold Account](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_set_patient_hold_account.md)

- Handler: `brightree_set_patient_hold_account`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`, `hold_account`, `skip`, `dry_run`
- Outputs: `success`, `message`, `updated_fields`, `verification_details`, `skipped`, `error`

Perform Set Patient Hold Account through Brightree.

### [Set Patient Marketing Referral Facility](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_set_patient_marketing_referral_facility.md)

- Handler: `brightree_set_patient_marketing_referral_facility`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`, `facility_text`, `facility_value`, `skip_if_missing`, `dry_run`, `marketing_rep_name`, `marketing_rep_value`
- Outputs: `success`, `message`, `updated_fields`, `skipped`, `error`

Perform Set Patient Marketing Referral Facility through Brightree.

### [Set Patient Primary Doctor Same as Ordering](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_set_patient_primary_doctor_same_as_ordering.md)

- Handler: `brightree_set_patient_primary_doctor_same_as_ordering`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`, `dry_run`
- Outputs: `success`, `message`, `updated_fields`, `verification_details`, `skipped`, `error`

Perform Set Patient Primary Doctor Same as Ordering through Brightree.

### [Set Patient Responsible Party to Self](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_set_patient_responsible_party_to_self.md)

- Handler: `brightree_set_patient_responsible_party_to_self`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`, `dry_run`
- Outputs: `success`, `message`, `updated_fields`, `verification_details`, `skipped`, `error`

Perform Set Patient Responsible Party to Self through Brightree.

### [Set Patient Tax Zone](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_set_patient_tax_zone.md)

- Handler: `brightree_set_patient_tax_zone`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`, `tax_zone_text`, `tax_zone_value`, `skip_if_missing`, `dry_run`
- Outputs: `success`, `message`, `updated_fields`, `tax_zone_text`, `tax_zone_value`, `expected_tax_zone`, `verification_details`, `skipped`, `error`

Perform Set Patient Tax Zone through Brightree.

### [Set Patient User Fields](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_set_patient_user_fields.md)

- Handler: `brightree_set_patient_user_fields`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`, `user_fields`, `skip`, `dry_run`
- Outputs: `success`, `message`, `updated_fields`, `verification_details`, `skipped`, `error`

Perform Set Patient User Fields through Brightree.

### [Set Sales Order Workers Comp Fields Batches](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_set_sales_order_workers_comp_fields_batches.md)

- Handler: `brightree_set_sales_order_workers_comp_fields_batches`

- External effect: `write`
- Inputs: `workers_comp_batches`
- Outputs: `success`, `results`, `updated_count`, `failed_count`, `error_message`

Perform Set Sales Order Workers Comp Fields Batches through Brightree.

### [Sync Document Insurance](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_sync_document_insurance_to_patient.md)

- Handler: `brightree_sync_document_insurance_to_patient`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `document_id`, `patient_key`
- Outputs: `success`, `document_id`, `patient_key`, `insurance_id`, `carrier_id`, `policy_key`, `insurer_name`, `start_date`, `synced`, `skipped`, `message`, `error_message`

Perform Sync Document Insurance through Brightree.

### [Sync Document Marketing Rep](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_sync_document_marketing_rep_to_patient.md)

- Handler: `brightree_sync_document_marketing_rep_to_patient`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `document_id`, `patient_key`
- Outputs: `success`, `document_id`, `patient_key`, `marketing_rep_key`, `marketing_rep_name`, `submitted_by_name`, `synced`, `message`, `error_message`

Perform Sync Document Marketing Rep through Brightree.

### [Sync Ordering Doctor](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_sync_document_ordering_doctor_to_patient.md)

- Handler: `brightree_sync_document_ordering_doctor_to_patient`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `document_id`, `patient_key`
- Outputs: `success`, `document_id`, `patient_key`, `provider_id`, `provider_name`, `provider_npi`, `doctor_key`, `doctor_name`, `created_doctor`, `pecos_verified`, `synced`, `message`, `error_message`

Perform Sync Ordering Doctor through Brightree.

### [Update Patient Note](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_update_patient_note.md)

- Handler: `brightree_update_patient_note`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`, `patient_note_key`, `patient_note_type_key`, `description_prepend`, `description_append`, `assigned_to_name`, `date_needed`, `status`, `reason`, `dry_run`

Perform Update Patient Note through Brightree.

### [Update Sales Order Aftercare](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_update_sales_order_aftercare.md)

- Handler: `brightree_update_sales_order_aftercare`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `sales_order_key`, `wip_state`, `assigned_to_key`, `assigned_to_name`, `date_needed`, `expected_current_wip_state`, `expected_current_classification`, `order_note_append`, `dry_run`
- Outputs: `success`, `updated`, `noop`, `dry_run`, `sales_order_key`, `resolved_assigned_to_key`, `resolved_assigned_to_name`, `fields_updated`, `actual`, `mismatches`, `message`, `error`

Perform Update Sales Order Aftercare through Brightree.

### [Validate Patient Billing Address](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_validate_patient_billing_address.md)

- Handler: `brightree_validate_patient_billing_address`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`, `facility_name`, `dry_run`
- Outputs: `success`, `message`, `updated_fields`, `verification_details`, `error`

Perform Validate Patient Billing Address through Brightree.

### [Void Sales Order](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_void_sales_order.md)

- Handler: `brightree_void_sales_order`
- Connection type: `brightree`
- External effect: `irreversible`
- Inputs: `sales_order_key`, `reason_code`, `dry_run`
- Outputs: `success`, `voided`, `dry_run`, `sales_order_key`, `void_key`, `reason_code`, `message`, `error`, `error_message`

Perform Void Sales Order through Brightree.

### [Void Sales Order Batches](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_void_sales_order_batches.md)

- Handler: `brightree_void_sales_order_batches`
- Connection type: `brightree`
- External effect: `irreversible`
- Inputs: `void_requests`, `dry_run`
- Outputs: `success`, `results`, `voided_count`, `failed_count`, `dry_run`, `error_message`

Perform Void Sales Order Batches through Brightree.

### [Write Prepared Patient Updates](https://genhealth.ai/docs/workflows/integrations/brightree/brightree_write_prepared_patient_updates.md)

- Handler: `brightree_write_prepared_patient_updates`
- Connection type: `brightree`
- External effect: `write`
- Inputs: `patient_key`, `patient_updates`
- Outputs: `success`, `patient_key`, `missing_fields`, `has_missing_source_fields`, `updated_fields`, `messages`, `error_message`, `error`

Perform Write Prepared Patient Updates through Brightree.
