Customer Beneficiary File
A listing of all customer beneficiaries in Helix for a given program.
Customer File Definition
The Customer Beneficiary File is created by Helix on a monthly basis. It has the following properties:
- Exactly one tab-delimited header line
- Zero or more tab-delimited content lines
- A tab character (
\t, or0x09) embedded in actual text content will be replaced with a space character (" ", or0x20) during file generation - This file is tab-delimited to help reduce the size of file as it may grow considerably over time and possibly contain large sections of empty columns.
- ANSI encoded
- Line endings are Windows-style CarriageReturn + LineFeed (
\r\n, or0x0D0A) - File will be available in the relative directory of
/CustomerBeneficiary - File name follows a specific, case-sensitive pattern of:
yyyyMMddhhmm_CUSTOMERBENEFICIARY.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 having 30 tabs per line, receiving a file with 31 or more 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 (Max Length) | Tab Offset | Description |
|---|---|---|---|
| File Name` | string (50) | 0 | The name of this request file excluding path. Format: yyyyMMddhhmm_CUSTOMERBENEFICIARY.TXTExample: 201410210148_CUSTOMERBENEFICIARY.TXT |
| Record Count | integer (10) | 1 | The number of records represented within the file. This field is zero-padded on the left side. Example: 0000000872 |
| File Created Date | datetime (34) | 2 | The date the file was created. Follows same format as API. Example: 2014-10-20T10:30:31.456-05:00See data format guidelines |
| File Effective Date | datetime (34) | 3 | The date to which the data in the file pertains. Follows same format as API. Example: 2014-10-20T23:59:59.999-05:00See data format guidelines |
Content Row
| Property | Data Type (Max Length) | Tab Offset | Description |
|---|---|---|---|
| Program ID | integer (10) | 0 | The programId property of the customer beneficiary object. |
| Program Name | string (255) | 1 | The programName property of the customer beneficiary object. |
| Product ID | integer (10) | 2 | The productId property of the customer beneficiary object. |
| Customer ID | integer (10) | 3 | The customerId property of the customer beneficiary object. |
| Account ID | integer (10) | 4 | The accountId property of the customer beneficiary object. |
| Account Number | string (255) | 5 | The accountNumber property of the customer beneficiary object. |
| Customer Beneficiary ID | integer (10) | 6 | The customerBeneficiaryId property of the customer beneficiary object. |
| Customer Tag | string (50) | 7 | The tag property of the customer beneficiary object. |
| First Name | string (64) | 8 | The firstName property of the customer beneficiary object. |
| Middle Name | string (64) | 9 | The middleName property of the customer beneficiary object. |
| Last Name | string (128) | 10 | The lastName property of the customer beneficiary object. |
| Legal Name 1 | string (100) | 11 | The legalName1 property of the customer beneficiary object. |
| Legal Name 2 | string (100) | 12 | The legalName2 property of the customer beneficiary object. |
| Tax ID | string (255) | 13 | The taxId property of the customer beneficiary object. |
| Created Date | datetime | 14 | The date the customer beneficiary object was created and its status property set to Initiated. Follows same format as API.Example: 2014-10-20T23:59:59.999-05:00See data format guidelines |
| Address Line 1 | string (100) | 15 | The addressLine1 property of the customer beneficiary object. |
| Address Line 2 | string (100) | 16 | The addressLine2 property of the customer beneficiary object. |
| Address Line 3 | string (100) | 17 | The addressLine3 property of the customer beneficiary object. |
| Address Line 4 | string (100) | 18 | The addressLine4 property of the customer beneficiary object. |
| City | string (50) | 19 | The city property of the customer beneficiary object. |
| State | string (50) | 20 | The state property of the customer beneficiary object. |
| Postal Code | string (50) | 21 | The postalCode property of the customer beneficiary object. |
| Country | string (50) | 22 | The country property of the customer beneficiary object. |
| Email Address | string (256) | 23 | The emailAddress property of the customer beneficiary object. |
| Phone | string (15) | 24 | The phone property of the customer beneficiary object. |
| Distribution Description | string (50) | 25 | The distributionDescription property of the customer beneficiary object. |
| Account Distribution Description | string (50) | 26 | The accountDistributionDescription property of the customer beneficiary object. |
| Beneficiary Type | string (50) | 27 | The beneficiaryType property of the customer beneficiary object. |
| Tax ID Type | string (50) | 28 | The taxIdType property of the customer beneficiary object. |
| Beneficiary Position | integer (10) | 29 | The beneficiaryPosition property of the customer beneficiary object. |
| Distribution Percentage | tinyint (3) | 30 | The distributionPercentage property of the customer beneficiary object. |
| Distribution Type | string (50) | 31 | The distributionType property of the customer beneficiary object. |
Updated about 11 hours ago

