Apply Unapplied Payment

Use in a workflow

Copy the discovered node config and fill its params from the input contract. Validate the complete graph before publishing. Integration results use {{node_id.default.field}}. Check business success before dependent writes; completion alone does not prove success.

{
  "_group": "Brightree",
  "params": {
    "dry_run": true
  },
  "handler": "brightree_apply_unapplied_payment"
}

Action contracts and connections · Run recovery

Inputs

• invoice_key

  expression
  Invoice Key

  Optional literal value or workflow expression.

• unapplied_payment_key

  expression
  Unapplied Payment Key

  Optional literal value or workflow expression.

• invoice_detail_key

  expression
  Invoice Detail Key

  Optional literal value or workflow expression.

• amount

  expression
  Amount

  Optional literal value or workflow expression.

• pay_date

  expression
  Pay Date

  Optional literal value or workflow expression.

• expected_balance

  expression
  Expected Balance

  Optional literal value or workflow expression.

• dry_run

  boolean
  Dry Run

  Optional true-or-false value.

  Default: true

Outputs

• successSuccess
• dry_runDry Run
• appliedApplied
• verifiedVerified
• invoice_keyInvoice Key
• unapplied_payment_keyUnapplied Payment Key
• invoice_detail_keyInvoice Detail Key
• amount_appliedAmount Applied
• unapplied_balanceUnapplied Balance
• remaining_unappliedRemaining Unapplied
• line_balanceLine Balance
• observed_balanceObserved Balance
• balance_afterBalance After
• gate_passedGate Passed
• messageMessage
• errorError

Output schema completeness: best_effort_declared

Safety

External effect

irreversible

Confirmation recommended

Yes

Retry safe

No

Dry run supported

Yes

Schemas

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

{
  "type": "object",
  "properties": {
    "amount": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "dry_run": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "pay_date": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "invoice_key": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "expected_balance": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "invoice_detail_key": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "unapplied_payment_key": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "error": {},
    "applied": {},
    "dry_run": {},
    "message": {},
    "success": {},
    "verified": {},
    "gate_passed": {},
    "invoice_key": {},
    "line_balance": {},
    "balance_after": {},
    "amount_applied": {},
    "observed_balance": {},
    "unapplied_balance": {},
    "invoice_detail_key": {},
    "remaining_unapplied": {},
    "unapplied_payment_key": {}
  },
  "additionalProperties": true
}