FUfulcrumpro
Sales Order Discount Line Item

Partially update the external references of the discount line item for a sales order

Changed on

Every operation must have a path at or beneath /externalReferences; the line's other members are left as they are. A reference the patch keeps also keeps the members this API does not expose.

patch/api/sales-orders/{salesOrderId}/discount-line-item

Request

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

Path parameters

salesOrderIdstring required

Request body

opstring
valueunknown
pathstring
fromstring

Source path — present for move/copy operations, absent otherwise.

Response

Discount line item

idstring required

Unique id associated to this entity.

namestring required

The name of the discount line.

descriptionstring nullable

The name of the discount line.

isPercentageboolean required

Indicates whether FulcrumProduct.PublicApi.Dto.SalesOrder.DiscountLineItem.DiscountLineItemDto.Amount discount is percentage based (else, it's an absolute amount).

amountnumber double required

The amount of the discount.

externalReferencesobject nullable

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

absoluteAmountnumber double nullable

The absolute amount of the discount.

numberinteger

Line number

pricenumber double nullable

The calculated amount of this discount.

Changes