Skip to main content

Interface: TenderMainItem

Defined in: type/TenderMainItem.ts:9

Object class for TenderMainItem

Extends​

Properties​

attributedSaleDiscount​

attributedSaleDiscount: number

Defined in: type/TenderMainItem.ts:55

Extra item discount (%) calculated based on tender/order total discount

attributedSaleDiscountSum​

attributedSaleDiscountSum: number

Defined in: type/TenderMainItem.ts:106

Extra item discount (%) calculated based on tender/order total discount. Includes item specific incentives and extra costs

attributedSaleMargin​

attributedSaleMargin: number

Defined in: type/TenderMainItem.ts:57

Margin percentage calculated based on tender/order total discount

attributedSaleMarginSum​

attributedSaleMarginSum: number

Defined in: type/TenderMainItem.ts:108

Margin percentage calculated based on tender/order total discount. Includes item specific incentives and extra costs

childItems?​

optional childItems?: ITenderBaseItem[]

Defined in: type/TenderMainItem.ts:77

The tender/order item's child items. E.g. surcharges, incentives, etc.

costPrice​

costPrice: number

Defined in: type/TenderMainItem.ts:61

Product cost price per UOM of this tender/order item. VAT excluding

customerDiscountPercentage​

customerDiscountPercentage: number

Defined in: type/TenderMainItem.ts:41

Customer discount (%)

customerPrice​

customerPrice: number

Defined in: type/TenderMainItem.ts:63

Customer special price per UOM of this tender/order item. VAT excluding

discountPercentage​

discountPercentage: number

Defined in: type/TenderMainItem.ts:43

Sales discount (%)

discountPercentageSum​

discountPercentageSum: number

Defined in: type/TenderMainItem.ts:98

Sales discount (%). Includes item specific incentives and extra costs

expectedDeliveryDate?​

optional expectedDeliveryDate?: string

Defined in: type/TenderMainItem.ts:67

The preferred delivery date for this order as requested by the user

externalOrderitemId?​

optional externalOrderitemId?: string

Defined in: type/TenderMainItem.ts:69

The order item's ID in an external system

incentive?​

optional incentive?: TenderItemIncentive

Defined in: type/TenderMainItem.ts:73

incentive field

marginAmount​

marginAmount: number

Defined in: type/TenderMainItem.ts:47

Default margin amount (list price). VAT excluding

marginPercentage​

marginPercentage: number

Defined in: type/TenderMainItem.ts:49

Default margin percentage (list price)

name​

name: string

Defined in: type/TenderMainItem.ts:19

Tender/order item name

notes?​

optional notes?: string

Defined in: type/TenderMainItem.ts:71

User notes on tender item level

orderItemId?​

optional orderItemId?: number

Defined in: type/TenderMainItem.ts:17

Id of the order item

originalPrice​

originalPrice: number

Defined in: type/TenderMainItem.ts:59

Product list price per UOM of this tender/order item. VAT excluding

price​

price: number

Defined in: type/TenderMainItem.ts:29

The gross sales price per UOM of this tender/order item, no item specific incentives and extra costs are applied to this price. VAT excluding

Overrides​

ITenderBaseItem.price

priceNet​

priceNet: number

Defined in: type/TenderMainItem.ts:31

The sales price per UOM of this tender/order item, no item specific incentives and extra costs are applied to this price. VAT including

product?​

optional product?: Product

Defined in: type/TenderMainItem.ts:13

product field

productId?​

optional productId?: number

Defined in: type/TenderMainItem.ts:11

The tender/order item's productId, if applicable

Overrides​

ITenderBaseItem.productId

quantity​

quantity: number

Defined in: type/TenderMainItem.ts:23

The quantity for this tender/order item

Overrides​

ITenderBaseItem.quantity

saleMarginAmount​

saleMarginAmount: number

Defined in: type/TenderMainItem.ts:51

Margin amount. VAT excluding

saleMarginAmountSum​

saleMarginAmountSum: number

Defined in: type/TenderMainItem.ts:102

Margin amount. Includes item specific incentives and extra costs. VAT excluding

saleMarginPercentage​

saleMarginPercentage: number

Defined in: type/TenderMainItem.ts:53

Margin percentage

saleMarginPercentageSum​

saleMarginPercentageSum: number

Defined in: type/TenderMainItem.ts:104

Margin percentage. Includes item specific incentives and extra costs

sku​

sku: string

Defined in: type/TenderMainItem.ts:21

Tender/order item SKU

sum​

sum: number

Defined in: type/TenderMainItem.ts:87

PER UOM, not the line total — despite the name. The gross price for ONE unit of this tender/order item, with item specific incentives and extra costs applied. VAT EXCLUDING (this API labels the ex-VAT figure "gross").

For the line total use totalSum. Summing sum across the items under-reports every line by a factor of its quantity, and does it silently: the result is a plausible number and the types are green (PWP-1006).

sumNet​

sumNet: number

Defined in: type/TenderMainItem.ts:92

PER UOM, not the line total — see sum. VAT INCLUDING. For the line total use totalSumNet.

supplier?​

optional supplier?: string

Defined in: type/TenderMainItem.ts:25

Tender/order item supplier

supplierCode?​

optional supplierCode?: string

Defined in: type/TenderMainItem.ts:27

Tender/order item supplier code

surcharges?​

optional surcharges?: TenderItemSurcharge[]

Defined in: type/TenderMainItem.ts:75

surcharges field

taxCode​

taxCode: TaxCode

Defined in: type/TenderMainItem.ts:37

The tax code for this tender/order item

taxPercentage​

taxPercentage: number

Defined in: type/TenderMainItem.ts:39

The tax percentage for this tender/order item

totalDiscountPercentage​

totalDiscountPercentage: number

Defined in: type/TenderMainItem.ts:45

Total discount (%)

totalDiscountPercentageSum​

totalDiscountPercentageSum: number

Defined in: type/TenderMainItem.ts:100

Total discount (%). Includes item specific incentives and extra costs

totalPrice​

totalPrice: number

Defined in: type/TenderMainItem.ts:33

The total gross price of this tender/order item, no item specific incentives and extra costs are applied to this price. VAT excluding

totalPriceNet​

totalPriceNet: number

Defined in: type/TenderMainItem.ts:35

The total price of this tender/order item, no item specific incentives and extra costs are applied to this price. VAT including

totalSum​

totalSum: number

Defined in: type/TenderMainItem.ts:94

The total gross price of this tender/order item, with item specific incentives and extra costs applied to this price. VAT excluding

totalSumNet​

totalSumNet: number

Defined in: type/TenderMainItem.ts:96

The total price of this tender/order item, with item specific incentives and extra costs applied to this price. VAT including

uuid​

uuid: string

Defined in: type/TenderMainItem.ts:15

Id of the tender item, this id can be used for update or delete mutation for this tender item

Overrides​

ITenderBaseItem.uuid

valuePoints?​

optional valuePoints?: number

Defined in: type/TenderMainItem.ts:65

Total amount of valuePoints that apply to this tender/order item