Export Import Control System - Participant's Requirements Document

Appendix A - EDI Transactions

This appendix provides EDI transaction details.

• Section 1 provides sample XML files.
• Section 2 presents the structure of the EICS acknowledgement transaction, followed by some examples.
• Section 3 , which is not available online, presents the information and structure required for submitting an export or import permit application, cancelling a permit application, and withdrawing a cancel request. To request section 3 of this document please contact the Trade Controls & Technical Barriers Bureau.

1. Sample XML Files

1.1 Permit Application

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE Permit_Applications SYSTEM “EICS_Permit_Application V2R2.dtd">
<Permit_Applications>
<User_Id>userid</User_Id>
<Application>
<Exporter_Importer>
<Exp_Imp_EICS_File_Number>17</Exp_Imp_EICS_File_Number>
</Exporter_Importer>
<Applicant>
<Applicant_EICS_File_Number>60001</Applicant_EICS_File_Number>
</Applicant>
<General_Entries General_Export_Import_Ind="I" General_Language_Preference="E" General_Payment_Method="5" General_Distribution_Mode="1" General_Delivery_Target="3">
<General_Reference_Number>Reference 2001 05 23 1</General_Reference_Number>
<General_Comments>General comment 1</General_Comments>
<General_Entry_Exit_Date>2001/05/23</General_Entry_Exit_Date>
<General_Entry_Exit_Port>0101</General_Entry_Exit_Port>
<General_Distribution_Mechanism_Desc>Mailed</General_Distribution_Mechanism_Desc>
</General_Entries>
<Item>
<Commodity Cmdty_Document_Attached_Ind="0" Cmdty_Canadian_Currency_Ind="1" Cmdty_Unit_Of_Measure="1">
<Cmdty_Code>72142000000000</Cmdty_Code>
<Cmdty_Desc>Steel</Cmdty_Desc>
<Cmdty_Quantity>1000</Cmdty_Quantity>
<Cmdty_Value>2000</Cmdty_Value>
</Commodity>
<Export_Import_Details>
<Exp_Imp_Det_Origin_Destination_Country>FR</Exp_Imp_Det_Origin_Destination_Country>
</Export_Import_Details>
<Import_Specifics>
<Imp_Spec_Origin_Country>FR</Imp_Spec_Origin_Country>
<Imp_Spec_Shipment_Date>2001/05/23</Imp_Spec_Shipment_Date>
<Imp_Spec_End_Use_Desc>Structures</Imp_Spec_End_Use_Desc>
</Import_Specifics>
<Supplier_Consignee_Details Supplier_Consignee_Role="5">
<Supplier_Consignee_Name>Company A</Supplier_Consignee_Name>
<Supplier_Consignee_Last_Name>Lastname</Supplier_Consignee_Last_Name>
<Supplier_Consignee_First_Name>Firstname</Supplier_Consignee_First_Name>
<Supplier_Consignee_Address_Line_1>a1</Supplier_Consignee_Address_Line_1>
<Supplier_Consignee_Address_Line_2>a2</Supplier_Consignee_Address_Line_2>
<Supplier_Consignee_Address_Line_3>a3</Supplier_Consignee_Address_Line_3>
<Supplier_Consignee_City>city x</Supplier_Consignee_City>
<Supplier_Consignee_Province_State>ON</Supplier_Consignee_Province_State>
<Supplier_Consignee_Postal_Zip>A1A1A1</Supplier_Consignee_Postal_Zip>
<Supplier_Consignee_Country>CA</Supplier_Consignee_Country>
</Supplier_Consignee_Details>
</Item>
</Application>
</Permit_Applications>

1.2 Acknowledgement

Sample 1

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE Acknowledgements SYSTEM “EICS_Acknowledgement V0R4.DTD">
<Acknowledgements>
<Transactions_Received>1</Transactions_Received>
<Transactions_Processed>1</Transactions_Processed>
<Transactions_In_Error>0</Transactions_In_Error>
<Ack_Date_Time>2001-05-25 14:06:02</Ack_Date_Time>
<User_Id>pageauc</User_Id>
<Acknowledgement>
<General_Reference_Number>Reference 2001 04 05 1</General_Reference_Number>
<Pending_Permit_Application_Id>0</Pending_Permit_Application_Id>
<Permit_Application_Id>644</Permit_Application_Id>
<Permit_Id>369</Permit_Id>
<Message Severity="NOTIFY">
<Description>
NONE</Description>
</Message>
</Acknowledgement>
</Acknowledgements>

Sample 2

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE Acknowledgements SYSTEM “Eics_Acknowledgement V0R4.dtd">
<Acknowledgements>
<Transactions_Received>1</Transactions_Received>
<Transactions_Processed>0</Transactions_Processed>
<Transactions_In_Error>1</Transactions_In_Error>
<Ack_Date_Time>2001-05-24 17:03:18</Ack_Date_Time>
<User_Id>B3</User_Id>
<Acknowledgement>
<General_Reference_Number>111716</General_Reference_Number>
<Pending_Permit_Application_Id>1680</Pending_Permit_Application_Id>
<Permit_Application_Id>0</Permit_Application_Id>
<Permit_Id>0</Permit_Id>
<Message Severity="ERROR">
<Description>
E005 Invalid General_Entry_Exit_Port
</Description>
</Message>
</Acknowledgement>
</Acknowledgements>

2. Data Type Definition (DTD) Files

(copy and paste content below to file)

2.1 Permit Application (DTD version V2R2)

–copy below–

<?xml version="1.0" encoding="UTF-8"?>
<!– –>
<!ELEMENT Permit_Applications (User_Id, Application+)>
<!ELEMENT User_Id (#PCDATA)>
<!ELEMENT Application (Exporter_Importer, Applicant, General_Entries, Item+)>
<!– Exporter/Importer information –>
<!ELEMENT Exporter_Importer ((Exp_Imp_EICS_File_Number | Exp_Imp_CCRA_Business_Number))>
<!ELEMENT Exp_Imp_EICS_File_Number (#PCDATA)>
<!– Applicant information –>
<!ELEMENT Applicant ((Applicant_EICS_File_Number | Applicant_CCRA_Business_Number))>
<!ELEMENT Applicant_EICS_File_Number (#PCDATA)>
<!ELEMENT Applicant_CCRA_Business_Number (#PCDATA)>
<!– General Entries information –>
<!ELEMENT General_Entries (General_Reference_Number, General_CCRA_Transaction_Number?, General_Comments?, General_Entry_Exit_Date, General_Entry_Exit_Port?, General_Distribution_Mechanism_Desc?, General_Broker_Outpost_Number?)>
<!ATTLIST General_Entries
General_Export_Import_Ind (E | e | I | i) #REQUIRED
General_Language_Preference (E | e | F | f) #REQUIRED
General_Payment_Method (1 | 2 | 3 | 4 | 5) #REQUIRED
General_Distribution_Mode (1 | 2 | 3 | 4 | 5 | 6 | 7) #REQUIRED
General_Delivery_Target (1 | 2 | 3 | 4 | 5) #REQUIRED
General_Sensitive_Goods_Ind (0 | 1) #REQUIRED
> 
<!ELEMENT General_Reference_Number (#PCDATA)>
<!ELEMENT General_CCRA_Transaction_Number (#PCDATA)>
<!ELEMENT General_Comments (#PCDATA)>
<!ELEMENT General_Entry_Exit_Date (#PCDATA)>
<!ELEMENT General_Entry_Exit_Port (#PCDATA)>
<!ELEMENT General_Distribution_Mechanism_Desc (#PCDATA)>
<!ELEMENT General_Broker_Outpost_Number (#PCDATA)>
<!– Permit application item information –>
<!ELEMENT Item (Commodity, Export_Import_Details, Export_Specifics?, Import_Specifics?, Export_License_Details?, Export_Softwood_Lumber?, Supplier_Consignee_Details+)>
<!– Commodity information –>
<!ELEMENT Commodity (Cmdty_Code?, Cmdty_Desc?, Cmdty_Quantity, Alternate_Quantity?, Cmdty_Value)>
<!ATTLIST Commodity
Cmdty_Document_Attached_Ind (0 | 1) #REQUIRED
Cmdty_Canadian_Currency_Ind (0 | 1) #REQUIRED
Cmdty_Unit_Of_Measure (1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18) #REQUIRED
> 
<!ELEMENT Cmdty_Code (#PCDATA)>
<!ELEMENT Cmdty_Desc (#PCDATA)>
<!ELEMENT Cmdty_Quantity (#PCDATA)>
<!ELEMENT Alternate_Quantity (#PCDATA)>
<!ELEMENT Cmdty_Value (#PCDATA)>
<!– Export/import details information –>
<!ELEMENT Export_Import_Details (Exp_Imp_Det_Origin_Destination_Country, Exp_Imp_Det_Fibre_Origin_Country?, Exp_Imp_Det_Yarn_Origin_Country?, Exp_Imp_Det_Fabric_Origin_Country?)>
<!ATTLIST Export_Import_Details
Exp_Imp_Det_NAFTA_CCFTA_Proc_Type (1 | 2 | 3 | 4) #IMPLIED
> 
<!ELEMENT Exp_Imp_Det_Origin_Destination_Country (#PCDATA)>
<!ELEMENT Exp_Imp_Det_Fibre_Origin_Country (#PCDATA)>
<!ELEMENT Exp_Imp_Det_Yarn_Origin_Country (#PCDATA)>
<!ELEMENT Exp_Imp_Det_Fabric_Origin_Country (#PCDATA)>
<!– Export specifics information –>
<!ELEMENT Export_Specifics (Exp_Spec_Origin_Country, Exp_Spec_Shipment_Date, Exp_Spec_End_Use_Desc?)>
<!ATTLIST Export_Specifics
Exp_Spec_Special_Condition_Code (1 | 2) #IMPLIED
> 
<!ELEMENT Exp_Spec_Origin_Country (#PCDATA)>
<!ELEMENT Exp_Spec_Shipment_Date (#PCDATA)>
<!ELEMENT Exp_Spec_End_Use_Desc (#PCDATA)>
<!– Import specifics information –>
<!ELEMENT Import_Specifics (Imp_Spec_Origin_Country, Imp_Spec_Shipment_Date, Imp_Spec_End_Use_Desc?)>
<!ATTLIST Import_Specifics
Imp_Spec_Multiload_Shipment_Ind (0 | 1) #IMPLIED
Imp_Spec_Special_Condition_Code (1 | 2) #IMPLIED
> 
<!ELEMENT Imp_Spec_Origin_Country (#PCDATA)>
<!ELEMENT Imp_Spec_Shipment_Date (#PCDATA)>
<!ELEMENT Imp_Spec_End_Use_Desc (#PCDATA)>
<!– Export license details information –>
<!ELEMENT Export_License_Details (Exp_License_Number?, Exp_License_Date?, Exp_License_Quantity?, Exp_License_Trade_Agrmnt_Number?)>
<!ATTLIST Export_License_Details
Exp_License_Document_Attached_Ind (0 | 1) #IMPLIED
> 
<!ELEMENT Exp_License_Number (#PCDATA)>
<!ELEMENT Exp_License_Date (#PCDATA)>
<!ELEMENT Exp_License_Quantity (#PCDATA)>
<!ELEMENT Exp_License_Trade_Agrmnt_Number (#PCDATA)>
<!– Export softwood lumber information –>
<!ELEMENT Export_Softwood_Lumber (Exp_SL_US_Entry_Port, Exp_SL_Manufacturer_Business_Num, Exp_SL_Document_Entry_Number?, Exp_SL_US_Importer_Name, Exp_SL_Region_of_Logs?, Exp_MLB_C_of_O?)>
<!ATTLIST Export_Softwood_Lumber
Exp_SL_Transport_Mode (1 | 2 | 3) #REQUIRED
Exp_SL_Fees_Paid_Ind (0 | 1) #IMPLIED
Exp_SL_Excl_Logs_Ind (0 | 1) #IMPLIED
> 
<!ELEMENT Exp_SL_US_Entry_Port (#PCDATA)>
<!ELEMENT Exp_SL_Manufacturer_Business_Num (#PCDATA)>
<!ELEMENT Exp_SL_Document_Entry_Number (#PCDATA)>
<!ELEMENT Exp_SL_US_Importer_Name (#PCDATA)>
<!ELEMENT Exp_SL_Region_of_Logs (#PCDATA)>
<!ELEMENT Exp_MLB_C_of_O (#PCDATA)>
<!– Supplier Consignee information –>
<!ELEMENT Supplier_Consignee_Details (Supplier_Consignee_Name, Supplier_Consignee_Last_Name?, Supplier_Consignee_First_Name?, Supplier_Consignee_Address_Line_1?, Supplier_Consignee_Address_Line_2?, Supplier_Consignee_Address_Line_3?, Supplier_Consignee_City?, Supplier_Consignee_Province_State?, Supplier_Consignee_Postal_Zip?, Supplier_Consignee_Country)>
<!ATTLIST Supplier_Consignee_Details
Supplier_Consignee_Role (1 | 2 | 3 | 4 | 5) #REQUIRED
> 
<!ELEMENT Supplier_Consignee_Name (#PCDATA)>
<!ELEMENT Supplier_Consignee_Last_Name (#PCDATA)>
<!ELEMENT Supplier_Consignee_First_Name (#PCDATA)>
<!ELEMENT Supplier_Consignee_Address_Line_1 (#PCDATA)>
<!ELEMENT Supplier_Consignee_Address_Line_2 (#PCDATA)>
<!ELEMENT Supplier_Consignee_Address_Line_3 (#PCDATA)>
<!ELEMENT Supplier_Consignee_City (#PCDATA)>
<!ELEMENT Supplier_Consignee_Province_State (#PCDATA)>
<!ELEMENT Supplier_Consignee_Postal_Zip (#PCDATA)>
<!ELEMENT Supplier_Consignee_Country (#PCDATA)>

–end copy above–

2.2 Acknowledgement

<?xml version="1.0" encoding="UTF-8"?>
<!ELEMENT Acknowledgements (Transactions_Received, Transactions_Processed, Transactions_In_Error, Ack_Date_Time, User_Id, Acknowledgement+)>
<!ELEMENT Transactions_Received (#PCDATA)>
<!ELEMENT Transactions_Processed (#PCDATA)>
<!ELEMENT Transactions_In_Error (#PCDATA)>
<!ELEMENT Ack_Date_Time (#PCDATA)>
<!ELEMENT User_Id (#PCDATA)>
<!ELEMENT Acknowledgement (General_Reference_Number, Pending_Permit_Application_Id?, Permit_Application_Id?, Permit_Id?, Message+)>
<!ELEMENT General_Reference_Number (#PCDATA)>
<!ELEMENT Pending_Permit_Application_Id (#PCDATA)>
<!ELEMENT Permit_Application_Id (#PCDATA)>
<!ELEMENT Permit_Id (#PCDATA)>
<!ELEMENT Message (Description)>
<!ATTLIST Message Severity (NOTIFY | ERROR) #REQUIRED>
<!ELEMENT Description (#PCDATA)