Skip to content

Latest commit

 

History

History
44 lines (37 loc) · 5.17 KB

OrderLineItem.md

File metadata and controls

44 lines (37 loc) · 5.17 KB
Raw

MissionControl.OrderLineItem

Properties

Name Type Description Notes
id String
createdAt Date
updatedAt Date
references [String] The the first reference of this order line item is generated by the system that created it. The references are supposed to be used in customer/human related communication. It is not a technical ID.
kind String Line Items can represent multiple types of concepts within the basket. Fundamentally these represent the different types of chargeable parts of an order (job/service/shipping etc) but if relevant there could be extra concepts added using the 'unknown' value.
jobId String The UUID of the job, when the `kind` attribute is set to `product` otherwise blank
description String A description of this line item that explains it's contents to buyer of this order. Description must be omitted if the `kind` attribute is set to `product` or `shipping` otherwise a description is required.
quantity Number The orderd amount of this line item, given in the unit specified in the `unit` attribute.
unit String The unit in which the ordered amount of this line item is measured. Can be omitted if the line item is not provided in a measureable quantity. In that case the `unit` attribute must be set to 1 (which is the default).
netPrice Number The net price of a single unit (!) of this line item without taxes in the sub-unit of the currency selected for the order (i.e. cents for USD/EUR). This is not the total net price for the entire amount of the line item, but the price for one single unit, so if somebody ordered 100 pieces, this is the price for 1 piece. Mission Control will not change or check if the prices between `net_price`, `net_total_price`, `gross_price` and `gross_total_price` match up, so if you use a higher precision internally for rounding any of the prices that is fine.
grossPrice Number The total price of a single unit (!) of this line item with value added tax in the sub-unit of the currency selected for the order (i.e. cents for USD/EUR). If the order is made in a jurisdiction using sales tax instead of value added tax, this value should equal the value in `net_price`. Mission Control will not change or check if the prices between `net_price`, `net_total_price`, `gross_price` and `gross_total_price` match up, so if you use a higher precision internally for rounding any of the prices that is fine.
taxRate String The value-added tax (VAT) rate that is applied to this line item as a percentage. The percentage is represented as a decimal between 0 and 1, so a 19% tax rate would be `0.19`. For jurisdictions that use sales taxes instead of VAT leave this field blank.
netTotalPrice Number The total price of this line item without taxes in the sub-unit of the currency selected for the order (i.e. cents for USD/EUR). This is the price for the entire amount, so if somebody ordered 100 pieces of this line item, this is the price for all of those 100 pieces. Mission Control will not change or check if the prices between `net_price`, `net_total_price`, `gross_price` and `gross_total_price` match up, so if you use a higher precision internally for rounding any of the prices that is fine.
grossTotalPrice Number The total price of a single unit (!) of this line item with value added tax in the sub-unit of the currency selected for the order (i.e. cents for USD/EUR). If the order is made in a jurisdiction using sales tax instead of value added tax, this value should equal the value in `net_price`. Mission Control will not change or check if the prices between `net_price`, `net_total_price`, `gross_price` and `gross_total_price` match up, so if you use a higher precision internally for rounding any of the prices that is fine.
taxes Number The amount of value added tax due for the total of this line item in the sub-unit of the currency selected for the order (i.e. cents for USD/EUR). For jurisdictions that use value-added tax this attribute must be left blank. Mission Control will not change or check if the prices between `net_price`, `net_total_price`, `gross_price` and `gross_total_price` match up, so if you use a higher precision internally for rounding any of the prices that is fine.

Enum: KindEnum

  • product (value: "product")
  • service (value: "service")
  • shipping (value: "shipping")
  • logistics (value: "logistics")
  • unknown (value: "unknown")

Enum: UnitEnum

  • box (value: "box")
  • cm (value: "cm")
  • hour (value: "hour")
  • kg (value: "kg")
  • meter (value: "meter")
  • minute (value: "minute")
  • mm (value: "mm")
  • pallet (value: "pallet")
  • piece (value: "piece")