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:

  1. Exactly one tab-delimited header line
  2. Zero or more tab-delimited content lines
  3. A tab character (\t, or 0x09) embedded in actual text content will be replaced with a space character (" ", or 0x20) during file generation
  4. 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.
  5. ANSI encoded
  6. Line endings are Windows-style CarriageReturn + LineFeed (\r\n, or 0x0D0A)
  7. File will be available in the relative directory of /CustomerBeneficiary
  8. 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 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

PropertyData Type (Max Length)Tab OffsetDescription
File Name`string (50)0The name of this request file excluding path.
Format: yyyyMMddhhmm_CUSTOMERBENEFICIARY.TXT
Example: 201410210148_CUSTOMERBENEFICIARY.TXT
Record Countinteger (10)1The number of records represented within the file. This field is zero-padded on the left side.
Example: 0000000872
File Created Datedatetime (34)2The date the file was created. Follows same format as API.
Example: 2014-10-20T10:30:31.456-05:00
See data format guidelines
File Effective Datedatetime (34)3The date to which the data in the file pertains. Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines

Content Row

PropertyData Type (Max Length)Tab OffsetDescription
Program IDinteger (10)0The programId property of the customer beneficiary object.
Program Namestring (255)1The programName property of the customer beneficiary object.
Product IDinteger (10)2The productId property of the customer beneficiary object.
Customer IDinteger (10)3The customerId property of the customer beneficiary object.
Account IDinteger (10)4The accountId property of the customer beneficiary object.
Account Numberstring (255)5The accountNumber property of the customer beneficiary object.
Customer Beneficiary IDinteger (10)6The customerBeneficiaryId property of the customer beneficiary object.
Customer Tagstring (50)7The tag property of the customer beneficiary object.
First Namestring (64)8The firstName property of the customer beneficiary object.
Middle Namestring (64)9The middleName property of the customer beneficiary object.
Last Namestring (128)10The lastName property of the customer beneficiary object.
Legal Name 1string (100)11The legalName1 property of the customer beneficiary object.
Legal Name 2string (100)12The legalName2 property of the customer beneficiary object.
Tax IDstring (255)13The taxId property of the customer beneficiary object.
Created Datedatetime14The 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:00
See data format guidelines
Address Line 1string (100)15The addressLine1 property of the customer beneficiary object.
Address Line 2string (100)16The addressLine2 property of the customer beneficiary object.
Address Line 3string (100)17The addressLine3 property of the customer beneficiary object.
Address Line 4string (100)18The addressLine4 property of the customer beneficiary object.
Citystring (50)19The city property of the customer beneficiary object.
Statestring (50)20The state property of the customer beneficiary object.
Postal Codestring (50)21The postalCode property of the customer beneficiary object.
Countrystring (50)22The country property of the customer beneficiary object.
Email Addressstring (256)23The emailAddress property of the customer beneficiary object.
Phonestring (15)24The phone property of the customer beneficiary object.
Distribution Descriptionstring (50)25The distributionDescription property of the customer beneficiary object.
Account Distribution Descriptionstring (50)26The accountDistributionDescription property of the customer beneficiary object.
Beneficiary Typestring (50)27The beneficiaryType property of the customer beneficiary object.
Tax ID Typestring (50)28The taxIdType property of the customer beneficiary object.
Beneficiary Positioninteger (10)29The beneficiaryPosition property of the customer beneficiary object.
Distribution Percentagetinyint (3)30The distributionPercentage property of the customer beneficiary object.
Distribution Typestring (50)31The distributionType property of the customer beneficiary object.
{ "file_type": "not_finished" }