Skip to content

Consignee

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

Consignee

Consignee is the party to whom cargo is delivered. In CargoNext, Consignee is a master record linked to Customer or a standalone organization. Used in Sea Freight, Air Freight, Transport, and Customs.

Industry practice: Consignee = importer (for import) or receiver. May differ from the billing party.

To access: Home > Sea Freight > Organizations > Consignee or Home > Transport > Organizations > Consignee

1. How to Create

  1. Go to Consignee list, click New.
  2. Enter Consignee Name, Customer (if applicable).
  3. Add Address and Contact.
  4. Save.

2. Usage

Complete field reference

All fields from DocType Consignee 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
Details (details_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.
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.
Consignee Name (consignee_name) 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).
column_break_bvoo Column Break Purpose: Continues the current row in a second column (standard ERP two-column layout). What to enter: No data — layout only.
Importer Category (importer_category) Link Purpose: Creates a controlled reference to Importer Category 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 Importer Category. Create the master first if it does not exist.
Default UNLOCO (default_unloco) Link Purpose: Creates a controlled reference to UNLOCO 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 UNLOCO. Create the master first if it does not exist.
Is Active (is_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.
General defaults (section_general_defaults) 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.
Default Notify Party (default_notify_party) 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).
Default Notify Party Address (default_notify_party_address) Small Text Purpose: Short note or identifier where a full Text field is not needed. What to enter: One line of text; keep it brief for list views.
column_break_general Column Break Purpose: Continues the current row in a second column (standard ERP two-column layout). What to enter: No data — layout only.
Default Service Level (default_service_level) Link Purpose: Creates a controlled reference to Logistics Service Level 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 Logistics Service Level. Create the master first if it does not exist.
Default Incoterm (default_incoterm) Link Purpose: Creates a controlled reference to Incoterm 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 Incoterm. Create the master first if it does not exist.
Default Currency (default_currency) Link Purpose: Creates a controlled reference to Currency 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 Currency. Create the master first if it does not exist.
Default Payment Terms (default_payment_terms) Link Purpose: Creates a controlled reference to Payment Terms Template 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 Payment Terms Template. Create the master first if it does not exist.
Air Freight (air_freight_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.
Air freight defaults (section_air_defaults) 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.
Default Receiving Agent (Air) (air_default_receiving_agent) Link Purpose: Creates a controlled reference to Freight Agent 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 Freight Agent. Create the master first if it does not exist.
Default Broker (Air) (air_default_broker) Link Purpose: Creates a controlled reference to Freight Agent 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 Freight Agent. Create the master first if it does not exist.
Default Airport (default_airport) Link Purpose: Creates a controlled reference to UNLOCO 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 UNLOCO. Create the master first if it does not exist.
column_break_air_1 Column Break Purpose: Continues the current row in a second column (standard ERP two-column layout). What to enter: No data — layout only.
Default Customs Broker (Air) (air_default_customs_broker) Link Purpose: Creates a controlled reference to Supplier 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 Supplier. Create the master first if it does not exist.
Default Document Template (Air) (air_default_document_template) Link Purpose: Creates a controlled reference to Document List Template 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 Document List Template. Create the master first if it does not exist.
Default Milestone Template (Air) (air_default_milestone_template) Link Purpose: Creates a controlled reference to Milestone Template 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 Milestone Template. Create the master first if it does not exist.
column_break_air_2 Column Break Purpose: Continues the current row in a second column (standard ERP two-column layout). What to enter: No data — layout only.
Default Terms (Air) (air_default_tc_name) Link Purpose: Creates a controlled reference to Terms and Conditions 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 Terms and Conditions. Create the master first if it does not exist.
Default Client Notes (Air) (air_default_client_notes) Text Editor Purpose: Field type Text Editor — stores or displays data per Frappe standard behaviour. What to enter: Enter or select a value appropriate to the label; see ERPNext docs for this field type if unsure.
Sea Freight (sea_freight_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.
Sea freight defaults (section_sea_defaults) 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.
Default Receiving Agent (Sea) (sea_default_receiving_agent) Link Purpose: Creates a controlled reference to Freight Agent 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 Freight Agent. Create the master first if it does not exist.
Default Broker (Sea) (sea_default_broker) Link Purpose: Creates a controlled reference to Broker 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 Broker. Create the master first if it does not exist.
Default Seaport (default_seaport) Link Purpose: Creates a controlled reference to UNLOCO 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 UNLOCO. Create the master first if it does not exist.
column_break_sea_1 Column Break Purpose: Continues the current row in a second column (standard ERP two-column layout). What to enter: No data — layout only.
Default Freight Consolidator (sea_default_freight_consolidator) Link Purpose: Creates a controlled reference to Freight Consolidator 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 Freight Consolidator. Create the master first if it does not exist.
Default Document Template (Sea) (sea_default_document_template) Link Purpose: Creates a controlled reference to Document List Template 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 Document List Template. Create the master first if it does not exist.
Default Milestone Template (Sea) (sea_default_milestone_template) Link Purpose: Creates a controlled reference to Milestone Template 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 Milestone Template. Create the master first if it does not exist.
column_break_sea_2 Column Break Purpose: Continues the current row in a second column (standard ERP two-column layout). What to enter: No data — layout only.
Default Terms (Sea) (sea_default_tc_name) Link Purpose: Creates a controlled reference to Terms and Conditions 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 Terms and Conditions. Create the master first if it does not exist.
Default Client Notes (Sea) (sea_default_client_notes) Text Editor Purpose: Field type Text Editor — stores or displays data per Frappe standard behaviour. What to enter: Enter or select a value appropriate to the label; see ERPNext docs for this field type if unsure.
Customs (customs_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.
Customs defaults (section_customs_defaults) 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.
Default Customs Broker (customs_default_broker) Link Purpose: Creates a controlled reference to Broker 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 Broker. Create the master first if it does not exist.
Default Freight Agent (Customs) (customs_default_freight_agent) Link Purpose: Creates a controlled reference to Freight Agent 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 Freight Agent. Create the master first if it does not exist.
Customs Importer Classification (customs_importer_classification) Select From definition: Customs lane classification (SGL=Super Green Lane, GL=Green Lane) Purpose: Constrains input to predefined values (compliance, mode, status, or internal classification). What to enter: Pick exactly one value from the list: SGL, GL, Yellow Lane, Red Lane, Not Classified.
column_break_customs_1 Column Break Purpose: Continues the current row in a second column (standard ERP two-column layout). What to enter: No data — layout only.
Default Trade Agreement (customs_default_trade_agreement) 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).
Default Marks and Numbers (customs_default_marks_and_numbers) Long Text Purpose: Long remarks: cargo description, marks & numbers, special instructions, legal text. What to enter: Enter the full operational or legal wording; paste from external docs if allowed by policy.
Default Payment Terms (Customs) (customs_default_payment_terms) Link Purpose: Creates a controlled reference to Payment Terms Template 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 Payment Terms Template. Create the master first if it does not exist.
Default Document Template (Customs) (customs_default_document_template) Link Purpose: Creates a controlled reference to Document List Template 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 Document List Template. Create the master first if it does not exist.
Default Milestone Template (Customs) (customs_default_milestone_template) Link Purpose: Creates a controlled reference to Milestone Template 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 Milestone Template. Create the master first if it does not exist.
column_break_customs_2 Column Break Purpose: Continues the current row in a second column (standard ERP two-column layout). What to enter: No data — layout only.
Default Special Instructions (Customs) (customs_default_special_instructions) Long Text Purpose: Long remarks: cargo description, marks & numbers, special instructions, legal text. What to enter: Enter the full operational or legal wording; paste from external docs if allowed by policy.
Default Country of Origin (customs_default_country_of_origin) Link Purpose: Creates a controlled reference to Country 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 Country. Create the master first if it does not exist.
Transport (transport_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.
Transport defaults (section_transport_defaults) 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.
Default Document Template (Transport) (transport_default_document_template) Link Purpose: Creates a controlled reference to Document List Template 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 Document List Template. Create the master first if it does not exist.
Default Milestone Template (Transport) (transport_default_milestone_template) Link Purpose: Creates a controlled reference to Milestone Template 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 Milestone Template. Create the master first if it does not exist.
column_break_transport_1 Column Break Purpose: Continues the current row in a second column (standard ERP two-column layout). What to enter: No data — layout only.
Default Client Notes (Transport) (transport_default_client_notes) Text Editor Purpose: Field type Text Editor — stores or displays data per Frappe standard behaviour. What to enter: Enter or select a value appropriate to the label; see ERPNext docs for this field type if unsure.
Default Internal Notes (Transport) (transport_default_internal_notes) Text Editor Purpose: Field type Text Editor — stores or displays data per Frappe standard behaviour. What to enter: Enter or select a value appropriate to the label; see ERPNext docs for this field type if unsure.
Addresses and Contacts (addresses_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.
addresses_and_contacts 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.
Addresses (address_html) HTML Purpose: Shows calculated or static HTML (KPIs, dashboards, embedded help, milestone views). What to enter: Nothing to type — content is rendered by the system.
column_break_nivp Column Break Purpose: Continues the current row in a second column (standard ERP two-column layout). What to enter: No data — layout only.
Contacts (contact_html) HTML Purpose: Shows calculated or static HTML (KPIs, dashboards, embedded help, milestone views). What to enter: Nothing to type — content is rendered by the system.
section_break_vizq 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.
Primary Address (consignee_primary_address) Link Purpose: Creates a controlled reference to Address 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 Address. Create the master first if it does not exist.
Delivery Address (delivery_address) Link From definition: Default address for transport deliveries Purpose: Creates a controlled reference to Address 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 Address. Create the master first if it does not exist.
Primary Address (primary_address) Text Purpose: Multi-line narrative (instructions, clauses, template text). What to enter: Free text across multiple lines; use line breaks where helpful.
column_break_umfc Column Break Purpose: Continues the current row in a second column (standard ERP two-column layout). What to enter: No data — layout only.
Primary Contact (consignee_primary_contact) Link Purpose: Creates a controlled reference to Contact 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 Contact. Create the master first if it does not exist.
Connections (connections_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.

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