Skip to documentation
Brightree integration

Set Patient Tax Zone

Perform Set Patient Tax Zone through Brightree.

View as Markdown
brightree_set_patient_tax_zone
writebrightree

Inputs

  • patient_key
    expressionrequired
    Patient Key

    Required literal value or workflow expression.

  • tax_zone_text
    expressionrequired
    Tax Zone Text

    Required literal value or workflow expression.

  • tax_zone_value
    expression
    Tax Zone Value

    Optional literal value or workflow expression.

  • skip_if_missing
    boolean
    Skip If Missing

    Optional true-or-false value.

    Default: false

  • dry_run
    boolean
    Dry Run

    Optional true-or-false value.

    Default: false

Outputs

  • successSuccess
  • messageMessage
  • updated_fieldsUpdated Fields
  • tax_zone_textTax Zone Text
  • tax_zone_valueTax Zone Value
  • expected_tax_zoneExpected Tax Zone
  • verification_detailsVerification Details
  • skippedSkipped
  • errorError

Output schema completeness: best_effort_declared

Safety

External effect
write
Confirmation recommended
No
Retry safe
No
Dry run supported
Yes

Schemas

These schemas are first-pass authoring guidance. Runtime validation remains authoritative.

Input schema
{
  "type": "object",
  "required": [
    "patient_key",
    "tax_zone_text"
  ],
  "properties": {
    "dry_run": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "patient_key": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "tax_zone_text": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "tax_zone_value": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "skip_if_missing": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "message": {},
    "skipped": {},
    "success": {},
    "tax_zone_text": {},
    "tax_zone_value": {},
    "updated_fields": {},
    "expected_tax_zone": {},
    "verification_details": {}
  },
  "additionalProperties": true
}
View all Brightree actions