Brightree integration

Finalize Template Schedule Audit Cycle

Perform Finalize Template Schedule Audit Cycle through Brightree.

View as Markdown

brightree_finalize_template_schedule_audit_cycle

writebrightree

Inputs

account_key
text
Account Key
Optional text value.
cycle_id
expression
Cycle Id
Optional literal value or workflow expression.
max_candidates
numberrequired
Max Candidates
Required numeric value.
Default: 5000

Outputs

successSuccess
cycle_idCycle Id
completedCompleted
should_send_summaryShould Send Summary
cycle_statusCycle Status
total_item_countTotal Item Count
correct_countCorrect Count
corrected_countCorrected Count
deferred_countDeferred Count
manual_review_countManual Review Count
failed_countFailed Count
messageMessage
errorError

Output schema completeness: best_effort_declared

Safety

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

Schemas

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

Input schema

{
  "type": "object",
  "required": [
    "max_candidates"
  ],
  "properties": {
    "cycle_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "account_key": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "max_candidates": {
      "type": "number",
      "default": 5000,
      "description": "Required numeric value.",
      "x-workflow-field-type": "number"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "message": {},
    "success": {},
    "cycle_id": {},
    "completed": {},
    "cycle_status": {},
    "failed_count": {},
    "correct_count": {},
    "deferred_count": {},
    "corrected_count": {},
    "total_item_count": {},
    "manual_review_count": {},
    "should_send_summary": {}
  },
  "additionalProperties": true
}

View all Brightree actions