Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vh3.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Quotes

BigChange quotes and line items. Auth: X-API-Key header. Base: https://api.vh3connect.io/api:YdihQNr3.

​
Shared parameters

ParamTypeDescription
pageNumberintegerPage index (1-based)
pageSizeintegerItems per page (default 100, max 1000)
sortBystringSort field (endpoint-specific)
directionenumascending or descending

​
Date filters (list)

POST /quotes/list supports the same creation-date window as invoices: createdAtFrom and createdAtTo (ISO 8601 UTC). The range must not exceed 12 months. See overview.
ParamTypeRequiredDescription
createdAtFromstringNoQuotes created on or after this instant
createdAtTostringNoQuotes created on or before this instant
Optional filters: id, jobId, jobGroupId, contactId, reference (comma-separated, max 50 each).

​
Quotes

Quotations.

​
GET /quotes/quote

Get quote. 
curl -G "https://api.vh3connect.io/api:YdihQNr3/quotes/quote" \
  -H "X-API-Key: your-api-key" \
  --data-urlencode "quoteId=3001"

​
POST /quotes/create

Create quote. 
curl -X POST "https://api.vh3connect.io/api:YdihQNr3/quotes/create" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
  "contactId": 12345
}'

​
POST /quotes/edit

Update quote. 
curl -X POST "https://api.vh3connect.io/api:YdihQNr3/quotes/edit" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
  "quoteId": 3001
}'

​
POST /quotes/list

List quotes with optional filters and creation-date range (max 12 months between createdAtFrom and createdAtTo). Request body (filters):
FieldTypeRequiredDescription
pageNumberintegerNoPage index (1-based)
pageSizeintegerNoItems per page
createdAtFromstringNoCreated on or after (ISO 8601 UTC)
createdAtTostringNoCreated on or before (ISO 8601 UTC)
contactIdstringNoContact IDs (comma-separated, max 50)
jobIdstringNoJob IDs (comma-separated, max 50)
jobGroupIdstringNoJob group IDs (comma-separated, max 50)
idstringNoQuote IDs (comma-separated, max 50)
referencestringNoReferences (comma-separated, max 50)
sortBystringNoTypically createdAt
directionenumNoascending or descending
curl -X POST "https://api.vh3connect.io/api:YdihQNr3/quotes/list" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
  "pageNumber": 1,
  "pageSize": 50,
  "createdAtFrom": "2026-01-01T00:00:00Z",
  "createdAtTo": "2026-06-30T23:59:59Z",
  "contactId": "12345",
  "sortBy": "createdAt",
  "direction": "descending"
}'

​
POST /quotes/mark_sent

Mark sent. 
curl -X POST "https://api.vh3connect.io/api:YdihQNr3/quotes/mark_sent" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
  "quoteId": 3001
}'

​
POST /quotes/mark_accepted

Mark accepted. 
curl -X POST "https://api.vh3connect.io/api:YdihQNr3/quotes/mark_accepted" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
  "quoteId": 3001
}'

​
POST /quotes/mark_rejected

Mark rejected. 
curl -X POST "https://api.vh3connect.io/api:YdihQNr3/quotes/mark_rejected" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
  "quoteId": 3001
}'

​
Quote line items

Quote lines.

​
GET /quotes/line_item

Get line. 
curl -G "https://api.vh3connect.io/api:YdihQNr3/quotes/line_item" \
  -H "X-API-Key: your-api-key" \
  --data-urlencode "quoteId=3001" \
  --data-urlencode "lineItemId=1"

​
POST /quotes/line_item/create

Create line. 
curl -X POST "https://api.vh3connect.io/api:YdihQNr3/quotes/line_item/create" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
  "quoteId": 3001,
  "description": "Boiler service",
  "quantity": 1
}'

​
POST /quotes/line_item/edit

Update line. 
curl -X POST "https://api.vh3connect.io/api:YdihQNr3/quotes/line_item/edit" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
  "quoteId": 3001,
  "lineItemId": 1
}'

​
POST /quotes/line_item/delete

Delete line. 
curl -X POST "https://api.vh3connect.io/api:YdihQNr3/quotes/line_item/delete" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
  "quoteId": 3001,
  "lineItemId": 1
}'

​
POST /quotes/line_item/list

List lines. 
curl -X POST "https://api.vh3connect.io/api:YdihQNr3/quotes/line_item/list" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
  "quoteId": 3001,
  "pageNumber": 1,
  "pageSize": 50
}'