Archived Customer Extract File

A listing of all Customers in Helix for a given program that moved to status=Archived during the FileEffectiveDate.

Archived Customer Extract File Definition

The Archived Customer Extract File is created by Helix on a daily 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 /ArchivedCustomer
  8. File name follows a specific, case-sensitive pattern of: yyyyMMddhhmm_ARCHIVEDCUSTOMER.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
FileNamestring (50)0The name of this request file excluding path.
Format: yyyyMMddhhmm_ARCHIVEDCUSTOMER.TXT
Example: 201410210148_ARCHIVEDCUSTOMER.TXT
RecordCountinteger (10)1The number of records represented within the file. This field is zero-padded on the left side.
Example: 0000000872
FileCreatedDatedatetime (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
FileEffectiveDatedatetime (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
CustomerIdinteger (10)0The customerId property of the customer object.
AccountIdinteger (10)1The accountId property of the account object.
FirstNamestring (64)2The firstName property of the customer object.
MiddleNamestring (64)3The middleName property of the customer object.
LastNamestring (128)4The lastName property of the customer object.
Suffixstring (20)5The suffix property of the customer object.
BirthDatedatetime (34)6The birthDate property of the customer object.
Genderenum (1)7The gender property of the customer object.
Culturestring (50)8The culture property of the customer object.
TaxIdstring (30)9The taxId property of the customer object.
CustomerStatusstring (50)10The status property of the customer object.
CreatedDatedatetime (34)11The date the customer object was created.
ArchivedDatedatetime (34)12The date the status property of the customer object was set to Archived
DeceasedDatedatetime (34)13The deceasedDate property of the customer object.
IdVerificationDatedatetime (34)14The idVerificationDate property of the customer object.
IdVerificationDocumentsReceivedDatedatetime (34)15The date the documents required to verify the customer's identity were received.
DriversLicenseNumberstring (30)16The driversLicenseNumber property of the customer object.
DriversLicenseStatestring (2)17The driversLicenseState property of the customer object.
DriversLicenseIssueDatedatetime (34)18The driversLicenseIssueDate property of the customer object.
DriversLicenseExpireDatedatetime (34)19The driversLicenseExpireDate property of the customer object.
PassportNumberstring (30)20The passportNumber property of the customer object.
PassportCountrystring (5)21The passportCountry property of the customer object.
PassportIssueDatedatetime (34)22The passportIssueDate property of the customer object.
PassportExpireDatedatetime (34)23The passportExpireDate property of the customer object.
EmailAddressstring (255)24The emailAddress property of the customer object.
IsSubjectToBackupWithholdingstring (1)25The isSubjectToBackupWithholding property of the customer object.
IsOptedInToBankCommunicationstring (1)26The isOptedInToBankCommunication property of the customer object.
IsDocumentsAcceptedstring (1)27The isDocumentsAccepted property of the customer object.
DocumentsAcceptedDatedatetime (34)28The date the customer accepted the bank documents.
IsLockedstring (1)29The isLocked property of the customer object.
LockedDatedatetime (34)30The lockedDate property of the customer object.
LockedReasonstring (255)31The lockedReason property of the customer object.
ResidenceLine1string (100)32The addressLine1 property of the address object with type=Residence for this customer.
ResidenceLine2string (100)33The addressLine2 property of the address object with type=Residence for this customer.
ResidenceLine3string (100)34The addressLine3 property of the address object with type=Residence for this customer.
ResidenceLine4string (100)35The addressLine4 property of the address object with type=Residence for this customer.
ResidenceCitystring (50)36The city property of the address object with type=Residence for this customer.
ResidenceStatestring (2)37The state property of the address object with type=Residence for this customer.
ResidencePostalCodestring (50)38The postalCode property of the address object with type=Residence for this customer.
ResidenceCountrystring (50)39The country property of the address object with type=Residence for this customer.
MailingLine1string (100)40The addressLine1 property of the address object with type=Mailing for this customer.
MailingLine2string (100)41The addressLine2 property of the address object with type=Mailing for this customer.
MailingLine3string (100)42The addressLine3 property of the address object with type=Mailing for this customer.
MailingLine4string (100)43The addressLine4 property of the address object with type=Mailing for this customer.
MailingCitystring (50)44The city property of the address object with type=Mailing for this customer.
MailingStatestring (2)45The state property of the address object with type=Mailing for this customer.
MailingPostalCodestring (50)46The postalCode property of the address object with type=Mailing for this customer.
MailingCountrystring (50)47The country property of the address object with type=Mailing for this customer.
HomePhonestring (50)48The number property of the phone object with type=Home for this customer.
MobilePhonestring (50)49The number property of the phone object with type=Mobile for this customer.
OfficePhonestring (50)50The number property of the phone object with type=Office for this customer.
CustomField1string (100)51The customerField1 property of the customer object.
CustomField2string (100)52The customerField2 property of the customer object.
CustomField3string (100)53The customerField3 property of the customer object.
CustomField4string (100)54The customerField4 property of the customer object.
CustomField5string (100)55The customerField5 property of the customer object.
LastActivityDatedatetime (34)56The lastActivityDate property of the customer object.
ArchivedReasonstring (255)57The archiveReason selected when /customer/archive was called
AccountNumberinteger (10)58The accountNumber property of the account object
{ "file_type": "tab_delimited" }