ESM Business Rules

​ Message Mapping

User Data Dictionary

Data Dependencies

1. Export Sub-Manifest messages (ESM) must be electronically reported.
2. An ESM may report a maximum of 9999 lines per transaction.
3. An ESM may only be lodged by a registered exporter or a registered agent acting on their behalf.
4. The version number for an Original (9) message must be set at 1 or greater.
5. EDI generated ESM messages must quote a unique Sender Reference. The ICS will use this number and the associated version number to ensure duplicate messages are not processed.
6. An ESM message must contain a “date of departure”.
7. All times quoted are to be given in the local date/time on the port or airport where the reported vessel or aircraft is departing from"
8. ESM messages may be:
   1. “original” message function code 9.
   2. “change” message function code 4.
   3. “replace” message function code 5.
   4. “replace heading section only” message function code 20.
   5. “Withdraw” message function code 50.
9. Receipt of an ESM will generate a CONTRL response message, notifying CCF acceptance or rejection.
10. On completion of ICS processing the Department will return an ESMR message to indicate ICS acceptance, rejection or error conditions:
    1. The Department will reject any ESM message that has any errors or missing data. Where a rejection occurs the client will be advised with a list of errors causing the rejection as part of the response ESMR message.
    2. On rejection of an Original ESM message the Department will not return a Consolidation Reference Number but only a list of errors causing the rejection.
    3. When a rejection of an Original ESM message occurs, the client must send another Original ESM message with the errors corrected.
    4. The Department may send additional ESMR messages to report a change in status.
11. An ESM message cannot be withdrawn if:
    1. It has been already been linked to an Export Main Manifest (EMM)
    2. It has already been linked to another ESM.
    3. The ESM contains any lines of cargo
12. Replacement ESM messages require full data replacement, but with the message function code set to 5 (Replace).
13. ESM messages with “Replace Header Section Only” (message function code 20) require changes to the information in all of the segments in the Heading
    1. The message function code in a “heading section replace” must be set to 20.
14. Each Change, Replacement, Replace Heading Section Only or Withdrawal ESM message will be considered to be a new version of the message. For each version of a message the version number must be unique and increment upwards, to facilitate ICS processing.
15. Up to 998 Change, Replacement, or Replace Heading Section Only ESM messages can be submitted.
16. Change, Replacement, or “Replace Heading Section Only” or Withdrawal ESM messages for which no original exist will be rejected by the ICS.
17. When a Change, Replacement, or “Replace Heading Section only” or withdrawal is received, the ICS will compare the Sender Reference and Sender Reference version number with the most recent version of the report, which is stored in the ICS. Where the Sender Reference version number is not greater than the existing report the ICS will reject the change and send a CUSRES notifying of the rejection, and the latest Sender Reference version number stored by the Department.
18. An ESM message cannot be Changed, Replaced, have the heading section replaced or be withdrawn if it has already been withdrawn.
19. The ICS will always accept and process Change, Replacement, Replacement of the Heading section or withdrawal messages where the Sender Reference version number is greater than the existing stored report.
20. Before the ESM message is processed at the application level:
    1. All non-significant leading and trailing blanks will be stripped;
    2. Multiple spaces will be compressed.
21. All country references are to be stated as a valid two (2) character UN Country Code.
22. For an Original or Replacement message with 1 or more lines the line action code must be 'I' used.
23. Line information is not required for “Header Only Change” and “Withdrawal” messages.
    1. Where line information is supplied for a “Header Only Change” transaction, the transaction will be rejected.
24. To change an ESM the following data items are required:
    1. Full header details;
    2. The line number of any line/s to be inserted, changed or deleted;
    3. A line action code for each line/s to be inserted, changed or deleted;
    4. Full line details for each line/s to be inserted or changed. Line details are optional for Line action code of delete.
25. Any attempt to insert a line that already exists, or to change or delete a line that does not exist will result in rejection of the entire change message.
26. When the ICS is unavailable a contingency exemption code will be required. A client wishing to export goods cannot submit an Export Declaration (EXD). Instead, they must obtain a contingency CAN from the Department.
27. Once the system has been recovered the contingency exemption code and contingency CAN will be quoted on a Export Sub Manifest (ESM)
28. The format for the Contingency CAN is an14, this will be the only validation for the Contingency CAN.

ESM (Export Sub Manifest) - Data Dependencies

Header Data

Line Data

V 1.4 12 JUL 2004