Version 1.0
Change Since Version 1.0
Element / ChangeDOCuMENT TYPE DEFINITION
The SSIA Annual file should be a well-formed XML document conforming to the Document Type Definition below:
<!DOCTYPE SSIAFile [
<!ELEMENT SSIAFile (QSMDetails, InvestorDetails+)>
<!ATTLISTSSIAFile
formversion( 1 )#REQUIRED
periodstartCDATA#REQUIRED
periodendCDATA#REQUIRED
currency( E )#REQUIRED
language( E | G )#REQUIRED
<!ELEMENTQSMDetails (QSM)>
<!ELEMENTQSM EMPTY>
<!ATTLISTssiaregnumCDATA#REQUIRED
qsmnameCDATA#REQUIRED
surnameCDATA#REQUIRED
firstnameCDATA#REQUIRED
phonenumberCDATA#REQUIRED
<!ELEMENTInvestorDetails (Investor, YTDDetails, SSIATransIn?, SSIATransOut?)>
<!ELEMENTInvestor EMPTY>
<!ATTLISTsurnameCDATA#REQUIRED
firstnameCDATA#REQUIRED
ppsnumberCDATA#REQUIRED
address1CDATA#REQUIRED
address2CDATA#REQUIRED
address3CDATA#IMPLIED
address4CDATA#IMPLIED
address5CDATA#IMPLIED
dateofbirthCDATA#REQUIRED
<!ELEMENTYTDDetails EMPTY>
<!ATTLISTaccountnumCDATA#REQUIRED
sortcodeCDATA#IMPLIED
datecommenceCDATA#REQUIRED
subsytdCDATA#REQUIRED
creditsytdCDATA#REQUIRED
gainsytdCDATA#REQUIRED
withdrawalsytdCDATA#IMPLIED
datematurityCDATA#IMPLIED
datecessationCDATA#IMPLIED taxonmaturity CDATA #IMPLIED
taxoncessationCDATA#IMPLIED
totaltaxCDATA#IMPLIED
<!ELEMENTSSIATransIn EMPTY>
<!ATTLISTistransferredin( true | false )“false”
datetransinCDATA#IMPLIED
transferrerregCDATA#IMPLIED
<!ELEMENTSSIATransOut EMPTY>
<!ATTLISTistransferredout( true | false )“false”
datetransoutCDATA#IMPLIED
]>
NOTES ON ELEMENTS
SSIAFile
The SSIAFile element has the following attributes:
formversion / Numeric, required / Must be equal to “1” for this version of the file format. Will change with each new edition of the form.periodstart / Numeric, required / The Period Start Date will be the start of this year 01/01/2002 or next year 01/01/2003
periodend / Numeric, required / The Period End Date will be the end of this year 31/12/2002 or next year 31/12/2003
currency / E, required / E for Euro
language / E or G, required / E for English, G for Irish
It then consists of one QSMDetails element and one or more InvestorDetails elements.
QSMDetails
The QSMDetails element has no attributes. It consists of a QSM element.
QSM
The QSM element consists of the following attributes:
ssiaregnum / Numeric, required / SSIA QSM Number, length 8, beginning with 848 e.g. 84812345qsmname / Alpha, required / The name of the Qualifying Savings Manager, max 35 chars
surname / Alpha, required / Surname of Accountable/Specified Person (maxlength 13).
firstname / Alpha, required / First Name of Accountable/Specified Person (maxlength 12).
phonenumber / Numeric, required / The Specified Person’s phone number (maxlength 20)
InvestorDetails
The InvestorDetails element has no attributes. Each InvestorDetails element consists of one Investor element, one YTDDetails element, optionally one SSIATransIn element and optionally one SSIATransOut element.
Investor
The Investor element contains the following attributes:
surname / Alpha, required / Specified person’s Surname (max length 35).firstname / Alpha, required / Specified person’s First Name (max length 35).
ppsnumber / AlphaNumeric, required / The Specified Person’s PPS Number(PPS Number- Personal Public Service Number formerly known as Revenue Social Insurance) (length 9).
address1 / AlphaNumeric, required / Line 1 of the full postal address of the specified person being entered. (max length 35)
address2 / AlphaNumeric, required / Line 2 of the full postal address of the specified person being entered. (max length 35)
address3 / AlphaNumeric, optional / Line 3 of the full postal address of the specified person being entered. (max length 35)
address4 / AlphaNumeric, optional / Line 4 of the full postal address of the specified person being entered. (max length 35)
address5 / AlphaNumeric, optional / Line 5 of the full postal address of the specified person being entered. (max length 35)
dateofbirth / Date, required / The Specified Person’s Date of Birth (dd/mm/yyyy)
YTDDetails
The YTDDetails element has the following attributes:
accountnum / Numeric, required / The Bank Account Number of the specified person (max length 20)sortcode / Numeric, optional / The sortcode of the specified person (maxlength 6)
datecommence / Date, required / Enter date of commencement in format dd/mm/yyyy. Date must be between 01/05/2001 and 30/04/2002 (incl).
subsytd / Numeric, required / Enter total amount of subscriptions received from the investor in the annual period (max value €3048). Value 0.00 is acceptable.
creditsytd / Numeric, required / 25% of the value entered as "Total Amount of Subscriptions" or value is Total Credits (Max value €762). Value 0.00 is acceptable.
gainsytd / Numeric, required / Total amount of dividend, gross interest or other amount on the SSIA account in the annual period. (Max Value € 99999999.99, value 0.00 is acceptable)
withdrawalsytd / Numeric, optional / Total amount of withdrawals of funds from the SSIA account in annual period. (Max Value € 99999999.99, value 0.00 is acceptable).
datematurity / Date, optional / Date account matured in dd/mm/yyyy format.
datecessation / Date, optional / Date the SSIA was treated as ceasing in dd/mm/yyyy format.
taxonmaturity / Numeric, optional / Amount of tax due on SSIA treated as maturing. A required field if a value is entered in “Date of Maturity” field. (Max Value € 99999999.99)
taxoncessation / Numeric, optional / Amount of tax due on SSIA treated as ceasing. A required field if a value is entered in “Date of Cessation” field. (Max Value € 99999999.99)
totaltax / Numeric, autopopulated / Amount of total tax paid. (Max Value € 99999999.99, value 0.00 is acceptable)
SSIATransIn
The SSIATransIn element consists of the following attributes:
istransferredin / True or False, required / True if SSIA account has been transferred to you by another qualifying savings manager.datetransin / Numeric, optional / Enter date the SSIA was transferred to your institution, in dd/mm/yyyy format. Only required, when istransferredin is true.
transferrerreg / Numeric, optional / SSIA registration number for the Qualifying Savings Manager who transferred the SSIA. The first 3 digits must be 848 e.g. 84812345(Length 8).
Only required, when istransferredin is true.
SSIATransOut
The SSIATransOut element consists of the following attributes:
istransferredout / True or False, required / True if the SSIA account has been transferred by you to another qualifying savings manager.datetransout / Numeric, optional / Enter date the SSIA was transferred from your institution, in dd/mm/yyyy format.
Only required, when istransferredout is true.
Example
This is an example of a correct SSIA Annual XML file:
<?xml version="1.0" encoding="UTF-8"?>
<SSIAFile formversion="1" periodstart="01/01/2002" periodend="31/12/2002" currency="E" language="E">
<QSMDetails>
<QSM ssiaregnum="84811111" qsmname="An other" surname="Bloggs" firstname="Joe" phonenumber="123454" />
</QSMDetails>
<InvestorDetails>
<Investor surname="Bloggs" firstname="Joe" ppsnumber="1234567t" address1="25 High Street" address2="Dublin City" dateofbirth="07/02/1945" />
<YTDDetails accountnum="01181359" sortcode="933384" datecommence="01/08/2001" subsytd="1234.00" creditsytd="123.00" gainsytd="23.00" withdrawalsytd="2222.00" taxonwithdrawal="511.06" totaltax="511.06" />
<SSIATransIn istransferredin="true" datetransin="01/06/2002" transferrerreg="84811222" />
<SSIATransOut istransferredout="false" />
</InvestorDetails>
<InvestorDetails>
<Investor surname="Jane" firstname="Doe" ppsnumber="1236844" address1="6 Oak Street" address2="Dublin City" dateofbirth="01/01/1971" />
<YTDDetails accountnum="8482111" datecommence="01/01/2002" subsytd="333.00" creditsytd="33.00" gainsytd="3.00" withdrawalsytd="5555.00" datecessation="01/03/2002" taxoncessation="250.00" totaltax="1527.65" />
<SSIATransIn istransferredin="false" />
<SSIATransOut istransferredout="true" datetransout="01/06/2002" />
</InvestorDetails>
</SSIAFile>
- 1 -