Attribute - GOBL

Attribute describes a named feature or property of the parent object, such as the color or size of an item.

Schema ID

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

Properties

Title	Property	Type	Description
Label	`label`	string	Label for the attribute, used for presentation in converted outputs such as PDFs, and may identify the attribute when no key or type is set.
Key	`key`	cbc.Key	Key that identifies the attribute, either from the list pre-defined by GOBL or an alternative agreed upon between the supplier and customer.
Type	`type`	cbc.Code	Type defines a code used to identify the attribute when the “key” field is empty, from a code list agreed upon between the supplier and customer.
Text	`text`	string	Text value of the attribute.
Code	`code`	cbc.Code	Code value of the attribute, used as an alternative to text when the value comes from a code list agreed upon between the supplier and customer.
Amount	`amount`	num.Amount	Amount used when the attribute represents a numeric or measurable value.
Unit	`unit`	cbc.Key	Unit of measure that accompanies the amount.
Date	`date`	cal.Date	Date value of the attribute.
Extensions	`ext`	tax.Extensions	Extension code map for any additional regime specific codes that may be required, such as the standard unit code behind the attribute’s unit.

Key Values

Value	Description
`color`	Color of the item, either as a name or a code such as RAL or Pantone.
`size`	Size of the item, such as a clothing size.
`material`	Main material the item is made of, such as cotton or steel.
`length`	Length of the item itself, excluding packaging, usually as an amount with a unit of measure.
`width`	Width of the item itself, excluding packaging, usually as an amount with a unit of measure.
`height`	Height of the item itself, excluding packaging, usually as an amount with a unit of measure.
`diameter`	Diameter of the item itself, excluding packaging, usually as an amount with a unit of measure.
`weight`	Weight of a single unit of the item itself, excluding packaging, usually as an amount with a unit of measure.
`volume`	Volume of a single unit of the item itself, excluding packaging, usually as an amount with a unit of measure.
`production`	Date the item was produced or manufactured.
`expiry`	Date the item expires or is best consumed before.
`nutrition+energy`	Energy content per 100g or 100ml, usually in kilojoules (kj) or kilocalories (kcal).
`nutrition+fat`	Total fat content per 100g or 100ml, usually in grams.
`nutrition+saturated-fat`	Saturated fat content per 100g or 100ml, usually in grams.
`nutrition+carbohydrates`	Carbohydrate content per 100g or 100ml, usually in grams.
`nutrition+sugars`	Sugar content per 100g or 100ml, usually in grams.
`nutrition+protein`	Protein content per 100g or 100ml, usually in grams.
`nutrition+salt`	Salt content per 100g or 100ml, usually in grams.
`nutrition+fibre`	Fibre content per 100g or 100ml, usually in grams.
`emissions+co2e`	Greenhouse gas emissions of a single unit of the item expressed as a carbon dioxide equivalent, usually in kilograms.

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
Attribute	Not both key and type	`GOBL-ORG-ATTRIBUTE-01` Attribute must not have both a key and a type
Attribute	Text, code, amount, or date present	`GOBL-ORG-ATTRIBUTE-02` Attribute must have at least one of the text, code, amount, or date values
Attribute	No label Key or type present	`GOBL-ORG-ATTRIBUTE-04` Attribute must have a key, a type, or a label
Attribute	String(Unit) != "" Amount != nil	`GOBL-ORG-ATTRIBUTE-03` Attribute unit may only be used alongside an amount
`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-ATTRIBUTE-05` Attribute unit must be valid