FUfulcrumpro
Sales Order Discount Line Item

Get the discount line item for a sales order

Changed on
get/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

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

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

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

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

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