MTML Quick Reference

MTML 1.x Quick Reference

TradingMessageFunctions : (FunctionCode )

1 - Cancellation. It is advised to send the entire message again when cancelling a message, including a reference to the cancelled message in a Reference message segment with qualifier=ACW.

5 - Replacement. When replacing a message, the complete message should be sent, reference the message to be replaced in a Reference message segment with qualifier=ACW.

9 - Original

Reference Qualifiers :

AAG - Offer number. References the quote issued by the Vendor party, if any.

ACW - Reference number to previous message. Required only when the message is being replaced or canceled, and the message replaces a previous message of the same type, as referenced by the OrderedBy party identifier, the Vendor party identifier and the message number.

AGI - Request number. Reference to the request number issued by the Ordered by party, if any. Required if a Quote is based on a RequestForQuote. Not to be included if a Quote is based on an Order.

CP - Condition of purchase document number. Refences conditions of purchase as agreed among the parties. The valid conditions of purchase codes are defined in Appendix C of the IMPA ETS.

CT - Contract number. References a contract between the parties referenced by the contract number and date. Later prices may refer to this contract, by the use of the same qualifier in a line item message segment.

ERR - Used for designating errors when InterchangeResponse code indicates a processing/transport error

ON - Order number (purchase). Reference to the Order issued by Ordered by party, to which this response refers.

OP - Original purchase order. Reference to the Order number issued by the Ordered by party, and required if the Vendor party bases a Quote on a Purchase Order. Usually, this is not the case.

UC - Ultimate customer's reference number. The ship's requisition number, if any.

VA - VAT registration number. Can be used with a Buyer party to indicate that value added tax applies to this order.

XA - Company/place registration number

ZCS - Classification society coded. Uses Lloyd's class register codes specified in IMPA ETS Appendix D.

ZNS - National ship register coded (flag)

ZYH - Ship yard's hull number

ZYS - Ship yard

Party Qualifiers :

AG - Agent/representative. Port agent.

BY - Buyer. Legal owner of the ship.

CN - Consignee

FW - Freight forwarder

IV - Invoicee

OB - Ordered by. Buyer's agent.

UD - Ultimate customer. The ship.

VN - Vendor

BA - Billing Address

MonetaryAmount Qualifiers:

106 - Packing cost. States the packing cost, if any.

204 - Allowance amount. For additional allowances not covered by line item discounts. Note this is always stated as a positive value.

259 - Total charges. Total line item amount + packing cost + freight cost - allowance amount.

64 - Freight charge. States the quoted freight price, if any.

79 - Total line items amount. Sum of all line item monetary amounts.

DateTimePeriod Qualifiers :

132 - Arrival date/time, estimated. Estimated time of arrival for the ship in port.

133 - Departure date/time, estimated. The estimated time of departure of the ship from port.

137 - Document/message date/time. Every message should have a message date/time. The corresponding date format should be CCYYMMDDHHMM.

175 - Advise before date/time, the latest date the the Ordered By party will expect a quote from the Vendor party.

2 - Delivery date/time, requested. The sender is advised to use this qualifier to represent a vendor's delivery date at the pace of delivery location.

36 - Expiry date. Indicates the time period during which a quote is valid.

69 - Delivery date/time, promised for

ShipServ Notes : 69 is effectively LeadTime : should use DateTimeFormat Qualifier=804 for Quotes, and either any FormatQualifier on POCs

DateTimeFormat Qualifiers :

102 - CCYYMMDD

203 - CCYYMMDDHHMM

804 - Day. Delivery time in number of working days from Order. Used only when qualifier is Delivery date/time promised for.

LineItem TypeCodes :

BP - Buyer's part number

EN - International Article Numbering Association (EAN)

MF - Manufacturer's (producer's) article number

UP - Universal product code (UPC)

VP - Vendor's (seller's) part number

ZIM - IMPA Number

ZIS - ISSA Number

ZMA - Mariner's Annual number

PriceDetailsTypeCodes:

CA - Catalogue

CT - Contract

QT - Quoted

PriceDetailsTypeQualifiers:

DPR - Discount price, applies to unit price.

GRP - Gross unit price

Equipment :

This class allows the specification of the ship equipment or component that is the focus of the trading transaction, such as an engine, electrical sytem, etc.

Attributes:

description A brief description of the equipment.

drawingNumber The manufacturer's blueprint number associated with the equipment.

manufacturer The company that produced the equipment.

modelNumber The manufacturer's model number associated with the line of equipment.

name The textual name of the equipment.

rating The performance rating associated with the equipment.

serialNumber The manufacturer's unique identifier assigned to the specific piece of equipment.

type The general type of equipment that is the focus of the trading transaction.

TaxStatus Types:

Exempt - Specifically exempt from taxation according to tax codes, typically because of the party involved

NotTaxable - Not subject to tax according to tax codes, typically because of the items involved

Taxable - Subject to taxation according to tax codes

TransportModes:

1 - Maritime

2 - Rail

3 - Road

4 - Air

TradingContentsQualifiers :

1 - Consumables

2 - Frozen goods

3 - General stores

4 - Spares

5 - Services

CodeListResponsibleAgencies :

11 - Lloyd's IMO number(identifying ship ultimate customer)

ZEX - An external electronic exchange

ZIM - IMPA (International Marine Purchasing Association)

ZIS - ISSA (International Ship Supplier Association)

InterchangeResponse-related:

MessageResponseActions:

4 - Rejected - this level and all lower levels

7 - This level acknowledged, next lower level acknowledged if not explicitly rejected

ZFR - This level acknowledged by the final recipient

InterchangeResponseActions:

4 - Rejected - this level and all lower levels

8 - Interchange received

One point which is not very clear in the MTML 1.x documentation is that numeric qualifiers should be preceded by an underscore : e.g.

<Quote CurrencyCode="EUR" FunctionCode="_9" LineItemCount="3" MessageReferenceNumber="SHI..