Skip to content

Commodity

github-actions[bot] edited this page Apr 18, 2026 · 3 revisions

Commodity

Commodity is a master record for goods classification used in customs declarations. Typically includes HS Code, description, and duty/tax information.

Industry practice: HS (Harmonized System) codes are internationally standardized. Customs authorities use them for tariff and statistics.

To access: Home > Customs > Master Data > Commodity

1. How to Create

  1. Go to Commodity list, click New.
  2. Enter HS Code, Description, Country (if applicable).
  3. Add duty rates, restrictions if needed.
  4. Save.

2. Usage

Complete field reference

All fields from DocType Commodity and nested child tables, in form order (including layout breaks). Columns: Label with technical field name in backticks, Type, and Description (from the DocType definition and standard freight/ERP semantics).

Label (Field name) Type Description
Code (code) Data Purpose: Short stable code for lists, integrations, and EDI (often uppercase). What to enter: Unique code within this master; match what customs, carriers, or APIs expect.
Description (description) Data Purpose: Short free-text for codes, references, or labels that are not master-linked. What to enter: Type the value as it should appear on print/PDF (no line breaks).
Active (active) Check Purpose: Boolean flag that drives validation, billing, DG handling, or UI (depending on the field label). What to enter: Tick Yes / enabled, untick No / disabled.
column_break_vzlp Column Break Purpose: Continues the current row in a second column (standard ERP two-column layout). What to enter: No data — layout only.
Universal Commodity Code (universal_commodity_code) Data Purpose: Short stable code for lists, integrations, and EDI (often uppercase). What to enter: Unique code within this master; match what customs, carriers, or APIs expect.
IATA Commodity Code (iata_commodity_code) Data Purpose: Short stable code for lists, integrations, and EDI (often uppercase). What to enter: Unique code within this master; match what customs, carriers, or APIs expect.
Default HS Code (default_hs_code) Link Purpose: Creates a controlled reference to Customs Tariff Number so party, place, item, or document data stays consistent for reporting and integrations. What to enter: Type to search or click the link icon; select an existing Customs Tariff Number. Create the master first if it does not exist.
applicable_to_section Section Break Purpose: Visual grouping and optional heading for the fields that follow (improves long freight forms). What to enter: No data — informational layout only.
Forwarding (forwarding) Check Purpose: Boolean flag that drives validation, billing, DG handling, or UI (depending on the field label). What to enter: Tick Yes / enabled, untick No / disabled.
Shipping (shipping) Check Purpose: Boolean flag that drives validation, billing, DG handling, or UI (depending on the field label). What to enter: Tick Yes / enabled, untick No / disabled.
Land Transport (land_transport) Check Purpose: Boolean flag that drives validation, billing, DG handling, or UI (depending on the field label). What to enter: Tick Yes / enabled, untick No / disabled.
Perishable (perishable) Check Purpose: Boolean flag that drives validation, billing, DG handling, or UI (depending on the field label). What to enter: Tick Yes / enabled, untick No / disabled.
Timber (timber) Check Purpose: Boolean flag that drives validation, billing, DG handling, or UI (depending on the field label). What to enter: Tick Yes / enabled, untick No / disabled.
Hazardous (hazardous) Check Purpose: Boolean flag that drives validation, billing, DG handling, or UI (depending on the field label). What to enter: Tick Yes / enabled, untick No / disabled.
Flammable (flammable) Check Purpose: Boolean flag that drives validation, billing, DG handling, or UI (depending on the field label). What to enter: Tick Yes / enabled, untick No / disabled.
Container Vent Required (container_vent_required) Check Purpose: Boolean flag that drives validation, billing, DG handling, or UI (depending on the field label). What to enter: Tick Yes / enabled, untick No / disabled.
column_break_eefs Column Break Purpose: Continues the current row in a second column (standard ERP two-column layout). What to enter: No data — layout only.
Commodity Expiry (commodity_expiry) Date Purpose: Calendar date for the business event described by the label. What to enter: Choose the date from the picker; must reflect operational truth. Behaviour: Hidden in default layout; may still be set by import, API, or script.
Minimum Temperature (°C) (minimum_temperature) Float Purpose: Decimal quantity or measurement (weight, volume, count with decimals). What to enter: Enter a number using site decimal precision.
Maximum Temperature (°C) (maximum_temperature) Float Purpose: Decimal quantity or measurement (weight, volume, count with decimals). What to enter: Enter a number using site decimal precision.
Other Codes (other_codes_tab) Tab Break Purpose: Organises the form into tabs so related fields are easier to scan and edit. What to enter: No data — click the tab to show or hide its fields.
other_codes Table Purpose: Stores repeating Other Commodity Code lines (child records) such as packages, charges, legs, or documents. What to enter: Use Add row, fill each line, and remove rows you do not need. Save the parent to persist child rows.
Notes (notes_tab) Tab Break Purpose: Organises the form into tabs so related fields are easier to scan and edit. What to enter: No data — click the tab to show or hide its fields.

Child table: Other Commodity Code (field other_codes on parent)

Label (Field name) Type Description
Code (code) Data Purpose: Short stable code for lists, integrations, and EDI (often uppercase). What to enter: Unique code within this master; match what customs, carriers, or APIs expect.
Applied To (applied_to) Link Purpose: Creates a controlled reference to DocType so party, place, item, or document data stays consistent for reporting and integrations. What to enter: Type to search or click the link icon; select an existing DocType. Create the master first if it does not exist.
Value (value) Dynamic Link Purpose: References another document whose DocType is chosen in field applied_to (same pattern as ERPNext Dynamic Link). What to enter: First set the DocType field, then pick the document name for that type.

3. Related Topics

Getting Started

Setup and Settings

Sea Freight

Air Freight

Transport

Customs

Warehousing

Pricing Center

Job Management

Sustainability

Intercompany

Special Projects

Pages

Features

Reports

Glossary

Clone this wiki locally