Brightree integration

Margin Scorecard (persist + render)

Perform Margin Scorecard (persist + render) through Brightree.

View as Markdown

brightree_margin_scorecard

writebrightree

Inputs

org_label
textrequired
Org Label
Required text value.
period_days
number
Period Days
Optional numeric value.
Default: 0
date_from
date
Date From
Optional date in YYYY-MM-DD format.
date_to
date
Date To
Optional date in YYYY-MM-DD format.
min_claim_age_days
numberrequired
Min Claim Age Days
Required numeric value.
Default: 50
min_group_orders
numberrequired
Min Group Orders
Required numeric value.
Default: 8
top_n
numberrequired
Top N
Required numeric value.
Default: 15
persist_snapshot
booleanrequired
Persist Snapshot
Required true-or-false value.
Default: true

Outputs

successSuccess
period_startPeriod Start
period_endPeriod End
line_countLine Count
paid_line_countPaid Line Count
unpaid_line_countUnpaid Line Count
revenueRevenue
costCost
gp_dollarsGp Dollars
gp_pctGp Pct
has_prior_periodHas Prior Period
prior_gp_pctPrior Gp Pct
gp_pct_changeGp Pct Change
comparable_to_priorComparable To Prior
snapshot_idSnapshot Id
snapshot_persistedSnapshot Persisted
html_bodyHtml Body
subjectSubject
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": [
    "org_label",
    "min_claim_age_days",
    "min_group_orders",
    "top_n",
    "persist_snapshot"
  ],
  "properties": {
    "top_n": {
      "type": "number",
      "default": 15,
      "description": "Required numeric value.",
      "x-workflow-field-type": "number"
    },
    "date_to": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "date_from": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "org_label": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "period_days": {
      "type": "number",
      "default": 0,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "min_group_orders": {
      "type": "number",
      "default": 8,
      "description": "Required numeric value.",
      "x-workflow-field-type": "number"
    },
    "persist_snapshot": {
      "type": "boolean",
      "default": true,
      "description": "Required true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "min_claim_age_days": {
      "type": "number",
      "default": 50,
      "description": "Required numeric value.",
      "x-workflow-field-type": "number"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "cost": {},
    "error": {},
    "gp_pct": {},
    "revenue": {},
    "subject": {},
    "success": {},
    "html_body": {},
    "gp_dollars": {},
    "line_count": {},
    "period_end": {},
    "snapshot_id": {},
    "period_start": {},
    "prior_gp_pct": {},
    "gp_pct_change": {},
    "paid_line_count": {},
    "has_prior_period": {},
    "unpaid_line_count": {},
    "snapshot_persisted": {},
    "comparable_to_prior": {}
  },
  "additionalProperties": true
}

View all Brightree actions