A new batch job will poll for SARS response files and process them. The following files will be received from SARS:
- Directive Request Validation Response File
- Processed Directives Response File
- Processed Cancellation Response File
A file in the format below will be received in response to directive requests, queries and cancellation requests.
The response file will indicate if a file received passed the validation rules and was accepted for further processing or was rejected and not processed further by the Income Tax System (ITS).
If the received file contains no errors then the header record of the response file will indicate that the file was successful and the trailer record will indicate that no data records exist in the file.
If errors are detected the header record of the response file will indicate that the request file was rejected and error description data records will be included. The trailer record will contain a count of the number of error description records.
Header Record
|
Column Heading |
Size |
Format |
System value / Default value |
Comment |
|
SEC-ID |
1 |
|
H |
|
|
INFO-TYPE |
8 |
N |
IRP3RSP |
|
|
INFO-SUBTYPE |
8 |
|
Blanks |
|
|
TEST-DATA |
1 |
|
Y or N |
Y if it is a test file. N if it is a production file. |
|
FILE-SERIES-CTL |
1 |
|
S |
|
|
EXT-SYS |
8 |
|
Value for Batch Parameter ISP0901 |
Left justified & blank padded. |
|
VER-NO |
8 |
|
3 |
|
|
OWN-FILE-ID |
14 |
|
Value for Batch Parameter TAXDIRREQFILENO |
When the file is created increment the value for the Batch Parameter by 1. |
|
GEN-TIME |
14 |
|
CCYYMMDDhhmmss |
Date and time file is created |
|
RESP-FILE-ID |
14 |
|
RESP-FILE-ID contained in the Tax Directive Request file |
|
|
STATUS |
2 |
|
|
01 – Processed successfully 02 – File totals incorrect 03 – File format error 04 – Duplicate file 05 – Missing file(s) 06 – File size exceeded |
Data Record
|
Column Heading |
Size |
Format |
System value / Default |
Comment |
|
SEC-ID |
1 |
|
E |
|
|
REC-NUM |
8 |
N |
R_SEQUENCE |
If an error was detected in the header record or in the trailer record this field will be left blank |
|
FUND-NUMBER |
11 |
N |
FUND_NUMBER |
Compulsory |
|
KEY |
32 |
A/N |
R_NUMBER |
|
|
ERROR-NO |
5 |
N |
|
|
|
ERROR-TEXT |
65 |
A/N |
RESPONSE_TEXT |
|
Trailer Record
|
Column Heading |
Size |
Format |
System value / Default value |
Comment |
|
SEC-ID |
1 |
|
T |
|
|
REC-NO |
8 |
N |
Number of records in the file |
Zero filled, right-justified. |
The system will find the following:
The Benefit Tax Directive record with a value for R_SEQUENCE equal to the value for REC-NUM in the file and update the RESPONSE_TEXT field with the text in the ERROR-TEXT field.
The Scheme to which the Memberships are linked and the Team to which the Scheme is linked.
The e-mail address for the Team.
An e-mail will be created with the following information:
|
Scheme Code |
(FUND_NUMBER) |
|
Scheme Name |
|
|
Membership Reference Number |
(TAXPAYER_MEMBER_NUMBER) |
|
Member Initials and Surname |
|
|
Income Tax Reference Number |
(INCOME_TAX_REFERENCE_NUMBER) |
|
Error Number |
(ERROR_NO) |
|
Error |
(ERROR_TEXT) |
|
File Number |
(OWN-FILE-ID) |
If there is no value in the REC-NUM field, the system will find the Team to which the Scheme with a Scheme Code equal to the value for FUND-NUMBER is linked.
The system will find the e-mail address for the Team and create an e-mail with the following information:
|
Scheme Code |
(FUND_NUMBER) |
|
Error Number |
|
|
Error Text |
|
|
File Number |
(OWN-FILE-ID) |
A file in the format below will be received in response to processed directive requests, queries and cancellation requests:
Header Record
|
Column Heading |
Size |
Format |
System value / Default value |
Comment |
|
SEC-ID |
1 |
|
H |
|
|
INFO-TYPE |
8 |
N |
IRP3DIRS |
|
|
INFO-SUBTYPE |
8 |
|
Blanks |
|
|
TEST-DATA |
1 |
|
Y or N |
Y if it is a test file. N if it is a production file. |
|
FILE-SERIES-CTL |
1 |
|
S |
|
|
EXT-SYS |
8 |
|
Value for Batch Parameter ISP0901 |
Left justified & blank padded. |
|
VER-NO |
8 |
|
3 |
|
|
OWN-FILE-ID |
14 |
|
Value for Batch Parameter TAXDIRREQFILENO |
When the file is created increment the value for the Batch Parameter by 1. |
|
GEN-TIME |
14 |
|
CCYYMMDDhhmmss |
Date and time file is created |
|
RESP-FILE-ID |
14 |
|
|
|
|
STATUS |
2 |
|
|
|
Processed Directives Response Data Record
|
Column Heading |
Size |
Format |
System value / Default |
Comment |
|
SEC-ID |
1 |
|
R |
|
|
REQ-SEQ-NUM |
20 |
A/N |
R_SEQUENCE |
|
|
APPL-ID |
15 |
N |
DIRECTIVE_APPLICATION_ID |
|
|
IT-AREA |
4 |
A/N |
INCOME_TAX_AREA |
|
|
IT-REF-NO |
10 |
N |
INCOME_TAX_REFERENCE_ NUMBER |
|
|
DIR-ID |
15 |
N |
DIRECTIVE_ID |
|
|
REQ-STATUS |
2 |
A/N |
REQUEST_STATUS |
01 – Application declined 02 – Directive declined 03 – Awaiting approval 04 – Awaiting stop order 05 – Disapproved 06 – In progress 07 – Finalised 08 – Cancelled 09 – Archived 10 – Intermediate interface (awaiting validation) 11 – In progress – Unfinalised Exempt Amount |
|
ISSUE-DATE |
8 |
|
ISSUE_DATE |
CCYYMMDD |
|
VALIDITY-START |
8 |
|
VALIDITY_START_DATE |
CCYYMMDD |
|
VALIDITY-END |
8 |
|
VALIDITY_END_DATE |
CCYYMMDD |
|
GROSS-AMOUNT |
15 |
N |
GROSS_AMOUNT |
|
|
ACCRUAL-DATE |
8 |
|
LUMP_SUM_ACCRUAL_DATE |
CCYYMMDD |
|
TAX-RATE |
2 |
N |
TAX_RATE |
|
|
TAX-FREE-PORTION |
15 |
N |
TAX_FREE_PORTION |
|
|
GROSS-AMOUNT-PAYE |
15 |
N |
PAYE_AMOUNT |
|
|
DEDUCTION-FREQUENCY |
1 |
A/N |
|
Blanks |
|
ALLOWED-CONTRIBUTIONS |
15 |
N |
|
Blanks |
|
APPROVED-DEEMED-REMUNERATION |
13 |
N |
|
|
|
IT88L-REF-NO |
15 |
A/N |
IT88_REFERENCE_NUMBER |
|
|
ASSESSED-TAX-AMOUNT |
15 |
N |
ASSESSED_TAX_AMOUNT |
|
|
PROVISIONAL-TAX-AMOUNT |
15 |
N |
PROVISIONAL_TAX_AMOUNT_1 PROVISIONAL_TAX_AMOUNT_2 PROVISIONAL_TAX_AMOUNT_3 |
|
|
PROVISIONAL-TAX-PERIOD |
6 |
|
PROVISIONAL_TAX_PERIOD_1 PROVISIONAL_TAX_PERIOD_2 PROVISIONAL_TAX_PERIOD_3 |
CCYYNN |
|
VAT-REG-NO |
10 |
N |
VAT_REGISTRATION_NUMBER |
|
|
VAT-AMOUNT |
15 |
N |
VAT_AMOUNT |
|
|
PAYE-REF-NO |
10 |
N |
PAYE_REFERENCE_NUMBER |
|
|
PAYE-AMOUNT |
15 |
N |
PAYE_AMOUNT |
|
Processed Directive Response Error Description Record
|
Column Heading |
Size |
Format |
System value / Default |
Comment |
|
SEC-ID |
1 |
|
E |
|
|
REC-NUM |
8 |
A/N |
R_SEQUENCE |
|
|
KEY |
32 |
A/N |
DIRECTIVE_ID |
|
|
ERROR-NO |
5 |
N |
|
|
|
ERROR-TEXT |
65 |
A/N |
RESPONSE_TEXT |
|
Trailer Record
|
Column Heading |
Size |
Format |
System value / Default value |
Comment |
|
SEC-ID |
1 |
|
T |
|
|
REC-NO |
8 |
N |
Number of records in the file |
Zero filled, right-justified. |
|
GROSS-REM-SUM |
20 |
N |
Aggregate of all GROSS-REM fields in the file |
|
|
GROSS-REM-PAYE-SUM |
20 |
N |
Aggregate of all GROSS-REM-PAYE-SUM fields in the file |
|
|
TAX-FREE-SUM |
20 |
N |
Aggregate of all TAX-FREE-PORTION fields in the file |
|
|
ASSESSED-TAX-AMOUNT-SUM |
20 |
N |
Aggregate of all ASSESSED-TAX-AMOUNT fields in the file |
|
|
PROVISIONAL-TAX-AMOUNT-SUM |
20 |
N |
Aggregate of all PROVISIONAL-TAX-AMOUNT fields in the file |
|
|
VAT-AMOUNT-SUM |
20 |
N |
Aggregate of the VAT-AMOUNT fields in the file |
|
|
PAYE-AMOUNT-SUM |
20 |
N |
Aggregate of the PAYE-AMOUNT fields in the file |
|
|
TAX-RATE-SUM |
16 |
N |
Aggregate of all TAX-RATE fields in the file |
|
The system will find the following:
The Benefit Tax Directive record with a value for R_SEQUENCE equal to the value for REC-NUM in the Processed Directive Response Error Description Record and update the RESPONSE_TEXT field with the text in the ERROR-TEXT field.
The Scheme to which the Membership for which the Directive has been requested is linked and find the Team to which the Scheme is linked.
The e-mail address for the Team.
An e-mail will be created with the Team’s e-mail address and the following information:
|
Scheme Code |
(FUND_NUMBER) |
|
Scheme Name |
(FUND_NAME) |
|
Membership Reference Number |
(TAXPAYER_MEMBER_NUMBER) |
|
Member Initials and Surname |
(TAXPAYER_INITIALS and TAXPAYER_SURNAME) |
|
Income Tax Reference Number |
(INCOME_TAX_REFERENCE_NUMBER) |
|
Error Number |
(ERROR_NO) |
|
Error |
(ERROR_TEXT) |
|
File Number |
(OWN-FILE-ID) |
The system will find the following:
The Benefit Tax Directive record with a value for R_SEQUENCE equal to the value for REC-NUM in the Processed Directive Response Data Record and update the applicable fields as per the table above.
The Scheme to which each of the Membership for each of the Directive responses is linked and find the Team to which the Scheme is linked.
The Teams to which the Schemes are linked.
The e-mail address for the Team and create an e-mail per Scheme with the Team’s e-mail address, the Scheme Code (FUND_NUMBER) and Scheme Name, and a list of the Members with the following information for each directive:
|
Membership Reference Number |
(TAXPAYER_MEMBER_NUMBER) |
|
Member Initials and Surname |
|
|
Income Tax Reference Number |
(INCOME_TAX_REFERENCE_NUMBER) |
|
Directive Number |
(DIR-ID) |
|
Tax Amount |
(GROSS_AMOUNT_PAYE) |
A file in the format below will be received in response to cancellation requests.
Header Record
|
Column Heading |
Size |
Format |
System value / Default value |
Comment |
|
SEC-ID |
1 |
|
H |
|
|
INFO-TYPE |
8 |
N |
IRP3CRQ |
|
|
INFO-SUBTYPE |
8 |
|
Blanks |
|
|
TEST-DATA |
1 |
|
Y or N |
Y if it is a test file. N if it is a production file. |
|
FILE-SERIES-CTL |
1 |
|
S |
|
|
EXT-SYS |
8 |
|
Value for Batch Parameter ISP0901 |
Left justified & blank padded. |
|
VER-NO |
8 |
|
3 |
|
|
OWN-FILE-ID |
14 |
|
Value for Batch Parameter TAXDIRREQFILENO |
When the file is created increment the value for the Batch Parameter by 1. |
|
GEN-TIME |
14 |
|
CCYYMMDDhhmmss |
Date and time file is created |
|
RESP-FILE-ID |
14 |
|
|
|
|
STATUS |
2 |
|
|
|
Cancellation Response Data Record
|
Column Heading |
Size |
Format |
System value / Default |
Comment |
|
SEC-ID |
1 |
|
E |
|
|
REQ-SEQ-NUM |
20 |
A/N |
R_SEQUENCE |
|
|
DIR-ID |
15 |
N |
DIRECTIVE_ID |
|
|
IT-REF-NO |
10 |
N |
INCOME_TAX_REFERENCE_ NUMBER |
|
|
DIR-STATUS |
2 |
A/N |
STATUS |
01 – Application declined 02 – Directive declined 03 – Awaiting approval 04 – Awaiting stop order 05 – Disapproved 06 – In progress 07 – Finalised 08 – Cancelled 09 – Archived 10 – Intermediate interface (awaiting validation) 11 – In progress – Unfinalised Exempt Amount |
|
RESPONSE |
2 |
A/N |
|
01 – Directive cancelled 02 – Directive cannot be cancelled – Directive not finalized 03 – Directive cannot be cancelled – Stop Order adhered to 04 – Directive cannot be cancelled – Cancelled not requested by Directive Requestor fund 05 – Directive cannot be cancelled – Reason for Directive Cancellation not supplied |
|
RESPONSE-TEXT |
253 |
A/N |
RESPONSE_TEXT |
|
Trailer Record
|
Column Heading |
Size |
Format |
System value / Default value |
Comment |
|
SEC-ID |
1 |
|
T |
|
|
REC-NO |
8 |
N |
Number of records in the file |
Zero filled, right-justified. |
The system will:
Update the Benefit Tax Directive record for each Membership in the file.
Find the Scheme to which the Membership is linked and find the Team to which the Scheme is linked.
Find the e-mail address for the Team and create an e-mail per Membership with the following information:
- Scheme Code
- Membership Reference Number
- IT-REF-NO
- DIR_ID
- REQ-STATUS
- RESPONSE
- RESPONSE-TEXT