v2

latestOpenAPI 3.0.42026-08-084694591.6 MB
Sales Order Part Line Item

Create a part line item on a sales order

post/api/sales-orders/{salesOrderId}/part-line-items

Path parameters

salesOrderIdstring required

Request body

itemIdstring required

Item id associated with this line item.

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. If this value is not provided and no price breaks exist, the default will be 0.

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.PartLineItemCreateDto.TaxCodeId is provided, the provided FulcrumProduct.PublicApi.Dto.SalesOrder.PartLineItem.PartLineItemCreateDto.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

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.PartLineItemCreateDto.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 default unit of measure for the item will be applied.

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 added to sales order

idstring required

The id of the created record