Projects
A project object allows you to create default options for a group of work orders. Projects can be associated with a client or a work order template. You can also specify a selection rule and set up automated notifications.
Project Object
| Parameter | Type | Example | Mapping/Notes |
|---|---|---|---|
| id | integer | "id": 238 | Project ID. |
| company_id | string | "company_id": "183" | Company ID. |
| name | string | "name": "Alarm System Upgrade" | Project title. |
| status | string | "status": "active" | Project Status. |
| client | object | "client": { "id": 187, "name": "Tech Corp" } |
Client. Optional. |
| manager | object | "manager": { } | Project manager. Optional. |
| finance | object | "finance": { "id": 0, "description": "Pre-fund", "balance": 10000 } |
Finance Account. |
| cancellation_fee | decimal | "cancellation_fee": 30 | Cancellation fee paid to providers. Must be at least $30. |
| selection_rule | object | "selection_rule": { "id": 254, "name": "Sample Rule" } |
Default selection rule. Optional. |
| auto_dispatch | object | "auto_dispatch": { } | Use auto-dispatch for work orders in this group. Optional. |
| late_notification | boolean | "late_notification": false | Enable late notification. |
| notifications | object | "notifications": { } | Advanced: Custom Notifications and Messaging. |
| email_subject | object | "email_subject": { "manager": "New Work Order", "provider": "New Work Order" } |
Email subject line for: Work Order manager and Providers. |
| email_body | object | "email_body": { "manager": "", "provider": "" } |
Email content line for: Work order managers and Providers. |
| digest_email | object | "digest_email": { "manager": "", "provider": "" } |
Digest email content line for: Work order managers and Providers. |
| sms | object | "sms": { "manager": "", "provider": "" } |
Text messaging content line for: Work order managers and Providers. |
| notification | object | "notification": { "manager": "", "provider": "" } |
Site notification content line for: Work order managers and Providers. |
| templates | object | "results": [] | Returns a list of work order templates associated with this project. |
Examples
Work Order Project Response
You can locate project information in the work order > project object.
"project": { }