Contractor Foreman by Cotlet

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.