Simpro

App · 25 actions

Run your trade business's jobs in Simpro from your workflows: add customers, sites, jobs, quotes and leads from forms and enquiries, move jobs and quotes along, add job notes, and read invoices and the schedule. Start a workflow when a job, quote, invoice or lead comes in, a job changes stage or status, a quote is accepted or an invoice is paid.

Actions

ActionWhat it does
Add job noteAdd a note to a job, such as a call with the customer, optionally shown to the customer or given to someone to follow up.
Change job stage or statusMove a job to another stage (such as Complete), to one of your build's statuses, or both.
Change quote stage or statusMove a quote to another stage (such as Complete, when it is ready to send), to one of your build's statuses, or both.
Convert quote to jobTurn a quote the customer agreed to into a job, as converting it in Simpro does, and get the new job.
Create company customerAdd a business as a customer, with its contact details and address.
Create individual customerAdd a person as a customer, such as a homeowner, with their contact details and address.
Create jobAdd a job for a customer at one of their sites, with what it is for and when it is due.
Create leadAdd a lead: work a customer may want, before it is quoted, such as an enquiry from your website.
Create quoteAdd a quote for a customer at one of their sites, ready for your team to price in Simpro.
Create siteAdd a site: a place work is done, linked to the customer it belongs to.
Delete recordDelete a customer, site, job, quote or lead from Simpro for good.
Find customersFind customers by name or email, newest first: companies, individuals or both.
Find employeesList your employees by name, with their position, email and phone.
Find invoicesFind invoices by customer, issue date or whether they are paid, newest first.
Find jobsFind jobs by stage, customer, site, name or issue date, newest first.
Find quotesFind quotes by stage, customer, site, name or issue date, newest first.
Find schedule entriesList the time booked in the schedule on the days you choose, for one person or everyone, such as tomorrow's jobs.
Find sitesFind sites (the places work is done) by name or street, newest first.
Get customerGet a customer's details: contact details, address, sites and how much they owe.
Get invoiceGet an invoice's amounts, due date, the jobs it bills and whether it is paid.
Get jobGet a job's details: its stage and status, customer, site, dates, people and totals.
Get quoteGet a quote's details: its stage and status, whether the customer accepted it, its customer, site and totals.
Get siteGet a site's address, customers and notes, such as for a technician's directions.
Update customerChange a customer's details, or archive them.
Update jobChange a job's name, description, customer, site, due date or people.

Add job note

Add a note to a job, such as a call with the customer, optionally shown to the customer or given to someone to follow up.

Inputs

Jobjob_idtextRequired
The job's ID number in Simpro, from another Simpro step or the trigger.
NotenotetextRequired
What the note says. Line breaks are kept.
Subjectsubjecttext
A short subject for the note.
Show to the customervisible_to_customertrue/false
Let the customer see the note.
Follow-up datefollow_up_datedate
When to follow it up.
Assign toassign_totext
Who should follow it up.
Companycompany_idtext
Which of your Simpro companies to use. Leave blank if your build has only one.

Outputs

assigned_totext
Their name
assigned_to_idnumber
Who it is assigned to; 0 if nobody
date_createdtext
When it was written (ISO 8601, in the build's time zone)
follow_up_datetext
When to follow it up (YYYY-MM-DD); empty if not set
idnumber
The note's ID
job_idnumber
The job it is on
notetext
What the note says, as plain text
subjecttext
The note's subject
submitted_bytext
Their name
submitted_by_idnumber
Who wrote it; 0 if not known
visible_to_customertrue/false
Whether the customer can see it
Example output
{
  "assigned_to": "John Smith",
  "assigned_to_id": 123,
  "date_created": "2018-05-21T19:53:39+10:00",
  "follow_up_date": "",
  "id": 12345,
  "job_id": 12345,
  "note": "Fault/Request See customer's email.",
  "subject": "Customer called",
  "submitted_by": "",
  "submitted_by_id": 0,
  "visible_to_customer": false
}

Change job stage or status

Move a job to another stage (such as Complete), to one of your build's statuses, or both.

Inputs

Jobjob_idtextRequired
The job's ID number in Simpro, from another Simpro step or the trigger.
Stagestagetext
The stage to move it to. Simpro moves a fully invoiced job to Invoiced itself.One of: Pending, Progress (In progress), Complete, Archived.
Statusstatustext
The status to give it. Choosing one turns off Simpro's automatic status changes for this job.
Companycompany_idtext
Which of your Simpro companies to use. Leave blank if your build has only one.

Outputs

completed_datetext
When the job was completed (YYYY-MM-DD); empty if not set
customer_idnumber
The customer's ID
customer_nametext
The customer's name
date_issuedtext
When the job was issued (YYYY-MM-DD); empty if not set
date_modifiedtext
When the job last changed (ISO 8601, in the build's time zone)
descriptiontext
What the job is for, as plain text
due_datetext
When the job is due (YYYY-MM-DD); empty if not set
due_timetext
The time it is due (HH:MM); empty if not set
idnumber
The job's ID (its job number)
job_typetext
Service, Project or Prepaid
nametext
The job's name
notestext
The job's notes, as plain text
order_notext
The customer's order number
project_managertext
The project manager's name
project_manager_idnumber
The project manager's ID; 0 if none
quote_idnumber
The quote it was made from; 0 if none
salespersontext
The salesperson's name
salesperson_idnumber
The salesperson's ID; 0 if none
site_idnumber
The site's ID
site_nametext
The site's name
stagetext
Pending, Progress, Complete, Invoiced or Archived
statustext
Its status, as your build names it, such as Sales: In-Progress
status_idnumber
Its status's ID; 0 if none
technicianslist
The technicians on the job
total_ex_taxnumber
Its total before tax
total_inc_taxnumber
Its total including tax
total_taxnumber
The tax on it
Example output
{
  "completed_date": "",
  "customer_id": 12345,
  "customer_name": "John Smith Pty Ltd",
  "date_issued": "2021-04-22",
  "date_modified": "2018-05-21T19:53:39+10:00",
  "description": "Fault/Request See customer's email.",
  "due_date": "2021-04-22",
  "due_time": "04:22",
  "id": 12345,
  "job_type": "Service",
  "name": "Switchboard upgrade",
  "notes": "",
  "order_no": "",
  "project_manager": "",
  "project_manager_id": 0,
  "quote_id": 0,
  "salesperson": "John Smith",
  "salesperson_id": 123,
  "site_id": 12345,
  "site_name": "123 Example St",
  "stage": "Progress",
  "status": "Sales: In-Progress",
  "status_id": 12345,
  "technicians": [
    "John Smith"
  ],
  "total_ex_tax": 1.57,
  "total_inc_tax": 1.73,
  "total_tax": 0.16
}

Change quote stage or status

Move a quote to another stage (such as Complete, when it is ready to send), to one of your build's statuses, or both.

Inputs

Quotequote_idtextRequired
The quote's ID number in Simpro, from another Simpro step or the trigger.
Stagestagetext
The stage to move it to. Approved means the customer has agreed to it.One of: InProgress (In progress), Complete, Approved.
Statusstatustext
The status to give it. Choosing one turns off Simpro's automatic status changes for this quote.
Companycompany_idtext
Which of your Simpro companies to use. Leave blank if your build has only one.

Outputs

customer_idnumber
The customer's ID
customer_nametext
The customer's name
customer_stagetext
Where the customer is with it: New, Pending, Declined or Accepted; empty if not set
date_approvedtext
When the quote was approved (YYYY-MM-DD); empty if not set
date_issuedtext
When the quote was issued (YYYY-MM-DD); empty if not set
date_modifiedtext
When the quote last changed (ISO 8601, in the build's time zone)
descriptiontext
What the quote is for, as plain text
due_datetext
When the quote is due (YYYY-MM-DD); empty if not set
idnumber
The quote's ID (its quote number)
is_closedtrue/false
Whether the quote is closed
job_notext
The job it became; empty if none
nametext
The quote's name
notestext
The quote's notes, as plain text
order_notext
The customer's order number
project_managertext
The project manager's name
project_manager_idnumber
The project manager's ID; 0 if none
quote_typetext
Service, Project or Prepaid
salespersontext
The salesperson's name
salesperson_idnumber
The salesperson's ID; 0 if none
site_idnumber
The site's ID
site_nametext
The site's name
stagetext
InProgress, Complete or Approved
statustext
Its status, as your build names it, such as Sales: In-Progress
status_idnumber
Its status's ID; 0 if none
total_ex_taxnumber
Its total before tax
total_inc_taxnumber
Its total including tax
total_taxnumber
The tax on it
validity_daysnumber
How many days the quote is valid for
Example output
{
  "customer_id": 12345,
  "customer_name": "John Smith Pty Ltd",
  "customer_stage": "Pending",
  "date_approved": "",
  "date_issued": "2021-04-22",
  "date_modified": "2018-05-21T19:53:39+10:00",
  "description": "Fault/Request See customer's email.",
  "due_date": "2021-04-22",
  "id": 12345,
  "is_closed": false,
  "job_no": "",
  "name": "Switchboard upgrade",
  "notes": "",
  "order_no": "",
  "project_manager": "",
  "project_manager_id": 0,
  "quote_type": "Service",
  "salesperson": "John Smith",
  "salesperson_id": 123,
  "site_id": 12345,
  "site_name": "123 Example St",
  "stage": "InProgress",
  "status": "Sales: In-Progress",
  "status_id": 12345,
  "total_ex_tax": 1.57,
  "total_inc_tax": 1.73,
  "total_tax": 0.16,
  "validity_days": 30
}

Convert quote to job

Turn a quote the customer agreed to into a job, as converting it in Simpro does, and get the new job.

Inputs

Quotequote_idtextRequired
The quote's ID number in Simpro, from another Simpro step or the trigger.
Companycompany_idtext
Which of your Simpro companies to use. Leave blank if your build has only one.

Outputs

completed_datetext
When the job was completed (YYYY-MM-DD); empty if not set
customer_idnumber
The customer's ID
customer_nametext
The customer's name
date_issuedtext
When the job was issued (YYYY-MM-DD); empty if not set
date_modifiedtext
When the job last changed (ISO 8601, in the build's time zone)
descriptiontext
What the job is for, as plain text
due_datetext
When the job is due (YYYY-MM-DD); empty if not set
due_timetext
The time it is due (HH:MM); empty if not set
idnumber
The job's ID (its job number)
job_typetext
Service, Project or Prepaid
nametext
The job's name
notestext
The job's notes, as plain text
order_notext
The customer's order number
project_managertext
The project manager's name
project_manager_idnumber
The project manager's ID; 0 if none
quote_idnumber
The quote it was made from; 0 if none
salespersontext
The salesperson's name
salesperson_idnumber
The salesperson's ID; 0 if none
site_idnumber
The site's ID
site_nametext
The site's name
stagetext
Pending, Progress, Complete, Invoiced or Archived
statustext
Its status, as your build names it, such as Sales: In-Progress
status_idnumber
Its status's ID; 0 if none
technicianslist
The technicians on the job
total_ex_taxnumber
Its total before tax
total_inc_taxnumber
Its total including tax
total_taxnumber
The tax on it
Example output
{
  "completed_date": "",
  "customer_id": 12345,
  "customer_name": "John Smith Pty Ltd",
  "date_issued": "2021-04-22",
  "date_modified": "2018-05-21T19:53:39+10:00",
  "description": "Fault/Request See customer's email.",
  "due_date": "2021-04-22",
  "due_time": "04:22",
  "id": 12345,
  "job_type": "Service",
  "name": "Switchboard upgrade",
  "notes": "",
  "order_no": "",
  "project_manager": "",
  "project_manager_id": 0,
  "quote_id": 0,
  "salesperson": "John Smith",
  "salesperson_id": 123,
  "site_id": 12345,
  "site_name": "123 Example St",
  "stage": "Progress",
  "status": "Sales: In-Progress",
  "status_id": 12345,
  "technicians": [
    "John Smith"
  ],
  "total_ex_tax": 1.57,
  "total_inc_tax": 1.73,
  "total_tax": 0.16
}

Create company customer

Add a business as a customer, with its contact details and address.

Inputs

Company namecompany_nametextRequired
The business's name.
Emailemailtext
The business's email address.
Phonephonetext
The business's phone number.
Websitewebsitetext
The business's website.
Streetstreettext
The business's street address.
Citycitytext
The business's city or suburb.
Statestatetext
The business's state or region, such as NSW.
Postcodepostcodetext
The business's postcode or ZIP code.
Countrycountrytext
The business's country.
Private notesnotestext
Notes about the customer for your staff.
Also add a siteadd_sitetrue/false
Also add a site at the customer's address, ready for jobs and quotes.
Companycompany_idtext
Which of your Simpro companies to use. Leave blank if your build has only one.

Outputs

alt_phonetext
Their other phone number
amount_owingnumber
How much they owe
archivedtrue/false
Whether the customer is archived
citytext
City or suburb
company_nametext
The company's name (company customers)
countrytext
Country
customer_kindtext
company or individual
customer_typetext
Customer, or Lead for a possible customer
date_createdtext
When the customer was added (ISO 8601, in the build's time zone)
date_modifiedtext
When the customer last changed (ISO 8601, in the build's time zone)
emailtext
Their email
first_nametext
The person's first name (individual customers)
idnumber
The customer's ID
last_nametext
The person's last name (individual customers)
mobiletext
The person's mobile number (individual customers)
nametext
The company's name, or the person's first and last name
notestext
Private notes about the customer
phonetext
Their phone number
postcodetext
Postcode or ZIP code
siteslist
The sites the customer is linked to
statetext
State or region
streettext
Street address
tagslist
The customer's tags
titletext
The person's title, such as Mr (individual customers)
websitetext
The company's website (company customers)
Example output
{
  "alt_phone": "",
  "amount_owing": 1.57,
  "archived": false,
  "city": "Sydney",
  "company_name": "John Smith Pty Ltd",
  "country": "AUS",
  "customer_kind": "company",
  "customer_type": "Customer",
  "date_created": "2018-05-21T19:53:39+10:00",
  "date_modified": "2018-05-21T19:53:39+10:00",
  "email": "sales@simpro.com.au",
  "first_name": "",
  "id": 12345,
  "last_name": "",
  "mobile": "",
  "name": "John Smith Pty Ltd",
  "notes": "",
  "phone": "07 1234 5678",
  "postcode": "2000",
  "sites": [
    {
      "id": 12345,
      "name": "123 Example St"
    }
  ],
  "state": "NSW",
  "street": "123 Example St",
  "tags": [],
  "title": "",
  "website": "https://simprogroup.com/au/"
}

Create individual customer

Add a person as a customer, such as a homeowner, with their contact details and address.

Inputs

Titletitletext
Their title.One of: Mr, Mrs, Miss, Ms, Dr, Sir.
First namefirst_nametextRequired
Their first name.
Last namelast_nametextRequired
Their last name.
Emailemailtext
Their email address.
Phonephonetext
Their phone number.
Mobilemobiletext
Their mobile number.
Streetstreettext
The person's street address.
Citycitytext
The person's city or suburb.
Statestatetext
The person's state or region, such as NSW.
Postcodepostcodetext
The person's postcode or ZIP code.
Countrycountrytext
The person's country.
Private notesnotestext
Notes about the customer for your staff.
Also add a siteadd_sitetrue/false
Also add a site at the customer's address, ready for jobs and quotes.
Companycompany_idtext
Which of your Simpro companies to use. Leave blank if your build has only one.

Outputs

alt_phonetext
Their other phone number
amount_owingnumber
How much they owe
archivedtrue/false
Whether the customer is archived
citytext
City or suburb
company_nametext
The company's name (company customers)
countrytext
Country
customer_kindtext
company or individual
customer_typetext
Customer, or Lead for a possible customer
date_createdtext
When the customer was added (ISO 8601, in the build's time zone)
date_modifiedtext
When the customer last changed (ISO 8601, in the build's time zone)
emailtext
Their email
first_nametext
The person's first name (individual customers)
idnumber
The customer's ID
last_nametext
The person's last name (individual customers)
mobiletext
The person's mobile number (individual customers)
nametext
The company's name, or the person's first and last name
notestext
Private notes about the customer
phonetext
Their phone number
postcodetext
Postcode or ZIP code
siteslist
The sites the customer is linked to
statetext
State or region
streettext
Street address
tagslist
The customer's tags
titletext
The person's title, such as Mr (individual customers)
websitetext
The company's website (company customers)
Example output
{
  "alt_phone": "",
  "amount_owing": 1.57,
  "archived": false,
  "city": "Sydney",
  "company_name": "John Smith Pty Ltd",
  "country": "AUS",
  "customer_kind": "company",
  "customer_type": "Customer",
  "date_created": "2018-05-21T19:53:39+10:00",
  "date_modified": "2018-05-21T19:53:39+10:00",
  "email": "sales@simpro.com.au",
  "first_name": "",
  "id": 12345,
  "last_name": "",
  "mobile": "",
  "name": "John Smith Pty Ltd",
  "notes": "",
  "phone": "07 1234 5678",
  "postcode": "2000",
  "sites": [
    {
      "id": 12345,
      "name": "123 Example St"
    }
  ],
  "state": "NSW",
  "street": "123 Example St",
  "tags": [],
  "title": "",
  "website": "https://simprogroup.com/au/"
}

Create job

Add a job for a customer at one of their sites, with what it is for and when it is due.

Inputs

Customercustomer_idtextRequired
The customer's ID number in Simpro, from another Simpro step or the trigger.
Sitesite_idtextRequired
Where the work is: the site's ID number in Simpro, from another Simpro step or the trigger.
Typejob_typetext
What kind of job it is. Leave as Service unless it is a project or prepaid work.One of: Service, Project, Prepaid. Default: Service.
Namenametext
A short name for the job.
Descriptiondescriptiontext
What the job is for. Line breaks are kept.
Notesnotestext
Notes for your staff about the job.
Order numberorder_notext
The customer's order number.
Issue datedate_issueddate
When the job is issued.
Due datedue_datedate
When the job is due.
Due timedue_timetime
The time of day it is due.
Salespersonsalespersontext
The employee selling it.
Project managerproject_managertext
The employee managing it.
Companycompany_idtext
Which of your Simpro companies to use. Leave blank if your build has only one.

Outputs

completed_datetext
When the job was completed (YYYY-MM-DD); empty if not set
customer_idnumber
The customer's ID
customer_nametext
The customer's name
date_issuedtext
When the job was issued (YYYY-MM-DD); empty if not set
date_modifiedtext
When the job last changed (ISO 8601, in the build's time zone)
descriptiontext
What the job is for, as plain text
due_datetext
When the job is due (YYYY-MM-DD); empty if not set
due_timetext
The time it is due (HH:MM); empty if not set
idnumber
The job's ID (its job number)
job_typetext
Service, Project or Prepaid
nametext
The job's name
notestext
The job's notes, as plain text
order_notext
The customer's order number
project_managertext
The project manager's name
project_manager_idnumber
The project manager's ID; 0 if none
quote_idnumber
The quote it was made from; 0 if none
salespersontext
The salesperson's name
salesperson_idnumber
The salesperson's ID; 0 if none
site_idnumber
The site's ID
site_nametext
The site's name
stagetext
Pending, Progress, Complete, Invoiced or Archived
statustext
Its status, as your build names it, such as Sales: In-Progress
status_idnumber
Its status's ID; 0 if none
technicianslist
The technicians on the job
total_ex_taxnumber
Its total before tax
total_inc_taxnumber
Its total including tax
total_taxnumber
The tax on it
Example output
{
  "completed_date": "",
  "customer_id": 12345,
  "customer_name": "John Smith Pty Ltd",
  "date_issued": "2021-04-22",
  "date_modified": "2018-05-21T19:53:39+10:00",
  "description": "Fault/Request See customer's email.",
  "due_date": "2021-04-22",
  "due_time": "04:22",
  "id": 12345,
  "job_type": "Service",
  "name": "Switchboard upgrade",
  "notes": "",
  "order_no": "",
  "project_manager": "",
  "project_manager_id": 0,
  "quote_id": 0,
  "salesperson": "John Smith",
  "salesperson_id": 123,
  "site_id": 12345,
  "site_name": "123 Example St",
  "stage": "Progress",
  "status": "Sales: In-Progress",
  "status_id": 12345,
  "technicians": [
    "John Smith"
  ],
  "total_ex_tax": 1.57,
  "total_inc_tax": 1.73,
  "total_tax": 0.16
}

Create lead

Add a lead: work a customer may want, before it is quoted, such as an enquiry from your website.

Inputs

NamenametextRequired
What the lead is called.
Customercustomer_idtextRequired
The customer's ID number in Simpro, from another Simpro step or the trigger.
Sitesite_idtextRequired
Where the work would be: the site's ID number in Simpro, from another Simpro step or the trigger.
Descriptiondescriptiontext
What the customer is asking for. Line breaks are kept.
Notesnotestext
Notes for your staff about the lead.
Follow-up datefollow_up_datedate
When to follow it up.
Salespersonsalespersontext
The employee selling it.
Companycompany_idtext
Which of your Simpro companies to use. Leave blank if your build has only one.

Outputs

customer_idnumber
The customer's ID
customer_nametext
The customer's name
date_createdtext
When the lead was added (YYYY-MM-DD); empty if not set
date_modifiedtext
When the lead last changed (ISO 8601, in the build's time zone)
descriptiontext
What the lead is about, as plain text
follow_up_datetext
When to follow it up (YYYY-MM-DD); empty if not set
idnumber
The lead's ID
nametext
The lead's name
notestext
The lead's notes, as plain text
project_managertext
The project manager's name
project_manager_idnumber
The project manager's ID; 0 if none
salespersontext
The salesperson's name
salesperson_idnumber
The salesperson's ID; 0 if none
site_idnumber
The site's ID
site_nametext
The site's name
stagetext
Open or Closed
statustext
Its status, as your build names it, such as Sales: In-Progress
status_idnumber
Its status's ID; 0 if none
Example output
{
  "customer_id": 12345,
  "customer_name": "John Smith Pty Ltd",
  "date_created": "2021-04-22",
  "date_modified": "2018-05-21T19:53:39+10:00",
  "description": "Fault/Request See customer's email.",
  "follow_up_date": "2021-04-22",
  "id": 12345,
  "name": "Switchboard upgrade",
  "notes": "",
  "project_manager": "",
  "project_manager_id": 0,
  "salesperson": "John Smith",
  "salesperson_id": 123,
  "site_id": 12345,
  "site_name": "123 Example St",
  "stage": "Open",
  "status": "",
  "status_id": 0
}

Create quote

Add a quote for a customer at one of their sites, ready for your team to price in Simpro.

Inputs

Customercustomer_idtextRequired
The customer's ID number in Simpro, from another Simpro step or the trigger.
Sitesite_idtextRequired
Where the work is: the site's ID number in Simpro, from another Simpro step or the trigger.
Typequote_typetext
What kind of work it is. Leave as Service unless it is a project or prepaid work.One of: Service, Project, Prepaid. Default: Service.
Namenametext
A short name for the quote.
Descriptiondescriptiontext
What the quote is for. Line breaks are kept.
Notesnotestext
Notes for your staff about the quote.
Order numberorder_notext
The customer's order number.
Issue datedate_issueddate
When the quote is issued.
Due datedue_datedate
When the quote is due.
Valid for (days)validity_daysnumber
How many days the quote stays valid.From 0 to 32767.
Salespersonsalespersontext
The employee selling it.
Project managerproject_managertext
The employee managing it.
Companycompany_idtext
Which of your Simpro companies to use. Leave blank if your build has only one.

Outputs

customer_idnumber
The customer's ID
customer_nametext
The customer's name
customer_stagetext
Where the customer is with it: New, Pending, Declined or Accepted; empty if not set
date_approvedtext
When the quote was approved (YYYY-MM-DD); empty if not set
date_issuedtext
When the quote was issued (YYYY-MM-DD); empty if not set
date_modifiedtext
When the quote last changed (ISO 8601, in the build's time zone)
descriptiontext
What the quote is for, as plain text
due_datetext
When the quote is due (YYYY-MM-DD); empty if not set
idnumber
The quote's ID (its quote number)
is_closedtrue/false
Whether the quote is closed
job_notext
The job it became; empty if none
nametext
The quote's name
notestext
The quote's notes, as plain text
order_notext
The customer's order number
project_managertext
The project manager's name
project_manager_idnumber
The project manager's ID; 0 if none
quote_typetext
Service, Project or Prepaid
salespersontext
The salesperson's name
salesperson_idnumber
The salesperson's ID; 0 if none
site_idnumber
The site's ID
site_nametext
The site's name
stagetext
InProgress, Complete or Approved
statustext
Its status, as your build names it, such as Sales: In-Progress
status_idnumber
Its status's ID; 0 if none
total_ex_taxnumber
Its total before tax
total_inc_taxnumber
Its total including tax
total_taxnumber
The tax on it
validity_daysnumber
How many days the quote is valid for
Example output
{
  "customer_id": 12345,
  "customer_name": "John Smith Pty Ltd",
  "customer_stage": "Pending",
  "date_approved": "",
  "date_issued": "2021-04-22",
  "date_modified": "2018-05-21T19:53:39+10:00",
  "description": "Fault/Request See customer's email.",
  "due_date": "2021-04-22",
  "id": 12345,
  "is_closed": false,
  "job_no": "",
  "name": "Switchboard upgrade",
  "notes": "",
  "order_no": "",
  "project_manager": "",
  "project_manager_id": 0,
  "quote_type": "Service",
  "salesperson": "John Smith",
  "salesperson_id": 123,
  "site_id": 12345,
  "site_name": "123 Example St",
  "stage": "InProgress",
  "status": "Sales: In-Progress",
  "status_id": 12345,
  "total_ex_tax": 1.57,
  "total_inc_tax": 1.73,
  "total_tax": 0.16,
  "validity_days": 30
}

Create site

Add a site: a place work is done, linked to the customer it belongs to. Jobs, quotes and leads each need one.

Inputs

NamenametextRequired
What the site is called, often its street address.
Streetstreettext
The site's street address.
Citycitytext
The site's city or suburb.
Statestatetext
The site's state or region, such as NSW.
Postcodepostcodetext
The site's postcode or ZIP code.
Countrycountrytext
The site's country.
Customercustomer_idtext
Who the site belongs to: the customer's ID number in Simpro, from another Simpro step or the trigger.
Public notespublic_notestext
Notes about the site that customers can see, such as access details.
Private notesprivate_notestext
Notes about the site for your staff only.
Companycompany_idtext
Which of your Simpro companies to use. Leave blank if your build has only one.

Outputs

archivedtrue/false
Whether the site is archived
citytext
City or suburb
countrytext
Country
customerslist
The customers linked to the site
date_modifiedtext
When the site last changed (ISO 8601, in the build's time zone)
idnumber
The site's ID
nametext
The site's name
postcodetext
Postcode or ZIP code
private_notestext
Notes about the site for your staff only
public_notestext
Notes about the site that customers can see
statetext
State or region
streettext
Street address
Example output
{
  "archived": false,
  "city": "Sydney",
  "country": "AUS",
  "customers": [
    {
      "id": 12345,
      "name": "John Smith Pty Ltd"
    }
  ],
  "date_modified": "2018-05-21T19:53:39+10:00",
  "id": 12345,
  "name": "123 Example St",
  "postcode": "2000",
  "private_notes": "",
  "public_notes": "",
  "state": "NSW",
  "street": "123 Example St"
}

Delete record

Delete a customer, site, job, quote or lead from Simpro for good. It can't be undone.

Inputs

Typerecord_typetextRequired
What kind of record it is.One of: company_customer (Company customer), individual_customer (Individual customer), site, job, quote, lead.
Recordrecord_idtextRequired
The record's ID number in Simpro, from another Simpro step or the trigger.
Companycompany_idtext
Which of your Simpro companies to use. Leave blank if your build has only one.

Outputs

deletedtrue/false
Always true: the record was deleted
idnumber
The deleted record's ID
record_typetext
What kind of record it was
Example output
{
  "deleted": true,
  "id": 12345,
  "record_type": "job"
}

Find customers

Find customers by name or email, newest first: companies, individuals or both. Leave every field blank to list the newest.

Inputs

Company or individualcustomer_typetext
Only company customers, or only individuals. Leave blank for both.One of: company (Company customer), individual (Individual customer).
Namenametext
Words in the customer's name: a company's name, or a person's first or last name.
Emailemailtext
The customer's email address, exactly.
How manylimitnumber
The most to list, newest first. Defaults to 25.From 1 to 100.
Companycompany_idtext
Which of your Simpro companies to use. Leave blank if your build has only one.

Outputs

countnumber
How many are listed
customerslist
The customers found
totalnumber
How many match in all
Example output
{
  "count": 1,
  "customers": [
    {
      "alt_phone": "",
      "amount_owing": 1.57,
      "archived": false,
      "city": "Sydney",
      "company_name": "John Smith Pty Ltd",
      "country": "AUS",
      "customer_kind": "company",
      "customer_type": "Customer",
      "date_created": "2018-05-21T19:53:39+10:00",
      "date_modified": "2018-05-21T19:53:39+10:00",
      "email": "sales@simpro.com.au",
      "first_name": "",
      "id": 12345,
      "last_name": "",
      "mobile": "",
      "name": "John Smith Pty Ltd",
      "notes": "",
      "phone": "07 1234 5678",
      "postcode": "2000",
      "sites": [
        {
          "id": 12345,
          "name": "123 Example St"
        }
      ],
      "state": "NSW",
      "street": "123 Example St",
      "tags": [],
      "title": "",
      "website": "https://simprogroup.com/au/"
    }
  ],
  "total": 1
}

Find employees

List your employees by name, with their position, email and phone.

Inputs

Namenametext
Words in the employee's name.
Include archivedinclude_archivedtrue/false
Also list employees who have been archived.
How manylimitnumber
The most to list, in order of name. Defaults to 25.From 1 to 100.
Companycompany_idtext
Which of your Simpro companies to use. Leave blank if your build has only one.

Outputs

countnumber
How many are listed
employeeslist
The employees found
totalnumber
How many match in all
Example output
{
  "count": 1,
  "employees": [
    {
      "archived": false,
      "email": "address@example.com",
      "id": 123,
      "mobile": "",
      "name": "John Smith",
      "position": "Electrician",
      "work_phone": "07 3147 8777"
    }
  ],
  "total": 1
}

Find invoices

Find invoices by customer, issue date or whether they are paid, newest first. Leave every field blank to list the newest.

Inputs

Paidpaidtext
Only paid invoices, or only those not paid yet. Leave blank for both.One of: paid, unpaid (Not paid yet).
Customercustomer_idtext
The customer's ID number in Simpro, from another Simpro step or the trigger.
Issued on or afterissued_fromdate
Only those issued on or after this day.
Issued on or beforeissued_todate
Only those issued on or before this day.
How manylimitnumber
The most to list, newest first. Defaults to 25.From 1 to 100.
Companycompany_idtext
Which of your Simpro companies to use. Leave blank if your build has only one.

Outputs

countnumber
How many are listed
invoiceslist
The invoices found
totalnumber
How many match in all
Example output
{
  "count": 1,
  "invoices": [
    {
      "amount_paid": 0,
      "balance_due": 1.73,
      "currency": "AUD",
      "customer_id": 12345,
      "customer_name": "John Smith Pty Ltd",
      "date_created": "2018-05-21T19:53:39+10:00",
      "date_issued": "2021-04-22",
      "date_modified": "2018-05-21T19:53:39+10:00",
      "date_paid": "",
      "description": "",
      "due_date": "2021-05-22",
      "id": 10001,
      "internal_id": "12345",
      "invoice_type": "TaxInvoice",
      "is_paid": false,
      "job_ids": [
        12345
      ],
      "order_no": "",
      "stage": "Approved",
      "status": "Sent",
      "status_id": 12345,
      "total_ex_tax": 1.57,
      "total_inc_tax": 1.73,
      "total_tax": 0.16
    }
  ],
  "total": 1
}

Find jobs

Find jobs by stage, customer, site, name or issue date, newest first. Leave every field blank to list the newest.

Inputs

Stagestagetext
Only jobs in this stage.One of: Pending, Progress (In progress), Complete, Invoiced, Archived.
Customercustomer_idtext
The customer's ID number in Simpro, from another Simpro step or the trigger.
Sitesite_idtext
The site's ID number in Simpro, from another Simpro step or the trigger.
Namenametext
Words in the job's name.
Issued on or afterissued_fromdate
Only those issued on or after this day.
Issued on or beforeissued_todate
Only those issued on or before this day.
How manylimitnumber
The most to list, newest first. Defaults to 25.From 1 to 100.
Companycompany_idtext
Which of your Simpro companies to use. Leave blank if your build has only one.

Outputs

countnumber
How many are listed
jobslist
The jobs found
totalnumber
How many match in all
Example output
{
  "count": 1,
  "jobs": [
    {
      "completed_date": "",
      "customer_id": 12345,
      "customer_name": "John Smith Pty Ltd",
      "date_issued": "2021-04-22",
      "date_modified": "2018-05-21T19:53:39+10:00",
      "description": "Fault/Request See customer's email.",
      "due_date": "2021-04-22",
      "due_time": "04:22",
      "id": 12345,
      "job_type": "Service",
      "name": "Switchboard upgrade",
      "notes": "",
      "order_no": "",
      "project_manager": "",
      "project_manager_id": 0,
      "quote_id": 0,
      "salesperson": "John Smith",
      "salesperson_id": 123,
      "site_id": 12345,
      "site_name": "123 Example St",
      "stage": "Progress",
      "status": "Sales: In-Progress",
      "status_id": 12345,
      "technicians": [
        "John Smith"
      ],
      "total_ex_tax": 1.57,
      "total_inc_tax": 1.73,
      "total_tax": 0.16
    }
  ],
  "total": 1
}

Find quotes

Find quotes by stage, customer, site, name or issue date, newest first. Leave every field blank to list the newest.

Inputs

Stagestagetext
Only quotes in this stage.One of: InProgress (In progress), Complete, Approved.
Customercustomer_idtext
The customer's ID number in Simpro, from another Simpro step or the trigger.
Sitesite_idtext
The site's ID number in Simpro, from another Simpro step or the trigger.
Namenametext
Words in the quote's name.
Issued on or afterissued_fromdate
Only those issued on or after this day.
Issued on or beforeissued_todate
Only those issued on or before this day.
How manylimitnumber
The most to list, newest first. Defaults to 25.From 1 to 100.
Companycompany_idtext
Which of your Simpro companies to use. Leave blank if your build has only one.

Outputs

countnumber
How many are listed
quoteslist
The quotes found
totalnumber
How many match in all
Example output
{
  "count": 1,
  "quotes": [
    {
      "customer_id": 12345,
      "customer_name": "John Smith Pty Ltd",
      "customer_stage": "Pending",
      "date_approved": "",
      "date_issued": "2021-04-22",
      "date_modified": "2018-05-21T19:53:39+10:00",
      "description": "Fault/Request See customer's email.",
      "due_date": "2021-04-22",
      "id": 12345,
      "is_closed": false,
      "job_no": "",
      "name": "Switchboard upgrade",
      "notes": "",
      "order_no": "",
      "project_manager": "",
      "project_manager_id": 0,
      "quote_type": "Service",
      "salesperson": "John Smith",
      "salesperson_id": 123,
      "site_id": 12345,
      "site_name": "123 Example St",
      "stage": "InProgress",
      "status": "Sales: In-Progress",
      "status_id": 12345,
      "total_ex_tax": 1.57,
      "total_inc_tax": 1.73,
      "total_tax": 0.16,
      "validity_days": 30
    }
  ],
  "total": 1
}

Find schedule entries

List the time booked in the schedule on the days you choose, for one person or everyone, such as tomorrow's jobs.

Inputs

Fromdate_fromdate
The first day to list.
Todate_todate
The last day to list.
Employeestafftext
Only this employee's bookings.
Booked forschedule_typetext
Only time booked for jobs, quotes, leads or activities. Leave blank for all.One of: job, quote, lead, activity.
How manylimitnumber
The most to list, newest first. Defaults to 25.From 1 to 100.
Companycompany_idtext
Which of your Simpro companies to use. Leave blank if your build has only one.

Outputs

countnumber
How many are listed
scheduleslist
The schedule entries found
totalnumber
How many match in all
Example output
{
  "count": 1,
  "schedules": [
    {
      "date": "2021-04-22",
      "date_modified": "2018-05-21T19:53:39+10:00",
      "end_time": "16:00",
      "ends_at": "2021-04-22T16:00:00+10:00",
      "id": 12345,
      "notes": "",
      "record_id": 12345,
      "reference": "12345-678",
      "schedule_type": "job",
      "staff_id": 123,
      "staff_name": "John Smith",
      "staff_type": "employee",
      "start_time": "08:00",
      "starts_at": "2021-04-22T08:00:00+10:00",
      "total_hours": 8
    }
  ],
  "total": 1
}

Find sites

Find sites (the places work is done) by name or street, newest first. Leave both blank to list the newest.

Inputs

Namenametext
Words in the site's name.
Streetstreettext
Words in the site's street address.
How manylimitnumber
The most to list, newest first. Defaults to 25.From 1 to 100.
Companycompany_idtext
Which of your Simpro companies to use. Leave blank if your build has only one.

Outputs

countnumber
How many are listed
siteslist
The sites found
totalnumber
How many match in all
Example output
{
  "count": 1,
  "sites": [
    {
      "archived": false,
      "city": "Sydney",
      "country": "AUS",
      "customers": [
        {
          "id": 12345,
          "name": "John Smith Pty Ltd"
        }
      ],
      "date_modified": "2018-05-21T19:53:39+10:00",
      "id": 12345,
      "name": "123 Example St",
      "postcode": "2000",
      "private_notes": "",
      "public_notes": "",
      "state": "NSW",
      "street": "123 Example St"
    }
  ],
  "total": 1
}

Get customer

Get a customer's details: contact details, address, sites and how much they owe.

Inputs

Company or individualcustomer_typetextRequired
Whether it is a company customer or an individual.One of: company (Company customer), individual (Individual customer).
Customercustomer_idtextRequired
The customer's ID number in Simpro, from another Simpro step or the trigger.
Companycompany_idtext
Which of your Simpro companies to use. Leave blank if your build has only one.

Outputs

alt_phonetext
Their other phone number
amount_owingnumber
How much they owe
archivedtrue/false
Whether the customer is archived
citytext
City or suburb
company_nametext
The company's name (company customers)
countrytext
Country
customer_kindtext
company or individual
customer_typetext
Customer, or Lead for a possible customer
date_createdtext
When the customer was added (ISO 8601, in the build's time zone)
date_modifiedtext
When the customer last changed (ISO 8601, in the build's time zone)
emailtext
Their email
first_nametext
The person's first name (individual customers)
idnumber
The customer's ID
last_nametext
The person's last name (individual customers)
mobiletext
The person's mobile number (individual customers)
nametext
The company's name, or the person's first and last name
notestext
Private notes about the customer
phonetext
Their phone number
postcodetext
Postcode or ZIP code
siteslist
The sites the customer is linked to
statetext
State or region
streettext
Street address
tagslist
The customer's tags
titletext
The person's title, such as Mr (individual customers)
websitetext
The company's website (company customers)
Example output
{
  "alt_phone": "",
  "amount_owing": 1.57,
  "archived": false,
  "city": "Sydney",
  "company_name": "John Smith Pty Ltd",
  "country": "AUS",
  "customer_kind": "company",
  "customer_type": "Customer",
  "date_created": "2018-05-21T19:53:39+10:00",
  "date_modified": "2018-05-21T19:53:39+10:00",
  "email": "sales@simpro.com.au",
  "first_name": "",
  "id": 12345,
  "last_name": "",
  "mobile": "",
  "name": "John Smith Pty Ltd",
  "notes": "",
  "phone": "07 1234 5678",
  "postcode": "2000",
  "sites": [
    {
      "id": 12345,
      "name": "123 Example St"
    }
  ],
  "state": "NSW",
  "street": "123 Example St",
  "tags": [],
  "title": "",
  "website": "https://simprogroup.com/au/"
}

Get invoice

Get an invoice's amounts, due date, the jobs it bills and whether it is paid.

Inputs

Invoiceinvoice_idtextRequired
The invoice number, from another Simpro step or the trigger.
Companycompany_idtext
Which of your Simpro companies to use. Leave blank if your build has only one.

Outputs

amount_paidnumber
How much has been paid against it
balance_duenumber
How much is still owed
currencytext
Its currency, such as AUD
customer_idnumber
The customer's ID
customer_nametext
The customer's name
date_createdtext
When it was made (ISO 8601, in the build's time zone)
date_issuedtext
When it was issued (YYYY-MM-DD); empty if not set
date_modifiedtext
When it last changed (ISO 8601, in the build's time zone)
date_paidtext
When it was fully paid (YYYY-MM-DD); empty if not set
descriptiontext
Its description, as plain text
due_datetext
When payment is due (YYYY-MM-DD); empty if not set
idnumber
The invoice number
internal_idtext
The invoice's number in Simpro's own links
invoice_typetext
TaxInvoice, Deposit, ProgressInvoice or RequestForClaim
is_paidtrue/false
Whether it is fully paid
job_idslist
The jobs it invoices
order_notext
The customer's order number
stagetext
Approved, or Pending until someone approves it
statustext
Its status, as your build names it, such as Sales: In-Progress
status_idnumber
Its status's ID; 0 if none
total_ex_taxnumber
Its total before tax
total_inc_taxnumber
Its total including tax
total_taxnumber
The tax on it
Example output
{
  "amount_paid": 0,
  "balance_due": 1.73,
  "currency": "AUD",
  "customer_id": 12345,
  "customer_name": "John Smith Pty Ltd",
  "date_created": "2018-05-21T19:53:39+10:00",
  "date_issued": "2021-04-22",
  "date_modified": "2018-05-21T19:53:39+10:00",
  "date_paid": "",
  "description": "",
  "due_date": "2021-05-22",
  "id": 10001,
  "internal_id": "12345",
  "invoice_type": "TaxInvoice",
  "is_paid": false,
  "job_ids": [
    12345
  ],
  "order_no": "",
  "stage": "Approved",
  "status": "Sent",
  "status_id": 12345,
  "total_ex_tax": 1.57,
  "total_inc_tax": 1.73,
  "total_tax": 0.16
}

Get job

Get a job's details: its stage and status, customer, site, dates, people and totals.

Inputs

Jobjob_idtextRequired
The job's ID number in Simpro, from another Simpro step or the trigger.
Companycompany_idtext
Which of your Simpro companies to use. Leave blank if your build has only one.

Outputs

completed_datetext
When the job was completed (YYYY-MM-DD); empty if not set
customer_idnumber
The customer's ID
customer_nametext
The customer's name
date_issuedtext
When the job was issued (YYYY-MM-DD); empty if not set
date_modifiedtext
When the job last changed (ISO 8601, in the build's time zone)
descriptiontext
What the job is for, as plain text
due_datetext
When the job is due (YYYY-MM-DD); empty if not set
due_timetext
The time it is due (HH:MM); empty if not set
idnumber
The job's ID (its job number)
job_typetext
Service, Project or Prepaid
nametext
The job's name
notestext
The job's notes, as plain text
order_notext
The customer's order number
project_managertext
The project manager's name
project_manager_idnumber
The project manager's ID; 0 if none
quote_idnumber
The quote it was made from; 0 if none
salespersontext
The salesperson's name
salesperson_idnumber
The salesperson's ID; 0 if none
site_idnumber
The site's ID
site_nametext
The site's name
stagetext
Pending, Progress, Complete, Invoiced or Archived
statustext
Its status, as your build names it, such as Sales: In-Progress
status_idnumber
Its status's ID; 0 if none
technicianslist
The technicians on the job
total_ex_taxnumber
Its total before tax
total_inc_taxnumber
Its total including tax
total_taxnumber
The tax on it
Example output
{
  "completed_date": "",
  "customer_id": 12345,
  "customer_name": "John Smith Pty Ltd",
  "date_issued": "2021-04-22",
  "date_modified": "2018-05-21T19:53:39+10:00",
  "description": "Fault/Request See customer's email.",
  "due_date": "2021-04-22",
  "due_time": "04:22",
  "id": 12345,
  "job_type": "Service",
  "name": "Switchboard upgrade",
  "notes": "",
  "order_no": "",
  "project_manager": "",
  "project_manager_id": 0,
  "quote_id": 0,
  "salesperson": "John Smith",
  "salesperson_id": 123,
  "site_id": 12345,
  "site_name": "123 Example St",
  "stage": "Progress",
  "status": "Sales: In-Progress",
  "status_id": 12345,
  "technicians": [
    "John Smith"
  ],
  "total_ex_tax": 1.57,
  "total_inc_tax": 1.73,
  "total_tax": 0.16
}

Get quote

Get a quote's details: its stage and status, whether the customer accepted it, its customer, site and totals.

Inputs

Quotequote_idtextRequired
The quote's ID number in Simpro, from another Simpro step or the trigger.
Companycompany_idtext
Which of your Simpro companies to use. Leave blank if your build has only one.

Outputs

customer_idnumber
The customer's ID
customer_nametext
The customer's name
customer_stagetext
Where the customer is with it: New, Pending, Declined or Accepted; empty if not set
date_approvedtext
When the quote was approved (YYYY-MM-DD); empty if not set
date_issuedtext
When the quote was issued (YYYY-MM-DD); empty if not set
date_modifiedtext
When the quote last changed (ISO 8601, in the build's time zone)
descriptiontext
What the quote is for, as plain text
due_datetext
When the quote is due (YYYY-MM-DD); empty if not set
idnumber
The quote's ID (its quote number)
is_closedtrue/false
Whether the quote is closed
job_notext
The job it became; empty if none
nametext
The quote's name
notestext
The quote's notes, as plain text
order_notext
The customer's order number
project_managertext
The project manager's name
project_manager_idnumber
The project manager's ID; 0 if none
quote_typetext
Service, Project or Prepaid
salespersontext
The salesperson's name
salesperson_idnumber
The salesperson's ID; 0 if none
site_idnumber
The site's ID
site_nametext
The site's name
stagetext
InProgress, Complete or Approved
statustext
Its status, as your build names it, such as Sales: In-Progress
status_idnumber
Its status's ID; 0 if none
total_ex_taxnumber
Its total before tax
total_inc_taxnumber
Its total including tax
total_taxnumber
The tax on it
validity_daysnumber
How many days the quote is valid for
Example output
{
  "customer_id": 12345,
  "customer_name": "John Smith Pty Ltd",
  "customer_stage": "Pending",
  "date_approved": "",
  "date_issued": "2021-04-22",
  "date_modified": "2018-05-21T19:53:39+10:00",
  "description": "Fault/Request See customer's email.",
  "due_date": "2021-04-22",
  "id": 12345,
  "is_closed": false,
  "job_no": "",
  "name": "Switchboard upgrade",
  "notes": "",
  "order_no": "",
  "project_manager": "",
  "project_manager_id": 0,
  "quote_type": "Service",
  "salesperson": "John Smith",
  "salesperson_id": 123,
  "site_id": 12345,
  "site_name": "123 Example St",
  "stage": "InProgress",
  "status": "Sales: In-Progress",
  "status_id": 12345,
  "total_ex_tax": 1.57,
  "total_inc_tax": 1.73,
  "total_tax": 0.16,
  "validity_days": 30
}

Get site

Get a site's address, customers and notes, such as for a technician's directions.

Inputs

Sitesite_idtextRequired
The site's ID number in Simpro, from another Simpro step or the trigger.
Companycompany_idtext
Which of your Simpro companies to use. Leave blank if your build has only one.

Outputs

archivedtrue/false
Whether the site is archived
citytext
City or suburb
countrytext
Country
customerslist
The customers linked to the site
date_modifiedtext
When the site last changed (ISO 8601, in the build's time zone)
idnumber
The site's ID
nametext
The site's name
postcodetext
Postcode or ZIP code
private_notestext
Notes about the site for your staff only
public_notestext
Notes about the site that customers can see
statetext
State or region
streettext
Street address
Example output
{
  "archived": false,
  "city": "Sydney",
  "country": "AUS",
  "customers": [
    {
      "id": 12345,
      "name": "John Smith Pty Ltd"
    }
  ],
  "date_modified": "2018-05-21T19:53:39+10:00",
  "id": 12345,
  "name": "123 Example St",
  "postcode": "2000",
  "private_notes": "",
  "public_notes": "",
  "state": "NSW",
  "street": "123 Example St"
}

Update customer

Change a customer's details, or archive them. Fields left blank keep what they have.

Inputs

Company or individualcustomer_typetextRequired
Whether it is a company customer or an individual.One of: company (Company customer), individual (Individual customer).
Customercustomer_idtextRequired
The customer's ID number in Simpro, from another Simpro step or the trigger.
Company namecompany_nametext
A new name for the business.Only when Company or individual is Company customer.
Titletitletext
The person's title.Only when Company or individual is Individual customer. One of: Mr, Mrs, Miss, Ms, Dr, Sir.
First namefirst_nametext
The person's first name.Only when Company or individual is Individual customer.
Last namelast_nametext
The person's last name.Only when Company or individual is Individual customer.
Emailemailtext
Their email address.
Phonephonetext
Their phone number.
Mobilemobiletext
The person's mobile number.Only when Company or individual is Individual customer.
Websitewebsitetext
The business's website.Only when Company or individual is Company customer.
Streetstreettext
The customer's street address.
Citycitytext
The customer's city or suburb.
Statestatetext
The customer's state or region, such as NSW.
Postcodepostcodetext
The customer's postcode or ZIP code.
Countrycountrytext
The customer's country.
Private notesnotestext
Notes about the customer for your staff.
Archivearchivetext
Archive the customer, or restore one that was archived. Leave blank to keep it as it is.One of: archive (Archive it), restore (Restore it).
Companycompany_idtext
Which of your Simpro companies to use. Leave blank if your build has only one.

Outputs

alt_phonetext
Their other phone number
amount_owingnumber
How much they owe
archivedtrue/false
Whether the customer is archived
citytext
City or suburb
company_nametext
The company's name (company customers)
countrytext
Country
customer_kindtext
company or individual
customer_typetext
Customer, or Lead for a possible customer
date_createdtext
When the customer was added (ISO 8601, in the build's time zone)
date_modifiedtext
When the customer last changed (ISO 8601, in the build's time zone)
emailtext
Their email
first_nametext
The person's first name (individual customers)
idnumber
The customer's ID
last_nametext
The person's last name (individual customers)
mobiletext
The person's mobile number (individual customers)
nametext
The company's name, or the person's first and last name
notestext
Private notes about the customer
phonetext
Their phone number
postcodetext
Postcode or ZIP code
siteslist
The sites the customer is linked to
statetext
State or region
streettext
Street address
tagslist
The customer's tags
titletext
The person's title, such as Mr (individual customers)
websitetext
The company's website (company customers)
Example output
{
  "alt_phone": "",
  "amount_owing": 1.57,
  "archived": false,
  "city": "Sydney",
  "company_name": "John Smith Pty Ltd",
  "country": "AUS",
  "customer_kind": "company",
  "customer_type": "Customer",
  "date_created": "2018-05-21T19:53:39+10:00",
  "date_modified": "2018-05-21T19:53:39+10:00",
  "email": "sales@simpro.com.au",
  "first_name": "",
  "id": 12345,
  "last_name": "",
  "mobile": "",
  "name": "John Smith Pty Ltd",
  "notes": "",
  "phone": "07 1234 5678",
  "postcode": "2000",
  "sites": [
    {
      "id": 12345,
      "name": "123 Example St"
    }
  ],
  "state": "NSW",
  "street": "123 Example St",
  "tags": [],
  "title": "",
  "website": "https://simprogroup.com/au/"
}

Update job

Change a job's name, description, customer, site, due date or people. Fields left blank keep what they have. To move it on, use 'Change job stage or status'.

Inputs

Jobjob_idtextRequired
The job's ID number in Simpro, from another Simpro step or the trigger.
Namenametext
A short name for the job. Leave blank to keep it.
Descriptiondescriptiontext
What the job is for. Line breaks are kept. Leave blank to keep it.
Notesnotestext
Notes for your staff about the job. Leave blank to keep it.
Order numberorder_notext
The customer's order number.
Customercustomer_idtext
A new customer for the job: the customer's ID number in Simpro, from another Simpro step or the trigger.
Sitesite_idtext
A new site for the job: the site's ID number in Simpro, from another Simpro step or the trigger.
Due datedue_datedate
A new due date.
Due timedue_timetime
A new time of day it is due.
Salespersonsalespersontext
The employee selling it.
Project managerproject_managertext
The employee managing it.
Companycompany_idtext
Which of your Simpro companies to use. Leave blank if your build has only one.

Outputs

completed_datetext
When the job was completed (YYYY-MM-DD); empty if not set
customer_idnumber
The customer's ID
customer_nametext
The customer's name
date_issuedtext
When the job was issued (YYYY-MM-DD); empty if not set
date_modifiedtext
When the job last changed (ISO 8601, in the build's time zone)
descriptiontext
What the job is for, as plain text
due_datetext
When the job is due (YYYY-MM-DD); empty if not set
due_timetext
The time it is due (HH:MM); empty if not set
idnumber
The job's ID (its job number)
job_typetext
Service, Project or Prepaid
nametext
The job's name
notestext
The job's notes, as plain text
order_notext
The customer's order number
project_managertext
The project manager's name
project_manager_idnumber
The project manager's ID; 0 if none
quote_idnumber
The quote it was made from; 0 if none
salespersontext
The salesperson's name
salesperson_idnumber
The salesperson's ID; 0 if none
site_idnumber
The site's ID
site_nametext
The site's name
stagetext
Pending, Progress, Complete, Invoiced or Archived
statustext
Its status, as your build names it, such as Sales: In-Progress
status_idnumber
Its status's ID; 0 if none
technicianslist
The technicians on the job
total_ex_taxnumber
Its total before tax
total_inc_taxnumber
Its total including tax
total_taxnumber
The tax on it
Example output
{
  "completed_date": "",
  "customer_id": 12345,
  "customer_name": "John Smith Pty Ltd",
  "date_issued": "2021-04-22",
  "date_modified": "2018-05-21T19:53:39+10:00",
  "description": "Fault/Request See customer's email.",
  "due_date": "2021-04-22",
  "due_time": "04:22",
  "id": 12345,
  "job_type": "Service",
  "name": "Switchboard upgrade",
  "notes": "",
  "order_no": "",
  "project_manager": "",
  "project_manager_id": 0,
  "quote_id": 0,
  "salesperson": "John Smith",
  "salesperson_id": 123,
  "site_id": 12345,
  "site_name": "123 Example St",
  "stage": "Progress",
  "status": "Sales: In-Progress",
  "status_id": 12345,
  "technicians": [
    "John Smith"
  ],
  "total_ex_tax": 1.57,
  "total_inc_tax": 1.73,
  "total_tax": 0.16
}

On this page