add_change_order_items
Add change order items
Adds priced line items to a change order or change order request.
Adds line items at the end of the change order's first section: name, type (material, labor, equipment, subcontractor, other), quantity, unit, unit cost in dollars and markup percent. The app computes totals. Returns the saved items and the new total.
输入参数items必填change_order_id必填
add_estimate_items
Add estimate items
Adds priced line items to an existing estimate.
Adds line items at the end of an estimate section (the first one unless section_id says otherwise). Each item has a name, a type (material, labor, equipment, subcontractor, other), quantity, unit, your unit cost in dollars and a markup percent. Contractor Foreman computes the totals. cost_code_id comes from list_cost_codes. Returns the saved items and the new estimate total.
输入参数items必填section_idestimate_id必填
add_invoice_items
Add invoice items
Adds priced line items to an invoice.
Adds plain priced lines at the end of an invoice: name, type, quantity, unit, unit cost in dollars, markup percent. Items billed from an estimate, change order or schedule of values are added in the app. Returns the saved items, the new total and the balance due.
输入参数items必填invoice_id必填
add_project_note
Add project note
Adds a note to a project's Notes tab.
Writes a note on a Contractor Foreman project's Notes tab as the signed-in user, with an optional title. It is visible to the company's users with access to the project. Nobody is notified. Returns the saved note.
输入参数text必填titleproject_id必填
Records a vendor bill with its line items, optionally against a project.
Enters a bill from a vendor in Contractor Foreman: the vendor's invoice number, bill and due date, subject, notes and line items (description, quantity, unit, unit cost, cost type). With a project_id the cost shows in that project's job costing. The bill starts Open and nothing is paid or sent. Returns the saved bill.
输入参数items必填notesnumber必填subjectdue_datebill_datevendor_id必填project_id
create_change_order
Create change order
Creates a change order or change order request on a project, with line items.
Saves a new change order (status open) or change order request (status draft) on a project, for the project's customer. description records the reason. items are priced lines (name, type, quantity, unit, unit cost in dollars, markup percent, cost code). The app computes the total. Nothing is sent. send_change_order emails it after your OK, update_change_order sets the status.
输入参数datekinditemstitle必填numberproject_id必填description
create_contact
Create contact
Adds a customer, employee, contractor, vendor or misc contact to the Directory.
Creates a Contractor Foreman Directory record as the Add drawer does. Employees need a first and last name, contractors and vendors a company name, the others a name or a company. The record gets no app access and nobody is invited or emailed. Giving an employee a login stays a step in the app. Returns the new contact_id.
输入参数zipcellcitytype必填emailphonestateaddress1address2last_namefirst_namecompany_name
create_daily_log
Create daily log
New daily log on a project: work notes, people, deliveries, weather notes and delays.
Adds a daily log to the project for the date you give (arrival 07:00 unless you say otherwise) and returns it as get_daily_log shows it. Contractor Foreman records the weather for the date and the project address itself, and weather_notes sits next to it. notes must not be empty. people takes a headcount per crew or free text. The log reaches no client or crew and update_daily_log can edit it, so this tool runs without asking. One project can have several logs on one date: check list_daily_logs first.
输入参数date必填notes必填peoplevisitorsproject_id必填arrival_timejobsite_notesweather_delayweather_notesdeparture_timeschedule_delaymaterials_delivered
create_estimate
Create estimate
Creates a draft estimate on a project or for a customer, with priced line items.
Saves a new estimate in the Estimating status, unit-price billing, dated today. With project_id it belongs to that project and its customer. Without one, customer_id is required. items are priced lines (name, type, quantity, unit, unit cost in dollars, markup percent, cost code). The app computes totals. Nothing is sent: send_estimate does that after your OK. More lines later with add_estimate_items, other fields with update_estimate.
输入参数itemstitle必填exclusionsinclusionsproject_idcustomer_iddescriptionexpire_date
create_expense
Create expense
Records an expense (receipt, purchase, fee) with amount, date, vendor and project.
Enters an expense in Contractor Foreman as the signed-in user: name, amount, date, vendor, project, cost type, reason and whether it is billable to the customer. The project is required by the app, and the expense shows in that project's job costing. No receipt file is attached. Returns the saved expense.
输入参数datename必填typeamount必填reasonbillablevendor_idproject_id必填
create_inspection
Create inspection
Logs an inspection on a project with type, date, agency, inspector and notes.
Creates a Contractor Foreman inspection in Draft status on a project: inspection type, day, agency (internal, county, city or independent agency), inspector and notes. record_inspection_result sets pass, fail or re-inspect afterwards. Nobody is notified. Returns the saved inspection.
输入参数datetype必填notesagencyproject_id必填inspected_by
create_invoice
Create invoice
Creates a draft invoice for a project or customer, with priced line items.
Saves a new invoice in the Draft status. With project_id it bills that project's customer. Without one, customer_id is required. A description needs due_date in the same call. items are plain priced lines (name, type, quantity, unit, unit cost in dollars, markup percent). It is not sent. update_invoice with status submitted marks it sent and lets record_payment take payments. send_invoice emails it after your OK.
输入参数itemsnumberdue_dateproject_idcustomer_iddescriptioninvoice_date
Adds a sales lead with contact details and a pipeline stage.
Creates a lead in the Contractor Foreman Directory as the Leads Add drawer does: a name or a company, contact details, address and the stage (received by default). Nobody is emailed. Returns the new contact_id, which list_leads and get_contact read.
输入参数zipcellcityemailphonestagestateaddress1address2last_namefirst_namecompany_name
create_opportunity
Create opportunity
Adds a sales opportunity for a customer with stage, score, budget and expected sale date.
Creates an opportunity in Contractor Foreman as the Opportunities Add drawer does, for a customer from the Directory. It is assigned to the signed-in user. Nobody is emailed. The opportunity number must be unique. Without one it gets OPP- and the UTC date and time (OPP-261021-1213). Returns the saved opportunity.
输入参数zipcityname必填scorestagestatebudgetnumberaddress1customer_id必填project_typeest_sales_date
create_project
Create project
New project for a customer, with number, type, stage, address and dates.
Adds a project in the stage you give (default pending) for a customer from your Directory. Without number the account's next project number is used. Accounts that number projects by hand need one. The project reaches nobody outside your company, so this tool runs without asking. Returns the project as get_project shows it.
输入参数zipcityname必填typestatenumberstatusstreetstreet2end_datestart_datecustomer_id必填另有 1 个
create_punchlist
Create punchlist
New, empty punchlist on a project.
Adds an empty punchlist to the project and returns it as get_punchlist shows it. Items cannot be added through this tool yet, so add them in Contractor Foreman. Nobody is assigned or notified, so this tool runs without asking.
输入参数name必填project_id必填
create_purchase_order
Create purchase order
Creates a draft purchase order to a supplier with line items, optionally for a project.
Creates a Contractor Foreman purchase order in Draft status, ordered by the signed-in user: subject, supplier, project, order date, notes and line items (description, quantity, unit, unit cost, cost type). The supplier is not notified. Sending the PO stays a step in the app. Returns the saved order.
输入参数items必填notessubject必填vendor_id必填order_dateproject_id
Drafts a request for information on a project, with the question and a reply-by date.
Creates a Contractor Foreman RFI in Draft status on a project, from the signed-in user, dated now: title, question, the area and plan sheet it refers to and the date a response is needed by. It is not sent to anyone. Submitting it to the architect or owner stays a step in the app. Returns the saved RFI.
输入参数title必填question必填plan_sheetproject_id必填reference_arearesponse_needed_by
create_service_ticket
Create service ticket
Opens a service ticket for a customer, optionally scheduled for a date and time.
Creates a Contractor Foreman service ticket for a customer from the Directory: title, description, an optional project and the planned service date and time. The service address is the customer's (or the project's). With a date it is Scheduled, without one Unscheduled. Technicians are assigned in the app. The customer is not notified. Returns the saved ticket, with service_time on the 12-hour clock (02:00 PM).
输入参数title必填project_idcustomer_id必填descriptionservice_dateservice_time
create_share_link
Create share link
Makes a short internal link that opens an estimate, change order or invoice for your signed-in team.
The panel's Share Internal Link: a short URL that opens the record in the Contractor Foreman app. Only people who sign in to your Contractor Foreman company can open it. It is not a public page for the customer. To get a document to the customer, send_estimate, send_change_order and send_invoice email the PDF.
输入参数record_id必填record_type必填
create_sub_contract
Create sub-contract
Creates a draft sub-contract with a subcontractor on a project.
Creates a Contractor Foreman sub-contract in Draft status, issued by the signed-in user, for a project and a subcontractor from the Directory, with subject, agreement number and date. This API cannot add scope items, terms or send it for signature. Those stay steps in the app. The subcontractor is not notified. Returns the saved sub-contract.
输入参数datesubject必填project_id必填contractor_id必填agreement_number必填
New to-do, optionally on a project, with due date, priority and assignees.
Adds a to-do and returns it as get_todo shows it. Assignees see it in their Contractor Foreman app.
输入参数name必填due_datedue_timepriorityproject_iddescriptionassignee_ids
create_work_order
Create work order
Creates an Open work order on a project with subject, description and dates.
Creates a Contractor Foreman work order in Open status on a project, issued by the signed-in user, for the project's customer: subject, description, start and end date. It has no line items. Nobody is notified, and sending it to the customer stays a step in the app. update_work_order_status moves it on. Returns the saved order.
输入参数subject必填end_dateproject_id必填start_datedescription
delete_change_order
Delete change order
Deletes a change order or change order request for good.
Deletes the change order and its items. It cannot be undone. To keep the record, use update_change_order with status denied instead.
输入参数change_order_id必填
delete_estimate
Delete estimate
Deletes an estimate for good.
Deletes the estimate and its line items, as Delete in the estimate's menu does. Records made from it (projects, change orders, invoices) stay. It cannot be undone. To keep the history, use update_estimate with status lost instead.
输入参数estimate_id必填
delete_invoice
Delete invoice
Deletes an invoice that has no payments, for good.
Deletes the invoice and its items. It cannot be undone. An invoice with payments recorded is refused. For that one, or to keep the record, use update_invoice with status write_off or denied.
输入参数invoice_id必填
One vendor bill with its line items, dates, total, balance due and status.
Reads one Contractor Foreman bill by bill_id: what list_bills gives plus the payment terms and every line item with description, cost type, quantity, unit, unit cost, total and cost code.
输入参数bill_id必填
get_change_order
Get change order
One change order or request with description, status, total and line items.
Everything on one change order or change order request: number, title, status, project, customer, date, the reason (description), the estimate it came from, time delay and the priced line items.
输入参数change_order_id必填
get_clock_status
Get clock status
Who is clocked in right now, whether you are, and this and last week's crew hours.
Reads the Contractor Foreman Time Cards dashboard: the employees clocked in at this moment with their project and clock-in time, whether the signed-in user is clocked in (and that card's id), and the regular, overtime and total hours of the whole team and of the signed-in user for this week and last.
无需输入参数。
One Directory record in full: contact details, status, services, terms and additional contacts.
Reads one Contractor Foreman Directory record by contact_id: everything list_contacts gives plus a second phone, fax, website, status, services, tags, default payment terms, referral source, the date it was added and the additional contacts kept under it. For leads also stage and quality. Login details, wages and personal ids of employees are left out.
输入参数contact_id必填
get_daily_log
Get daily log
One daily log: work notes, people and visitors, materials, equipment, weather and delays.
Returns one daily log in full: the work performed, crew notes and employees on site, visitors, materials, equipment used with hours, the weather Contractor Foreman recorded for the date and the address (temperatures in both scales, the day's conditions), your weather notes and any weather or schedule delay. Read only.
输入参数daily_log_id必填
One estimate with customer, dates, terms, totals and every line item.
Everything on one estimate: status, project, customer contact, estimate and expiry dates, billing type, description, inclusions, exclusions, terms, totals in dollars and the line items by section (type, quantity, unit, unit cost, markup, total, cost code). section_id is what add_estimate_items takes to put new items in a section.
输入参数estimate_id必填
One expense with amount, date, vendor, project, cost type, cost code and reason.
Reads one Contractor Foreman expense by expense_id: what list_expenses gives plus the cost code and the reason written on it.
输入参数expense_id必填
get_inspection
Get inspection
One inspection with type, project, date, result, agency, inspector and notes.
Reads one Contractor Foreman inspection by inspection_id, with the same fields as list_inspections.
输入参数inspection_id必填
One invoice with customer, dates, terms, line items, payments and balance due.
Everything on one invoice: status, project, customer and their email, invoice and due dates, terms, retainage, total, amount paid and balance due in dollars, the line items and every payment recorded against it (date, amount, method, status).
输入参数invoice_id必填
get_job_costing
Get job costing
Estimated and actual cost per cost code for one project, with the difference and totals.
Sums the project's Job Cost Actual report per cost code: contract value, estimated cost (from the Schedule of Values or the approved estimates, plus change orders), actual cost split into bills, expenses, time cards and equipment, the difference (estimated minus actual, negative means over) and the amount invoiced. Time card hours are priced at labor_rate (default burden_rate). Costs with no cost code are under Unassigned. Amounts are in dollars. Read only.
输入参数labor_rateproject_id必填budget_from
get_opportunity
Get opportunity
One opportunity in full: customer contact, stage, score, budget, notes and last activity.
Reads one Contractor Foreman opportunity by opportunity_id: what list_opportunities gives plus the customer's email and phone, the notes and the subject of the last sales activity.
输入参数opportunity_id必填
One project: customer, address, stage, dates, contract amounts, costs, billing and retainage.
Returns one project. The revised contract amount is the original contract plus approved change orders, as the project shows it. Costs are budgeted, committed and actual. Billing is invoiced, paid and outstanding invoices, with retainage held shown apart. Amounts are in dollars. Use project_id from list_projects.
输入参数project_id必填
get_punchlist
Get punchlist
One punchlist: project, address, customer and how many items are open and completed.
Returns one punchlist with its project, the project address and customer, the number of open and completed items, who made it and when. The items themselves are not returned yet: open the punchlist in Contractor Foreman to see them. Read only.
输入参数punchlist_id必填
get_purchase_order
Get purchase order
One purchase order with supplier, dates, status and its line items.
Reads one Contractor Foreman purchase order by purchase_order_id: what list_purchase_orders gives plus every line item with description, cost type, quantity, unit, unit cost, total and cost code.
输入参数purchase_order_id必填
One RFI with its question, dates, answer and status.
Reads one Contractor Foreman RFI by rfi_id, with the same fields as list_rfis.
输入参数rfi_id必填
get_service_ticket
Get service ticket
One service ticket with customer, service address, schedule, technicians and priority.
Reads one Contractor Foreman service ticket by service_ticket_id: what list_service_tickets gives plus the priority, planned duration, service address, the customer's phone and the hours logged on it.
输入参数service_ticket_id必填
get_sub_contract
Get sub-contract
One sub-contract with subcontractor, amounts, retainage, scope of work and items.
Reads one Contractor Foreman sub-contract by sub_contract_id: what list_sub_contracts gives plus the scope of work text (HTML as saved) and the items added in the app, with quantity, unit cost, total and cost code. paid and balance come back null here. list_sub_contracts has them.
输入参数sub_contract_id必填
get_submittal
Get submittal
One submittal with plan sheet, specification section, status, dates and its items.
Reads one Contractor Foreman submittal by submittal_id: what list_submittals gives plus the plan sheet and specification section and each submitted item with manufacturer, status and the date it was sent back.
输入参数submittal_id必填
get_time_card
Get time card
One time card or crew sheet with hours per employee and cost code.
Reads one Contractor Foreman time card by timecard_id: what list_time_cards gives plus one entry per employee and cost code with the hours worked and the entry's notes. A crew sheet lists every crew member.
输入参数timecard_id必填
One to-do: description, project, priority, status, due date, assignees and checklist.
Returns one to-do with its description, due date and time, assignees and checklist items. Read only.
输入参数todo_id必填
get_work_order
Get work order
One work order with project, customer, status, dates, location, notes and items.
Reads one Contractor Foreman work order by work_order_id: what list_work_orders gives plus the location, notes and line items with quantity, unit cost and total.
输入参数work_order_id必填
Vendor bills with vendor, project, dates, total, balance due and status.
Reads the Contractor Foreman Bills list, newest first: bill number, subject, vendor, project, bill date, due date, total, balance still due and status (Open, Paid). Filter by project or search. get_bill adds the line items.
输入参数limitcursorsearchproject_id
list_change_orders
List change orders
Change orders and change order requests, newest first, with status, project and total.
The Change Orders list: number, title, kind (change_order or request), status, project, customer, date and total in dollars. Filter by project, kind, status or a search over title and number. Archived ones only with include_archived. Change orders have the statuses open, pending_approval, on_hold, approved, denied, billed. Requests have draft, on_hold, approved, denied, closed. A status that does not fit the kind stops the call. get_change_order gives the line items.
输入参数kindlimitcursorsearchstatusproject_idinclude_archived
list_contacts
List contacts
Customers, employees, contractors, vendors and misc contacts from the Directory.
Reads the Contractor Foreman Directory: active contacts with their type, name, company, title, email, phone, cell and address. Filter by type or search by name, company, email or phone. contact_id is the id other tools ask for as customer_id, vendor_id, contractor_id or employee_id. Leads have their own tool, list_leads.
输入参数typelimitcursorsearch
list_cost_codes
List cost codes
The company's cost codes, to put on estimate, change order and invoice items.
Every active cost code with its code number, name and parent group. cost_code_id is what the item tools take. search narrows by code or name.
输入参数search
list_cost_items
List cost items
Saved cost items with unit, unit cost and markup, to price estimate and change order lines.
The Cost Items Database: name, type, unit, your unit cost in dollars, default markup, cost code, SKU and notes. Use the values as line items in create_estimate, add_estimate_items or create_change_order. Filter by type or a name search. Subcontractor and other items are picked out of each page of all items, so such a page can hold fewer than limit. Keep the cursor going until next_cursor is null.
输入参数typelimitcursorsearch
list_daily_logs
List daily logs
Daily logs by date, optionally for one project and a date range.
Returns daily logs in the order of the Daily Logs list, with date, arrival time, project and who wrote them, and total, the count of logs that match. Filter by project and by from/to dates (both inclusive). get_daily_log gives one log in full: notes, people, materials, equipment and the weather. Pages hold up to 100 logs; pass next_cursor back as cursor.
输入参数tofromlimitcursorsearchproject_id
list_estimates
List estimates
Estimates, newest first, with status, project, customer and total.
The Estimates list: number, title, status, project, customer, dates and total in dollars. Filter by project, status or a search over title, number and customer. Archived estimates only with include_archived. get_estimate gives the line items.
输入参数limitcursorsearchstatusproject_idinclude_archived
list_expenses
List expenses
Expenses with amount, date, vendor, project, cost type and who paid.
Reads the Contractor Foreman Expenses list, last added first: name, amount with tax, date, vendor, project, cost type (Material, Labor, Equipment ..), who paid it and through what, and whether it is billable to the customer. Filter by project or search.
输入参数limitcursorsearchproject_id
list_inspections
List inspections
Inspections with project, type, date, result, agency and permit number.
Reads the Contractor Foreman Inspections list, newest first: number, inspection type, project, date and time, status (Draft, Pass, Fail, Re-Inspect), agency, inspector, permit number, assignee and notes. Filter by project or search.
输入参数limitcursorsearchproject_id
list_invoices
List invoices
Invoices, newest first, with status, totals, balance due and an overdue flag.
The Invoices list: number, status (draft, submitted, on_hold, paid, denied, write_off), project, customer, invoice and due dates, total and balance due in dollars, and overdue (past the due date with a balance). Archived invoices are left out. unpaid_only keeps submitted and on-hold invoices that still have a balance. status, when given, replaces the unpaid_only status filter. unpaid_only and due_before filter the page you get, so a page can hold fewer than limit. Keep the cursor going until next_cursor is null. get_invoice gives the items and payments.
输入参数limitcursorsearchstatusdue_beforeproject_idcustomer_idunpaid_only
Sales leads with contact details, stage and quality score.
Reads the active leads in the Contractor Foreman Directory: name, company, email, phone, address, stage (received, pending, qualifying, qualified, quoted, awarded, lost) and quality from 1 to 5. Search by name, company, email or phone. Opportunities (deals tied to a customer) are list_opportunities.
输入参数limitcursorsearch
list_opportunities
List opportunities
Sales opportunities with customer, stage, score, budget and expected sale date.
Reads the Contractor Foreman Opportunities list: deals for a customer before they turn into a project, at every stage, with number, name, stage (received, pending, qualifying, qualified, quoted, awarded, lost), score 1 to 5, budget in the account currency, estimated sales date and who it is assigned to. Search by name, number or customer.
输入参数limitcursorsearch
list_payments
List payments
Payments received on invoices, newest first, with amount, method and invoice.
The Payments list: date, amount in dollars, method, status (received, in_review, verified, failed), notes, the invoice it pays, customer and project. get_invoice shows the payments of one invoice.
输入参数limitcursorproject_idcustomer_id
list_project_crew_hours
List project crew hours
Hours and labor cost logged on one project, per employee and per day and cost code.
Reads the time logged on a Contractor Foreman project (the project's Time Cards tab): every entry with the day, employee, cost code, regular and overtime hours and labor cost, plus a sum per employee (most hours first) and the project total. days counts the distinct days an employee logged. Cost uses the wages in the Directory and is 0 when no wage is set. Optional date range.
输入参数end_dateproject_id必填start_date
list_project_files
List project files
Photos and documents on a project, with name, size and a download link.
Reads a Contractor Foreman project's Files tab, newest first: file name, title, whether it is an image, size, notes, tags, when it was added and a download link. The app signs the links and they expire about 30 days after the call (the expires parameter). Call again for fresh ones.
输入参数project_id必填
list_project_notes
List project notes
The notes on a project's Notes tab, with author and time.
Reads the notes kept on a Contractor Foreman project's Notes tab, oldest first: title, text, who added it, when (in the account's date format) and how many files are attached.
输入参数project_id必填
list_projects
List projects
Projects with customer, stage, dates, contract amount, costs and percent complete.
Returns active (not archived) projects in the order of the Projects list. Completed projects are left out unless include_completed is true or status asks for them. search matches the project name, number or customer. Amounts are in the account's currency: contract amount without tax, budgeted, committed and actual cost, invoiced and paid. Pages hold up to 100 projects; pass next_cursor back as cursor.
输入参数limitcursorsearchstatusinclude_completed
list_punchlists
List punchlists
Punchlists with project, status, open and completed item counts and who the items are assigned to.
Returns punchlists, optionally for one project, with the number of open and completed items and the people their items are assigned to. status is the one the Punchlists list shows. Pages hold up to 100 punchlists; pass next_cursor back as cursor.
输入参数limitcursorsearchproject_id
list_purchase_orders
List purchase orders
Purchase orders with supplier, project, order date, total and status.
Reads the Contractor Foreman Purchase Orders list, newest first: PO number, subject, supplier, project, order and delivery date, total, status (Draft, Submitted, Approved, Received, Closed ..) and who ordered it. Filter by project or search. get_purchase_order adds the line items.
输入参数limitcursorsearchproject_id
Requests for information with question, project, dates, answer and status.
Reads the RFIs in Contractor Foreman's RFI & Notices module, newest first: number, title, the question, area and plan sheet it refers to, project, date, response needed by, response received, the answer and status (Draft, Submitted, Outstanding, Received, Closed). Schedule and compliance notices from the same module are left out, so a page can hold fewer than limit. Filter by project or search.
输入参数limitcursorsearchproject_id
list_schedule_tasks
List schedule tasks
Gantt schedule tasks of a project: dates, duration, dependencies, assignees, percent complete.
Returns the tasks of the project schedule in Gantt order. kind is task, milestone or summary (a group whose dates follow its subtasks). end_date is the task's last day, inclusive. depends_on lists the tasks this one waits for, with the link type and lag in days. Use task_id with update_schedule_task. An empty list means the project has no schedule yet.
输入参数project_id必填
list_service_tickets
List service tickets
Service tickets with customer, status, service date and time and technicians.
Reads the Contractor Foreman Service Tickets list, newest first: ticket number, title, description, status (Unscheduled, Scheduled, En Route, Checked-In, Completed ..), customer, project, service date and time and the assigned technicians. Filter by project or search.
输入参数limitcursorsearchproject_id
list_sub_contracts
List sub-contracts
Sub-contracts with subcontractor, project, amount, billed, paid, balance and status.
Reads the Contractor Foreman Sub-Contracts list, newest first: agreement number, subject, subcontractor, project, date, contract total, amount billed and paid, balance, retainage percent and status (Draft, Submitted, Committed, Approved ..). Filter by project or search.
输入参数limitcursorsearchproject_id
list_submittals
List submittals
Submittals with project, status, date received, due date and approver.
Reads the Contractor Foreman Submittals list, newest first: number, title, project, status (Draft, Submitted, Pending, Response Received, Approved, Rejected), date received, due date, who it is assigned to and who approved it. Filter by project or search.
输入参数limitcursorsearchproject_id
list_time_cards
List time cards
Time cards with employee or crew, project, clock-in and clock-out times and hours, newest first.
Reads the Contractor Foreman Time Cards list, newest first: employee cards and crew sheets with the project, day, clock-in and clock-out time, hours worked and break hours. A card still running has running true and no hours yet. Filter by a date range, a project or an employee. get_time_card gives one card's entries per person and cost code.
输入参数limitcursorend_dateproject_idstart_dateemployee_id
To-dos with project, priority, status, due date and assignees.
Returns to-dos, optionally for one project, one status (open, incomplete, complete) or only those assigned to you. get_todo gives one with its description and checklist. Pages hold up to 100 to-dos; pass next_cursor back as cursor.
输入参数limitcursorsearchstatusmine_onlyproject_id
list_work_orders
List work orders
Work orders with project, customer, status, dates, total and assignee.
Reads the Contractor Foreman Work Orders list, newest first: number, subject, description, project, customer, status (Open, Estimating, Submitted, Approved, Canceled, Completed), start and end date, total and who it is assigned to. Filter by project or search.
输入参数limitcursorsearchproject_id
record_inspection_result
Record inspection result
Marks an inspection passed, failed or to re-inspect, optionally with notes.
Sets the status of a Contractor Foreman inspection to pass, fail, re_inspect or back to draft, as the status field on its page does, and optionally replaces its notes (corrections the inspector asked for). Nobody is notified. Returns the inspection as saved.
输入参数notesresult必填inspection_id必填
record_payment
Record payment
Records a payment you received against an invoice.
Adds a payment to an invoice, as Add Payment does: amount in dollars, method (bank_transfer, cash, check, credit_card, other), date, status (received, in_review, verified, failed) and notes. It only records money already received. It charges nobody and emails nobody. The invoice must be submitted (update_invoice) and the amount cannot exceed the balance due. A payment that clears the balance marks the invoice paid.
输入参数datenotesamount必填method必填statusinvoice_id必填
remove_estimate_items
Remove estimate items
Deletes line items from an estimate.
Deletes the given line items (item_id from get_estimate) and returns the new estimate total. An item_id that is not on the estimate stops the call before anything is deleted. The app refuses while the estimate is pending_approval, approved or completed: set it back to estimating with update_estimate first.
输入参数item_ids必填estimate_id必填
send_change_order
Send change order
Emails the change order as a PDF to the customer or to the addresses you give.
Sends the change order (or request) PDF by email from Contractor Foreman, as the panel's View/Email PDF does. Without to it goes to the project's customer, and a customer without an email stops the call. The status does not change: update_change_order sets pending_approval or approved.
输入参数tocopy_memessagesubjectchange_order_id必填
send_estimate
Send estimate
Emails the estimate as a PDF to the customer or to the addresses you give.
Sends the customer version of the estimate PDF by email from Contractor Foreman, as the panel's View/Email PDF does. Without to it goes to the estimate's customer, and a customer without an email stops the call. The estimate's status does not change. update_estimate sets it (pending_approval, approved).
输入参数tocopy_memessagesubjectestimate_id必填
Emails the invoice as a PDF to the customer or to the addresses you give.
Sends the invoice PDF by email from Contractor Foreman, as the panel's View/Email PDF does. Without to it goes to the invoice's customer, and a customer without an email stops the call. The invoice needs a due date (update_invoice). Sending does not change the status: update_invoice with status submitted marks it sent.
输入参数tocopy_memessagesubjectinvoice_id必填
update_change_order
Update change order
Changes a change order's status, title, reason or date.
Sets only the fields you pass. Change order statuses: open, pending_approval, on_hold, approved (Unbilled/Approved, counts toward the contract), denied, billed. Change order request statuses: draft, on_hold, approved, denied, closed. A status of the other kind stops the call. Nobody is emailed. send_change_order does that.
输入参数datetitlestatusdescriptionchange_order_id必填
update_daily_log
Update daily log
Change the notes, times, people, deliveries, weather notes or delays of a daily log.
Replaces only the fields you pass and returns the log as get_daily_log shows it. Text fields are replaced, not appended: read the log first to add to its notes. materials_delivered replaces the material notes. weather_delay, schedule_delay and visitors can mark a delay or a visit but not clear it. The log date and project do not change. The log reaches no client or crew, so this tool runs without asking.
输入参数notespeoplevisitorsarrival_timedaily_log_id必填jobsite_notesweather_delayweather_notesdeparture_timeschedule_delaymaterials_delivered
update_estimate
Update estimate
Changes an estimate's status, title, dates, description, inclusions or exclusions.
Sets only the fields you pass. status moves the estimate on the Estimates board: estimating, pending_approval, on_hold, re_estimating, approved, completed or lost. Marking it approved here does not email anyone. send_estimate sends it. Line items change with add_estimate_items and remove_estimate_items.
输入参数titlestatusexclusionsinclusionsdescriptionestimate_id必填expire_dateestimate_date
update_invoice
Update invoice
Changes an invoice's status, invoice date, due date or description.
Sets only the fields you pass. Statuses: draft, submitted (sent to the customer, payments can be recorded), on_hold, paid, denied, write_off. Contractor Foreman needs a due date on every change, so an invoice without one needs due_date in the same call. Nobody is emailed. send_invoice does that.
输入参数statusdue_dateinvoice_id必填descriptioninvoice_date
update_project
Update project
Change a project's name, stage, type, address, dates or description.
Changes only the fields you pass and returns the project as get_project shows it. A completed project drops out of list_projects unless include_completed is true. Editing the schedule can move the project dates again. Nothing reaches the customer, so this tool runs without asking.
输入参数zipcitynametypestatestatusstreetstreet2end_dateproject_id必填start_datedescription
update_schedule_task
Update schedule task
Change the name, dates, length or percent complete of a task on the project schedule.
Changes one task and returns it as the schedule shows it afterwards. start_date alone moves the task and keeps its length; end_date or duration_days change the length. Tasks that depend on it are not moved: check depends_on in list_schedule_tasks and move them too. The project's start and end dates follow the schedule. A schedule edit reaches nobody outside your company and one more call undoes it, so this tool runs without asking.
输入参数nametask_id必填end_dateproject_id必填start_dateduration_dayspercent_complete
update_service_ticket_status
Update service ticket status
Moves a service ticket to scheduled, en route, checked in, completed, closed and so on.
Sets the status of a Contractor Foreman service ticket as the status field on its page does: unscheduled, scheduled, en_route, checked_in, requires_followup, canceled, completed or closed. The app's own en-route and completion emails to the customer are separate buttons and are not sent. Completed moves the service date to today, as the app does. Returns the ticket as saved.
输入参数status必填service_ticket_id必填
Change a to-do's name, description, due date, priority or status, e.g. mark it complete.
Changes only the fields you pass and returns the to-do as get_todo shows it. status complete closes it, open reopens it. Assignees and checklist items are not changed. Nothing is sent to anyone, so this tool runs without asking.
输入参数namestatustodo_id必填due_datedue_timeprioritydescription
update_work_order_status
Update work order status
Moves a work order to open, estimating, submitted, approved, canceled or completed.
Sets the status of a Contractor Foreman work order as the status field on its page does. The status in the answer is the label the company uses for it. Nobody is emailed. Returns the work order as saved.
输入参数status必填work_order_id必填