Statement Event Notification File
This is an extension file
This file is an extension of the master Event Notification File and is meant to provide additional data points for statement events. A single event will appear in both files and share the same
UserEventId.
Statement Event Notification File Definition
The Statement Event Notification File is created by Helix on an hourly basis. It has the following properties:
- Fixed-length.
- ANSI encoded
- Line endings are Windows-style CarriageReturn + LineFeed (
\r\n, or0x0D0A) - File will be available in the relative directory of
/EventNotification - File name follows a specific, case-sensitive pattern of:
yyyyMMddhhmm_STATEMENTEVENTNOTIFICATION.TXT
Format Disclaimer
Helix reserves the right to append new field(s) to the end of any Header or Content line without notice. This is to allow new data points to be added as needed in a timely fashion.Implementation Note
Your code should be written such that unexpected characters after the "last" field but prior to the end of each line should be ignored. That is, if the file is documented as being 872 bytes per line, receiving a file with 984 bytes per line should not disrupt your processing. This applies to both Header and Content lines.File Name Disclaimer
The date in file name should be used as a guideline for human eyes only. Any date-related programmatic dependencies should rely on theFileCreatedDateorFileEffectiveDatecontained within the header line of each file, as these will be precise to the second and will be in the appropriate timezone.
Header Row
| Property | Data Type (Length) | Alignment | Start Position | Description |
|---|---|---|---|---|
RecordType | string (1) | Left | 1 | The flag for the header row. Will always be H. |
FileName | string (50) | Left | 2 | The name of this request file excluding path. Format: yyyyMMddhhmm_STATEMENTEVENTNOTIFICATION.TXTExample: 201901210939_STATEMENTEVENTNOTIFICATION.TXT |
RecordCount | integer (10) | Right | 52 | The number of records represented within the file. This field is zero-padded on the left side. Example: 0000000872 |
FileCreatedDate | datetime (34) | Left | 62 | The date the file was created. Follows same format as API. Example: 2014-10-20T10:30:31.456-05:00See data format guidelines |
FileEffectiveDate | datetime (34) | Left | 96 | The date to which the data in the file pertains. Follows same format as API. Example: 2014-10-20T09:30:31.456-05:00See data format guidelines |
Content Row
| Property | Data Type (Length) | Alignment | Start Position | Description |
|---|---|---|---|---|
UserEventID | integer (19) | Right | 1 | The unique identifier for an event. Use this field alone to cross reference against the Event Notification File or the Realtime Event sent via Azure Service Bus. This field is zero-padded on the left side. Example: 0000000872 |
CustomerId | integer (10) | Right | 20 | The unique identifier for a customer. This field is zero-padded on the left side. Example: 0000000872 |
AccountId | integer (10) | Right | 30 | The unique identifier for an account. This field is zero-padded on the left side. Example: 0000000872 |
Month | integer (2) | Right | 40 | The two digit month of the statement. Value is 00 for Tax 1099-INT & 1099-MISC events. This field is zero-padded on the left side.Example: 09 |
Year | integer (4) | Right | 42 | The four digit year of the statement. |
NumberOfAccounts | integer (4) | Right | 46 | The number of accounts associated with the customer. This field is zero-padded on the left side. Example: 0003 |
EventTypeId | integer (10) | Right | 50 | The type of event that occurred. Possible values: - 3062: Monthly Statement Available- 3501: Tax 1099-INT Available- 3502: Tax 1099-MISC AvailableThis field is zero-padded on the left side. Example: 0000003062 |
EventDate | string (34) | Left | 60 | The date and time the event was triggered. |
Take me to the Example Statement Event Notification File
Updated about 1 year ago