Message Mapping
User Data Dictionary
The new EDI Client Registration message will cater for creation of new CCID clients and registration of ABNs in the ICS.
The message will cater for registration of a single CCID or single ABN, not both. The message will only cater for initial registrations/creations. No subsequent amendments will be possible via EDI, users will have to perform amendments using existing UI functionality.
Three EDI messages are required to cater for this new functionality.
- An inbound message for the creation of a CCID/Registration of an ABN.
- Confirmation of successful registration or validation error responses will be contained in the current ERM outbound message.
- An outbound message to cater for notification of Duplicate client details.
| User Message Type | Description | ICS Document Type |
|---|
| Inbound |
|---|
|
CLREG | Client Registration - ABN & CCID | CLREG |
| Outbound |
|---|
|
CLRREGR | Client Registration Response | ERM |
|
CLNTDUP | Client Duplicate Response | CLNTDUP |
All current rules that apply for ABN / CCID registration via ICS Customs Interactive will also apply to the new EDI client registration process.
An ABN will only be able to be registered if it is not already registered in the system.
If an external user is attempting to register a CCID and the name and address details of the new CCID client match to an ABN already registered, but the ABN has a "cancelled" status - allow registration to proceed.
When registering an ABN the Business address will be derived from the lowest numbered valid CAC unless a CAC number is supplied to use a specific Business Address where more then 1 CAC exists.
If a new EDI Registration Request message results in a duplicate client record(s) being found in ICS (100% match on Name and Address details supplied), the creation message will be rejected and details of the matched duplicate record(s) will be returned to the user.
Some examples of business errors will include but not limited to:
- ABN already registered
- User does not contain a valid role to create/register this CCID/ABN
- Invalid Role name
- Invalid ABN
Minimum Data Requirements for CCID / ABN Registration
CCID with a Client Type of individual (IND)
| Family Name |
| Business Address Type |
| Business Address Details |
| Address Line 1 |
| Contact Name |
| Contact Address (max 6 data elements, min 1 data element) |
| Role Names |
CCID with a Client Type of Organisation (ORG)
| Organisation Name |
| Country |
| Business Address type |
| Address Line 1 |
| Contact Name |
| Contact Purpose |
| Contact Address (max 6 data elements, min 1 data element) |
| Roles Name |
ABN Client
| ABN |
| Contact Name |
| Contact Purpose |
| Contact Address ((max 6 data elements, min 1 data element) |
| Role Names |
