FUfulcrumpro
Sales Order Part Line Item

Get a list of part lines items for a sales order

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

Request

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

Path parameters

salesOrderIdstring required

Query parameters

includeCostBreakdownboolean

Response

List of part line items for the given sales order id

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

  • 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

      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)

  • 68a3cf300a5dRevision changes
    • 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)