API Documentation

Statement Event Notification File

A record of statement properties which tie back to events in the corresponding Event Notification File.

Statement Event Notification File Definition

This file is created by CorePro on an hourly basis. It has the following properties:

  1. Fixed-length. Header row is 129 bytes excluding line endings. Each content row is 94 bytes excluding line endings.
  2. ANSI encoded
  3. Line endings are Windows-style CarriageReturn + LineFeed (\r\n, or 0x0D0A)
  4. File will be available in the relative directory of /EventNotification
  5. File name follows a specific, case-sensitive pattern of: yyyyMMddhhmm_STATEMENTEVENTNOTIFICATION.TXT
  6. Root-relative path on sftp.corepro.io for that file would be: /EventNotification/201809060605_STATEMENTEVENTNOTIFICATION.TXT

Format Disclaimer
Q2 Open 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 the FileCreatedDate or FileEffectiveDate contained 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. Will be named following this pattern:
  1. yyyyMMddhhmm_STATEMENTEVENTNOTIFICATION.TXT
  2. Example: 201901210939_STATEMENTEVENTNOTIFICATION.TXT
RecordCount integer (10) Right 52 The number of records represented within the file.
NOTE: This field is zero-padded on the left side. e.g.: 0000000872
FileCreatedDate datetime (34) Right 62 The date the file was created.
Follows same format as API e.g.: 2014-10-20T10:30:31.456-05:00. See date format details.
FileEffectiveDate datetime (34) Right 96 The date to which the data in the file pertains.
Follows same format as API e.g.: 2014-10-20T23:59:59.999-05:00. See date format details.

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.
NOTE: This field is zero-padded on the left side. e.g.: 0000000872
CustomerId integer (10) Right 20 The unique identifier for a Customer.
NOTE: This field is zero-padded on the left side. e.g.: 0000000872
AccountId integer (10) Right 30 The unique identifier for an Account.
NOTE: This field is zero-padded on the left side. e.g.: 0000000872
Month integer (2) Right 40 The two digit month of the statement.
NOTE: This field is zero-padded on the left side. e.g.: 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.
NOTE: This field is zero-padded on the left side. e.g.: 0003
EventTypeId integer (10) Right 50 The type of event that occurred.
See the following list for all possible values:
  • 3062 : Monthly Statement Available
NOTE: This field is zero-padded on the left side. e.g.: 0000003062
EventDate string (34) Left 60 The date and time the event was triggered on.

Ready to start a conversation?

Email Us