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:
- 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
/CustomerFiles - 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 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 |
|---|---|---|---|
FileName | string (50) | 0 | The name of this request file excluding path. Format: yyyyMMddhhmm_ARCHIVEDCUSTOMER.TXTExample: 201410210148_ARCHIVEDCUSTOMER.TXT |
RecordCount | integer (10) | 1 | The number of records represented within the file. Example: 872 |
FileCreatedDate | 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 |
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:00See data format guidelines |
Content Row
| Property | Data Type (Max Length) | Tab Offset | Description |
|---|---|---|---|
| Customer Id | integer (10) | 0 | The customerId property of the customer object. |
| Tag | string (50) | 1 | The tag property of the customer object. |
| First Name | string (64) | 2 | The firstName property of the customer object. |
| Middle Name | string (64) | 3 | The middleName property of the customer object. |
| Last Name | string (128) | 4 | The lastName property of the customer object. |
| Suffix | string (20) | 5 | The suffix property of the customer object. |
| Birth Date | 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. |
| Tax Id | string (30) | 9 | The taxId property of the customer object. |
| Status | string (50) | 10 | The status property of the customer object. |
| Created Date | datetime (34) | 11 | The date the customer object was created. |
| Archived Date | datetime (34) | 12 | The date the status property of the customer object was set to Archived |
| Deceased Date | datetime (34) | 13 | The deceasedDate property of the customer object. |
| ID Verification Date | datetime (34) | 14 | The idVerificationDate property of the customer object. |
| ID Verification Documents Received Date | datetime (34) | 15 | The date the documents required to verify the customer's identity were received. |
| Drivers License Number | string (30) | 16 | The driversLicenseNumber property of the customer object. |
| Drivers License State | string (2) | 17 | The driversLicenseState property of the customer object. |
| Drivers License Issue Date | datetime (34) | 18 | The driversLicenseIssueDate property of the customer object. |
| Drivers License Expire Date | datetime (34) | 19 | The driversLicenseExpireDate property of the customer object. |
| Passport Number | string (30) | 20 | The passportNumber property of the customer object. |
| Passport Country | string (5) | 21 | The passportCountry property of the customer object. |
| Passport Issue Date | datetime (34) | 22 | The passportIssueDate property of the customer object. |
| Passport Expire Date | datetime (34) | 23 | The passportExpireDate property of the customer object. |
| Email Address | string (255) | 24 | The emailAddress property of the customer object. |
| Is Subject To Backup Withholding | string (1) | 25 | The isSubjectToBackupWithholding property of the customer object. |
| Is Opted In To Bank Communication | string (1) | 26 | The isOptedInToBankCommunication property of the customer object. |
| Is Documents Accepted | string (1) | 27 | The isDocumentsAccepted property of the customer object. |
| Documents Accepted Date | datetime (34) | 28 | The date the customer accepted the bank documents. |
| Is Locked | string (1) | 29 | The isLocked property of the customer object. |
| Locked Date | datetime (34) | 30 | The lockedDate property of the customer object. |
| Locked Reason | string (255) | 31 | The lockedReason property of the customer object. |
| Residence Line 1 | string (100) | 32 | The addressLine1 property of the address object with type=Residence for this customer. |
| Residence Line 2 | string (100) | 33 | The addressLine2 property of the address object with type=Residence for this customer. |
| Residence Line 3 | string (100) | 34 | The addressLine3 property of the address object with type=Residence for this customer. |
| Residence Line 4 | string (100) | 35 | The addressLine4 property of the address object with type=Residence for this customer. |
| Residence City | string (50) | 36 | The city property of the address object with type=Residence for this customer. |
| Residence State | string (2) | 37 | The state property of the address object with type=Residence for this customer. |
| Residence Postal Code | string (50) | 38 | The postalCode property of the address object with type=Residence for this customer. |
| Residence Country | string (50) | 39 | The country property of the address object with type=Residence for this customer. |
| Mailing Line1 | string (100) | 40 | The addressLine1 property of the address object with type=Mailing for this customer. |
| Mailing Line 2 | string (100) | 41 | The addressLine2 property of the address object with type=Mailing for this customer. |
| Mailing Line 3 | string (100) | 42 | The addressLine3 property of the address object with type=Mailing for this customer. |
| Mailing Line 4 | string (100) | 43 | The addressLine4 property of the address object with type=Mailing for this customer. |
| Mailing City | string (50) | 44 | The city property of the address object with type=Mailing for this customer. |
| Mailing State | string (2) | 45 | The state property of the address object with type=Mailing for this customer. |
| Mailing Postal Code | string (50) | 46 | The postalCode property of the address object with type=Mailing for this customer. |
| Mailing Country | string (50) | 47 | The country property of the address object with type=Mailing for this customer. |
| Home Phone | string (50) | 48 | The number property of the phone object with type=Home for this customer. |
| Mobile Phone | string (50) | 49 | The number property of the phone object with type=Mobile for this customer. |
| Office Phone | string (50) | 50 | The number property of the phone object with type=Office for this customer. |
| Custom Field 1 | string (100) | 51 | The customerField1 property of the customer object. |
| Custom Field 2 | string (100) | 52 | The customerField2 property of the customer object. |
| Custom Field 3 | string (100) | 53 | The customerField3 property of the customer object. |
| Custom Field 4 | string (100) | 54 | The customerField4 property of the customer object. |
| Custom Field 5 | string (100) | 55 | The customerField5 property of the customer object. |
| Last Activity Date | datetime (34) | 56 | The lastActivityDate property of the customer object. |
| Archive Reason | string (255) | 57 | The archiveReason selected when /customer/archive was called |
| Account Number | integer (10) | 58 | The accountNumber property of the account object |
| Account Id | integer (10) | 59 | The accountId property of the account object |
| Customer Type | string (10) | 60 | Business or Individual |
| Business Legal Name | string (300) | 61 | The businessLegalName property of the customer object |
| DBA | string (200) | 62 | The doingBusinessAs property of the customer object |
| Legal Entity Type | string (100) | 63 | The legalEntityType property of the customer object |
| NAICS Code | string (20) | 64 | The correspondingindustryCode associated with the customer via the customer's industryClassificationCodeId |
| Primary Business Line 1 | string (200) | 65 | The addressLine1 property of the address object with type=PrimaryBusiness for this customer. |
| Primary Business Line 2 | string (200) | 66 | The addressLine2 property of the address object with type=PrimaryBusiness for this customer. |
| Primary Business Line 3 | string (200) | 67 | The addressLine3 property of the address object with type=PrimaryBusiness for this customer. |
| Primary Business Line 4 | string (200) | 68 | The addressLine4 property of the address object with type=PrimaryBusiness for this customer. |
| Primary Business City | string (100) | 69 | The city property of the address object with type=PrimaryBusiness for this customer. |
| Primary Business State | string (100) | 70 | The state property of the address object with type=PrimaryBusiness for this customer. |
| Primary Business Postal Code | string (100) | 71 | The postalCode property of the address object with type=PrimaryBusiness for this customer. |
| Primary Business Country | string (100) | 72 | The country property of the address object with type=PrimaryBusiness for this customer. |
| Tax Mailing Line 1 | string (200) | 73 | The addressLine1 property of the address object with type=TaxFormMailing for this customer. |
| Tax Mailing Line 2 | string (200) | 74 | The addressLine2 property of the address object with type=TaxFormMailing for this customer. |
| Tax Mailing Line 3 | string (200) | 75 | The addressLine3 property of the address object with type=TaxFormMailing for this customer. |
| Tax Mailing Line 4 | string (200) | 76 | The addressLine4 property of the address object with type=TaxFormMailing for this customer. |
| Tax Mailing City | string (100) | 77 | The city property of the address object with type=TaxFormMailing for this customer.. |
| Tax Mailing State | string (100) | 78 | The state property of the address object with type=TaxFormMailing for this customer. |
| Tax Mailing Postal Code | string (100) | 79 | The postalCode property of the address object with type=TaxFormMailing for this customer. |
| Tax Mailing Country | string (100) | 80 | The country property of the address object with type=TaxFormMailing for this customer. |
| Tax Id Type | string (100) | 81 | the taxIdType property of the customer object |
| Residency Status Type | string (200) | 82 | the residencyStatusType property of the customer object |
{
"file_type": "tab_delimited"
}
Take me to the Example Archived Customer Extract File
Updated 10 months ago