Revenue Online Services
Diesel Rebate Claim
Schema Notes
Revenue Online Services
Schema Notes
Diesel Rebate Claim
(Irish Operators)
Last Updated
Document Version
31/10/2013
0.4
Page 1 of 24
Revenue Online Services
Diesel Rebate Claim
Schema Notes
CONTENTS
Contents ................................................................................................................................................................................. 2
0
Document Information .................................................................................................................................................... 3
0.1
Synopsis................................................................................................................................................................. 3
0.2
Change History ...................................................................................................................................................... 3
0.3
Abbreviations used in this Document ..................................................................................................................... 3
0.4
Additional Information ............................................................................................................................................ 3
1
Schema Overview .......................................................................................................................................................... 4
1.1
Supported Functions .............................................................................................................................................. 4
1.2
Schemas ................................................................................................................................................................ 4
1.3
Business Overview ................................................................................................................................................. 4
1.3.1
Diesel Rebate Scheme Processes ................................................................................................................. 4
2
SUBMIT .......................................................................................................................................................................... 5
2.1
Diesel Rebate Claim Request ................................................................................................................................ 5
3
Diesel Rebate Claim Types ............................................................................................................................................ 7
3.1
Declarant Type ....................................................................................................................................................... 7
3.2
Period Type ............................................................................................................................................................ 7
3.3
Licences Type ........................................................................................................................................................ 8
3.3.1
Licence Type .................................................................................................................................................. 9
3.4
Vehicles Type ......................................................................................................................................................... 9
3.4.1
Vehicle Type ................................................................................................................................................ 10
3.5
AdditionalOdometers ............................................................................................................................................ 11
3.6
Odometer ............................................................................................................................................................. 11
3.7
FuelCardPurchases Type .................................................................................................................................... 12
3.7.1
FuelCardPurchase Type .............................................................................................................................. 12
3.8
BulkSupplyPurchases Type ................................................................................................................................. 14
3.8.1
BulkSupplyPurchase Type ........................................................................................................................... 14
3.9
BulkCorrections Type ........................................................................................................................................... 16
3.9.1
Correction Type ............................................................................................................................................ 16
3.10 BankAccount Type ............................................................................................................................................... 18
Appendix 1 – Diesel Rebate Claim Types ............................................................................................................................ 19
Simple Types ................................................................................................................................................................... 19
Appendix 2 – ROS Common Types ..................................................................................................................................... 20
Enumerated Types ........................................................................................................................................................... 20
Appendix 3 – Error Messages .............................................................................................................................................. 21
Appendix 4 – Sample Requests ........................................................................................................................................... 23
Page 2 of 24
Revenue Online Services
Diesel Rebate Claim
Schema Notes
0
DOCUMENT INFORMATION
0.1
Synopsis
This document outlines the Diesel Rebate Claim schema for Irish Operators. It contains all the validation rules,
which must be passed to enable a successful upload onto ROS for a Diesel Rebate Claim.
This is a draft version and may be subject to further changes.
0.2
Change History
Table 1: Change History
Version
Number
0.1
0.2
0.3
0.4
0.3
Section Affected
Section 3.8, Appendix 1,
Appendix 3,
Section 3.1, Appendix 1
Section 3.4.1, 3.5, 3.6
Section 3.3.1, Appendix 1
Date
Initial Revision
Updated after Review
15/08/2013
12/09/2013
Update alphaDRS_70 to alphaDRS_18
Add full path for business validation errors
Update ros:taxtype to rev:RegistrationType
Update Vehicle element, add AdditionalOdometers,
Odometer types
CpcNumber field updated from ros:positive6 to string_255
31/10/2013
Abbreviations used in this Document
Abbreviation
DRS
XML
0.4
Change Description
Description
Diesel Rebate Scheme
eXtensible Mark-up Language
Additional Information
N/A
Page 3 of 24
Revenue Online Services
Diesel Rebate Claim
Schema Notes
1 SCHEMA OVERVIEW
This document contains the element definitions, field & cross-field dependency rules for the Revenue Diesel
Rebate Claim schema. The element descriptions include the following:

Name

Type

Required (in the request)

Description.
o Required data format.
o Restricted data values where appropriate.
o Maximum and minimum values where applicable.
o Dependent elements – other elements that are optional but required in certain circumstances if
other elements are not provided.
The element rules must be fulfilled for Revenue to accept and process the request.
1.1
Supported Functions
The following functions are supported using the Diesel Rebate Claim schema. These map to DRS business
processes as outlined in Section 2 below.

1.2
Submit Claim Return
Schemas
There is one primary schema containing definitions for Diesel Rebate Claim requests and responses. There are
also a number of supporting schemas that have custom types defined. Table 2 below outlines details of these
schemas.
Table 2 Diesel Rebate Claim Schemas
schema.xsd
Namespace
Prefix
N/A
New or
Modified
New
rostypes/schema.xsd
ros:
Existing
Name
File
Diesel Rebate Claim
Requests & Responses
ROS Types
Reference
Section 2
Appendix 2
The new and modified schemas will be made available on the ROS website as part of the Diesel Rebate Scheme
(DRS) software release.
1.3
1.3.1
1.3.1.1
Business Overview
Diesel Rebate Scheme Processes
Submit Diesel Rebate Claim
Third parties can submit a Diesel Rebate Claim through ROS. In order to submit a claim a request must first be
created which adheres to the rules contained within the Diesel Rebate Claim schema. These rules may be
mandatory or optional depending on the type of claim that is to be submitted. For example, if a claim is based on
Fuel Card Purchases alone it will not be required to supply Bulk Supply details within the claim request.
Only one Diesel Rebate Claim may be included in a single Diesel Rebate Claim request.
To notify Revenue of a Diesel Rebate Claim, a DieselRebateClaim request needs to be submitted.
If the Diesel Rebate Claim submission is unsuccessful, i.e. the submission fails validation, a list of Errors will be
returned. See Appendix 3 for more details on error messages. Please note that if validation fails for any of the
submitted data then the entire submission will fail and the Diesel Rebate Claim will not be processed. The
validation error will need to be resolved and the request re-submitted.
Page 4 of 24
Revenue Online Services
Diesel Rebate Claim
Schema Notes
2 SUBMIT
2.1
Diesel Rebate Claim Request
Figure 1 Diesel Rebate Claim request
A Diesel Rebate Claim request contains all of the information required to submit a Diesel Rebate Claim to
Revenue. The request contains a number of mandatory and optional elements. Fields are deemed optional if they
may not always be required on a Diesel Rebate Claim. This will be clearly indicated in the field description. The
attributes/elements of a Diesel Rebate Claim Request are listed below.
Table 3 Diesel Rebate Claim request attributes
formversion
Numeric
Minimum
Value/Length
1
product
Text Characters
1
20
Y
IsAmendment
ros:boolean
1
1
Y
Name
Type
Maximum
Value
1
Required
(Y/N)
Y
Description / Validation
Version of the form
Form version must be 1
The name of the software or software
company used to generate the return.
Flag to identify whether this is an amendment
of an original claim.
Table 4 Diesel Rebate Claim request elements
Name
Required
(Y/N/C)
Type
Declarant
Declarant
Y
Period
Period
Y
Description / Validation
The person/entity who is submitting the claim. Information is
required on the tax reference number and tax type of the
person/entity who is submitting the form to determine
whether they are permitted to submit Diesel Rebate Claims.
See Section 3.1 below for details.
The period of the claim. Claims may be submitted on a
quarterly basis per year. The period will contain a start date
and end date to determine the period of the claim.
Page 5 of 24
Revenue Online Services
Diesel Rebate Claim
Schema Notes
Name
Required
(Y/N/C)
Type
Licences
Licences
Y
Vehicles
Vehicles
N
Description / Validation
See Section 3.2 below for details.
A list of Transport Operator Licences that is associated with
the claim.
See Section 3.3 below for details.
A list of Vehicles that is associated with the claim.
Optional
FuelCardPurchases
FuelCardPurchases
C
BulkSupplyPurchases
BulkSupplyPurchases
C
BulkCorrections
BulkCorrections
N
See Section 3.4 below for details.
A list of Fuel Card Purchases that is associated with the
claim.
Conditional
At lease one of FuelCardPurchases or
BulkSupplyPurchases is required on the claim.
See Section 3.5 below for details.
A list of Bulk Supply Purchases that is associated with the
claim.
Conditional
At lease one of FuelCardPurchases or
BulkSupplyPurchases is required on the claim.
See Section 3.6 below for details.
A list of Bulk Corrections required for previously claimed
Bulk Supply Purchases.
A maximum of one claim correction can be included per
previous claim period.
Optional
BankAccount
BankAccount
N
See Section 3.7 below for details.
Details of a Bank Account including IBAN, BIC and account
holder name.
Optional
Not mandatory on the schema but will be required to pass
validation for the initial phase of the project.
See Section 3.8 below for details.
Page 6 of 24
Revenue Online Services
Diesel Rebate Claim
Schema Notes
3 DIESEL REBATE CLAIM TYPES
3.1
Declarant Type
Figure 2 Declarant Type
The Declarant Type contains details on the declarant who is filing the claim. It includes details of the Tax type and
tax number of the person making the claim. The tax type is limited to one of the following tax types: PREM, VAT,
IT, CT, CGT, DWT, DIRT, IUT, ELEVY, RCT, VAT E-SERV, VIES, PAYE. The tax number must be a valid tax
number for the declared tax type.
Table 5 Declarant Elements
Name
Type
Required
(Y/N)
Description / Validation
TaxType
Rev:RegistrationType
Y
Tax Type, limited to one of PREM, VAT, IT, CT, CGT, DWT,
TaxReferenceNumber
ros:registration
Y
DIRT, IUT, ELEV, RCT, EVAT, VIES, PAYE
3.2
The tax registration number. Must match one of the following
regular expressions.
[0-9]{7,8}[A-Wa-w][A-ITWXZa-itwxz ]
[0-9]{5}[A-Wa-w]
[7-9][A-Wa-w][0-9]{5}[A-Za-z]
[0-9]{5,8}
[0-9]{1,2}[A-Za-z][0-9]{5}[A-Za-z]
Period Type
Figure 3 Period Type
The Period Type contains details of the period for which the claim is being submitted. Periods are quarterly and
contain a start date and end date to identify the period. The periods that may be available to file for are:

Quarter 1: Jan 1 – March 31

Quarter 2: April 1 – June 30

Quarter 3: July 1 – Sept 30

Quarter 4: Oct 1 – Dec 31
st
st
st
st
st
th
th
st
Table 6 Period Elements
Name
Type
Required
(Y/N/C)
Description / Validation
StartDate
ros:date
Y
The start date of the filing period.
EndDate
ros:date
Y
Must be in the format DD/MM/YYYY
The end date of the filing period.
Must be in the format DD/MM/YYYY
Page 7 of 24
Revenue Online Services
Diesel Rebate Claim
3.3
Schema Notes
Licences Type
Figure 4 Licences Type Elements
The Licences type contains a list of Transport Operator Licences that are applicable to the claim. At least one Licence
must be included on the claim, up to a maximum of 6 per claim. The same licence may not be added more than once as
all Licences included on the claim should be unique.
Table 7 Licences Type Elements
Name
Licence
Type
Licence
Required
(Y/N)
Y
Description / Validation
List of Licence types associated with the claim. A Diesel Rebate
Claim can contain 1-6 Licences.
Each Licence must be unique
Page 8 of 24
Revenue Online Services
Diesel Rebate Claim
3.3.1
Schema Notes
Licence Type
Figure 5 Licence Type
The Licence Type contains information on the Transport Operator Licences for which the Diesel Rebate Claim is being
filed. A Licence will consist of a Transport Operator Licence number and an associated Transport Manager CPC number.
Table 8 Licence Elements
Name
Require
d (Y/N)
Type
LicenceNumber
ros:positive9
Description / Validation
The Transport Operator’s Licence Number.
Y
This is a numeric field
CpcNumber
string_255
Min length 1 - Max length 9
The Certificate Of Professional Competence (CPC) Number of
the Transport Manager who is associated with the licence.
Y
This is an alphanumeric field
Min length 1 - Max length 255
3.4
Vehicles Type
Figure 6 Vehicles Type
The Vehicles type contains a list of qualifying vehicles that are listed against their Transport Operator Licences that are
applicable to the claim. At least one Vehicle must be included on the claim, up to a maximum of 2000 per claim. Only
Vehicles for which a claim is being made should be included. The same vehicle may not be added more than once as all
Vehicles included on the claim should be unique.
Table 9 Vehicles Elements
Name
Vehicle
Type
Vehicle
Required
(Y/N)
Y
Description / Validation
List of Vehicle types associated with the claim. A Diesel Rebate
Claim can contain 1-2000 Vehicles.
Each Vehicle must be unique
Page 9 of 24
Revenue Online Services
Diesel Rebate Claim
3.4.1
Schema Notes
Vehicle Type
Figure 7 Vehicle Type
The Vehicle Type will contain information on the Vehicle whose fuelling details the user is claiming an auto-diesel rebate
against. This will include the vehicle registration number, the beginning and end value of the odometer, the volume of
auto-diesel purchased by fuel card that is being claimed and the volume of auto-diesel purchased by bulk supply that is
being claimed.
Table 10 Vehicle Elements
Name
VehicleReg
Type
alpha12AllRos
Requir
ed
(Y/N)
Description / Validation
Y
The Vehicle Registration Number.
This is an alphanumeric field. Allowed characters are [a-zA-Z
1234567890 /\-'@;:£€ \. \* \( \) &áéíóúÁÉÍÓÚ]*
OdometerBegin
positive8
Y
Min length 1 - Max length12
Odometer reading for vehicle at the start of the return period (in
Kilometres)
This is a numeric field
OdometerEnd
positive8
Y
Minimum Value = 0, Maximum Value = 10000000
Odometer reading for vehicle at the end of the return period (in
Kilometres)
This is a numeric field
AdditionalOdometers
AdditionalOdometers
N
FuelCard
positiveDec7
Y
Minimum Value = 0, Maximum Value = 10000000
To be used where an odometer has been cycled or replaced
during the period.
This is an optional field
Volume of auto-diesel (in litres) purchased by fuel card that is
being claimed for the vehicle.
This is a decimal field
BulkSupply
positiveDec7
Y
Minimum Value = 0, Maximum Value = 1000000.00
Volume of auto-diesel used from bulk supply that is being
claimed for the vehicle
This is a decimal field
Minimum Value = 0, Maximum Value = 1000000.00
Page 10 of 24
Revenue Online Services
Diesel Rebate Claim
3.5
Schema Notes
AdditionalOdometers
Figure 8 AdditionalOdometers type
The AdditionalOdometers type contains a list of additional Odometer readings to be used where an Odometer has
been cycled or replaced during the period. A maximum of 5 additional Odometer readings may be included in the
AdditionalOdometers type.
Table 11 AdditionalOdometers elements
Name
OdometerBegin
Type
positive8
Requir
ed
(Y/N)
Y
Description / Validation
Odometer reading for vehicle at the start of the return period (in
Kilometres)
This is a numeric field
OdometerEnd
positive8
Y
Minimum Value = 0, Maximum Value = 10000000
Odometer reading for vehicle at the end of the return period (in
Kilometres)
This is a numeric field
Minimum Value = 0, Maximum Value = 10000000
3.6
Odometer
Figure 9 Odometer Type
An Odometer type contains the start and end values for an additional odometer.
Table 12 Odometer elements
Name
Odometer
Type
Odometer
Requir
ed
(Y/N)
Description / Validation
Y
An Odometer reading for a cycled or replaced odometer
A maximum of 5 Odometer’s may be added
Page 11 of 24
Revenue Online Services
Diesel Rebate Claim
3.7
Schema Notes
FuelCardPurchases Type
Figure 10 FuelCardPurchases Type
The FuelCardPurchases type is used to capture the purchase details for each fuel card that the user is claiming an autodiesel rebate against. The FuelCardPurchases type is not mandatory but at lease one of FuelCardPurchases or
BulkSupplyPurchases must be included on a claim.
Table 13 FuelCardPurchases Type
Name
Type
FuelCardPurchase
FuelCardPurchase
Required
(Y/N)
Y
Description / Validation
List of Fuel Card Purchases associated with the claim. At least 1
Fuel Card Purchase must be included in the list, up to a
maximum of 1000.
The Fuel Card number of each Fuel Card Purchase in the list
must be unique.
3.7.1
FuelCardPurchase Type
Figure 11 FuelCardPurchase type
The FuelCardPurchase Type contains the details of each individual Fuel Card purchase. This includes the fuel card
number that was used in the purchase, the amount of auto-fuel purchased and the amount of auto-fuel purchased that
qualifies for the claim.
Table 14 FuelCardPurchase Type
Name
FuelCardNumber
Type
positive19_16
Require
d (Y/N)
Y
Description / Validation
The Fuel Card number.
This is a numeric field
AmountPurchased
positiveDec8
Y
Min length 16 - Max length 19
Total amount of fuel volume (in litres) purchased by the
specified fuel card for the period.
Page 12 of 24
Revenue Online Services
Diesel Rebate Claim
Name
Schema Notes
Type
Require
d (Y/N)
Description / Validation
This is a numeric field
AmountClaimed
positiveDec8
Y
Values can range from 0 to 10000000.00
Total amount of fuel volume (in litres) purchased for the period
on the specified fuel card that qualifies for a rebate and is being
claimed
This is a numeric field
Values can range from 0 to 10000000.00
Page 13 of 24
Revenue Online Services
Diesel Rebate Claim
3.8
Schema Notes
BulkSupplyPurchases Type
Figure 12 BulkSupplyPurchases Type
The BulkSupplyPurchases Type is used to capture the purchase details for each bulk supply purchase that the user is
claiming an auto-diesel rebate against. The BulkSupplyPurchases type is not mandatory but at lease one of
BulkSupplyPurchases or FuelCardPurchases must be included on a claim.
Table 15 BulkSuplyPurchases Type
Name
Type
BulkSupplyPurchase
BulkSupplyPurcha
se
Required
(Y/N)
Y
Description / Validation
List of Bulk Supply Purchases associated with the claim. At least
1 Bulk Supply Purchase must be included in the list, up to a
maximum of 1000.
The combination of Excise Licence number, Invoice and
Delivery Date for each Bulk Supply Purchase in the list must be
unique.
3.8.1
BulkSupplyPurchase Type
Figure 13 BulkSupplyPurchase Type
The BulkSupplyPurchase type contains the details of each individual bulk supply purchase. Each bulk supply purchase
will include the excise licence number of the supplier, the purchase invoice, the date of delivery, the amount of auto-fuel
purchased and the amount of auto-fuel purchased that qualifies for the claim.
Name
ExciseLicence
Type
ExciseLicenceType
Require
d (Y/N)
Y
Description / Validation
The excise licence number of the bulk supply supplier
This is an alphanumeric field
Invoice
alphaDRS_25
Y
ExciseLicence should be in the format [a-zA-Z0-9]{5,14}
Invoice number for the bulk supply purchase.
This is an alphanumeric field
Invoice should be in the format
[a-zA-Z, 0-9ÁÉÍÓÚáéíóú\-/&\.\(\)'*]*
Page 14 of 24
Revenue Online Services
Diesel Rebate Claim
Name
Schema Notes
Type
Require
d (Y/N)
Description / Validation
Maximum length of 25 characters
DeliveryDate
ros:date
Y
Date of the bulk supply delivery
AmountPurchased
positive9_2000
Y
Must be in the format DD/MM/YYYY
Total amount of fuel volume purchased (in litres)
This is a numeric field
AmountClaimed
positive9_1
Y
Minimum value is 2000, maximum value is 100000000
Total amount of fuel volume (in litres) that a rebate is being
claimed for.
This is a numeric field
Minimum value is 1, maximum value is 100000000
Page 15 of 24
Revenue Online Services
Diesel Rebate Claim
3.9
Schema Notes
BulkCorrections Type
Figure 14 BulkCorrections Type
The BulkCorrections Type is used to capture the correction details for bulk supply purchases previously claimed, and
subsequently used in a non qualifying manner under the diesel rebate scheme. Bulk corrections may be made for a
previous period within 12 months of the currently selected claim period with a maximum of one correction being allowed
per period.
Table 16 BulkCorrections Type
Name
Type
BulkCorrection
BulkCorrection
Required
(Y/N)
Y
Description / Validation
List of Bulk Corrections associated with the claim. A maximum
of one claim correction can be included per previous claim
period.
Up to 4 previous periods may be included on a claim (limited to
periods starting from the 1st of July 2013)
Each period included must be unique
3.9.1
Correction Type
Figure 15 Correction Type
The Correction Type contains details of a bulk supply correction for a previous period. This includes the period for which
the correction applies and the amount that was over-claimed in that period.
Table 17 Correction Type
Name
Type
Require
d (Y/N)
Period
Period
Y
AmountOverClaimed
positive9_1
Y
Description / Validation
The period of the claim. The period will contain a start date and
end date to determine the period of the claim.
See Section 3.2 for details.
Volume (in litres) over claimed in previous period.
Page 16 of 24
Revenue Online Services
Diesel Rebate Claim
Name
Schema Notes
Type
Require
d (Y/N)
Description / Validation
This is a numeric field
Values can range from 1 to 100000000
Page 17 of 24
Revenue Online Services
Diesel Rebate Claim
Schema Notes
3.10 BankAccount Type
Figure 16 BankAccount Type
The Bank Account Type is used capture the bank details to which calculated rebate amounts will be paid to.
Table 18 BankAccount Type
Name
IBAN
BIC
AccountHolder
Type
iban
bic
alphaDRS_18
Required
(Y/N)
Description / Validation
Y
IBAN details for account
Y
IBAN must be in the format
[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{4}[0-9]{7}([a-zA-Z0-9]?){0,16}
BIC details for account
Y
BIC must be in the format
[a-zA-Z]{6}([a-zA-Z0-9]{2}|[a-zA-Z0-9]{5})
The account holder name
This is an alphanumeric field between 1 and 18 characters long.
Characters that are allowed include
[a-zA-Z, 0-9ÁÉÍÓÚáéíóú\-/&\.\(\)'*]*
Page 18 of 24
Revenue Online Services
Diesel Rebate Claim
Schema Notes
APPENDIX 1 – DIESEL REBATE CLAIM TYPES
Simple Types
There are a number of simple types used in the Diesel Rebate Claim schema to represent string, integer and
decimal values. See the table below for details on the simple types.
Table 19 Simple Element Type Descriptions
Element
Restriction
ros:string20
String with a maximum length of 20
ros:boolean
ROS Enumerated Type. See Appendix 2
ros:date
Date in format DD/MM/YYYY
ROS Enumerated Type. See Appendix 2
ros:alphaAll
Accepted values for Diesel Rebate Claim are
PREM, VAT, IT, CT, CGT, DWT, DIRT, IUT, ELEV, RCT, EVAT, VIES, PAYE
Should only contain the characters
[a-zA-Z 1234567890 /\-'@;:£€ \. \* \( \) &áéíóúÁÉÍÓÚ]*
ros:positive8
Integer between 0 and 99999999
ros:positive9
Integer between 0 and 999999999
A Tax Reference Number.
rev:RegistrationType
ros:registration
String in the format of one of the following
[0-9]{7,8}[A-Wa-w][A-ITWXZa-itwxz ]?
[0-9]{5}[A-Wa-w]
[7-9][A-Wa-w][0-9]{5}[A-Za-z]
[0-9]{5,8}
[0-9]{1,2}[A-Za-z][0-9]{5}[A-Za-z]
ExciseLicenceType
String in the format [a-zA-Z0-9]{5,14}
positive8
Integer between 0 and 10000000
positive9
Integer between 0 and 100000000
positive9_2000
Integer between 2000 and 100000000
positive9_1
positive19_16
Integer between 1 and 100000000
String in the format [0-9]
Minimum length is 16
Maximum length is 19
positiveDec7
Decimal between 0 and 1000000.00
positiveDec8
Decimal between 0 and 10000000.00
Should only contain the characters
[a-zA-Z, 0-9ÁÉÍÓÚáéíóú\-/&\.\(\)'*]*
Should only contain the characters
[a-zA-Z, 0-9ÁÉÍÓÚáéíóú\-/&\.\(\)'*]*”
Minimum length is 1
Maximum length is 25
Should only contain the characters
[a-zA-Z, 0-9ÁÉÍÓÚáéíóú\-/&\.\(\)'*]*”
Minimum length is 1
Maximum length is 18
alphaDRS
alphaDRS_25
alphaDRS_18
string_255
alpha12AllRos
iban
bic
String with a minimum length of 1, maximum length of 255
Should only contain the characters
[a-zA-Z 1234567890 /\-‘@;:£€ \. \* \( \) &áéíóúÁÉÍÓÚ]*
Minimum length is 1
Maximum length is 12
String in the format
[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{4}[0-9]{7}([a-zA-Z0-9]?){0,16}
String in the format
[a-zA-Z]{6}([a-zA-Z0-9]{2}|[a-zA-Z0-9]{5})
Page 19 of 24
Revenue Online Services
Diesel Rebate Claim
Schema Notes
APPENDIX 2 – ROS COMMON TYPES
Enumerated Types
Table 20 boolean
Input
True
False
Table 21 taxtype
Input
Air Travel Tax
Betting Duty
C&E
CGT
Corporation Tax
DIRT
DWT
Environmental Levy
EU Savings Dir
EVR
Excise
Income Tax
Intrastat
IT38
IUT
LAET
PAYE-Emp
PAYE-Ind
PSWT
RCT
SSIA
Stamp Duty
Transit
VAT
Vat on eServices
VIES
VRT
Other
Page 20 of 24
Revenue Online Services
Diesel Rebate Claim
Schema Notes
APPENDIX 3 – ERROR MESSAGES
The Third Party Diesel Rebate Claim service can respond with business errors based on simple-field or cross-field
validation of input or due to inconsistent data.
The following information may be included in a validation error message

Field Path: A validation message may include the path from the root of the request to the field that
triggered the validation rule i.e. drsClaim.bankDetails.iban

Index: If a validation error occurs within a collection of elements, an index will be used in the field path to
help identify the field that failed. i.e. drsClaim.licences[1].licenceNumber indicates the first licence
element in the request has failed validation

Value: The actual value that failed validation may be included in the validation message. i.e.
drsClaim.licences[1].licenceNumber, Unknown Licence Number (999999999)
The current list of business errors that can be returned include:

No permission to file for this client

No permission to file for this registration

Not Registered for this Tax

The filing period you have entered is invalid. Please enter a quarterly filing period

The deadline for the filing period you have entered has passed.

The filing period you have entered is not available for filing yet

drsClaim.licences[index].licenceNumber, Unknown Licence Number ( {0} )

drsClaim.licences [index]. cpcNumber, The CPC number does not match this Operator Licence according
to Revenue records ( {0} )

drsClaim.licences , A maximum of 6 licences are permitted in a claim

drsClaim.vehicles [index], The vehicle registration number is unknown ( {0} )

drsClaim.vehicles [index], OdometerEnd, Must be greater than or equal to the starting odometer value

drsClaim.vehicles: A maximum of 2000 vehicles are permitted in a claim

drsClaim, Details of Fuel Card Purchases and/or Bulk Supply Purchases must be included in the claim

drsClaim, fuelCardPurchases, A maximum of 1000 fuel card purchases are permitted in a claim

drsClaim, fuelCardPurchases [index],The fuel card is not recognised as an approved card ( {0} )

FuelCardPurchase[index].amountClaimed, Must be less than or equal to the total purchases volume on
this card

drsClaim.fuelCardPurchases, Overall fuel card purchases being claimed ({0} Litres) must match the
summed total specified under vehicle usage ({1} Litres)

drsClaim.bulkPurchases [index], Invalid Excise Licence Number ( {0} )

drsClaim.bulkPurchases [index], Date entered must fall within the claim period ( {0} )

drsClaim.bulkPurchases [index].amountClaimed, Must be less than or equal to the purchased volume

drsClaim.bulkCorrections , A maximum of 4 Corrections are permitted in a claim

drsClaim.bulkCorrections [index], Period not available for automatic corrections please contact Revenue

drsClaim.bulkCorrections [index], The correcting period you have entered is invalid. Please enter a
quarterly filing period

drsClaim.bulkCorrections [index], There are no bulk supply purchases on record for the correcting period

drsClaim.bulkCorrections [index].amountOverClaimed, The over-claimed amount exceeds the volume
originally claimed for correcting period

drsClaim.bankDetails.iban, Invalid IBAN Code
Page 21 of 24
Revenue Online Services
Diesel Rebate Claim
Schema Notes

The diesel rebate claim cannot be processed at this time as you do not have a valid tax clearance
certificate

A claim is on file for this period but it cannot currently be amended on ROS. Please contact your local tax
office to make amendments to the claim
Page 22 of 24
Revenue Online Services
Diesel Rebate Claim
Schema Notes
APPENDIX 4 - SAMPLE REQUESTS
<?xml version="1.0" encoding="UTF-8"?>
<claim:DieselRebateClaim isAmendment="false" product="software product" formversion="1"
xsi:schemaLocation="http://www.ros.ie/schemas/drs/claim/v1/ schema.xsd"
xmlns:claim="http://www.ros.ie/schemas/drs/claim/v1/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<claim:Declarant>
<TaxType>VAT</TaxType>
<TaxReferenceNumber>1234567T</TaxReferenceNumber>
</claim:Declarant>
<claim:Period>
<StartDate>01/07/2013</StartDate>
<EndDate>30/09/2013</EndDate>
</claim:Period>
<claim:Licences>
<claim:Licence>
<LicenceNumber>00001</LicenceNumber>
<CpcNumber>0001</CpcNumber>
</claim:Licence>
<claim:Licence>
<LicenceNumber>00002</LicenceNumber>
<CpcNumber>0002</CpcNumber>
</claim:Licence>
</claim:Licences>
<claim:Vehicles>
<claim:Vehicle>
<VehicleReg>10D99999</VehicleReg>
<OdometerBegin>10000</OdometerBegin>
<OdometerEnd>13000</OdometerEnd>
<FuelCard>400</FuelCard>
<BulkSupply>2000</BulkSupply>
</claim:Vehicle>
<claim:Vehicle>
<VehicleReg>10D99998</VehicleReg>
<OdometerBegin>8500</OdometerBegin>
<OdometerEnd>12000</OdometerEnd>
<FuelCard>450</FuelCard>
<BulkSupply>3000</BulkSupply>
</claim:Vehicle>
</claim:Vehicles>
<claim:FuelCardPurchases>
<claim:FuelCardPurchase>
<FuelCardNumber>9999999999999999999</FuelCardNumber>
<AmountPurchased>300</AmountPurchased>
<AmountClaimed>300</AmountClaimed>
</claim:FuelCardPurchase>
<claim:FuelCardPurchase>
<FuelCardNumber>9999999999999998</FuelCardNumber>
<AmountPurchased>550</AmountPurchased>
<AmountClaimed>550</AmountClaimed>
</claim:FuelCardPurchase>
</claim:FuelCardPurchases>
<claim:BulkSupplyPurchases>
<claim:BulkSupplyPurchase>
<ExciseLicence>999999</ExciseLicence>
<Invoice>12345A</Invoice>
<DeliveryDate>26/07/2013</DeliveryDate>
<AmountPurchased>2000</AmountPurchased>
<AmountClaimed>2000</AmountClaimed>
</claim:BulkSupplyPurchase>
<claim:BulkSupplyPurchase>
<ExciseLicence>999998</ExciseLicence>
<Invoice>23456B</Invoice>
<DeliveryDate>15/08/2013</DeliveryDate>
<AmountPurchased>5000</AmountPurchased>
<AmountClaimed>1000</AmountClaimed>
</claim:BulkSupplyPurchase>
</claim:BulkSupplyPurchases>
<claim:BulkCorrections>
Page 23 of 24
Revenue Online Services
Diesel Rebate Claim
Schema Notes
<claim:Correction>
<claim:Period>
<StartDate>01/04/2013</StartDate>
<EndDate>30/06/2013</EndDate>
</claim:Period>
<AmountOverClaimed>1000</AmountOverClaimed>
</claim:Correction>
</claim:BulkCorrections>
<claim:BankAccount>
<IBAN>IE11IRCE99999999999999</IBAN>
<BIC>AAAAAAAA</BIC>
<AccountHolder>Joe Bloggs</AccountHolder>
</claim:BankAccount>
</claim:DieselRebateClaim>
Page 24 of 24