CSV Notes. English and Irish versions are located on this document

Transcription

1 CSV Notes English and Irish versions are located on this document 1

2 Contents CSV Notes... 1 What is a CSV file?... 3 Location of the File Upload Facility in ROS... 4 File Upload - Status messages... 6 Upload Successful... 6 Uploaded file cannot be read... 6 Uploaded file contains Error messages... 8 File Format... 9 Notes:

3 What is a CSV file? The CSV ("Comma Separated Value") file format is often used to exchange data between disparate applications. A CSV file is a specially formatted plain-text file that stores spread sheet or basic database-style information in a very simple format, with one record on each line, and each field within that record separated by a comma. The purpose of this document is to provide a brief guide on the format and use of the Comma Separated Value (CSV) file when making a claim using the Charitable Donations (CDS) File Upload facility on ROS. The File Upload facility allows a customer to prepare their CDS claims offline in a CSV formatted file and then upload the file using the Charitable Donations (CDS) File Upload facility on ROS. This CSV file will adhere to a format specified by Revenue. The template for the CSV file can be found in the ROS Developer Centre under CDS. Once the user uploads the CSV file, ROS will attempt to file the CDS return based on the data in the file. If any issues are encountered with the data, no return will be made and each error encountered will be displayed to the user, up to a maximum of 1,000 errors be returned to the customer. Note: It's important that the individual "records" within a CSV file DO NOT contain commas, as this may break the simple formatting when using the file in another application. 3

4 Location of the File Upload Facility in ROS The File Upload facility can be found in the MyServices section in ROS, under the File a return Section. Select Charitable Donations from the drop down list and then click the Upload Return button to navigate to the File Upload facility. See Figure 1. Figure 1 Navigation button to File Upload screen When the Upload Return button is selected, the customer will be taken to the File Input facility where a customer will be able to choose a CSV file from their local system. This is performed by selecting Add File(s) and then selecting the appropriate CSV file from their local system. After adding a file the customer can the select the Upload File(s) button to submit the file to ROS. See Figure 1. 4

5 Figure 2 File Upload facility screen 5

6 File Upload - Status messages After the customer has submitted their claim they will be brought to an acknowledgement screen which will inform them if their submission was successful or contained errors. Upload Successful If the upload was successful then a message will be displayed to the customer informing them that the upload was successful as seen in Figure 3 below. Figure 3 Upload Successful Uploaded file cannot be read In the event that the file being uploaded cannot be read (corrupted, not fully uploaded, incorrect format), an error will be displayed to the customer informing them that there was a problem. The error will appear in the Upload Status section as seen in Figure 4 below. 6

7 Figure 4 Problem reading uploaded file 7

8 Uploaded file contains Error messages Validation will be performed on each input line in the supplied CSV file. Where a specific donation or bank details line does not pass validation, the customer will be presented with an error message. These error messages will be repeated for all lines that have errors and each line can have multiple errors. These messages will be displayed on the upload screen, allowing the user to correct the file and retry the upload of a file that was found to contain validation errors. See Figure 5 below. Figure 5 Errors while validating the CSV file 8

9 File Format The file needs to be a.csv file. It has 2 line types. The first line type is for Charity Details. The second line type is for Donations. Line 1 of the CSV must only contain the year for which the claim is being made. Field description and rules: Year: This field contains the year for the claim being made Field rules: mandatory, must be 4 numbers, year cannot be greater than 4 years prior, year cannot be the current year or future years, format YYYY The Donation line(s) occur from 1 to 10,000 times and must start on line 2 of the CSV file. Donation lines must be on continuous lines. A Donation line contains the following fields: Name, PPSN, Donation, and Charity Association. Field description and rules: Name: This field contains the name of the donor who made a donation to the charity. Field rules: mandatory, max 70 chars - The allowed characters are listed here: abcdefghijklmnopqrstuvwxyzzABCDEFGHIJKLMNOPQRSTUVWXY ZáéíóúÁÉÍÓÚ PPSN: This field contains the PPSN of the donor who made a donation to the charity. Field rules: mandatory, max 9 chars, valid PPSN no., PPSN can only be included on one line item (cannot have duplicates of a PPSN across multiple lines) Donation: This field contains the amount donated by a person to the charity. Field rules: mandatory, format , cannot be less than 250 and cannot be greater than 1m Charity Association: This field indicates if there is a relationship between the donor and the charity. Field rules: mandatory, max 3 char, must be either Yes or No Notes: File Format: It's important that the individual "records" within a CSV file NOT contain commas, as this may break the simple formatting when using the file in another application. 9

10 Field rules: Any breach of these rules will result in error messages being returned to the customer on screen. 10