FUfulcrumpro
Sales Order Line Item

Get a specific line item for a sales order of generic type

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

Request

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

Path parameters

salesOrderIdstring required
lineItemIdstring required

Response

Line item

idstring required

Unique id associated to this entity.

lineItemIdstring nullable

The line item id (if applicable).

type'part' | 'shipping' | 'tax' | 'discount' | 'fee' | 'refund' required

Sales order line item type

pricenumber double required

The line item price.

discountedPricenumber double nullable

The line item discounted unit price (if applicable).

namestring nullable

Verbose name for this entity.

descriptionstring nullable

Line item description.

quantitynumber double

The line item quantity

externalReferencesobject nullable

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

accountingCodeIdstring nullable

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

isTaxableboolean required

Dictate if this line item is taxable.

subTotalnumber double required

Total line item cost, including applicable discounts

preDiscountSubTotalnumber double required

Total line item cost, before discounts

isPercentageDiscountboolean nullable

Indicates whether FulcrumProduct.PublicApi.Dto.SalesOrder.SalesOrderLineItemDto.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 sales order part line item;

numberinteger

Line number

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)

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