diff --git a/working_draft/API/docs/dm-waybill.md b/working_draft/API/docs/dm-waybill.md index 70907454..96b97238 100644 --- a/working_draft/API/docs/dm-waybill.md +++ b/working_draft/API/docs/dm-waybill.md @@ -93,6 +93,83 @@ Approach needs to be two-fold: |34b|Optional shipping information - Untitled box|up to carrier|in Waybill/optionalShippingInfo| |34c|Optional shipping information - Untitled box|up to carrier|| +| Box | Air Waybill requirements | Description/Comment | 1R Objet | Object Property | Comment | +| ------- | ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 1A | Airline Code Number | Issuing carrier's three-digit IATA airline code number | Waybill#waybillPrefix | waybillPrefix | | +| 1B | Serial Number | Eight digits including a check digit | Waybill | waybillNumber | | +| 1 | Airport of Departure | IATA three-letter code of the airport of departure (or city when the name of the airport is unknown) | Waybill | departureLocation | | +| 1C | Issuing Carrier's Name and Address | Issuing carrier's name and head office address | involvedParty | Party | From Party: use partyDetails to capture the carrier's name and address. Use ParticipantIdentifier to specifiy AIR for Airline | +| 1D | Reference to Originals | Not to be completed | \- | \- | | +| 1E | Reference to Conditions of Contracts | Not be completed unless used by the issuing carrier at its option | \- | \- | | +| 2 | Shipper's Name and Address | Name, address and country (or two-letter country code) of the shipper | Waybill | involvedParty | In Party: use partyDetails to capture the shipper's name and address. Use partyRole to specifiy SHP for Shipper or FFW for Freight Forwarder | +| 3 | Shipper's Account Number | Not be completed unless used by the issuing carrier at its option | \- | \- | | +| 4 | Consignee's Name and Address | Name, address and country (or two-letter country code) of the consignee | Waybill | involvedParty | In Party: use partyDetails to capture the consignee's name and address. Use partyRole to specifiy CNE for Consignee | +| 5 | Consignee's Account Number | Not be completed unless used by the issuing carrier at its option | \- | \- | | +| 6 | Issuing Carrier's Agent Name and City | Name and location (airport or city) of the issuing carrier's IATA Cargo Agent | Waybill | involvedParty | In Party: use partyDetails to capture the Issuing carrier's IATA Cargo Agent | +| 7 | Agent's IATA Code | In non-CASS areas, IATA seven-digit code / In CASS areas, IATA seven-digit code followed by a three-digit CASS address code and a check digit | Waybill | involvedParty | In Party: use partyDetails to capture the iataCargoAgentCode from Company | +| 8 | Account Number | Not be completed unless used by the issuing carrier at its option | \- | \- | | +| 9 | Airport of Departure and Requested Routing | | TransportLegs | departureLocation | Where legNumber is '1' | +| 11A | To (by 1st carrier) | IATA 3-letter code of aiport of destination or first transfer point | TransportLegs | arrivalLocation | Where legNumber is '1' | +| 11B | By 1st carrier | "Name of 1st carrier | \- | \- | | +| 11C | To (by 2nd carrier) | IATA 3-letter code of aiport of destination or second transfer point | TransportLegs | arrivalLocation | Where legNumber is '2' | +| 11D | By 2nd carrier | "Name of 2nd carrier | \- | \- | | +| 11E | To (by 3rd carrier) | IATA 3-letter code of aiport of destination or third transfer point | TransportLegs | arrivalLocation | Where legNumber is '3' | +| 11F | By 3rd carrier | "Name of 3rd carrier | \- | \- | | +| 18 | Airport of Destination | Airport of destination of the last carrier | TransportLegs | arrivalLocation | Where legNumber is 'greater' | +| 19A | Requested Flight | To be completed by the carrier/agent/shipper effecting the booking | TransportLegs | transportIdentifier | Where legNumber is '1' | +| 19B | Requested Date | To be completed by the carrier/agent/shipper effecting the booking | TransportLegs | departureDate | Where legNumber is '1' | +| 10 | Accounting Information | Only accounting information required by carriers | Waybill | accountingInformation | | +| 12 | Currency | ISO 3-letter currency code of country of departure | \- | \- | extract from the currency used in the Waybill | +| 13 | Charges Codes - For Carrier Use Only | To be completed when the air waybill data is transmitted by electronic means | Waybill | carrierChargeCode | | +| 14A/14B | Weight/Valuation Charges | Prepaid or Collect | Waybill | weightValuationIndicator | | +| 15A/15B | Other Charges at Origin | Prepaid or Collect | Waybill | otherChargesIndicator | | +| 16 | Declared Value for Carriage | As specified by the shipper, may be NVD | Waybill | declaredValueForCarriage | | +| 17 | Declared Value for Customs | May be inserted, my be NCV, may be blank | Waybill | declaredValueForCustoms | | +| 20 | Insurance | Amount to be insured, when and where the issuing carrier offers such a service | Shipment | insurance | | +| 21 | Handling information | Clear and concise information | Shipment | specialHandlingCodes + textualHandlingInstructions | Retrieve Handling Information captured for each piece of the shipment | +| 21A | Special Customs Information (SCI) | Customs Origin Code for consignment loaded or reloaded at an airport in an EU country | Shipment | customsInformation | | +| 22A | Number of pieces and RCP | Number of pieces for the applicable rating entry | WaybillLineItem | pieceCountforRate | Manual data capture | +| 22B | Gross Weight | Gross weight of the pieces for the applicable rating entry shall | WaybillLineItem | grossWeightForRate | Manual data capture | +| 22C | Kg/Lb | The unit of weight used (K or L) | WaybillLineItem | grossWeightForRate | Unit of measurement to be specified in unit of Value (see table 1.48 Measureement Unit Code) | +| 22Z | Service Code | Not be completed unless used by the issuing carrier at its option | Waybill | serviceCode | | +| 22D | Rate Class | \- | WaybillLineItem | rateClassCode | | +| 22E | Commodity Item Number | see Resolution 600a Attachment 'B' 2.18.6 | WaybillLineItem | commodityItemNumberForRate | | +| 22F | Chargeable Weight | Applicable chargeable weight, calculated according to applicable rating rules | WaybillLineItem | chargeableWeightForRate | | +| 22G | Rate/Charge | Applicable rate or charge | WaybillLineItem | rateCharge | | +| 22H | Total | Total charge or discount for each line entry | \- | \- | Calculated value | +| 22I | Nature and Quantity of Goods | see Resolution 600a Attachment 'B' 2.18.10 | WaybillLineItem | goodsDescriptionForRate + dimensionsForRate | | +| 22J | Total Number of Pieces | \- | Shipment | pieces | Count of Pieces linked to Shipment | +| 22K | Total Gross Weight | \- | Shipment | totalGrossWeight | | +| 22L | Total | Total charge or discount for the whole shipment | \- | \- | Calculated value | +| 23 | Other Charges | see Resolution 600a Attachment 'B' 2.19 | Waybill | otherCharges | | +| 24A | Prepaid Weight Charge | Weight/volume charge for air carriage | \- | \- | Calculated value | +| 25A | Prepaid Valuation Charge | Valuation charge, if applicable | Waybill | declaredValueForCarriage | | +| 26A | Prepaid Tax | Any applicable tax | Waybill | otherCharges | Sum of otherCharges where chargePaymentType is 'P' Prepaid Indicator (see code list 1.5) and otherChargeCode are tax codes related (see code list 1.2) | +| 27A | Due Agent | Not be used unless agreed locally | Waybill | otherCharges | Sum of otherCharges where chargePaymentType is 'P' Prepaid Indicator (see code list 1.5) and entitlement is 'A' Other Charges due Agent (see code list 1.3) | +| 28A | Due Carrier | Total of prepaid other charges due to carrier | Waybill | otherCharges | Sum of otherCharges where chargePaymentType is 'P' Prepaid Indicator (see code list 1.5) and entitlement is 'C' Other Charges due Carrier (see code list 1.3) | +| 29A | Untitled box | Not be completed unless used by the issuing carrier at its option | \- | \- | | +| 30A | Total Prepaid | Total of all the prepaid charges | \- | \- | calculated value: Weight Charge (prepaid) + Valuation Charge (prepaid) + Tax (prepaid) + Total Other Charges Due Agent (prepaid) + Total Other Charges Due Carrier (prepaid) | +| 24B | Collect Weight Charge | Weight/volume charge for air carriage | \- | \- | Calculated value | +| 25B | Collect Valuation Charge | Valuation charge, if applicable | Waybill | declaredValueForCarriage | | +| 26B | Collect Tax | Any applicable tax | Waybill | otherCharges | Sum of otherCharges where chargePaymentType is 'C' Collect Indicator (see code list 1.5) and otherChargeCode are tax codes related (see code list 1.2) | +| 27B | Due Agent | Total disbursements due to agent | Waybill | otherCharges | Sum of otherCharges where chargePaymentType is 'C' Collect Indicator (see code list 1.5) and entitlement is 'A' Other Charges due Agent (see code list 1.3) | +| 28B | Due Carrier | Total disbursements due to carrier | Waybill | otherCharges | Sum of otherCharges where chargePaymentType is 'C' Collect Indicator (see code list 1.5) and entitlement is 'C' Other Charges due Carrier (see code list 1.3) | +| 29B | Untitled box | Not be completed unless used by the issuing carrier at its option | \- | \- | | +| 30B | Total Collect | Total of all the collect charges | \- | \- | calculated value: Weight Charge (collect) + Valuation Charge (collect) + Tax (collect) + Total Other Charges Due Agent (collect) + Total Other Charges Due Carrier (collect) | +| 31 | Shipper's Certification Box | Signature of the shipper or his agent (printed, signed or stamped) | Waybill | consignorDeclarationSignature | | +| 32A | Executed on (Date) | Date of execution of the air waybill | Waybill | carrierDeclarationDate | | +| 32B | At (Place) | Name of the place of execution (airport or city) of the air waybill | Waybill | carrierDeclarationPlace | | +| 32C | Signature of Issuing Carrier or its Agent | \- | Waybill | carrierDeclarationSignature | | +| 33 | For carriers use only at destination | Not be completed | \- | \- | | +| 33A | Currency Conversion Rate | Destination currency code followed by the conversion rate | Waybill+CurrencyValue | destinationCurrencyRate+CurrencyUnit | | +| 33B | Collect Charges in Destination Currency | Amount shown in the “Total Collect” box (30B) after conversion to the destination currency at the currency conversion rate shown in box (33A) | \- | \- | Calculated value: 30A\*33B | +| 33C | Charges at Destination | Charges levied at destination accruing to the last carrier | Waybill | destinationCharges | | +| 33D | Total Collect Charges | Sum of boxes (33B) and (33C) | \- | \- | Calculated value: 33B+33C | +| 34A | Optional Shipping Information - Reference Number | Reference number as per shipper/agent/issuing carrier agreement | Waybill | shippingRefNo | | +| 34B | Optional Shipping Information - Untitled Box | Not be completed unless used by the issuing carrier at its option | Waybill | shippingInfo | | +| 34C | Optional Shipping Information - Untitled Box | Not be completed unless used by the issuing carrier at its option | | | | + + The Air Waybill document can be re-created at any moment as all required information are within the data model and can be retrieved using the linked data (see the conceptual data model in the Design Principles documentation).