OCSE Federal Parent Locator Service E-IWO Record Layouts
Electronic Income Withholding Orders Version 3.0
OMB Control No: 0970-0154 Expiration Date: xx/xx/xxxx piration Date: xx/xx/xxxx
Chart D-1 is the Universal Header record layout established for the e-IWO system.
Chart D-2 is the Universal Trailer record layout established for the e-IWO system.
Chart D-3 is the e-IWO Detail record layout established for the e-IWO system.
Chart D-4 is the e-IWO Acknowledgment record layout established for the e-IWO system.
Chart D-5 is the Summary of Changes for this Version 3.0.
The Paperwork Reduction Act of 1995
This information collection and associated responses are conducted in accordance with 45 CFR 303.100 of the Child Support Enforcement Program. The IWO form is designed to provide uniformity and standardization. Public reporting for this collection of information is estimated to average two to five minutes per response. An agency may not conduct or sponsor, and a person is not required to respond to, a collection of information unless it displays a currently valid OMB control number.
Chart D-1: Universal Header (File And Batch)
|
||||||
Element Name |
Definition |
Location |
Length |
Type |
Req./ Opt. |
Data Element Rules |
Document Code |
A code that indicates whether the header is for a file or a batch and the type of record that follows. |
1-3 |
3 |
A |
R |
Required for all headers. First two characters indicate header type. FH always indicates a file header. BH always indicates a batch header. Third character indicates the record type. The record types are: A – Acknowledgment: file sent from an employer to a state (FHA, BHA) I – IWO Detail: file sent from a state to an employer (FHI, BHI) K – Acknowledgment Result: file sent from the Portal to an employer (FHK, BHK). Used by the Portal. S – IWO Result: file sent from the Portal to a state (FHS, BHS). Used by the Portal. |
Control Number |
An identifier assigned by the state, tribe, or territory, employer or payroll processor that uniquely identifies a file or group of records in a batch. |
4-25 |
22 |
A/N |
R |
Required for all headers. A unique, alphanumeric element that identifies a specific file or a batch within a file. You cannot reuse previously submitted control numbers. The file header (FH) will have a unique control number to identify a file. The state must assign a unique control number for each employer batch (BHI) contained in a file. Recommended format: 5 Digit Locator – 21000 (two-digit state Locator Code number followed by three zeroes) Date – YYMMDD Time – HHMMSS Sequence # – 0000 For acknowledgments, employers may enter an identifier of their choosing. Leading or embedded spaces not allowed. |
State Locator Code
|
The state/tribe/territory Locator Code. Formerly known as FIPS code. |
26-30 |
5 |
A/N |
CR |
Format: 21000 (two-digit state Locator Code number followed by three zeroes) IWO detail sent by states: FHI – Required – Input own Locator Code BHI – Required – Input own Locator Code Acknowledgment sent by an employer or its payroll processor: FHA – Fill with spaces BHA – Required – Input state, tribe, or territory for which the batch is intended. |
EIN Text |
The Employer’s Identification Number (EIN). |
31-39 |
9 |
A/N |
CR |
IWO Detail sent by states: FHI – Fill with spaces BHI – Required – Employer FEIN Acknowledgment sent by employers: FHA – Required – Employer FEIN BHA – Required – Employer FEIN Acknowledgment sent by the primary employer with multiple FEINs or third party: FHA – Fill with spaces BHA – Optional – Can input primary FEIN Acknowledgment sent to states: FHA – Fill with spaces BHA – Employer FEIN |
Primary EIN Text |
The federal EIN of the parent company processing IWOs for its subsidiaries or a third party processing IWOs for an employer. |
40-48 |
9 |
A/N |
CR |
Acknowledgment sent by an employer with one FEIN: FHA – Fill with spaces BHA – Fill with spaces Acknowledgment sent by the primary employer with multiple FEINs or a third party processor: FHA – Required – Input primary FEIN BHA – Required – Input primary FEIN IWO Detail sent by states: FHI – Fill with spaces BHI – Fill with spaces Acknowledgment sent to states: FHA – Fill with spaces BHA – Fill with spaces |
Creation Date |
The date the header was generated. |
49-56 |
8 |
A/N |
R |
Required for all headers. Must be a valid date in CCYYMMDD format. |
Creation Time |
The time the header was generated. |
57-62 |
6 |
A/N |
R |
Required for all headers. Must be a valid time in HHMMSS format. |
Error Field Name Text |
The list of fields that did not pass the e-IWO edits. |
63-80 |
18 |
A/N |
O |
Used only by the Portal to return the abbreviated Version 3.0 of field names in error. Each code will be separated by a comma. Valid values: CDT – Creation date CNM – Control number CTM – Creation time DOC – Document code DUP – File already received EIN – EIN text FPS – State Locator Code PPE – Payroll processor EIN text |
Filler FHI and BHI FHA and BHA FHS and BHS FHK and BHK |
IWO Detail Acknowledgment IWO Result Acknowledgment Result |
81 |
Varies 2326 493 2326 493 |
A/N |
O |
The filler length varies based on the file it is associated with. |
Chart D-2: Universal Trailer (File And Batch)
|
||||||
Element Name |
Definition |
Location |
Length |
Type |
Req./ Opt. |
Data Element Rules |
Document Code |
A code that indicates whether the trailer is for a file or a batch and the type of records. |
1-3 |
3 |
A |
R |
Required for all trailers. First two characters indicate trailer type. FT always indicates a file trailer; BT always indicates a batch trailer. The third character indicates the record type. The record types are: A – Acknowledgment: file sent from an employer to a state (FTA, BTA). I – IWO Detail: file sent from a state to an employer (FTI, BTI). K – Acknowledgment Result: file sent from the Portal to an employer (FTK, BTK). Used by the Portal. S – IWO Result: file sent from the Portal to a state (FTS, BTS). Used by the Portal. |
Control Number |
An identifier assigned by the state, tribe, or territory that uniquely identifies a file or group of records in a batch. |
4-25 |
22 |
A/N |
R |
Required for all trailers. A unique, alphanumeric element that identifies a specific file or a batch within a file. This must be the same number specified in the corresponding file or batch header control number. |
Batch Count |
Indicates the number of batches contained in the file. |
26-30 |
5 |
N |
R |
Used with file trailers (FTA, FTI, FTK, and FTS). Zero fill if batch trailers (BTA, BTI, BTK, and BTS). |
Record Count |
Indicates the number of records contained in a batch. |
31-35 |
5 |
N |
R |
Used with batch trailers (BTA, BTI, BTK and BTS). Zero fill if file trailers (FTA, FTI, FTK, and FTS). |
Employer Sent Count |
Indicates the number of valid records sent to an employer after the editing process. |
36-40 |
5 |
N |
CR |
Used for the IWO Results file (BTS). Only used by the Portal. Always fill with zeroes. |
State Sent Count |
Indicates the number of valid records sent to a state after the editing process. |
41-45 |
5 |
N |
CR |
Used for the Acknowledgment Results file (BTK). Only used by the Portal. Always fill with zeroes. |
Error Field Name Text |
The list of fields that did not pass the e-IWO edits. |
46-63 |
18 |
A/N |
O |
Used only by the Portal to return the abbreviated Version 3.0 of field names in error. Each code will be separated by a comma. Valid Values: BCT – Batch Count field CNM – Control Number field DOC – Document Code field RCT – Record Count field REC – Invalid file structure |
Filler FTI and BTI FTA and BTA FTS and BTS FTK and BTK |
IWO Detail Acknowledgment IWO Result Acknowledgment Result |
64 |
Varies 2343 510 2343 510 |
A/N |
O |
The filler length varies based on the file that it is associated with. |
Chart D-4: e-IWO Acknowledgment Record
|
||||||
Element Name |
Definition |
Location |
Length |
Type |
Req./ Opt. |
Data Element Rules |
Document Code |
Indicates the acknowledgment record follows. |
1-3 |
3 |
A/N |
R |
Value must be ‘ACK.’ |
Document Action Code |
Indicates the type of document. |
4-6 |
3 |
A/N |
R |
Valid Values: AMD – Amended: The value input by the state, tribe, or territory (pos. 7-9 in the Detail Record). EMP – Employer Initiated: The value input
by the employer to inform the state, tribe, or territory about
an action that has or will be initiated by them. Use ‘EMP’
with the following values in the Record Disposition Status Code
(pos. 154-155). LUM – Lump Sum: The value input by the state, tribe, or territory (pos. 7-9 in the Detail Record). ORG – Original: The value input by the state, tribe, or territory (pos. 7-9 in the Detail Record). TRM – Termination: The value input by the state, tribe, or territory (pos. 7-9 in the Detail Record). |
Case ID |
A value assigned by a state to uniquely identify each IV-D case in the state. |
7-21 |
15 |
A/N |
R |
The Case ID input by the state (pos. 88-102 in the Detail Record). |
EIN Text |
The employer/ |
22-30 |
9 |
N |
R |
Required field follows Length and Type instructions. |
Employee Last Name |
Obligor’s last name. |
31-50 |
20 |
A/N |
R |
Letters A-Z or spaces. No special characters except periods (.), hyphens (-), apostrophes (’), or embedded spaces are allowed. The first character must not be a space. |
Employee First Name |
Obligor’s first name. |
51-65 |
15 |
A/N |
R |
Letters A-Z or spaces. No special characters except periods (.), hyphens (-), apostrophes (’), or embedded spaces are allowed. The first character must not be a space. |
Employee Middle Name |
Obligor’s middle name or initial. |
66-80 |
15 |
A/N |
O |
Letters A-Z or spaces. No special characters except periods (.), hyphens (-), apostrophes (’), or embedded spaces are allowed. The first character must not be a space. |
Employee Name Suffix |
Obligor’s name suffix. |
81-84 |
4 |
A/N |
O |
Optional field follows Length and Type instructions. |
Employee SSN |
Obligor’s Social Security number. |
85-93 |
9 |
N |
R |
Required field follows Length and Type instructions. |
Document Tracking Number |
Assigned by the entity sending the document that uniquely identifies the document. |
94-123 |
30 |
A/N |
CR |
The Document Tracking Number input by the state (pos. 1548-1577 in the Detail Record). The Document Tracking Number is not used for an Employer Initiated Acknowledgment (EMP). |
Order ID |
A unique identifier associated with a specific child support obligation within a case. |
124-153 |
30 |
A/N |
O |
The Order ID input by the state (pos. 1578-1607 in the Detail Record). |
Record Disposition Status Code |
Indicates whether a record was accepted or rejected by the employer. |
154-155 |
2 |
A/N |
R |
Values are: A – Record accepted R – Record rejected
The following codes are used only with an Employer Initiated Acknowledgment Document Action Code (EMP) (pos. 4-6 in the Acknowledgment Record). L – Lump Sum S – Suspension T – Termination |
Disposition Reason Code |
The reason an e-IWO record is being accepted or rejected by an employer. |
156-158 |
3 |
A/N |
CR |
If the value in the Record Disposition Status Code (pos. 154-155) equals ‘A,’ a Disposition Reason Code is optional. Accepted values are: B – Name mismatch S – Employee is in a suspense status at employer W – Incorrect FEIN received for employee Spaces are also acceptable.
If the value in the Record Disposition Status (pos. 154-155) equals ‘R,’ a reason code is required. Rejected values are: B – Name mismatch D – Duplicate IWO M – IWO received from multiple states N – NCP no longer at the employer O – Other reason S – Employee is in a suspense status at employer U – NCP not known to employer W – Incorrect FEIN received for employee X – Employer could not electronically process this record Z – Termination cannot be processed; no current IWO in place |
Filler |
For future use. |
159 |
1 |
A/N |
O |
For future use. |
Termination Date |
Date an employee left or was terminated by an employer. |
160-167 |
8 |
A/N |
O |
Must be a valid date in CCYYMMDD format. If not applicable, fill this field with spaces. |
NCP Last Known Address Line 1 Text |
Line 1 of the NCP’s last known address. |
168-192 |
25 |
A/N |
O |
Optional field follows Length and Type instructions. |
NCP Last Known Address Line 2 Text |
Line 2 of the NCP’s last known address. |
193-217 |
25 |
A/N |
O |
Optional field follows Length and Type instructions. |
NCP Last Known Address City Name |
NCP’s last known city address. |
218-239 |
22 |
A/N |
O |
Optional field follows Length and Type instructions. |
NCP Last Known Address State Code |
NCP’s last known state code. |
240-241 |
2 |
A |
O |
Valid, two-character, alphabetic state or territory code. |
NCP Last Known Address ZIP Code |
NCP’s last known five-digit ZIP Code. |
242-246 |
5 |
N |
O |
Optional field follows Length and Type instructions. |
NCP Last Known Address Ext ZIP Code |
NCP’s last known four-digit ZIP Code extension. |
247-250 |
4 |
A/N |
O |
Optional field follows Length and Type instructions. |
Final Payment Made Date |
Date of the final payment sent to the SDU. |
251-258 |
8 |
A/N |
O |
Must be a valid date in CCYYMMDD format. If not applicable, fill this field with spaces. |
Final Payment Amount |
Amount of the final payment sent to the SDU. This only applies when an employee has been terminated or left his/her employer. |
259-269 |
11 |
N |
R |
Numeric Decimal assumed Unsigned No rounding Right justify Zero fill to left Zero fill if N/A The last payment/wages paid to an NCP that has left or been terminated. |
New Employer Name |
Name of NCP’s new employer. |
270-326 |
57 |
A/N |
O |
Optional field follows Length and Type instructions. |
New Employer Address Line 1 Text |
Line 1 of new employer’s address. |
327-351 |
25 |
A/N |
O |
Optional field follows Length and Type instructions. |
New Employer Address Line 2 Text |
Line 2 of new employer’s address. |
352-376 |
25 |
A/N |
O |
Optional field follows Length and Type instructions. |
New Employer Address City Name |
New employer’s city name. |
377-398 |
22 |
A/N |
O |
Optional field follows Length and Type instructions. |
New Employer State Code |
New employer’s state code. |
399-400 |
2 |
A |
O |
Valid, two-character, alphabetic state or territory code |
New Employer Address ZIP Code |
New employer’s five-digit ZIP Code. |
401-405 |
5 |
N |
O |
Optional field follows Length and Type instructions. |
New Employer Address Ext ZIP Code |
New employer’s four-digit ZIP Code extension. |
406-409 |
4 |
A/N |
O |
Optional field follows Length and Type instructions. |
Payment Lump Sum Date |
The date an employer anticipates that a Lump Sum Payment will be disbursed to an employee. |
410-417 |
8 |
A/N |
CR |
Must be a valid date in CCYYMMDD format. If the Document Action Code (pos. 7-9 in the Detail Record) is ‘EMP,’ and the Record Disposition Status Code (pos. 154-155) equals ‘L,’ this field must be filled with a valid future date. If the Document Action Code (pos. 7-9 in the Detail Record) is ‘EMP,’ and the Record Disposition Status Code (pos. 154-155) equals ‘T,’ this field must be filled with spaces. |
Payment Lump Sum Amount |
The amount an employer intends to issue as a Lump Sum Payment to the employee. |
418-428 |
11 |
N |
R |
Numeric Decimal assumed Unsigned No rounding Right justify Zero fill to left Zero fill if N/A If the Document Action Code (pos. 7-9 in the Detail Record) is ‘EMP,’ and the Record Disposition Status Code (pos. 154-155) equals ‘L,’ the dollar amount in this field must be filled with zeroes or an amount greater than $0.00. If the Document Action Code (pos. 7-9 in the Detail Record) is ‘EMP’ and the Record Disposition Status Code (pos. 154-155) equals ‘T,’ this field must be filled with zeroes. |
Payment Lump Sum Type Text |
The type of Lump Sum Payment that will be disbursed to an employee. Examples of a Lump Sum Payment include bonus, severance, commission, etc. |
429-463 |
35 |
A/N |
O |
Possible values are bonus, severance, or other unique identifiers. If the Document Action Code (pos. 7-9 in the Detail Record) is ‘EMP’ and the Record Disposition Status Code (pos. 154-155) equals ‘L,’ this field must be filled. If the Document Action Code (pos. 7-9 in the Detail Record) is ‘EMP’ and the Record Disposition Status Code (pos. 154-155) equals ‘T,’ this field must be blank. |
NCP Last Known Phone Number |
Last known phone number for the NCP. |
464-473 |
10 |
A/N |
O |
Optional field follows Length and Type instructions. |
First Error Field Name |
Name of the first field that did not pass the |
474-505 |
32 |
A/N |
O |
Used only by the Portal to return the first element that did not pass the Portal edits. |
Second Error Field Name |
Name of the second field that did not pass the e-IWO edits. |
506-537 |
32 |
A/N |
O |
Used only by the Portal to return the second element that did not pass the Portal edits. |
Multiple Error Indicator |
Indicates that a record has more than two errors. |
538 |
1 |
A/N |
O |
Valid values used only by the Portal: T – True F – False If more than two errors exist in the record, set to ‘T.’ If less than two errors exist, set to ‘F.’ |
Correct FEIN |
The actual FEIN under which the employee is working. |
539-547 |
9 |
N |
CR |
If the Record Disposition Code is “W,” this field is required. |
Multi IWO State Code |
The state code for which an employer already has an IWO in place for the employee and the IWO just received is a duplicate. |
548-549 |
2 |
A |
CR |
If the Record Disposition Code is “M,” this field is required. |
Filler |
For future use. |
550-573 |
24 |
A/N |
O |
For future use. |
|
|
Location |
Change |
Chart D-1 and D-3, Locator |
All references to Locator in this version were previously referred to as FIPS. |
Chart D-1,Control Number Location 4-25 |
Added text to data element rule: “Leading or embedded spaces not allowed.” |
Chart D-3 Case ID Location 88-102 |
Changed Identifier to ID. Added text to rules: “No leading spaces, backslash (\), or asterisk (*). |
Chart D-3 Case ID Location 160-184 |
Changed data element rule to “The first character must be a letter or a number.” |
Chart D-3 Case ID Location 185-209 |
Changed data element rule to “The first character must be a letter or a number.” |
Chart D-3 Case ID Location 210-231 |
Changed data element rule to “The first character must be a letter or a number.” |
Chart D-3, Obligee First Name Location 380-394 |
Changed to required element. |
Chart D-3, State Tribe Territory Name Location 625-659 |
Added to definition: “…that issued the support order.” Changed to required element. |
Chart D-3, Send Payment Within Days Number Location 670-671 |
Added text to data element rule: Right justify Zero fill to left Zero fill in N/A |
Chart D-3, Payee Name Location 674-730 |
Changed data element rule to “The first character must be a letter or a number.” |
Chart D-3, Payee Address Line 1 Text Location 731-755 |
Changed to a required element. |
Chart D-3, Payee Address City Name Location 781-802 |
Changed to a required element. |
Chart D-3, Payee Address State Code Location 803-804 |
Changed to a required element. |
Chart D-3, Payee Address ZIP Code Location 805-809 |
Changed to a required element. |
Chart D-3, Payee Remittance Locator Code Location 814-820 |
Changed instances of “FIPS” Code to “Locator Code.” Added to definition: “Formerly known as FIPS codes.” Added “numeric” to second sentence of data element rule. |
Chart D-3, Issuing Official Name Location 821-890 |
Removed government from name and description. Changed data element rule to “The first character must be a letter or a number.” |
Chart D-3, Issuing Official Name Location 891-940 |
Changed data element rule to “The first character must be a letter or a number.” |
Chart D-3, Supplemental Information Location 1263-1422 |
Renamed element from Specific Payee Withholding Limits Text to Supplemental Information Location. Added text to definition: “…any state specific requirements.” |
Chart D-3, Employee State Contact Name Location 1423-1479 |
Changed to a required element. |
Chart D-3, Employee State Contact Phone Number Location 1480-1489 |
Changed to a required element. |
Chart D-3, Order ID Location 1578-1607 |
Changed Identifier to ID. |
Chart D-3, Employer State Contact Name Location 1744-1747 |
Changed to an optional element. |
Chart D-3, Employer State Contact Name Location 1748-1757 |
Changed to a required element. |
Chart D-3, Child 1 Last Name Location 1816-1835 |
Changed to a required element. |
Chart D-3, Child 1 Birth Date Location 1870-1877 |
Changed to a required element. |
Chart D-3, Child 2 Last Name Location 1878-1897 |
Changed to a conditionally required element if there is an additional child. |
Chart D-3, Child 2 First Name Location 1898-1912 |
Changed to a conditionally required element if there is an additional child. |
Chart D-3, Child 2 Birth Date Location 1932-1939 |
Changed to a conditionally required element if there is an additional child. |
Chart D-3, Child 3 Last Name Location 1940-1959 |
Changed to a conditionally required element if there is an additional child. |
Chart D-3, Child 3 First Name Location 1960-1959 |
Changed to a conditionally required element if there is an additional child. |
Chart D-3, Child 3 Birth Date Location 1994-2001 |
Changed to a conditionally required element if there is an additional child. |
Chart D-3, Child 4 Last Name Location 2002-2021 |
Changed to a conditionally required element if there is an additional child. |
Chart D-3, Child 4 First Name Location 2022-2036 |
Changed to a conditionally required element if there is an additional child. |
Chart D-3, Child 4 Birth Date Location 2056-2063 |
Changed to a conditionally required element if there is an additional child. |
Chart D-3, Child 5 Last Name Location 2064-2083 |
Changed to a conditionally required element if there is an additional child. |
Chart D-3, Child 5 First Name Location 2084-2098 |
Changed to a conditionally required element if there is an additional child. |
Chart D-3, Child 5 Birth Date Location 2118-2125 |
Changed to a conditionally required element if there is an additional child. |
Chart D-3, Child 6 Last Name Location 2126-2145 |
Changed to a conditionally required element if there is an additional child. |
Chart D-3, Child 6 First Name Location 2146-2160 |
Changed to a conditionally required element if there is an additional child. |
Chart D-3, Child 6 Birth Date Location 2180-2187 |
Changed to a conditionally required element if there is an additional child. |
Chart D-3, Document Image Text Location 2228-2252 |
Added to data element rule: “…numeric state Locator Code, otherwise leave blank.” |
Chart D-3 and D-4 |
Changed any blank Data Element Rules to either: Required field follows Length and Type instructions Optional field follows Length and Type instructions |
Chart D-4, Case ID Location 7-21 |
Changed Identifier to ID. |
Chart D-4, Order ID Location 124-153 |
Changed Identifier to ID. |
Chart D-4, Disposition Reason Code Location 156-158 |
Added to data element rule: “optional” Changed in data element rule: “Spaces are also acceptable” |
File Type | application/vnd.openxmlformats-officedocument.wordprocessingml.document |
File Title | e-IWO Record Layouts |
Author | Office of Child Support Enforcement |
File Modified | 0000-00-00 |
File Created | 2021-01-14 |