# Screed

> Screed is the operating layer for hardscape and paver subcontractors: a shared material catalog, estimates built from areas and catalog items, material-aware purchase orders and receivers, crew scheduling and field production, and actuals that feed the next estimate. People use the web app; agents use the Screed MCP server and the same URLs.

## For agents

See Generated capabilities below for registered v1 and MCP operations.

- **MCP server:** `POST https://api.screed.dev/api/mcp` — JSON-RPC 2.0, MCP protocol `2025-03-26`, tools only.
- **Auth:** `Authorization: Bearer screed_…` (older `brikt_` keys still work). A company admin mints a key in Screed at `/settings/integrations/api`. A key acts for one company; every result is scoped to it. Keys are **read-only** unless the admin chose **Read & write**: a read-only key sees only read tools (`readOnlyHint: true`) and gets `403` from write endpoints. `get_whatsapp_invite` also needs a read & write key: the invite link lets anyone join the crew group.
- **Discovery:** `GET https://api.screed.dev/api/mcp` lists every tool with `readOnly` and `requiresWriteKey` flags. `initialize` returns usage instructions.
- **Errors:** a failed tool call returns `isError: true` with a plain-English reason (not found in this company, contracted estimate is locked, bad id). Fix the input and retry. Any other failure returns `Tool failed` with no detail. A second content block carries `{"code", "requestId"}`: `code` is a stable machine-readable code (`invalid_request`, `validation_failed`, `scope_read_only`, `plan_required`, `internal`…), and protocol errors carry the same pair in `error.data`. The REST endpoints under `/api/v1` and `/api/field` work the same way: `400 {"error": "<reason>", "code": "…", "requestId": "…"}` for a problem you can fix, `500` with code `internal` for anything else. Every response has an `X-Request-Id` header (send your own to have it used); quote it when asking about a request. The codes and the versioning policy (v1 is additive only) are in `https://screed.dev/api/v1/openapi.json` (`info.x-error-codes`, `info.x-versioning-policy`).
- **Deep links:** every result carries `url` fields. Give people those links instead of describing where to click.

### Tools

Workspace:
- `list_projects`, `get_project` — jobs, status, address, estimates
- `list_estimates`, `get_estimate` — areas (SF, LF), line items (product, quantity, unit cost, extended cost), totals (material cost, sell price, margin, cost per SF) exactly as the Estimate lens shows them
- `create_estimate` → `add_area` → `search_catalog` → `add_item_to_area` — build an estimate; quantities and costs run through Screed's own calculation, and a quantity or unit cost you send is kept as typed. `update_line`, `update_area` and `update_estimate` correct what was added; `remove_line`, `remove_area` and `remove_estimate` (drafts only) take it out. Contracted estimates are locked (changes go through a change order in the app)
- `search_catalog`, `get_catalog_item` — the shared hardscape catalog: specs, documents, constraints, value alternatives. `search_catalog {includeCompanyItems: true}` also returns the company's own items (`companyItems`, with `companyItemId` for `add_item_to_area`) when company lines are on
- `get_board` — crews and assignments for a date window (scheduled, pending confirmation, confirmed, standby, disputed), each day with its `id`, `areaId` and `spanId`
- `get_schedule`, `list_crews` — the Board's spans (blocks of crew days) with crew, project, area and day ids, status, headcount, hours and pay-period ids, each area's planned and remaining labor, and the crews (no pay). REST: `GET /api/v1/schedule`, `GET /api/v1/crews` (a read key is enough)
- `list_daily_logs` — field logs with headcount, hours, units installed, notes

Field feed:
- `list_field_events`, `create_job_feed`, `upsert_job`, `get_whatsapp_invite` — WhatsApp crew groups and Slack job channels. REST equivalents: `/api/field/jobs`, `/api/field/events`, `/api/field/groups`, `/api/field/status` (same key).
- Jobs: `upsert_job` / `POST /api/field/jobs` take `name`, `number` (the company's job number, e.g. `1097`, shown as the job's Number and unique within the company), `source` + `externalId` (the job's id in the system it comes from, the same ids `upsert_projects` uses), `address` and `people`. A repeat call updates the same job, found by `source` + `externalId`, then `number`, never by name; a call with neither is refused, and an existing job's status is left alone. For job data in bulk use `upsert_projects`. `list_projects`, `get_project` and `GET /api/field/groups` return `number`.
- `report_delivery`, `list_delivery_reports`, `list_deliveries` — deliveries received on site, keyed by `source` + `externalId`: the purchase order and lines (Screed ids or the `externalId`s they were sent with), quantities received and refused, `receivedOn`, ticket, notes, https photo links and the reporter. A report is not a receipt: the project's superintendent verifies it and its PM books it in Screed, and only then do the purchase order's quantities change; no key verifies or books one. Reads give each report's status (`REPORTED`, `VERIFIED`, `BOOKED`, `REJECTED`) and the receipts booked, with `updatedSince`. REST: `POST` / `GET /api/v1/delivery-reports`, `GET /api/v1/deliveries`.
- `report_field_production`, `list_field_reports` — crew days' production from the field, keyed by `source` + `externalId`: the crew day (`crewDayId`, or `spanId` with `workDate`), the estimate area (`areaId`), `installedQuantity` and `unit`, `hours`, `headcount`, notes, https photo links and the reporter. A report never confirms a crew day: the project's superintendent verifies it and its PM books it in Screed, and only then is the crew day confirmed with the installed quantity; no key verifies, books or confirms one. Reads give each report's status (`REPORTED`, `VERIFIED`, `BOOKED`, `REJECTED`), with `updatedSince`. REST: `POST` / `GET /api/v1/field-reports`.

Import (the company's own data, matched by the id it has in the sending system):
- `upsert_customers`, `list_customers` — the company's customers. REST: `PUT` / `GET /api/v1/customers`.
- `upsert_vendors`, `list_vendors` — the company's vendors (suppliers) with account number, payment terms, lead time, office details, `contacts` (the first is the one purchase orders go to) and `locations` (plants, by the company's own code). Matched by name to Screed's supplier directory; a supplier already on the company's list is linked on its first import (`linked: true`). REST: `PUT` / `GET /api/v1/vendors`. Send vendors before the prices and fees that reference them.
- `upsert_vendor_prices`, `list_vendor_prices` — what each vendor charges for each item: `itemExternalId` and `vendorExternalId` (sent before, under the same source), `purchaseUnit`, `invoiceUnit`, `unitPrice`, `effectiveDate` / `expiresDate`, `priceSource` (`QUOTE`, `SALES_ORDER`, `INVOICE`, `PRICE_LIST`, `CONTRACT`) and `sourceRef`, `vendorSku`, `orderIncrement`, `minimumQuantity`, `leadTimeDays`, an optional `location` (plant code) and `projectNumber` (a price for that job only), and `preferred`. A new record per price change; history is kept and the latest price in effect is used. REST: `PUT` / `GET /api/v1/vendor-prices`.
- `upsert_vendor_fees`, `list_vendor_fees` — charges a vendor adds on top of item prices (never items, never sales tax): `vendorExternalId`, `feeType` (`DELIVERY`, `PALLET`, `FUEL_SURCHARGE`, `HAULING`, `SMALL_ORDER`, `OTHER`), `amount` per `LOAD`, `PALLET`, `ORDER`, `TON`, `MILE` or `PERCENT`, `effectiveDate`, `zone` (required for `DELIVERY`) and `zoneArea`, and optional `minimumCharge`, `expiresDate`, `sourceRef`, `location` and `projectNumber`. REST: `PUT` / `GET /api/v1/vendor-fees`.
- `upsert_name_aliases`, `list_name_aliases` — the company's other spellings: `kind` `SUPPLIER` (a spelling of one of its vendors, by `vendorExternalId`) or `MANUFACTURER` (a spelling of a catalog manufacturer, by its name in `manufacturer`; send once per catalog manufacturer it stands for), so vendors and items sent under those spellings match. `active: false` removes one. REST: `PUT` / `GET /api/v1/name-aliases`.
- `upsert_estimates` — whole estimates from another system, created or replaced (`unchanged` when a re-send matches; never a contracted, ordered or billed one; `replaceSubmitted` for a submitted one; `dryRun: true` previews): up to 10 estimates and 2,000 lines, each with its `project` (`number` or `externalId`), `sections` (`SURFACE` with `surfaceAreaSf`, or `GENERAL`) and lines naming a company `item` by `externalId` or a `catalogItemId`, with `quantity` in Screed's unit for it, `unitCost`, `layerKey` `BORDER` and `costCode`; `rates` and `otherMarkups`. Answers Screed's `calculatedQuantity`, rates, totals by cost type with sales tax, and the difference from `sourceTotal`. REST: `PUT` / `GET /api/v1/estimates` (GET reads them back in the same shape, by `source` and `externalId` or `projectNumber`).
- `upsert_crews`, `upsert_schedule` — crews (name, `kind`, `company`, `contactPhone`, `members`, `notes`, `active`; never pay) and Board spans planned in another system: each span names a `crew` (`id` or the `externalId` `upsert_crews` took), a `project` (`id`, `number` or `externalId`) and optionally an `area` (`id`, or `estimateExternalId` + `sectionExternalId` from `upsert_estimates`), a `startDate` and `workingDays` (the company workweek, Monday to Friday by default) or its own `dates`, `headcount`, `hoursPerDay` and `notes`. Spans are plans: a PM confirms each day in Screed, and no tool confirms or books one. Days confirmed, reported, past, or changed or removed by a PM are never touched and come back as `kept`; `prune: true` removes this source's spans on the request's projects that were not sent; `dryRun: true` previews. The Board marks the spans "from <source>". REST: `PUT /api/v1/crews`, `PUT /api/v1/schedule` (a read & write key).
- `upsert_projects` — the company's projects (jobs) with job `number`, `customerExternalId`, address, `city`, `state`, `zip`, `startDate` / `endDate` (YYYY-MM-DD), `status` and `description`. A first import links an existing job with the same number, instead of duplicating it (`linked: true`). Never opens crew channels. REST: `PUT` / `GET /api/v1/projects`. Send customers first.
- `upsert_company_items`, `list_company_items` — the company's item list, one item per product and color (colors share `productId`), with manufacturer, series, size, thickness, takeoff and purchase units and conversions, the company's cost-type code (`M-PAV`, `L`, `FRT`…) and CSI code. Each material is matched to the Screed catalog (labor, equipment, subcontract and other items are always `NEW`) and every result carries `match` (`MATCHED`, `NEEDS_REVIEW` with candidates to pick in Screed, `NEW`, or `DUPLICATE`). REST: `PUT /api/v1/items` (up to 250 per request, all or nothing, `dryRun: true` previews) and `GET /api/v1/items`. `GET /api/v1/company` shows the company, plan and key a request runs as. Contract and version: `https://screed.dev/api/v1/openapi.json` (`info.version`, `info.x-changelog`). API and MCP access (read and write keys) needs the Pro or Commercial plan; each key is limited to 120 requests a minute, and batch writes (REST and MCP, dry runs included) to 5,000 records a minute; a `429` (code `rate_limited`) says in `Retry-After` how many seconds until the budget resets.

### URL grammar (browser agents and deep links)

- Projects: `/projects/<job>/estimate|procure|produce/<estimate>?area=<id>&item=<id>&panel=l1|l2` (`<job>` and `<estimate>` are each `name-slug-first-8-of-id`; a plain id also works). `/projects/<job>` is the job; `/projects` is the Projects home, with `/projects/clients` and `/projects/invoices`. Links written before v1 1.17.0 still open the same screen
- Board: `/board?date=YYYY-MM-DD&project=<job>`
- Catalog: `/catalog?q=<text>&manufacturer=<name>&thickness=<mm>&item=<id>`
- Settings: `/settings/<profile|notifications|company|team|billing|integrations|webhooks|conversions|rules>`

Every screen has one `h1`, one `<main>`, and one destination nav (`nav[aria-label="Destinations"]`). Tabs are links (`aria-current`) or tablists (`aria-selected`). Keyboard: `g p` / `g b` / `g c` / `g s` jump between destinations, `/` focuses search, `⌘K` opens the command palette.

## Product

Four destinations:
- **Projects** (`/projects`) — one project through three lenses: **Estimate** (scope, areas, quantities, cost, price, proposal), **Procure** (material-aware POs and receivers from the estimate), **Produce** (field quantities vs plan)
- **Board** (`/board`) — cross-project crew schedule, daily confirmation, and crew pay
- **Catalog** (`/catalog`) — products, specs, documents, provenance, constraints, alternatives
- **Settings** (`/settings`) — company, team, policy, and connections (QuickBooks Online, Ramp, Slack, API keys, webhooks)

Boundaries: Screed authors estimates, POs, and receivers and records field production. AP approval, matching, bills, card and payment execution belong to Ramp (preferred) or the company's AP partner; the general ledger belongs to QuickBooks Online or the ERP. Every other tool connects through this API: the company's own integration or agent pushes jobs (`upsert_job`, `POST /api/field/jobs`).

## Pricing

No free plan and no trial; a plan covers everyone in the company, with unlimited users. Plans: https://app.getscreed.com/upgrade

- **Starter** — $80/month ($800/year): estimates, product catalog, proposals and material lists, ordering materials (purchase orders), suppliers; up to 25 active projects (completed and archived ones don't count)
- **Pro** — $250/month ($2,500/year): everything in Starter with unlimited projects, plus the Board and daily logs, Produce, deliveries and receiving, contracts and change orders, QuickBooks, Slack and WhatsApp, and the API and MCP server (read and write keys)
- **Commercial** — $600/month ($6,000/year): everything in Pro, plus a setup call; commercial paperwork (AIA pay applications, submittals, webhooks) is in development and not yet sold
- **Larger companies** (several companies, custom terms): contact us at john@getscreed.com

## Links

- [Screed app](https://app.getscreed.com): sign in or create an account
- [Full context](https://screed.dev/llms-full.txt): workflows, data model, and field capture in more depth

## Generated capabilities

- `read_activity_feed` — Read activity filtered by the current member’s audience. REST: `POST https://api.screed.dev/api/v1/workspace/activity/query`.
- `read_project_activity` — Read activity filtered by the current member’s audience. REST: `POST https://api.screed.dev/api/v1/workspace/projects/:projectId/activity/query`.
- `count_project_activity` — Read activity filtered by the current member’s audience. REST: `POST https://api.screed.dev/api/v1/workspace/projects/:projectId/activity/count`.
- `edit_capture_report` — Edit an open report under its current sender and reviewer permissions. REST: `PUT https://api.screed.dev/api/v1/workspace/reports/:proposalId/values`.
- `report_crew_day` — Report a planned crew day's installed quantity, hours and crew size as the signed-in person; it waits in the review queue (a superintendent's own report on their job is verified on arrival) and the PM books it. REST: `POST https://api.screed.dev/api/v1/crew-days/:crewDayId/reports`.
- `search_workspace` — Search company projects, suppliers, customers and paperwork. REST: `POST https://api.screed.dev/api/v1/workspace/search`.
- `read_project_people` — Read current assignments and company members for the project picker. REST: `POST https://api.screed.dev/api/v1/workspace/project-people/query`.
- `read_project_frame` — Read permission-filtered project figures and work waiting for the member. REST: `GET https://api.screed.dev/api/v1/workspace/projects/:projectId/frame`.
- `read_project_live_connection` — Read the authorized realtime topic and observation time for a project. REST: `GET https://api.screed.dev/api/v1/workspace/projects/:projectId/live`.
- `read_project_status` — Read the current status and the member’s permission to post. REST: `GET https://api.screed.dev/api/v1/workspace/projects/:projectId/status`.
- `post_project_status` — Post a status as the assigned project manager or authorized admin. REST: `POST https://api.screed.dev/api/v1/workspace/projects/:projectId/status`.
- `read_project_selector` — List workspace project choices with contract totals in cents. REST: `GET https://api.screed.dev/api/v1/workspace/project-selector`.
- `issue_hub_document` — Issue any hub document or queue a package with the same member rules as the UI. REST: `POST https://api.screed.dev/api/v1/documents/hub/issue`.
- `read_board_workspace` — Read the complete Board workspace, permissions and pay periods. REST: `POST https://api.screed.dev/api/v1/board/workspace/read`.
- `save_board_crew` — Add or change a crew and its rates as a current crew manager. REST: `POST https://api.screed.dev/api/v1/board/crews/save`.
- `create_board_span` — Schedule a block of planned crew days. REST: `POST https://api.screed.dev/api/v1/board/spans/create`.
- `edit_board_span` — Edit the selected block of planned crew days. REST: `POST https://api.screed.dev/api/v1/board/spans/edit`.
- `move_board_span` — Move planned crew days to a crew and start date. REST: `POST https://api.screed.dev/api/v1/board/spans/move`.
- `split_board_block` — Split a planned crew block at the chosen day. REST: `POST https://api.screed.dev/api/v1/board/blocks/split`.
- `join_board_blocks` — Join adjacent compatible blocks of planned crew days. REST: `POST https://api.screed.dev/api/v1/board/blocks/join`.
- `change_board_record` — Change crew-day evidence, with current approval authority for actuals. REST: `POST https://api.screed.dev/api/v1/board/records/change`.
- `find_board_booked_day` — Find the first or next booked day on a project. REST: `POST https://api.screed.dev/api/v1/board/booked-day/read`.
- `read_board_day_date` — Read the date of a crew day, or null when it is absent. REST: `POST https://api.screed.dev/api/v1/board/day-date/read`.
- `read_board_paving_weather` — Read marginal paving forecast days for company projects. REST: `POST https://api.screed.dev/api/v1/board/paving-weather/read`.
- `read_company_crew_size` — Read the company’s default crew size and edit permission. REST: `GET https://api.screed.dev/api/v1/board/settings/crew-size`.
- `save_company_crew_size` — Set the company’s default crew size as a current crew manager. REST: `PUT https://api.screed.dev/api/v1/board/settings/crew-size`.
- `read_company_pay_schedule` — Read the company’s pay schedule. REST: `GET https://api.screed.dev/api/v1/board/settings/pay-schedule`.
- `save_company_pay_schedule` — Set the company’s pay schedule as a current admin. REST: `PUT https://api.screed.dev/api/v1/board/settings/pay-schedule`.
- `read_crew_pay_schedule` — Read a company crew’s pay schedule as a current admin. REST: `GET https://api.screed.dev/api/v1/board/settings/crews/:crewId/pay-schedule`.
- `save_crew_pay_schedule` — Set a crew’s pay schedule or restore the company schedule as a current admin. REST: `PUT https://api.screed.dev/api/v1/board/settings/crews/:crewId/pay-schedule`.
- `read_company_workweek` — Read the days of the week the company’s crews work. REST: `GET https://api.screed.dev/api/v1/board/settings/workweek`.
- `save_company_workweek` — Set the days of the week the company’s crews work as a current admin. REST: `PUT https://api.screed.dev/api/v1/board/settings/workweek`.
- `add_crew_document` — Store a PDF or photo for a company crew as a current crew manager. REST: `POST https://api.screed.dev/api/v1/board/crew-documents/add`.
- `remove_crew_document` — Remove a company crew document and its file as a current crew manager. REST: `POST https://api.screed.dev/api/v1/board/crew-documents/remove`.
- `list_project_clients` — Search active company clients with project drawer labels. REST: `POST https://api.screed.dev/api/v1/project-management/clients/search`.
- `list_all_project_clients` — List company clients including retired clients with name-only labels. REST: `POST https://api.screed.dev/api/v1/project-management/clients/all`.
- `create_project_client` — Add or reuse an active company client by name. REST: `POST https://api.screed.dev/api/v1/project-management/clients/create`.
- `find_project_site_county` — Look up the supported sales-tax county for a job address. REST: `POST https://api.screed.dev/api/v1/project-management/site-county`.
- `list_managed_projects` — List the company projects with their customer names. REST: `POST https://api.screed.dev/api/v1/project-management/projects/list`.
- `get_managed_project` — Read project details, its client and estimate summaries with integer costs in cents. REST: `POST https://api.screed.dev/api/v1/project-management/projects/read`.
- `create_drawer_project` — Create a project with its number and requested status using drawer rules. REST: `POST https://api.screed.dev/api/v1/project-management/projects/create-from-drawer`.
- `create_legacy_project` — Create a draft project using the legacy form rules and automatic creator assignment. REST: `POST https://api.screed.dev/api/v1/project-management/projects/create-draft`.
- `update_managed_project` — Edit project fields while preserving omitted values and signature location locks. REST: `PUT https://api.screed.dev/api/v1/project-management/projects/edit`.
- `delete_managed_project` — Delete an uncontracted project only when it has no purchasing, contract or field records. REST: `POST https://api.screed.dev/api/v1/project-management/projects/remove`.
- `get_field_settings` — Read company field integration settings. REST: `GET https://api.screed.dev/api/v1/field-settings`.
- `set_crew_channels_on_new_jobs` — Set whether new jobs open crew channels. REST: `PUT https://api.screed.dev/api/v1/field-settings/crew-channels`.
- `save_slack_bot_token` — Check and save the company Slack bot token. REST: `PUT https://api.screed.dev/api/v1/field-settings/slack/token`.
- `save_slack_signing_secret` — Save the company Slack signing secret. REST: `PUT https://api.screed.dev/api/v1/field-settings/slack/signing-secret`.
- `disconnect_slack` — Disconnect the company Slack workspace. REST: `POST https://api.screed.dev/api/v1/field-settings/slack/disconnect`.
- `create_field_api_key` — Create a company API key as a current administrator. REST: `POST https://api.screed.dev/api/v1/field-settings/api-keys`.
- `revoke_field_api_key` — Revoke a company API key as a current administrator. REST: `POST https://api.screed.dev/api/v1/field-settings/api-keys/:id/revoke`.
- `get_whatsapp_setup` — Read projects and members available for WhatsApp setup. REST: `POST https://api.screed.dev/api/v1/field-settings/whatsapp/setup`.
- `list_whatsapp_group_links` — List the company WhatsApp group links. REST: `GET https://api.screed.dev/api/v1/field-settings/whatsapp/groups`.
- `list_field_phones` — List active field phones and held message counts. REST: `GET https://api.screed.dev/api/v1/field-settings/whatsapp/phones`.
- `create_whatsapp_project_group` — Open a WhatsApp crew group and Slack job channel. REST: `POST https://api.screed.dev/api/v1/field-settings/whatsapp/groups/create`.
- `get_whatsapp_group_invite` — Read an existing WhatsApp group invite link. REST: `POST https://api.screed.dev/api/v1/field-settings/whatsapp/groups/:id/invite`.
- `create_whatsapp_group_link` — Link an existing WhatsApp group to a company project. REST: `POST https://api.screed.dev/api/v1/field-settings/whatsapp/groups/link`.
- `set_field_phone_role` — Set the reporting role of a company field phone. REST: `PUT https://api.screed.dev/api/v1/field-settings/whatsapp/phones/:phoneRegistrationId/role`.
- `delete_whatsapp_group_link` — Remove a WhatsApp group link from the company. REST: `POST https://api.screed.dev/api/v1/field-settings/whatsapp/groups/:id/delete`.
- `set_whatsapp_group_active` — Enable or disable a company WhatsApp group link. REST: `PUT https://api.screed.dev/api/v1/field-settings/whatsapp/groups/:id/active`.
- `link_field_phone_user` — Link a field phone to a current company member. REST: `PUT https://api.screed.dev/api/v1/field-settings/whatsapp/phones/:phoneRegistrationId/user`.
- `get_privacy_policy_setting` — Read the company’s signer privacy policy address. REST: `GET https://api.screed.dev/api/v1/settings/signer-privacy`.
- `save_privacy_policy_url` — Set the company’s signer privacy policy address as an owner or admin. REST: `PUT https://api.screed.dev/api/v1/settings/signer-privacy`.
- `confirm_tax_treatment` — Confirm Screed’s sourced sales tax treatment for a state, as an owner or admin. REST: `POST https://api.screed.dev/api/v1/settings/tax-treatments/confirm`.
- `set_job_time_zone` — Confirm or change the job’s time zone, which its field records follow, as its project manager, an owner or an admin. REST: `PUT https://api.screed.dev/api/v1/projects/:projectId/time-zone`.
- `list_product_claims` — Read the product facts a job’s documents would print, with sources and review status. REST: `GET https://api.screed.dev/api/v1/projects/:projectId/product-claims`.
- `propose_product_claim` — Send a product fact the catalog holds for review, citing its source document and page or section. REST: `POST https://api.screed.dev/api/v1/product-claims`.
- `review_product_claim` — Approve or reject a proposed product fact; only a product claims reviewer, signed in to Screed. REST: `POST https://api.screed.dev/api/v1/product-claims/:claimId/review`.
- `get_contractor_licenses` — Read the company’s state contractor license numbers. REST: `GET https://api.screed.dev/api/v1/settings/contractor-licenses`.
- `save_contractor_license` — Set or remove one state’s contractor license number as a company admin. REST: `PUT https://api.screed.dev/api/v1/settings/contractor-licenses`.
- `get_brand_kit` — Read the company’s saved document branding and editing permission. REST: `GET https://api.screed.dev/api/v1/settings/brand-kit`.
- `save_brand_kit` — Save checked document branding as a company owner or admin. REST: `PUT https://api.screed.dev/api/v1/settings/brand-kit`.
- `brand_kit_sample` — Render a sample page with unsaved document branding. REST: `POST https://api.screed.dev/api/v1/settings/brand-kit/sample`.
- `suggest_brand_from_website` — Read guarded branding suggestions from the company’s website without saving. REST: `GET https://api.screed.dev/api/v1/settings/brand-kit/website-suggestions`.
- `get_onboarding_integration_status` — Read the QuickBooks connection and sync status for onboarding. REST: `GET https://api.screed.dev/api/v1/settings/onboarding/integrations`.
- `trigger_onboarding_sync` — Push and link QuickBooks vendors during company onboarding. REST: `POST https://api.screed.dev/api/v1/settings/onboarding/sync`.
- `get_qbo_connection_status` — Read QuickBooks connection and the last successful sync without credentials. REST: `GET https://api.screed.dev/api/v1/settings/quickbooks/connection`.
- `disconnect_qbo` — Deactivate the company’s QuickBooks connection as a company admin. REST: `POST https://api.screed.dev/api/v1/settings/quickbooks/disconnect`.
- `sync_qbo_vendors` — Sync the company’s active suppliers to QuickBooks and retain tenant-owned mappings. REST: `POST https://api.screed.dev/api/v1/settings/quickbooks/vendors/sync`.
- `sync_qbo_classes` — Sync shared cost-code divisions into the company’s QuickBooks classes. REST: `POST https://api.screed.dev/api/v1/settings/quickbooks/classes/sync`.
- `pull_qbo_purchase_orders` — Bring QuickBooks job-tagged purchase orders into drafts and Needs linking. REST: `POST https://api.screed.dev/api/v1/settings/quickbooks/purchase-orders/pull`.
- `get_webhook_endpoints` — Read company webhook endpoint settings and delivery counts without signing secrets. REST: `GET https://api.screed.dev/api/v1/settings/webhook-endpoints`.
- `create_webhook_endpoint` — Create an outbound endpoint and reveal its signing secret once. REST: `POST https://api.screed.dev/api/v1/settings/webhook-endpoints`.
- `update_webhook_endpoint` — Change an outbound webhook’s name, URL or event types. REST: `PUT https://api.screed.dev/api/v1/settings/webhook-endpoints/:id`.
- `delete_webhook_endpoint` — Delete the company’s outbound endpoint. REST: `POST https://api.screed.dev/api/v1/settings/webhook-endpoints/:id/delete`.
- `toggle_webhook_endpoint` — Enable or disable the company’s outbound endpoint. REST: `POST https://api.screed.dev/api/v1/settings/webhook-endpoints/:id/toggle`.
- `test_webhook_endpoint` — Send one signed test ping and record its delivery outcome. REST: `POST https://api.screed.dev/api/v1/settings/webhook-endpoints/:id/test`.
- `get_webhook_delivery_log` — Read the company endpoint’s recent delivery attempts. REST: `GET https://api.screed.dev/api/v1/settings/webhook-endpoints/:id/deliveries`.
- `get_inbound_webhooks` — Read inbound webhook settings without signing secrets. REST: `GET https://api.screed.dev/api/v1/settings/inbound-webhooks`.
- `create_inbound_webhook` — Create an inbound webhook and reveal its signing secret once. REST: `POST https://api.screed.dev/api/v1/settings/inbound-webhooks`.
- `update_inbound_webhook` — Change the company’s inbound webhook mapping or name. REST: `PUT https://api.screed.dev/api/v1/settings/inbound-webhooks/:id`.
- `delete_inbound_webhook` — Delete the company’s inbound webhook. REST: `POST https://api.screed.dev/api/v1/settings/inbound-webhooks/:id/delete`.
- `toggle_inbound_webhook` — Enable or disable the company’s inbound webhook. REST: `POST https://api.screed.dev/api/v1/settings/inbound-webhooks/:id/toggle`.
- `get_integrations_overview` — Read company integration connection states without credentials or secrets. REST: `GET https://api.screed.dev/api/v1/settings/integrations`.
- `get_conversions` — Read the shared unit conversion reference table as a company member. REST: `GET https://api.screed.dev/api/v1/settings/conversions`.
- `convert_unit` — Convert a quantity or money in cents using exact reference factors. REST: `GET https://api.screed.dev/api/v1/settings/conversions/calculate`.
- `create_conversion` — Create a shared unit conversion and its inverse as authorized Screed staff. REST: `POST https://api.screed.dev/api/v1/settings/conversions`.
- `update_conversion` — Update one shared conversion as authorized Screed staff. REST: `PUT https://api.screed.dev/api/v1/settings/conversions/:id`.
- `delete_conversion` — Delete one shared conversion as authorized Screed staff. REST: `POST https://api.screed.dev/api/v1/settings/conversions/:id/delete`.
- `seed_common_conversions` — Add missing common shared conversions as authorized Screed staff. REST: `POST https://api.screed.dev/api/v1/settings/conversions/seed`.
- `get_team_settings` — List company members and pending invites as a current admin. REST: `GET https://api.screed.dev/api/v1/settings/team`.
- `update_team_member` — Update a company member’s role and workspace access as an admin. REST: `PUT https://api.screed.dev/api/v1/settings/team/members/:userId`.
- `transfer_company_ownership` — Transfer ownership to an existing company member as the current owner. REST: `POST https://api.screed.dev/api/v1/settings/team/ownership`.
- `invite_teammate` — Invite an email address to join the company with a job role. REST: `POST https://api.screed.dev/api/v1/settings/team/invites`.
- `resend_team_invite` — Email a pending company invite again as a current admin. REST: `POST https://api.screed.dev/api/v1/settings/team/invites/:inviteId/resend`.
- `revoke_team_invite` — Revoke a pending company invite as a current admin. REST: `POST https://api.screed.dev/api/v1/settings/team/invites/:inviteId/revoke`.
- `get_my_profile` — Read the connected member’s current profile. REST: `GET https://api.screed.dev/api/v1/settings/profile`.
- `update_my_profile` — Update the connected member’s name and phone. REST: `PUT https://api.screed.dev/api/v1/settings/profile`.
- `get_notification_preferences` — Read the connected member’s notification preferences. REST: `GET https://api.screed.dev/api/v1/settings/notification-preferences`.
- `update_notification_preferences` — Set the connected member’s notification preferences. REST: `PUT https://api.screed.dev/api/v1/settings/notification-preferences`.
- `list_my_push_devices` — List the connected member’s active push devices. REST: `GET https://api.screed.dev/api/v1/settings/push-devices`.
- `unregister_my_push_device` — Disable one of the connected member’s push devices. REST: `POST https://api.screed.dev/api/v1/settings/push-devices/:id/unregister`.
- `get_my_role` — Read the connected member’s current company role and workspace access. REST: `GET https://api.screed.dev/api/v1/settings/my-role`.
- `get_company_settings` — Read company document, estimate and contact defaults. REST: `GET https://api.screed.dev/api/v1/settings/company`.
- `update_company_settings` — Update company document, estimate and contact defaults as an admin. REST: `PUT https://api.screed.dev/api/v1/settings/company`.
- `get_number_formats` — Read the company’s PO and customer invoice number formats, whether each counts per company, year or job, and the next numbers, as an owner or admin. REST: `GET https://api.screed.dev/api/v1/settings/number-formats`.
- `preview_number_formats` — Show what saving number formats would do, without saving: each job’s and the company series’ next PO and invoice number, read from every number the company has in Screed and QuickBooks, and the numbers a format doesn’t read. The owner’s. REST: `POST https://api.screed.dev/api/v1/settings/number-formats/preview`.
- `update_number_formats` — Set the company’s PO and customer invoice number formats as its owner. Each job’s or year’s counter starts after the highest number already used in Screed and QuickBooks; existing numbers never change. REST: `PUT https://api.screed.dev/api/v1/settings/number-formats`.
- `record_number_handover` — Record, as the company’s owner, that QuickBooks has stopped issuing numbers in a series that spans jobs (a format without {job}, or the fallback for jobs without a number). Screed reads QuickBooks’ numbers again, starts the series after them, and issues from it from then on; until then, with QuickBooks connected, new numbers in it wait. REST: `POST https://api.screed.dev/api/v1/settings/number-formats/handover`.
- `onboard_payment_account` — Start or resume Stripe account onboarding as the company owner. REST: `POST https://api.screed.dev/api/v1/settings/payment-account/onboard`.
- `create_subscription_checkout` — Start or resume the company subscription checkout as a company admin. REST: `POST https://api.screed.dev/api/v1/settings/subscription/checkout`.
- `update_customer_invoice` — Update a draft using the member’s invoice editing rights. REST: `PUT https://api.screed.dev/api/v1/customer-invoices/:id/draft`.
- `delete_customer_invoice` — Delete an unsent invoice as a member allowed to delete drafts. REST: `POST https://api.screed.dev/api/v1/customer-invoices/:id/delete`.
- `replace_customer_invoice_link` — Rotate a sent invoice’s customer link using the member’s sending rights. REST: `POST https://api.screed.dev/api/v1/customer-invoices/:id/link`.
- `void_customer_invoice` — Void a sent invoice with a reason using the member’s invoice rights. REST: `POST https://api.screed.dev/api/v1/customer-invoices/:id/void`.
- `reissue_customer_invoice` — Copy a void invoice into a new draft using the member’s invoice rights. REST: `POST https://api.screed.dev/api/v1/customer-invoices/:id/reissue`.
- `void_recorded_invoice_payment` — Void a mistaken offline payment with a reason and the member’s payment rights. REST: `POST https://api.screed.dev/api/v1/customer-invoices/:id/payments/:paymentId/void`.
- `update_customer_invoice_settings` — Update invoice numbering, tax and payment defaults as the company owner. REST: `PUT https://api.screed.dev/api/v1/customer-invoice-settings`.
- `set_invoice_deposit_on_acceptance` — Turn acceptance deposits on or off as the company owner with verified two-step. REST: `PUT https://api.screed.dev/api/v1/customer-invoice-settings/deposit-on-acceptance`.
- `propose_resend_customer_invoice` — Ask a person to approve emailing a sent invoice again. REST: `POST https://api.screed.dev/api/v1/customer-invoices/:id/resend`; a person approves.
- `propose_refund_invoice_payment` — Ask an admin to approve returning a confirmed online payment through Stripe. REST: `POST https://api.screed.dev/api/v1/customer-invoices/:id/payments/:paymentId/refund`; a person approves.
- `bill_project_payment` — Create or reuse the invoice draft for one frozen payment schedule step. REST: `POST https://api.screed.dev/api/v1/billing/schedule-steps/invoice`.
- `get_project_billing` — Read project schedules, invoices and money received using the member’s billing rights. REST: `GET https://api.screed.dev/api/v1/billing/projects/:projectId`.
- `list_outside_purchase_orders` — Read outside purchase orders needing linking or conflict review. REST: `POST https://api.screed.dev/api/v1/procurement/outside-purchase-orders/query`.
- `list_outside_po_estimate_lines` — Read estimate line choices for linking an outside purchase order to this company’s project. REST: `GET https://api.screed.dev/api/v1/procurement/outside-purchase-orders/estimate-lines/:projectId`.
- `link_outside_purchase_order` — Link an outside purchase order to company project, supplier and item records. REST: `POST https://api.screed.dev/api/v1/procurement/outside-purchase-orders/:id/link`.
- `ignore_outside_purchase_order` — Ignore an outside purchase order as a member permitted to link outside orders. REST: `POST https://api.screed.dev/api/v1/procurement/outside-purchase-orders/:id/ignore`.
- `dismiss_outside_purchase_order` — Dismiss an outside purchase order warning through the existing company member checks. REST: `POST https://api.screed.dev/api/v1/procurement/outside-purchase-orders/:id/dismiss`.
- `get_ramp_po_subscription` — Read the optional Ramp purchase order webhook subscription and current member permissions. REST: `GET https://api.screed.dev/api/v1/procurement/ramp/subscription`.
- `subscribe_ramp_purchase_orders` — Replace the optional Ramp purchase order webhook subscription as a company administrator. REST: `POST https://api.screed.dev/api/v1/procurement/ramp/subscription`.
- `check_ramp_po_subscription` — Verify the optional Ramp subscription and update its saved status as a company administrator. REST: `POST https://api.screed.dev/api/v1/procurement/ramp/subscription/check`.
- `get_over_order_tolerance` — Read the company over-order tolerance and the member’s edit permission. REST: `GET https://api.screed.dev/api/v1/procurement/over-order-tolerance`.
- `save_over_order_tolerance` — Set the company over-order tolerance as an owner or admin past two-step verification. REST: `PUT https://api.screed.dev/api/v1/procurement/over-order-tolerance`.
- `list_receivers` — List delivery receipts visible to the current company member. REST: `POST https://api.screed.dev/api/v1/procurement/receivers/query`.
- `get_receiver` — Open a company delivery receipt and its line items. REST: `GET https://api.screed.dev/api/v1/procurement/receivers/:receiverId`.
- `update_receiver_status` — Update a receipt status as the current member; accepting, rejecting or disputing evidence requires a fresh approval grant. REST: `PUT https://api.screed.dev/api/v1/procurement/receivers/:receiverId/status`.
- `get_receiver_po_lines` — List open purchase order lines available for receiving. REST: `GET https://api.screed.dev/api/v1/procurement/receiving/po-lines/:purchaseOrderId`.
- `list_receivable_purchase_orders` — List company purchase orders in a receivable status and whether quantities remain open. REST: `GET https://api.screed.dev/api/v1/procurement/receiving/purchase-orders`.
- `get_receiver_signature` — Read signature evidence on a company delivery receipt. REST: `GET https://api.screed.dev/api/v1/procurement/receivers/:receiverId/signature`.
- `get_receiver_stats` — Count company delivery receipts by status and received day. REST: `GET https://api.screed.dev/api/v1/procurement/receiving/stats`.
- `submit_site_delivery_report` — Submit the member’s site delivery evidence for verification and booking, with stable receipt retry identity. REST: `POST https://api.screed.dev/api/v1/procurement/site-delivery-reports`.
- `get_receiving_history` — Read the current member’s company purchase order receiving history and evidence. REST: `GET https://api.screed.dev/api/v1/procurement/receiving/:poId/history`.
- `list_procurement_rules` — Read the company’s procurement automation rules in priority order. REST: `GET https://api.screed.dev/api/v1/procurement/automation-rules`.
- `create_procurement_rule` — Create a procurement automation rule after the caller’s company rights are checked. REST: `POST https://api.screed.dev/api/v1/procurement/automation-rules`.
- `update_procurement_rule` — Update only the supplied fields of a company procurement rule. REST: `PUT https://api.screed.dev/api/v1/procurement/automation-rules/:id`.
- `delete_procurement_rule` — Delete a procurement rule owned by the calling company. REST: `POST https://api.screed.dev/api/v1/procurement/automation-rules/:id/delete`.
- `toggle_procurement_rule` — Toggle a company procurement rule’s active state under the company ordering lock. REST: `POST https://api.screed.dev/api/v1/procurement/automation-rules/:id/toggle`.
- `reorder_procurement_rules` — Set company rule priorities in the supplied order and refuse unknown or repeated rules. REST: `POST https://api.screed.dev/api/v1/procurement/automation-rules/reorder`.
- `list_company_suppliers` — Read the company’s suppliers, private contacts and edit eligibility. REST: `GET https://api.screed.dev/api/v1/procurement/company-suppliers`.
- `create_company_supplier` — Add or reactivate a supplier while keeping company contacts private. REST: `POST https://api.screed.dev/api/v1/procurement/company-suppliers`.
- `update_company_supplier` — Update the company’s supplier details without renaming the shared directory. REST: `PUT https://api.screed.dev/api/v1/procurement/company-suppliers/:id`.
- `set_company_supplier_active` — Deactivate or reactivate a company supplier without deleting past purchases. REST: `POST https://api.screed.dev/api/v1/procurement/company-suppliers/:id/active`.
- `get_vendor_dispatch` — Read a dispatch only with its valid signed vendor credential and matching caller company. REST: `POST https://api.screed.dev/api/v1/procurement/vendor-portal/dispatch`.
- `confirm_vendor_delivery` — Confirm the requested delivery schedule using its signed vendor credential. REST: `POST https://api.screed.dev/api/v1/procurement/vendor-portal/dispatch/confirm`.
- `list_operational_purchase_orders` — List purchase orders using the company member’s operational filters. REST: `POST https://api.screed.dev/api/v1/procurement/purchase-orders/query`.
- `get_operational_purchase_order` — Read the complete operational purchase order with monetary amounts in cents. REST: `GET https://api.screed.dev/api/v1/procurement/purchase-orders/:poId`.
- `create_operational_purchase_order` — Create a draft purchase order with the authenticated member recorded as author. REST: `POST https://api.screed.dev/api/v1/procurement/purchase-orders`.
- `update_operational_purchase_order` — Edit an operational purchase order under its current status and company policy. REST: `PUT https://api.screed.dev/api/v1/procurement/purchase-orders/:poId`.
- `validate_purchase_order_issue` — Read the same issue blockers and warnings shown in the purchase order sheet. REST: `GET https://api.screed.dev/api/v1/procurement/purchase-orders/:poId/issue-check`.
- `list_purchase_order_projects` — Read the active company projects offered in the purchase order editor. REST: `GET https://api.screed.dev/api/v1/procurement/purchase-order-projects`.
- `list_purchase_order_vendors` — Read the company suppliers offered in the purchase order editor. REST: `GET https://api.screed.dev/api/v1/procurement/purchase-order-vendors`.
- `list_purchase_order_items` — Read catalog items available in the purchase order editor with prices in cents. REST: `GET https://api.screed.dev/api/v1/procurement/purchase-order-items`.
- `get_purchase_order_pricing` — Read the selected project’s supplier price for an item in cents. REST: `POST https://api.screed.dev/api/v1/procurement/purchase-order-pricing/query`.
- `get_purchase_order_vendor_context` — Read company supplier history and optional project budget context in cents. REST: `POST https://api.screed.dev/api/v1/procurement/purchase-order-vendor-context/query`.
- `get_purchase_order_requests` — Read the waiting and most recent agent request shown on a purchase order. REST: `GET https://api.screed.dev/api/v1/procurement/purchase-orders/:poId/requests`.
- `get_operational_ramp_approval` — Read the purchase order’s current Ramp approval and available member action. REST: `GET https://api.screed.dev/api/v1/procurement/purchase-orders/:poId/ramp-approval`.
- `request_operational_ramp_approval` — Submit a company purchase order to the selected Ramp approval workflow. REST: `POST https://api.screed.dev/api/v1/procurement/purchase-orders/:poId/ramp-approval`.
- `propose_record_operational_purchase_order_sent` — Ask a person to approve recording the purchase order as sent outside Screed. REST: `POST https://api.screed.dev/api/v1/procurement/purchase-orders/:poId/record-sent`; a person approves.
- `propose_cancel_operational_purchase_order` — Ask a person to approve cancelling the purchase order through its existing operational rules. REST: `POST https://api.screed.dev/api/v1/procurement/purchase-orders/:poId/cancel`; a person approves.
- `browse_catalog` — Browse product lines using the same catalog filters as the web catalog. REST: `POST https://api.screed.dev/api/v1/catalog/browse`.
- `get_catalog_facets` — Read available catalog filter values and counts. REST: `GET https://api.screed.dev/api/v1/catalog/facets`.
- `get_catalog_product` — Read product specifications, alternatives, and source documents. REST: `GET https://api.screed.dev/api/v1/catalog/products/:itemId`.
- `search_catalog_items` — Search shared products and the calling company’s linked items. REST: `POST https://api.screed.dev/api/v1/catalog/items/search`.
- `get_item_detail` — Read catalog specifications and company usage and purchase history in cents. REST: `GET https://api.screed.dev/api/v1/catalog/items/:itemId/detail`.
- `get_related_items` — Read products from the same manufacturer and installation layer. REST: `GET https://api.screed.dev/api/v1/catalog/items/:itemId/related`.
- `get_item_price_history` — Read the calling company’s monthly purchase price history in cents. REST: `GET https://api.screed.dev/api/v1/catalog/items/:itemId/prices`.
- `create_company_item` — Create a company-owned item using the catalog editor’s validation and matching. REST: `POST https://api.screed.dev/api/v1/catalog/company-items`.
- `update_company_item` — Update company-owned item defaults while preserving source item-list ownership. REST: `PUT https://api.screed.dev/api/v1/catalog/company-items/:itemId`.
- `set_company_item_active` — Change a company item’s availability while preserving existing estimate lines. REST: `PUT https://api.screed.dev/api/v1/catalog/company-items/:itemId/active`.
- `get_item_review_counts` — Read counts for the calling company’s catalog item review queues. REST: `GET https://api.screed.dev/api/v1/catalog/company-items/review-counts`.
- `create_estimate_area` — Add an estimate area or its one general-conditions section. REST: `POST https://api.screed.dev/api/v1/estimate-areas`.
- `edit_estimate_area` — Edit an area while preserving the estimate and signature locks. REST: `PUT https://api.screed.dev/api/v1/estimate-areas/:id`.
- `set_area_dimensions` — Set base depth, bedding depth or joint width on an open estimate area. REST: `PUT https://api.screed.dev/api/v1/estimate-areas/:id/dimensions`.
- `delete_estimate_area` — Delete an open area unless general conditions, orders or billing retain it. REST: `POST https://api.screed.dev/api/v1/estimate-areas/:id/delete`.
- `list_estimate_areas` — Read the company estimate areas and their material lines, with costs in cents. REST: `GET https://api.screed.dev/api/v1/estimates/:estimateId/areas`.
- `list_area_patterns` — Read the laying patterns offered by the area picker. REST: `GET https://api.screed.dev/api/v1/estimate-area-patterns`.
- `list_area_catalog_items` — Read products available to the area picker, with prices in cents. REST: `GET https://api.screed.dev/api/v1/estimate-area-catalog`.
- `preview_area_build` — Preview the exact materials, cited depths and edge change the area picker applies. REST: `GET https://api.screed.dev/api/v1/estimate-areas/:areaId/build-preview`.
- `change_area_build` — Change the area build, cited depths and materials together under the estimate lock. REST: `POST https://api.screed.dev/api/v1/estimate-areas/:areaId/build`.
- `add_estimate_area_item` — Add a product with the same pricing, sizing and scope rules as the estimating UI. REST: `POST https://api.screed.dev/api/v1/estimate-area-items`.
- `add_estimate_company_line` — Add or quick-create one company item using the UI price, labor and sizing rules. REST: `POST https://api.screed.dev/api/v1/estimate-company-lines`.
- `edit_estimate_area_item` — Edit quantity, price, waste, notes, scope or furnishing through the UI mutation service. REST: `PUT https://api.screed.dev/api/v1/estimate-area-items/:areaItemId`.
- `set_area_item_quantity` — Type or reset quantity, drafting a change-order overlay for a contracted baseline. REST: `PUT https://api.screed.dev/api/v1/estimate-area-items/:areaItemId/quantity`.
- `set_area_item_waste` — Set or reset the waste percentage and recalculate the line under the estimate lock. REST: `PUT https://api.screed.dev/api/v1/estimate-area-items/:areaItemId/waste`.
- `set_area_item_by_others` — Set whether others furnish the line and recalculate its cost under the UI lock rules. REST: `PUT https://api.screed.dev/api/v1/estimate-area-items/:areaItemId/by-others`.
- `delete_estimate_area_item` — Remove an editable line unless a purchase order or frozen baseline retains it. REST: `POST https://api.screed.dev/api/v1/estimate-area-items/:areaItemId/delete`.
- `set_area_item_color` — Set or clear the proposal color while enforcing signature and baseline locks. REST: `PUT https://api.screed.dev/api/v1/estimate-area-items/:areaItemId/color`.
- `swap_estimate_area_item` — Swap catalog or company product, retaining line role and using the UI price and sizing rules. REST: `POST https://api.screed.dev/api/v1/estimate-area-items/:areaItemId/swap`.
- `search_estimate_company_items` — Find active company items ranked exactly as the estimate add row. REST: `GET https://api.screed.dev/api/v1/estimate-company-items/search`.
- `create_workspace_estimate` — Create a draft with company rates and its general conditions section. REST: `POST https://api.screed.dev/api/v1/estimate-workspace`.
- `get_workspace_estimate` — Read the complete canvas estimate, including scope, products, tax and company settings. REST: `GET https://api.screed.dev/api/v1/estimate-workspace/:id`.
- `list_project_workspace_estimates` — List the job’s estimates newest first using its ID or address token. REST: `GET https://api.screed.dev/api/v1/project-estimates/:project`.
- `list_workspace_estimates` — List company estimates with prices derived from their current lines. REST: `GET https://api.screed.dev/api/v1/estimate-workspace`.
- `update_workspace_estimate` — Rename an open estimate or change its description under its row lock. REST: `PUT https://api.screed.dev/api/v1/estimate-workspace/:id`.
- `update_workspace_estimate_rates` — Change estimate percentages under its row and signature lock. REST: `PUT https://api.screed.dev/api/v1/estimate-workspace/:id/rates`.
- `remove_workspace_estimate` — Delete an open unsigned estimate only when no downstream records refer to it. REST: `POST https://api.screed.dev/api/v1/estimate-workspace/:id/remove`.
- `duplicate_workspace_estimate` — Copy scope, options, geometry, labor and settings into a new draft. REST: `POST https://api.screed.dev/api/v1/estimate-workspace/:id/duplicate`.
- `list_estimate_patterns` — List shared installation patterns in name order. REST: `GET https://api.screed.dev/api/v1/estimate-patterns`.
- `open_first_workspace_estimate` — Open the oldest job estimate or atomically create its first draft. REST: `POST https://api.screed.dev/api/v1/estimate-workspace/first`.
- `accept_labor_learning` — Copy the estimate into its next version with the chosen areas’ labor hours learned from confirmed Board work; the estimate itself is unchanged. REST: `POST https://api.screed.dev/api/v1/estimate-workspace/:estimateId/labor-learning`.
- `list_company_clients` — List active and retired clients with their projects. REST: `GET https://api.screed.dev/api/v1/company-clients`.
- `update_company_client` — Replace client details while refusing active name clashes. REST: `PUT https://api.screed.dev/api/v1/company-clients/:id`.
- `set_company_client_active` — Retire or restore a client while preserving its projects. REST: `PUT https://api.screed.dev/api/v1/company-clients/:id/active`.
- `extract_bluebeam_takeoff` — Extract validated areas and measured outlines from Bluebeam XML. REST: `POST https://api.screed.dev/api/v1/takeoff/bluebeam/extract`.
- `draft_area_surface` — Draft an awarded area’s surface quantity through the change-order service. REST: `POST https://api.screed.dev/api/v1/areas/:areaId/change-order/surface`.
- `draft_area_perimeter` — Draft an awarded area’s perimeter through the change-order service. REST: `POST https://api.screed.dev/api/v1/areas/:areaId/change-order/perimeter`.
- `reset_area_change_order` — Clear pending change-order overlays for one awarded area. REST: `POST https://api.screed.dev/api/v1/areas/:areaId/change-order/reset`.
- `discard_change_order` — Discard all pending overlays for an awarded estimate. REST: `POST https://api.screed.dev/api/v1/estimates/:id/change-order/discard`.
- `preview_estimate_win` — Review the current proposal and price a member may win. REST: `GET https://api.screed.dev/api/v1/estimates/:id/win-preview`.
- `preview_estimate_unlock` — Review the won version and the invoices that remain billed through a revision. REST: `GET https://api.screed.dev/api/v1/estimates/:id/unlock-preview`.
- `unlock_estimate_to_revise` — Reopen a won estimate using the member’s existing revision rights. REST: `POST https://api.screed.dev/api/v1/estimates/:id/unlock`.
- `normalize_estimate_uts` — Read the estimate’s assemblies, materials and labor in the shared trade representation. REST: `GET https://api.screed.dev/api/v1/estimates/:id/trade-model`.
- `sync_estimate_totals` — Recalculate an estimate’s stored cost from its line totals in exact cents. REST: `POST https://api.screed.dev/api/v1/estimates/:id/recalculate-total`.
- `resolve_estimate_assembly` — Resolve a default assembly and its compatible catalog products. REST: `POST https://api.screed.dev/api/v1/estimate-assemblies/search`.
- `compare_estimate_assemblies` — Compare complete assembly resolutions and their layer differences. REST: `POST https://api.screed.dev/api/v1/estimate-assemblies/compare`.
- `recalculate_area_items` — Resize an open area’s calculated quantities while preserving typed and manual quantities. REST: `POST https://api.screed.dev/api/v1/areas/:areaId/recalculate-items`.
- `get_area_constraint_bundle` — Read the area’s applicable rule set and company or manufacturer variants. REST: `GET https://api.screed.dev/api/v1/areas/:areaId/constraint-bundle`.
- `evaluate_area_constraints` — Evaluate the area’s priced catalog facts and surface sentence against its applicable rules. REST: `GET https://api.screed.dev/api/v1/areas/:areaId/constraint-evaluation`.
- `get_area_picker_alternatives` — Rank compatible product alternatives with the estimating UI’s same-brand, industry and value choices. REST: `POST https://api.screed.dev/api/v1/areas/:areaId/product-alternatives/search`.
- `set_estimate_item_supplier` — Save the company’s preferred supplier for an estimate line’s catalog product. REST: `POST https://api.screed.dev/api/v1/area-items/:areaItemId/preferred-supplier`.
- `set_estimate_supplier_deliveries` — Plan a supplier’s delivery count for the open estimate’s sourced sales tax. REST: `POST https://api.screed.dev/api/v1/estimate-supplier-deliveries`.
- `get_estimate_procurement_status` — Read the latest purchase-order status for each allocated estimate line. REST: `GET https://api.screed.dev/api/v1/estimates/:id/procurement-status`.
- `export_estimate_csv` — Export the same estimate lines and costs as the estimating CSV download. REST: `GET https://api.screed.dev/api/v1/estimates/:id/export-csv`.
- `get_latest_estimate_proposal_issue` — Read the latest issued proposal’s recorded price, issuer and schedule-fit evidence. REST: `GET https://api.screed.dev/api/v1/estimates/:id/latest-proposal-issue`.
- `set_estimate_labor_rate` — Set an estimate’s hourly labor rate and reprice its calculated hourly company lines. REST: `POST https://api.screed.dev/api/v1/estimates/:id/labor-rate`.
- `set_company_default_labor_rate` — Set the company’s default hourly labor rate with the member’s current administrator rights. REST: `POST https://api.screed.dev/api/v1/company/default-labor-rate`.
- `get_estimate_contract_state` — Read the frozen version, issued changes and pending change-order differences. REST: `GET https://api.screed.dev/api/v1/estimates/:id/contract-state`.
- `refresh_estimate_after_mutation` — Apply a mutation’s sizing effects and refresh the same totals and constraint warnings as the canvas. REST: `POST https://api.screed.dev/api/v1/estimates/:estimateId/areas/:areaId/refresh`.
- `create_site_scan` — Record capture consent and open resumable uploads for a project site scan. REST: `POST https://api.screed.dev/api/v1/site-scans`.
- `upload_site_scan_parts` — Request upload URLs for only the parts still missing from a site scan. REST: `POST https://api.screed.dev/api/v1/site-scans/:scanId/parts`.
- `complete_site_scan_upload` — Verify uploaded parts and queue a site scan for processing once. REST: `POST https://api.screed.dev/api/v1/site-scans/:scanId/complete`.
- `get_site_scan` — Read a project site scan with checks and signed URLs for derived assets. REST: `GET https://api.screed.dev/api/v1/site-scans/:scanId`.
- `list_site_scans` — List project site scans and candidate counts with choices available to the calling person. REST: `GET https://api.screed.dev/api/v1/site-scans`.
- `list_scan_candidates` — Read measured site surfaces and their evidence before a person applies them. REST: `GET https://api.screed.dev/api/v1/site-scans/:scanId/candidates`.
- `import_site_file` — Record consent and open a resumable upload for a site survey or model. REST: `POST https://api.screed.dev/api/v1/site-scans/imports`.
- `propose_apply_scan` — Ask a person to add reviewed site scan surfaces to an open estimate. REST: `POST https://api.screed.dev/api/v1/site-scans/:scanId/apply`; a person approves.
- `list_closeout_items` — Read the closeout checklist and available catalog PDFs for the project. REST: `GET https://api.screed.dev/api/v1/closeouts/:projectId/items`.
- `add_closeout_item` — Add a required or optional warranty, manual or as-built checklist item. REST: `POST https://api.screed.dev/api/v1/closeouts/:projectId/items`.
- `rename_closeout_item` — Rename an item on the closeout checklist. REST: `PUT https://api.screed.dev/api/v1/closeouts/items/:id/name`.
- `set_closeout_item_required` — Mark a closeout checklist item required or optional. REST: `PUT https://api.screed.dev/api/v1/closeouts/items/:id/required`.
- `remove_closeout_item` — Remove a closeout checklist item while it has no attached file. REST: `POST https://api.screed.dev/api/v1/closeouts/items/:id/remove`.
- `attach_closeout_upload` — Attach a verified PDF upload from this project to a closeout checklist item. REST: `POST https://api.screed.dev/api/v1/closeouts/items/:id/uploads`.
- `begin_job_file_upload` — Reserve a multipart PDF upload for a closeout, an RFI or a historical reference on a project. REST: `POST https://api.screed.dev/api/v1/job-files/uploads`.
- `complete_job_file_upload` — Verify an uploaded project PDF and record its exact hash and size. REST: `POST https://api.screed.dev/api/v1/job-files/uploads/:uploadId/complete`.
- `import_takeoff` — Create measured areas in order and import available Bluebeam outlines. REST: `POST https://api.screed.dev/api/v1/estimates/:estimateId/takeoff`.
- `set_plan_sheet_calibration` — Set a two-point sheet scale in feet and record the calling person or API key. REST: `POST https://api.screed.dev/api/v1/plans/sheets/:sheetId/calibration`.
- `set_plan_area_outline` — Save sheet-inch outlines using the stored scale and resize calculated estimate quantities. REST: `POST https://api.screed.dev/api/v1/plans/sheets/:sheetId/areas/:areaId/outline`.
- `register_oauth_app` — Register an app as a company administrator and show its client secret once. REST: `POST https://api.screed.dev/api/v1/oauth/apps`.
- `get_bom` — Read the latest bill of materials or its draft. REST: `GET https://api.screed.dev/api/v1/documents/boms`.
- `issue_bom` — Issue a frozen bill of materials grouped by supplier. REST: `POST https://api.screed.dev/api/v1/documents/boms/issue`.
- `get_ship_request` — Read a shipping request’s latest issue or draft HTML. REST: `GET https://api.screed.dev/api/v1/documents/ship-requests/:dispatchId`.
- `issue_ship_request` — Freeze a shipping request as an issued HTML page and PDF. REST: `POST https://api.screed.dev/api/v1/documents/ship-requests/issue`.
- `propose_send_ship_request` — Ask a person to approve sending a shipping request to its supplier. REST: `POST https://api.screed.dev/api/v1/procurement/ship-requests/:dispatchId/send`; a person approves.
- `create_ship_request` — Create a shipping or pickup request from an open purchase order. REST: `POST https://api.screed.dev/api/v1/procurement/ship-requests`.
- `list_ship_requests` — List a purchase order’s shipping and pickup requests and latest issues. REST: `GET https://api.screed.dev/api/v1/procurement/ship-requests`.
- `download_document` — Download verified issued files using temporary private links. REST: `GET https://api.screed.dev/api/v1/documents/:issueId/download`.
- `list_documents` — List issued project documents with kind, area and status filters. REST: `GET https://api.screed.dev/api/v1/documents`.
- `get_document` — Read verified issued PDF, HTML or manifest bytes as inline base64. REST: `GET https://api.screed.dev/api/v1/documents/:issueId`.
- `issue_document` — Freeze a document issue after reviewing any missing information. REST: `POST https://api.screed.dev/api/v1/documents/issue`.
- `build_package` — Assemble issued project documents into a ZIP or bound PDF. REST: `POST https://api.screed.dev/api/v1/documents/packages`.
- `get_estimate_document` — Read the latest issued estimate or preview its draft HTML. REST: `GET https://api.screed.dev/api/v1/documents/estimates`.
- `issue_estimate_document` — Issue a frozen estimate cost sheet for all areas or one area. REST: `POST https://api.screed.dev/api/v1/documents/estimates/issue`.
- `get_purchase_order_document` — Read the latest issued purchase order or its draft HTML. REST: `GET https://api.screed.dev/api/v1/documents/purchase-orders/:purchaseOrderId`.
- `issue_purchase_order_document` — Issue a frozen purchase order document after reviewing its gaps. REST: `POST https://api.screed.dev/api/v1/documents/purchase-orders/issue`.
- `get_receiver_document` — Read the latest delivery receipt or preview its draft. REST: `GET https://api.screed.dev/api/v1/documents/receivers/:receiverId`.
- `issue_receiver_document` — Freeze a delivery receipt as HTML and PDF. REST: `POST https://api.screed.dev/api/v1/documents/receivers/issue`.
- `get_submittal_register` — Read product submittal revisions and review actions for a project. REST: `GET https://api.screed.dev/api/v1/submittals/register`.
- `create_submittal_package` — Create a submittal package from products on an estimate. REST: `POST https://api.screed.dev/api/v1/submittals/packages`.
- `record_submittal_review` — Record a returned review against the latest submittal revision. REST: `POST https://api.screed.dev/api/v1/submittals/reviews`.
- `get_rfi` — Read a question and its recorded answer. REST: `GET https://api.screed.dev/api/v1/rfis/:rfiId`.
- `list_rfis` — List numbered questions on a project. REST: `GET https://api.screed.dev/api/v1/projects/:projectId/rfis`.
- `create_rfi` — Create the next numbered project question. REST: `POST https://api.screed.dev/api/v1/rfis`.
- `record_rfi_answer` — Record an answer without changing issued documents. REST: `POST https://api.screed.dev/api/v1/rfis/:rfiId/answer`.
- `issue_rfi` — Freeze the question and current answer as the next issue. REST: `POST https://api.screed.dev/api/v1/documents/rfis/issue`.
- `update_rfi` — Edit an RFI question, subject, assignee or priority without changing frozen issues. REST: `PUT https://api.screed.dev/api/v1/rfis/:rfiId`.
- `close_rfi` — Close an RFI without changing its recorded question, answer or issued files. REST: `POST https://api.screed.dev/api/v1/rfis/:rfiId/close`.
- `attach_rfi_file` — Attach a verified completed upload from the same project to an RFI. REST: `POST https://api.screed.dev/api/v1/rfis/:rfiId/attachments`.
- `create_rfi_link` — Create a public link to one frozen RFI issue. REST: `POST https://api.screed.dev/api/v1/rfis/links`.
- `get_closeout` — Read the job closeout checklist and latest issued closeout. REST: `GET https://api.screed.dev/api/v1/documents/closeouts/:projectId`.
- `issue_closeout` — Issue a frozen closeout with its attached warranty, manual and as-built PDFs. REST: `POST https://api.screed.dev/api/v1/documents/closeouts/issue`.
- `attach_closeout_document` — Attach a stored catalog PDF from a product on the job to a closeout item. REST: `POST https://api.screed.dev/api/v1/closeouts/:id/attachments`.
- `get_submittal` — Read the latest submittal issue or preview an unissued package with its gaps. REST: `GET https://api.screed.dev/api/v1/documents/submittals/:packageId`.
- `issue_submittal` — Issue a frozen submittal package after reviewing its gaps. REST: `POST https://api.screed.dev/api/v1/documents/submittals/issue`.
- `prepare_estimate_submittal` — Prepare the estimate’s default submittal package or open its existing package register. REST: `POST https://api.screed.dev/api/v1/submittals/prepare`.
- `get_crew_sheet` — Read a crew day’s work, materials and deliveries. REST: `GET https://api.screed.dev/api/v1/documents/crew-sheet`.
- `issue_crew_sheet` — Issue a frozen crew work-order sheet. REST: `POST https://api.screed.dev/api/v1/documents/crew-sheet/issue`.
- `get_schedule_document` — Read a project lookahead and its gaps. REST: `GET https://api.screed.dev/api/v1/documents/schedule`.
- `issue_schedule` — Issue a frozen project lookahead. REST: `POST https://api.screed.dev/api/v1/documents/schedule/issue`.
- `get_photo_log` — Read project photos by day and area. REST: `GET https://api.screed.dev/api/v1/documents/photo-log`.
- `issue_photo_log` — Issue a frozen project photo log. REST: `POST https://api.screed.dev/api/v1/documents/photo-log/issue`.
- `get_punch_list` — Preview punch items and omitted photos for a project. REST: `GET https://api.screed.dev/api/v1/documents/punch-list`.
- `issue_punch_list` — Issue a frozen punch list for a project. REST: `POST https://api.screed.dev/api/v1/documents/punch-list/issue`.
- `list_punch_items` — List punch items on a project. REST: `GET https://api.screed.dev/api/v1/punch-items/list`.
- `create_punch_item` — Record a punch item on a project. REST: `POST https://api.screed.dev/api/v1/punch-items/create`.
- `set_punch_item_status` — Change a punch item’s status. REST: `POST https://api.screed.dev/api/v1/punch-items/:itemId/status`.
- `update_punch_item` — Edit a punch item’s capture details. REST: `POST https://api.screed.dev/api/v1/punch-items/:itemId/update`.
- `add_punch_photo` — Upload photo bytes to a punch item. REST: `POST https://api.screed.dev/api/v1/punch-items/:itemId/photos`.
- `get_daily_report` — Read a reviewed daily report and its gaps. REST: `GET https://api.screed.dev/api/v1/documents/daily-report`.
- `issue_daily_report` — Issue a frozen daily report for a project day. REST: `POST https://api.screed.dev/api/v1/documents/daily-report/issue`.
- `get_project_review` — Read the latest draft and approved project review with frozen evidence citations. REST: `GET https://api.screed.dev/api/v1/projects/:projectId/review`.
- `draft_project_review` — Draft a cited project review from reviewed evidence for a person to edit and approve. REST: `POST https://api.screed.dev/api/v1/projects/:projectId/review/draft`.
- `edit_project_review` — Edit draft review claims as an authorized delegated member, retaining named person provenance. REST: `PUT https://api.screed.dev/api/v1/projects/:projectId/review/:reviewId`.
- `get_project_evidence` — Read the project’s recorded evidence through a cutoff. REST: `GET https://api.screed.dev/api/v1/project-review/evidence`.
- `get_project_review_document` — Find the latest issued project review and its document link. REST: `GET https://api.screed.dev/api/v1/documents/project-reviews`.
- `issue_project_review` — Issue the latest approved review as a frozen project document. REST: `POST https://api.screed.dev/api/v1/documents/project-reviews/issue`.
- `list_project_feedback` — Read customer feedback recorded for a project. REST: `GET https://api.screed.dev/api/v1/project-feedback`.
- `record_project_feedback` — Record what a customer said about completed work. REST: `POST https://api.screed.dev/api/v1/project-feedback/record`.
- `create_feedback_link` — Create a private single-response customer feedback link. REST: `POST https://api.screed.dev/api/v1/project-feedback/link`.
- `list_project_issues` — List tracked issues for a project. REST: `GET https://api.screed.dev/api/v1/projects/:projectId/issues`.
- `raise_project_issue` — Track an issue and its impact on a project. REST: `POST https://api.screed.dev/api/v1/projects/:projectId/issues/raise`.
- `resolve_project_issue` — Resolve a tracked issue with a recorded resolution. REST: `POST https://api.screed.dev/api/v1/project-issues/:issueId/resolve`.
- `set_area_outline` — Save an outline in feet and resize calculated quantities. REST: `POST https://api.screed.dev/api/v1/areas/:areaId/outline`.
- `get_project_scene` — Read the estimate layout with optional proposal choices applied. REST: `GET https://api.screed.dev/api/v1/estimates/:estimateId/scene`.
- `get_change_order_document` — Get the frozen document for an already issued change order. REST: `GET https://api.screed.dev/api/v1/documents/change-orders/:estimateId/:number`.
- `issue_change_order_document` — Issue or reuse the frozen document for an already locked change order. REST: `POST https://api.screed.dev/api/v1/documents/change-orders/:estimateId/issue`.
- `get_job_cost` — Read contracted, committed and actual job costs in cents. REST: `GET https://api.screed.dev/api/v1/reports/job-cost/:projectId`.
- `get_wip` — Read earned revenue and sent billings on active contracts. REST: `GET https://api.screed.dev/api/v1/reports/wip`.
- `get_ar_aging` — Read unpaid invoices and pay applications aged in company days. REST: `GET https://api.screed.dev/api/v1/reports/ar-aging`.
- `issue_job_cost_report` — Freeze a job cost report as HTML and PDF. REST: `POST https://api.screed.dev/api/v1/documents/reports/job-cost`.
- `issue_wip_report` — Freeze a company work in progress report as HTML and PDF. REST: `POST https://api.screed.dev/api/v1/documents/reports/wip`.
- `issue_ar_aging_report` — Freeze a company receivables aging report as HTML and PDF. REST: `POST https://api.screed.dev/api/v1/documents/reports/ar-aging`.
- `get_customer_invoice_document` — Read the latest frozen customer invoice document. REST: `GET https://api.screed.dev/api/v1/documents/customer-invoices/:invoiceId`.
- `issue_customer_invoice_document` — Freeze or reuse the document of an already-sent customer invoice. REST: `POST https://api.screed.dev/api/v1/documents/customer-invoices/:invoiceId/issue`.
- `create_subcontract` — Create a draft subcontract with an exact schedule of values. REST: `POST https://api.screed.dev/api/v1/subcontracts`.
- `get_subcontract` — Read a subcontract in your company. REST: `GET https://api.screed.dev/api/v1/subcontracts/:subcontractId`.
- `issue_subcontract` — Freeze or reuse an issued subcontract document. REST: `POST https://api.screed.dev/api/v1/documents/subcontracts/:subcontractId/issue`.
- `propose_send_subcontract` — Ask a person to approve sending a subcontract for signature. REST: `POST https://api.screed.dev/api/v1/subcontracts/:subcontractId/propose-send`; a person approves.
- `list_subcontracts` — List the subcontracts on a project in your company. REST: `GET https://api.screed.dev/api/v1/subcontracts`.
- `list_subcontract_vendors` — List active company vendors available for a project subcontract. REST: `GET https://api.screed.dev/api/v1/subcontracts/vendors`.
- `save_subcontract` — Create a subcontract or replace the fields and lines of an existing draft. REST: `PUT https://api.screed.dev/api/v1/subcontracts`.
- `withdraw_subcontract` — Withdraw a subcontract signature request as an authorized person with fresh two-step approval. REST: `POST https://api.screed.dev/api/v1/subcontracts/:subcontractId/withdraw`.
- `create_pay_application` — Create a pay application from the contract schedule of values. REST: `POST https://api.screed.dev/api/v1/billing-applications/create`.
- `get_pay_application` — Read a pay application belonging to the calling company. REST: `GET https://api.screed.dev/api/v1/billing-applications/:billingApplicationId`.
- `issue_pay_application` — Freeze a pay application as an issued HTML and PDF document. REST: `POST https://api.screed.dev/api/v1/documents/billing-applications/:billingApplicationId/issue`.
- `list_event_types` — List available event types, labels and audiences. REST: `GET https://api.screed.dev/api/v1/events/types`.
- `list_events` — Read visible events after a 30-second settling window; transactions committing later than that window can be missed. REST: `GET https://api.screed.dev/api/v1/events`.
- `subscribe_events` — Create an HTTPS subscription and show its signing secret once. REST: `POST https://api.screed.dev/api/v1/event-subscriptions`.
- `list_event_subscriptions` — List visible event subscriptions without signing secrets. REST: `GET https://api.screed.dev/api/v1/event-subscriptions`.
- `unsubscribe_events` — Deactivate an event subscription. REST: `POST https://api.screed.dev/api/v1/event-subscriptions/:id/cancel`.
- `decide_request` — Approve or reject a request as its human decision maker. REST: `POST https://api.screed.dev/api/v1/documents/requests/:id/decision`.
- `decide_report` — Verify, book or reject a field report as yourself. REST: `POST https://api.screed.dev/api/v1/reports/:id/decision`.
- `approve_project_review` — Approve a draft project review as its human reviewer. REST: `POST https://api.screed.dev/api/v1/project-reviews/:id/approve`.
- `list_agent_actions` — List visible agent writes and their outcomes. REST: `GET https://api.screed.dev/api/v1/agent-actions`.
- `get_pending_change_order` — Read pending contract changes and their exact amount in cents. REST: `GET https://api.screed.dev/api/v1/estimates/:id/change-order`.
- `draft_change_order` — Draft additions, changes and removals without changing the contracted baseline. REST: `POST https://api.screed.dev/api/v1/estimates/:id/change-order/draft`.
- `propose_issue_change_order` — Ask a project manager to approve and issue pending contract changes. REST: `POST https://api.screed.dev/api/v1/estimates/:id/change-order/issue`; a person approves.
- `list_customer_invoices` — List customer invoices and company totals in cents. REST: `GET https://api.screed.dev/api/v1/customer-invoices`.
- `get_customer_invoice` — Read a customer invoice in cents with its issued-document link. REST: `GET https://api.screed.dev/api/v1/customer-invoices/:id`.
- `draft_customer_invoice` — Create a draft customer invoice with prices expressed in whole cents. REST: `POST https://api.screed.dev/api/v1/customer-invoices`.
- `propose_send_customer_invoice` — Ask a person to approve freezing and sending a draft customer invoice. REST: `POST https://api.screed.dev/api/v1/customer-invoices/:id/send`; a person approves.
- `propose_record_payment` — Ask a person to approve recording money received outside online payments. REST: `POST https://api.screed.dev/api/v1/customer-invoices/:id/payments`; a person approves.
- `get_proposal` — Read the latest proposal, signature request and acceptance. REST: `GET https://api.screed.dev/api/v1/estimates/:id/proposal`.
- `issue_proposal` — Issue the estimate’s proposal with its current scope and price. REST: `POST https://api.screed.dev/api/v1/documents/proposals/issue`.
- `propose_send_proposal` — Ask a person to send the proposal for signature. REST: `POST https://api.screed.dev/api/v1/estimates/:id/proposal/send`; a person approves.
- `price_proposal_scenario` — Price selected choices against an issued proposal in whole cents. REST: `GET https://api.screed.dev/api/v1/estimates/:id/scenario`.
- `get_proposal_scenario` — Read the live and latest issued proposal scenarios. REST: `GET https://api.screed.dev/api/v1/estimates/:id/proposal/scenario`.
- `list_scenario_requests` — List customer scenario requests and their frozen totals. REST: `GET https://api.screed.dev/api/v1/estimates/:id/scenario-requests`.
- `list_proposal_options` — Read the editable proposal option groups. REST: `GET https://api.screed.dev/api/v1/estimates/:id/options`.
- `read_proposal_options` — Read editable groups, live pricing and requests, preserving partial refusal messages. REST: `GET https://api.screed.dev/api/v1/estimates/:id/options/workspace`.
- `withdraw_proposal_scenario_request` — Withdraw an open requested set as an authorized company member. REST: `POST https://api.screed.dev/api/v1/proposal-scenario-requests/:requestId/withdraw`.
- `upsert_proposal_options` — Replace proposal option groups while preserving the service’s scope and plan checks. REST: `PUT https://api.screed.dev/api/v1/estimates/:id/options`.
- `create_proposal_explore_link` — Create a customer proposal exploration link as an authorized company member. REST: `POST https://api.screed.dev/api/v1/estimates/:id/proposal/explore-link`.
- `revoke_proposal_explore_link` — Revoke a proposal exploration link as an authorized company member. REST: `POST https://api.screed.dev/api/v1/proposal-explore-links/:linkId/revoke`.
- `propose_win` — Ask a person to win an estimate on its proposal or a customer’s requested set. REST: `POST https://api.screed.dev/api/v1/estimates/:id/win`; a person approves.
- `set_project_assignments` — Assign project managers and superintendents as an authorized company member. REST: `PUT https://api.screed.dev/api/v1/projects/:projectId/assignments`.
- `add_won_estimate_payment_schedule` — Attach the first payment schedule to the displayed won estimate version as an authorized member. REST: `PUT https://api.screed.dev/api/v1/estimates/:estimateId/billing-schedule`.
- `set_estimate_payment_schedule` — Save an estimate payment schedule or restore its company default with the estimate editing rules. REST: `PUT https://api.screed.dev/api/v1/estimates/:estimateId/payment-schedule`.
- `copy_proposal_signature_link` — Read an open proposal signature link and record that the authorized member copied it. REST: `POST https://api.screed.dev/api/v1/estimates/:estimateId/proposal-signature/link`.
- `withdraw_proposal_signature` — Withdraw an open proposal signature request as an authorized person with fresh two-step approval. REST: `POST https://api.screed.dev/api/v1/estimates/:estimateId/proposal-signature/withdraw`.
- `record_proposal_cancellation` — Record how and when a customer cancelled as an authorized person with fresh two-step approval. REST: `POST https://api.screed.dev/api/v1/estimates/:estimateId/proposal-signature/cancelled`.
- `preview_opening_position` — Reconcile one project's opening position and show the next billing and receiving positions, writing nothing. REST: `POST https://api.screed.dev/api/v1/project-opening-positions/preview`.
- `stage_opening_position` — Keep the exact opening position, by its payload hash, for a person with financial authority to review and commit. REST: `POST https://api.screed.dev/api/v1/project-opening-positions`.
- `get_opening_position` — Read a staged or committed opening position with its reconciliation, findings and status. REST: `GET https://api.screed.dev/api/v1/project-opening-positions/:submissionId`.
- `commit_opening_position` — Commit the reviewed revision; only a person with financial authority signed in to Screed can, so an API caller is refused. REST: `POST https://api.screed.dev/api/v1/project-opening-positions/:submissionId/commit`.
- `record_opening_payment` — Record money received after the cutoff against an opening receivable, without an invoice. REST: `POST https://api.screed.dev/api/v1/project-opening-positions/receivables/:id/payments`.
- `apply_opening_cash` — Apply the opening position's cash on account to a sent invoice on the same job; it records no payment. REST: `POST https://api.screed.dev/api/v1/customer-invoices/:id/opening-cash`.
- `reverse_opening_cash` — Take back opening cash applied to an invoice: it is on account again and the invoice owes it again. REST: `POST https://api.screed.dev/api/v1/project-opening-positions/cash-applications/:id/reverse`.
- `import_quickbooks_customers` — Preview or bring in QuickBooks customers as customers and their jobs as projects, keyed by QuickBooks id. REST: `POST https://api.screed.dev/api/v1/quickbooks/customers/import`.
- `draft_opening_position_from_quickbooks` — Replay a job’s QuickBooks invoices, payments and credits to its cutoff as opening-position receivables, and list what QuickBooks can’t supply. REST: `POST https://api.screed.dev/api/v1/quickbooks/opening-position-drafts`.
- `sync_ramp_bills` — Bring approved Ramp bills on mapped POs in as supplier invoices, and mark the ones Ramp paid as paid. REST: `POST https://api.screed.dev/api/v1/ramp/bills/sync`.
- `pull_quickbooks_open_purchase_orders` — Bring in every open job-tagged QuickBooks PO, however old, as drafts or into Needs linking. REST: `POST https://api.screed.dev/api/v1/quickbooks/purchase-orders/open/pull`.
- `get_migration` — Read the company's plan for moving onto Screed from QuickBooks and Ramp: its state, a next sentence saying what to do, and the items to resolve, 100 at a time. REST: `GET https://api.screed.dev/api/v1/migration`.
- `resolve_migration_item` — Answer, choose for or leave out one migration plan item at its version, with a note; a money answer cites an uploaded PDF and its page. REST: `POST https://api.screed.dev/api/v1/migration/items/:id/resolve`.