Sign in
Sales Order Discount Line Item

Update the discount line item for a sales order

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

Path parameters

salesOrderIdstring required

Request body

namestring required

The name of the discount line.

descriptionstring nullable

The description of the discount line.

isPercentageboolean required

Indicates whether "Amount" value is percentage based or 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.

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

No recorded changes to this endpoint across all 23 revisions of this API.