Brightree integration

Apply Invoice Payment

Perform Apply Invoice Payment through Brightree.

View as Markdown

brightree_apply_invoice_payment

irreversiblebrightree

Inputs

deposit_key
expression
Deposit Key
Optional literal value or workflow expression.
receipt_key
expression
Receipt Key
Optional literal value or workflow expression.
invoice_key
expression
Invoice Key
Optional literal value or workflow expression.
amount
expression
Amount
Optional literal value or workflow expression.
proc_line_index
expression
Proc Line Index
Optional literal value or workflow expression.
Default: "0"
payment_type
text
Payment Type
Optional text value.
Default: "7"
reason
text
Reason
Optional text value.
Default: "0"
note
expression
Note
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
invoice_keyInvoice Key
invoice_numberInvoice Number
payments_appliedPayments Applied
observed_balanceObserved Balance
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.

Input schema

{
  "type": "object",
  "properties": {
    "note": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "amount": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "reason": {
      "type": "string",
      "default": "0",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "dry_run": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "deposit_key": {
      "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"
    },
    "receipt_key": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "payment_type": {
      "type": "string",
      "default": "7",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "proc_line_index": {
      "default": "0",
      "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"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "dry_run": {},
    "message": {},
    "success": {},
    "gate_passed": {},
    "invoice_key": {},
    "invoice_number": {},
    "observed_balance": {},
    "payments_applied": {}
  },
  "additionalProperties": true
}

View all Brightree actions