Upload Document to Sales Order
Perform Upload Document to Sales Order through Brightree.
brightree_upload_document_to_sales_orderUse 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"
}Inputs
- Sales Order Key
sales_order_keyexpressionrequiredRequired literal value or workflow expression.
- Patient Key
patient_keyexpressionrequiredRequired literal value or workflow expression.
- Branch Key
branch_keyexpressionOptional literal value or workflow expression.
- Document Id
document_idexpressionrequiredRequired literal value or workflow expression.
- Document Type
document_typetextrequiredRequired text value.
- Batch Name
batch_nametextOptional text value.
- Batch Id
batch_idtextOptional text value.
- File Name
file_nameexpressionOptional literal value or workflow expression.
- Notes
notestextareaOptional text value.
- Dry Run
dry_runbooleanOptional true-or-false value.
Default:
false
Outputs
successSuccessdry_runDry Runsales_order_keySales Order Keypatient_keyPatient Keybranch_keyBranch Keybranch_key_sourceBranch Key Sourceuploaded_filenameUploaded FilenamemessageMessageerrorError
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
}