FUfulcrumpro
Sales Order Part Line Item

Update a specific part line item for a sales order

Changed on
put/api/sales-orders/{salesOrderId}/part-line-items/{lineItemId}

Request

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

Path parameters

salesOrderIdstring required
lineItemIdstring required

Request body

quantitynumber double

The line item quantity

pricenumber double nullable

The line item price. Note, if a price break exists for the item being added (vendor price breaks, item price breaks, etc), this value will be ignored as it is quantity-driven based on the price breaks that do/will exist, unless pricingScheme is price. If this value is not provided and no price breaks exist, the default will be 0. With pricingScheme set to margin, a non-zero price that differs from the line's current price is rejected with a 400.

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.

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

overrideTaxRateboolean nullable

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

descriptionstring nullable

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

internalNotesstring nullable

The line item internal notes. Aka production notes.

itemNotesstring nullable

The line item notes (visible in job tracking).

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

discountAmountnumber double nullable

The amount of the discount.

deliveryDatestring date-time nullable

The Delivery Date for the line item. Only the calendar date is used, exactly as written; any time or UTC offset is ignored.

unitOfMeasureNamestring nullable

The unit of measure to apply. If left blank, the existing unit of measure on the line item will be retained.

accountingCodeIdstring nullable

Accounting code key identifier. Please reference /api/accounting-codes endpoint. If this value is not provided and the name matches a defined "default fee", the accounting code on the "default fee" will be used.

isCustomerItemboolean nullable

Determines whether or not to display the customer part number and customer part description.

customerPartNumberstring nullable

Used for the part number on customer facing documents when IsCustomerItem is true

customerPartDescriptionstring nullable

Used for the description on customer facing documents when IsCustomerItem is true

Response

Part line item

idstring required

Unique id associated to this entity.

namestring required

The line item name.

quantitynumber double required

The line item quantity

pricenumber double required

The line item price.

discountedPricenumber double required

The discounted line item price.

dueDatestring date-time nullable

Customer delivery date

isTaxableboolean required

Dictate if this line item is taxable.

overrideTaxRateboolean nullable

Dictate if the tax rate is overridden.

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

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 item internal notes. Aka production notes.

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

discountAmountnumber double nullable

The amount of the discount.

customFieldsobject nullable

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

parentLineIdstring nullable

Identifier pointing to the parent line item (if this part line was sourced from a blanket line item). Please reference /api/sales-order/{salesOrderId}/blanket-line-items/list endpoint.

subTotalnumber double required

Total line item cost, including applicable discounts

preDiscountSubTotalnumber double required

Total line item cost, before discounts

customerPartNumberstring nullable

The customer's known part line item number.

customerPartDescriptionstring nullable

The customer's known part line item description.

numberinteger

Line number

isFullyInvoicedboolean

Indicate if this item has been fully invoiced.

isInvoicedboolean

Indicate if this item has ANY invoices.

quantityInvoicednumber double nullable

Indicate the total quantity that have been invoiced (issued/paid).

quantityOnInvoicesnumber double nullable

Indicate the total quantity that exists on any invoice (including open).

Changes

  • efbedf8e5e19Revision 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)

  • 6fc46fb4f45bRevision changes
    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json)

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status (media type: application/problem+json)

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json)

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status (media type: application/problem+json)

    • warning

      added the new overhead enum value to the /// response property for the response status (media type: application/json)

    • warning

      added the new overhead enum value to the /// response property for the response status (media type: application/problem+json)

    • warning

      added the new unknown enum value to the /// response property for the response status (media type: application/json)

    • warning

      added the new unknown enum value to the /// response property for the response status (media type: application/problem+json)

    • info

      the request property's minLength was decreased from 1 to 0 (media type: application/json-patch+json)

    • info

      the request property's minLength was decreased from 1 to 0 (media type: application/json)

    • info

      the request property's minLength was decreased from 1 to 0 (media type: text/json)

    • info

      the request property's minLength was decreased from 1 to 0 (media type: application/*+json)

    • info

      the request property's minLength was decreased from 1 to 0 (media type: application/json-patch+json)

    • info

      the request property's minLength was decreased from 1 to 0 (media type: application/json)

    • info

      the request property's minLength was decreased from 1 to 0 (media type: text/json)

    • info

      the request property's minLength was decreased from 1 to 0 (media type: application/*+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)