Skip to main content

Bids Service

Overview

The Bids Service is the core estimation engine for ForgeX. It provides a complete solution for creating, managing, and tracking construction bids with detailed cost breakdowns.

Base URL

http://localhost:5001/api

Key Features

🧮

Multi-Module Estimation

Concrete, labor, equipment, materials, subcontractors, and miscellaneous items

📈

Automatic Cost Rollup

Real-time calculation from items → scopes → bids with markup application

🔗

Bid Sharing

Generate share codes for collaboration and bid import

🚚

Equipment Bidding Modes

Traditional (scope-based) and Gantt (timeline-based) modes

📄

PDF/Excel Export

Generate professional exports in multiple formats

📚

Scope Hierarchy

Parent-child scope relationships with inheritance

Core Entities

Bids

Top-level entity representing a complete construction estimate.

Key Fields:

  • bidNumber - Unique identifier (user-defined)
  • jobName - Project name
  • clientId - Customer reference
  • status - Lifecycle state (DRAFT, SUBMITTED, AWARDED, etc.)
  • equipmentBiddingMode - TRADITIONAL or GANTT
  • Cost totals for each module

View Bid Endpoints →

Scopes

Work breakdown structure within a bid (e.g., "Foundation", "Grade Beam").

Key Fields:

  • name - Scope name
  • typeId - Scope type (Slab, Pier, Wall, etc.)
  • multiplier - Cost scaling factor for repeated scopes
  • parentScopeId - Optional parent for hierarchy
  • Module cost totals

View Scope Endpoints →

Estimation Modules

Six specialized modules for different cost types:

  1. Concrete - Cubic yards, rebar, mix designs
  2. Labor - Crew sizing, hourly rates, soft costs
  3. Equipment - Rentals, fuel, delivery
  4. Materials - Line items with waste factors
  5. Subcontractors - External services (pumps, drilling, etc.)
  6. Miscellaneous - General costs

Estimation Workflow

1
Create Bid

Initialize bid with client, job name, and overhead/profit percentages

2
Add Scopes

Define work breakdown structure (foundation, beams, slabs, etc.)

3
Estimate Items

Add concrete, labor, equipment, materials, subcontractor, and misc items to each scope

4
Review Totals

Automatic cost rollup calculates scope and bid totals with markups

5
Export

Generate PDF, Excel, or PM tracking spreadsheet

Cost Calculation Flow

🔍 Click diagram to expand

View Cost Rollup Details →

Authentication

All Bids Service endpoints require SuperTokens session authentication:

Cookie: sAccessToken=...; sRefreshToken=...

Role-Based Access

RolePermissions
ADMINFull access (create, edit, delete, manage users)
ESTIMATORCreate and edit bids (no delete)
PMRead-only access to bids

Quick Start

curl -X POST https://bids.precisionsiteservices.com/api/bids \
-H "Cookie: sAccessToken=...; sRefreshToken=..." \
-H "Content-Type: application/json" \
-d '{
"bidNumber": "BID-2025-001",
"name": "Shopping Center Foundation",
"clientId": "uuid",
"overheadPercentage": 10,
"profitPercentage": 15
}'

API Sections

Common Query Parameters

Most list endpoints support:

ParameterTypeDescription
limitnumberResults per page (default: 50)
offsetnumberPagination offset (default: 0)
searchstringSearch by name or description
statusstringFilter by status
sortBystringSort field (e.g., "createdAt")
orderstringSort direction ("asc" or "desc")

Error Handling

See API Overview for standard error formats.