Dycode SimpleUBL UBL 2.0 Class Library

ForwardingInstructions Class


The document issued to a forwarder, giving instructions regarding the action to be taken for the forwarding of goods described therein. Forwarding Instructions is used by any party who gives instructions for the transportation services required for a consignment of goods to any party who is contracted to provide the transportation services. The parties who issue this document are commonly referred to as the shipper or consignor, while the parties who receive this document are forwarders, carriers, shipping agents, etc. Note that this document may also be issued by a forwarder or shipping agent in their capacity as a "shipper". This document can be used to arrange for the transportation (1) of different types of goods or cargoes; (2) whether containerized or non-containerized; (3) through different modes of transport including multi-modal; and (4) from any origin to any destination.

Public Instance Constructors

ForwardingInstructions Constructor Default constructor.
ForwardingInstructions Copy Constructor Copy constructor. (Only C++)
ForwardingInstructions Constructor with required values Constructor with required values. (Only C++, .NET)

Public Instance Properties

Property UBL 2.0 Description
UBLVersionID0..1 UBL Version Identifier. The earliest version of the UBL 2 schema for this document type that defines all of the elements that might be encountered in the current instance. (Ex: 2.0.5)
UBLExtensions0..1 A container for all extensions present in the document.
CustomizationID0..1 Customization Identifier. Identifies a user-defined Customization of UBL for a specific use. (Ex: NES)
ProfileID0..1 Profile Identifier. Identifies a user-defined profile of the customization of UBL being used. (Ex: BasicProcurementProcess)
ID1 Identifier. Unique identifier of the Forwarding Instructions.
CarrierAssignedID0..1 Identifier. Reference number assigned by a carrier or its agent to identify a specific shipment such as a booking reference number when cargo space is reserved prior to loading.
UUID0..1 UUID. A universally unique identifier for an instance of this ABIE.
IssueDate0..1 Issue Date. Date on which the Forwarding Instructions were issued.
IssueTime0..1 Issue Time. Time at which the Forwarding Instructions were issued.
Name0..1 Name. Name of a Forwarding Instructions.
Descriptions0..n Description. Textual description of the document instance.
Notes0..n Note. Informative notes associated with the Forwarding Instructions.
DocumentStatusCode0..1 Document Status Code. Identifies the status of the Forwarding Instructions with respect to its original state. This may be used if the document precedes the event and is subsequently found to be incorrect and in need of cancelling or revising.
ShippingOrderID0..1 Shipping Order Identifier. Reference number to identify a Shipping Order.
ToOrderIndicator0..1 Indicator. Indicator of whether the transport document is consigned to order.
AdValoremIndicator0..1 Indicator. A term used in commerce in reference to certain duties, called ad valorem duties, which are levied on commodities at certain rates per centum on their value.
DeclaredCarriageValueAmount0..1 Value. Value, declared by the shipper or his agent solely for the purpose of varying the carrier's level of liability from that provided in the contract of carriage, in case of loss or damage to goods or delayed delivery.
OtherInstructions0..n Instruction. Contains other free-text based instructions related to the shipment to the forwarders or carriers. This should only be used where such information cannot be represented in other structured information entities within the document.
ConsignorParty0..1 Party. The party consigning goods, as stipulated in the transport contract by the party ordering transport.
CarrierParty0..1 Party. The party providing the transport of goods between named points.
FreightForwarderParty0..1 Party. The party combining individual smaller consignments into a single larger consignment (so-called consolidated consignment) that is sent to a counterpart who mirrors the consolidator's activity by dividing the consolidated consignment into its original components.
Shipment1 Shipment. An association to Shipment.
DocumentReferences0..n Document Reference. An association to Document Reference.
ExchangeRates0..n Exchange Rate. Information that directly relates to the rate of exchange (conversion) between two currencies.
Signatures0..n Signature. One or more signatures applied to the document instance.
XML XML Document in the string format.

Public Instance Methods

GetSchemaValidationErrors Validate document by schema. If document is not valid, return validation error.
GetSchemaValidationErrorsFromXML Validate XML by schema. If XML is not valid, return validation error.
GetValueValidationErrors Validate document by value. If document is not valid, return validation error.
GetValueValidationErrorsFromXML Validate XML by value. If XML is not valid, return validation error.
GetValidationErrors Validate document by schema and then by value. If document is not valid, return validation error.
GetValidationErrorsFromXML Validate XML by schema and then by value. If XML is not valid, return validation error.
Write Write document XML.
Read Read document XML.

Public Operators

Operator=Overloading of Assignment Operator. (Only C++)

Thread Safety

Public static members of this type are safe for multithreaded operations. Instance members are not guaranteed to be thread-safe.

See Also

ForwardingInstructions Properties | Dycode.SimpleUBL