# Simpro

> 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.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/simpro

## Actions

### 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**

- Job (`job_id`, text, required): The job's ID number in Simpro, from another Simpro step or the trigger.
- Note (`note`, text, required): What the note says. Line breaks are kept.
- Subject (`subject`, text): A short subject for the note.
- Show to the customer (`visible_to_customer`, true/false): Let the customer see the note.
- Follow-up date (`follow_up_date`, date): When to follow it up.
- Assign to (`assign_to`, text): Who should follow it up.
- Company (`company_id`, text): Which of your Simpro companies to use. Leave blank if your build has only one.

**Outputs**

- `assigned_to` (text): Their name
- `assigned_to_id` (number): Who it is assigned to; 0 if nobody
- `date_created` (text): When it was written (ISO 8601, in the build's time zone)
- `follow_up_date` (text): When to follow it up (YYYY-MM-DD); empty if not set
- `id` (number): The note's ID
- `job_id` (number): The job it is on
- `note` (text): What the note says, as plain text
- `subject` (text): The note's subject
- `submitted_by` (text): Their name
- `submitted_by_id` (number): Who wrote it; 0 if not known
- `visible_to_customer` (true/false): Whether the customer can see it

**Example output**

```json
{
  "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**

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

**Outputs**

- `completed_date` (text): When the job was completed (YYYY-MM-DD); empty if not set
- `customer_id` (number): The customer's ID
- `customer_name` (text): The customer's name
- `date_issued` (text): When the job was issued (YYYY-MM-DD); empty if not set
- `date_modified` (text): When the job last changed (ISO 8601, in the build's time zone)
- `description` (text): What the job is for, as plain text
- `due_date` (text): When the job is due (YYYY-MM-DD); empty if not set
- `due_time` (text): The time it is due (HH:MM); empty if not set
- `id` (number): The job's ID (its job number)
- `job_type` (text): Service, Project or Prepaid
- `name` (text): The job's name
- `notes` (text): The job's notes, as plain text
- `order_no` (text): The customer's order number
- `project_manager` (text): The project manager's name
- `project_manager_id` (number): The project manager's ID; 0 if none
- `quote_id` (number): The quote it was made from; 0 if none
- `salesperson` (text): The salesperson's name
- `salesperson_id` (number): The salesperson's ID; 0 if none
- `site_id` (number): The site's ID
- `site_name` (text): The site's name
- `stage` (text): Pending, Progress, Complete, Invoiced or Archived
- `status` (text): Its status, as your build names it, such as Sales: In-Progress
- `status_id` (number): Its status's ID; 0 if none
- `technicians` (list): The technicians on the job
- `total_ex_tax` (number): Its total before tax
- `total_inc_tax` (number): Its total including tax
- `total_tax` (number): The tax on it

**Example output**

```json
{
  "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**

- Quote (`quote_id`, text, required): The quote's ID number in Simpro, from another Simpro step or the trigger.
- Stage (`stage`, text): The stage to move it to. Approved means the customer has agreed to it. One of: `InProgress` (In progress), `Complete`, `Approved`.
- Status (`status`, text): The status to give it. Choosing one turns off Simpro's automatic status changes for this quote.
- Company (`company_id`, text): Which of your Simpro companies to use. Leave blank if your build has only one.

**Outputs**

- `customer_id` (number): The customer's ID
- `customer_name` (text): The customer's name
- `customer_stage` (text): Where the customer is with it: New, Pending, Declined or Accepted; empty if not set
- `date_approved` (text): When the quote was approved (YYYY-MM-DD); empty if not set
- `date_issued` (text): When the quote was issued (YYYY-MM-DD); empty if not set
- `date_modified` (text): When the quote last changed (ISO 8601, in the build's time zone)
- `description` (text): What the quote is for, as plain text
- `due_date` (text): When the quote is due (YYYY-MM-DD); empty if not set
- `id` (number): The quote's ID (its quote number)
- `is_closed` (true/false): Whether the quote is closed
- `job_no` (text): The job it became; empty if none
- `name` (text): The quote's name
- `notes` (text): The quote's notes, as plain text
- `order_no` (text): The customer's order number
- `project_manager` (text): The project manager's name
- `project_manager_id` (number): The project manager's ID; 0 if none
- `quote_type` (text): Service, Project or Prepaid
- `salesperson` (text): The salesperson's name
- `salesperson_id` (number): The salesperson's ID; 0 if none
- `site_id` (number): The site's ID
- `site_name` (text): The site's name
- `stage` (text): InProgress, Complete or Approved
- `status` (text): Its status, as your build names it, such as Sales: In-Progress
- `status_id` (number): Its status's ID; 0 if none
- `total_ex_tax` (number): Its total before tax
- `total_inc_tax` (number): Its total including tax
- `total_tax` (number): The tax on it
- `validity_days` (number): How many days the quote is valid for

**Example output**

```json
{
  "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**

- Quote (`quote_id`, text, required): The quote's ID number in Simpro, from another Simpro step or the trigger.
- Company (`company_id`, text): Which of your Simpro companies to use. Leave blank if your build has only one.

**Outputs**

- `completed_date` (text): When the job was completed (YYYY-MM-DD); empty if not set
- `customer_id` (number): The customer's ID
- `customer_name` (text): The customer's name
- `date_issued` (text): When the job was issued (YYYY-MM-DD); empty if not set
- `date_modified` (text): When the job last changed (ISO 8601, in the build's time zone)
- `description` (text): What the job is for, as plain text
- `due_date` (text): When the job is due (YYYY-MM-DD); empty if not set
- `due_time` (text): The time it is due (HH:MM); empty if not set
- `id` (number): The job's ID (its job number)
- `job_type` (text): Service, Project or Prepaid
- `name` (text): The job's name
- `notes` (text): The job's notes, as plain text
- `order_no` (text): The customer's order number
- `project_manager` (text): The project manager's name
- `project_manager_id` (number): The project manager's ID; 0 if none
- `quote_id` (number): The quote it was made from; 0 if none
- `salesperson` (text): The salesperson's name
- `salesperson_id` (number): The salesperson's ID; 0 if none
- `site_id` (number): The site's ID
- `site_name` (text): The site's name
- `stage` (text): Pending, Progress, Complete, Invoiced or Archived
- `status` (text): Its status, as your build names it, such as Sales: In-Progress
- `status_id` (number): Its status's ID; 0 if none
- `technicians` (list): The technicians on the job
- `total_ex_tax` (number): Its total before tax
- `total_inc_tax` (number): Its total including tax
- `total_tax` (number): The tax on it

**Example output**

```json
{
  "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 name (`company_name`, text, required): The business's name.
- Email (`email`, text): The business's email address.
- Phone (`phone`, text): The business's phone number.
- Website (`website`, text): The business's website.
- Street (`street`, text): The business's street address.
- City (`city`, text): The business's city or suburb.
- State (`state`, text): The business's state or region, such as NSW.
- Postcode (`postcode`, text): The business's postcode or ZIP code.
- Country (`country`, text): The business's country.
- Private notes (`notes`, text): Notes about the customer for your staff.
- Also add a site (`add_site`, true/false): Also add a site at the customer's address, ready for jobs and quotes.
- Company (`company_id`, text): Which of your Simpro companies to use. Leave blank if your build has only one.

**Outputs**

- `alt_phone` (text): Their other phone number
- `amount_owing` (number): How much they owe
- `archived` (true/false): Whether the customer is archived
- `city` (text): City or suburb
- `company_name` (text): The company's name (company customers)
- `country` (text): Country
- `customer_kind` (text): company or individual
- `customer_type` (text): Customer, or Lead for a possible customer
- `date_created` (text): When the customer was added (ISO 8601, in the build's time zone)
- `date_modified` (text): When the customer last changed (ISO 8601, in the build's time zone)
- `email` (text): Their email
- `first_name` (text): The person's first name (individual customers)
- `id` (number): The customer's ID
- `last_name` (text): The person's last name (individual customers)
- `mobile` (text): The person's mobile number (individual customers)
- `name` (text): The company's name, or the person's first and last name
- `notes` (text): Private notes about the customer
- `phone` (text): Their phone number
- `postcode` (text): Postcode or ZIP code
- `sites` (list): The sites the customer is linked to
- `state` (text): State or region
- `street` (text): Street address
- `tags` (list): The customer's tags
- `title` (text): The person's title, such as Mr (individual customers)
- `website` (text): The company's website (company customers)

**Example output**

```json
{
  "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**

- Title (`title`, text): Their title. One of: `Mr`, `Mrs`, `Miss`, `Ms`, `Dr`, `Sir`.
- First name (`first_name`, text, required): Their first name.
- Last name (`last_name`, text, required): Their last name.
- Email (`email`, text): Their email address.
- Phone (`phone`, text): Their phone number.
- Mobile (`mobile`, text): Their mobile number.
- Street (`street`, text): The person's street address.
- City (`city`, text): The person's city or suburb.
- State (`state`, text): The person's state or region, such as NSW.
- Postcode (`postcode`, text): The person's postcode or ZIP code.
- Country (`country`, text): The person's country.
- Private notes (`notes`, text): Notes about the customer for your staff.
- Also add a site (`add_site`, true/false): Also add a site at the customer's address, ready for jobs and quotes.
- Company (`company_id`, text): Which of your Simpro companies to use. Leave blank if your build has only one.

**Outputs**

- `alt_phone` (text): Their other phone number
- `amount_owing` (number): How much they owe
- `archived` (true/false): Whether the customer is archived
- `city` (text): City or suburb
- `company_name` (text): The company's name (company customers)
- `country` (text): Country
- `customer_kind` (text): company or individual
- `customer_type` (text): Customer, or Lead for a possible customer
- `date_created` (text): When the customer was added (ISO 8601, in the build's time zone)
- `date_modified` (text): When the customer last changed (ISO 8601, in the build's time zone)
- `email` (text): Their email
- `first_name` (text): The person's first name (individual customers)
- `id` (number): The customer's ID
- `last_name` (text): The person's last name (individual customers)
- `mobile` (text): The person's mobile number (individual customers)
- `name` (text): The company's name, or the person's first and last name
- `notes` (text): Private notes about the customer
- `phone` (text): Their phone number
- `postcode` (text): Postcode or ZIP code
- `sites` (list): The sites the customer is linked to
- `state` (text): State or region
- `street` (text): Street address
- `tags` (list): The customer's tags
- `title` (text): The person's title, such as Mr (individual customers)
- `website` (text): The company's website (company customers)

**Example output**

```json
{
  "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**

- Customer (`customer_id`, text, required): The customer's ID number in Simpro, from another Simpro step or the trigger.
- Site (`site_id`, text, required): Where the work is: the site's ID number in Simpro, from another Simpro step or the trigger.
- Type (`job_type`, text): What kind of job it is. Leave as Service unless it is a project or prepaid work. One of: `Service`, `Project`, `Prepaid`. Default: `Service`.
- Name (`name`, text): A short name for the job.
- Description (`description`, text): What the job is for. Line breaks are kept.
- Notes (`notes`, text): Notes for your staff about the job.
- Order number (`order_no`, text): The customer's order number.
- Issue date (`date_issued`, date): When the job is issued.
- Due date (`due_date`, date): When the job is due.
- Due time (`due_time`, time): The time of day it is due.
- Salesperson (`salesperson`, text): The employee selling it.
- Project manager (`project_manager`, text): The employee managing it.
- Company (`company_id`, text): Which of your Simpro companies to use. Leave blank if your build has only one.

**Outputs**

- `completed_date` (text): When the job was completed (YYYY-MM-DD); empty if not set
- `customer_id` (number): The customer's ID
- `customer_name` (text): The customer's name
- `date_issued` (text): When the job was issued (YYYY-MM-DD); empty if not set
- `date_modified` (text): When the job last changed (ISO 8601, in the build's time zone)
- `description` (text): What the job is for, as plain text
- `due_date` (text): When the job is due (YYYY-MM-DD); empty if not set
- `due_time` (text): The time it is due (HH:MM); empty if not set
- `id` (number): The job's ID (its job number)
- `job_type` (text): Service, Project or Prepaid
- `name` (text): The job's name
- `notes` (text): The job's notes, as plain text
- `order_no` (text): The customer's order number
- `project_manager` (text): The project manager's name
- `project_manager_id` (number): The project manager's ID; 0 if none
- `quote_id` (number): The quote it was made from; 0 if none
- `salesperson` (text): The salesperson's name
- `salesperson_id` (number): The salesperson's ID; 0 if none
- `site_id` (number): The site's ID
- `site_name` (text): The site's name
- `stage` (text): Pending, Progress, Complete, Invoiced or Archived
- `status` (text): Its status, as your build names it, such as Sales: In-Progress
- `status_id` (number): Its status's ID; 0 if none
- `technicians` (list): The technicians on the job
- `total_ex_tax` (number): Its total before tax
- `total_inc_tax` (number): Its total including tax
- `total_tax` (number): The tax on it

**Example output**

```json
{
  "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**

- Name (`name`, text, required): What the lead is called.
- Customer (`customer_id`, text, required): The customer's ID number in Simpro, from another Simpro step or the trigger.
- Site (`site_id`, text, required): Where the work would be: the site's ID number in Simpro, from another Simpro step or the trigger.
- Description (`description`, text): What the customer is asking for. Line breaks are kept.
- Notes (`notes`, text): Notes for your staff about the lead.
- Follow-up date (`follow_up_date`, date): When to follow it up.
- Salesperson (`salesperson`, text): The employee selling it.
- Company (`company_id`, text): Which of your Simpro companies to use. Leave blank if your build has only one.

**Outputs**

- `customer_id` (number): The customer's ID
- `customer_name` (text): The customer's name
- `date_created` (text): When the lead was added (YYYY-MM-DD); empty if not set
- `date_modified` (text): When the lead last changed (ISO 8601, in the build's time zone)
- `description` (text): What the lead is about, as plain text
- `follow_up_date` (text): When to follow it up (YYYY-MM-DD); empty if not set
- `id` (number): The lead's ID
- `name` (text): The lead's name
- `notes` (text): The lead's notes, as plain text
- `project_manager` (text): The project manager's name
- `project_manager_id` (number): The project manager's ID; 0 if none
- `salesperson` (text): The salesperson's name
- `salesperson_id` (number): The salesperson's ID; 0 if none
- `site_id` (number): The site's ID
- `site_name` (text): The site's name
- `stage` (text): Open or Closed
- `status` (text): Its status, as your build names it, such as Sales: In-Progress
- `status_id` (number): Its status's ID; 0 if none

**Example output**

```json
{
  "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**

- Customer (`customer_id`, text, required): The customer's ID number in Simpro, from another Simpro step or the trigger.
- Site (`site_id`, text, required): Where the work is: the site's ID number in Simpro, from another Simpro step or the trigger.
- Type (`quote_type`, text): What kind of work it is. Leave as Service unless it is a project or prepaid work. One of: `Service`, `Project`, `Prepaid`. Default: `Service`.
- Name (`name`, text): A short name for the quote.
- Description (`description`, text): What the quote is for. Line breaks are kept.
- Notes (`notes`, text): Notes for your staff about the quote.
- Order number (`order_no`, text): The customer's order number.
- Issue date (`date_issued`, date): When the quote is issued.
- Due date (`due_date`, date): When the quote is due.
- Valid for (days) (`validity_days`, number): How many days the quote stays valid. From 0 to 32767.
- Salesperson (`salesperson`, text): The employee selling it.
- Project manager (`project_manager`, text): The employee managing it.
- Company (`company_id`, text): Which of your Simpro companies to use. Leave blank if your build has only one.

**Outputs**

- `customer_id` (number): The customer's ID
- `customer_name` (text): The customer's name
- `customer_stage` (text): Where the customer is with it: New, Pending, Declined or Accepted; empty if not set
- `date_approved` (text): When the quote was approved (YYYY-MM-DD); empty if not set
- `date_issued` (text): When the quote was issued (YYYY-MM-DD); empty if not set
- `date_modified` (text): When the quote last changed (ISO 8601, in the build's time zone)
- `description` (text): What the quote is for, as plain text
- `due_date` (text): When the quote is due (YYYY-MM-DD); empty if not set
- `id` (number): The quote's ID (its quote number)
- `is_closed` (true/false): Whether the quote is closed
- `job_no` (text): The job it became; empty if none
- `name` (text): The quote's name
- `notes` (text): The quote's notes, as plain text
- `order_no` (text): The customer's order number
- `project_manager` (text): The project manager's name
- `project_manager_id` (number): The project manager's ID; 0 if none
- `quote_type` (text): Service, Project or Prepaid
- `salesperson` (text): The salesperson's name
- `salesperson_id` (number): The salesperson's ID; 0 if none
- `site_id` (number): The site's ID
- `site_name` (text): The site's name
- `stage` (text): InProgress, Complete or Approved
- `status` (text): Its status, as your build names it, such as Sales: In-Progress
- `status_id` (number): Its status's ID; 0 if none
- `total_ex_tax` (number): Its total before tax
- `total_inc_tax` (number): Its total including tax
- `total_tax` (number): The tax on it
- `validity_days` (number): How many days the quote is valid for

**Example output**

```json
{
  "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**

- Name (`name`, text, required): What the site is called, often its street address.
- Street (`street`, text): The site's street address.
- City (`city`, text): The site's city or suburb.
- State (`state`, text): The site's state or region, such as NSW.
- Postcode (`postcode`, text): The site's postcode or ZIP code.
- Country (`country`, text): The site's country.
- Customer (`customer_id`, text): Who the site belongs to: the customer's ID number in Simpro, from another Simpro step or the trigger.
- Public notes (`public_notes`, text): Notes about the site that customers can see, such as access details.
- Private notes (`private_notes`, text): Notes about the site for your staff only.
- Company (`company_id`, text): Which of your Simpro companies to use. Leave blank if your build has only one.

**Outputs**

- `archived` (true/false): Whether the site is archived
- `city` (text): City or suburb
- `country` (text): Country
- `customers` (list): The customers linked to the site
- `date_modified` (text): When the site last changed (ISO 8601, in the build's time zone)
- `id` (number): The site's ID
- `name` (text): The site's name
- `postcode` (text): Postcode or ZIP code
- `private_notes` (text): Notes about the site for your staff only
- `public_notes` (text): Notes about the site that customers can see
- `state` (text): State or region
- `street` (text): Street address

**Example output**

```json
{
  "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**

- Type (`record_type`, text, required): What kind of record it is. One of: `company_customer` (Company customer), `individual_customer` (Individual customer), `site`, `job`, `quote`, `lead`.
- Record (`record_id`, text, required): The record's ID number in Simpro, from another Simpro step or the trigger.
- Company (`company_id`, text): Which of your Simpro companies to use. Leave blank if your build has only one.

**Outputs**

- `deleted` (true/false): Always true: the record was deleted
- `id` (number): The deleted record's ID
- `record_type` (text): What kind of record it was

**Example output**

```json
{
  "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 individual (`customer_type`, text): Only company customers, or only individuals. Leave blank for both. One of: `company` (Company customer), `individual` (Individual customer).
- Name (`name`, text): Words in the customer's name: a company's name, or a person's first or last name.
- Email (`email`, text): The customer's email address, exactly.
- How many (`limit`, number): The most to list, newest first. Defaults to 25. From 1 to 100.
- Company (`company_id`, text): Which of your Simpro companies to use. Leave blank if your build has only one.

**Outputs**

- `count` (number): How many are listed
- `customers` (list): The customers found
- `total` (number): How many match in all

**Example output**

```json
{
  "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**

- Name (`name`, text): Words in the employee's name.
- Include archived (`include_archived`, true/false): Also list employees who have been archived.
- How many (`limit`, number): The most to list, in order of name. Defaults to 25. From 1 to 100.
- Company (`company_id`, text): Which of your Simpro companies to use. Leave blank if your build has only one.

**Outputs**

- `count` (number): How many are listed
- `employees` (list): The employees found
- `total` (number): How many match in all

**Example output**

```json
{
  "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**

- Paid (`paid`, text): Only paid invoices, or only those not paid yet. Leave blank for both. One of: `paid`, `unpaid` (Not paid yet).
- Customer (`customer_id`, text): The customer's ID number in Simpro, from another Simpro step or the trigger.
- Issued on or after (`issued_from`, date): Only those issued on or after this day.
- Issued on or before (`issued_to`, date): Only those issued on or before this day.
- How many (`limit`, number): The most to list, newest first. Defaults to 25. From 1 to 100.
- Company (`company_id`, text): Which of your Simpro companies to use. Leave blank if your build has only one.

**Outputs**

- `count` (number): How many are listed
- `invoices` (list): The invoices found
- `total` (number): How many match in all

**Example output**

```json
{
  "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**

- Stage (`stage`, text): Only jobs in this stage. One of: `Pending`, `Progress` (In progress), `Complete`, `Invoiced`, `Archived`.
- Customer (`customer_id`, text): The customer's ID number in Simpro, from another Simpro step or the trigger.
- Site (`site_id`, text): The site's ID number in Simpro, from another Simpro step or the trigger.
- Name (`name`, text): Words in the job's name.
- Issued on or after (`issued_from`, date): Only those issued on or after this day.
- Issued on or before (`issued_to`, date): Only those issued on or before this day.
- How many (`limit`, number): The most to list, newest first. Defaults to 25. From 1 to 100.
- Company (`company_id`, text): Which of your Simpro companies to use. Leave blank if your build has only one.

**Outputs**

- `count` (number): How many are listed
- `jobs` (list): The jobs found
- `total` (number): How many match in all

**Example output**

```json
{
  "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**

- Stage (`stage`, text): Only quotes in this stage. One of: `InProgress` (In progress), `Complete`, `Approved`.
- Customer (`customer_id`, text): The customer's ID number in Simpro, from another Simpro step or the trigger.
- Site (`site_id`, text): The site's ID number in Simpro, from another Simpro step or the trigger.
- Name (`name`, text): Words in the quote's name.
- Issued on or after (`issued_from`, date): Only those issued on or after this day.
- Issued on or before (`issued_to`, date): Only those issued on or before this day.
- How many (`limit`, number): The most to list, newest first. Defaults to 25. From 1 to 100.
- Company (`company_id`, text): Which of your Simpro companies to use. Leave blank if your build has only one.

**Outputs**

- `count` (number): How many are listed
- `quotes` (list): The quotes found
- `total` (number): How many match in all

**Example output**

```json
{
  "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**

- From (`date_from`, date): The first day to list.
- To (`date_to`, date): The last day to list.
- Employee (`staff`, text): Only this employee's bookings.
- Booked for (`schedule_type`, text): Only time booked for jobs, quotes, leads or activities. Leave blank for all. One of: `job`, `quote`, `lead`, `activity`.
- How many (`limit`, number): The most to list, newest first. Defaults to 25. From 1 to 100.
- Company (`company_id`, text): Which of your Simpro companies to use. Leave blank if your build has only one.

**Outputs**

- `count` (number): How many are listed
- `schedules` (list): The schedule entries found
- `total` (number): How many match in all

**Example output**

```json
{
  "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**

- Name (`name`, text): Words in the site's name.
- Street (`street`, text): Words in the site's street address.
- How many (`limit`, number): The most to list, newest first. Defaults to 25. From 1 to 100.
- Company (`company_id`, text): Which of your Simpro companies to use. Leave blank if your build has only one.

**Outputs**

- `count` (number): How many are listed
- `sites` (list): The sites found
- `total` (number): How many match in all

**Example output**

```json
{
  "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 individual (`customer_type`, text, required): Whether it is a company customer or an individual. One of: `company` (Company customer), `individual` (Individual customer).
- Customer (`customer_id`, text, required): The customer's ID number in Simpro, from another Simpro step or the trigger.
- Company (`company_id`, text): Which of your Simpro companies to use. Leave blank if your build has only one.

**Outputs**

- `alt_phone` (text): Their other phone number
- `amount_owing` (number): How much they owe
- `archived` (true/false): Whether the customer is archived
- `city` (text): City or suburb
- `company_name` (text): The company's name (company customers)
- `country` (text): Country
- `customer_kind` (text): company or individual
- `customer_type` (text): Customer, or Lead for a possible customer
- `date_created` (text): When the customer was added (ISO 8601, in the build's time zone)
- `date_modified` (text): When the customer last changed (ISO 8601, in the build's time zone)
- `email` (text): Their email
- `first_name` (text): The person's first name (individual customers)
- `id` (number): The customer's ID
- `last_name` (text): The person's last name (individual customers)
- `mobile` (text): The person's mobile number (individual customers)
- `name` (text): The company's name, or the person's first and last name
- `notes` (text): Private notes about the customer
- `phone` (text): Their phone number
- `postcode` (text): Postcode or ZIP code
- `sites` (list): The sites the customer is linked to
- `state` (text): State or region
- `street` (text): Street address
- `tags` (list): The customer's tags
- `title` (text): The person's title, such as Mr (individual customers)
- `website` (text): The company's website (company customers)

**Example output**

```json
{
  "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**

- Invoice (`invoice_id`, text, required): The invoice number, from another Simpro step or the trigger.
- Company (`company_id`, text): Which of your Simpro companies to use. Leave blank if your build has only one.

**Outputs**

- `amount_paid` (number): How much has been paid against it
- `balance_due` (number): How much is still owed
- `currency` (text): Its currency, such as AUD
- `customer_id` (number): The customer's ID
- `customer_name` (text): The customer's name
- `date_created` (text): When it was made (ISO 8601, in the build's time zone)
- `date_issued` (text): When it was issued (YYYY-MM-DD); empty if not set
- `date_modified` (text): When it last changed (ISO 8601, in the build's time zone)
- `date_paid` (text): When it was fully paid (YYYY-MM-DD); empty if not set
- `description` (text): Its description, as plain text
- `due_date` (text): When payment is due (YYYY-MM-DD); empty if not set
- `id` (number): The invoice number
- `internal_id` (text): The invoice's number in Simpro's own links
- `invoice_type` (text): TaxInvoice, Deposit, ProgressInvoice or RequestForClaim
- `is_paid` (true/false): Whether it is fully paid
- `job_ids` (list): The jobs it invoices
- `order_no` (text): The customer's order number
- `stage` (text): Approved, or Pending until someone approves it
- `status` (text): Its status, as your build names it, such as Sales: In-Progress
- `status_id` (number): Its status's ID; 0 if none
- `total_ex_tax` (number): Its total before tax
- `total_inc_tax` (number): Its total including tax
- `total_tax` (number): The tax on it

**Example output**

```json
{
  "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**

- Job (`job_id`, text, required): The job's ID number in Simpro, from another Simpro step or the trigger.
- Company (`company_id`, text): Which of your Simpro companies to use. Leave blank if your build has only one.

**Outputs**

- `completed_date` (text): When the job was completed (YYYY-MM-DD); empty if not set
- `customer_id` (number): The customer's ID
- `customer_name` (text): The customer's name
- `date_issued` (text): When the job was issued (YYYY-MM-DD); empty if not set
- `date_modified` (text): When the job last changed (ISO 8601, in the build's time zone)
- `description` (text): What the job is for, as plain text
- `due_date` (text): When the job is due (YYYY-MM-DD); empty if not set
- `due_time` (text): The time it is due (HH:MM); empty if not set
- `id` (number): The job's ID (its job number)
- `job_type` (text): Service, Project or Prepaid
- `name` (text): The job's name
- `notes` (text): The job's notes, as plain text
- `order_no` (text): The customer's order number
- `project_manager` (text): The project manager's name
- `project_manager_id` (number): The project manager's ID; 0 if none
- `quote_id` (number): The quote it was made from; 0 if none
- `salesperson` (text): The salesperson's name
- `salesperson_id` (number): The salesperson's ID; 0 if none
- `site_id` (number): The site's ID
- `site_name` (text): The site's name
- `stage` (text): Pending, Progress, Complete, Invoiced or Archived
- `status` (text): Its status, as your build names it, such as Sales: In-Progress
- `status_id` (number): Its status's ID; 0 if none
- `technicians` (list): The technicians on the job
- `total_ex_tax` (number): Its total before tax
- `total_inc_tax` (number): Its total including tax
- `total_tax` (number): The tax on it

**Example output**

```json
{
  "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**

- Quote (`quote_id`, text, required): The quote's ID number in Simpro, from another Simpro step or the trigger.
- Company (`company_id`, text): Which of your Simpro companies to use. Leave blank if your build has only one.

**Outputs**

- `customer_id` (number): The customer's ID
- `customer_name` (text): The customer's name
- `customer_stage` (text): Where the customer is with it: New, Pending, Declined or Accepted; empty if not set
- `date_approved` (text): When the quote was approved (YYYY-MM-DD); empty if not set
- `date_issued` (text): When the quote was issued (YYYY-MM-DD); empty if not set
- `date_modified` (text): When the quote last changed (ISO 8601, in the build's time zone)
- `description` (text): What the quote is for, as plain text
- `due_date` (text): When the quote is due (YYYY-MM-DD); empty if not set
- `id` (number): The quote's ID (its quote number)
- `is_closed` (true/false): Whether the quote is closed
- `job_no` (text): The job it became; empty if none
- `name` (text): The quote's name
- `notes` (text): The quote's notes, as plain text
- `order_no` (text): The customer's order number
- `project_manager` (text): The project manager's name
- `project_manager_id` (number): The project manager's ID; 0 if none
- `quote_type` (text): Service, Project or Prepaid
- `salesperson` (text): The salesperson's name
- `salesperson_id` (number): The salesperson's ID; 0 if none
- `site_id` (number): The site's ID
- `site_name` (text): The site's name
- `stage` (text): InProgress, Complete or Approved
- `status` (text): Its status, as your build names it, such as Sales: In-Progress
- `status_id` (number): Its status's ID; 0 if none
- `total_ex_tax` (number): Its total before tax
- `total_inc_tax` (number): Its total including tax
- `total_tax` (number): The tax on it
- `validity_days` (number): How many days the quote is valid for

**Example output**

```json
{
  "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**

- Site (`site_id`, text, required): The site's ID number in Simpro, from another Simpro step or the trigger.
- Company (`company_id`, text): Which of your Simpro companies to use. Leave blank if your build has only one.

**Outputs**

- `archived` (true/false): Whether the site is archived
- `city` (text): City or suburb
- `country` (text): Country
- `customers` (list): The customers linked to the site
- `date_modified` (text): When the site last changed (ISO 8601, in the build's time zone)
- `id` (number): The site's ID
- `name` (text): The site's name
- `postcode` (text): Postcode or ZIP code
- `private_notes` (text): Notes about the site for your staff only
- `public_notes` (text): Notes about the site that customers can see
- `state` (text): State or region
- `street` (text): Street address

**Example output**

```json
{
  "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 individual (`customer_type`, text, required): Whether it is a company customer or an individual. One of: `company` (Company customer), `individual` (Individual customer).
- Customer (`customer_id`, text, required): The customer's ID number in Simpro, from another Simpro step or the trigger.
- Company name (`company_name`, text): A new name for the business. Only when Company or individual is Company customer.
- Title (`title`, text): The person's title. Only when Company or individual is Individual customer. One of: `Mr`, `Mrs`, `Miss`, `Ms`, `Dr`, `Sir`.
- First name (`first_name`, text): The person's first name. Only when Company or individual is Individual customer.
- Last name (`last_name`, text): The person's last name. Only when Company or individual is Individual customer.
- Email (`email`, text): Their email address.
- Phone (`phone`, text): Their phone number.
- Mobile (`mobile`, text): The person's mobile number. Only when Company or individual is Individual customer.
- Website (`website`, text): The business's website. Only when Company or individual is Company customer.
- Street (`street`, text): The customer's street address.
- City (`city`, text): The customer's city or suburb.
- State (`state`, text): The customer's state or region, such as NSW.
- Postcode (`postcode`, text): The customer's postcode or ZIP code.
- Country (`country`, text): The customer's country.
- Private notes (`notes`, text): Notes about the customer for your staff.
- Archive (`archive`, text): 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).
- Company (`company_id`, text): Which of your Simpro companies to use. Leave blank if your build has only one.

**Outputs**

- `alt_phone` (text): Their other phone number
- `amount_owing` (number): How much they owe
- `archived` (true/false): Whether the customer is archived
- `city` (text): City or suburb
- `company_name` (text): The company's name (company customers)
- `country` (text): Country
- `customer_kind` (text): company or individual
- `customer_type` (text): Customer, or Lead for a possible customer
- `date_created` (text): When the customer was added (ISO 8601, in the build's time zone)
- `date_modified` (text): When the customer last changed (ISO 8601, in the build's time zone)
- `email` (text): Their email
- `first_name` (text): The person's first name (individual customers)
- `id` (number): The customer's ID
- `last_name` (text): The person's last name (individual customers)
- `mobile` (text): The person's mobile number (individual customers)
- `name` (text): The company's name, or the person's first and last name
- `notes` (text): Private notes about the customer
- `phone` (text): Their phone number
- `postcode` (text): Postcode or ZIP code
- `sites` (list): The sites the customer is linked to
- `state` (text): State or region
- `street` (text): Street address
- `tags` (list): The customer's tags
- `title` (text): The person's title, such as Mr (individual customers)
- `website` (text): The company's website (company customers)

**Example output**

```json
{
  "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**

- Job (`job_id`, text, required): The job's ID number in Simpro, from another Simpro step or the trigger.
- Name (`name`, text): A short name for the job. Leave blank to keep it.
- Description (`description`, text): What the job is for. Line breaks are kept. Leave blank to keep it.
- Notes (`notes`, text): Notes for your staff about the job. Leave blank to keep it.
- Order number (`order_no`, text): The customer's order number.
- Customer (`customer_id`, text): A new customer for the job: the customer's ID number in Simpro, from another Simpro step or the trigger.
- Site (`site_id`, text): A new site for the job: the site's ID number in Simpro, from another Simpro step or the trigger.
- Due date (`due_date`, date): A new due date.
- Due time (`due_time`, time): A new time of day it is due.
- Salesperson (`salesperson`, text): The employee selling it.
- Project manager (`project_manager`, text): The employee managing it.
- Company (`company_id`, text): Which of your Simpro companies to use. Leave blank if your build has only one.

**Outputs**

- `completed_date` (text): When the job was completed (YYYY-MM-DD); empty if not set
- `customer_id` (number): The customer's ID
- `customer_name` (text): The customer's name
- `date_issued` (text): When the job was issued (YYYY-MM-DD); empty if not set
- `date_modified` (text): When the job last changed (ISO 8601, in the build's time zone)
- `description` (text): What the job is for, as plain text
- `due_date` (text): When the job is due (YYYY-MM-DD); empty if not set
- `due_time` (text): The time it is due (HH:MM); empty if not set
- `id` (number): The job's ID (its job number)
- `job_type` (text): Service, Project or Prepaid
- `name` (text): The job's name
- `notes` (text): The job's notes, as plain text
- `order_no` (text): The customer's order number
- `project_manager` (text): The project manager's name
- `project_manager_id` (number): The project manager's ID; 0 if none
- `quote_id` (number): The quote it was made from; 0 if none
- `salesperson` (text): The salesperson's name
- `salesperson_id` (number): The salesperson's ID; 0 if none
- `site_id` (number): The site's ID
- `site_name` (text): The site's name
- `stage` (text): Pending, Progress, Complete, Invoiced or Archived
- `status` (text): Its status, as your build names it, such as Sales: In-Progress
- `status_id` (number): Its status's ID; 0 if none
- `technicians` (list): The technicians on the job
- `total_ex_tax` (number): Its total before tax
- `total_inc_tax` (number): Its total including tax
- `total_tax` (number): The tax on it

**Example output**

```json
{
  "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
}
```
