MCP App Store
by KeenEthics
BuildPass icon

BuildPass MCP Server for ChatGPT

By BuildPass Inc

Overview

Bring your construction business into your AI conversations with BuildPass. Connect project management, site operations and finance so you can spend less time on admin and more time building. Ask questions across your projects, prepare reports, manage tasks and documents, create estimates and track budgets. Turn conversations into action with the context of your construction business behind every request. Sign in with your existing BuildPass account and authorize access.

How to connect

  1. ChatGPT: Open the BuildPass listing in the ChatGPT app directory and choose Connect. ChatGPT listing BuildPass exposes 286 tools here.

Tools

appendActionUpdate

ChatGPT
Append an update to an action/task activity thread. Preserves the description and other action fields and records an authored timestamped update. Appending also triggers notifications to the action's current assignees. Requires a message, at least one file, or both. Does not edit status, priority, due date, location, or assignees.

appendDefectUpdate

ChatGPT
Append an update to a defect activity thread using the same behavior as BuildPass "Send update". Preserves the description and other defect fields. Mentions can notify mentioned admin users, but this operation does not notify every assignee or send the defect itself. Requires a message, at least one file, or both.

appendRFIComment

ChatGPT
Append a comment to an RFI conversation without changing the formal question or other RFI fields. Non-draft comments trigger the RFI activity workflow for respondents and watchers; draft comments are stored without that workflow. Requires a message, at least one file, or both.

archiveRecords

ChatGPT
Archive one recordType; attachments follow actions, defects, forms, notices, register items and diaries. formResponse is a submission; template is its reusable definition. Per-record outcomes; stop at first failure. Cascades: subcontractor (SWMS, insurance, SDS, documents, prequalifications, integrations), meetingType (active meetings), permit (reminders), template (resource links; company defaults cannot be archived). Only meetingType, notice, permit, register, registerItem, workflow can be restored; toolbox is deleted. Configured workflows may send email or SMS.

archiveSubmittal

ChatGPT
Archive one Submittal by exact ID and cancel its approval flow. Only DRAFT or VOID Submittals can be archived; OPEN or CLOSED records must already be VOID. Archived records can be restored, but their cancelled approval flow is not reinstated.

archiveToolboxInvite

ChatGPT
Archive one toolbox invite identified by toolboxId plus adminUserId or workerId.

completeFormResponse

ChatGPT
Complete or submit an existing canonical form response as-is, matching Core UI completion. May notify linked-action assignees and run configured workflows or integration syncs. Does not fill answers or edit the reusable template. Omitted completedAt uses server completion time. Returns the completed-response report destination; validation, permission, and lifecycle failures remain errors.

completeSubmittal

ChatGPT
Send the final approved package for one Submittal to its distribution list, closing it first if still open. Requires a final approval decision. Emails real recipients once and cannot be recalled. Already distributed records are returned unchanged. The to and cc arrays replace all recipients for this send. Always emails; to close without distributing, set the Submittal status to CLOSED instead.

createActions

ChatGPT
Create up to 50 project actions/tasks per call, including imports from files or pasted content. A one-item items array creates one action. Non-atomic: successful rows persist when others fail, with row-level failures returned. Top-level fields are defaults; row values override them. Initial assignees may be notified. type and priorityType require exact project-configured labels; assignees require canonical IDs.

createAddressBookContacts

ChatGPT
Create standalone address-book contacts without a Company record. company is an optional free-text label, not a Company ID. projectIds scopes directory entries to projects; omit for global contacts. An existing email reuses its directory entry; supplied company and projectIds replace those values, and an archived entry is restored. Does not add RFI participants or send notifications. Returned entity IDs are contact IDs for RFI participants. Per-item outcomes; the first failure stops the rest.

createCertifications

ChatGPT
Add certifications to workers' profiles for the builder, one per item. BuildPass recommends workers upload their own from their phone: it stays in their wallet across builders, they get expiry reminders, and it is reviewed. One added here is Builder Generated: hidden from the worker, marked reviewed by the user, and skips the automatic check. Suits a user asking to add one for a worker, especially one without their own login. Requiring a certification on the project prompts a worker with their own profile to add it at their next sign-on. Per-item outcomes; the first failure stops the rest.

createContacts

ChatGPT
Create subcontractor contacts, one per item. Per-item outcomes; the first failure stops the rest. Omitted optional fields stay blank; projectIds initially links a contact to those projects. isPrimaryContact true clears the previous primary contact.

createDashboards

ChatGPT
Create reporting dashboards, one per item, each with a title and optional description, initial project scope, and access rules. Per-item outcomes; the first failure stops the rest. Omitted optional fields stay unset. Widget configuration happens in the UI, not through this tool.

createDefects

ChatGPT
Create up to 50 defects/punch list items/snags per call, including imports from files or pasted rows. A one-item items array creates one defect. Non-atomic: successful rows persist when others fail, with row-level failures. Row values override top-level defaults. Files attach uploads, gallery photos, or existing BuildPass files. Assignees may be notified when creation notifications are enabled; otherwise defects remain pending an explicit send.

createDocumentFolders

ChatGPT
Create document, drawing, or gallery-photo folders, one per item, at the root or inside a folder in the same scope. Per-item outcomes; the first failure stops the rest. A child needs the returned ID of its parent, so nested structures take one call per level. Use subcontractor_documents for the UI Other Documents area. visibleToWorkers shares a document or drawing folder and its contents with workers; omit it for gallery_photos.

createDocuments

ChatGPT
Create document records from files, one per item. The first failure stops remaining items. documentScope PROJECT requires projectId; COMPANY omits projectId. Omitted linked IDs stay unset.

createEmergencies

ChatGPT
Create emergency alerts, one per item. Per-item outcomes; the first failure stops the rest. workerIds and visitorIds define the initial recipients to notify; omitting them sends no emergency messages.

createFeedbackSubmission

ChatGPT
Submit explicit Agent product feedback directly to BuildPass support without opening support chat. Use when the user asks to send feedback, report an Agent problem, or contact support about the Agent. Creates an internal Pylon issue with the verified current user as requester and returns the real submission reference. Do not submit feedback speculatively without an explicit user request or agreement.

createFormResponses

ChatGPT
Create response shells from saved reusable templates, one per item, for inspections, checklists, or form submissions. The first failure stops remaining items. Omitted completedAt leaves the response in progress; completed responses may run completion, intake, and integration workflows. Does not fill answers. Returns a suggested Open navigation action for each row.

createGalleryPhotos

ChatGPT
Add uploaded images to project galleries, one per item. Requires completed upload keys and their matching projectId, fileName, contentType, and fileSize after the image bytes have been PUT to the upload URL. Returns attachment IDs with per-item outcomes; the first failure stops remaining items. Images only; does not create document records or attach files to other records.

createInsurance

ChatGPT
Create insurance documents, one per item. Per-item outcomes; the first failure stops the rest. Omitted optional fields stay unset.

createLocations

ChatGPT
Create one or more project locations (areas/rooms/zones/levels/units, up to 50 per call) used to organize and filter records by place, from plans, PDFs, spreadsheets, CSVs, prose, or pasted lists. Use a one-item items array for a single location. Split larger imports into 50-row calls. Non-atomic: successful rows persist when others fail, and results include row-level failures. Top-level parentId acts as the default parent; row parentId values override it. Nesting under a location created in the same call requires a second call using the returned ID.

createMeetingTypeTemplate

ChatGPT
Create and attach a blank TOOLBOX template to a Meeting v2 meeting type. AGENDA defines agenda fields in toolbox.templateResponse; MEETING defines meeting-specific fields in toolbox.meetingTemplateResponse. Replaces any existing template link of the selected kind. Does not author the template structure.

createMeetingTypes

ChatGPT
Create Meeting v2 meeting type records, one per item. Returns per-item outcomes; the first failure stops remaining items. Does not create or attach agenda or meeting templates.

createNotices

ChatGPT
Create notice/pre-start wrapper records with linked template responses, one per item. The first failure stops remaining items. Linked responses use template default answers; template.completedAt defaults to now unless supplied. Does not author response answers. Completing the linked response can trigger configured workflows and integrations, including external messages.

createPermits

ChatGPT
Create permits for workers, one per item. Per-item outcomes; the first failure stops the rest. workerIds becomes the initial worker set, and every supplied worker is notified immediately after the permit is created. Permit application template responses are authored in the permit UI, not here.

createProjectSwmsFromLibrary

ChatGPT
Create project method statement records from exact IDs of existing library documents using Core API library-copy rules. Copies existing library records; does not generate or submit new method statement content.

createProjects

ChatGPT
Queue one or more BuildPass projects for creation in the connected user's active builder context using Core API authorization. This accepts the fields Core API bulk creation currently applies: name, address, status, and project contacts. Use a single-row projects array for one project. Creation is asynchronous through the Core API bulk-create worker, so this tool returns the queued count and does not return created project IDs, latitude/longitude, or completion proof.

createRFIs

ChatGPT
Create up to 50 RFIs per call from files, pasted tables, or prose. A one-item items array creates one RFI. Non-atomic: successful rows persist when others fail, with row-level failures. Row values override top-level defaults. Omitted status defaults to DRAFT. OPEN rows receive numbers according to project numbering settings and notify respondents and watchers.

createRegister

ChatGPT
Create one live BuildPass register and its linked editable field definition. The setup choice is irreversible: blank is general-purpose; libraryBacked requires an active REGISTER_TYPE LibraryTemplate ID. Company-managed items require libraryBacked setup. A reusable template alone is not a live register. Failures can report partially created records and inspection details.

createRegisterItemBookings

ChatGPT
Create booking rows for register items, one per item. Per-item outcomes; the first failure stops the rest. This does not modify the register items' other fields.

createRegisterItemTypes

ChatGPT
Create register item types, one per item. Per-item outcomes; the first failure stops the rest. linkedChecklistIds sets the initial linked checklist set when supplied.

createRegisterItems

ChatGPT
Create up to 50 register items per call, including imports from files or pasted content. identifierPrefix identifies the live register; the server resolves its canonical ID and templates. fieldUpdates require actual field IDs or labels, value shapes, and options from its field definition; raw template JSON is unsupported. Non-atomic: valid rows persist when others fail, with repairable row failures. Row values override top-level defaults. Configured register workflows may send email or SMS.

createSchedule

ChatGPT
Create a new blank schedule shell for a project when the user explicitly wants a blank schedule container. This creates the schedule title only. Schedule item generation, review assumptions, and publishing are separate from this blank shell.

createSds

ChatGPT
Create SDS documents, one per item. Per-item outcomes; the first failure stops the rest. projectIds sets the initial linked projects.

createSelfMessage

ChatGPT
Send an email or SMS to the signed-in user only; cannot send to other people. emailHtml supplies designed email content and message supplies the matching plain-text version. BuildPass delivers the supplied message through its notification system.

createSignOns

ChatGPT
Create manual site-attendance sign-on records, each for one worker on one project. Returns per-item outcomes; the first failure stops remaining items. May reuse an existing active sign-on for the same worker and project. Does not read attendance or sign workers off. Configured attendance workflows may send email or SMS.

createSiteDiaries

ChatGPT
Create Site Diary records with default embedded response shells, one per item. kind daily (default) creates a daily diary; supplementary creates a sub-log with its supplementary templateId, attaching to or creating the parent daily diary for that date. The first failure stops remaining items. Does not fill response answers. Creating a main diary also schedules client-portal sharing when enabled for the project. Configured daily-log workflows may send email or SMS and enabled integrations may sync the log.

createSubcontractors

ChatGPT
Create up to 50 subcontractors/companies/vendors in the current builder per call, including imports from files or pasted vendor lists, CSVs, spreadsheets, PDFs, or tables. A one-item items array creates one company. Non-atomic: successful rows persist when others fail; returns created counts and row-level failures. Each row requires companyEmail.

createSubmittalDrafts

ChatGPT
Create up to 50 draft Submittals per call, including manual entry and imports from files or pasted tables. Accepts submitter, intake mode, documents, reference files, due date, and an approval plan or template. Type keys and approval template IDs must match builder configuration. Drafts require a submitter and approval plan before opening. Top-level fields are defaults for rows that omit them. Non-atomic: rows can partially fail. Does not open, send, close, or distribute.

createSubmittalOpenAndSend

ChatGPT
Open the named Submittals and email each subcontractor a portal link to their own items. Sends real email to external recipients and cannot be recalled. Recipients must belong to the selectable contacts in the current package send-preview groups. The recipients array replaces all recipients for this send; omitted contacts receive nothing. Blocked or excluded Submittals are skipped and reported.

createSubmittalPackages

ChatGPT
Create Submittal Packages, one per item, optionally attaching existing Submittals or creating simple placeholder draftItems. confirmMoveExistingSubmittals true allows replacing existing package assignments. Per-item outcomes; the first failure stops the rest. Within an item the package is created first, so a move or draft can fail after it exists: resolve with its returned ID rather than creating another package. This does not open, send, close, distribute, share, or create public links.

createSubmittalRevision

ChatGPT
Request a new revision of one Submittal: closes the current revision and opens the next against the same approval stages, notifying the submitter to resubmit. Requires OPEN or CLOSED status and a latest decision of Revise and Resubmit or Rejected. The optional note goes to the submitter.

createSubmittalsFromLogTemplate

ChatGPT
Create draft Submittals from selected published log-template item IDs, matching the apply-template dialog. Each draft records its source template. packageMode NONE (default) leaves them unpackaged; NEW puts them in one new package (packageTitle, packageSpecificationSection, packageDescription); EXISTING adds them to existingPackageId on this project. Opening later requires a company, submitter, submission due date, and approval template. Does not open or send.

createTimesheetEntries

ChatGPT
Create timesheet entry wrapper records for workers, one per item. The first failure stops remaining items. timeType and costCode require exact configured labels and codes. Datetimes are absolute ISO with the project offset. templateResponse creates or links an embedded response; completedAt defaults to now. Does not subsequently edit response answers. Configured workflows may send email or SMS; APPROVED_1 can also notify secondary approvers.

createToolboxInvites

ChatGPT
Create one or more toolbox invites for workers/admin users. Use a one-item adminUserIds or workerIds array for a single invite. This appends invites for the supplied users and skips duplicates; it does not replace the existing invite roster.

createToolboxPreStarts

ChatGPT
Create pre-start notices from toolbox talk content, starting today in the project's timezone for numberOfDays. The toolbox's scheduled date is not used. Per-item outcomes; the first failure stops the rest. Creating the linked responses can trigger configured workflows and integrations, including external messages.

createToolboxes

ChatGPT
Create toolbox talks/Meeting v2 meetings, one per item. Per-item outcomes; the first failure stops the rest. For typed meetings pass meetingTypeId and fill its AGENDA and MEETING templates with agendaFieldUpdates and meetingFieldUpdates. Omit meetingTitle to use the type name. With status DISTRIBUTED, workerIds create invites, notify recipients, and schedule reminders; other statuses do not.

editTemplateWorkingCopy

ChatGPT
Apply exact JSON edits to a private template working copy and validate the whole result. Schema-invalid edits ARE retained: use the returned revision for subsequent repairs. Path/target failures apply none of the batch. set assigns a value, remove deletes, insert inserts at an array index. IDs target existing items; omit itemId and use root-relative paths to repair malformed hierarchy or duplicate IDs. Preserve stable IDs and unrelated authored content. Result lists added/updated items (ids, paths) and removed ids; a cut list gives changedItemCount and outline offset. Apply only after valid.

editWorkflowWorkingCopy

ChatGPT
Apply exact JSON edits to a private workflow working copy and validate the whole result. Schema-invalid edits ARE retained: use the returned revision for subsequent repairs. Path/target failures apply none of the batch. set assigns a value, remove deletes, insert inserts at an array index. IDs target existing items; omit itemId and use root-relative paths to repair malformed hierarchy or duplicate IDs. Preserve stable IDs and unrelated authored content. Result lists added/updated steps (ids, paths) and removed ids. Apply only after valid.

getAction

ChatGPT
Get one action/task by exact ID, including details, status, priority, due date, location, description, and its complete activity-thread update history in newest-first order.

getAdminUser

ChatGPT
Get detailed information about a specific admin user.

getAutoSignOnSetupStatus

ChatGPT
Report automatic sign-on setup by project. Shows builder auto sign-on setting, project latitude/longitude/radius, geofence readiness, geolocation reminders, and whether each project is effectively ready for auto sign-on/off. Worker phone opt-in and location permission state are not available in admin data.

getBuildPassWorkflowGuide

ChatGPT
Fetch one MCP-safe BuildPass product or workflow guide by its exact guide ID.

getCertification

ChatGPT
Get the certification record and its attached file metadata. File URLs are references only; this result does not include or inspect the referenced file contents.

getContact

ChatGPT
Get detailed information about a specific contact.

getDashboard

ChatGPT
Get detailed information about a dashboard by ID.

getDefect

ChatGPT
Get detailed information about a specific defect, including whether it has been sent to its assignees (sentToAssignees and sentAt) and its complete update thread in newest-first order.

getDocument

ChatGPT
Get one document record and its file metadata. This result does not include or inspect the referenced file contents. sharedDirectlyWithWorkers and sharedViaWorkerVisibleFolder report configuration only; they do not establish that a named worker can open it.

getDrawing

ChatGPT
Get one drawing record and its file metadata, including review status, notify recipients, previous revision, version history, and read receipts. This result does not include or inspect the referenced drawing contents.

getEmergency

ChatGPT
Get detailed information about a specific emergency.

getFormResponse

ChatGPT
Get a specific form/template response. Compact mode includes response metadata, a complete value-bearing field summary, and attachmentCount. Full mode includes normalized field labels, block types, options, current values, expected answer shapes, attachment URLs, and canonical raw responseData.

getInduction

ChatGPT
Get detailed information about a specific induction. Use the returned authenticated webUrl for the trusted induction signature workflow.

getInsurance

ChatGPT
Get one insurance record and its file metadata. This result does not include or inspect the referenced file contents.

getLibrarySwms

ChatGPT
Get details for one reusable library method statement before creating a project record from it, including compact review checklist fields when available.

getLocation

ChatGPT
Get detailed information about a location.

getMeetingType

ChatGPT
Get one Meeting v2 meeting type, including agendaTemplate.fields and meetingTemplate.fields with the labels and value shapes of its agenda and meeting-specific fields.

getMyActivitySummary

ChatGPT
Get the signed-in user's own BuildPass activity over recent weeks in the active company: counts by record type, action and status change, by weekday and hour, plus event counts per project, most active first. Use for questions about how they work, what they review or approve, what they do regularly or which projects they work on most; it does not show other people's activity.

getNotice

ChatGPT
Get a notice/pre-start with project, dates, sign-ons, acknowledgements, linked toolbox details, and embedded response. Compact mode includes a complete value-bearing field summary. Full mode includes normalized field labels, block types, options, values, expected answer shapes, and canonical raw responseData.

getPermit

ChatGPT
Get detailed information about a specific permit.

getPhoneCall

ChatGPT
Get one authorized phone call summary by exact ID. Returns current ordered Page summary, tasks, and photos; legacy summary fields are returned only without a Page. Core API enforces builder access and call-detail visibility.

getPhotoReport

ChatGPT
Get one authorized, view-only Supasite Photo Report and its ordered semantic Page blocks by exact Photo Report ID. Does not expose the owner-only Supasite edit link.

getPlatformUsageReport

ChatGPT
Get high-level platform usage report data with optional project and date range filters. Use for report-style summaries of BuildPass activity; returns reporting data only and does not export files.

getPrequalification

ChatGPT
Get one prequalification submission. formResponse contains read-only subcontractor answers; reviewFormResponse contains the company review checklist, or null if absent. Compact mode includes metadata and complete value-bearing summaries. Full mode includes normalized fields and canonical raw responseData for each form.

getProject

ChatGPT
Get detailed information about a specific project by ID.

getProjectSchedule

ChatGPT
Get a project schedule by exact ID, including every phase, task, and milestone. Returns the full schedule rather than a filtered or paged item subset.

getPublishedSchedule

ChatGPT
Read the published schedule snapshot, marked source: published, as a summary or as a paged reference. view "summary" (default) for an overview; view "reference" for item IDs, dates, durations, hierarchy, dependencies, and critical-path inputs. Excludes browser-local unsaved items and temporary IDs. The user publishes manually in Scheduling UI.

getRFI

ChatGPT
Get one RFI by exact ID, including the formal question, delivery state (sentToRespondents and openedAt), response context, and complete comment history in newest-first order.

getRegister

ChatGPT
Get a live register with its linked editable template identity, settings, and compact field contracts for main and type-library responses. linkedTemplate identifies its owned definition, distinct from a reusable REGISTER template. fields and typeFields include IDs, labels, block types, value shapes, and options.

getRegisterItem

ChatGPT
Get a register item. Compact mode includes metadata and complete value-bearing summaries of main, type, upload, and review responses. Full mode includes normalized fields and one canonical raw responseData payload per form.

getReportFormat

ChatGPT
Fetch a saved output/report format prompt by exact ID, including its stored content for PDF-ready documents, CSV exports, charts, reports, or other recurring output formats. Returns content without generating an artifact.

getScheduleItem

ChatGPT
Get detailed information about a specific schedule item (phase, task, or milestone).

getSds

ChatGPT
Get one SDS record and its linked file metadata. This result does not include or inspect the referenced SDS contents.

getSettings

ChatGPT
Read one BuildPass settings scope: actions (type and priority labels), company, project, signOn, user, checklists, integration, procoreProject folders, or rfiNumbering. Read actions before filtering or setting action type or priorityType; rfiNumbering before RFI imports that carry numbers; checklists to see which forms workers can use. actions, project, procoreProject, and rfiNumbering need projectId; integration needs integrationType. The manual QR access code is not returned; use the project webUrl.

getSignOn

ChatGPT
Get detailed information about a specific sign-on record.

getSiteDiary

ChatGPT
Get one Site Diary wrapper with embedded response values by id or by projectId and date. Full mode includes normalized fields and raw responseData. Photos are associated with formResponse.id and image source SITE_DIARY. A date without a diary returns data null.

getSubcontractor

ChatGPT
Get detailed information about a subcontractor.

getSubmittal

ChatGPT
Get a Submittal by exact ID: package, type, spec section, intake mode, submitter, frozen approval plan, live approval flow with current stage and participant decisions, all revisions, distribution recipients and dates, documents and their provenance, and recent conversation. Includes stage and participant IDs.

getSubmittalPackage

ChatGPT
Get a Submittal Package by exact ID with package metadata and contained item identity/status. Does not provide item-level approval or ball-in-court analysis or the native package CSV/PDF export.

getSubmittalSettings

ChatGPT
Get builder Submittal configuration: type keys and labels, approval templates with IDs, stages and default selection, and published log templates. With logTemplateId and projectId, returns that log template's items and their exact IDs instead.

getSummaryRecord

ChatGPT
Read a meeting, phone call or photo report summary and its directly connected actions and defects by exact record type and record ID. Returns ordered Page content and image attachment URLs. Defects are supported only for PHOTO_REPORT. IDs identify the source record, not its Page.

getSwms

ChatGPT
Get a project safety method statement with assigned workers, review status, and whether its review response exists or will be created from the project template. Compact mode includes checklist source and complete value-bearing summary. Full mode includes normalized checklist fields and canonical raw responseData when present.

getTemplate

ChatGPT
Read one saved template, checklist, or form definition from canonical database state. Compact detail returns metadata, summaries, current validation issues (informational, each with the item id to patch). A null patchItem value removes a field. For structure, use "index" for compact IDs and hierarchy, "targeted" for exact known values including conditions, "property" with an item ID and path for nested JSON, or "full" for paged access. Follow nextCursor and concatenate valueJsonChunks.

getTemplateAuthoringReference

ChatGPT
Return the requested sections of the reusable template/checklist/form definition reference: core has the template and design rules and section, group, block, and option shapes (returned when nothing else is requested); sourceDigitisation covers file migrations; conditions covers Condition[][] visibility; capture/display block types return exact block shapes. Does not return an existing template's IDs or definition.

getTemplateTypeReference

ChatGPT
For reusable template/checklist/form definitions, get the exact Core API TemplateType enum values, their BuildPass product destinations, and each type's placement (module-effective: one effective template per project; company-wide: available to every project, no project copies or company default) when the value or placement is unclear. Includes the INSPECTION-to-Forms and ITP-to-Inspections mapping. For broad inventory or count questions, treat the returned values as the complete type set.

getTemplateWorkingCopy

ChatGPT
Check the whole template working copy and read an outline or exact JSON subtree. Subtrees are returned as valueJson (JSON text); parse it as JSON. All reads and edits use the same authored JSON. Supply itemId and/or path for a subtree; omit both for a paginated outline. Repair diagnostics refer to this working copy. Source remains unchanged.

getTimesheet

ChatGPT
Get a timesheet entry with worker, project, hours, status, timing, approval details, and linked response. Compact mode includes a complete value-bearing field summary. Full mode includes normalized field labels, block types, options, values, expected answer shapes, and canonical raw responseData.

getTimesheetTypes

ChatGPT
Get available timesheet time type labels, cost code codes, and settings flags for the current builder or a specific project.

getToolbox

ChatGPT
Get a toolbox talk or meeting with current manual and synced Page notes; legacy notes appear only without a Page. Child-page metadata identifies the source app for synced notes. Compact mode includes Page content and form summaries; full mode adds template definitions and normalized fields. includeAttendance adds merged invite and pre-start sign-on attendance matching the printed PDF.

getVisitor

ChatGPT
Get a visitor by exact ID with their name, contact details, and project sign-on history.

getWorker

ChatGPT
Get detailed information about a specific worker by ID, including contact details, address, date of birth, emergency contact details, archived/disconnected workers when includeArchived is true, and a certificationIds helper list for follow-up certification checks. Medical information and allergies are intentionally unavailable here; use the returned authenticated webUrl when the user needs those worker details.

getWorkflow

ChatGPT
Get detailed information about a specific workflow.

getWorkflowAuthoringCapabilities

ChatGPT
Read the Core API workflow capability catalogue for a trigger and selected resource. Includes supported conditions, recipients, waits, attachments, variables, and stepTypes: the JSON Schema of each step type. Supply path to read a smaller section, with offset and limit to page arrays. Arbitrary subtrees are returned as valueJson; parse it as JSON. Use real resource and project IDs; refresh after changing the trigger.

getWorkflowWorkingCopy

ChatGPT
Check the whole workflow working copy and read an outline or exact JSON subtree. Subtrees are returned as valueJson (JSON text); parse it as JSON. All reads and edits use the same authored JSON. Supply itemId and/or path for a subtree; omit both for a paginated outline. Repair diagnostics refer to this working copy. Source remains unchanged.

listActions

ChatGPT
List project actions/tasks with search, status, configured type/priority, assignee, location, date, and pagination filters. Returns structured rows for outstanding-work and task questions. type and priorityType filters require projectId and exact project-configured labels.

listAddressBookContacts

ChatGPT
Search active standalone address-book contacts by name or email, optionally scoped to a project. Returns contact IDs for RFI and Submittal participants; directoryEntryId is not a participant ID. Omit projectId to search the whole builder directory, including global contacts.

listAdminUsers

ChatGPT
List admin users (staff members) in the organization, with identity, role, and project-scope information. Does not list site worker records.

listCertificationTemplates

ChatGPT
Search and page available certification/ticket templates by name, short name, code, category, or type. Returns template IDs, metadata, and the file names each template takes with whether each is required, not worker certifications.

listCertifications

ChatGPT
List worker certifications/tickets/licences/licenses/qualifications with worker, type, review status, expiry, search, and pagination filters. Includes certification IDs and credential metadata, not the contents of attached files.

listContacts

ChatGPT
List contacts for a subcontractor. Use when user asks about subcontractor contacts.

listDashboards

ChatGPT
List custom reporting dashboards with optional search, project filters, and pagination. Use when the user clearly means saved analytics/reporting dashboards, not general app navigation.

listDefects

ChatGPT
List defects/punch list items/snags across accessible projects, or narrow to one project, with search, status, priority, type, assignee, location, date, and pagination filters. Use for quality issues, incomplete work, rectification, close-out, and outstanding-work questions; returns structured defect rows, each stating whether it has been sent to its assignees.

listDocumentFolders

ChatGPT
List document, drawing or gallery-photo folders with paths and parent IDs in one scope tree. folderId narrows to one folder and its descendants. Each row has its own settings (visibleToWorkers, hasActivePublicLink) and effective access (effectiveWorkerAccess, effectivePublicLinkAccess), identifying the parent granting inherited access. Worker sharing and public-link access are independent. Scopes: builder_documents (company-wide), project_documents, subcontractor_documents (project Other), drawings, gallery_photos.

listDocuments

ChatGPT
List project documents/files/paperwork with search, status, category, company, folder, archived, and pagination filters. sharedDirectlyWithWorkers and sharedViaWorkerVisibleFolder report how each document is configured for worker access; they do not establish that a named worker can open it. Rows may include an existing free-text type label, but Core does not expose configured type options here, so do not invent type values; use searchString for user wording like SWMS, SDS/MSDS, insurance, permits, manuals, certificates, reports, or contracts.

listDrawings

ChatGPT
List project drawings/plans/blueprints/sheets with search, status, folder, archived, and pagination filters. Use for drawing registers, plan sets, latest revision, sheet lookup, waiting-review approval checks, notification recipient review, and drawing status questions. Returns structured drawing rows including review status and notify recipients.

listEmergencies

ChatGPT
List emergencies for a project. Use when user asks about site emergencies or incidents.

listFormResponses

ChatGPT
List form responses/submissions/checklists/inspections with project, template, status, search, location, date, and pagination filters. Includes completed and in-progress structured site records. Omitted status returns all unarchived responses regardless of completion. appliedFilters echoes the effective filter. Returns response rows, not reusable template definitions.

listGalleryPhotos

ChatGPT
Search project gallery photos by text, image source, location, folder, upload date, and photo-taken date. Each result includes its BuildPass image URL and mediaReference (mediaId, sourceType, sourceId, filename, contentType, url). Does not return a record's full form response.

listInductions

ChatGPT
List inductions/orientations/onboarding records for site or company in the current builder context. Use for worker induction status, orientation progress, sign-on readiness, and review queues. For site inductions, provide projectId; company inductions use the current builder context.

listInsurance

ChatGPT
List insurance documents/COIs/certificates of insurance with project, subcontractor, search, status, expiry, archived, and pagination filters. Use for subcontractor insurance, coverage, expiry, and compliance questions.

listIntegrationConnections

ChatGPT
List existing integration connections, optionally filtered by project or subcontractor. Does not connect, disconnect, or return the configured integration-management settings.

listIntegrations

ChatGPT
List configured BuildPass integrations for connection diagnostics. Connection and sync configuration changes are managed in the BuildPass integrations UI.

listLibrarySwms

ChatGPT
List reusable library method statement documents with exact IDs, status, subcontractor, and expiry. With projectId, also returns whether each document is connected to that project and whether its subcontractor is on the project. Returns library documents rather than project records.

listLocations

ChatGPT
List project locations/areas/rooms/zones/levels/units used to organize and filter records by place.

listMeetingTypes

ChatGPT
List Meeting v2 meeting types for the builder, including meetingTypeId and visible field labels. Types group toolbox/meeting records and may have two linked TOOLBOX templates: AGENDA for agenda fields and MEETING for meeting-specific fields. archivedFilter accepts ACTIVE_ONLY, ARCHIVED_ONLY, or BOTH.

listMyBuilders

ChatGPT
List the BuildPass builders (company accounts) the current user can work in, with the active builder marked. Use for active-builder and available-company-account questions.

listNotices

ChatGPT
List notices/pre-starts/daily sign-on messages with optional project, date, archive, and pagination filters. Use for hazards, announcements, daily instructions, acknowledgement records, and sign-on notice questions. Date bounds match either the notice start date or its creation date; check returned dates when selecting notices for a scheduled day. For a local calendar day, pass dateFrom at 00:00:00 and dateTo at 23:59:59.999 with the project's timezone offset.

listPermits

ChatGPT
List permits/permits-to-work for high-risk work, including hot works, excavation, confined space, energisation, and working at heights. Supports project, status, type, search, date, location, archive, and pagination filters. Returns list rows rather than full individual permit detail.

listPhoneCalls

ChatGPT
List and search Supasite-powered Phone Calls within the current builder and project access. Includes exact phone call IDs. Core API enforces the caller's call-visibility permissions.

listPhotoReports

ChatGPT
List and search view-only Supasite Photo Reports in one BuildPass project. Core API applies project and Page visibility access.

listPhotoTags

ChatGPT
List project photos with their tags, descriptions, and source. Use when the user asks what tags photos have, wants to see tagged/untagged photos, or asks about photo descriptions.

listPrequalifications

ChatGPT
List prequalification/prequal/vendor onboarding submissions with search, status, subcontractor, overdue, due-date, archive, and pagination filters. Provides company-level compliance submission rows rather than full individual submission detail.

listProjectSchedules

ChatGPT
List project schedules/programs/timelines/lookaheads with project, archive, and pagination filters. Provides schedule metadata and exact IDs rather than every phase, task, or milestone.

listProjects

ChatGPT
List and search accessible projects, including stable project IDs and stored geofence latitude, longitude, and radius. Results are paginated and scoped to the current user. Archived projects are excluded unless status is ARCHIVED.

listRFIs

ChatGPT
List RFIs (Requests for Information) across accessible projects or one project, with status, ball-in-court, respondent, location, drawing, due-date, archive, search, sort, and pagination filters. Returns structured RFI rows with project identity rather than full individual detail.

listRegisterItemTypes

ChatGPT
List register item types and their upload/review template configuration. Upload templates and review templates are assigned to Register Item Types, not register item rows. Use this for questions about which item types have upload templates, review templates, linked checklists, or template visibility.

listRegisterItems

ChatGPT
List register items/rows by exact register identifier, project, search, assignee, archive, and pagination filters. Returns entries within a register rather than register definitions or full individual item detail.

listRegisterSetupTypes

ChatGPT
List active library-backed register setup types, such as Plant and Equipment. Returned IDs identify LibraryTemplates validated for REGISTER_TYPE, not company reusable template IDs. Blank/custom registers do not require a library setup type.

listRegisters

ChatGPT
List BuildPass registers/custom tracking lists such as plant, equipment, asset, activity, and compliance registers. Returns metadata and exact identifier prefixes, not item rows or item-type upload/review template assignments.

listReportFormats

ChatGPT
List saved reusable output/report formats, including CSV/PDF/chart recipes and repeatable deliverable structures.

listRoles

ChatGPT
List assignable admin-user roles for the current builder, including exact role IDs and display names. Role assignment inputs require IDs, not display names.

listScheduleItems

ChatGPT
List schedule items from a project schedule with paging and optional filters for item type, date range, item title text, assignee name, and unassigned items. Use narrow filters first for large schedules and request additional pages with limit/offset when needed. Use this for questions like "find everything between these dates", "who is meant to be on site on this day", and bulk operations like assigning companies to multiple tasks. Returns item IDs, dates, durations, hierarchy, and each assignee with their confirmation date or not confirmed.

listSds

ChatGPT
List Safety Data Sheets (SDS/MSDS/material safety data sheets) with project, subcontractor, search, status, review-date, archive, and pagination filters. Returns chemical and hazardous-material safety document metadata, not referenced file contents.

listSignOns

ChatGPT
List sign-ons/sign-ins/site attendance records by project, worker, subcontractor, date, sign-off, method, archive, time-of-day, search, and pagination. Use for attendance, site-hours, sign-on coverage, who was on site, not-signed-off rows, and group-by subcontractor reporting. Dates are absolute ISO datetimes with the project timezone offset; time-of-day filters are HH:MM in each row project timezone. Use summaryBy="worker" for worker attendance; summaryBy="day" for daily coverage/site-hours with projectId/projectIds and dateFrom/dateTo up to 31 days.

listSiteDiaries

ChatGPT
List Site Diary/Site Log records with search, archive, sort, and pagination filters. kind daily (default) lists daily logs across one (projectId), several (projectIds) or all visible projects, by dateFrom/dateTo. supplementary lists sub-logs for one required projectId, by date or supplementary templateId. Returns diary entry content such as notes, weather, incidents, deliveries, and fields, not site attendance records.

listSubcontractors

ChatGPT
List companies/subcontractors/trade partners/vendors with project, search, status, compliance, and pagination filters. includeComplianceSnapshot=true requires projectId and adds a loaded-page snapshot across SWMS, public liability, workers compensation, and prequalification. Trade licences are worker-level records and are not included.

listSubmittalPackages

ChatGPT
List Submittal Packages with package identity, spec section, counts, and IDs. Does not provide item-level approval, ball-in-court, due-date, or type analysis or the native package CSV/PDF export.

listSubmittals

ChatGPT
List project Submittals with search, status, approval status, type, package, urgent, due-date, archive, sort, and pagination filters. Rows include ball-in-court, intake mode, submitter, and live revision number. forApprovalAdminUserId filters items waiting on that exact admin user; createdByAdminUserId filters their created items.

listSwms

ChatGPT
List project safety method statements with project, status, subcontractor, search, archive, and pagination filters. Includes hazardous-work methods, risk controls, review, and worker acknowledgement facts. Returns project records, not reusable library documents or full individual record detail.

listTemplates

ChatGPT
List or count form/checklist templates of one exact Core API TemplateType (view templates, the default), or inspect its management state (view managementState): the effective template, company default, and project assignment. managementState takes only templateType, projectId and supplementary; for supplementary SITE_DIARY it returns the assigned and unassigned sub-log templates without resolving a default. Does not inventory all types in one call, create, or edit.

listTimesheets

ChatGPT
List timesheet entries with project, status, subcontractor, worker, date, search, and pagination filters for labour hours, approvals, and hours worked. dateFrom/dateTo require offset ISO DateTime boundaries in the project timezone. Returns rows rather than full individual entry detail.

listToolboxes

ChatGPT
List project toolbox talks/tailgate meetings/safety meetings with search, status, legacy type, and date filters. Includes Meeting v2 meetingType/template summaries when present.

listVisitors

ChatGPT
List visitors currently on site for a specific project with their contact details. Provides current attendance and headcount, not a cross-project visitor search.

listWorkers

ChatGPT
List and search workers/operatives. searchString matches name, email, mobile, or trade; filters narrow by trade, company, project, tickets, or tags. Returns paginated worker records and certification helper IDs.

listWorkflowExecutions

ChatGPT
List workflow execution runs with workflow, project, status, resource type, and pagination filters. Provides run history, failures, and skipped executions, not workflow definitions.

listWorkflows

ChatGPT
List and search workflow/automation/reminder definitions with project, status, active state, resource type, archive, and pagination filters. Includes triggers and scheduled notification/email/SMS automation metadata, not execution history.

prepareAttachmentUpload

ChatGPT
Mint a presigned upload URL and storage key for images, PDFs, and common documents up to 50MB. uploadUrl accepts raw bytes via PUT with the specified contentType. A completed upload is identified by { type: "upload", key, fileName, contentType, fileSize }; creating a record or attaching the file is not performed here.

prepareSubmittalOpenAndSend

ChatGPT
Preview bulk open-and-send for a Submittal Package or chosen Submittals without sending. Returns subcontractor groups, selectable contacts, ready items, and blocked (missing plan/company/contact) or excluded (sent/closed/void/archived/logged/in-review) items. Groups and recipients describe the current valid send inputs.

prepareTemplateWorkingCopy

ChatGPT
Open a private template JSON working copy from a saved template, or start a new template. The source remains unchanged while you edit and repair the working copy.

prepareWorkflowWorkingCopy

ChatGPT
Open a private workflow JSON working copy from a saved workflow, or start a new workflow. The source remains unchanged while you edit and repair the working copy.

restoreRecords

ChatGPT
Restore one or more archived BuildPass records of one recordType without changing their other fields. Per-record outcomes; the first failure stops remaining records. A permit reinstates its workers' reminder schedule; a meeting type restores the type record only, not its meetings. Restored register items can trigger configured email or SMS workflows.

restoreSubmittal

ChatGPT
Restore an archived Submittal by exact ID into the active log. Does not reinstate an approval flow cancelled by archiving.

saveReportFormat

ChatGPT
Create or update a reusable output/report format after the user explicitly asks to save the current output format, report format, CSV/PDF/chart recipe, or repeatable deliverable structure. The prompt stores the repeatable recipe (data-source gathering, filters, grouping, columns, chart choices, and authoring instructions), not the generated artifact body. Pass id to update an existing format; omit id to create a new one.

saveTemplateWorkingCopy

ChatGPT
Save an exact validated working-copy revision to its original saved template, or create its new template. A changed saved source is rejected. Browser-editor working copies cannot be saved with this tool.

saveWorkflowWorkingCopy

ChatGPT
Save an exact validated working-copy revision to its original saved workflow, or create its new workflow. A changed saved source is rejected. Browser-editor working copies cannot be saved with this tool.

searchAssignees

ChatGPT
Search for assignees (workers, admin users, subcontractors) by name. Returns bounded candidates with IDs, names, and types; a name can match multiple people. projectId improves worker/admin-user/resource-tag matching; company/subcontractor matches can be found without project context.

searchBuildPass

ChatGPT
Start here to find any BuildPass record, document, photo or person from the user's own words, even when the wording is loose. Searches every category unless categories narrows it; photos also match by what they show. Returns best-effort matches, not exhaustive lists, totals or aggregations; coverage is incomplete.

searchBuildPassWorkflowGuides

ChatGPT
Search MCP-safe BuildPass product and workflow documentation by query. Returns matching guide IDs and summaries of product relationships.

searchProductGuidance

ChatGPT
Search BuildPass how-to articles and product stories for how to do a task, whether it is possible, who can do it and on which plan. Accepts a product question and one to four compact queries; returns task-shaped sources (steps with exact screen and button names, roles, plan, limits, and how each was checked), not customer records. Inputs must not contain customer data.

sendDefects

ChatGPT
Send one or more defects in a project to their assignees. Uses the Core send operation and reads back saved sentToAssignees/sentAt. This confirms BuildPass distribution state, not recipient delivery or receipt. Use when a defect shows sentToAssignees=false and the user asks to send, issue, notify, or distribute it, and to resend an already-sent defect only when the user explicitly asks to resend. Every defect needs at least one assignee, and a company assignee needs a contact; the call fails with that reason when one is missing.

updateAction

ChatGPT
Update an action/task. Omitted fields are preserved, including project, location, assignees, and attachments. Scalar fields patch the action. addAssignees, assignToCurrentUser, removeAssignees, and addFiles append/remove only the specified relationships; they never replace the full set. The update notifies the action assigner and affected current or newly added assignees. At least one field or relationship change must be supplied.

updateActiveBuilder

ChatGPT
Switch the user's active BuildPass builder to an exact builderId they belong to. Changes the active builder everywhere for that user, including the web app and subsequent tool calls, until another switch.

updateAdminUser

ChatGPT
Update admin-user metadata and project scope, not roles. Omitted scalars are preserved. Email changes update identity; profile changes synchronize to notifications. Supplied projectIds replace this builder's entire project scope for that user; [] clears it and omission preserves it.

updateAdminUserRoles

ChatGPT
Replace an existing admin user's role assignments for the current builder using exact admin-user and assignable role IDs. Supplied roleIds replace the builder's entire current role list. Resulting roles synchronize to external identity and profile systems. BuildPass permissions enforce which roles the caller may assign.

updateChecklistSettings

ChatGPT
Update organisation-wide checklist/form settings. This is a shallow settings merge for the exposed booleans: omit options you want to preserve. addPublicChecklistIds and removePublicChecklistIds append/remove worker-available forms without replacing the full public checklist list.

updateDashboardFavouriteStatus

ChatGPT
Favourite or unfavourite a dashboard for the current admin user only. This does not change dashboard content or access.

updateDefect

ChatGPT
Update a defect, including moving it to a different defect type/register. Omitted fields are preserved, including assignees and attachments. Scalar fields patch the defect. addAssignees, assignToCurrentUser, removeAssignees, and addFiles append/remove only the specified relationships; they never replace the full set. The update notifies the defect assigner and, when the defect was already distributed and remains open, its recipients. At least one field or relationship change must be supplied.

updateDocument

ChatGPT
Update a document record; a new file replaces the original. Omitted scalars are preserved. Does not edit the free-text document type label.

updateDocumentFolder

ChatGPT
Rename a document, drawing, or gallery-photo folder, or change worker sharing for document/drawing folders. Omitted name is preserved. visibleToWorkers shares/unshares with inducted workers except in gallery_photos. Parent sharing is inherited by nested folders and contents. Does not move a folder.

updateDocumentFolderContents

ChatGPT
Move folders, documents or drawings within one folder scope and project. folderIds work in every scope; documentIds in the three document scopes; drawingIds in drawings. gallery_photos moves folders, not individual photos. A folder cannot move into itself or a descendant.

updateDrawingReview

ChatGPT
Update a project's drawing review table: replace per-drawing notification recipients and/or approve waiting-review drawings. Recipients require canonical {id, type}; [] clears the list. Recipients apply before approval. Approval creates version history and notifies recipients; revisions/duplicates mark the previously approved revision OUTDATED.

updateEmergency

ChatGPT
Update an emergency. Omit title and description to preserve them. Changing status is a direct status update, but note that editing a resolved emergency can clear its resolvedAt timestamp unless it remains resolved.

updateFormResponse

ChatGPT
Update response answers via fieldUpdates and/or metadata (projectId, locationId, completedAt). Answers require actual field IDs or labels and their defined value shapes. Applies answers in order, preserving other fields; linked actions may notify assignees and saving may run workflows or syncs. Supplied completedAt completes the response; omission preserves completion state. Does not edit the reusable template.

updateInduction

ChatGPT
Update or review an induction: status WAITING_REVIEW, CHANGES_REQUESTED, or REVIEWED (approve), evidenceSighted, and whether related tickets follow. Omit status to preserve it. When approving, updateTicketStatus defaults to true like the review screen. Current backend behavior can set evidenceSighted to true but does not reliably set it back to false. Signature capture is intentionally unavailable through this tool; use the returned authenticated induction webUrl. Configured induction workflows may send email or SMS and enabled integrations may sync the updated induction.

updateInsurance

ChatGPT
Update an insurance document. Omit fields to preserve them. A new file creates a new version of the document and resets status to WAITING_REVIEW.

updateLocation

ChatGPT
Update a project location's name or parent. Omit name or parentId to preserve the current value.

updateMeetingType

ChatGPT
Rename a Meeting v2 meeting type. Does not change linked agenda or meeting template definitions.

updateNotice

ChatGPT
Update notice/pre-start wrapper metadata and/or embedded response fieldUpdates. Metadata patches the wrapper and linked response; fieldUpdates change answers and complete the response, with completedAt defaulting to now. template.completedAt also defaults to now when omitted. Answers require actual visible field labels and defined value shapes. Omitted fields are preserved; reusable definitions are unchanged. Completing or updating the linked response can trigger configured workflows and integrations, including external messages.

updatePermit

ChatGPT
Update permit dates, details, location, or workers. Omitted fields are preserved. workerIds is a full replacement list only when explicitly supplied; omit workerIds to preserve current workers. Newly added workers are notified, and the permit reminder schedule is recalculated after the update. At least one field must be supplied.

updatePermitWorkerStatus

ChatGPT
Move permit workers through their status lifecycle via transition: approve, reject, start, pause, resume from suspension, or closeout. Only the supplied permit-worker ids are affected. message is optional on approve, required on reject; files may accompany either to annotate the decision. start, pause, resume, and closeout take only permitId, ids, and transition. This tool does not fill enacting or closeout template responses from raw payloads; use the permit UI for that.

updatePhoto

ChatGPT
Update gallery photos: add tags to many photos, or replace one photo's tags or description. Use attachment IDs from gallery reads. addTags keeps existing tags on every listed photo. tags is the complete replacement list for one photo: read existing tags first and keep any the user wants; [] clears them. Missing tag names are created automatically. Omitted fields are preserved; an empty description clears it.

updatePrequalification

ChatGPT
Update submission status, dueDate, comments, and/or the company review checklist via fieldUpdates using actual reviewFormResponse field labels and defined value shapes. One write; omitted wrapper fields and answers are preserved. Subcontractor-submitted answers are read-only. Does not edit the reusable definition. Configured prequalification workflows may send email or SMS.

updateProject

ChatGPT
Update project name, address, status, dates, timezone, locale, admins, geolocation, or assigned companies (subcontractors). Omitted scalars are preserved. Scalar changes and company assignment changes cannot be combined in one call because they use separate mutations. Coordinates require latitude and longitude together; radius is independent.

updateProjectGeofence

ChatGPT
Update only a project geofence used for geolocation reminders and automatic sign-on/off. Coordinates require latitude and longitude together; radius can change independently. Omitted values are preserved.

updateProjectSiteTimings

ChatGPT
Replace the full weekly site timing set for a project with the supplied working hours and daily start/finish times.

updatePublishedSchedule

ChatGPT
Change a published schedule's items: create, update, archive, or shift items by working days. Publishes the result at once unless previewOnly is set, which saves nothing. Sends no notification to anyone. Needs the publishedVersion from a read of the schedule; fails without saving if that is not the current one, or, naming the editor, while anyone has it checked out. One invalid row refuses the whole call. Returns the changed and other moved items with old and new dates, the dependents rule used, dependency violations left, confirmation changes, the tempId map, and the new publishedVersion.

updateRFI

ChatGPT
Update an RFI or open, close, reopen, or void it. Omitted fields are preserved; supplied respondents, watchers, drawingIds, and files replace each entire list. Opening, non-draft changes, or adding recipients to an open RFI may notify respondents/watchers. Recipient IDs must identify admin users or contacts.

updateRFINumberingSettings

ChatGPT
Update a project RFI starting number for future opened RFIs only; existing RFIs are not renumbered. A startingNumber at or below currentHighestSequenceNumber does not change the next number because existing numbered RFIs are already at or above that setting.

updateRegister

ChatGPT
Change a live register's name, identifier prefix, project availability, or Edit settings by its exact identifierPrefix. Omitted values are preserved. Does not edit fields, archive, or change blank/library-backed setup. Company management requires library-backed setup.

updateRegisterDefinition

ChatGPT
Edit a live register's linked field definition by exact identifierPrefix. The server resolves the owned template ID, not a similarly named reusable template. templateEditPlan makes targeted edits preserving existing fields. Does not change irreversible blank/library-backed setup.

updateRegisterItemFields

ChatGPT
Update visible register-item main fields, type-library fields, or upload-form fields using actual field IDs or labels and defined value shapes. id targets one item; items targets up to 50 with non-atomic row outcomes. Preserves other item data. Does not edit metadata, links, status, follow-up date, or name. Configured register workflows may send email or SMS.

updateRegisterItemType

ChatGPT
Update a register item type. Omit name and linkedChecklistIds to preserve them. If linkedChecklistIds is supplied, it replaces the full linked-checklist set and [] clears it.

updateRegisterItems

ChatGPT
Update register item metadata, links or assignees. ids applies one shared patch to up to 100 items; items takes up to 50 row patches. Rows override defaults; omissions and hidden required data are preserved. checklistTemplateIds/projectIds replace links. Non-atomic, with per-row failures. addAssignees/removeAssignees/setAssignees also support assignee-only patches; setAssignees: [] clears all and cannot combine with add/remove. Configured workflows may send email/SMS; CHANGES_REQUESTED can notify assigned companies.

updateScheduleTitle

ChatGPT
Rename a project schedule by its exact projectScheduleId, not a project ID. Changes only the title and applies immediately. Does not edit phases, tasks, milestones, dates, dependencies, or assignees, and is not a draft item edit or publish action.

updateSds

ChatGPT
Update an SDS document; a new file replaces the current one. Omit scalar fields to preserve them. If projectIds is supplied, it replaces the full linked project set and [] clears all project links.

updateSignOn

ChatGPT
Sign workers off or correct manual attendance times on supplied sign-on IDs only. Sign-off uses optional signOffDate, defaulting to now. A signOnDate correction requires one signOnId; omitted signOffDate is preserved. Does not infer additional workers or create records. Configured attendance workflows may send email or SMS.

updateSiteDiary

ChatGPT
Update a Site Diary or supplementary diary's date/project and/or embedded response answers via one fieldUpdates array. id must be the diary wrapper ID, not formResponse.id. Answers require actual form field labels and defined value shapes. Resolves supported projectLocation and company IDs; preserves omissions. Does not edit reusable definitions. Concurrent writes to one diary can overwrite each other. Configured daily-log workflows may send email or SMS and enabled integrations may sync the updated log.

updateSubcontractorTags

ChatGPT
Set tags on a subcontractor by tag name. This replaces the subcontractor's current tags; pass [] to clear all tags.

updateSubmittal

ChatGPT
Update a Submittal by exact ID or open, close, or void it. Omitted fields are preserved; null clears a field. Description fields are editable in DRAFT/OPEN; company, distribution, intake, documents, and approval settings are DRAFT-only. OPEN submitters can change until they respond. Opening requires a submitter and approval plan and sends irreversible email to the submitter or first stage. ids with approvalTemplateId applies one template to many drafts. Does not decide approval stages or distribute the final package.

updateSubmittalApprovalStage

ChatGPT
Act on an open Submittal's live approval flow. Each action and its fields (? optional): DECIDE (participantId, decision, message?, files?) records the signed-in participant's own decision; external approvers use their email link. SUBMIT (message?, files?) supplies documents during the active submitter stage. UPDATE_APPROVERS (stageId, addApprovers?, removeParticipantIds?, requiredAll?) changes unfinished-stage approvers. REMIND (stageId for the whole stage or participantId for one person, message?) emails pending participants. SKIP (stageId, reason) skips a stage.

updateSummaryRecordConnections

ChatGPT
Connect or disconnect existing actions on a meeting, phone call, or photo report, or defects on a PHOTO_REPORT. Omitted links remain unchanged. Additions must share the source builder and projects. Returns saved connection lists.

updateSwms

ChatGPT
Update a project method statement's workers, status/review, or review-checklist answers, preserving omitted groups. Requires at least one change. workerIds replaces all assignments; [] clears them. fieldUpdates require actual field names/options and defined value shapes. Creates a missing review response from the project template.

updateTemplate

ChatGPT
Update saved template metadata only: name, category, or identifier prefix. Does not create, edit, or repair template JSON or an open editor draft.

updateTemplateAssignments

ChatGPT
Assign templates to projects, set a company default, or reset a project override for site diary, induction, sign-on, SWMS checklist, notice, timesheet, and prequalification types. INSPECTION is unsupported. operation assignProjects (templateId, projectIds) replaces the template's projects; setAsDefault (templateId) makes it the company default, clearing project assignments, and rejects supplementary templates; resetProjectToDefault (projectId, templateType) clears that project's override. Does not edit structure.

updateTimesheetEntry

ChatGPT
Update a timesheet entry's date, hours, configured time type/cost code, status, times, notes, or linked response fieldUpdates. Answers require actual field labels and defined value shapes; timeType/costCode require exact configured labels/codes. Datetimes are absolute ISO with the project offset. Omitted fields are preserved; reusable definitions are unchanged. Configured workflows may send email or SMS; APPROVED_1 can also notify secondary approvers.

updateToolbox

ChatGPT
Update a toolbox talk/Meeting v2 meeting. Omitted scalar fields are preserved. agendaFieldUpdates and meetingFieldUpdates require the live template field definitions and preserve untouched fields. meetingTypeId changes the type. keys replaces the full list; [] clears it. Updates queue the meeting refresh workflow. When the resulting status is DISTRIBUTED, supplied workerIds add only new invites, notify those recipients, and schedule reminders.

updateToolboxAttendance

ChatGPT
Mark toolbox attendance, either for the supplied invitee adminUserIds and workerIds (the invite roster is not replaced), or with currentUser true for the signed-in user only, which marks them attended and affects nobody else. Marking worker attendance with builderGeneratedAttendance can also sign workers on and trigger configured email or SMS workflows. Signature capture is intentionally unavailable through this tool; use the returned authenticated toolbox webUrl.

updateToolboxInvites

ChatGPT
Change one toolbox's invites. create adds invites and skips duplicates; it never replaces the roster. markAttendance sets attended for the listed invitees, inviting any who are missing, and writes pre-start acknowledgements for workers; currentUser true marks only the signed-in user attended. With attended and builderGeneratedAttendance it can also sign workers on and trigger configured email or SMS workflows. archive removes one person's invite. Signature capture needs the returned toolbox webUrl.

updateWorkflowStatus

ChatGPT
Change whether a workflow runs. publish makes a draft the live, active version and archives the previously published version in its chain; activate and deactivate turn a published workflow on or off; discardDraft drops a draft and keeps the published version.

winpay_changeBills

ChatGPT
Changes bills: Supplier and subcontractor bills (accounts payable): the intake inbox, bill lines and tax, and approval and payment status. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Operations that take items save them all or none: if any row is refused, nothing is saved and the error lists each refused row. Pass operation and its input ({} when it takes none). Operations: - updateBill: Changes a bill's header; omitted fields are kept and null clears a field. Bills are created through intake or in BuildPass, not here. - archiveBill: Archives a bill and ends any approval in progress; refused while a pay application assessment holds it. restoreBill brings it back. - restoreBill: Restores an archived Bill to the state derived from its surviving axes. - linkBillPurchaseOrder: Links a bill to its purchase order, or confirms a link where suppliers differ. Needs bill edit and purchase order view. Choose mode: - link: Links the bill to a purchase order on its project, drawing down its committed cost; null clears. (purchaseOrderReference on updateBill is only a label.) - confirmCrossSupplier: Confirms the linked order although its supplier differs from the bill's vendor, clearing the mismatch flag. Refused if any of the three changed since you checked. - createBillLines: Adds up to 50 lines or tax lines to a bill. - updateBillLine: Changes one line or tax line on a bill. Choose kind: - line: Update bill line - taxLine: Update bill tax line - reorderBillLines: Reorder bill lines Also found as: supplier invoice, accounts payable, AP.

winpay_changeBudgets

ChatGPT
Changes budgets: The project's cost budget, its lines and groups (a cost code may carry several lines), with budget imports, the cost-control report, and buyout (which budget lines are let and when). Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Operations that take items save them all or none: if any row is refused, nothing is saved and the error lists each refused row. Pass operation and its input ({} when it takes none). Operations: - createBudget: Creates the project's draft budget; one per project. - createBudgetLines: Adds up to 50 lines to a draft budget. Several lines may share a cost code; give each a description to tell them apart. Each created line returns its ref (cost code plus a number, such as 03-200.2), which never changes. The budget has one Unallocated line at the top level (costCodeId null, no groupId); change it with updateBudgetLines. A line with no cost code inside a group is an ordinary line. If any row is refused, nothing is saved and the error names each one. - updateBudgetLines: Changes up to 50 lines on one draft budget; fields left out keep their value. Refused if a line has moved or been deleted. Baselined lines are fixed; money then moves by transfer, done in BuildPass. - recodeBudgetLine: Moves a draft budget line, with its amount, rate, note and ref, to another cost code. A cost code that already has lines gets one more. The spend on the line moves with it, except rows listed in leaveSpendIds and rows getBudget lineSpend says must stay; those keep the old cost code. - resetBudgetDraft: Deletes every line from a draft budget that has not been baselined, keeping the budget and its imports. Refused once transfers move money on any line, or while a buyout package from it is not cancelled. - createBudgetLinesFromScheduleOfValues: Takes projectId, not budgetId: creates a zero-amount line on the project's draft budget for each schedule of values line and cost code it maps to, grouped under broken-out lines; no amounts are copied. Only on an empty draft; refused when a schedule line has no cost code. - createBudgetGroups: Adds up to 50 groups to a draft budget to organise its lines. Groups may nest under a parent group. Put a line in a group with createBudgetLines groupId. getBudget view budget lists the groups. - updateBudgetGroups: Renames or moves up to 50 groups on a draft budget. A moved group takes its lines and subgroups with it, and cannot move inside itself. Move a line between groups with updateBudgetLines groupId. - updateBudgetFromEstimate: Takes projectId: applies the changes getBudget view estimateUpdatePreview listed, except the change ids in skip. Pass that preview's revision; a newer estimate or budget edit refuses it, so read the preview again. Lines the builder edited keep the builder's values, and lines added by hand are never touched. Refused once the budget is baselined. - updateBuyout: Plans letting for a project's cost codes: sets planned let dates, excludes or restores lines from letting, or records let coverage. Choose aspect: - plannedLetDate: Sets or clears one planned let date on the baselined budget lines for the given cost codes. All or nothing: every cost code needs a budget line, and the Unallocated allowance can't be scheduled. - lettingExcluded: Excludes a cost code's baselined budget line from letting (the Budget report is unaffected), or restores it. Refused when there is no budget line, or the line is already in procurement. - letCoverage: Records whether each cost code on a subcontract or purchase order is fully let. Ask the builder; there is no default. Needs a baselined budget and budget:edit. Also found as: budget, budget line, original budget, cost budget, cost control, schedule of values, budget group, budget section, estimate, reseed, sync budget, buyout, letting, let date, package, procurement.

winpay_changeCompaniesAndContacts

ChatGPT
Changes companies and contacts: The organisation's directory: client, supplier and subcontractor companies with their trade types, the people at them, and workers who log labour. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Operations that take items save them all or none: if any row is refused, nothing is saved and the error lists each refused row. Pass operation and its input ({} when it takes none). Operations: - createCompanies: Adds up to 50 companies (clients, suppliers, subcontractors). - updateCompany: Changes a company. Omitted fields are kept; null clears a field. - createContacts: Adds up to 50 contacts, each optionally at a company. - moveContacts: Moves every listed contact to one company, or with null removes them from their company. Returns each contact's previous company. - setPrimaryContact: Makes a contact their company's only primary contact, unsetting the previous one. The contact must already be at a company. - createWorkers: Adds up to 50 workers who log labour. - updateWorker: Update a worker Also found as: client, supplier, subcontractor, vendor, person, trade type.

winpay_changeCostCodes

ChatGPT
Changes cost codes: The cost breakdown every budget, bill and commitment is coded to: templates, project cost codes and their hierarchy, plus the organisation's cost types (labour, material, subcontract, equipment, other) that classify estimate lines. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Pass operation and its input ({} when it takes none). Operations: - updateCostCode: Changes one project cost code. Choose aspect: - visibility: Hides a project cost code and its subtree from budgets and pickers, or shows it again. - scopeOrigin: Marks a project cost code and its subtree as work the client instructed after the deal, or clears the mark. Cost-plus claims group costs by it. - moveCostCode: Moves a cost code under a new parent. Choose scope: - project: Moves a cost code and its subtree under a new parent, or to the top level. Codes and coded lines are unchanged; only roll-ups move. - template: Moves a template cost code and its subtree under a new parent, or to the top level. - createCostCodeTemplate: Creates one cost code template, blank or copied from a project's or preset's cost codes. Choose source: - blank: Create a cost code template - project: Create a template from an existing project's cost codes - preset: Create a template from a built-in preset - updateCostCodeTemplate: Update a cost code template - importProjectCostCodes: Imports a whole template or preset into a project; codes it already has are skipped. Adding a single cost code is not available here. Choose source: - template: Import project cost codes from a template - preset: Seed project cost codes directly from a baked-in preset - unlinkProjectCostCodeTemplate: Drops the link only; the project's cost codes stay. Also found as: cost breakdown.

winpay_changeDocuments

ChatGPT
Changes documents: Project and organisation documents and their folders, revisions and markups, including files attached to bills, claims and contracts. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Operations that take items save them all or none: if any row is refused, nothing is saved and the error lists each refused row. Pass operation and its input ({} when it takes none). Operations: - createFolders: Creates up to 50 folders under existing folders or at the top level (not under one created in the same call). - updateFolder: Rename a folder - moveFolder: Move a folder within its scope - linkDocumentRevision: Makes the document a newer revision of predecessorDocumentId and updates dependent takeoff quantities. Refused for proposal and template revisions. Also found as: file, drawing, attachment.

winpay_changeEstimateRecipes

ChatGPT
Changes estimate recipes: The organisation's estimate recipe library: reusable sections and lines, without rates, costs or markup, that are imported into estimates. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Pass operation and its input ({} when it takes none). Operations: - reorderEstimateRecipes: The recipe library: the listed recipes go first, the rest keep their order. Needs organisation-level estimate:edit. - createEstimateRecipe: Adds a recipe to the organisation library. It keeps library rate links, never prices or markup. Needs estimate:edit; a recipe holds at most 1000 sections, lines and rate sheet rows. Choose source: - sections: From one estimate's sections: pass estimateId or sectionIds. - empty: An empty recipe. - importEstimateRecipes: Adds recipes to an estimate as new sections and lines. Lines and rows linked to a live library rate take its current price; problem links, and cost codes, units and cost types the project lacks, are left off and listed. Preview with getEstimateRecipe view importPreview. Refused on an archived estimate. - createEstimateRecipePart: Adds a section to a recipe, a line to a recipe section, or a rate sheet row to a recipe line, at the end. Needs organisation-level estimate:edit. Choose kind: - section: A named section. - line: An unpriced line; RATE by default, and a LUMP_SUM line takes no quantity or unit. - rateSheetRow: Adds a breakdown row at the end of a recipe line. The first priced row takes over the line's own rate link. - updateEstimateRecipe: Changes a recipe, recipe section, recipe line or rate sheet row, including its library rate link; estimates already imported don't change. Needs organisation-level estimate:edit. Choose part: - recipe: Name or description. - section: Renames a section. - line: The fields given on a line; switching to LUMP_SUM clears quantity and unit. - rateSheetRow: Changes a recipe breakdown row. Changing its unit drops its rate link. Estimates already imported don't change. Also found as: recipe, recipe library, assembly, template section.

winpay_changeEstimates

ChatGPT
Changes estimates: Priced build-ups of a job: an estimate holds sections, each section holds scope items (lines with quantity, rate, cost and markup), plus fee and discount rows. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Operations that take items save them all or none: if any row is refused, nothing is saved and the error lists each refused row. Pass operation and its input ({} when it takes none). Operations: - createEstimates: Creates up to 50 estimates on one project. - updateEstimate: Changes an estimate's name, default markup or target margin. Refused on an archived estimate. - archiveEstimate: Archives an estimate, hiding it from the project's list; restoreEstimate brings it back with its lines and fees. - restoreEstimate: Restores a previously archived estimate. - createEstimateAdjustment: Adds a fee or discount row at the bottom of an estimate's stack. A percentage row's rate is in basis points (900 = 9%); a lump sum is integer cents. - updateEstimateAdjustment: Changes a fee or discount row's name, calculation, cost code, kind or presentation; fields left out keep their value. Percentage rates are in basis points (900 = 9%). - duplicateEstimate: Copies an estimate (archived or not) to a new active estimate on the same project, with its sections, priced lines, takeoff links, fees and discounts. Unlike a recipe, it keeps the money. RFQs, proposals and budgets are not copied. - createEstimateSections: Adds up to 50 sections to an estimate, in order. - updateEstimateSection: Changes a section's name, locations, or the cost code it passes down to lines that set none. - createRateSheetRows: Adds up to 50 rows to a scope item's rate sheet, in order. - startRateSheet: Adds a first priced row of 1 × the item's current rate or lump sum. Returns the first row if the sheet already exists. - updateRateSheetRow: Updates a row and re-derives the item's unit rate. Changing a library-priced row's rate or unit drops its library link. - applyRateSheetLibraryRate: Copies a library rate and unit onto a row, or a new row at the end. Later library edits don't change it. A rate's cost code number codes the row with the matching project cost code unless the user chose the row's code; unmatchedCostCode names a number the project lacks. - reorderEstimateParts: Puts a list in the given order, each item once. Scope items: reorderScopeItems. Choose kind: - sections: Reorders sections among their siblings. List every section once; each keeps its parent and takes its place among its siblings from where it falls in the list. To change a section's parent, move it. - adjustments: The fee and discount rows; rows on the estimate total stay last. - rateSheetRows: Reorders a scope item's rate sheet rows. List every row once. - createScopeItems: Adds up to 50 lines to one estimate section, in order. - updateScopeItems: Changes up to 50 lines, on any estimates; each row names its line and the fields to change, and the rest keep their value. - applyScopeItemRate: Copies a library rate's unit rate, unit (unless takeoff-linked), cost type and wastage onto a line. Later library edits don't change it. A rate's cost code number codes the line with the matching project cost code unless the user chose the line's code; unmatchedCostCode names a number the project lacks. Refused for an archived library, or on a takeoff-linked line when the units differ. - moveScopeItems: Moves lines, in their current order, to the end of a section of the same estimate. Moving into the options list offers them as proposed omissions; moving out returns them to ordinary scope. - reorderScopeItems: Puts a section's lines in the given order. - linkScopeItemTakeoff: Replaces a RATE line's takeoff measurement links; its quantity then follows them. Measurements must be on the same project in compatible units. - moveEstimateSection: Moves a section and everything in it inside parentSectionId (null: top level). Also found as: fee, discount, line item.

winpay_changeForecasts

ChatGPT
Changes forecasts: Forecast final cost (EAC) and cost-to-complete items, the live WIP report, cash forecasts and the organisation's portfolio roll-up and overheads. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Operations that take items save them all or none: if any row is refused, nothing is saved and the error lists each refused row. Pass operation and its input ({} when it takes none). Operations: - updateEacLines: Sets the forecast final cost of up to 50 budget lines of one project as one number each (eacCents or toCompleteCents), replacing the line's current figure. Name each line by budgetLineRef (e.g. "03-200.2") or budgetLineId; a cost code with one budget line needs only costCodeId. Use createForecastItems instead for named items of cost still to come; each item adds its amount on top of the current figure, so don't do both for the same cost. Each line once; nothing is saved if any row is refused. - createForecastItems: Adds up to 50 named items of cost still to come to one project; each raises its budget line's forecast final cost by its amount, or by the difference when it names a budgetRow the line already has. Name the line by budgetLineRef or budgetLineId when its cost code has more than one budget line. - linkForecastItem: Links the quote or document behind a forecast item. Choose kind: - quote: Links the forecast item to the received quote it was priced from. Only items classified quote, and the quote must be on the same project. Omit quoteId to clear. The link never changes the forecast amount. - evidence: Attaches a document from the item's project library as supporting evidence. Idempotent. - createOverheadHandEntries: Adds up to 50 monthly overhead amounts entered by hand. - updateOverheadHandEntry: Changes an entry's code, description, amount, start or end month. Set an end month to stop it counting later while keeping earlier months; endPeriodKey null makes it open-ended. Can't move to an archived code. Needs organisation-wide company_overhead:view and budget:edit. - updateOverheadRecovery: Sets the forecast revenue and the approved overhead recovery rate for one financial year in one currency. Omit a field to keep it; null clears it. New estimates use the approved rate of the current financial year only, so a rate set for another year applies only while that year is current. Changing it never changes an existing estimate. Needs organisation-wide company_overhead:view and budget:edit. Also found as: EAC, estimate at completion, cost to complete, WIP, work in progress, cash flow, company result, overheads.

winpay_changeInvoices

ChatGPT
Changes invoices: Invoices to the client (from claims, retention releases, standalone, and credit notes), their status and the payments received. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Pass operation and its input ({} when it takes none). Operations: - archiveInvoice: Archives a draft invoice, withdrawing any pending review; an issued invoice can't be archived. Its claim, release or credited invoice is free for a new invoice, and restoreInvoice brings the draft back. - restoreInvoice: Returns an archived invoice to draft. Also found as: receivable, payment received, tax invoice.

winpay_changeLabour

ChatGPT
Changes labour: Labour entries logged against a project, labour imports, and each role's loaded cost and default charge-out rate. Workers are under Companies and Contacts. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Operations that take items save them all or none: if any row is refused, nothing is saved and the error lists each refused row. Pass operation and its input ({} when it takes none). Operations: - createLabourEntries: Logs up to 50 labour entries on one project. Workers are listed and created under Companies and Contacts. - updateLabourEntry: Changes a labour entry and recalculates its cost. rateCents pins the rate; changing the worker or pay type re-prices it; an hours-only edit keeps it. - createLabourRates: Adds up to 50 role rates: loaded cost and optional charge-out. - updateLabourRate: Update a labour rate's rates (role is immutable) Also found as: labor, timesheet, hours, worker, charge-out rate.

winpay_changeLienWaivers

ChatGPT
Changes lien waivers: Lien waivers collected from subcontractors and suppliers against bills and payments (US). Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Operations that take items save them all or none: if any row is refused, nothing is saved and the error lists each refused row. Pass operation and its input ({} when it takes none). Operations: - createLienWaivers: Creates up to 50 draft lien waivers on one US project. - updateLienWaiver: Corrects a draft waiver; omitted fields are kept. Refused once the waiver is requested or later (it must then be voided and raised again, in BuildPass). Also found as: lien release, conditional waiver, unconditional waiver.

winpay_changeMainContract

ChatGPT
Changes main contract: The head contract with the client once a job is won: contract value, cost-plus fee schedule and estimated-cost revisions. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Pass operation and its input ({} when it takes none). Operations: - createMainContract: Creates the head contract with the client on a won project; one per project. A fixed-price contract takes its sum and retention from the project, so set the project's contract value first. A cost-plus contract has no sum: it needs feeSchedule and may carry an estimated total cost. Refused while the project is at tender. The schedule of values is set up afterwards. Also found as: head contract, contract sum, fee schedule, cost plus fee.

winpay_changeMonthEnd

ChatGPT
Changes month end: Accounting periods per project: the open period's close working, accruals, locked period snapshots, and opening balances for projects brought in part-way. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Operations that take items save them all or none: if any row is refused, nothing is saved and the error lists each refused row. Pass operation and its input ({} when it takes none). Operations: - createManualAccruals: Adds up to 50 manual accruals, for work no bill or purchase order covers yet, to a project's open period. Also found as: period close, GL tie-out, general ledger, opening balance.

winpay_changeProductFeedback

ChatGPT
Changes product feedback: Requests to the BuildPass team for something BuildPass cannot do today, sent as the person who asked. Help with their own records is a support request, not product feedback. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Pass operation and its input ({} when it takes none). Operations: - createProductFeedback: Files a product request with the BuildPass team as the signed-in person: something they want BuildPass to do that it cannot do today, such as restoring a discarded bill or adding an approval step. Not for help with their own records; that is a support request. Write the note in their words: what they wanted to do, on which record if any, and why. The title is a short summary. Also found as: feature request, product request, suggestion, missing.

winpay_changeProgressClaims

ChatGPT
Changes progress claims: Progress claims to the client (US: pay applications to the owner): drafts, pricing (lump sum or cost plus) and the client's payment response. A subcontractor's claim on you is under Subcontracts. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Operations that take items save them all or none: if any row is refused, nothing is saved and the error lists each refused row. Pass operation and its input ({} when it takes none). Operations: - createClaims: Creates up to 50 draft claims to the client, each on a main contract. Each claim gets one line per schedule of values line, at most 2,000 lines per save, so send claims on large schedules a few at a time. - updateClaim: Changes a draft claim. Choose aspect: - period: Changes a draft claim's period, or sets one claim date instead. A submitted claim's period can't change; revising it into a new draft is done by a person in BuildPass. A cost-plus claim always needs a period: it includes every unclaimed bill approved by the period end. - paymentTerms: Sets a draft claim's days of credit, how they are counted, or its own due date. Each field may be sent alone; null resets it to the default. The due date is frozen at submit. - disclosure: Overrides how much a draft claim discloses. Omitted fields are kept; null resets to the contract or organisation setting. periodEvidence on a lump-sum claim attaches or detaches the period's approved supplier invoices. - amendmentPresentation: Shows one finalised main contract amendment on the draft claim as one line or as its variations. Billing stays on the variation lines. - name: Sets the draft claim's name, shown beside its number on the claim and invoice line. - variationPresentation: Claims one approved variation on the draft claim as one line (default) or broken into its lines. Amounts already entered stay. - createStageClaim: Raises a draft claim dated the day a stage was reached, claiming the rest of that schedule line in full. Takes the stage's name unless name is given. Refused for cost plus, a stage already claimed in full, or a stage already on an open claim. - createClaimLines: Adds up to 50 rows to a draft claim. kind sovLine: lines against schedule of values lines; otherCost: hand-entered costs on a cost-plus claim. - updateClaimLines: Sets up to 50 lines on draft claims; each row names its line and a patch. Claim this period by amount (claimedNetCents) or percent (percentCompleteThisPeriodBp, basis points: 5000 = 50%), or state the total to date (claimedToDateNetCents or percentCompleteToDateBp), not both in one row. A total below the certified previous amount reduces this claim; above the scheduled value is refused. - updateClaimOtherCost: Changes an other cost on a draft cost-plus claim. Only fields sent change. Also found as: owner pay application, payment claim, payment schedule, billing, reimbursable.

winpay_changeProjects

ChatGPT
Changes projects: A job: client, site, contract type, stage, dates and its default rate library. Most other records hang off a project. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Operations that take items save them all or none: if any row is refused, nothing is saved and the error lists each refused row. Pass operation and its input ({} when it takes none). Operations: - createProjects: Creates up to 50 projects. - updateProject: Changes a project. Choose aspect: - fields: Changes project fields, including the head contract sum (see expectedContractSumCents). Omitted fields are kept; null clears a field that accepts null. - defaultRateLibrary: Sets or clears (null) the project's default rate library. - updateProjectLocations: Adds locations one at a time or from a pattern (8 buildings, 3 floors each, 4 units a floor), duplicates a location with everything beneath it, renames one or changes its kind, or moves it. Choose action: - add: Adds one location at the end of its parent's children. Names are unique among siblings. - addPattern: Adds many locations in one step, top level first: each level repeats under every location of the level above. Name templates use {n} for the location's own number, {building}, {floor} or {unit} for an ancestor's number, and {n:3} to pad with zeros. Up to 2,000 locations a step. - duplicate: Copies the location and all locations beneath it, placed right after it. Optionally replaces text in every copied name beneath it. - change: Renames a location or changes its kind. Sections and lines keep pointing at it. - move: Moves a location, with everything beneath it, under a new parent or to a new place among its siblings. - archiveProject: Archives a project; its records stay and restoreProject brings it back. - restoreProject: Restores an archived project. If another job took its number meanwhile, it gets a new one. Also found as: job, site, location, building, floor, unit, area.

winpay_changeProposals

ChatGPT
Changes proposals: Your priced offer to the client (AU: tender), derived from an estimate, with its working lines, sections and issued snapshots. A price a supplier sends you is a quote under Quotes. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Operations that take items save them all or none: if any row is refused, nothing is saved and the error lists each refused row. Pass operation and its input ({} when it takes none). Operations: - createProposal: Creates the project's draft proposal; refused if the project already has one. Add lines afterwards by deriving from an estimate. - deriveProposal: Overwrites every working line, including manual edits, with the estimate's scope items rolled up by grain at sell price. - updateProposal: Changes the proposal. Choose aspect: - header: Changes the proposal title, validity window and disclosed margin. Prose sections are updateProposalSection. - detailLevel: Sets how much breakdown the client sees: totalOnly (no lines), summary (grain lines, the default), unpricedItems (plus each line's items, unpriced), itemized (plus item sell prices) or fullScope (plus each item's scope text). Display only: hidden amounts stay in the total, and cost and markup are never shown. Frozen at issue. - template: Picks the organisation proposal document template that wraps the issued PDF, or null for the BuildPass standard layout. Frozen at issue. - createProposalLines: Adds up to 50 working lines to a proposal. - updateProposalLine: Changes a working line's description, amount, kind, cost codes or order. - createProposalSections: Adds up to 50 sections to a proposal: source custom for a new section, source saved to copy a saved one. - updateProposalSection: Changes a proposal section: a custom section by its sectionId, or a standard section by its role. Choose target: - section: Changes a custom section's heading, body, placement or order. startOnNewPage also works on well-known sections. - role: Sets a well-known section (coverLetter, inclusions, exclusions) from markdown-lite: blank line = paragraph, '- ' = bullet, bold, '| a | b |' lines = table ('| --- |' as the second line makes a header row). Also found as: tender, quote to client, offer.

winpay_changePurchaseOrders

ChatGPT
Changes purchase orders: Purchase orders to suppliers: drafts and their lines, what has been billed against each, and what remains committed. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Operations that take items save them all or none: if any row is refused, nothing is saved and the error lists each refused row. Pass operation and its input ({} when it takes none). Operations: - createPurchaseOrders: Creates up to 50 draft purchase orders on one project, each to one supplier with at least one line (200 lines in total at most). Nothing is saved if any order is refused. - derivePurchaseOrder: Raises a draft purchase order from a bill or an accepted quote. Choose source: - bill: Creates a DRAFT purchase order from a bill, which supplies the project, supplier and lines. If the budget is baselined, ask the builder whether each cost code is fully let and record it with changeBudgets updateBuyout aspect letCoverage. - quote: Creates a DRAFT purchase order from a received quote, with its project, supplier, scope and ex-tax lines (add-on lines left off). A quote backs one purchase order or one subcontract, never both; repeating returns the existing order. - updatePurchaseOrder: Edits the header of a DRAFT purchase order; fields left out keep their value. Needs purchase_order:edit. - createPurchaseOrderLines: Adds up to 50 lines to a draft purchase order. - updatePurchaseOrderLines: Changes up to 50 purchase order lines; each row names its line and the fields to change, and the rest keep their value. Also found as: purchase order, PO, order, supplier order, committed cost, commitment.

winpay_changeQuotes

ChatGPT
Changes quotes: Quotes suppliers and subcontractors sent back, their lines and tax basis, the leveled comparison, and award mapping of quote lines onto estimate scope. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Operations that take items save them all or none: if any row is refused, nothing is saved and the error lists each refused row. Pass operation and its input ({} when it takes none). Operations: - createQuote: Records a price a supplier sent you outside BuildPass against an RFQ; it lands RECEIVED and marks the recipient as responded. Reviewing, awarding and converting it are done by a person in BuildPass. Needs budget:view. Refused when the RFQ is cancelled, the supplier is archived, the total or tax is negative, or the source document is outside the organisation. Line amounts may be negative. - updateQuote: Corrects terms captured during review; fields left out keep their value. - createQuoteLines: Adds up to 50 lines to a quote. - updateQuoteLines: Changes up to 50 quote lines; each row names its line and the fields to change, and the rest keep their value. - setQuoteLinesTaxBasis: Sets whether quote line amounts include tax. Choose target: - lines: Sets one tax basis on the listed lines, keeping each line's own rate. - needsReview: Sets one tax basis on every line with no basis yet, keeping each line's own rate. - updateAwardMapping: Changes how an RFQ's quotes map onto estimate scope items; each action survives mapping re-runs and clears any prior confirmation. Choose action: - itemCoverage: Sets coverage, covering quotes and covered amount for one estimate scope item. GAP lists no quotes. - itemsOutOfScope: Marks estimate scope items out of this RFQ's award scope (not counted as gaps), or clears the flag. - unmatchedLineDismissal: Dismisses a quote line the estimate has no match for, or restores it. - placeUnmatchedLine: Counts an unmatched quote line toward an existing estimate line instead of a new one. Refused for a deduction or a line the estimate already carries. - wholeQuote: Prices one estimate line at an awarded itemised quote's ex-tax total; lines only it covered become gaps and its unmatched lines are dismissed. Refused when the quote shares a line with another quote, or another quote prices the line. - chooseEstimate: For an RFQ raised without estimate scope, sets the project estimate its awarded quotes map onto and queues a mapping run. Refused when the RFQ came from an estimate, no quote is awarded, or the estimate is archived. Also found as: quote, bid, tender, leveling, award.

winpay_changeRatesAndTakeoffs

ChatGPT
Changes rates and takeoffs: Rate libraries and their unit rates that price estimate lines, measurement units, and takeoffs that measure quantities off drawings. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Operations that take items save them all or none: if any row is refused, nothing is saved and the error lists each refused row. Pass operation and its input ({} when it takes none). Operations: - createRateLibraries: Creates up to 50 rate libraries. - updateRateLibrary: Update a rate library (name and/or subdivision defaults) - createRates: Adds up to 50 rates to one rate library. - updateRates: Changes up to 50 rates in active libraries; each row names its rate and the fields to change, and the rest keep their value. - createTakeoff: Creates the project's takeoff, or returns the one it has unchanged (one per project; name is ignored then, rename with updateTakeoff). - updateTakeoff: Rename a takeoff - createTakeoffItems: Adds up to 50 measurements to a takeoff. - updateTakeoffItem: Update a takeoff measurement item - reorderTakeoffItems: Puts a takeoff's measurements in the given order; list every one once. Also found as: unit rate, price book, quantity, scale.

winpay_changeRetention

ChatGPT
Changes retention: Retention the client holds on claims (balances, ledger entries, releases) and releases of retention held from subcontractors. Retention held per subcontract is projected under Subcontracts. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Operations that take items save them all or none: if any row is refused, nothing is saved and the error lists each refused row. Pass operation and its input ({} when it takes none). Operations: - createRetentionReleases: Raises up to 50 draft retention releases. side receivable: retention the client holds on a main contract; payable: retention held from a subcontractor. Also found as: retainage, retention release, practical completion, defects liability.

winpay_changeRfqs

ChatGPT
Changes rfqs: Requests for quote or tender sent to suppliers and subcontractors: versions, documents, recipients and reminders. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Operations that take items save them all or none: if any row is refused, nothing is saved and the error lists each refused row. Pass operation and its input ({} when it takes none). Operations: - createRfqs: Creates up to 50 draft RFQs on one project as one batch; estimateId and ccEmails apply to all. Add documents with attachRfqDocument. Nothing is saved if any is refused. Recipients and issuing are done in BuildPass. Returns the batch ID and RFQ IDs in order. - updateRfq: Edits a DRAFT RFQ; once issued, changes need an addendum. - attachRfqDocument: Attaches a document to the draft version; repeating is harmless. Refused once issued (changes need an addendum). Visibility flags start off; set them with updateRfqDocument. - updateRfqDocument: Sets any of showMarkup, showShapeLabels and showMeasurements on a document of a draft RFQ; after issue, changes need an addendum. Off by default so subs price their own quantities. - updateRfqRecipient: Changes one recipient: bid intent, access or notified contacts. Choose aspect: - bidIntent: Records whether the company intends to bid, as the builder heard it (subs can also set it in the portal). Allowed once the RFQ is ISSUED or CLOSED. - access: Revokes or restores one recipient's link once the RFQ is issued; while revoked they can't open, download or respond and get no further emails. Sent emails aren't recalled. - notifiedContacts: Replaces the contacts notified for a recipient while the RFQ is DRAFT. Also found as: RFQ, request for quote, request for tender, tender package, bid, leveling.

winpay_changeScheduleOfValues

ChatGPT
Changes schedule of values: The schedule of values (AU: claim schedule) that splits the contract value into lines progress claims bill against. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Operations that take items save them all or none: if any row is refused, nothing is saved and the error lists each refused row. Pass operation and its input ({} when it takes none). Operations: - createScheduleOfValues: Creates the one draft schedule of values under a main contract; then add lines or seed it from an estimate. To correct a lump-sum contract sum before baseline, use changeProjects updateProject (aspect fields). - createScheduleOfValueLines: Adds up to 50 lines to a draft schedule of values, in order. If any row is refused, nothing is saved and the error names each refused row. - updateScheduleOfValueLines: Changes up to 50 lines; each row names its line and the fields to change, and the rest keep their value. itemNumber is the number a line shows, so renumber lines by sending each one its new number. After baseline only description and itemNumber change here; move value with moveScheduleOfValueLineValue. - setScheduleOfValueLineCostCodes: Sets the cost codes a line is linked to (its WIP split), also after baseline. Refused when the schedule is locked or archived, the main contract is closed, or the line has sub-items (map those instead). An empty list clears the links. - moveScheduleOfValueLineValue: After baseline, moves an amount between two lines of one schedule; the contract sum is unchanged. Check view valueMoves first. - reorderScheduleOfValueLines: Reorders the top-level lines, or the sub-items of parentLineId. List every line in that group once. - seedScheduleOfValues: Fills an empty draft schedule from an estimate: scope items roll up into lines, the contract sum is spread by sell value, and allowance, PC item and provisional sum lines join the allowance register. Check view estimateSeedPreview first. Also found as: SoV, SoV line, claim schedule, contract breakdown, renumber, cost code mapping, estimate handoff.

winpay_changeSchedules

ChatGPT
Changes schedules: The construction programme (Gantt): schedules and their items with dates, not money. The schedule of values is a separate family. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Operations that take items save them all or none: if any row is refused, nothing is saved and the error lists each refused row. Pass operation and its input ({} when it takes none). Operations: - createSchedules: Creates up to 50 empty schedules on one project; tasks cannot be added here. - duplicateSchedule: Copies a programme's tasks, dependencies and assignees into a new programme, shifting dates so the first item starts on startDate. Cost codes and scope links carry only within this project. The response counts what was left blank; getScheduleRecord kind copySummary lists it. - updateSchedule: Update a schedule - linkSchedulePredecessor: Add one item this item waits on - createScheduleItems: Adds up to 50 items to one schedule. A phase is top level; a task or milestone sits under a phase or task (parentId), so add phases first and their tasks in a second call. Refused while the programme is still being drafted from the estimate. - updateScheduleItems: Changes up to 50 schedule items; each row names its item and the fields to change, and the rest keep their value. predecessors replaces the item's whole list. A phase cannot become a task or milestone, nor the other way. - reorderScheduleItems: Sets each named item's sortOrder and, when parentId is given, moves it under that item (null moves it to the top level). Up to 50 items per call; items left out keep their place. Also found as: programme, program, Gantt, task, predecessor.

winpay_changeSubcontracts

ChatGPT
Changes subcontracts: Subcontracts let to trades: scope sections and lines, agreements, contract documents, change orders, back-charges, and the subcontractor's claims (pay applications) against them. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Operations that take items save them all or none: if any row is refused, nothing is saved and the error lists each refused row. Pass operation and its input ({} when it takes none). Operations: - createSubcontractLines: Adds up to 50 lines to a subcontract. - updateSubcontractLines: Changes up to 50 lines on DRAFT subcontracts; each row names its line and the fields to change, and the rest keep their value. An executed subcontract changes through change orders. - reorderSubcontractLines: Reorder draft subcontract lines - createSubcontractScopeSections: Adds up to 50 scope sections to a DRAFT subcontract: custom (source custom) or copied from the library (source saved). - updateSubcontractScopeSection: Updates a custom section on a DRAFT subcontract; fields left out keep their value. - attachSubcontractDocument: Attaches an existing project document to a subcontract, or as evidence on a pay application. Choose target: - subcontract: Links a project document to the subcontract as backup; repeating is harmless. Refused once the subcontract is CANCELLED or TERMINATED. - payApplicationEvidence: Retain a project document as assessment evidence - createSubcontractChangeOrders: Creates up to 50 draft change orders on one EXECUTED subcontract. These are changes with a subcontractor; a change with the client is a Variation. - updateSubcontractChangeOrder: Updates a DRAFT change order's header; fields left out keep their value. - createSubcontractChangeOrderLines: Adds up to 50 lines to a draft subcontract change order. - updateSubcontractChangeOrderLines: Changes up to 50 subcontract change order lines; each row names its line and the fields to change, and the rest keep their value. - createSubcontractorAgreements: Creates up to 50 subcontractor agreements. - updateSubcontractorAgreement: Update subcontractor agreement - updatePayApplication: Sets claim details on a subcontractor's DRAFT or SUBMITTED pay application (your claims to the client are Progress Claims). Fields left out keep their value; null clears. Needs pay_application:edit; changing paidBeforeBuildPass with a linked bill also needs bill:edit (refused once in accounting), and setting it true needs bill:pay. - createSubcontract: Creates a draft subcontract with a vendor on a project. Value, scope, lines and inclusions stay editable while it is a draft. lines are lump sums: when given, the value is their total and valueCents is ignored. Refused when a line has an empty description, a negative or fractional amount, or an archived or off-project cost code. Add rate lines and cost types afterwards with createSubcontractLines. If the budget is baselined, ask whether each cost code is fully let and record it with updateBuyout aspect letCoverage. Also found as: subcontract, subcontractor, trade contract, scope section, subcontract change order, back-charge, backcharge, pay application, subcontractor claim, subcontractor agreement.

winpay_changeVariations

ChatGPT
Changes variations: Variations (US: change orders) to the contract with the client, formal contract amendments, and change events that track possible changes before they are priced. A change with a subcontractor is a subcontract change order under Subcontracts. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Operations that take items save them all or none: if any row is refused, nothing is saved and the error lists each refused row. Pass operation and its input ({} when it takes none). Operations: - createVariations: Creates up to 50 draft variations (changes with the client) on one project, numbered in turn, with at most 500 lines across them. For a "change order", check which party it is with; a subcontractor's is createSubcontractChangeOrders. - updateVariation: Changes a draft variation's header. The number can change in any status. Title, description and notes can also change when submitted, or approved without a client signature; that marks the notice out of date, and an open signature request must be recalled first. - createVariationLines: Adds up to 50 cost or sell lines to a draft variation. - updateVariationLines: Changes up to 50 lines on draft variations; each row names its line and the fields to change, and the rest keep their value. - mirrorVariationLine: Creates the matching line on the other side: a sell line from a cost line, or the reverse. Choose direction: - toSell: Creates the linked sell line that prices a cost line to the client. - toCost: Creates the linked cost line behind a sell scope line. - createMainContractAmendments: Creates up to 50 formal contract amendments on one project, each grouping variations. - updateMainContractAmendment: Changes a draft amendment's reference, variations, or what its document shows for each variation. - setChangeEventStatus: Moves a change event to open, closed or void. Void is final and refused while a live change is raised from it; it needs variation:archive. - createAllowances: Adds up to 50 rows to the client contract's allowance register (allowances, PC items, provisional sums) on one project. The budget's Unallocated allowance is a budget line, not this. - updateAllowances: Changes up to 50 allowance register rows; each row names its allowance and the fields to change (wording, family, amount, whether it waits on a client choice, due date), and the rest keep their value. - updateAllowanceOption: Edits a candidate option offered to the client for an allowance. Also found as: change order, change event, contract amendment, allowance, selection, provisional sum, prime cost.

winpay_getBillInvoiceFile

ChatGPT
Gets a download link for the original invoice file on one bill: the file the supplier or subcontractor sent, unchanged. It is never a BuildPass summary or export. Get the billId from readBills, operation listBills, view bills; rows come newest first with their project and createdAt. A person without organisation-wide bill access passes projectId to list one project at a time. The result has fileName, mimeType, fileSize and a downloadUrl. Pass downloadUrl to the tool that saves the file, or fetch it with GET and no headers. It works for 10 minutes, so ask for it right before you use it. Ask again if it has expired. status no_file means the bill has no invoice file. status too_large means the file is over the 50 MB limit and someone must download it from the bill in BuildPass. Needs bill:view on the bill.

winpay_getDocumentContent

ChatGPT
Reads the file of one document: a project document or revision, an RFQ attachment or extract, or a quote's source file. Get the documentId from another tool, e.g. listRfqs kind documents, a revision chain, or a quote's sourceDocumentId. PDFs and spreadsheets return as text with a marker per page or sheet, for citing. A long file returns in parts: pass nextPage and nextCharacter to the next call until both are null. Images return as an image. Needs document:view on a project the document, or its email thread, belongs to.

winpay_readAccounting

ChatGPT
Reads accounting: Connections to the accounting system (Xero, QuickBooks and others): bill export setup, import candidates and API usage. Pass operation and its input ({} when it takes none). Operations: - listAccounting: Lists accounting connections or bill import candidates. Choose kind: - connections: Lists the organisation's accounting connections. - billImportCandidates: Accounting-system bills waiting to import. - getAccountingRecord: Reads one accounting connection or import candidate. Choose view: - apiUsage: Estimated API requests this UTC month against a monthly reference (not Sage's billable balance). Check evaluatedAt; it may be stale. - setup: The setup steps this connection needs before bills export, each with state, what is missing and who can fix it; nextStepId is the next required step. waiting_bills groups unexported approved bills by blocker. Needs accounting:list or accounting:manage. - billImportCandidate: One import candidate with its linked or suggested BuildPass bills and how well each matches. Also found as: Xero, QuickBooks, MYOB, export.

winpay_readApprovals

ChatGPT
Reads approvals: Approval policies and chains: who approves what, the approvals waiting on me, and settled approvals. Pass operation and its input ({} when it takes none). Operations: - listApprovals: Lists approvals. Choose view: - pending: Records whose current approval step is waiting on the caller, oldest first. - board: Every in-progress approval chain, with its record, current step and pending approvers. - settled: Approved, rejected or withdrawn approval chains, newest first, with who settled each, when and why. Records the caller cannot view are left out, so a page can be short. - getApprovalRecord: Reads approval setup: chain is one record's steps and history, policy is the rules for one transaction type. Choose kind: - chain: One record's approval chain: steps, current step, and who acted when. - policy: The approval policy for one transaction type: ordered steps with conditions, the separation-of-duties flag, and the default step template. - projectClientApproval: Whether a Cost Plus project's client must approve purchase orders and subcontracts: active (confirmed), policy (already required by policy) or suggested (not gated), plus the client contact it would email. Null if not Cost Plus. Also found as: approver, sign-off.

winpay_readBills

ChatGPT
Reads bills: Supplier and subcontractor bills (accounts payable): the intake inbox, bill lines and tax, and approval and payment status. Pass operation and its input ({} when it takes none). Operations: - listBills: Lists bills. For one project's bills, use view bills with projectId. Choose view: - bills: Lists bills (summary fields only). Follow continueCursor until isDone is true, even after an empty page. - costCodeTotals: Bill line totals per cost code (default statuses: APPROVED and PAID). - intakeQueue: Lists bill intake records by review state; pending (default) holds parked attachments awaiting a decision. - intakeFeed: Recent intake records in every state: created bills, parked and skipped. - intakeAddresses: The organisation's bills@ email address and each project's bill intake address. - getBill: Reads one bill. Choose view: - bill: Get bill - lines: List bill lines - taxLines: List bill tax lines - payments: Payments recorded against a bill, oldest first, including voided ones (voidedAt set). - status: Get bill status axes Also found as: supplier invoice, accounts payable, AP.

winpay_readBudgets

ChatGPT
Reads budgets: The project's cost budget, its lines and groups (a cost code may carry several lines), with budget imports, the cost-control report, and buyout (which budget lines are let and when). Pass operation and its input ({} when it takes none). Operations: - getBudget: Reads the project's cost budget. Choose view: budget (groups, lines with their ref and description, and totals; null before one exists), report (cost-control report per cost code; projected cost is the system figure, the PM's forecast is readForecasts eacReport), estimateViewReport (the same report by budget group and line, with each line's forecast), imports, transfers (newest first), undoBaselineBlockers (what blocks undoing the baseline, done in BuildPass), lineBuildUp (estimate lines behind a budget line), lineSpend (spend on a budget line, each row with why it would keep its cost code if the line moved to costCodeId), estimateScope (estimate scope for cost codes, no dollars), estimateSeedPreview (what seeding from an estimate would create; seeding is done in BuildPass), estimateUpdatePreview (what updating a draft budget from its revised estimate would change; apply with updateBudgetFromEstimate), scheduleOfValuesSeedPreview (lines createBudgetLinesFromScheduleOfValues would create). - getBuyout: Reads buyout: coverage (which budget lines are let, and when), a buyout package (an RFQ) or suggested let dates. Choose view: - coverage: Per cost code: Revised budget, committed cost and letting in progress, plus grand total and Unallocated. hasBudget and isDraft show whether a baselined budget exists. - package: Package name, scope of works (notes), the budget lines it covers as cost-code labels, and its itemized scope (no dollar figures). A package is an RFQ; pass its rfqId from readRfqs listRfqs. - letDateSuggestions: Suggests planned let dates from the project's programme: the earliest matching task start minus the cost code's let lead time (default 4 weeks). Also found as: budget, budget line, original budget, cost budget, cost control, budget report, budget transfer, build-up, buyout, letting, let date, package, procurement.

winpay_readCompaniesAndContacts

ChatGPT
Reads companies and contacts: The organisation's directory: client, supplier and subcontractor companies with their trade types, the people at them, and workers who log labour. Pass operation and its input ({} when it takes none). Operations: - listDirectory: Lists the organisation's directory. Choose kind: - companies: Lists the organisation's companies. - contacts: Lists the organisation's contacts. - workers: List workers - tradeTypes: Built-in subcontractor trades and the organisation's own trade and supplier types, each with the cost codes it suggests for a company's bills. - getDirectoryRecord: Reads one company or contact. A company's people are listDirectory with kind contacts and its companyId. Choose kind: - company: Get company - contact: Get contact Also found as: client, supplier, subcontractor, vendor, person, trade type.

winpay_readCorrespondence

ChatGPT
Reads correspondence: Letters and correspondence threads on a project or subcontract, and the organisation's letter templates. Pass operation and its input ({} when it takes none). Operations: - listCorrespondence: Lists correspondence. Choose kind: - projectItems: The project's draft and issued letters, newest first. - subcontractItems: Letters to this subcontract's party, newest first. - threads: The project inbox: every email thread on the project, newest activity first. - templates: The organisation's letter templates (name and wording), in display order. - recipients: Who a letter can be addressed to: the client, each live subcontract, and suppliers on purchase orders. - getCorrespondenceRecord: Reads one correspondence item or inbox thread. Choose kind: - item: Get a correspondence item by ID - thread: A thread's messages with attachments, send status and the record it belongs to. Also found as: letter, email, inbox, message.

winpay_readCostCodes

ChatGPT
Reads cost codes: The cost breakdown every budget, bill and commitment is coded to: templates, project cost codes and their hierarchy, plus the organisation's cost types (labour, material, subcontract, equipment, other) that classify estimate lines. Pass operation and its input ({} when it takes none). Operations: - listCostCodes: Lists cost codes and the records that organise them. Monthly overhead amounts are changeForecasts createOverheadHandEntries. Choose kind: - projectCostCodes: List cost codes for a project - projectCostCodeSearch: Search project cost codes - templateCostCodes: List cost codes for a template - overheadCostCodes: Company-level codes for costs outside any project (insurance, rent, vehicles); company bills code to these. - templates: List cost code templates - presets: List built-in cost code presets - overheadAccounts: Expense and untyped accounts from the connected Xero or QuickBooks company, with how each is already linked or mapped. otherAccounts lists the other active accounts. - costTypes: Lists cost types: the five built-in ones and any the organisation added. - getCostCodeRecord: Reads one cost code or template. defaultTemplate returns the organisation's default template; organisationDefaultTemplateId only its ID. Choose kind: - costCode: Get a project cost code - template: Get a cost code template - defaultTemplate: Returns the organisation's default cost code template, or null. Creating one is done by a person in BuildPass. - organisationDefaultTemplateId: Returns the organisation's default cost code template ID only, or null. - projectTemplate: Get the cost code template linked to a project Also found as: cost breakdown.

winpay_readDocuments

ChatGPT
Reads documents: Project and organisation documents and their folders, revisions and markups, including files attached to bills, claims and contracts. Pass operation and its input ({} when it takes none). Operations: - listDocuments: Lists documents and folders. Choose kind: - organisationDocuments: Documents across the organisation, with files and download URLs. - projectDocuments: List documents filed in a project - folders: List folders in a project or organization scope - getDocumentRecord: Reads one document's details or one folder. To read a document's text, use getDocumentContent. Choose view: - document: Get document metadata, files and download URLs - revisions: List document revisions from oldest to newest - currentRevision: Get the current document in a revision chain - folderPath: Get the document's folder ancestry names - typeChoices: The current type first, then each type the document editor offers. A blocked type carries its reason: owned_by_record, added_from_workflow, document_stays_in_folder, folder_holds_other_types, or type_lives_in_folder (the last three with the system folder kind). - destinations: Folders in the document's scope that the filing rule accepts for its type, and whether the scope root is one of them. - projects: List projects linked to a document - markup: Get the markup overlay for a Document - folderBreadcrumbs: Get folder ancestry - folderContentCounts: Count documents and folders beneath a folder Also found as: file, drawing, attachment.

winpay_readEstimateRecipes

ChatGPT
Reads estimate recipes: The organisation's estimate recipe library: reusable sections and lines, without rates, costs or markup, that are imported into estimates. Pass operation and its input ({} when it takes none). Operations: - listEstimateRecipes: Lists the organisation's recipe library, or the recipes a project's estimates can import. Choose kind: - library: Lists the whole org recipe library with section and line counts, including recipes with no sections. - forProject: Lists the org recipes that can be imported into this project, with section and line counts. Omits recipes with no sections. Empty without estimate:edit on the project. - getEstimateRecipe: Reads one recipe with its sections and lines, or previews what importing recipes into an estimate would add. Choose view: - recipe: Returns one recipe with its sections and lines. - importPreview: Previews importing the given recipes into this estimate: the library rate links that will price lines, the links that can't (missing, archived or a different unit), and the cost codes, units and cost types the project can't resolve. Also found as: recipe, recipe library, assembly, template section.

winpay_readEstimates

ChatGPT
Reads estimates: Priced build-ups of a job: an estimate holds sections, each section holds scope items (lines with quantity, rate, cost and markup), plus fee and discount rows. Pass operation and its input ({} when it takes none). Operations: - listEstimates: Lists a project's estimates, with or without totals, or reads the approved overhead recovery rate new estimates start from. Choose kind: - estimates: Lists a project's estimates with their default markup. - estimatesWithTotals: Lists a project's estimates with each one's sell total: every line at its own markup, then fees and discounts. - overheadRecovery: The approved overhead recovery rate for the current financial year in the project's currency, and nothing else: no overhead totals or revenue. approvedBasisPoints is null when no rate is approved. Needs estimate:edit on the project. - getEstimate: Reads an estimate or a part of it. view estimate is the header only; view pricing splits the sell price into cost, overhead and profit; lines are getScopeItems, totals listEstimates kind estimatesWithTotals. Choose view: - estimate: Returns one estimate, or null. - pricing: Splits the estimate's sell price into parts that add up to it: costCents (direct cost plus coded fee rows), overheadRecovery.amountCents (the overhead recovery row, with its rate), and profitCents, everything else. profitBasisPoints is profit as a share of sell. All amounts are integer cents in the project's currency. overheadRecovery is null when the estimate has no overhead recovery row. Needs estimate:view. - sections: Lists an estimate's sections in tree order: each section is followed by the sections inside it. parentSectionId names the section a section sits inside; absent is top level. costCodeId is the cost code the section passes down to the lines beneath it that set none of their own. - adjustments: Lists the estimate's fee and discount rows in calculation order; a running-subtotal row prices on every row above it. The row with purpose overhead_recovery recovers company overheads as a share of the estimate total. canAddOverheadRecovery says whether the estimate can take an overhead recovery row, and a row's canBecomeAnotherFee says whether its cost code, kind and base can change. - rateSheetRows: Lists the rate sheet rows of every item on an estimate, grouped by item. Returns one page of rows and totalRows; while isDone is false, pass continueCursor as paginationOpts.cursor for the next page. - section: Returns one section, or null. - scopeItemRateSheet: Lists the rows that build a scope item's unit rate. While it has rows, its unit rate is their sum. - getScopeItems: Reads an estimate's lines: allLines every line of the estimate, sectionLines one section's lines in order, item one line (null if missing). A line's quantity, rate, cost and markup are for one location: it counts at each location in its own locationIds, else its nearest section's, so read estimate totals from the estimate's pricing, not by adding lines. allLines and sectionLines: Returns one page of rows and totalRows; while isDone is false, pass continueCursor as paginationOpts.cursor for the next page. Also found as: fee, discount, line item.

winpay_readForecasts

ChatGPT
Reads forecasts: Forecast final cost (EAC) and cost-to-complete items, the live WIP report, cash forecasts and the organisation's portfolio roll-up and overheads. Pass operation and its input ({} when it takes none). Operations: - getProjectForecast: Reads one project's cost forecast (EAC), WIP or cash forecast. Choose view: - eacReport: The PM's forecast final cost (EAC) per cost code, summed up the hierarchy: forecast final cost, cost to date, cost to complete and % complete, with its source and a stale flag. Empty until the forecast is seeded. The system's projected cost is in the budget report. - eacCostCodeRows: The rows behind a budget line's forecast to complete. origin forecast: the open forecast items, with forecastItemId. Other origins show where a forecast could start from, as total cost: history (last saved rows), budget (the budget line's quantity × rate), estimate (a copy of the estimate lines on this code) or none. Items added on top show among those rows. - eacRevisions: Forecast final cost revisions, newest first (each revised line and added forecast item), with previousEacCents, revisedBy and revisedAt. - wipReport: Live WIP (work in progress) report for the project's main contract: the over/under-claimed position and an advisory split by cost code. Pass asAtDay to read the end of a past day in the site timezone; later days are refused. Use wipPeriod for a locked month. - wipPeriod: The WIP report of one locked month, rebuilt from its frozen snapshot (same shape as the live report, never recomputed). valuation uses the method frozen on the lock. Null when the month has no locked snapshot. The cost-side month-end snapshot is under month end. - wipEarnedRevenueOverride: The earned-revenue override in effect (amount, reason, who set it and when), or null. It replaces the computed contract-level earned revenue on the WIP report. - cashflow: The project's cash forecast by month: cash out from commitments and uncommitted budget, cash in from the claim schedule, with running balance, lowest point and retention still held. Months up to the latest locked period are actuals. - getPortfolio: Organisation-wide figures. Choose view: - rollUp: One row per project for a month (default this month): contract sum, cost to date, forecast final cost, margin, billings and over/under-claimed. Locked months read their snapshot. Totals are per currency. - companyResult: The organisation's last 12 months per currency: project margin less overheads. Each currency's recovery is retired and always reads zero; the approved overhead recovery rate lives with the overhead budget. Needs organisation-wide company_overhead:view. - cashflow: Organisation-wide cash forecast: every non-archived project's monthly cash line summed per currency, with the lowest point and the projects that drain or fund cash most. - overheads: Each overhead code's budget, spend and projected year end for one financial year in one currency, with the year's totals. For each month left, a code projects its budget, or without a budget its average monthly spend so far from the books and approved bills, plus future hand entries. projectedYearEndCents = ytdSpendCents + remainingBudgetCents + remainingRunRateCents + remainingHandEnteredCents; unforecastCodeCount counts codes with no budget and no spend to average, which project zero. recovery holds the forecast revenue, the calculated recovery rate (totals.projectedYearEndCents over forecast revenue, in basis points; null without a forecast revenue) and the approved rate. Needs organisation-wide company_overhead:view. - overheadsSetup: The overhead setup checklist: each step's state, what blocks it, and who can fix it. Needs organisation-wide company_overhead:view. - overheadHandEntries: Overhead amounts entered by hand for costs the books don't show (for example an unpaid director wage), each counted monthly over its period. Needs organisation-wide company_overhead:view. Also found as: EAC, estimate at completion, cost to complete, WIP, work in progress, cash flow, company result, overheads.

winpay_readInvoices

ChatGPT
Reads invoices: Invoices to the client (from claims, retention releases, standalone, and credit notes), their status and the payments received. Pass operation and its input ({} when it takes none). Operations: - listInvoices: Lists invoices to clients. Choose view: - invoices: Invoices to clients, paged: standard, progress claim, retention release and credit notes. - rollups: Exact counts and money totals per status. - getInvoice: Reads one invoice. Choose view: - invoice: One invoice with lines, tax lines, timeline and settlement. payment.paymentStatus is UNPAID, PART_PAID, PAID or CREDITED. settlementActions says whether record_receipt, credit and write_off are allowed, or what blocks each. - payments: Payments recorded against the invoice (not voided), oldest first. Also found as: receivable, payment received, tax invoice.

winpay_readLabour

ChatGPT
Reads labour: Labour entries logged against a project, labour imports, and each role's loaded cost and default charge-out rate. Workers are under Companies and Contacts. Pass operation and its input ({} when it takes none). Operations: - listLabour: Lists labour. Choose kind: - entries: List labour entries for a project - rates: List labour rates - getLabourImport: The import's status and, once AWAITING_REVIEW, its proposalJson: the column mapping and proposed rows with matched workers, cost codes and duplicate or rate flags. Also found as: labor, timesheet, hours, worker, charge-out rate.

winpay_readLienWaivers

ChatGPT
Reads lien waivers: Lien waivers collected from subcontractors and suppliers against bills and payments (US). Pass operation and its input ({} when it takes none). Operations: - listLienWaivers: Lists lien waivers with payee, bill number and whether each is effective (conditional: received and payment cleared; unconditional: received). - getLienWaiverRecord: Reads lien waivers (US). Choose view: - waiver: One lien waiver with its payee, linked bill and whether it is effective. - billCoverage: Whether lien waivers hold up paying one bill: the project's mode (warn or block), pending reasons and the waivers behind them. Also found as: lien release, conditional waiver, unconditional waiver.

winpay_readMainContract

ChatGPT
Reads main contract: The head contract with the client once a job is won: contract value, cost-plus fee schedule and estimated-cost revisions. Pass operation and its input ({} when it takes none). Operations: - getMainContract: Reads the head contract with the client. It is set up in BuildPass, not here. Before the schedule of values is baselined, correct a lump-sum contract sum with changeProjects updateProject (aspect fields); after that it moves only through variations. Choose view: - project: The project's active main contract, or null. - contract: Get a main contract by ID - feeTermsCorrectable: True while a cost-plus contract's latest fee schedule version can still be corrected in place (active, no revision pending, the client has not approved it, and no sent claim covers it). False for lump sum. - feeSchedule: A cost-plus contract's approved fee schedule versions, newest first: charge-out rates by labour role, fee lines and plant lines, each with effective date, changes, approval, whether live today and whether still correctable. Also any revision awaiting approval and the earliest date a new revision may take. Null for lump sum. - estimateRevisions: A cost-plus contract's estimated total cost history, oldest first. Empty for lump sum or before an estimate is set. Also found as: head contract, contract sum, fee schedule, cost plus fee.

winpay_readMonthEnd

ChatGPT
Reads month end: Accounting periods per project: the open period's close working, accruals, locked period snapshots, and opening balances for projects brought in part-way. Pass operation and its input ({} when it takes none). Operations: - getMonthEnd: Reads a project's month-end working. Needs accounting period view; openClose also needs bill list, claim list and wip:view; accrualCandidates bill and purchase order view; openingReconciliation claim view. Choose view: - periods: The open period, current month and locked periods, newest first. - openClose: The open period's close working, as locking now would freeze it: per cost code position and movement since the last lock, reasons, sell side, readiness of the close steps, pendingPeriodKeys and boundaryCrossers (bills approved after their month locked). - lockedSnapshot: A locked period's frozen cost lines (for its WIP use readForecasts getProjectForecast view wipPeriod). Null if not locked. - costByGl: A locked period's cost to date by GL account, plus unmapped cost codes. Null if not locked. - accrualsDetail: A locked period's accruals by source (in-flight bill, PO received not invoiced, manual). Null if not locked. - glTieOut: A locked period's latest GL tie-out: cost movement per GL account against the books. observation is null until one has run. Null if not locked. - glTieOutAccountBills: The bills behind one GL account's tie-out movement, with export status; unexported bills usually explain a variance. Use the synthetic id for the unmapped bucket. Null if the period is not locked or tied out, or the tie-out needs re-running. - accrualCandidates: Accrual candidates for the open period or periodKey. - openingPosition: The opening-position worksheet for a project brought in part-way: readiness, lock state, stated figures and pre-filled rows. - openingReconciliation: Loaded opening figures compared with the stated percent complete. Advisory. Also found as: period close, GL tie-out, general ledger, opening balance.

winpay_readOrganisationSettings

ChatGPT
Reads organisation settings: The organisation's settings, regional context, members and access groups, plan and module access, audit log, and its connection to BuildPass Core (Build). Pass operation and its input ({} when it takes none). Operations: - getOrganisation: Reads organisation-level context. Choose view: - settings: Get organisation settings - regional: Regional rules (tax, dates, terminology) for the organisation or a project. - entitlements: Account status, purpose and jurisdiction, which decide module access. Ignore onboardingReleasedAt and unlockedModules. - coreSyncConnection: The paired Build account and its region. Null when there is none (not an error). - coreSyncPolicy: The Build sync policy: when projects push, which records sync, and how timesheets pull and cost. - coreSyncActivity: Every Build sync attempt, newest first, including ones policy declined. - coreSyncAdoption: Build companies and workers waiting on a match decision, with the proposed BuildPass record. A pending worker blocks its timesheet rows. - coreSyncContactDrift: Contact email changes made in Build that BuildPass did not apply, since BuildPass owns that email. - coreSyncCostCodes: Cost codes shared to Build's timesheet picker, and whether changes are unsent. Null with no Build connection. - coreSyncProjectContext: A project's Build sync state and the client and subcontractors that can go with it. - coreSyncBuildJumpTarget: Where Open in Build lands: the region's Build app and the project's Build id. Null when there is no Build connection or the project is not in Build. - listOrganisation: Lists the organisation's people and access groups. Choose kind: - members: Members, invitations and archived members. - assignableAccessGroups: Access groups that can be assigned. - accessGroups: Every access group with member counts. - accessGroupTemplates: Templates for new access groups. - getOrganisationRecord: Reads one organisation record. Choose kind: - member: Get organization member - accessGroup: One access group with its capabilities and members. - auditLog: Get audit log Also found as: organization, user, permission, plan, module, core sync.

winpay_readProductFeedback

ChatGPT
Reads product feedback: Requests to the BuildPass team for something BuildPass cannot do today, sent as the person who asked. Help with their own records is a support request, not product feedback. Pass operation and its input ({} when it takes none). Operations: - listProductFeedback: Lists the product requests people in the organisation sent to BuildPass, newest first, with who sent each and where it stands: received, reviewing, considering, planned, addressed or not pursuing. Use it when someone asks what happened to a request. Also found as: feature request, product request, suggestion, missing, feedback status, my requests.

winpay_readProgressClaims

ChatGPT
Reads progress claims: Progress claims to the client (US: pay applications to the owner): drafts, pricing (lump sum or cost plus) and the client's payment response. A subcontractor's claim on you is under Subcontracts. Pass operation and its input ({} when it takes none). Operations: - listClaims: Lists claims to the client, payment responses, and lines a stage claim can claim. Choose view: - claims: A project's claims, optionally by status. - paymentResponses: Payment responses on a project in both directions: schedules you issued to subcontractors' pay applications (with their deadline) and schedules the client sent on your claims. Each side is left out if you can't read it. - billingsToDate: Certified billings to date per schedule of values line and in total, tax-exclusive and before retention. The figure WIP uses. - stages: Schedule lines a stage claim can claim, with the value left on each. staged is true when the schedule came from stage payments. Empty for cost plus. - getClaim: Reads one claim. sources and feeBasis are for cost-plus claims. Choose view: - claim: A claim with its lines (claimed, and certified once certified), each time it was served, and the client's statutory response deadline. - sources: For a draft cost-plus claim: every approved bill and labour entry in its period with an included flag, plus its other costs. Sources billed by another claim don't appear. After submit: the sources the claim used, without amounts. - feeBasis: How a cost-plus claim's fee is priced: each fee line's rate and basis, and for a fixed fee its cap, earlier draws, this draw and what remains. Also the fee schedule versions used. A draft reads current terms; a submitted claim reads its frozen terms. Null for lump sum. - serveReadiness: What would stop or warn on serving a draft claim, most severe first; submit runs the same check. Blockers: no client to serve, a negative total, or an earlier draft claim still claiming a line on this one (submit that first). Warnings: client without a business number, period not yet ended. Also found as: owner pay application, payment claim, payment schedule, billing.

winpay_readProjects

ChatGPT
Reads projects: A job: client, site, contract type, stage, dates and its default rate library. Most other records hang off a project. Pass operation and its input ({} when it takes none). Operations: - listProjects: Lists the organisation's projects. - getProject: Reads one project. Choose view: - project: Get project - roleAssignments: Who holds each construction role on the project. Does not yet affect approvals. - locations: The project's location tree (site, building, floor, unit, area), depth first, with each location's path such as Building 3 › Floor 2 › Unit 204. Empty when the project has none. Also found as: job, site, project team.

winpay_readProposals

ChatGPT
Reads proposals: Your priced offer to the client (AU: tender), derived from an estimate, with its working lines, sections and issued snapshots. A price a supplier sends you is a quote under Quotes. Pass operation and its input ({} when it takes none). Operations: - getProposal: Reads the proposal. Choose view: - proposal: Returns the project's one proposal with its status, source estimate, working lines, sections and latest issued snapshot, or null. - snapshots: Lists the snapshots frozen at each issue, newest first. - listProposalSavedSections: Lists the organisation's reusable proposal sections. Those with includeByDefault are added to new proposals. Also found as: tender, quote to client, offer.

winpay_readPurchaseOrders

ChatGPT
Reads purchase orders: Purchase orders to suppliers: drafts and their lines, what has been billed against each, and what remains committed. Pass operation and its input ({} when it takes none). Operations: - listPurchaseOrders: Lists purchase orders (orders), issued orders with remaining commitment (available) or committed cost per cost code. Choose view: - orders: Purchase orders with supplier, project, amounts, status and line count. Follow continueCursor until isDone. - available: Issued purchase orders on a project with supplier, total and remaining commitment (may be zero). Empty for an inaccessible project. - committedCost: Committed cost per cost code from ISSUED purchase order lines, for a project or the organisation. Committed cost across subcontracts and POs is in the budget report. - getPurchaseOrder: Reads one purchase order. Choose view: - order: The purchase order with supplier, recipient contact and cost-coded lines. - billing: Linked bills, billed to date, remaining commitment and over-billing status; null when the order is unavailable or inaccessible. Also found as: purchase order, PO, order, supplier order, committed cost, commitment.

winpay_readQuotes

ChatGPT
Reads quotes: Quotes suppliers and subcontractors sent back, their lines and tax basis, the leveled comparison, and award mapping of quote lines onto estimate scope. Pass operation and its input ({} when it takes none). Operations: - listQuotes: Lists quotes suppliers and subcontractors sent you, for one RFQ or a whole project. Your own price to the client is a proposal. Choose kind: - forRfq: Returns the raw quote rows for an RFQ across all statuses. - forRfqEnriched: Quotes with company name, line counts, valueCents (ex-tax; null until a tax-inclusive total's ex-tax amount is confirmed in BuildPass), totalCheck and letting status (canLet, letBlocker). - forProject: Every non-draft, non-superseded quote on the project, newest first, with company name and total. - getQuote: Reads one quote, or an RFQ's quote comparison and award mapping. Choose view: - quote: The quote with currency, tax basis, totalCheck and the RFQ version it priced. - review: The quote with tax treatment, ex-tax subtotal, qualifications, lines with sourceLocation, appliesTo and locationId, and the locations its RFQ version asks a price for. - comparison: Status NEEDS_RUN, REGENERATING, FAILED, or READY with the leveled comparison. - leveling: The leveled line set for the latest version with regeneration status, or null if never run. - awardMapping: The award mapping (status, fingerprint, overlay, confirmation), or null when no quote is awarded. - awardMappingView: Coverage per estimate scope item, with the awarded quotes covering it. - awardApplyPlan: What applying the award would change in the estimate: per-line before and after cost, awarded scope it lacks, and rows left alone with why. Also found as: quote, bid, tender, leveling, award.

winpay_readRatesAndTakeoffs

ChatGPT
Reads rates and takeoffs: Rate libraries and their unit rates that price estimate lines, measurement units, and takeoffs that measure quantities off drawings. Pass operation and its input ({} when it takes none). Operations: - listRates: Lists rate libraries, their rates, and measurement units. Choose kind: - libraries: List rate libraries - rates: List rates in a library Returns one page of rows and totalRows; while isDone is false, pass continueCursor as paginationOpts.cursor for the next page. - rateSearch: Search rates in a library - units: Returns unit IDs, keys, groups and symbols. - getRateRecord: Reads one rate library or rate. Choose kind: - library: Get a rate library - organisationDefaultLibrary: Get the org-wide default rate library id - rate: Get a rate - getTakeoff: Reads takeoff data. takeoff and workspace take projectId; documents, items, rollup, geometry and defaultScale take takeoffId; item and itemUsage take takeoffItemId; calibrations and pageCalibration take documentId. Choose view: - takeoff: Get a project takeoff - workspace: Get the takeoff workspace - documents: List attached takeoff drawings - items: List takeoff measurement items Returns one page of rows and totalRows; while isDone is false, pass continueCursor as paginationOpts.cursor for the next page. - rollup: Read measured quantities and calibration status - geometry: Read the takeoff measurement geometry - defaultScale: Get the takeoff default drawing scale - item: Get a takeoff measurement item - itemUsage: Inspect measurement shape and estimate usage - calibrations: List drawing page calibrations - pageCalibration: Get a drawing page calibration Also found as: unit rate, price book, quantity, scale.

winpay_readRetention

ChatGPT
Reads retention: Retention the client holds on claims (balances, ledger entries, releases) and releases of retention held from subcontractors. Retention held per subcontract is projected under Subcontracts. Pass operation and its input ({} when it takes none). Operations: - getRetention: The amount held from each subcontractor is projected by readSubcontracts listSubcontracts kind payableRetention. Choose view: - mainContractBalance: Retention held to date and the retention cap (or null) in cents. - mainContractEntries: Retention ledger entries (withholdings and reversals), oldest first. - mainContractReleases: Releases (draft, approved, settled, void), newest first, each with settled to date. - mainContractEligibility: The amount a release with this trigger could take now, net of other non-void releases. pc releases a share of the withheld pool; dlp and manual release the rest. milestoneReady is advisory and never blocks. - projectOverview: The project's client-side retention in one read: main contract ID, gross withheld, released (settled), approved not settled, outstanding, the cap, and PC/DLP eligibility with each milestone's readiness. Null without an active main contract. - projectSubcontractReleases: Releases of retention held from subcontractors, with subcontractor names and settled amounts. - subcontractEligibility: Eligible and committed release amounts against the withheld pool, per the subcontract's release schedule. Advisory; milestone dates aren't checked. - release: One release with settled to date and its settlement evidence. Also found as: retainage, retention release, practical completion, defects liability.

winpay_readRfqs

ChatGPT
Reads rfqs: Requests for quote or tender sent to suppliers and subcontractors: versions, documents, recipients and reminders. Pass operation and its input ({} when it takes none). Operations: - listRfqs: Lists RFQs, or one RFQ's recipients or documents. Quotes that came back are listQuotes. Choose kind: - rfqs: RFQs in every status (DRAFT, ISSUED, CLOSED, CANCELLED). Filter by projectId and/or estimateId; omit both for the whole organisation. - recipients: Recipients with delivery, view, response and bounce times. - documents: Documents on the RFQ's latest version, or on versionId, with file metadata, any pinned markup snapshot and the three visibility flags. - getRfq: Reads one RFQ or RFQ batch. Quotes, the comparison and award mapping are getQuote. Choose view: - rfq: The RFQ with status, scope description, close date and latest version. - detail: The RFQ with its latest scope snapshot, recipients and quote summary. - reminderPreview: Lists eligible recipients, unanswered replies and successful reminder timestamps. - reminderResults: Each recipient's queued, sent or failed reminder result. - batch: The batch and every RFQ in it, in creation order. batch.pendingDocumentLinks is set while documents are still attaching in the background. Also found as: RFQ, request for quote, request for tender, tender package, bid, leveling.

winpay_readScheduleOfValues

ChatGPT
Reads schedule of values: The schedule of values (AU: claim schedule) that splits the contract value into lines progress claims bill against. Pass operation and its input ({} when it takes none). Operations: - getScheduleOfValues: Reads the schedule of values (AU: claim schedule; not the programme), which splits the contract sum into the lines claims bill against. Views: project (active schedule), mainContract, schedule (by ID), lines (in outline order, each with its displayNumber; Returns one page of rows and totalRows; while isDone is false, pass continueCursor as paginationOpts.cursor for the next page.), reconciliation (line total vs contract sum; must reach zero before baseline), valueMoves (whether value can move to or from each line), removals (whether each line and import can be removed), estimateSeedPreview (what seeding would write), stageTemplate (contract sum and stage payment templates, shares in basis points). Also found as: SoV, SoV line, claim schedule, contract breakdown.

winpay_readSchedules

ChatGPT
Reads schedules: The construction programme (Gantt): schedules and their items with dates, not money. The schedule of values is a separate family. Pass operation and its input ({} when it takes none). Operations: - listSchedules: The construction programme (Gantt): tasks and dates, not money. The schedule of values is a separate family. Choose kind: - schedules: List schedules for a project - items: List items for a schedule Returns one page of rows and totalRows; while isDone is false, pass continueCursor as paginationOpts.cursor for the next page. - copySources: Programmes that can be copied into this project, its own first; ones not ready show copyable false and why. Copy with duplicateSchedule. - getScheduleRecord: Reads one schedule or schedule item. Choose kind: - schedule: Get a schedule - item: Get a schedule item - copySummary: For a copied programme, items still missing a cost code, scope link or assignee. Null if none or not copied. Also found as: programme, program, Gantt, task, predecessor.

winpay_readSubcontracts

ChatGPT
Reads subcontracts: Subcontracts let to trades: scope sections and lines, agreements, contract documents, change orders, back-charges, and the subcontractor's claims (pay applications) against them. Pass operation and its input ({} when it takes none). Operations: - listSubcontracts: Lists subcontracts and the records under them. Pay applications here are a subcontractor's claims on you; your claims to the client are Progress Claims. Choose kind: - subcontracts: Subcontracts in every status with company, project and effectiveValueCents (value plus executed change orders). Filter by projectId; omit for the whole organisation. - changeOrders: A subcontract's change orders with number, net total and ADDITIVE, DEDUCTIVE or ZERO_VALUE classification. - backCharges: A subcontract's back-charges, oldest first. - payApplications: A subcontractor's pay applications on a subcontract, in number order. - claimLines: Schedule lines and executed change-order lines with scheduled value, certified to date, and whether a new claim can take certified work off the line (claim it at 0, then assess a negative amount). - agreements: List subcontractor agreements - savedSections: The library of saved scope sections and PDF appendices, in display order, with their cost codes. - savedSectionsForCostCodes: Saved scope sections tagged with any of the given cost codes; overhead and archived codes never match, and empty sections are left out. - payableRetention: Projected retention held per non-cancelled subcontract on a project (value × retention %, capped), plus the committed total of EXECUTED subcontracts. - getSubcontractRecord: Reads one subcontract (with its lines or finance), change order, back-charge or agreement. Choose view: - subcontract: Get a subcontract - lines: List subcontract lines - finance: Effective value (value plus executed change orders), committed cost per cost code, retention terms and projected held retention, and billed to date. - documentFields: Every document field for the subcontract, with the formatted value of each fillable one from live data. - contractGeneration: Each field box on the template, in reading order, with its value and a missing flag. - changeOrder: The change order with its cost-coded lines, number, classification and the subcontract's projected effective value (value plus executed change orders). - changeOrderLines: Lists the cost-coded lines of a change order, in sort order. - backCharge: One back-charge. - agreement: Get subcontractor agreement Also found as: subcontract, subcontractor, trade contract, scope section, subcontract change order, back-charge, backcharge, pay application, subcontractor claim, subcontractor agreement.

winpay_readVariations

ChatGPT
Reads variations: Variations (US: change orders) to the contract with the client, formal contract amendments, and change events that track possible changes before they are priced. A change with a subcontractor is a subcontract change order under Subcontracts. Pass operation and its input ({} when it takes none). Operations: - listVariations: Lists a project's changes to the client contract. Choose kind: - variations: A project's variations (changes to the client contract), each with its number and sell and cost totals. - changeEvents: A project's change events, newest first, with number, status (pending while a live change is raised from it), rough cost and revenue, and lines. - amendments: A project's formal contract amendments with their variations. A draft amendment may hold approved and submitted variations; when the client executes it, the submitted ones are approved. - allowances: The allowance register: one row per allowance, PC item or provisional sum, with type, cost code, original allowance and status. Newest first; archived rows left out. Returns one page of rows and totalRows; while isDone is false, pass continueCursor as paginationOpts.cursor for the next page. - linkableCommitments: Executed subcontracts and issued purchase orders an allowance row can link to, with supplier and committed cost, largest first. - getVariationRecord: Reads one variation record or readiness check. Choose view: - variation: A variation with its sell and cost lines. - lines: A variation's sell and cost lines, in order. - submitReadiness: Ready, or what blocks submitting: permission, status, uncoded cost lines, unfinished rate lines or no priced scope. Submit also enforces the margin cap. - approveReadiness: Ready, or what blocks approving: permission, status, contract, pricing. Approval also enforces approval-chain and signature rules. - changeEvent: One change event with its lines, totals, and every variation, subcontract change order and budget transfer raised from it. - amendment: One main contract amendment. - allowanceRevisions: The row's past choices, oldest first: what each settled in the contract and the change order that carried it. Empty if never reselected. - createReadiness: Ready, or what blocks creating a variation on this project (permission, main contract). Also found as: change order, change event, contract amendment, allowance, selection, provisional sum, prime cost.

winpay_removeBills

ChatGPT
Delete a bill line or tax line: Supplier and subcontractor bills (accounts payable): the intake inbox, bill lines and tax, and approval and payment status. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Pass operation and its input ({} when it takes none). Operations: - removeBillLine: Deletes one line or tax line from a bill. Choose kind: - line: Delete bill line - taxLine: Delete bill tax line Also found as: supplier invoice, accounts payable, AP.

winpay_removeBudgets

ChatGPT
Remove items from budgets: The project's cost budget, its lines and groups (a cost code may carry several lines), with budget imports, the cost-control report, and buyout (which budget lines are let and when). Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Pass operation and its input ({} when it takes none). Operations: - removeBudgetLine: Deletes one line from a draft budget. - removeBudgetGroup: Removes a group from a draft budget. Its lines and subgroups move up into the group it sat in, or to the top level; no line or amount is deleted. Also found as: budget, budget line, original budget, cost budget, cost control, budget group, budget section.

winpay_removeDocuments

ChatGPT
Remove a document from its revision chain: Project and organisation documents and their folders, revisions and markups, including files attached to bills, claims and contracts. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Pass operation and its input ({} when it takes none). Operations: - unlinkDocumentRevision: Removes the link to its predecessor and updates dependent takeoff quantities. Neither document is deleted. Also found as: file, drawing, attachment.

winpay_removeEstimateRecipes

ChatGPT
Delete an estimate recipe section, line or rate sheet row: The organisation's estimate recipe library: reusable sections and lines, without rates, costs or markup, that are imported into estimates. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Pass operation and its input ({} when it takes none). Operations: - removeEstimateRecipePart: Deletes a recipe section, line or rate sheet row. Needs organisation-level estimate:edit. Whole recipes are deleted in the app. Choose kind: - section: Permanently deletes a recipe section and its lines. Estimates already imported keep their copies. - line: Permanently deletes a recipe line. Estimates already imported keep their copies. - rateSheetRow: Permanently deletes a recipe breakdown row. Estimates already imported keep their copies. Also found as: recipe, recipe library, assembly, template section.

winpay_removeEstimates

ChatGPT
Remove items from estimates: Priced build-ups of a job: an estimate holds sections, each section holds scope items (lines with quantity, rate, cost and markup), plus fee and discount rows. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Pass operation and its input ({} when it takes none). Operations: - removeEstimatePart: Deletes a section and all beneath it, a fee or discount row, or a rate sheet row. A single line is removeScopeItem. Choose kind: - section: Deletes a section with every section and scope item beneath it. - adjustment: Deletes a fee or discount row. - rateSheetRow: Deletes a row and re-derives the item's unit rate. After the last row goes, the rate can be typed again. - removeScopeItem: Deletes one line. - detachScopeItemTakeoff: Removes a line's takeoff measurement links, keeping its current quantity as a manual one. Also found as: fee, discount, line item.

winpay_removeForecasts

ChatGPT
Detach evidence from a forecast item: Forecast final cost (EAC) and cost-to-complete items, the live WIP report, cash forecasts and the organisation's portfolio roll-up and overheads. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Pass operation and its input ({} when it takes none). Operations: - unlinkForecastItemEvidence: Removes the evidence link; the document stays in the project library. Idempotent. Also found as: EAC, estimate at completion, cost to complete, WIP, work in progress, cash flow.

winpay_removeLabour

ChatGPT
Delete a labour entry: Labour entries logged against a project, labour imports, and each role's loaded cost and default charge-out rate. Workers are under Companies and Contacts. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Pass operation and its input ({} when it takes none). Operations: - removeLabourEntry: Delete a labour entry Also found as: labor, timesheet, hours, worker, charge-out rate.

winpay_removeProgressClaims

ChatGPT
Delete a claim line or other cost: Progress claims to the client (US: pay applications to the owner): drafts, pricing (lump sum or cost plus) and the client's payment response. A subcontractor's claim on you is under Subcontracts. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Pass operation and its input ({} when it takes none). Operations: - removeClaimLine: Deletes a line or other cost from a draft claim. Choose kind: - line: Deletes a line from a draft claim. - otherCost: Deletes an other cost from a draft cost-plus claim; it won't reappear on a later claim. Also found as: owner pay application, payment claim, payment schedule, billing, reimbursable.

winpay_removeProposals

ChatGPT
Delete a proposal line or section: Your priced offer to the client (AU: tender), derived from an estimate, with its working lines, sections and issued snapshots. A price a supplier sends you is a quote under Quotes. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Pass operation and its input ({} when it takes none). Operations: - removeProposalPart: Deletes one line or custom section from a proposal; a well-known section is cleared. Choose kind: - line: Remove a working line - section: Deletes a custom section, or clears a well-known section. Also found as: tender, quote to client, offer.

winpay_removePurchaseOrders

ChatGPT
Delete a purchase order line: Purchase orders to suppliers: drafts and their lines, what has been billed against each, and what remains committed. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Pass operation and its input ({} when it takes none). Operations: - removePurchaseOrderLine: Deletes a DRAFT line. Needs purchase_order:edit. Also found as: purchase order, PO, order, supplier order, committed cost, commitment.

winpay_removeRatesAndTakeoffs

ChatGPT
Remove items from rates and takeoffs: Rate libraries and their unit rates that price estimate lines, measurement units, and takeoffs that measure quantities off drawings. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Pass operation and its input ({} when it takes none). Operations: - removeRate: Deletes one rate; refused if its library is archived. - removeTakeoffPart: Deletes a measurement, or detaches a drawing from a takeoff. Choose kind: - item: Delete a takeoff measurement item that no live estimate line uses - drawing: Detaches a drawing; shapes already drawn on it remain. Also found as: unit rate, price book, quantity, scale.

winpay_removeRfqs

ChatGPT
Remove an RFQ recipient or document: Requests for quote or tender sent to suppliers and subcontractors: versions, documents, recipients and reminders. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Pass operation and its input ({} when it takes none). Operations: - removeRfqPart: Removes one recipient or document from an RFQ. Choose kind: - recipient: Removes a recipient while the RFQ is DRAFT. - document: Detaches a document from the draft version (no-op if not attached). Once issued, this needs an addendum. Also found as: RFQ, request for quote, request for tender, tender package, bid, leveling.

winpay_removeScheduleOfValues

ChatGPT
Remove schedule of values lines: The schedule of values (AU: claim schedule) that splits the contract value into lines progress claims bill against. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Pass operation and its input ({} when it takes none). Operations: - removeScheduleOfValueLines: Archives lines and their sub-items with one reason; if any line is refused, nothing is removed. kind lines: the lines named; import: every active line from one spreadsheet import. After baseline, reallocations must give the value to lines that stay. Check view removals first. Also found as: SoV, SoV line, claim schedule, contract breakdown.

winpay_removeSchedules

ChatGPT
Archive a schedule or a schedule item: The construction programme (Gantt): schedules and their items with dates, not money. The schedule of values is a separate family. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Pass operation and its input ({} when it takes none). Operations: - archiveScheduleRecord: Archives a schedule with all its items, or one item with everything under it. There is no restore. Choose kind: - schedule: Archive a schedule (cascades to its items) - item: Archive a schedule item (cascades to its subtree) Also found as: programme, program, Gantt, task, predecessor.

winpay_removeSubcontracts

ChatGPT
Delete a subcontract line, scope section, document or change order line: Subcontracts let to trades: scope sections and lines, agreements, contract documents, change orders, back-charges, and the subcontractor's claims (pay applications) against them. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Pass operation and its input ({} when it takes none). Operations: - removeSubcontractPart: Removes one part of a subcontract. Choose kind: - line: Delete a draft subcontract line - scopeSection: Deletes a custom section, or clears a standard section's content. DRAFT only. - document: Unlinks a document from the subcontract; it stays in the project library. Refused once the subcontract is CANCELLED or TERMINATED. - changeOrderLine: Delete a change order line Also found as: subcontract, subcontractor, trade contract, scope section, subcontract change order, back-charge, backcharge, pay application, subcontractor claim, subcontractor agreement.

winpay_removeVariations

ChatGPT
Remove items from variations: Variations (US: change orders) to the contract with the client, formal contract amendments, and change events that track possible changes before they are priced. A change with a subcontractor is a subcontract change order under Subcontracts. Approving, submitting, issuing, paying and sending a record happen in BuildPass, not here. Delete or void only through an operation that says so. Pass operation and its input ({} when it takes none). Operations: - removeVariationLine: Deletes a variation line. - archiveAllowance: Takes a wrong allowance register row off the register with a reason; it keeps its history but leaves every read. Only an open or selected row can go: an instructed, varied or closed row, or one with a live client confirmation, must be undone first. To merge allowances, create the combined row first, then archive the rows it replaces, so a refused create leaves them in place. Also found as: change order, change event, contract amendment, allowance, selection, provisional sum, prime cost, merge allowances.

winpay_status

ChatGPT
Reports whether Win & Pay is linked to this BuildPass connection, not linked, or refusing access.

Capabilities

Writes

Example Prompts

Click any prompt to copy it.

Similar Apps

Listed on MCP App Store

Listed on MCP App Store

Add this badge to your site or README. It links to this page.

HTML

<a href="https://mcp-app-store.keenethics-labs.com/app/buildpass"><img src="https://mcp-app-store.keenethics-labs.com/badges/listed-on-mcp-app-store.svg" alt="Listed on MCP App Store" width="220" height="44"></a>

Markdown

[![Listed on MCP App Store](https://mcp-app-store.keenethics-labs.com/badges/listed-on-mcp-app-store.svg)](https://mcp-app-store.keenethics-labs.com/app/buildpass)