# Housecall Pro

> Read Housecall Pro jobs, customers, estimates, leads and invoices, and manage customer details and addresses.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/housecall-pro

## Actions

### Create customer

Create customer.

**Inputs**

- First name (`first_name`, text): first_name.
- Last name (`last_name`, text): last_name.
- Email (`email`, text): email.
- Company (`company`, text): company.
- Notifications enabled (`notifications_enabled`, true/false): Will the customer receive notifications
- Mobile number (`mobile_number`, text): mobile_number.
- Home number (`home_number`, text): home_number.
- Work number (`work_number`, text): work_number.
- Tags (`tags`, list): tags.
- Lead source (`lead_source`, text): lead_source.
- Notes (`notes`, text): notes.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "addresses": [],
    "attachments": [],
    "company": "",
    "company_id": "",
    "company_name": "",
    "created_at": "",
    "do_not_service": false,
    "email": "",
    "first_name": "",
    "home_number": "",
    "id": "",
    "last_name": "",
    "lead_source": "",
    "mobile_number": "",
    "notes": "",
    "notifications_enabled": false,
    "tags": [],
    "updated_at": "",
    "work_number": ""
  },
  "has_more": false,
  "next_cursor": null
}
```

### Create customer address

Create customer address.

**Inputs**

- Customer id (`customer_id`, text, required): customer_id.
- Street (`street`, text, required): street.
- Street line 2 (`street_line_2`, text): street_line_2.
- City (`city`, text, required): city.
- State (`state`, text, required): state.
- Zip (`zip`, text, required): zip.
- Country (`country`, text, required): country. One of: `AF` (Afghanistan), `AX` (Åland Islands), `AL` (Albania), `DZ` (Algeria), `AD` (Andorra), `AO` (Angola), `AI` (Anguilla), `AQ` (Antarctica), `AG` (Antigua & Barbuda), `AR` (Argentina), and 239 more.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "city": "",
    "country": "",
    "id": "",
    "state": "",
    "street": "",
    "street_line_2": "",
    "type": "billing",
    "zip": ""
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get company

Get company.

**Inputs**: None.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "address": {
      "city": "",
      "country": "",
      "latitude": 0,
      "longitude": 0,
      "state": "",
      "street": "",
      "street_line_2": "",
      "zip": ""
    },
    "default_arrival_window": "",
    "franchise_info": {
      "franchisor_depth": 0,
      "metadata": {},
      "root_franchisor_id": ""
    },
    "id": "",
    "locations": [],
    "logo_url": "",
    "name": "",
    "phone_number": "",
    "service_areas_data": {
      "zip_codes": []
    },
    "support_email": "",
    "time_zone": "",
    "website": ""
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get customer

Get customer.

**Inputs**

- Customer id (`customer_id`, text, required): customer_id.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "addresses": [],
    "attachments": [],
    "company": "",
    "company_id": "",
    "company_name": "",
    "created_at": "",
    "do_not_service": false,
    "email": "",
    "first_name": "",
    "home_number": "",
    "id": "",
    "last_name": "",
    "lead_source": "",
    "mobile_number": "",
    "notes": "",
    "notifications_enabled": false,
    "tags": [],
    "updated_at": "",
    "work_number": ""
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get estimate

Get estimate.

**Inputs**

- Estimate id (`estimate_id`, text, required): estimate_id.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "address": {
      "city": "",
      "country": "",
      "id": "",
      "state": "",
      "street": "",
      "street_line_2": "",
      "type": "billing",
      "zip": ""
    },
    "assigned_employees": [],
    "assigned_route_template_id": "",
    "company_id": "",
    "company_name": "",
    "created_at": "",
    "customer": {
      "company": "",
      "company_id": "",
      "company_name": "",
      "created_at": "",
      "email": "",
      "first_name": "",
      "home_number": "",
      "id": "",
      "last_name": "",
      "lead_source": "",
      "mobile_number": "",
      "notes": "",
      "notifications_enabled": false,
      "tags": [],
      "updated_at": "",
      "work_number": ""
    },
    "estimate_fields": {
      "business_unit": {},
      "job_type": {}
    },
    "estimate_number": "",
    "id": "",
    "lead_source": "",
    "options": [],
    "schedule": {
      "appointments": [],
      "arrival_window": 0,
      "scheduled_end": "",
      "scheduled_end_local": "",
      "scheduled_start": "",
      "scheduled_start_local": "",
      "time_zone": ""
    },
    "updated_at": "",
    "work_status": "",
    "work_timestamps": {
      "completed_at": "",
      "on_my_way_at": "",
      "started_at": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get event

Get event.

**Inputs**

- Event id (`event_id`, text, required): event_id.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "address": {
      "city": "",
      "state": "",
      "street": "",
      "street_line_2": "",
      "zip": ""
    },
    "all_day": false,
    "assigned_employees": [],
    "company_id": "",
    "company_name": "",
    "created_at": "",
    "id": "",
    "name": "",
    "note": "",
    "recurrence_rule": "",
    "schedule": {
      "end_time": "",
      "start_time": "",
      "time_zone": ""
    },
    "tags": [],
    "updated_at": ""
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get invoice

Get invoice.

**Inputs**

- Uuid (`uuid`, text, required): The UUID of the invoice to retrieve

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "amount": 0,
    "discounts": [],
    "display_due_concept": "",
    "due_amount": 0,
    "due_at": "",
    "due_concept": "",
    "id": "",
    "invoice_date": "",
    "invoice_number": "",
    "items": [],
    "job_id": "",
    "paid_at": "",
    "payments": [],
    "sent_at": "",
    "service_date": "",
    "status": "",
    "subtotal": 0,
    "taxes": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get job

Get job.

**Inputs**

- Id (`id`, text, required): The ID of the job

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "address": {
      "city": "",
      "country": "",
      "id": "",
      "state": "",
      "street": "",
      "street_line_2": "",
      "type": "billing",
      "zip": ""
    },
    "assigned_employees": [],
    "assigned_route_template_id": "",
    "attachments": [],
    "canceled_at": "",
    "company_id": "",
    "company_name": "",
    "created_at": "",
    "customer": {
      "company": "",
      "company_id": "",
      "company_name": "",
      "created_at": "",
      "email": "",
      "first_name": "",
      "home_number": "",
      "id": "",
      "last_name": "",
      "lead_source": "",
      "mobile_number": "",
      "notes": [],
      "notifications_enabled": false,
      "tags": [],
      "updated_at": "",
      "work_number": ""
    },
    "deleted_at": "",
    "description": "",
    "id": "",
    "invoice_number": "",
    "job_fields": {
      "business_unit": {},
      "job_type": {}
    },
    "lead_source": "",
    "locked_at": "",
    "notes": [],
    "original_estimate_id": "",
    "original_estimate_uuids": [],
    "outstanding_balance": 0,
    "recurrence_id": "",
    "recurrence_number": 0,
    "recurrence_rule": "",
    "recurrence_status": "active",
    "schedule": {
      "appointments": [],
      "arrival_window": 0,
      "scheduled_end": "",
      "scheduled_end_local": "",
      "scheduled_start": "",
      "scheduled_start_local": "",
      "time_zone": ""
    },
    "subtotal": 0,
    "tags": [],
    "total_amount": 0,
    "updated_at": "",
    "work_status": "needs scheduling",
    "work_timestamps": {
      "completed_at": "",
      "on_my_way_at": "",
      "started_at": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get lead

Get lead.

**Inputs**

- Id (`id`, text, required): id.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "address": {
      "city": "",
      "id": "",
      "state": "",
      "street": "",
      "street_line_2": "",
      "zip": ""
    },
    "assigned_employee": {
      "avatar_url": "",
      "color_hex": "",
      "company_id": "",
      "company_name": "",
      "created_at": "",
      "email": "",
      "first_name": "",
      "id": "",
      "last_name": "",
      "mobile_number": "",
      "permissions": {},
      "role": "",
      "tags": []
    },
    "company_id": "",
    "company_name": "",
    "conversions": [],
    "customer": {
      "company": "",
      "email": "",
      "first_name": "",
      "home_number": "",
      "id": "",
      "last_name": "",
      "lead_source": "",
      "mobile_number": "",
      "notifications_enabled": false,
      "tags": [],
      "work_number": ""
    },
    "id": "",
    "job_fields": {
      "business_unit_uuid": "",
      "job_type_uuid": ""
    },
    "lead_source": "",
    "lost_at": "",
    "number": 0,
    "pipeline_status": "",
    "status": "lost",
    "tags": [],
    "total_amount": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List customer addresses

List customer addresses.

**Inputs**

- Customer id (`customer_id`, text, required): customer_id.
- Page (`page`, number): Paginated page number.
- Page size (`page_size`, number): Number of addresses returned per page.
- Sort by (`sort_by`, text): Address attribute to sort by. One of: `created_at`, `updated_at`.
- Sort direction (`sort_direction`, text): Ascending or descending. One of: `desc`, `asc`.

**Outputs**: Result.

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "addresses": [],
    "page": 1,
    "total_pages": 1
  },
  "has_more": false,
  "next_cursor": null
}
```

### List customers

List customers.

**Inputs**

- Q (`q`, text): A query that can be used to search for a customer by name, email, mobile number and address.
- Page (`page`, number): Current Page
- Page size (`page_size`, number): Number of customers per page
- Sort by (`sort_by`, text): Customer attribute to sort by
- Sort direction (`sort_direction`, text): Ascending or descending. One of: `asc`, `desc`.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "customers": [],
    "page": 0,
    "page_size": 0,
    "total_items": 0,
    "total_pages": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List employees

List employees.

**Inputs**

- Page (`page`, number): Current page
- Page size (`page_size`, number): Number of employees per page
- Sort by (`sort_by`, text): employee attribute to sort_by
- Sort direction (`sort_direction`, text): Ascending or descending

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "employees": [],
    "page": 0,
    "page_size": 0,
    "total_items": 0,
    "total_pages": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List estimates

List estimates.

**Inputs**

- Scheduled start min (`scheduled_start_min`, date and time): Filters estimates with a starting time greater than or equal to the date sent.
- Scheduled start max (`scheduled_start_max`, date and time): Filters estimates with a starting time less than or equal to the date sent.
- Page (`page`, text): Paginated page number.
- Work status (`work_status`, list): Work status filter. Returns estimates from all statuses if empty. One or more of: `unscheduled`, `scheduled`, `in_progress`, `completed`, `canceled`.
- Page size (`page_size`, number): Number of estimates returned per page.
- Sort direction (`sort_direction`, text): Order of estimates returned. One of: `asc`, `desc`.
- Sort by (`sort_by`, text): Attribute to sort by. One of: `created_at`, `updated_at`, `id`.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "estimates": [],
    "page": 0,
    "page_size": 0,
    "total_items": 0,
    "total_pages": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List events

List events.

**Inputs**

- Page (`page`, number): Paginated page number
- Page size (`page_size`, number): Number of events returned per page.
- Sort by (`sort_by`, text): Event attribute to sort by. One of: `name`, `note`, `created_at`, `updated_at`, `street`, `street_line_2`, `city`, `state`, `zip`.
- Sort direction (`sort_direction`, text): Ascending or descending. One of: `asc`, `desc`.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "events": [],
    "page": 0,
    "page_size": 0,
    "total_items": 0,
    "total_pages": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List invoices

List invoices.

**Inputs**

- Created at min (`created_at_min`, date and time): Filters invoices with a created_at greater than or equal to the input date
- Created at max (`created_at_max`, date and time): Filters invoices with a created_at less than or equal to the input date
- Page (`page`, number): Paginated page number. At least 1.
- Page size (`page_size`, text): Number of invoices returned per page.
- Sort by (`sort_by`, text): sort_by. One of: `amount`, `created_at`, `due_amount`, `due_at`, `invoice_number`, `paid_at`, `sent_at`, `status`, `updated_at`.
- Sort direction (`sort_direction`, text): sort_direction. One of: `asc`, `desc`.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "invoices": [],
    "page": 0,
    "page_size": 0,
    "total_items": 0,
    "total_pages": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List job types

List job types.

**Inputs**: None.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "job_types": [],
    "page": 0,
    "page_size": 0,
    "total_items": 0,
    "total_pages": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List jobs

List jobs.

**Inputs**

- Scheduled start min (`scheduled_start_min`, date and time): Filters jobs with a starting time greater than or equal to the date sent.
- Scheduled start max (`scheduled_start_max`, date and time): Filters jobs with a starting time less than or equal to the date sent.
- Page (`page`, text): Paginated page number.
- Work status (`work_status`, list): Work status filter. Returns jobs from all statuses if empty. One or more of: `unscheduled`, `scheduled`, `in_progress`, `completed`, `canceled`.
- Page size (`page_size`, number): Number of jobs returned per page.
- Sort direction (`sort_direction`, text): sort_direction. One of: `asc`, `desc`.
- Sort by (`sort_by`, text): Attribute to sort by. One of: `created_at`, `updated_at`, `invoice_number`, `id`, `description`, `work_status`.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "jobs": [],
    "page": 0,
    "page_size": 0,
    "total_items": 0,
    "total_pages": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List lead sources

List lead sources.

**Inputs**

- Q (`q`, text): A query that can be used to search for a lead source by name
- Page (`page`, number): Current Page
- Page size (`page_size`, number): Number of lead sources per page
- Sort direction (`sort_direction`, text): Ascending or descending. One of: `asc`, `desc`.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "lead_sources": [],
    "page": 0,
    "page_size": 0,
    "total_items": 0,
    "total_pages": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### List leads

List leads.

**Inputs**

- Page (`page`, text): Paginated page number.
- Page size (`page_size`, number): Number of jobs returned per page.
- Sort direction (`sort_direction`, text): sort_direction. One of: `asc`, `desc`.
- Sort by (`sort_by`, text): Attribute to sort by. One of: `created_at`, `updated_at`, `id`, `status`.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "leads": [],
    "page": 0,
    "page_size": 0,
    "total_items": 0,
    "total_pages": 0
  },
  "has_more": false,
  "next_cursor": null
}
```

### Update customer

Update customer.

**Inputs**

- Customer id (`customer_id`, text, required): customer_id.
- First name (`first_name`, text): first_name.
- Last name (`last_name`, text): last_name.
- Email (`email`, text): email.
- Company (`company`, text): company.
- Notifications enabled (`notifications_enabled`, true/false): Will the customer receive notifications
- Mobile number (`mobile_number`, text): mobile_number.
- Home number (`home_number`, text): home_number.
- Work number (`work_number`, text): work_number.
- Tags (`tags`, list): tags.
- Lead source (`lead_source`, text): lead_source.
- Notes (`notes`, text): notes.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "addresses": [],
    "attachments": [],
    "company": "",
    "company_id": "",
    "company_name": "",
    "created_at": "",
    "do_not_service": false,
    "email": "",
    "first_name": "",
    "home_number": "",
    "id": "",
    "last_name": "",
    "lead_source": "",
    "mobile_number": "",
    "notes": "",
    "notifications_enabled": false,
    "tags": [],
    "updated_at": "",
    "work_number": ""
  },
  "has_more": false,
  "next_cursor": null
}
```
