Animal Products E-cert Help Files

Although you can generate a batch file using the Data View button, you won't be able to submit that file until you have at least amended the certificate number and saved the amended file. E-cert will not accept two certificates with the same number within a calendar year unless the existing certificate is in a status of Resubmit. In that case, everything on the existing certificate is replaced by the new batch file with the same certificate number.

Start tag

<batch_request>

This is the required start tag for all on-line batch submissions.

The SOAP requirements are slightly different, and are covered in the AP E-Cert Submission using SOAP - Technical User Guide.

Submission type start tag

A tag indicating the submission type:

<raise_eligibility_document> or <raise_export_certificate> or

<amend_eligibility_document> or <amend_export_certificate> or

<cancel_eligibility_document> or <cancel_export_certificate> or

<exhaust_eligibility_document> or

<exhaust_eligibility_document_products> or

Certificate type start tag

<EligibilityDocument> for an eligibility document or <Certificate> for an export certificate

Header tags

a set of tags defining Elements, Sub-elements and Attributes

Product tags

a set of tags at the Product level defining Elements, Sub-elements and Attributes

Process tags

a set of tags at the Process level for each product item defining Elements, Sub-elements and Attributes

Export Certificate Approval tags (export certificates only)
a set of tags at the Approval level, to define any optional decalaration clauses

Certificate type end tag

</EligibilityDocument> for an eligibility document or </Certificate> for an export certificate

Submission type end tag

An end tag to match the submission type start tag:

</raise_eligibility_document> or </raise_export_certificate> or

</amend_eligibility_document> or </amend_export_certificate> or

</cancel_eligibility_document> or </cancel_export_certificate> or

</exhaust_eligibility_document> or

</exhaust_eligibility_document_products> or

End tag

</batch_request>

This is the required end tag for all on-line batch submissions.

Because internet pages wrap information onto the next line if there is not enough space on the screen to display it, some of the examples shown in the following tables may appear to be on more than one line but in a batch file they must be on a single line. You might find the tables easier to read if you open the Print Friendly version then change the browser page layout to landscape and print this page.

Description

Type

Contents

Notes

XML tags

Notes for tags

Start

<batch_request>

…………………

all other tags for the batch file

…………………

</batch_request>

There is a matching tag at the end of the batch file. Within this tag are all certificate data.

Submission and Certificate type

<raise_eligibility_document>

<EligibilityDocument>

…………………

all other tags for the certificate

…………………

</EligibilityDocument>

</raise_eligibility_document>

There are matching end tags at the end of the submission data.

The submission tags change depending on action required (raise, amend etc)

Auto-approval

Y/N

Y or N

Eligibility Declarations only.

<Form code = "AA"/>

Remove this completely for EDs or if the EDec is not to be Auto-Approved.

Certificate number

N (6)

Unique serial number within the calendar year used as last component in shoulder number.

<EligibilityDocument number = "123456">

OR <EligibilityDocument number = "NZL2009/ME600/123456T">.

Use full shoulder number when using the amend or resubmit methods.

Consignor

AN (10)

Identifier

Must be a valid premises or Exporter ID

<Consignor identifier = "ME600"/>

Consignee

AN (10)

Identifier

Must be a valid premises or Exporter ID

<Consignee identifier = "S600"/>

Transport mode

N (1)

1 = Maritime 
2 = Rail 
3 = Road 
4 = Air

Required on all EDs other than internal transfers where the consignor and consignee are the same ID. EDs to exporters must choose either 1 or 4.
Air may be used for road consignments sent directly to an airport coldstore intended for airfreight shipment.

<Transport>

<Mode code = "3"/>
<ConveyanceRef></ConveyanceRef>
<Carrier>
<Name>HRTL1</Name>  

</Carrier>
</Transport>

<Transport>

<Mode code = "4"/>
<ConveyanceRef>NZ02</ConveyanceRef>
<Carrier>
<Name>Air NZ</Name>
</Carrier>
</Transport>

The transport tags must all appear as a block.

The mode description (eg Road or Air) is optional.

Carrier name

AN (254)

The full name or listed ID of the transport company or "Operator Vehicle"

Required for edible meat and seafood products, optional for others.  
Transfers to exporters may additionally have the vessel or airline name.

Conveyance ref

AN (254)

Transport reference

Vessel voyage number or flight number for transfers to exporters.

Loading port

AN (254)

A (5)

Air or seaport name or code

Either a five letter code or the name of the port of loading (UNLOCODE)

<LoadingPort code = "NZLYT"/>

If a valid NZ port code (NZLYT) is entered, it will overwrite whatever is typed as a description (Lyttelton).

Final destination

AN (254)

A (5)

Country or code

May also include the city of destination. May enter a five letter code (UNLOCODE)

<FinalDestination>Japan</FinalDestination>

5 letter code will convert to city, country format on submission.

Departure date

Date

yyyy-mm-dd

Date of departure from the consigning or final premises.

<Departure>

<Date>2002-06-02</Date>
</Departure>

3rd party access

AN (254)

One or more valid IDs, separated by comma.

Read-only access to the certificate is granted to all users who can read certificates for the IDs specified.

<ThirdParty identifier = "ME600"/>
<ThirdParty identifier = "S600"/>

Multiple TP premises must be entered as separate ThirdParty elements.

Unofficial Commercial Information

AN (2000)

Any commercial data that the consignor or exporter needs to specify. NZFSA will not verify this data but will not approve EDs with information known to be untrue. 

<Comment language = "en">
Contract number L90332
</Comment>

Only one Comment element is permitted per ED.

Multiple lines can be displayed by including a carriage return or a \n for each line feed.

Description

Type

Contents

Notes

XML tags

Notes for tags

Start of header 

<batch_request>

…………………

all other tags for the batch file

…………………

</batch_request>

There is a matching tag at the end of the batch file.

Submission and certificate type

<raise_export_certificate>
<Certificate>
...................

all other tags for the certificate
...................
</Certificate>

</raise_export_certificate>

There are matching end tags at the end of the submission.

The submission tags change depending on action required (raise, amend etc)

Form code

AN (254)

Template number

Refers to the template used in the submission

<Form code=”AP120”/>

Requires valid template.

Certificate number

N (6)

Unique serial number within the calendar year used as last component in shoulder number.

<Certificate number = "123456">

Use full shoulder number when using the amend or resubmit methods.

Consignor

AN (10)

Exporter ID

Must be a valid registered exporter ID.

<Consignor identifier = "ELN6000"/>

Importer ID

AN (254)

ID of the overseas importer of the consignment

Enter only if specifically required by OMAR.

<Consignee identifier = "XYZ123"/>

Importer Name

AN (254)

Name of the overseas importer of the consignment

For most export certificates either the name OR address is required. Some OMARs may require both.

<Consignee identifier = "XYZ123">
<Name>Acme Importers</Name>
<Address>126 Queen St

Manchester

UK
</Address>

<Representative>Acme Importers Agents Ltd
</Representative>
</Consignee>

Multiple <Address> tags are not permitted.
Multiple lines can be displayed by including a carriage return in the file. \n does not work in this field.

Leave the <Representative> & </Representative> tags out if not required.

Importer Address

AN (254)

Overseas address of consignee.

For most export certificates either the name OR address is required. Some OMARs may require both.

Importer Representative

AN (254)

Name of agent of the Importer if relevant

May be required by OMAR.

Importing Country

A (2)

Two-letter Country code of export country.

This determines which declarations the system will expect to be in the batch file.

<ImportingCountry>
Country code = "JP"/>

Japan

EU commodity code

 AN

Commodity code declarations are mandatory on EU certificates

EU commodity codes are specified as declarations.

<Subtitle code="4.A-1"/>

The EU Commodity Code is specified as a Certificate. Subtitle Sub-element and not as a declaration.

Official Information

AN (2000)

Additional declarations authorised by NZFSA. 

<OfficialInformation
language = "en">
Replacement of certificate no nnnn dated xx-yy-zz which is lost.
</OfficialInformation>

The attribute language = "en" is required. Multiple lines can be displayed by including a carriage return or a \n for each line feed.

Transport mode

N (1)

1 = Maritime
4 = Air

Transport mode is a required entry on all export certificates. Road and rail are not permitted on export certificates.

<Transport>

<Mode code = "1"/>
<ConveyanceRef>
</ConveyanceRef>
<Carrier>
<Name>Palliser Bay</Name>
</Carrier>
</Transport>

The transport tags must all appear as a block. The description (eg Maritime) is optional.

Carrier name

AN (254)

The vessel name or airline

Name of the vessel, airline or courier.

Conveyance ref

AN (254)

Transport ref (eg voyage or flight no.)

Voyage or flight number.

Loading port

AN (5)

Valid five-letter port code

Any valid NZ port code.

2-letter country code followed by 3-letter port code.

<LoadingPort code = "NZLYT"/>

The description is optional. If a valid port code is entered, it will overwrite whatever is entered as a description.

Port of inspection

AN (5)

Valid five-letter port code

List of country and city codes

City code of port of inspection and release. These may be displayed on E-cert with additional state or country information.

2-letter country code followed by 3-letter city code.

<InspectionPort code = "DEFRA"/>

The description is optional. If a valid port code is entered, it will overwrite whatever is entered as a description.

Discharge port

AN (5)

Valid five-letter port code

List of country and city codes

City code of discharge port. If there is no discharge port code the system will put in this field the same code as the port of inspection.

2-letter country code followed by 3-letter city code.

<DischargePort code = "DEHAM"/>

The description is optional. If a valid port code is entered, it will overwrite whatever is typed as a description.

Final destination

AN (254)

AN (5)

Country required.

City optional depending upon OMAR requirements. Or 2-letter country code followed by 3-letter city code.

<FinalDestination>Los Angeles, United States
</FinalDestination>

5 letter code will convert to city, country format on submission.

Departure date

Date

yyyy-mm-dd

Date of departure from New Zealand port of export.

<Departure>
<Date>2007-06-02</Date>
</Departure>

3rd party access

AN (254)

One or more valid IDs, separated by commas.

Read-only access to the current certificate is granted to all users who can see certificates for the IDs specified here.

<ThirdParty identifier = "ME600"/>
<ThirdParty identifier = "S600"/>

Multiple Third Party premises need to be entered as separate ThirdParty tags.
A comma separated list in the identifier field will give an error.

Unofficial commercial information

AN (2000)

Any commercial information that the exporter wishes to specify.

NZFSA will not verify this data but cannot approve a certificate with known false information in this field.

This field is seen by overseas authorities on the printed certificate but not on E-cert.

<Comment language = "en">
Order number C43434 </Comment>

Only one Certificate Comment element is permitted in any one file.

Multiple lines can be displayed by including a carriage return or a \n for each line feed.

Description

Type

Contents

Notes

XML tags

Notes for XML

Start of product item

Must precede each set of product item fields in the batch file

<Product item = "1">
................
all other tags for the product item
...............
</Product>

All data for any one product is between the start and end Product tags.

Declarations

AN (254)

One or more two-letter declaration category codes separated by commas or single spaces

ED only

Each product item shall have at least one declaration category but there must be enough to support onward certification.

Requirements for export certificate declarations are detailed in Specifying Export Declarations

<Classification>
<Class code="CH"/>
<Type code="DC"/>
</Classification>

Each DC code is specified separately, as Classification Types.

CH=Chilled

DC=Declaration Category

Product description

AN (254)

<Description language="en">Boneless lamb legs\nGigot d'Agneau Desosse</Description>

Multiple lines can be displayed by including a carriage return or a \n for each line feed.

Classification Data

AN (254)

Various

Export only

See individual certificate templates for details of requirements

Some fields must have the information exactly as shown on tables of data associated with the field in the online data entry form, including upper or lower case letters as specified.

Each classification item requires a separate code.

<Classification>
<Class code="Canadian Product  Code">020410508101</Class>
<Type code="CL"/>
</Classification>

Species

AN (254)

Species name

<Species language="en">
Bovine</Species>

<Species language="en">
Ovine &amp; Bovine
</Species>

You cannot use & in XML files, an alternative entity is &amp; see Special Characters

Countries

AN (254)

List of two-letter country-codes

separated by commas

ED only
Each product may have a different set of countries.

Transfers to exporters should only have the country of final destination (ZE for EU is not acceptable).

<Classification>
 <Class code="JP"/>
<Type code="CC"/>
 </Classification>
<Classification>
 <Class code="AU"/>
<Type code="CC"/>
 </Classification>

ED only

Each Product Country code is specified separately, as a Country Code Classification Type.

NZHS Codes

AN (6)

Valid entry from list.

ED only

This HS code is for "Meat”; of bovine animals, boneless cuts, fresh or chilled".

 <Classification>

<Class code="020130"/>

<Type code="NZHSC"/>

</Classification>

HS codes are another type of classification data in XML files.

Container no

AN (254)

Seafreight or airfreight container number.

<Container
number="TRLU123456"
seal="NZFSA12345678">
</Container>

Container number and seal number are both entered within the Container tag.

Leave out the seal= sub-element if it is not needed.

Multiple numbers can be entered separated by commas.

Seal no

AN (254)

NZFSA or, for EDs only, verifiable non-official seals explicitly required by specifications.

Item marks or brands

AN (254)

Format mandated by OMAR for some countries.

<Marks>M123</Marks>
<Marks>12345</Marks>

To display on multiple lines use \n or repeat the Marks element.

Number of packages

N

<Package count = "50">
<Type code = "CT"/>
</Package>

<Package count = "50">
<Type code = "CT"/>
</Package>

Number and type of packages are both entered within the Package tag.

If a valid package type code is entered, it will overwrite whatever is entered as a description

Package type

A (2)

Two letter package type code

Total (gross) weight

N

<Weight value = "3500.00">
<Type code = "AAB"/>
<Unit code = "KGM"/>
</Weight>

Gross weight and Gross Weight Unit are both entered within one instance of the Weight tag.
AAB identifies that this is Gross Weight.

If a weight unit code is used it will override any content in the description.
A separate instance of the tag is required to record Net Weight.

Net weight

N

<Weight value = "180.25">
<Type code = "AAA"/>
<Unit code = “KGM"/>
</Weight>

Net weight and Net Weight Unit are both entered within one instance of the Weight tag.
AAA identifies that this is Net Weight.
A separate instance of the tag is required to record Gross Weight.

Weight unit

A (3)

Three-letter weight unit code

See Gross Weight and Net Weight above.

This product was sourced from

AN (unl)

Source ED and product tracking information. 

This is required if the product has any incoming EDs supporting outward certification.

Format is: shoulder-no, product-no/ no-of-destination-units

There may be multiple product-no/ no-of-destination-units entries per source ED, separated by commas as in the second example.

<Document  number="NZL2001/ME1/4567T" item="2" outQuantity="50">
</Document>
<Document  number="NZL2001/ME1/4567T" item="3" outQuantity="40">
</Document>

A separate set of Document tags is required for each source product reference. This includes the situation where there are multiple products from a single source ED.

outQuantity is the number of outgoing packages that are attributable to the named source ED product item. 

Source EDs that are not on E-cert shall have 'P' in front of the shoulder number.

Comments

AN (4000)

Various

EDs - verifiable product item related data and transfer control declarations.

Export certificates - only comments authorised by NZFSA shall be entered.

See Transfer control declarations for information about those on EDs.

See Shellfish for entry of harvest information.

<Comment>Subject to moist heat at 120 C for 15 minutes.\n Packed into clean containers.</Comment>

Multiple lines can be displayed by including a carriage return or a \n for each line feed.

Description

Type

Contents

Notes

XML tags

Notes for XML

Start of process

<Processing>
............

all other process tags
............
</Processing>

Each set of data is contained within the start and end Processing tags.

Process type

A (3)

Three-letter process type code

For an ED there shall be at least one process added for the consignor. The source certificate processes are automatically carried forward and shall not be repeated unless using the date override facility - see below. 

If the source certificate is not on E-cert, at least one process shall be added for each premises that handled the product and there shall be enough processes to support onward certification.

The Transfer (TRA) process type is used by E-cert for Exporter to Exporter transfers

To see what processes are required for specific export certificates see Available Templates.

<Processing>
<Type code = "SLT"/>
..............
</Processing>

The description (eg Slaughter) is optional. The code will override any content in the description.

Start of processing

Date

yyyy-mm-dd

Start date of process.

Required if the process is slaughter or Expiry Date.

Dates for other processes may be required by OMAR.

<Processing>
<Type code = "SLT"/>
<StartDate>1998-01-10</StartDate>
..............
</Processing>

End of processing 

Date

yyyy-mm-dd

End date of process.

Required if the process is slaughter or Expiry Date.

Dates for other processes may be required by OMAR.

<Processing>
<Type code = "SLT"/>
<StartDate>1998-01-10</StartDate>
<EndDate>1998-01-13</EndDate>
..............
</Processing>

Applied by

AN(10)

Licence ID

Required if the process was applied by a premises other than the consignor.

<Processing>
<Type code = "SLT"/>
<StartDate>1998-01-10</StartDate>
<EndDate>1998-01-13</EndDate>
<Premises identifier = "ME600"/>
</Processing>

Date override

Y/N

Yes or leave blank

Can only be used if there is the same process for the same premises on a source ED. Dates must fall on or between the equivalent source ED dates.

<Processing dateOverride="YES">
<Type code = "SLT"/>
<StartDate>1998-01-10</StartDate>
<EndDate>1998-01-13</EndDate>
<Premises identifier = "ME600"/>
</Processing>

The dateOverride attribute can either be omitted, or set to "NO", if Process Override is not to be applied.

Character

Entity

Character

Entity

Less than symbol (<)

&lt;

Apostrophe symbol (‘)

&apos;

Greater than symbol (>)

&gt;

Ampersand symbol (&)

&amp;

Quote symbol (“)

&quot;

It is extremely important you enter the correct certificate number as E-cert has no way of knowing if you have got it right.

Example 1

<Approval form = "AP1676">

<Declaration code = "AP1676/9">

<Insert order="1">131</Insert>

<Insert order="2">15</Insert>
</Declaration>
</Approval>

Selects declaration 9 from template AP1676 (AP1676/9) and declares 2 user input fields.

Example 2

<Approval form = "AP120">

</Approval>

Will declare all mandatory attestations for template AP120

Example 3

Submission to Training site

<Approval form = "AP1125.2">

<Declaration code = "AP1125.2/4"/>
<Declaration code = "AP1125.2/6"/>
</Approval>

Selects declaration 4 and 6 from template AP1125 version 2.

Description

Type

Contents

XML tags

Notes

Start

<batch_request>

Exhaust ED

AN

The full shoulder number of an approved ED.

<exhaust_eligibility_documents>
<shoulder_number>NZL2002/ME600/2345T</shoulder_number>
</exhaust_eligibility_documents>

The shoulder number and the tags for it must be on the same line in the batch file.

To exhaust multiple EDs, repeat the whole group of tags for each additional shoulder number.

End of batch

</batch_request>

Description

Type

Contents

XML tags

Notes

Start

<batch_request>

Exhaust product item

N

The product item number to be exhausted.

<exhaust_eligibility_document_products>
<shoulder_number>NZL2002/ME600/2345T</shoulder_number>
<product_number>3</product_number>
</exhaust_eligibility_document_products>

<exhaust_eligibility_document_products>
<shoulder_number>NZL2002/ME600/2345T</shoulder_number>
<product_number>4</product_number>
</exhaust_eligibility_document_products>

The shoulder number and the tags for it must be on the same line in the batch file. Also, the product item number and its tags must be on the same line.

To exhaust multiple products on an ED, repeat the whole element group for each additional product number, as shown.

End of batch

</batch_request>