# Housecall Pro

Housecall Pro provides field service businesses with customer, job, scheduling, estimate, invoice, price book, and operational management APIs.

Category: Sales & CRM. Connect from any Opisense bot at https://www.opisense.com/integrations/housecall-pro/.

## Actions

- **Add a Line Item to a Job**: Add one pricing line item to a Housecall Pro job.
- **Add a Note to a Job**: Create a note attached to an existing Housecall Pro job.
- **Add an Attachment to a Job**: Add an attachment to a Housecall Pro job.
- **Add an Estimate Option Note**: Create a note attached to an existing Housecall Pro estimate option.
- **Add Job Tags**: Add an existing reusable tag to a Housecall Pro job.
- **Approve Estimate Options**: Irreversibly mark Housecall Pro estimate options as approved by the Pro.
- **Bulk Lock Jobs**: Irreversibly lock Housecall Pro jobs whose scheduled start or completion time falls in an inclusive time range for the requested statuses.
- **Bulk Update Estimate Option Line Items**: Bulk update line items for a Housecall Pro estimate option.
- **Bulk Update Job Input Materials**: Bulk update input materials for a Housecall Pro job.
- **Bulk Update Job Line Items**: Bulk update a Housecall Pro job's line items.
- **Convert Lead**: Irreversibly convert an existing Housecall Pro lead into either a job or an estimate and return the new resource ID.
- **Create a Lead Source**: Create a lead source for attributing customers, jobs, and leads.
- **Create a Tag**: Create a reusable tag for classifying customers, jobs, and leads.
- **Create an Address on a Customer**: Create an address on a customer.
- **Create Appointment**: Add an appointment to a Housecall Pro job.
- **Create Customer**: Create a Housecall Pro customer, optionally with addresses, tags, lead source, and notes.
- **Create Estimate**: Create a Housecall Pro estimate for a customer or address with at least one pricing option and optional tax, schedule, assigned employees,…
- **Create Estimate Option**: Add a named pricing option with optional line items and tax settings to an existing Housecall Pro estimate.
- **Create Estimate option attachment**: Create a new estimate option attachment
- **Create Estimate Option Link**: Create a link attached to an existing Housecall Pro estimate option.
- **Create Job**: Create a Housecall Pro job for an existing customer and address, optionally with a schedule, assigned employees, line items, tags, notes,…
- **Create Job Link**: Create a link attached to an existing Housecall Pro job.
- **Create Job Type**: Create a job type for classifying Housecall Pro jobs and estimates.
- **Create Lead**: Create a Housecall Pro lead for either an existing customer or an inline customer, optionally with an address, assignment, line items,…
- **Create Material**: Create a material in a Housecall Pro price book category.
- **Create Material Category**: Create a root or nested material category in the price book.
- **Create Price Form**: Create a new price form in the Housecall Pro price book.
- **Create Webhook Subscription**: Enable persistent external webhook delivery for the connected Housecall Pro company.
- **Decline Estimate Options**: Irreversibly mark one or more Housecall Pro estimate options as declined by the service professional.
- **Delete a Job Line Item**: Permanently delete one line item from a Housecall Pro job.
- **Delete Appointment**: Permanently delete one appointment from a Housecall Pro job.
- **Delete Estimate Option Note**: Permanently delete a specific note from a Housecall Pro estimate option.
- **Delete Job Note**: Permanently delete a specific note from a Housecall Pro job.
- **Delete Job Schedule**: Erase the schedule from an existing Housecall Pro job.
- **Delete Material**: Permanently delete an existing Housecall Pro price-book material.
- **Delete Material Category**: Permanently delete an existing Housecall Pro price-book material category.
- **Delete Price Form**: Permanently delete an existing Housecall Pro price form.
- **Delete Webhook Subscription**: Permanently remove the connected Housecall Pro company's persistent webhook delivery subscription and stop future company events.
- **Disable Application**: Disable the application for the connected company.
- **Dispatch Job**: Update the employees dispatched to a Housecall Pro job.
- **Enable Application**: Enable the application for the connected company.
- **Get a Customer's Address** (read-only): Get a customer's address via customer ID and address ID.
- **Get Application** (read-only): Get the application and its current state for the connected company.
- **Get Checklists** (read-only): Get one page of checklists belonging to one or more jobs or estimates.
- **Get Company** (read-only): Return the connected Housecall Pro company, its time zone, service area, address, and accessible child locations for company-context…
- **Get Customer** (read-only): Return one Housecall Pro customer by ID, including addresses and optional attachment or do-not-service details.
- **Get Estimate** (read-only): Return one Housecall Pro estimate by ID, optionally including attachments on its estimate options.
- **Get Event** (read-only): Return one Housecall Pro event by ID, including its schedule, address, tags, recurrence, and assigned employees.
- **Get Invoice** (read-only): Return one Housecall Pro invoice by UUID, including amounts, dates, line items, adjustments, payments, and its related job ID.
- **Get Job** (read-only): Return one Housecall Pro job by ID with optional attachments or appointments expanded.
- **Get Lead** (read-only): Return one Housecall Pro lead by ID with its customer, address, assigned employee, status, totals, and conversion records.
- **Get Price Form** (read-only): Get one Housecall Pro price-book price form by UUID, including its pricing fields and assignments.
- **Get Schedule Availability** (read-only): Return the connected Housecall Pro company's configured business-hour schedule windows and booking availability buffer.
- **List Booking Windows** (read-only): Return currently available Housecall Pro booking windows for an optional date range, service, price form, duration, or employee set.
- **List Customer Addresses** (read-only): Return one page of service and billing addresses for a Housecall Pro customer, including address IDs used by job and estimate tools.
- **List Customers** (read-only): Search and return one page of customers by name, email, phone number, or address.
- **List Employees** (read-only): Page through active employees for assignment and scheduling decisions.
- **List Estimate Option Line Items** (read-only): Return one page of pricing line items for an estimate option.
- **List Estimates** (read-only): Filter and return one page of estimates by schedule, employee, customer, work status, location, and sort order.
- **List Events** (read-only): Filter and return one page of company events.
- **List Invoices** (read-only): Filter and return one page of invoices by location, status, customer, dates, amount due, payment method, and sort order.
- **List Job Appointments** (read-only): Return the scheduled appointments and assigned employees for one job.
- **List Job Input Materials** (read-only): List all input materials recorded for one Housecall Pro job.
- **List Job Invoices** (read-only): Return all invoices associated with one Housecall Pro job.
- **List Job Line Items** (read-only): Return all line items and pricing details for one Housecall Pro job.
- **List Job Types** (read-only): Return one page of job types, optionally filtered by name, for job and estimate classification.
- **List Jobs** (read-only): Filter and return one page of jobs by schedule, employee, customer, work status, location, and sort order.
- **List Lead Line Items** (read-only): Return one page of pricing line items for a lead.
- **List Lead Sources** (read-only): Search and return one page of lead sources available for attribution, including whether each source is editable.
- **List Leads** (read-only): Filter and return one page of leads by employee, customer, status, tags, source, location, and sort order.
- **List Material Categories** (read-only): Page through root-level price-book material categories or categories under a selected parent.
- **List Materials** (read-only): Page through price-book materials under a material category.
- **List Pipeline Statuses** (read-only): Return one page of configured pipeline statuses for leads, jobs, or estimates.
- **List Price Book Services** (read-only): Search and page through price-book services used for job pricing and service-specific booking availability.
- **List Price Forms** (read-only): Page through active price-book price forms and their pricing fields.
- **List Routes** (read-only): Return one page of company routes for a date, including grouped employees, job appointments, events, and estimates.
- **List Service Zones** (read-only): Page through service zones, optionally filtering by ZIP code or address, for customer intake and serviceability checks.
- **List Tags** (read-only): Page through the company's reusable tags for customer, job, and lead classification.
- **Lock Job**: Irreversibly lock a Housecall Pro job by ID and return the locked job.
- **Preview Invoice by UUID** (read-only): Preview a specific Housecall Pro invoice by UUID as an HTML file.
- **Remove Job Tag**: Remove a tag from a Housecall Pro job.
- **Update a Job Line Item**: Update one existing line item on a Housecall Pro job.
- **Update a Job Type**: Update the name of a job type used to classify jobs and estimates.
- **Update a Tag**: Update the name of an existing reusable tag.
- **Update Appointment**: Replace the schedule and assigned employees for an existing Housecall Pro job appointment.
- **Update Customer**: Update editable contact, notification, tag, lead-source, or note fields on an existing Housecall Pro customer.
- **Update Estimate Option Schedule**: Replace the schedule, notification settings, and assigned employees for a Housecall Pro estimate option.
- **Update Franchise Info**: Update territory-management, franchisee-identifier, or custom external metadata for the connected Housecall Pro company.
- **Update Job Schedule**: Update the supplied schedule, notification, or dispatched-employee fields on a Housecall Pro job.
- **Update Lead Source**: Update the name of a Housecall Pro lead source marked as editable.
- **Update Material**: Update information for an existing Housecall Pro price-book material.
- **Update Material Category**: Update the name of an existing price-book material category.
- **Update Pipeline Status**: Irreversibly move a Housecall Pro lead, job, or estimate to a pipeline status with an equal or higher order value.
- **Update Price Form**: Update settings, assignments, and nested pricing fields on an existing Housecall Pro price form.
- **Update Schedule Availability**: Replace the connected Housecall Pro company's daily business-hours windows and minimum booking buffer.
