Quote Line

The quote line resource.

Base/quoteLine

GET/quoteLine

List quote lines

Retrieve a paginated list of quote lines. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GET/quoteLine

curl --request GET \
  --url '<your-host>/quoteLine?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "quoteId": "xyz789",
    "quoteRevisionId": 0,
    "status": "string",
    "itemId": "xyz789",
    "itemType": "string",
    "description": "string",
    "methodType": "string"
  }
]

GET/quoteLine

Retrieve a quote line

Fetch a single quote line by filtering on `id`.

Query parameters

idstring

Match on the quote line's `id`, e.g. `eq.{id}`.

GET/quoteLine

curl --request GET \
  --url '<your-host>/quoteLine?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "quoteId": "xyz789",
  "quoteRevisionId": 0,
  "status": "string",
  "itemId": "xyz789",
  "itemType": "string",
  "description": "string",
  "methodType": "string"
}

POST/quoteLine

Create a quote line

Create a new quote line.

Body parameters

quoteIdstringrequired

quoteRevisionIdnumberrequired

statusquoteLineStatusrequired

estimatorIdstring

References user.id

itemIdstringrequired

itemTypestringrequired

descriptionstringrequired

customerPartIdstring

customerPartRevisionstring

methodTypemethodTyperequired

unitOfMeasureCodestring

internalNotesobject

companyIdstringrequired

References company.id

customFieldsobject

quantityarray

additionalChargesobject

locationIdstring

References location.id

noQuoteReasonstring

taxPercentnumberrequired

tagsarray

unitPricePrecisionnumberrequired

externalNotesobject

configurationobject

pricingRuleIdstring

References pricingRule.id

priceTraceobject

sortOrdernumberrequired

POST/quoteLine

curl --request POST \
  --url <your-host>/quoteLine \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"quoteId":"xyz789","quoteRevisionId":0,"status":"string","itemId":"xyz789","itemType":"string","description":"string","methodType":"string","companyId":"xyz789","taxPercent":0,"unitPricePrecision":0,"sortOrder":0}'

Response

{
  "id": "abc123def456",
  "quoteId": "xyz789",
  "quoteRevisionId": 0,
  "status": "string",
  "itemId": "xyz789",
  "itemType": "string",
  "description": "string",
  "methodType": "string"
}

PATCH/quoteLine

Update a quote line

Update an existing quote line, matched on `id`.

Body parameters

quoteIdstringrequired

quoteRevisionIdnumberrequired

statusquoteLineStatusrequired

estimatorIdstring

References user.id

itemIdstringrequired

itemTypestringrequired

descriptionstringrequired

customerPartIdstring

customerPartRevisionstring

methodTypemethodTyperequired

unitOfMeasureCodestring

internalNotesobject

companyIdstringrequired

References company.id

customFieldsobject

quantityarray

additionalChargesobject

locationIdstring

References location.id

noQuoteReasonstring

taxPercentnumberrequired

tagsarray

unitPricePrecisionnumberrequired

externalNotesobject

configurationobject

pricingRuleIdstring

References pricingRule.id

priceTraceobject

sortOrdernumberrequired

PATCH/quoteLine

curl --request PATCH \
  --url '<your-host>/quoteLine?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"quoteId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "quoteId": "xyz789",
  "quoteRevisionId": 0,
  "status": "string",
  "itemId": "xyz789",
  "itemType": "string",
  "description": "string",
  "methodType": "string"
}

DELETE/quoteLine

Delete a quote line

Delete a quote line, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the quote line to delete, e.g. `eq.{id}`.

DELETE/quoteLine

curl --request DELETE \
  --url '<your-host>/quoteLine?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content