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
- Development
- Production
http://localhost:5001/api
https://bids.precisionsiteservices.com/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 nameclientId- Customer referencestatus- Lifecycle state (DRAFT, SUBMITTED, AWARDED, etc.)equipmentBiddingMode- TRADITIONAL or GANTT- Cost totals for each module
Scopes
Work breakdown structure within a bid (e.g., "Foundation", "Grade Beam").
Key Fields:
name- Scope nametypeId- Scope type (Slab, Pier, Wall, etc.)multiplier- Cost scaling factor for repeated scopesparentScopeId- Optional parent for hierarchy- Module cost totals
Estimation Modules
Six specialized modules for different cost types:
- Concrete - Cubic yards, rebar, mix designs
- Labor - Crew sizing, hourly rates, soft costs
- Equipment - Rentals, fuel, delivery
- Materials - Line items with waste factors
- Subcontractors - External services (pumps, drilling, etc.)
- Miscellaneous - General costs
Estimation Workflow
Initialize bid with client, job name, and overhead/profit percentages
Define work breakdown structure (foundation, beams, slabs, etc.)
Add concrete, labor, equipment, materials, subcontractor, and misc items to each scope
Automatic cost rollup calculates scope and bid totals with markups
Generate PDF, Excel, or PM tracking spreadsheet
Cost Calculation Flow
Authentication
All Bids Service endpoints require SuperTokens session authentication:
Cookie: sAccessToken=...; sRefreshToken=...
Role-Based Access
| Role | Permissions |
|---|---|
| ADMIN | Full access (create, edit, delete, manage users) |
| ESTIMATOR | Create and edit bids (no delete) |
| PM | Read-only access to bids |
Quick Start
- Create Bid
- List Bids
- Export PDF
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
}'
curl https://bids.precisionsiteservices.com/api/bids \
-H "Cookie: sAccessToken=...; sRefreshToken=..."
curl https://bids.precisionsiteservices.com/api/bids/{id}/pdf \
-H "Cookie: sAccessToken=...; sRefreshToken=..." \
--output bid.pdf
API Sections
Clients
Customer management
Bids
Bid CRUD operations
Scopes
Work breakdown structure
Concrete
Concrete & rebar estimation
Labor
Crew sizing & labor costs
Equipment
Equipment rentals & fuel
Materials
Material line items
Subcontractors
External services
Miscellaneous
General costs
Pricing
Pricing catalog
Variables
Global variables & rates
Calculations
Cost rollup logic
Common Query Parameters
Most list endpoints support:
| Parameter | Type | Description |
|---|---|---|
limit | number | Results per page (default: 50) |
offset | number | Pagination offset (default: 0) |
search | string | Search by name or description |
status | string | Filter by status |
sortBy | string | Sort field (e.g., "createdAt") |
order | string | Sort direction ("asc" or "desc") |
Error Handling
See API Overview for standard error formats.