Item - GOBL

Item is used to describe a single product or service.

Schema ID

https://gobl.org/draft-0/org/item

Properties

Title	Property	Type	Description
UUID	`uuid`	string	Universally Unique Identifier.
Ref	`ref`	cbc.Code	Primary reference code that identifies this item. Additional codes can be provided in the ‘identities’ property.
Key	`key`	cbc.Key	Special key used to classify the item sometimes required by some regimes.
Name	`name`	string	Brief name of the item
Identities	`identities`	array of org.Identity	List of additional codes, IDs, or SKUs which can be used to identify the item. They should be agreed upon between supplier and customer.
Attributes	`attributes`	array of org.Attribute	Attributes describe named features or properties of the item, such as color or size.
Description	`description`	string	Detailed description of the item.
Images	`images`	array of org.Image	Images associated with the item.
Currency	`currency`	currency.Code	Currency used for the item’s price.
Price	`price`	num.Amount	Base price of a single unit to be sold. Must be either zero or positive.
Alternative Prices	`alt_prices`	array of currency.Amount	AltPrices defines a list of prices with their currencies that may be used as an alternative to the item’s base price.
Unit	`unit`	cbc.Key	Unit of measure using a GOBL key. Standard UN/ECE codes may be preserved in the untdid-unit extension.
Country of Origin	`origin`	l10n.ISOCountryCode	Country code of where this item was from originally.
Extensions	`ext`	tax.Extensions	Extension code map for any additional regime specific codes that may be required.
Meta	`meta`	cbc.Meta	Additional meta information that may be useful

Key Values

Value	Description
`goods`	Goods
`services`	Services

Unit Values

Value	Description
`mg`	Milligrams
`cg`	Centigrams
`g`	Metric grams
`kg`	Metric kilograms
`t`	Metric tons
`mm`	Millimetres
`cm`	Centimetres
`dm`	A unit of length equal to one-tenth of a metre.
`m`	Metres
`lm`	The running length in metres of a uniform-width product (e.g. carpet, fabric, cable), billed per metre regardless of width.
`km`	Kilometres
`in`	Inches
`ft`	Feet
`lft`	The running length in feet of a uniform-width product (e.g. lumber, trim, cable), billed per foot regardless of width.
`mm2`	Square millimetres
`cm2`	Square centimetres
`dm2`	Square decimetres
`m2`	Square metres
`ac`	A unit of area equal to 43,560 square feet.
`ha`	A unit of area equal to 10,000 square metres.
`mm3`	Cubic millimetres
`cm3`	Cubic centimetres
`dm3`	Cubic decimetres
`m3`	Cubic metres
`ml`	Millilitres
`cl`	Centilitres
`dl`	Decilitres
`l`	Litres
`kl`	Kilolitres
`w`	Watts
`kw`	Kilowatts
`kwh`	Kilowatt Hours
`kj`	Kilojoules
`kcal`	Kilocalories
`rate`	A unit of quantity expressed as a rate for usage of a facility or service.
`yr`	A unit of time equal to twelve months.
`mon`	Unit of time equal to 1/12 of a year of 365,25 days.
`wk`	A unit of time equal to seven days.
`day`	Days
`s`	Seconds
`h`	Hours
`min`	Minutes
`piece`	A unit of count defining the number of pieces (piece: a single item, article or exemplar).
`item`	A unit of count defining the number of items regarded as separate units.
`pair`	A unit of count defining the number of pairs (pair: item described by two’s).
`dozen`	A unit of count defining the number of units in multiples of 12.
`assortment`	A unit of count defining the number of assortments (assortment: a collection of items or components of a single product packaged together).
`service`	A unit of count defining the number of service units (service unit: defined period / property / facility / utility of supply).
`job`	A unit of count defining the number of jobs.
`activity`	A unit of count defining the number of activities (activity: a unit of work or action).
`trip`	A unit of count defining the number of trips (trip: a journey to a place and back again).
`group`	A unit of count defining the number of groups (group: set of items classified together).
`outfit`	A unit of count defining the number of outfits (outfit: a complete set of equipment / materials / objects used for a specific purpose).
`kit`	A unit of count defining the number of kits (kit: tub, barrel or pail).
`basebox`	A unit of area of 112 sheets of tin mil products (tin plate, tin free steel or black plate) 14 by 20 inches, or 31,360 square inches.
`pk`	A unit of count defining the number of items per bulk pack.
`one`	A single generic unit of a service or product.
`bag`	Bags
`box`	Boxes
`bin`	Bins
`can`	Cans
`tub`	Tubs
`case`	Cases
`tray`	Trays
`portion`	Portions
`set`	A unit of count defining the number of sets (set: a number of objects grouped together).
`roll`	Rolls
`carton`	Cartons
`cylinder`	Cylinders
`barrel`	Barrels
`jerrican`	Jerrican, cylindrical
`carboy`	Carboys
`demijohn`	Demijohns
`bottle`	Bottles
`canister`	Canisters
`pkg`	Standard packaging unit.
`pkt`	Packets
`bunch`	Bunches
`bdl`	Bundles
`blk`	Blocks
`pallet`	Pallets
`reel`	Reels
`sack`	Sacks
`sheet`	Sheets
`envelope`	Envelopes
`lot`	Lot
`unit`	A type of package composed of a single item or object, not otherwise specified as a unit of transport equipment.

Validation Rules

Field	Test	Validation Code / Message
`name`	Present	`GOBL-ORG-ITEM-01` Item name is required
`price`	Min 0	`GOBL-ORG-ITEM-02` Item price must be zero or positive
`attributes`	Attribute keys must be unique	`GOBL-ORG-ITEM-03` Item attributes must not contain duplicate keys
`unit`	One of [mg, cg, g, kg, t, mm, cm, dm, m, lm, km, in, ft, lft, mm2, cm2, dm2, m2, ac, ha, mm3, cm3, dm3, m3, ml, cl, dl, l, kl, w, kw, kwh, kj, kcal, rate, yr, mon, wk, day, s, h, min, piece, item, pair, dozen, assortment, service, job, activity, trip, group, outfit, kit, basebox, pk, one, bag, box, bin, can, tub, case, tray, portion, set, roll, carton, cylinder, barrel, jerrican, carboy, demijohn, bottle, canister, pkg, pkt, bunch, bdl, blk, pallet, reel, sack, sheet, envelope, lot, unit]	`GOBL-ORG-ITEM-04` Item unit must be valid