Requirements
Connecting Simpro takes an active account plus an API access token from your account settings — no other setup is required.[3]
Get your Simpro credentials
- SubdomaintextRequired
For example, https://
[1]mycompany.simprosuite.com. You should passmycompanyvalue only. - API Key (Secret Key)textRequired
API Key can be obtained at
[1]Account -> Settings -> API. Please, go toSystem Setup->API->Application->Create API Application. Then copy and paste aTokenvalue here.
Connect Simpro in WEXTL
- Log in to your WEXTL account, add the Simpro node module to your workflow, and click Create new credential.Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Simpro account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Notes
Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →
Simpro node modules
The list below is a reference of every Simpro node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Expand any Simpro node module below to see exactly what it takes in, what it returns, and what connection it needs.
Watch EventsTrigger
| Field | Type |
|---|---|
| ID | text |
| Build | text |
| Description | text |
| Name | text |
| Action | text |
| Reference | object |
| any | text |
| Date Triggered | text |
Get a Company CustomerAction
| Field | Type |
|---|---|
Company IDRequired | choice |
| Field | Type |
|---|---|
| ID | number |
| Company name | text |
| Preferred techs | array |
| Phone | text |
| Do not call | boolean |
| Alt phone | text |
| Address | object |
| Address | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Billing address | object |
| Address | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Customer type | text |
| Tags | array |
| Amount owing | number |
| Rates | object |
| Part tax code | object |
| Labour tax code | object |
| Discount fee | text |
| Always deduct cis | boolean |
| Service fee | object |
| Material | object |
Get a ContactAction
Get a ContractorAction
| Field | Type |
|---|---|
Company IDRequired | choice |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| Position | text |
| Availability | array |
| Address | object |
| Address | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Date of hire | text |
| Date of birth | text |
| Primary contact | object |
| Secondary email | text |
| Work phone | text |
| Extension | text |
| Cell phone | text |
| Fax | text |
| Preferred notification method | text |
| Emergency contact | object |
| Name | text |
| Relationship | text |
| Work phone | text |
| Cell phone | text |
| Alt phone | text |
| Address | text |
| Account setup | object |
| Username | text |
| Is mobility | boolean |
| Security group | object |
| Mobile security group | object |
| User profile | object |
| Is salesperson | boolean |
| Is project manager | boolean |
| Storage device | object |
| Preferred language | text |
| Date created | date |
Get a Contractor AttachmentAction
Get a Contractor Custom Field ValueAction
Get a CustomerAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Customer IDRequired | number |
| Columns | choice |
| Field | Type |
|---|---|
| ID | number |
| Title | text |
| Given Name | text |
| Family Name | text |
| Preferred Techs | array |
| Phone | text |
| Do Not Call | boolean |
| Alt Phone | text |
| Address | object |
| Address | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Billing Address | object |
| Address | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Customer Type | text |
| Tags | array |
Get a Customer AttachmentAction
Get a Customer Custom Field ValueAction
Get a Customer NoteAction
Get a JobAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Job IDRequired | number |
| Columns | choice |
| Field | Type |
|---|---|
| ID | number |
| Type | text |
| Customer | object |
| ID | number |
| Company Name | text |
| Given Name | text |
| Family Name | text |
| Customer Contract | object |
| ID | number |
| Name | text |
| Start Date | text |
| End Date | text |
| Contract no | text |
| Customer Contact | object |
| ID | number |
| Given Name | text |
| Family Name | text |
| Additional Contacts | array |
| Site | object |
| ID | number |
| Name | text |
| Site Contact | object |
| ID | number |
| Given Name | text |
| Family Name | text |
| Order No | text |
| Request No | text |
| Name | text |
| Description | text |
Get a LeadAction
| Field | Type |
|---|---|
Company IDRequired | choice |
| Columns | choice |
| Field | Type |
|---|---|
| ID | number |
| Lead Name | text |
| Customer | object |
| ID | number |
| Company Name | text |
| Given Name | text |
| Family Name | text |
| Additional Customers | array |
| Customer Contact | object |
| ID | number |
| Given Name | text |
| Family Name | text |
| Additional Contacts | array |
| Site | object |
| ID | number |
| Name | text |
| Site Contact | object |
| ID | number |
| Given Name | text |
| Family Name | text |
| Stage | text |
| Follow Up Date | text |
| Date Created | text |
| Description | text |
Get a Lead AttachmentAction
Get a Lead Custom Field ValueAction
Get a Quote AttachmentAction
Get a ScheduleAction
Get a SiteAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Site IDRequired | number |
| Columns | choice |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| Address | object |
| Address | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Billing Address | object |
| Address | text |
| City | text |
| State | text |
| Postal Code | text |
| Billing Contact | text |
| Primary Contact | object |
| Contact | object |
| Title | text |
| Given Name | text |
| Family Name | text |
| text | |
| Work Phone | text |
| Cell Phone | text |
| Fax | text |
| Position | text |
| Preferred Notification Method | text |
| Public Notes | text |
| Private Notes | text |
| Zone | object |
| ID | number |
| Name | text |
| Preferred Techs | array |
| Preferred Technicians | array |
| Date Modified | text |
Get a Site AttachmentAction
Get a Site Custom Field ValueAction
Get a TaskAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Task IDRequired | number |
| Columns | choice |
| Field | Type |
|---|---|
| ID | number |
| Subject | text |
| Created By | object |
| ID | number |
| Name | text |
| Type | text |
| Type ID | number |
| Assigned To | object |
| ID | number |
| Name | text |
| Type | text |
| Type ID | number |
| Assignees | array |
| Assigned To Customer | boolean |
| Completed By | object |
| ID | number |
| Name | text |
| Type | text |
| Type ID | number |
| Associated | object |
| Job | object |
| Quote | object |
| Customer | object |
| Contact | object |
| Site | object |
| Is Billable | boolean |
| Show On Work Order | boolean |
| Email Notifications | boolean |
| Description | text |
Get an EmployeeAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Employee IDRequired | number |
| Columns | choice |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| Position | text |
| Availability | array |
| Address | object |
| Address | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Date Of Hire | text |
| Date Of Birth | text |
| Primary Contact | object |
| text | |
| Secondary Email | text |
| Work Phone | text |
| Extension | text |
| Cell Phone | text |
| Fax | text |
| Preferred Notification Method | text |
| Emergency Contact | object |
| Name | text |
| Relationship | text |
| Work Phone | text |
| Cell Phone | text |
| Alt Phone | text |
| Address | text |
| Account Setup | object |
| Username | text |
| Is Mobility | boolean |
| Security Group | object |
| User Profile | object |
| Is Salesperson | boolean |
| Is Project Manager | boolean |
| Storage Device | object |
| Preferred Language | text |
| Date Created | text |
Get an Individual CustomerAction
| Field | Type |
|---|---|
Company IDRequired | choice |
| Field | Type |
|---|---|
| ID | number |
| Title | text |
| Given name | text |
| Family name | text |
| Preferred techs | array |
| Phone | text |
| Do not call | boolean |
| Alt phone | text |
| Address | object |
| Address | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Billing address | object |
| Address | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Customer type | text |
| Tags | array |
Get an InvoiceAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Invoice IDRequired | number |
| Columns | choice |
| Field | Type |
|---|---|
| ID | number |
| Internal ID | number |
| Type | text |
| Customer | object |
| ID | number |
| Company Name | text |
| Given Name | text |
| Family Name | text |
| Jobs | array |
| Recurring Invoice | object |
| ID | number |
| Description | text |
| Total | object |
| Date Issued | text |
| Period | object |
| Start Date | text |
| End Date | text |
| Payment Term ID | number |
| Payment Terms | object |
| Days | number |
| Type | text |
| Due Date | text |
| Progress Claim Number | number |
| Is Final Claim | boolean |
List Contractor AttachmentsSearch
List Contractor Custom FieldsSearch
List Custom FieldsSearch
List Customer AttachmentsSearch
List Customer Custom FieldsSearch
List Customer NotesSearch
List Job Cost CentersSearch
| Field | Type |
|---|---|
Company IDRequired | choice |
| Search Query | text |
| Search | choice |
| Select Order Field | choice |
| Limit | number |
| Columns | choice |
| Field | Type |
|---|---|
| ID | number |
| Cost center | object |
| ID | number |
| Name | text |
| Job ID | number |
| Name | text |
| Display order | number |
| Total | object |
| Ex tax | number |
| Tax | number |
| Inc tax | number |
| Tax code | object |
| Claimed | object |
| To date | object |
| Remaining | object |
| Percent complete | number |
List Lead AttachmentsSearch
List Lead Custom FieldsSearch
List Quote AttachmentsSearch
Search Company CustomersSearch
Search ContactsSearch
Search ContractorsSearch
Search CustomersSearch
Search Individual CustomersSearch
Search InvoicesSearch
| Field | Type |
|---|---|
Company IDRequired | choice |
| Search Conditions | array |
Field NameRequired | text |
| Search Value | text |
| Search | choice |
| Columns | choice |
| Select Order Field | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | number |
| Type | text |
| Customer | object |
| ID | number |
| Company Name | text |
| Given Name | text |
| Family Name | text |
| Jobs | array |
| Recurring Invoice | object |
| ID | number |
| Description | text |
| Total | object |
| Total | object |
| Ex Tax | number |
| Inc Tax | number |
| Tax | number |
| Reverse Charge Tax | number |
| Amount Applied | number |
| Balance Due | number |
| Is Paid | boolean |
Search JobsSearch
Search LeadsSearch
| Field | Type |
|---|---|
Company IDRequired | choice |
| Search Conditions | array |
Field NameRequired | text |
| Search Value | text |
| Search | choice |
| Columns | choice |
| Select Order Field | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | number |
| Lead Name | text |
| Customer | object |
| ID | number |
| Company Name | text |
| Given Name | text |
| Family Name | text |
| Additional Customers | array |
| Customer Contact | object |
| ID | number |
| Given Name | text |
| Family Name | text |
| Additional Contacts | array |
| Site | object |
| ID | number |
| Name | text |
| Site Contact | object |
| ID | number |
| Given Name | text |
| Family Name | text |
| Stage | text |
| Follow Up Date | text |
| Date Created | text |
| Description | text |
Search SchedulesSearch
| Field | Type |
|---|---|
Company IDRequired | choice |
| Search Conditions | array |
Field NameRequired | text |
| Search Value | text |
| Search | choice |
| Columns | choice |
| Limit | number |
| Select Order Field | choice |
| Field | Type |
|---|---|
| ID | number |
| Type | text |
| Reference | text |
| Total Hours | number |
| Staff | object |
| ID | number |
| Name | text |
| Type | text |
| Type ID | number |
| Date | text |
| Blocks | array |
Search SitesSearch
Search TasksSearch
| Field | Type |
|---|---|
Company IDRequired | choice |
| Search Conditions | array |
Field NameRequired | text |
| Search Value | text |
| Search | choice |
| Columns | choice |
| Select Order Field | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | number |
| Subject | text |
| Assigned To | object |
| ID | number |
| Name | text |
| Type | text |
| Type ID | number |
| Assignees | array |
| Completed by | object |
| ID | number |
| Name | text |
| Type | text |
| Type ID | number |
| Due Date | text |
| Percent Complete | number |
Search Work OrdersSearch
Add Job AttachmentAction
Create a Company CustomerAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Company NameRequired | text |
| Create Site | boolean |
| Preferred Techs | array |
| Technician ID | number |
| Phone | text |
| Do Not Call | boolean |
| Alternative Phone | text |
| Address | object |
| Address | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Billing Address | object |
| Address | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Customer Type | choice |
| Archived | boolean |
| Field | Type |
|---|---|
| ID | number |
| Company name | text |
| Preferred techs | array |
| Phone | text |
| Do not call | boolean |
| Alt phone | text |
| Address | object |
| Address | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Billing address | object |
| Address | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Customer type | text |
| Tags | array |
| Amount owing | number |
| Rates | object |
| Part tax code | object |
| Labour tax code | object |
| Discount fee | text |
| Always deduct cis | boolean |
| Service fee | object |
| Material | object |
Create a ContactAction
| Field | Type |
|---|---|
Company IDRequired | choice |
| Title | text |
Given NameRequired | text |
| Family Name | text |
| text | |
| Work Phone | text |
| Fax | text |
| Cell Phone | text |
| Alternate Phone | text |
| Department | text |
| Position | text |
| Notes | text |
| Field | Type |
|---|---|
| ID | number |
| Title | text |
| Given Name | text |
| Family Name | text |
| text | |
| Work Phone | text |
| Fax | text |
| Cell Phone | text |
| Alt Phone | text |
| Department | text |
| Position | text |
| Notes | text |
Create a ContractorAction
| Field | Type |
|---|---|
Company IDRequired | choice |
NameRequired | text |
Contact NameRequired | text |
| Position | text |
| Address | object |
| Address | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Date Of Hire | date |
| Date Of Birth | date |
| Primary Contact | object |
| Secondary Email | |
| Work Phone | text |
| Extension | text |
| Cell Phone | text |
| Fax | text |
| Preferred Notification Method | choice |
| Emergency Contact | object |
| Name | text |
| Relationship | text |
| Work Phone | text |
| Cell Phone | text |
| Alt Phone | text |
| Address | text |
| Account Setup | object |
| Username | text |
| Password | text |
| Is Mobility | boolean |
| Security Group | number |
| Mobile Security Group | number |
| Zones | array |
| Zone ID | number |
| Default Zone | number |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| Position | text |
| Availability | array |
| Address | object |
| Address | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Date of hire | text |
| Date of birth | text |
| Primary contact | object |
| Secondary email | text |
| Work phone | text |
| Extension | text |
| Cell phone | text |
| Fax | text |
| Preferred notification method | text |
| Emergency contact | object |
| Name | text |
| Relationship | text |
| Work phone | text |
| Cell phone | text |
| Alt phone | text |
| Address | text |
| Account setup | object |
| Username | text |
| Is mobility | boolean |
| Security group | object |
| Mobile security group | object |
| User profile | object |
| Is salesperson | boolean |
| Is project manager | boolean |
| Storage device | object |
| Preferred language | text |
| Date created | date |
Create a Contractor AttachmentAction
Create a Contractor Attachment FolderAction
Create a Customer AttachmentAction
Create a Customer Attachment FolderAction
Create a Customer NoteAction
| Field | Type |
|---|---|
Company IDRequired | choice |
SubjectRequired | text |
| Note | text |
| Date Created | date |
| Follow Up Date | date |
| Attachments | array |
| Assign To | choice |
| Submitted By | choice |
| Reference | object |
| Reference Type | choice |
| Reference Number | number |
| Reference Text | text |
| Field | Type |
|---|---|
| ID | number |
| Subject | text |
| Note | text |
| Date created | date |
| Follow up date | text |
| Attachments | array |
| Assign to | object |
| ID | number |
| Name | text |
| Type | text |
| Type ID | number |
| Submitted by | object |
| ID | number |
| Name | text |
| Type | text |
| Type ID | number |
| Reference | object |
| Type | text |
| Number | text |
| Text | text |
Create a JobAction
| Field | Type |
|---|---|
Company IDRequired | choice |
TypeRequired | choice |
CustomerRequired | number |
| Customer Contract | number |
| Customer Contact | number |
| Additional Contacts | array |
| Contact | number |
SiteRequired | number |
| Site Contact | number |
| Order No | text |
| Name | text |
| Description | text |
| Notes | text |
| Field | Type |
|---|---|
| ID | number |
| Type | text |
| Customer | object |
| ID | number |
| Company Name | text |
| Given Name | text |
| Family Name | text |
| Customer Contract | object |
| ID | number |
| Name | text |
| Start Date | text |
| End Date | text |
| Contract no | text |
| Customer Contact | object |
| ID | number |
| Given Name | text |
| Family Name | text |
| Additional Contacts | array |
| Site | object |
| ID | number |
| Name | text |
| Site Contact | object |
| ID | number |
| Given Name | text |
| Family Name | text |
| Order No | text |
| Request No | text |
| Name | text |
| Description | text |
Create a Job Attachment FolderAction
Create a Job Cost CentreAction
| Field | Type |
|---|---|
Company IDRequired | choice |
| Name | text |
| Stage | choice |
| Description | text |
| Notes | text |
| Order No | text |
| Start Date | date |
| End Date | date |
| Auto Adjust Dates | boolean |
| Display Order | number |
| Variation Approval Date | date |
| Items Locked | boolean |
| Field | Type |
|---|---|
| Cost center | number |
| Name | text |
| Stage | text |
| Description | text |
| Notes | text |
| Order no | text |
| Start date | text |
| End date | text |
| Auto adjust dates | boolean |
| Display order | number |
| Variation approval date | text |
| Items locked | boolean |
Create a LeadAction
| Field | Type |
|---|---|
Company IDRequired | choice |
| Lead Name | text |
| Customer | number |
| Customer Contact | number |
| Additional Contacts | array |
| Contact ID | number |
| Site Contact | number |
| Stage | choice |
| Follow-Up Date | date |
| Description | text |
| Notes | text |
| Cost Center | number |
| Salesperson | number |
| Field | Type |
|---|---|
| ID | number |
| Lead Name | text |
| Customer | object |
| ID | number |
| Company Name | text |
| Given Name | text |
| Family Name | text |
| Additional Customers | array |
| Customer Contact | object |
| ID | number |
| Given Name | text |
| Family Name | text |
| Additional Contacts | array |
| Site | object |
| ID | number |
| Name | text |
| Site Contact | object |
| ID | number |
| Given Name | text |
| Family Name | text |
| Stage | text |
| Follow Up Date | text |
| Date Created | text |
| Description | text |
Create a Lead AttachmentAction
Create a Lead Attachment FolderAction
Create a Quote AttachmentAction
Create a Quote Attachment FolderAction
Create a SiteAction
| Field | Type |
|---|---|
Company IDRequired | choice |
| Date Of Hire | date |
| Date Of Birth | date |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| Address | object |
| Address | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Billing address | object |
| Address | text |
| City | text |
| State | text |
| Postal code | text |
| Billing contact | text |
| Primary contact | object |
| Contact | object |
| Title | text |
| Given name | text |
| Family name | text |
| text | |
| Work phone | text |
| Cell phone | text |
| Fax | text |
| Position | text |
| Preferred notification method | text |
| Public notes | text |
| Private notes | text |
| Zone | object |
| ID | number |
| Name | text |
| Preferred techs | array |
| Preferred technicians | array |
| Date modified | text |
Create a Site AttachmentAction
Create a Site Attachment FolderAction
Create an Individual CustomerAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Given NameRequired | text |
Family NameRequired | text |
| Title | choice |
| Preferred Technicians | array |
| Technician ID | text |
| Phone | text |
| Do Not Call | boolean |
| Alternative Phone | text |
| Address | object |
| Address | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Billing Address | object |
| Address | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Customer Type | choice |
| Field | Type |
|---|---|
| ID | number |
| Title | text |
| Given name | text |
| Family name | text |
| Preferred techs | array |
| Phone | text |
| Do not call | boolean |
| Alt phone | text |
| Address | object |
| Address | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Billing address | object |
| Address | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Customer type | text |
| Tags | array |
Create an InvoiceAction
| Field | Type |
|---|---|
Company IDRequired | choice |
| Type | choice |
| Jobs | array |
| Date Issued | date |
| Payment Term ID | text |
| Payment Terms | object |
| Days | number |
| Type | choice |
| Due Date | date |
| Progress Claim Number | text |
| Stage | choice |
| Per Item | text |
| Order No | text |
| Late Payment Fee | text |
| CIS Deduction Rate | text |
| Field | Type |
|---|---|
| ID | number |
| Title | text |
| Given Name | text |
| Family Name | text |
| text | |
| Work Phone | text |
| Fax | text |
| Cell Phone | text |
| Alt Phone | text |
| Department | text |
| Position | text |
| Notes | text |
Delete a ContactAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Contact IDRequired | number |
| Columns | choice |
Delete a ContractorAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Delete a Contractor AttachmentAction
Delete a CustomerAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Delete a CustomerAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Delete a Customer AttachmentAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Delete a Customer NoteAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Delete a JobAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Job IDRequired | number |
| Columns | choice |
Delete a Job AttachmentAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Job IDRequired | number |
Job IDRequired | number |
Delete a Job Cost CentreAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Delete a LeadAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Lead IDRequired | number |
| Columns | choice |
Delete a Lead AttachmentAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Delete a Quote AttachmentAction
Delete a SiteAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Site IDRequired | number |
| Columns | choice |
Delete a Site AttachmentAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Delete a TaskAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Task IDRequired | number |
| Columns | choice |
Delete an InvoiceAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Invoice IDRequired | number |
| Columns | choice |
Delete Contact or JobAction
| Field | Type |
|---|---|
Company IDRequired | choice |
TypeRequired | choice |
Contact Or Job IDRequired | number |
Make an API Calluniversal
Update a Company CustomerAction
| Field | Type |
|---|---|
Company IDRequired | choice |
| Company Name | text |
| Create Site | boolean |
| Preferred Techs | array |
| Technician ID | number |
| Phone | text |
| Do Not Call | boolean |
| Alternative Phone | text |
| Address | object |
| Address | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Billing Address | object |
| Address | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Customer Type | choice |
| Archived | boolean |
| Field | Type |
|---|---|
| ID | number |
| Company name | text |
| Preferred techs | array |
| Phone | text |
| Do not call | boolean |
| Alt phone | text |
| Address | object |
| Address | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Billing address | object |
| Address | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Customer type | text |
| Tags | array |
| Amount owing | number |
| Rates | object |
| Part tax code | object |
| Labour tax code | object |
| Discount fee | text |
| Always deduct cis | boolean |
| Service fee | object |
| Material | object |
Update a ContactAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Contact IDRequired | number |
| Title | text |
| Given Name | text |
| Family Name | text |
| text | |
| Work Phone | text |
| Fax | text |
| Cell Phone | text |
| Alt Phone | text |
| Department | text |
| Position | text |
| Field | Type |
|---|---|
| ID | number |
| Title | text |
| Given Name | text |
| Family Name | text |
| text | |
| Work Phone | text |
| Fax | text |
| Cell Phone | text |
| Alt Phone | text |
| Department | text |
| Position | text |
| Notes | text |
Update a Contact Custom FieldAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Contact IDRequired | number |
Custom Field IDRequired | number |
ValueRequired | text |
| Field | Type |
|---|---|
| ID | number |
| Title | text |
| Given Name | text |
| Family Name | text |
| text | |
| Work Phone | text |
| Fax | text |
| Cell Phone | text |
| Alt Phone | text |
| Department | text |
| Position | text |
| Notes | text |
Update a ContractorAction
| Field | Type |
|---|---|
Company IDRequired | choice |
| Name | text |
| Contact Name | text |
| Position | text |
| Address | object |
| Address | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Date Of Hire | date |
| Date Of Birth | date |
| Primary Contact | object |
| Secondary Email | |
| Work Phone | text |
| Extension | text |
| Cell Phone | text |
| Fax | text |
| Preferred Notification Method | choice |
| Emergency Contact | object |
| Name | text |
| Relationship | text |
| Work Phone | text |
| Cell Phone | text |
| Alt Phone | text |
| Address | text |
| Account Setup | object |
| Username | text |
| Password | text |
| Is Mobility | boolean |
| Security Group | number |
| Mobile Security Group | number |
| Zones | array |
| Zone ID | number |
| Default Zone | number |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| Position | text |
| Availability | array |
| Address | object |
| Address | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Date of hire | text |
| Date of birth | text |
| Primary contact | object |
| Secondary email | text |
| Work phone | text |
| Extension | text |
| Cell phone | text |
| Fax | text |
| Preferred notification method | text |
| Emergency contact | object |
| Name | text |
| Relationship | text |
| Work phone | text |
| Cell phone | text |
| Alt phone | text |
| Address | text |
| Account setup | object |
| Username | text |
| Is mobility | boolean |
| Security group | object |
| Mobile security group | object |
| User profile | object |
| Is salesperson | boolean |
| Is project manager | boolean |
| Storage device | object |
| Preferred language | text |
| Date created | date |
Update a Contractor Custom FieldAction
| Field | Type |
|---|---|
Company IDRequired | choice |
| Value | text |
Update a Customer Custom FieldAction
| Field | Type |
|---|---|
Company IDRequired | choice |
| Value | text |
Update a Customer NoteAction
| Field | Type |
|---|---|
Company IDRequired | choice |
| Subject | text |
| Note | text |
| Follow Up Date | date |
| Assign To | choice |
| Reference | object |
| Reference Type | choice |
| Reference Number | number |
| Reference Text | text |
| Field | Type |
|---|---|
| ID | number |
| Subject | text |
| Note | text |
| Date created | date |
| Follow up date | text |
| Attachments | array |
| Assign to | object |
| ID | number |
| Name | text |
| Type | text |
| Type ID | number |
| Submitted by | object |
| ID | number |
| Name | text |
| Type | text |
| Type ID | number |
| Reference | object |
| Type | text |
| Number | text |
| Text | text |
Update a JobAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Job IDRequired | number |
| Customer | number |
| Customer Contract | number |
| Customer Contact | number |
| Additional Contacts | array |
| Site | number |
| Site Contact | number |
| Order No | text |
| Name | text |
| Description | text |
| Notes | text |
| Field | Type |
|---|---|
| ID | number |
| Title | text |
| Given Name | text |
| Family Name | text |
| text | |
| Work Phone | text |
| Fax | text |
| Cell Phone | text |
| Alt Phone | text |
| Department | text |
| Position | text |
| Notes | text |
Update a Job Cost CenterAction
| Field | Type |
|---|---|
Company IDRequired | choice |
| Name | text |
| Stage | choice |
| Description | text |
| Notes | text |
| Order No | text |
| Start Date | date |
| End Date | date |
| Auto Adjust Dates | boolean |
| Display Order | number |
| Variation Approval Date | date |
| Items Locked | boolean |
| Field | Type |
|---|---|
| Cost center | number |
| Name | text |
| Stage | text |
| Description | text |
| Notes | text |
| Order no | text |
| Start date | text |
| End date | text |
| Auto adjust dates | boolean |
| Display order | number |
| Variation approval date | text |
| Items locked | boolean |
Update a LeadAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Lead IDRequired | number |
| Lead Name | text |
| Customer | number |
| Customer Contact | number |
| Additional Contacts | array |
| Site | number |
| Site Contact | number |
| Stage | choice |
| Follow-Up Date | date |
| Description | text |
| Notes | text |
| Field | Type |
|---|---|
| ID | number |
| Lead Name | text |
| Customer | object |
| ID | number |
| Company Name | text |
| Given Name | text |
| Family Name | text |
| Additional Customers | array |
| Customer Contact | object |
| ID | number |
| Given Name | text |
| Family Name | text |
| Additional Contacts | array |
| Site | object |
| ID | number |
| Name | text |
| Site Contact | object |
| ID | number |
| Given Name | text |
| Family Name | text |
| Stage | text |
| Follow Up Date | text |
| Date Created | text |
| Description | text |
Update a Lead Custom FieldAction
| Field | Type |
|---|---|
Company IDRequired | choice |
| Value | text |
Update a Site Custom FieldAction
| Field | Type |
|---|---|
Company IDRequired | choice |
| Value | text |
Update a TaskAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Task IDRequired | number |
| Subject | text |
| Assigned To | number |
| Assignees | array |
| Assigned To Customer | boolean |
| Completed By | number |
| Associated Entities | object |
| Job | object |
| Quote | object |
| Customer | number |
| Contact | number |
| Site | number |
| Is Billable | boolean |
| Show on Work Order | boolean |
| Email Notifications | boolean |
| Description | text |
| Field | Type |
|---|---|
| ID | number |
| Subject | text |
| Created By | object |
| ID | number |
| Name | text |
| Type | text |
| Type ID | number |
| Assigned To | object |
| ID | number |
| Name | text |
| Type | text |
| Type ID | number |
| Assignees | array |
| Assigned To Customer | boolean |
| Completed By | object |
| ID | number |
| Name | text |
| Type | text |
| Type ID | number |
| Associated | object |
| Job | object |
| Quote | object |
| Customer | object |
| Contact | object |
| Site | object |
| Is Billable | boolean |
| Show On Work Order | boolean |
| Email Notifications | boolean |
| Description | text |
Update an Individual CustomerAction
| Field | Type |
|---|---|
Company IDRequired | choice |
| Given Name | text |
| Family Name | text |
| Title | choice |
| Preferred Technicians | array |
| Technician ID | text |
| Phone | text |
| Do Not Call | boolean |
| Alternative Phone | text |
| Address | object |
| Address | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Billing Address | object |
| Address | text |
| City | text |
| State | text |
| Postal Code | text |
| Country | text |
| Customer Type | choice |
| Field | Type |
|---|---|
| ID | number |
| Title | text |
| Given name | text |
| Family name | text |
| Preferred techs | array |
| Phone | text |
| Do not call | boolean |
| Alt phone | text |
| Address | object |
| Address | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Billing address | object |
| Address | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Customer type | text |
| Tags | array |
Update an InvoiceAction
| Field | Type |
|---|---|
Company IDRequired | choice |
Invoice IDRequired | number |
| Type | choice |
| Date Issued | date |
| Payment Term ID | number |
| Payment Terms | object |
| Days | number |
| Type | choice |
| Due Date | date |
| Progress Claim Number | number |
| Stage | choice |
| Per Item | boolean |
| Order No | text |
| Late Payment Fee | boolean |
| CIS Deduction Rate | number |
| Field | Type |
|---|---|
| ID | number |
| Type | text |
| Customer | object |
| ID | number |
| Company Name | text |
| Given Name | text |
| Family Name | text |
| Jobs | array |
| Recurring Invoice | object |
| ID | number |
| Description | text |
| Total | object |
| Total | object |
| Ex Tax | number |
| Inc Tax | number |
| Tax | number |
| Reverse Charge Tax | number |
| Amount Applied | number |
| Balance Due | number |
| Is Paid | boolean |
Templates
Look for Simpro templates in the WEXTL template library.
Browse templates →Explore alternative apps
- BlueFolder[2]Field service management software for work orders, technicians, customers, and service history.
- ArcsiteMobile CAD and estimating for contractors — draw plans, takeoffs, and proposals on site.
- AspireField service management for landscaping — estimating, scheduling, production, and billing.
- AcculynxRoofing business management CRM for jobs, leads, estimates, and field production.
- AroFloField service job management for trades — scheduling, quoting, invoicing, and crews.
References
- WEXTL® Simpro Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Simpro.
- WEXTL® visual workflow builder data.
Last updated: Jul 24, 2026 18:12