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

Property

Data Type (Max Length)

Tab Offset

Description

FileName

string (50)

0

The name of this request file excluding path.
Format: yyyyMMddhhmm_ARCHIVEDCUSTOMER.TXT
Example: 201410210148_ARCHIVEDCUSTOMER.TXT

RecordCount

integer (10)

1

The number of records represented within the file. This field is zero-padded on the left side.
Example: 0000000872

FileCreatedDate

datetime (34)

2

The date the file was created. Follows same format as API.
Example: 2014-10-20T10:30:31.456-05:00
See data format guidelines

FileEffectiveDate

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:00
See data format guidelines

Content Row

Property

Data Type (Max Length)

Tab Offset

Description

CustomerId

integer (10)

0

The customerId property of the customer object.

AccountId

integer (10)

1

The accountId property of the account object.

FirstName

string (64)

2

The firstName property of the customer object.

MiddleName

string (64)

3

The middleName property of the customer object.

LastName

string (128)

4

The lastName property of the customer object.

Suffix

string (20)

5

The suffix property of the customer object.

BirthDate

datetime (34)

6

The birthDate property of the customer object.

Gender

enum (1)

7

The gender property of the customer object.

Culture

string (50)

8

The culture property of the customer object.

TaxId

string (30)

9

The taxId property of the customer object.

CustomerStatus

string (50)

10

The status property of the customer object.

CreatedDate

datetime (34)

11

The date the customer object was created.

ArchivedDate

datetime (34)

12

The date the status property of the customer object was set to Archived

DeceasedDate

datetime (34)

13

The deceasedDate property of the customer object.

IdVerificationDate

datetime (34)

14

The idVerificationDate property of the customer object.

IdVerificationDocumentsReceivedDate

datetime (34)

15

The date the documents required to verify the customer's identity were received.

DriversLicenseNumber

string (30)

16

The driversLicenseNumber property of the customer object.

DriversLicenseState

string (2)

17

The driversLicenseState property of the customer object.

DriversLicenseIssueDate

datetime (34)

18

The driversLicenseIssueDate property of the customer object.

DriversLicenseExpireDate

datetime (34)

19

The driversLicenseExpireDate property of the customer object.

PassportNumber

string (30)

20

The passportNumber property of the customer object.

PassportCountry

string (5)

21

The passportCountry property of the customer object.

PassportIssueDate

datetime (34)

22

The passportIssueDate property of the customer object.

PassportExpireDate

datetime (34)

23

The passportExpireDate property of the customer object.

EmailAddress

string (255)

24

The emailAddress property of the customer object.

IsSubjectToBackupWithholding

string (1)

25

The isSubjectToBackupWithholding property of the customer object.

IsOptedInToBankCommunication

string (1)

26

The isOptedInToBankCommunication property of the customer object.

IsDocumentsAccepted

string (1)

27

The isDocumentsAccepted property of the customer object.

DocumentsAcceptedDate

datetime (34)

28

The date the customer accepted the bank documents.

IsLocked

string (1)

29

The isLocked property of the customer object.

LockedDate

datetime (34)

30

The lockedDate property of the customer object.

LockedReason

string (255)

31

The lockedReason property of the customer object.

ResidenceLine1

string (100)

32

The addressLine1 property of the address object with type=Residence for this customer.

ResidenceLine2

string (100)

33

The addressLine2 property of the address object with type=Residence for this customer.

ResidenceLine3

string (100)

34

The addressLine3 property of the address object with type=Residence for this customer.

ResidenceLine4

string (100)

35

The addressLine4 property of the address object with type=Residence for this customer.

ResidenceCity

string (50)

36

The city property of the address object with type=Residence for this customer.

ResidenceState

string (2)

37

The state property of the address object with type=Residence for this customer.

ResidencePostalCode

string (50)

38

The postalCode property of the address object with type=Residence for this customer.

ResidenceCountry

string (50)

39

The country property of the address object with type=Residence for this customer.

MailingLine1

string (100)

40

The addressLine1 property of the address object with type=Mailing for this customer.

MailingLine2

string (100)

41

The addressLine2 property of the address object with type=Mailing for this customer.

MailingLine3

string (100)

42

The addressLine3 property of the address object with type=Mailing for this customer.

MailingLine4

string (100)

43

The addressLine4 property of the address object with type=Mailing for this customer.

MailingCity

string (50)

44

The city property of the address object with type=Mailing for this customer.

MailingState

string (2)

45

The state property of the address object with type=Mailing for this customer.

MailingPostalCode

string (50)

46

The postalCode property of the address object with type=Mailing for this customer.

MailingCountry

string (50)

47

The country property of the address object with type=Mailing for this customer.

HomePhone

string (50)

48

The number property of the phone object with type=Home for this customer.

MobilePhone

string (50)

49

The number property of the phone object with type=Mobile for this customer.

OfficePhone

string (50)

50

The number property of the phone object with type=Office for this customer.

CustomField1

string (100)

51

The customerField1 property of the customer object.

CustomField2

string (100)

52

The customerField2 property of the customer object.

CustomField3

string (100)

53

The customerField3 property of the customer object.

CustomField4

string (100)

54

The customerField4 property of the customer object.

CustomField5

string (100)

55

The customerField5 property of the customer object.

LastActivityDate

datetime (34)

56

The lastActivityDate property of the customer object.

ArchivedReason

string (255)

57

The archiveReason selected when /customer/archive was called

AccountNumber

integer (10)

58

The accountNumber property of the account object