FUfulcrumpro
Quote Part Line Item

Update a specific part line item for a Quote

Changed on
put/api/quotes/{quoteId}/part-line-items/{lineItemId}

Request

  • Base URL
    https://api.fulcrumpro.com
  • URL
    https://api.fulcrumpro.com/api/quotes/{quoteId}/part-line-items/{lineItemId}
  • Auth
    none declared

Path parameters

quoteIdstring required
lineItemIdstring required

Request body

quantitynumber double

The line item quantity

pricenumber double nullable

The line item price. With pricingScheme set to price, the line takes this price, and keeps its current price when it is omitted (on create, the price the item gives the line). With pricingScheme set to margin, the price is derived from the line's margin and cost, and a non-zero price that differs from the line's current price (on create, any non-zero price) is rejected with a 400. Without pricingScheme, the line is priced under its current scheme: a margin-priced line derives its price from its margin, a line with quantity price breaks takes the price of the break that applies at its quantity, and any other line takes this price, or 0 when it is omitted.

pricingScheme'price' | 'margin'

How a part line item is priced; omit to keep the line's current scheme. price: the line keeps the price sent and its margin is derived from cost. On a line with quantity price breaks, the price replaces that of the break applying at the line's quantity (the highest break at or below it, else the lowest); the other breaks are kept. margin: the price is derived from the line's margin and cost. A non-zero price other than the line's current price (on create, any non-zero price) is rejected with a 400.

descriptionstring nullable

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

internalNotesstring nullable

The line item internal notes

itemNotesstring nullable

The line item notes.

isTaxableboolean nullable

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.QuotePartLineItemUpdateDto.TaxCodeId is provided, the provided FulcrumProduct.PublicApi.Dto.Quote.PartLineItem.QuotePartLineItemUpdateDto.TaxRate will supercede the defined tax rate.

overrideTaxRateboolean nullable

Indicate if the tax supplied is intended to be an override.

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.QuotePartLineItemUpdateDto.DiscountAmount discount is percentage based (else, it's an absolute amount).

discountAmountnumber double nullable

The amount of the discount.

accountingCodeIdstring nullable

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

leadTimeDaysinteger nullable

The line's lead time, as the days of an entry from GET /api/quotes/lead-times. Omit it, or send null, to keep the line's lead time; send 0 to remove it. Any other value is a 400.

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.

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

Changes

  • 369711e9060cRevision changes
    • info

      added the new optional request property (media type: application/json-patch+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: application/problem+json)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: application/problem+json)

  • 170091e03d2fRevision changes
    • info

      added the new optional request property (media type: application/json-patch+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)