housecall_get_company
Get the company
Fetch the Housecall Pro company this key belongs to — name, contact details, address, time zone, service-area zip codes and (multi-location) its locations. A cheap way to confirm the key works. Housecall Pro: GET /company.
無需輸入參數。
housecall_list_customers
List customers
List or search customers, with their phone numbers, tags and addresses. `q` searches name, email, mobile number and address. Housecall Pro: GET /customers.
輸入參數qpageexpandsort_bypage_sizelocation_idssort_direction
housecall_get_customer
Get one customer
Fetch a single customer by id, including their addresses (whose ids you need to create a job or estimate). Housecall Pro: GET /customers/{customer_id}.
輸入參數expandcustomer_id必填
housecall_list_jobs
List jobs
List jobs, filterable by scheduled window, customer, assigned employees and work status. Each job carries its customer, address, notes, schedule, assigned employees and totals. Housecall Pro: GET /jobs.
輸入參數pageexpandsort_bypage_sizecustomer_idwork_statusemployee_idslocation_idssort_directionscheduled_end_maxscheduled_end_minscheduled_start_max另有 1 個
housecall_get_job
Get one job
Fetch a single job by id — customer, address, work status and timestamps, schedule, assigned employees, notes and totals. Housecall Pro: GET /jobs/{id}.
輸入參數expandjob_id必填
housecall_list_job_line_items
List a job's line items
List the line items (services, materials, labor, discounts) on one job, with unit price, cost, quantity and amount in cents. Housecall Pro: GET /jobs/{job_id}/line_items.
輸入參數job_id必填
housecall_list_job_invoices
List a job's invoices
List the invoices raised for one job, with status, amounts, due and paid dates, items, taxes, discounts and payments. Housecall Pro: GET /jobs/{job_id}/invoices.
輸入參數job_id必填
housecall_list_invoices
List invoices
List invoices across the company, filterable by status, customer, and created / due / paid date ranges — e.g. everything open and overdue. Amounts are in cents. Housecall Pro: GET /invoices.
輸入參數pagestatussort_bypage_sizedue_at_maxdue_at_minpaid_at_maxpaid_at_minlocation_idscustomer_uuidcreated_at_maxcreated_at_min另有 1 個
housecall_list_estimates
List estimates
List estimates, filterable by scheduled window, customer, assigned employees and work status. Each carries its customer, address, schedule and options. Housecall Pro: GET /estimates.
輸入參數pagesort_bypage_sizecustomer_idwork_statusemployee_idslocation_idssort_directionscheduled_end_maxscheduled_end_minscheduled_start_maxscheduled_start_min
housecall_get_estimate
Get one estimate
Fetch a single estimate by id, including its options and each option's approval status. Housecall Pro: GET /estimates/{estimate_id}.
輸入參數estimate_id必填
housecall_list_employees
List employees
List the company's active employees with their role, contact details and permissions. Use their ids to assign or dispatch jobs. Housecall Pro: GET /employees.
輸入參數pagesort_bypage_sizelocation_idssort_direction
housecall_list_leads
List leads
List leads, filterable by status (open / won / lost), customer, assigned employees, tags and lead source. Housecall Pro: GET /leads.
輸入參數pagestatussort_bytag_idspage_sizecustomer_idlead_sourceemployee_idslocation_idssort_direction
housecall_get_lead
Get one lead
Fetch a single lead by id — its customer, address, lead source, tags, assigned employee, status and pipeline status. Housecall Pro: GET /leads/{id}.
輸入參數lead_id必填
housecall_list_job_types
List job types
List the company's job types (e.g. Repair, Install, Maintenance). Use an id as job_type_id when creating a job or estimate. Housecall Pro: GET /job_fields/job_types.
輸入參數name
housecall_list_tags
List tags
List the tags defined in the company. Housecall Pro: GET /tags.
輸入參數pagesort_bypage_sizesort_direction
housecall_list_price_book_services
List price book services
List or search the price book's services — name, task number, price and cost (cents), taxable and online-booking flags; optionally with their materials and labor rates. Housecall Pro: GET /api/price_book/services.
輸入參數qpageexpandsort_bypage_sizesort_direction
housecall_create_customer
Create a customer
Create a new customer, optionally with one or more addresses. Housecall Pro: POST /customers.
輸入參數tagsemailnotescompanyaddresseslast_namefirst_namehome_numberlead_sourcework_numbermobile_numbernotifications_enabled
housecall_update_customer
Update a customer
Change a customer's name, contact details, tags, lead source, notes or notification setting. Only the fields you pass are sent. Housecall Pro: PUT /customers/{customer_id}.
輸入參數tagsemailnotescompanylast_namefirst_namecustomer_id必填home_numberlead_sourcework_numbermobile_numbernotifications_enabled
housecall_create_customer_address
Add an address to a customer
Add a service address to an existing customer. Returns the address id to use when creating a job or estimate. Housecall Pro: POST /customers/{customer_id}/addresses.
輸入參數zip必填city必填state必填street必填country必填customer_id必填street_line_2
housecall_create_job
Create a job
Create a job for an existing customer at one of their existing addresses, optionally scheduled, assigned, tagged and with line items (prices in cents). Get address ids from housecall_get_customer. Housecall Pro: POST /jobs.
輸入參數tagsnotesscheduleaddress_id必填line_itemscustomer_id必填job_type_idlead_sourceinvoice_numberbusiness_unit_idassigned_employee_ids
housecall_update_job_schedule
Reschedule a job
Set or change a job's scheduled start/end and arrival window, optionally dispatching employees and notifying the customer and/or the pro. Jobs with more than one appointment (multi-day) cannot be rescheduled here. Housecall Pro: PUT /jobs/{job_id}/schedule.
輸入參數job_id必填notifyend_timenotify_prostart_time必填dispatched_employee_idsarrival_window_in_minutes
housecall_dispatch_job
Dispatch a job to employees
Set which employees a job is dispatched to. This REPLACES the current dispatch list — pass everyone who should be on the job. Housecall Pro: PUT /jobs/{job_id}/dispatch.
輸入參數job_id必填employee_ids必填
housecall_add_job_note
Add a note to a job
Add a text note to a job. Housecall Pro: POST /jobs/{job_id}/notes.
輸入參數job_id必填content必填
housecall_create_estimate
Create an estimate
Create an estimate for a customer with one or more options (e.g. Good / Better / Best), each with line items priced in cents. Give an existing address_id or a new address. Housecall Pro: POST /estimates.
輸入參數noteaddressmessageoptionsscheduleaddress_idcustomer_id必填job_type_idlead_sourceestimate_numberbusiness_unit_idassigned_employee_ids
housecall_create_lead
Create a lead
Create a lead, either for an existing customer (customer_id) or with a new customer inline (customer). Optionally with an address, lead source, assigned employee, tags, note and line items priced in cents. Housecall Pro: POST /leads.
輸入參數notetagsaddresscustomeraddress_idline_itemscustomer_idlead_sourceassigned_employee_id