BT OneBillPlus CD-ROM Technical Guide (Private Circuits) File 6

Transcription

1 BT OneBillPlus CD-ROM Technical Guide (Private Circuits) File 6 Issue 3.0 Page 1 of 19

2 Table of Contents 1. Welcome Introduction What is delivered? How is it delivered? Technical Prerequisites Technical Data Contact Point for Queries Notes CD-ROM OneBillPlus Private Circuit Details File...6 Issue 3.0 Page 2 of 19

3 1. Welcome Welcome to BT OneBillPlus. OneBillPlus is a service, which consolidates individual Private Circuit bills (known as source or local invoices), UK-wide from BT s billing systems. Once a billing frequency is agreed with you a single bill is produced which combines source invoice billing data raised at that date. However, this guide is all about the billing record data generated from our systems, covering your billing usage and available for you to use as management information. BT has developed the facility to provide the relevant OneBillPlus source invoice data on Read-Only Compact Disk (CD). We provide a CDROM disk copy of the guide and you are welcome to copy this on to your hard disk for your own private use, provided you do not modify the guide in any way 2. Introduction This guide provides a definition of the format of OneBillPlus data, sent via CD-ROM. BT OneBillPlus customers who have elected to receive their bill data via CD-ROM in addition to Paper invoices should use it. The OneBillPlus service has been enhanced to provide files on CD-ROM for you to input to your own systems enabling the analysis of your BT charges and usage. This document has been produced for technical personnel to assist in utilising the information held on the data files. It gives an overview of the contents of each file, the format in which the file is copied to the CD-ROM, and a detailed file layout with a technical description of each field and record on the file. 3. What is Delivered? The OneBillPlus service produces various data files, which may be interrogated by your own software to provide a detailed analysis of the BT services you use and the costs of those services. The data is held in a Comma Delimited Format (fixed width). This information can be read into most PC spreadsheet and database packages but if your files hold a high volume of data we recommend that you import them using an industry standard database package. 4. How is it delivered? The data files are supplied on CD-ROM. Issue 3.0 Page 3 of 19

4 5. Technical Prerequisites To use the CD-ROM you must have an IBM compatible Personal Computer that has the ability to read Compact Disk. 6. Technical Data The files written to CD-ROM will have the following parameters: - OneBillPlus Private Circuit Statement details file File name FORMAT XXXXF6YY.ZZ Fixed field comma delimited. Where: XXXX is the last four digits of your OneBillPlus account number. YY is the last two digits of the invoice number. ZZ is the identifier relating to the location of the BT office responsible for the OneBillPlus account. The files will be versioned as follows: Examples: OneBillPlus Summary information - R OneBillPlus Private Circuit details - M The version number has two parts, a major number (Rnnn) and a minor number (nn). The Minor number is incremented when there is no change to the data structure; i.e. typically operational fixes like a field should be spaces and not nulls, wrong decimal point etc. The Major number is incremented when there are data structure changes, i.e. new fields appended to an existing record, new record types introduced, etc. Issue 3.0 Page 4 of 19

5 7. Contact Point for Queries Any queries regarding the use of the CD-ROM product, e.g., non-receipt, corruption of data, general usage queries, should be directed to your BT contact number detailed on your paper invoice. 8. Notes The following notes will be of use when interpreting the data held on the disk: Fields, which are numeric monetary values, are in pounds and pence to either 2 or 3 decimal places e.g..ppp Note: Decimal places are explicitly present in all numerical fields. For example All monetary fields are preceded with a + or - sign. Issue 3.0 Page 5 of 19

6 9. CD-ROM OneBillPlus Private Circuit Details File This file, File 6, can contain the following record types:- Record Type Description Record Type Number Page Number File Header Bill Header Circuit Record Network Rental Charge Equipment Rental Charge Maintenance Charge Connection Charge Other Charge and Credit Record Discount Record Circuit Total Record Adjustment Record Account Level Charge Bill Trailer File Trailer A description and the format of each of the fields on the records follows:- Issue 3.0 Page 6 of 19

7 File Header (Record type 000) There will be one of these records on the file. It identifies the file as a BT Private Circuit breakdown file, the creation date, your account number and the BT contact number. FILE 6 RECORD NAME: FILE HEADER Record Type: 000 RECORD-TYPE Identifies the record type. 3 '000' ONEBILLPLUS-AC-NO The unique national BT Account number to identify a particular OneBillPlus account 10 SOURCE-SYSTEM Identifies the Source System to the user 10 PCB-IS ONEBILLPLUS-REPORT-NO OneBillPlus Report number 10 ONEBILLPLUS-REPORT-VERS-NO OneBillPlus Report version number 4 RUN-DATE Date file was created 8 yyyymmdd PROGRAM-ID Identifies the Mag Media file type 8 FILE 6 PROGRAM-VERSION-NO Identifies the version number of this file format. See note on file version in section 6. 7 Issue 3.0 Page 7 of 19

8 Bill Header (Record type 001) There will be one of these records for each source invoice included in the OneBillPlus invoice. They will detail the date on which the bill was produced, indicate the type of discount applied, the bill period and the rental start and end dates. RECORD NAME: BILL HEADER RECORD Record Type: 001 RECORD-TYPE Identifies the record type ACCOUNT-NO The Private Circuit source account number 12 SOURCE-INVOICE-NO The unique reference number for the source bill 12 CUST-CONTACT-FIRST-NAME The first name of the customer contact 28 CUST-CONTACT-LAST-NAME The last name (surname) of the customer contact. 56 COMPANY-NAME The name of the company 56 CUSTOMER-ADDRESS-1 First line of customer s address 75 CUSTOMER-ADDRESS-2 Second line of customer s address 75 CUSTOMER-ADDRESS-3 Third line of customer s address 75 CUSTOMER-ADDRESS-4 Fourth line of customer s address 26 CUSTOMER-ADDRESS-5 Fifth line of customer s address 16 BILLING-FREQUENCY The source accounts billing frequency: 1 Q-Quarterly A-Annual BILL-DATE The date of the source invoice 8 BILLED-AMOUNT The total amount billed on the source bill (including VAT but excluding any amounts 13 brought forward from previous invoices). VAT-AMOUNT The total VAT included in the billed amount 13 B/FWD-AMOUNT Outstanding amount brought forward from all previous invoices including VAT 13 OUTSTANDING AMOUNT Outstanding amount (Billed-Amount + B/fwd amount) 13 Issue 3.0 Page 8 of 19

9 Circuit Record (Record type 002) These records show all circuits shown on the invoice but identify circuits with new activity such as new provisions with the legend New Activity. RECORD NAME: CIRCUIT RECORD Record Type:002 RECORD-TYPE Identifies the record type CIRCUIT-ID This holds the 12 character Circuit Id 16 CIRCUIT-ACTIVITY Identifies whether there has been any activity on the circuit since the previous invoice 16 New Activity / No New Activity PROVISION-DATE Date that the circuit was provided 8 PCB-IS PRODUCT CODE This field is used to determine CFB discounts 7 Alpha/Numeric Issue 3.0 Page 9 of 19

10 Network Rental Charge Record (Record type 003) There will be one of these records for each full or part period Network Rental charge billed on the source bill. These records identify network charges such as local ends and main links, each local end or main link is shown as a separate row. Each network product now has a standard description called class of service. These records also show the customer their own order number, ( which always appears ), and the customers purchase number. As each local end is shown as a separate row the address details are shown against the A end address, the B end address normally refers to the BT serving exchange address. RECORD NAME: NETWORK RENTAL CHARGE RECORD Record Type: 003 RECORD-TYPE Identifies the record type CIRCUIT-ID This holds the 12 character Circuit Id 16 ELEMENT-ID This holds the Circuit Element Id in fixed format i.e. a 12 character Circuit Id with trailing 16 spaces followed by the four character Element No. ELEMENT-TYPE This identifies the element type. This is converted from the PCB-IS element type as follows: 4 ML-MLNK (Main Link) LA and LB LEND (Local End A/B) EE EEND (End to End) RD-RDIS (Route Distance) SR-CSEQ (Service) NETWORK-SERVICE- The description of the Circuit Component 56 DESCRIPTION CHARGE-AMOUNT The Rental charge after discount but not including VAT 12 VAT-AMOUNT The VAT on the charge 12 VAT-RATE The rate of VAT 6 RATE The full period rental (This will be the same as the charge for the full period rentals, but not 12 for part period rentals). CIRCUIT-DISTANCE The distance of the circuit element if required for charging (in metres) 8 CIRCUIT-ELEMENT-DESCRIPTION This describes the element type as follows: 75 ML- Main Link LA Local End A LB Local end B EE End to End RD Route Distance SR-Service Note that this can be used to identify the original PCB-IS element type for Network elements ORDER-NO The BT order number (AN number) 6 CUSTOMER-REF The Customer s reference number 20 CUST-ORDER-NO The Customer s order number 20 FROM-DATE The start date for the rental charge 8 Issue 3.0 Page 10 of 19

11 TO-DATE The end date for the rental charge 8 COMPANY-NAME The name of the Company 22 ADDRESS-A-1 The content depends on the element type: 22 LA and LB The Site Address (Site A for LA, Site B for LB) EE and RD Site A Address ML A end Exchange Code in first line; all other lines blank ADDRESS-A-2 22 ADDRESS-A-3 22 ADDRESS-A-4 22 ADDRESS-A-5 22 ADDRESS-A-6 22 ADDRESS-A-7 22 ADDRESS-B-1 The content depends on the element type: 22 LA and LB The Exchange Code ( A end for LA, B end for LB) in first line; all other lines blank EE and RD Site b Address ML B end Exchange Code in first line; all other lines blank ADDRESS-B-2 22 ADDRESS-B-3 22 ADDRESS-B-4 22 ADDRESS-B-5 22 ADDRESS-B-6 22 ADDRESS-B-7 22 EXCHANGE-A The content depends on the element type: 22 LA and LB First line of the Site Address (Site A for LA, Site B for LB) EE and RD First line of Site A Address ML A end Exchange Code EXCHANGE-B The content depends on the element type: 22 LA and LB The Exchange Code ( A end for LA, B end for LB) EE and RD First line of Site B Address ML B end Exchange Code COMPONENT-ID This holds the Circuit Component Id in the form c/s where c is the Circuit id and s is the 16 Suffix No. Note that this item is variable length and there may be spaces between the Circuit Id and the / and between the / and the Suffix No. PCB-IS PRODUCT CODE This field is used to determine CFB discounts 7 Alpha/Numeric Issue 3.0 Page 11 of 19

12 Equipment Rental Charge (Record type 004) There will be one of these records for each full or part period Equipment Rental Charge billed on the source bill. RECORD NAME: EQUIPMENT RENTAL CHARGE (full or part period) Record Type: 004 RECORD-TYPE Identifies the record type CIRCUIT-ID This holds the 12 character Circuit Id 16 ELEMENT-ID This holds the Circuit Element Id in fixed format i.e. a 12 character Circuit Id with trailing 16 spaces followed by the four character Element No. ELEMENT-TYPE This identifies the element type. This is converted from the PCB-IS element type as follows: 4 ML-MLNK (Main Link) LA and LB LEND (Local End A/B) EE EEND (End to End) RD-RDIS (Route Distance) EQ-CSEQ (Equipment)) NETWORK-SERVICE- The description of the Circuit Component. If the component is an Equipment Only 56 DESCRIPTION component this will be set to Equipment-Only. QUANTITY The quantity of the equipment type 5 CHARGE-AMOUNT The Rental charge after discount but not including VAT 12 VAT-AMOUNT The VAT on the charge 12 VAT-RATE The rate of VAT 6 RATE The full period rental for a single item of equipment 12 EQUIPMENT-DESCRIPTION The description of the equipment e.g. Signalling unit 201A 75 ORDER-NO The BT order number (AN number) 6 CUSTOMER-REF The Customer s reference number 20 CUST-ORDER-NO The Customer s order number 20 FROM-DATE The start date for the rental charge 8 TO-DATE The end date for the rental charge 8 COMPONENT-ID This holds the Circuit Component Id in the form c/s where c is the Circuit id and s is the 16 Suffix No. Note that this item is variable length and there may be spaces between the Circuit Id and the / and between the / and the Suffix No. PCB-IS PRODUCT CODE This field is used to determine CFB discounts 7 Alpha/Numeric Issue 3.0 Page 12 of 19

13 Maintenance Charge Record (Record type 005) There will be one of these records for each full or part period Maintenance Charge contained in the source bill. RECORD NAME: MAINTAINENANCE CHARGE RECORD Record Type: 005 RECORD-TYPE Identifies the record type CIRCUIT-ID This holds the 12 character Circuit Id 16 ELEMENT-ID This holds the Circuit Element Id in fixed format i.e. a 12 character Circuit Id with trailing 16 spaces followed by the four character Element No. ELEMENT-TYPE This identifies the element type. This is converted from the PCB-IS element type as follows: 4 ML-MLNK (Main Link) LA and LB LEND (Local End A/B) EE EEND (End to End) RD-RDIS (Route Distance) EQ and PL -CSEQ (Equipment)) NETWORK-SERVICE- The description of the Circuit Component. If the component is an Equipment Only 56 DESCRIPTION component this will be set to Equipment-Only. QUANTITY Will always be 1 for Network Maintenance; may be greater than 1 for Equipment 5 Maintenance CHARGE-AMOUNT The total Maintenance charge after discount but not including VAT 12 VAT-AMOUNT The VAT on the charge 12 VAT-RATE The rate of VAT 6 RATE The full period charge for Network Maintenance; the full period charge for a single item for 12 Equipment Maintenance. MAINTENANCE-DESCRIPTION The description of the maintenance contract 75 ORDER-NO The BT order number (AN number) 6 CUSTOMER-REF The Customer s reference number 20 CUST-ORDER-NO The Customer s order number 20 FROM-DATE The start date for the rental charge 8 TO-DATE The end date for the rental charge 8 COMPONENT-ID This holds the Circuit Component Id in the form c/s where c is the Circuit id and s is the 16 Suffix No. Note that this item is variable length and there may be spaces between the Circuit Id and the / and between the / and the Suffix No. PCB-IS PRODUCT CODE This field is used to determine CFB discounts 7 Alpha/Numeric Issue 3.0 Page 13 of 19

14 Connection Charge Record (Record type 006) There will be one of these records for each full or part period Connection Charge contained in the source bill. RECORD NAME: CONNECTION CHARGE RECORD Record Type: 006 RECORD-TYPE Identifies the record type CIRCUIT-ID This holds the 12 character Circuit Id 16 ELEMENT-ID This holds the Circuit Element Id in fixed format i.e. a 12 character Circuit Id with trailing 16 spaces followed by the four character Element No. NETWORK-SERVICE- The description of the Circuit Component. If the component is an Equipment Only 56 DESCRIPTION component this will be set to Equipment-Only. QUANTITY Will always be 1 for Network Maintenance; may be greater than 1 for Equipment 5 Maintenance CHARGE-AMOUNT The total charge after discount but not including VAT 12 VAT-AMOUNT The VAT on the charge 12 VAT-RATE The rate of VAT 6 CHARGE-DESCRIPTION The description for the charge 75 ORDER-NO The BT order number (AN number) 6 CUSTOMER-REF The Customer s reference number 30 CUST-ORDER-NO The Customer s order number 30 EFFECTIVE-DATE The effective date for the one-off charge. 8 COMPONENT-ID This holds the Circuit Component Id in the form c/s where c is the Circuit id and s is the 16 Suffix No. Note that this item is variable length and there may be spaces between the Circuit Id and the / and between the / and the Suffix No. PCB-IS PRODUCT CODE This field is used to determine CFB discounts 7 Alpha/Numeric Issue 3.0 Page 14 of 19

15 Other Charge and Credit Record (Record type 007) There will be one of these records for each full or part period Other Charge and Credit Record contained in the source bill. RECORD NAME: OTHER CHARGE AND CREDIT RECORD Record Type: 007 RECORD-TYPE Identifies the record type CIRCUIT-ID This holds the 12 character Circuit Id 16 ELEMENT-ID This holds the Circuit Element Id in fixed format i.e. a 12 character Circuit Id with trailing 16 spaces followed by the four character Element No. NETWORK-SERVICE- The description of the Circuit Component. If the component is an Equipment Only 56 DESCRIPTION component this will be set to Equipment-Only. QUANTITY Will always be 1 for Network Maintenance; may be greater than 1 for Equipment 5 Maintenance CHARGE-AMOUNT The total charge after discount but not including VAT 12 VAT-AMOUNT The VAT on the charge 12 VAT-RATE The rate of VAT 6 CHARGE-DESCRIPTION The description for the charge 75 ORDER-NO The BT order number (AN number) 6 CUSTOMER-REF The Customer s reference number 30 CUST-ORDER-NO The Customer s order number 30 EFFECTIVE-DATE The effective date for the one-off charge. 8 COMPONENT-ID This holds the Circuit Component Id in the form c/s where c is the Circuit id and s is the 16 Suffix No. Note that this item is variable length and there may be spaces between the Circuit Id and the / and between the / and the Suffix No. PCB-IS PRODUCT CODE This field is used to determine CFB discounts 7 Alpha/Numeric Issue 3.0 Page 15 of 19

16 Discount Record (Record type 008) There will be one of these records for each full or part period Discount Record contained in the source bill. These records show the before and after discount totals and the savings made against any circuit on one of the many BT discount schemes. RECORD NAME: DISCOUNT RECORD Record Type: 008 RECORD-TYPE Identifies the record type CIRCUIT-ID This holds the 12 character Circuit Id 16 CONTRACT-START-DATE Contract start date 8 CONTRACT-END-DATE Contract end date 8 COST-BEFORE Total of all circuit charges that are liable for discount (before discount). Note that not all 12 charges are liable for discount so this must not be used as a circuit total charge. COST-AFTER As for COST-BEFORE but after discount 12 DISCOUNT The total discount i.e. COST-BEFORE COST-AFTER (reported as a negative charge). 12 VAT Total VAT for all circuit charges that are liable for discount 12 VAT-RATE The rate of VAT 7 Circuit Total Record (Record type 009) There will be one of these records for each full or part period Circuit Total Record contained in the source bill. RECORD NAME: CIRCUIT TOTAL RECORD Record Type: 009 RECORD-TYPE Identifies the record type CIRCUIT-ID This holds the 12 character Circuit Id 16 TOTAL-CHARGE Total of all charges for the circuit after discount but not including VAT 13 TOTAL-VAT Total VAT for the circuit 13 PCB-IS PRODUCT CODE This field is used to determine CFB discounts 7 Alpha/Numeric Issue 3.0 Page 16 of 19

17 Adjustment Record (Record type 010) There will be one of these records for each Adjustment (Cessation Credits and other adjustments) contained in the source bill RECORD NAME: ADJUSTMENT RECORD Record Type: 010 RECORD-TYPE Identifies the record type CIRCUIT-ID This holds the 12 character Circuit Id 16 ELEMENT-ID This holds the Circuit Element Id in fixed format i.e. a 12 character Circuit Id with trailing 16 spaces followed by the four character Element No. FROM-DATE The start date for cessation credits; the effective start date for other adjustments 8 TO-DATE The end date for cessation credits; the effective end date for other adjustments 8 FILLER Blank field 9 NO-OF-DAYS The number of days for cessation credits; zero for other adjustments 3 DESCRIPTION Description of the adjustment. Contains Cessation Credit for Cessation Credits. This item 75 can be used to distinguish between Cessation Credits and other adjustments RATE The full period charge for cessation credits; zero for other adjustments. 12 COST The total charge (negative for credits) 12 VAT-AMOUNT The VAT on the charge (negative for credits) 12 VAT-RATE The rate of VAT 6 COMPONENT-ID This holds the Circuit Component Id in the form c/s where c is the Circuit id and s is the 16 Suffix No. Note that this item is variable length and there may be spaces between the Circuit Id and the / and between the / and the Suffix No. PCB-IS PRODUCT CODE This field is used to determine CFB discounts 7 Alpha/Numeric Issue 3.0 Page 17 of 19

18 Account Level Charge Record (Record type 011) There will be one of these records for each full or part Account Level Record contained in the source bill. RECORD NAME: ACCOUNT LEVEL CHARGE RECORD Record Type: 011 RECORD-TYPE Identifies the record type EFFECTIVE-DATE The effective date for the account level charge 8 ORDER-NO The BT order number (AN number) 6 CHARGE-DESCRIPTION The description for the charge 75 QUANTITY The quantity 5 CHARGE-AMOUNT The total charge after discount but not including VAT. 12 RATE The unit charge after discount but not including VAT 12 VAT-AMOUNT The VAT on the total charge 12 VAT-RATE The rate of VAT 7 Bill Trailer Record (Record type 099) There will be one of these records for each full or part period Bill Trailer Record contained in the source bill. Record Name: BILL TRAILER RECORD Record Type: 099 RECORD-TYPE Identifies the record type. 3 '099' RT1-COUNT The total number of Type 1 records in the Private Circuit Bill source bill. 9 RT2-COUNT The total number of Type 2 records in the Private Circuit Bill source bill. 9 RT3-COUNT The total number of Type 3 records in the Private Circuit Bill source bill. 9 RT4-COUNT The total number of Type 4 records in the Private Circuit Bill source bill. 9 RT5-COUNT The total number of Type 5 records in the Private Circuit Bill source bill. 9 RT6-COUNT The total number of Type 6 records in the Private Circuit Bill source bill. 9 RT7-COUNT The total number of Type 7 records in the Private Circuit Bill source bill. 9 RT8-COUNT The total number of Type 8 records in the Private Circuit Bill source bill. 9 RT9-COUNT The total number of Type 9 records in the Private Circuit Bill source bill. 9 RT10-COUNT The total number of Type 10 records in the Private Circuit Bill source bill. 9 RT11-COUNT The total number of Type 11 records in the Private Circuit Bill source bill. 9 Issue 3.0 Page 18 of 19

19 File Trailer Record (Record type 999) There will be one trailer record at the end of each file. RECORD NAME: File Trailer Record Record Type: 999 RECORD-TYPE Identifies the record type. 3 '999' ONEBILLPLUS-AC-NO The unique national BT Account number to identify a particular OneBillPlus account 10 SOURCE-SYSTEM Identifies the Source System to the user 10 PCB-IS ONEBILLPLUS-REPORT-NO OneBillPlus Report number 10 ONEBILLPLUS-REPORT-VERS-NO OneBillPlus Report version number 4 RUN-DATE Date file was created 8 yyyymmdd PROGRAM-ID Identifies the Mag Media file type 7 FILE 6 PROGRAM-VERSION-NO Identifies the version number of this file format. See note on file version in section 6. 7 INVOICE-COUNT Total number of source bills included in this file 9 Issue 3.0 Page 19 of 19