Invoice Batch File Layout

The invoice batch file sent to your billing service is a comma-delimited (.csv) file. Each data field is enclosed in double quotes ("). The data in the fields varies by line type, and the first field in each line is a tag that identifies the line type.

Tag

Line Type

Description

VER

Version

Information about the version of this document.

HDR

Header

Information about the whole invoice, such as the remit-to address, the sale and invoice dates, the sales representative's name, and other information. Each invoice has only one HDR line.

ITM

Line Item

Information about one line item on the invoice, such as the part number, the quantity ordered, the quantity shipped, and the unit and extended price. You can have multiple ITM lines per invoice.

CMT

Comment

Information about a comment. The actual wording of the CMT will be located in a DSC field located directly below this CMT. You can have multiple CMT lines per invoice.

SUB

Subtotal

Information about a subtotal on an invoice. The actual wording for the invoice will be located in a DSC field located directly below this SUB. You can have multiple SUB lines per invoice.

DSC

Description

Descriptions for the ITM, CMT and SUB line types. As these descriptions can be more than one line, you can have multiple DSC lines per ITM, CMT, and SUB line. Each ITM, CMT, and SUB line is followed by at least one DSC line.

PMT

Payment

Payment details for this order. You can have 0-n lines per invoice.

FTR

Footer

Information about the entire invoice, such as the invoice total, tax, freight, and handling amounts, and a count of the number of items on the invoice. Each invoice has only one FTR line. It signals the end of the data for one invoice.

SUM

Summary

Summary information for the entire batch transmission, such as the number of invoices in the batch file. Each invoice has only one SUM line.

A detailed file description is listed below for each of the sections:

Format Key

A detailed file descriptions contain a Format requirement. For this column, the following rules apply:

Format

Description

Alpha

Field uses only alphabetical characters A through Z.

Numeric

Field uses only whole numbers - no decimals.

mm/dd/yy

Field requires a date.

Decimal (X)

Field uses numbers with decimals with X indicating the number of decimal places to use.

Alphanumeric

Field allows alpha and numeric data.

Version Line Data Fields

A detailed file description is listed below for this section:

Field Number

Description

Format

1

Segment Code VER

Alpha

2

Eclipse Point Release

Alphanumeric

3

Third-Party Invoice Layout Document ID

Alpha

Header Line Data Fields

A detailed file description is listed below for this section:

Field Number

Description

Format

1

Segment Code HDR

Alpha

2

Bill-To Customer ID

Numeric

3

Order ID

Alphanumeric

4

Ship-To Customer ID

Numeric

5

Remit-To Address1

Alphanumeric

6

Remit-To Address2

Alphanumeric

7

Remit-To Address3

Alphanumeric

8

Remit-To Address4

Alphanumeric

9

Remit-To City

Alpha

10

Remit-To State

Alpha

11

Remit-To Zip

Alphanumeric

12

Remit-To Phone Number

Alphanumeric

13

Remit-To Fax Number

Alphanumeric

14

Ship Branch Address1

Alphanumeric

15

Ship Branch Address2

Alphanumeric

16

Ship Branch Address3

Alphanumeric

17

Ship Branch Address4

Alphanumeric

18

Ship Branch City

Alpha

19

Ship Branch State

Alpha

20

Ship Branch Zip

Alphanumeric

21

Ship Branch Phone Number

Alphanumeric

22

Ship Branch Fax Number

Alphanumeric

23

Bill-To Address1

Alphanumeric

24

Bill-To Address2

Alphanumeric

25

Bill-To Address3

Alphanumeric

26

Bill-To Address4

Alphanumeric

27

Bill-To City

Alpha

28

Bill-To State

Alpha

29

Bill-To Zip

Alphanumeric

30

Ship-To Address1

Alphanumeric

31

Ship-To Address2

Alphanumeric

32

Ship-To Address3

Alphanumeric

33

Ship-To Address4

Alphanumeric

34

Ship-To City

Alpha

35

Ship-To State

Alpha

36

Ship-To Zip

Alphanumeric

37

Order Date

mm/dd/yy

38

Ship Date

mm/dd/yy

39

Customer PO number

Alphanumeric

40

Order With

Alpha

41

Salesman

Alpha

42

Ship Via

Alphanumeric

43

Terms Description

Alphanumeric

44

Writer

Alpha

45

Customer Release

Alphanumeric

46

Price Branch

Numeric

47

Phone Number

Alphanumeric

48

Duplicate Count

Alpha

49

Due Date

mm/dd/yy

50

Send via

Alpha

51

Email – TO

Alphanumeric

52

Email – CC

Alphanumeric

53

Email – BCC

Alphanumeric

54

Email – Subject

Alphanumeric

55

Email – Body

Alphanumeric

56

Email – From

Alphanumeric

57

Email – Format

Alpha

58

Fax – To Contact

Alpha

59

Fax – To Number

Numeric

60

Fax – To Message

Alphanumeric

61

Fax – From Contact

Alpha

62

Fax – Send Time

Alphanumeric

63

Fax – Send Date

mm/dd/yyyy

64

C.O.D.

Boolean

65

Shipping Instructions

Alphanumeric

66

Shipping Tracker Number

Alphanumeric

67

Shipping Branch

Numeric

68

Pricing Branch Address 1

Alphanumeric

69

Pricing Branch Address 2

Alphanumeric

70

Pricing Branch Address 3

Alphanumeric

71

Pricing Branch Address 4

Alphanumeric

72

Pricing Branch City

Alpha

73

Pricing Branch State

Alpha

74

Pricing Branch Zip

Alphanumeric

75

Pricing Branch Phone Number

Alphanumeric

76

Pricing Branch Fax Number

Alphanumeric

77

User Defined Data

 

78

User Defined Data

 

79

User Defined Data

 

80

User Defined Data

 

81

User Defined Data

 

82

User Defined Data

 

83

User Defined Data

 

84

User Defined Data

 

85

User Defined Data

 

86

User Defined Data

 

Item Line Data Fields

A detailed file description is listed below for this section:

Field Number

Description

Format

1/A

Segment Code ITM

Alpha

2/B

Bill-To Customer ID

Numeric

3/C

Order ID

Alpha

4/D

Product Number

Alphanumeric

5/E

Quantity Ordered

Numeric

6/F

Quantity Shipped

Numeric

7/G

Unit of Measure

Alpha

8/H

Net Price

Decimal (7)

9/I

Price Per Unit of Measure

Alpha

10/J

Extended Net (Subtotal)

Decimal (3)

11/K

List Override

Decimal (3)

12/L

Largest Unit of Measure

Alpha

13/M

Tax Flag

Numeric

14/N

Line Item Freight

Decimal (2)

15/O

Price Line

Alpha

16/P

Cash Discount Percent

Alphanumeric

17/Q

User Defined Data

 

18/R

User Defined Data

 

19/S

User Defined Data

 

20/T

User Defined Data

 

21/U

User Defined Data

 

22/V

User Defined Data

 

23/W

User Defined Data

 

24/X

User Defined Data

 

25/Y

User Defined Data

 

26/Z

User Defined Data

 

Item Line Comment Fields

A detailed file description is listed below for this section:

Field Number

Description

Format

1

Segment Code CMT

Alpha

2

Bill-To Customer ID

Numeric

3

Order ID

Alpha

4

User Defined Data

 

5

User Defined Data

 

6

User Defined Data

 

7

User Defined Data

 

8

User Defined Data

 

9

User Defined Data

 

10

User Defined Data

 

11

User Defined Data

 

12

User Defined Data

 

13

User Defined Data

 

Item Line Subtotal Fields

A detailed file description is listed below for this section:

Field Number

Description

Format

1

Segment Code SUB

Alpha

2

Bill-To Customer ID

Numeric

3

Order ID

Alpha

4

Subtotal

Decimal (3)

5

User Defined Data

 

6

User Defined Data

 

7

User Defined Data

 

8

User Defined Data

 

9

User Defined Data

 

10

User Defined Data

 

11

User Defined Data

 

12

User Defined Data

 

13

User Defined Data

 

14

User Defined Data

 

Consolidated Order Subtotal Fields

A detailed file description is listed below for this section:

Field Number

Description

Format

1

Segment Code CON

Alpha

2

Bill-To Customer ID

Numeric

3

Order ID

Alpha

4

Child Order ID

Alpha

5

Customer PO

Alpha

6

Customer Release

Alpha

7

Subtotal

Decimal (3)

8

Freight

Decimal (3)

9

Tax

Decimal (3)

10

Handling

Decimal (3)

11

FET

Decimal (3)

12

Child Order Total

Decimal (3)

13

Child Order Ship Date

Date

14

Child Order Ordered Date

Date

 

Item Line Description Fields

A detailed file description is listed below for this section:

Field Number

Description

Format

1

Segment Code DSC

Alpha

2

Bill-To Customer ID

Numeric

3

Description Line

Alpha

4

User Defined Data

 

5

User Defined Data

 

6

User Defined Data

 

7

User Defined Data

 

8

User Defined Data

 

9

User Defined Data

 

10

User Defined Data

 

11

User Defined Data

 

12

User Defined Data

 

13

User Defined Data

 

Payment Fields

A detailed file description is listed below for this section:

Field Number

Description

Format

1

Segment Code PMT

Alpha

2

Bill-To Customer ID

Numeric

3

Payment Amount

Decimal (2)

4

Payment Date

mm/dd/yy

5

Payment Type

Alpha

6

Payment ID

Alphanumeric

7

Check – Number

Alphanumeric

8

CC Merchant ID

Alphanumeric

9

CC Number

Alphanumeric

10

CC Holder

Alpha

11

CC Amount

Decimal (2)

12

CC Time/Date

Alphanumeric

13

CC Type

Alpha

14

CC Auth Code

Numeric

15

CC Charge Date

mm/dd/yy

16

User Defined Data

 

17

User Defined Data

 

18

User Defined Data

 

19

User Defined Data

 

20

User Defined Data

 

21

User Defined Data

 

22

User Defined Data

 

23

User Defined Data

 

24

User Defined Data

 

25

User Defined Data

 

Footer Line Data Fields

A detailed file description is listed below for this section:

Field Number

Description

Format

1/A

Segment Code FTR

Alpha

2/B

Bill-To Customer ID

Numeric

3/C

Order ID

Alpha

4/D

Service Charge

Decimal (2)

5/E

Unearned amount

Decimal (2)

6/F

Invoice Message Line 1

Alphanumeric

7/G

Invoice Message Line 2

Alphanumeric

8/H

Invoice Message Line 3

Alphanumeric

9/I

Invoice Message Line 4

Alphanumeric

10/J

Subtotal

Decimal (3)

11/K

Discount Message

Alphanumeric

12/L

Freight

Decimal (2)

13/M

Handling

Decimal (2)

14/N

Due Message

Alphanumeric

15/O

Freight Terms

Alphanumeric

16/P

Tax Amount

Decimal (2)

17/Q

FET Amount

Decimal (2)

18/R

Invoice Total

Decimal (2)

19/S

Invoice Line Item Count

Numeric

20/T

Signature Bitmap Filename

Alphanumeric

21/U

US Funds

Numeric

22/V

Reprint Flag

Boolean

23/W

User Defined Data

 

24/X

User Defined Data

 

25/Y

User Defined Data

 

26/Z

User Defined Data

 

27

User Defined Data

 

28

User Defined Data

 

29

User Defined Data

 

30

User Defined Data

 

31

User Defined Data

 

32

User Defined Data

 

Summary Line Data Fields

A detailed file description is listed below for this section:

Field Number

Description

Format

1

Segment Code SUM

Alpha

2

Invoice Count

Numeric

3

Batch Line Item Count

Numeric

4

Total Batch Amount

Decimal (3)

5

Byte Count (excluding SUM line)

Numeric

6

Transmission Date

ddmmyyyy

7

Branches in batch

Alphanumeric

8

Selection Codes used for batch

Alphanumeric

9

Cut Date

ddmmyyyy

10

Shipping/Pricing Branch Selection

Alphanumeric

11

Additional Selection Criteria

Alphanumeric

See Also:

Setup Requirements for the Third-Party Billing Interface

Adding User-Defined Data to Invoices and Statements

Statement Batch File Layout