Skip to documentation
Brightree integration

Upload Document to Sales Order

Perform Upload Document to Sales Order through Brightree.

View as Markdown
brightree_upload_document_to_sales_order
writebrightree

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": false
  },
  "handler": "brightree_upload_document_to_sales_order"
}

Action contracts and connections · Run recovery

Inputs

  • sales_order_key
    expressionrequired
    Sales Order Key

    Required literal value or workflow expression.

  • patient_key
    expressionrequired
    Patient Key

    Required literal value or workflow expression.

  • branch_key
    expression
    Branch Key

    Optional literal value or workflow expression.

  • document_id
    expressionrequired
    Document Id

    Required literal value or workflow expression.

  • document_type
    textrequired
    Document Type

    Required text value.

  • batch_name
    text
    Batch Name

    Optional text value.

  • batch_id
    text
    Batch Id

    Optional text value.

  • file_name
    expression
    File Name

    Optional literal value or workflow expression.

  • notes
    textarea
    Notes

    Optional text value.

  • dry_run
    boolean
    Dry Run

    Optional true-or-false value.

    Default: false

Outputs

  • successSuccess
  • dry_runDry Run
  • sales_order_keySales Order Key
  • patient_keyPatient Key
  • branch_keyBranch Key
  • branch_key_sourceBranch Key Source
  • uploaded_filenameUploaded Filename
  • messageMessage
  • 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": [
    "sales_order_key",
    "patient_key",
    "document_id",
    "document_type"
  ],
  "properties": {
    "notes": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "textarea"
    },
    "dry_run": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "batch_id": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "file_name": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "batch_name": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "branch_key": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "document_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "patient_key": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "document_type": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "sales_order_key": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "dry_run": {},
    "message": {},
    "success": {},
    "branch_key": {},
    "patient_key": {},
    "sales_order_key": {},
    "branch_key_source": {},
    "uploaded_filename": {}
  },
  "additionalProperties": true
}
View all Brightree actions