FUfulcrumpro
Quote Part Line Item

Partially updates the notes of a specific part line item for a Quote

Changed on

Supported paths: /itemNotes and /internalNotes, with the add, replace and remove operations. A value sets the note; null, a blank string or remove clears it; a path the patch does not name is kept, an untouched item note being reconciled with the line's BOM copy as the update does. The line's price, cost, margin, discount, pricing scheme and quantity are not changed.

patch/api/quotes/{quoteId}/part-line-items/{lineItemId}

Request

  • Base URL
    https://api.fulcrumpro.com
  • Auth
    none declared

Path parameters

quoteIdstring required
lineItemIdstring required

Request body

opstring
valueunknown
pathstring
fromstring

Source path — present for move/copy operations, absent otherwise.

Response

Part line item

idstring required

Unique id associated to this entity.

quantitynumber double required

The line item quantity

pricenumber double required

The line item price.

discountedPricenumber double required

The discounted line item price.

itemIdstring required

Item id associated with this line item.

descriptionstring nullable

The part line item description. Defaults to the item's description if none specified.

accountingCodeIdstring nullable

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

internalNotesstring nullable

The line's internal notes, aka production notes, as stored. Create stores the value sent; update stores it when it is not empty and otherwise keeps the stored notes, so an update cannot clear them.

itemNotesstring nullable

The line's own stored item notes. Create and update store the value sent; when it is omitted, empty or whitespace they store the line's effective notes instead — its own, else its BOM snapshot's — so an update cannot clear them. A line whose own notes were never stored reads null even when its BOM snapshot carries notes.

isTaxableboolean required

Dictate if this line item is taxable.

taxCodeIdstring nullable

Tax code key identifier. Please reference /api/tax-rates endpoint.

taxRatenumber double nullable

Tax rate to use for this entity. If a FulcrumProduct.PublicApi.Dto.Quote.PartLineItem.QuotePartLineItemDto.TaxCodeId is provided, the provided FulcrumProduct.PublicApi.Dto.Quote.PartLineItem.QuotePartLineItemDto.TaxRate will supercede the defined tax rate.

overrideTaxRateboolean nullable

Dictate if the tax rate is overridden.

externalReferencesobject nullable

Arbitrary key-value-pair like data that can be used to later on search for this line item.

isPercentageDiscountboolean nullable

Indicates whether FulcrumProduct.PublicApi.Dto.Quote.PartLineItem.QuotePartLineItemDto.DiscountAmount discount is percentage based (else, it's an absolute amount).

discountAmountnumber double nullable

The amount of the discount.

subTotalnumber double required

Total line item cost, including applicable discounts

preDiscountSubTotalnumber double required

Total line item cost, before discounts

customFieldsobject nullable

Custom fields that have been defined for the part line item;

numberinteger

Line number

pricingScheme'price' | 'margin' | 'defaultMargin' | 'shopRate' | 'timeAndMaterials' required

How a part line item, or an item by default, is priced. price: the price is set directly and the margin is derived from cost. margin: the price is derived from a margin and cost. defaultMargin: the price is derived from the company's default margin and cost. shopRate: the price is derived from shop rates and material markups. timeAndMaterials: the price is derived from estimated hours and material cost.

priceSource'item' | 'operation' | 'custom'

Where a part line item's price came from. item: the item's sales price breaks. operation: the routing's operations. custom: a price entered for the line.

Changes