PGW EDI Implementation Guideline

Transcription

1 PGW EDI Implementation Guideline For Transaction Set 814 Drop (ESP or LDC Initiated) Request and Response X12 v Drop Request and Response Rev 1.7 Nov 16, 2015

2 Contents 814 General Request, Response or Confirmation ID: Supplier or Utility initiated Drop Request and Response... 4 ISA Interchange Control Header... 4 GS Functional Group Header... 4 Segment: ST Transaction Set Header... 5 Segment: BGN Beginning Segment... 6 Segment: N1 Name (8S=LDC Name)... 7 Segment: N1 Name (SJ=ESP Name)... 8 Segment: N1 Name (8R=Customer Name)... 9 Segment: N3 Address Information (Service Address) Segment: N4 Geographic Location Segment: LIN Item Identification Segment: ASI Action or Status Indicator Segment: REF Reference Identification (1P=Status Reason) Segment: REF Reference Identification (7G=Rejection Reason) Segment: REF Reference Identification (11=ESP Account Number) Segment: REF Reference Identification (12=LDC Account Number) Segment: DTM Date/Time Reference (151=Service End Date) Segment: NM1 Organization Name (MQ = Meter Location) Segment: REF Reference Identification (RB = ESP Rate Code) Segment: SE Transaction Set Trailer GE Functional Group Trailer IEA Interchange Control Trailer Appendix A-1: Drop Reason Codes (ESP initiated transactions) Appendix A-2: Drop Reason Codes (LDC initiated transactions) Appendix B: Drop Reject Codes References: Page 1 of Drop Request and Response Rev 1.7 Nov 16, 2015

3 Revision Notes Revision # Date Description Reason 1.7 Nov 16, Added the section Revision Notes starting with Traceability of changes this version (1.7) 1.7 Nov 16, 2015 Page: 25 Appendix A-2: Drop Reason Codes (LDC initiated transactions) Added codes CBX, DUB and CB6 Adding new reason codes for LDC initiated drop. Page 2 of Drop Request and Response Rev 1.7 Nov 16, 2015

4 814 General Request, Response or Confirmation Heading Functional Group ID=GE Pos. Seg. Req. Loop Notes and No. ID Name Des. Max. Use Repeat Comments Must Use 010 ST Transaction Set Header M 1 Must Use 020 BGN Beginning Segment M 1 LOOP ID N1 >1 040 N1 Name O 1 n1 060 N3 Address Information O N4 Geographic Location O PER Administrative Communications Contact O >1 Detail Pos. Seg. Req. Loop Notes and No. ID Name Des. Max. Use Repeat Comments LOOP ID LIN >1 010 LIN Item Identification O ASI Action or Status Indicator O REF Reference Identification O >1 040 DTM Date/Time Reference O >1 060 AMT Monetary Amount O >1 LOOP ID NM1 >1 080 NM1 Individual or Organizational Name O REF Reference Identification O >1 Summary Pos. Seg. Req. Loop Notes and No. ID Name Des. Max. Use Repeat Comments Must Use 150 SE Transaction Set Trailer M 1 Page 3 of Drop Request and Response Rev 1.7 Nov 16, 2015

5 814 D: ESP or LDC initiated Drop Request and Response ISA Interchange Control Header GS Functional Group Header Page 4 of Drop Request and Response Rev 1.7 Nov 16, 2015

6 Segment: ST Transaction Set Header Position: 010 Loop: Level: Heading Usage: Mandatory Max Use: 1 Purpose: To indicate the start of a transaction set and to assign a control number Syntax Notes: Semantic Notes: 1 The transaction set identifier (ST01) is used by the translation routines of the interchange partners to select the appropriate transaction set definition. Comments: Must Use ST Transaction Set Identifier Code M ID 3/3 Code uniquely identifying a Transaction Set 814 General Request, Response or Confirmation Must Use ST Transaction Set Control Number M AN 4/9 Identifying control number that must be unique within the transaction set functional group assigned by the originator for a transaction set Page 5 of Drop Request and Response Rev 1.7 Nov 16, 2015

7 Segment: BGN Beginning Segment Position: 020 Loop: Level: Heading Usage: Mandatory Max Use: 1 Purpose: To indicate the beginning of a transaction set Syntax Notes: Semantic Notes: 1 BGN02 is the transaction set reference number. 2 BGN03 is the transaction set date. 3 BGN06 is the transaction set reference number of a previously sent transaction affected by the current transaction. Comments: Must Use BGN Transaction Set Purpose Code M ID 2/2 Code identifying purpose of transaction set 11 Response Signifies that the requested service will be addressed as described in this transaction. 13 Request Must Use BGN Reference Identification M AN 1/15 Reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier A unique transaction identification number assigned by the originator of this transaction. This number must be unique over time. Must Use BGN Date M DT 8/8 Date (CCYYMMDD) The transaction creation date the date that the data was processed by the sender s application system. Optional BGN Reference Identification O AN 1/15 Reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier If used, refers to the BGN02 identification number of the original Request. Not used on the request. Optional on the response. Page 6 of Drop Request and Response Rev 1.7 Nov 16, 2015

8 Segment: N1 Name (8S=LDC Name) Position: 040 Loop: N1 Level: Heading Usage: Optional Max Use: 1 Purpose: To identify a party by type of organization, name, and code Syntax Notes: 1 At least one of N102 or N103 is required. 2 If either N103 or N104 is present, then the other is required. Semantic Notes: Comments: 1 This segment, used alone, provides the most efficient method of providing organizational identification. To obtain this efficiency the ID Code (N104) must provide a key to the table maintained by the transaction processing party. 2 N105 and N106 further define the type of entity in N101. Must Use N Entity Identifier Code M ID 2/3 Code identifying an organizational entity, a physical location, property or an individual 8S Consumer Service Provider (CSP) LDC Must Use N Name X AN 1/60 Free-form name LDC Company Name Must Use N Identification Code Qualifier X ID 1/2 Code designating the system/method of code structure used for Identification Code (67) 1 D-U-N-S Number, Dun & Bradstreet 9 D-U-N-S+4, D-U-N-S Number with Four Character Suffix Must Use N Identification Code X AN 2/80 Code identifying a party or other code LDC D-U-N-S Number or D-U-N-S + 4 Number Must Use N Entity Identifier Code O ID 2/3 Code identifying an organizational entity, a physical location, property or an individual. Used in addition to the N103 and N104 to identify the transaction sender and receiver when more than two parties are identified by N1 loops. 40 Receiver Entity to accept transmission 41 Submitter Entity transmitting transaction set Page 7 of Drop Request and Response Rev 1.7 Nov 16, 2015

9 Segment: N1 Name (SJ=ESP Name) Position: 040 Loop: N1 Level: Heading Usage: Mandatory Max Use: 1 Purpose: To identify a party by type of organization, name, and code Syntax Notes: 1 At least one of N102 or N103 is required. 2 If either N103 or N104 is present, then the other is required. Semantic Notes: Comments: 1 This segment, used alone, provides the most efficient method of providing organizational identification. To obtain this efficiency the ID Code (N104) must provide a key to the table maintained by the transaction processing party. 2 N105 and N106 further define the type of entity in N101. Must Use N Entity Identifier Code M ID 2/3 Code identifying an organizational entity, a physical location, property or an individual SJ Service Provider ESP Must Use N Name X AN 1/60 Free-form name ESP Company Name Must Use N Identification Code Qualifier X ID 1/2 Code designating the system/method of code structure used for Identification Code (67) 1 D-U-N-S Number, Dun & Bradstreet 9 D-U-N-S+4, D-U-N-S Number with Four Character Suffix Must Use N Identification Code X AN 2/80 Code identifying a party or other code ESP D-U-N-S Number or D-U-N-S + 4 Number Must Use N Entity Identifier Code O ID 2/3 Code identifying an organizational entity, a physical location, property or an individual. Used in addition to the N103 and N104 to identify the transaction sender and receiver when more than two parties are identified by N1 loops. 40 Receiver Entity to accept transmission 41 Submitter Entity transmitting transaction set Page 8 of Drop Request and Response Rev 1.7 Nov 16, 2015

10 Segment: N1 Name (8R=Customer Name) Position: 040 Loop: N1 Level: Heading Usage: Mandatory Max Use: 1 Purpose: To identify a party by type of organization, name, and code Syntax Notes: 1 At least one of N102 or N103 is required. 2 If either N103 or N104 is present, then the other is required. Semantic Notes: Comments: 1 This segment, used alone, provides the most efficient method of providing organizational identification. Must Use N Entity Identifier Code M ID 2/3 Code identifying an organizational entity, a physical location, property or an individual 8R Consumer Service Provider (CSP) Customer Must Use N Used to identify the customer associated with the LDC service account Name X First Name AN 1/20 Last Name AN 1/25 Free-form name. First name and Last name, if both are present, should be separated by a space. Customer Name as it appears on the customer s bill Page 9 of Drop Request and Response Rev 1.7 Nov 16, 2015

11 Segment: N3 Address Information (Service Address) Position: 060 Loop: N1 Level: Heading Usage: Optional Max Use: 2 Purpose: To specify the location of the named party Syntax Notes: Semantic Notes: Comments: Must Use N Address Information M AN 1/40 Address information Page 10 of Drop Request and Response Rev 1.7 Nov 16, 2015

12 Segment: N4 Geographic Location Position: 070 Loop: N1 Level: Heading Usage: Optional Max Use: 1 Purpose: To specify the geographic place of the named party Syntax Notes: Semantic Notes: Comments: 1 A combination of either N401 through N403 may be adequate to specify a location. Must Use N City Name O AN 2/30 Free-form text for city name Must Use N State or Province Code O ID 2/2 Code (Standard State/Province) as defined by appropriate government agency Must Use N Postal Code O ID 3/5 Code defining international postal zone code excluding punctuation and blanks (zip code for United States) Optional N Country Code O ID 2/3 Code identifying the country Page 11 of Drop Request and Response Rev 1.7 Nov 16, 2015

13 Segment: LIN Item Identification Position: 010 Loop: LIN Level: Detail Usage: Mandatory Max Use: 1 Purpose: To specify basic item identification data Syntax Notes: 1 If either LIN04 or LIN05 is present, then the other is required. Semantic Notes: 1 LIN01 is the line item identification Comments: 1 See the Data Dictionary for a complete list of Ids. 2 LIN02 through LIN31 provide for fifteen different product/service Ids for each item. For example: Case, Color, Drawing No., U.P.C. No., ISBN No., Model No., or SKU. Must Use LIN Assigned Identification O AN 1/20 Alphanumeric characters assigned for differentiation within a transaction set On the request, this is a unique tracking number for each line item (LIN) in this transaction. This number must be unique over all time. This number must be returned on the response transaction in the same element. Must Use LIN Product/Service ID Qualifier M ID 2/2 Code identifying the type/source of the descriptive number used in Product/Service ID (234) SH Service Requested Must Use LIN Product/Service ID M AN 1/48 Identifying number for a product or service GAS Gas Service Identifies the product Must Use LIN Product/Service ID Qualifier M ID 2/2 Code identifying the type/source of the descriptive number used in Product/Service ID (234) SH Service Requested Must Use LIN Product/Service ID M ID 1/48 Primary Service Identifying number for a product or service CE Generation Services Page 12 of Drop Request and Response Rev 1.7 Nov 16, 2015

14 Segment: ASI Action or Status Indicator Position: 020 Loop: LIN Level: Detail Usage: Mandatory Max Use: 1 Purpose: Syntax Notes: Semantic Notes: Comments: To indicate the action to be taken with the information provided or the status of the entity described All ESP initiated drops should be coded as Final (ASI01=F). Must Use ASI Action Code M ID 1/2 Code indicating type of action F Final U Reject (Response only) WQ Accept (Response only) Must Use ASI Maintenance Type Code M ID 3/3 Code identifying the specific type of item maintenance 024 Cancellation or Termination Drop Page 13 of Drop Request and Response Rev 1.7 Nov 16, 2015

15 Segment: REF Reference Identification (1P=Status Reason) Position: 030 Loop: LIN Level: Detail Usage: This is a mandatory field on a Drop request only. Max Use: >1 Purpose: To specify identifying information Syntax Notes: 1 At least one of REF02 or REF03 is required. 2 If either C04003 or C04004 is present, then the other is required. 3 If either C04005 or C04006 is present, then the other is required. Semantic Notes: 1 REF04 contains data relating to the value cited in REF02. Comments: Must Use REF Reference Identification Qualifier M ID 2/3 Code qualifying the Reference Identification 1P Accessorial Status Code Used in the instance where the 814 Request is accepted, but additional status information must be provided; e.g. code W09, special off-cycle meter read cannot be performed. This is a required field on a Drop request. Must Use REF Reference Identification X AN 1/30 Reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier Conditional REF Description X AN 1/80 A free-form description to clarify the related data elements and their content Used to further describe the status reason code sent in REF02. Code A13 requires text explanation in this element. Drop Reason codes for ESP initiated transactions are defined in Appendix A-1. Drop Reason codes for LDC initiated transactions are defined in Appendix A-2. Page 14 of Drop Request and Response Rev 1.7 Nov 16, 2015

16 Segment: REF Reference Identification (7G=Rejection Reason) Position: 030 Loop: LIN Level: Detail Usage: Optional Max Use: >1 Purpose: To specify identifying information Syntax Notes: Semantic Notes: Comments: Must Use REF Reference Identification Qualifier M ID 2/3 Code qualifying the Reference Identification 7G Data Quality Reject Reason Reject reasons associated with a reject status notification. Must Use REF Reference Identification M AN 1/30 Must Use REF Description X AN 1/80 Drop Reject codes are defined in Appendix B. Page 15 of Drop Request and Response Rev 1.7 Nov 16, 2015

17 Segment: REF Reference Identification (11=ESP Account Number) Position: 030 Loop: LIN Level: Detail Usage: Optional Max Use: >1 Purpose: To specify identifying information Syntax Notes: Semantic Notes: Comments: Must Use REF Reference Identification Qualifier M ID 2/3 Code qualifying the Reference Identification 11 Account Number ESP-assigned account number for end use customer. Must Use REF Reference Identification M AN 1/10 Reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier Page 16 of Drop Request and Response Rev 1.7 Nov 16, 2015

18 Segment: REF Reference Identification (12=LDC Account Number) Position: 030 Loop: LIN Level: Detail Usage: Mandatory Max Use: >1 Purpose: To specify LDC assigned account number information Semantic Notes: 1 REF04 contains data relating to the value cited in REF02. Comments: Must Use REF Reference Identification Qualifier M ID 2/3 Code qualifying the Reference Identification 12 Billing Account LDC-assigned account number for end use customer. Must Use REF Reference Identification M AN 1/10 Reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier Page 17 of Drop Request and Response Rev 1.7 Nov 16, 2015

19 Segment: DTM Date/Time Reference (151=Service End Date) Position: 040 Loop: LIN Level: Detail Usage: Mandatory for acceptance response or utility initiated drop request. Max Use: >1 Purpose: To specify pertinent dates and times Syntax Notes: Semantic Notes: Comments: Must Use DTM Date/Time Qualifier M ID 3/3 Code specifying type of date or time, or both date and time 151 Service Period End Estimated date that the service with the ESP will end. Must Use DTM Date X DT 8/8 Date expressed as CCYYMMDD Page 18 of Drop Request and Response Rev 1.7 Nov 16, 2015

20 Segment: NM1 Organization Name (MQ = Meter Location) Position: 080 Loop: NM1 Level: Detail Usage: Mandatory Max Use: 1 Purpose: To supply the Service Point Id Syntax Notes: 1 If either NM108 or NM109 is present, then the other is required. Semantic Notes: 1 NM102 qualifies NM103. Must Use NM Entity Identifier Code M ID 2/3 Code identifying an organizational entity, a physical location, property or an individual MQ Meter Location Must Use NM Entity Type Qualifier M ID 1/1 Code qualifying the type of entity 3 Unknown Must Use NM Identification Code Qualifier X ID 1/2 Code designating the system/method of code structure used for Identification Code (67) 32 Assigned by Property Operator Meter Number Must Use NM Identification Code X AN 2/10 Code identifying a party or other code Service Point ID Page 19 of Drop Request and Response Rev 1.7 Nov 16, 2015

21 Segment: REF Reference Identification (RB = ESP Rate Code) Position: 130 Loop: NM1 Level: Detail Usage: Mandatory Max Use: >1 Purpose: To specify PGW Pool Id for the ESP. Comments: Must Use REF Reference Identification Qualifier M ID 2/3 Code qualifying the Reference Identification RB Rate code number ESP Rate Code for the customer Must Use REF Reference Identification M AN 1/30 PGW Pool ID as defined for a particular ESP. Page 20 of Drop Request and Response Rev 1.7 Nov 16, 2015

22 Segment: SE Transaction Set Trailer Number of Included Segments M SE01 96 M N Transaction Set Control Number M SE M AN 4 9 GE Functional Group Trailer IEA Interchange Control Trailer Page 21 of Drop Request and Response Rev 1.7 Nov 16, 2015

23 Appendix A-1: Drop Reason Codes (ESP initiated transactions) PGW (814 ID) Drop Reason Code Mapping with PA-EDI Guidelines (IG814Dv6) The following are the Drop Reason Codes sent from the ESP (Energy Service Provider, the Supplier) to the LDC (Local Distribution Company, the Utility) in an 814 Drop Request transaction (PGW internal code 814 ID). Note: Per the specs: IG814Dv6, page # 28, the Status Reason Codes are only valid in certain directions. PGW accepted values for the drop reason codes are: OTH MOV NPS RQS RQC FBP. ESP (Supplier) Codes as per PA- EDI Guidelines PA-EDI Guidelines Description PGW Reason Codes PGW Description Comment 007 Service terminated or customer dropped because of nonpayment NPS DROP BY SUPPLIER FOR NON-PAYMT 020 Customer moved or account closed (this is only for LDC Drop request to ESP) MOV CUSTOMER IS MOVING Note the direction here. A13 Other OTH OTHER B38 Dropped by customer request RQC CUSTOMER REQUESTED CCE Contract expired RQS CONTRACT ENDED SUPP INITIATED CHA Customer changed to another Service Provider PGW does not have this code, Seeburger can put OTH as the reason code. Page 22 of Drop Request and Response Rev 1.7 Nov 16, 2015

24 EB3 Withdrawn PGW does not have this code, Seeburger can put OTH as the reason code. Page 23 of Drop Request and Response Rev 1.7 Nov 16, 2015

25 Appendix A-2: Drop Reason Codes (LDC initiated transactions) PGW (814 OD) Drop Reason Code Mapping with PA-EDI Guidelines (IG814Dv6) The following are the Drop Reason Codes sent in the LDC initiated Drop Request transaction (PGW internal code 814 ID) to the ESP. Note: Per the specs: IG814Dv6, page # 28, the Status Reason Codes are only valid in certain directions. PGW has the following values for the drop reason codes: TOF, EXT, OTH, MOV, NPS, RQS, RQC and FBP. PGW Reason Codes PGW Description ESP (Supplier) Codes as per PA- EDI Guidelines PA-EDI Guidelines Description Comment TOF TURN OFF A13 Other - TURN OFF A13 is used in the absence of an equivalent code in the PA- EDI Guidelines. Note: Explanation Required in REF03 EXT SUPPLIER EXITING MARKET A13 Other - SUPPLIER EXITING MARKET A13 is used in the absence of an equivalent code in the PA- EDI Guidelines. Note: Explanation Required in REF03 OTH OTHER A13 Other Customer Requested. Note: Explanation Required in REF03 MOV NPS CUSTOMER IS MOVING DROP FOR NON- PAYMT 020 Customer moved or account closed (this is only for LDC Drop request to ESP) 007 Service terminated or customer dropped because of nonpayment Page 24 of Drop Request and Response Rev 1.7 Nov 16, 2015

26 RQS CONTRACT ENDED SUPP INITIATED CCE Contract expired This is usually applicable to ESP initiated Drops. RQC CUSTOMER REQUESTED B38 Dropped by customer request FBP FINAL BILL B38 Dropped by customer request PA-EDI Guidelines specifications do not mention a placeholder for the final bill. Since drops initiated by PGW are usually be due to a customer request, B38 can be used. CBX DUB CB6 CB ACCOUNT OVER USAGE LIMIT DUAL ACCT UNDER CB USAGE LIMIT CRP STATUS NOT CB ELIGIBLE A13 Other - CB ACCOUNT OVER USAGE LIMIT A13 Other - DUAL ACCT UNDER CB USAGE LIMIT A13 Other - CRP STATUS NOT CB ELIGIBLE A13 is used in the absence of an equivalent code in the PA- EDI Guidelines. Note: Explanation Required in REF03 A13 is used in the absence of an equivalent code in the PA- EDI Guidelines. Note: Explanation Required in REF03 A13 is used in the absence of an equivalent code in the PA- EDI Guidelines. Note: Explanation Required in REF03 Page 25 of Drop Request and Response Rev 1.7 Nov 16, 2015

27 Appendix B: Drop Reject Codes PGW (814 ODR/IDR) Drop Reject Code Mapping with PA-EDI Guidelines (IG814Dv6) The following are the Drop Reject Codes used in the 814 Drop Responses from the LDC to reject an ESP initiated drop request (PGW internal code 814 ODR) or vice-versa (PGW internal code 814 IDR). Reference: IG814Dv6, page # 26. PGW Reject codes PGW Description ESP Codes as per PA- EDI Guidelines ESP (PA-EDI Guidelines) Description Comment 008 SERVICE AGREEMENT DOES NOT HAVE AN ACTIVE OR PENDING STATUS 008 Account exists but is not active A13 DUPLICATE USA/SUPPLIER EXISTS A13 Other (Explanation Required in REF03) A13 AN ACTIVE OR PENDING ENROLLMENT WITH THIS SUPPLIER ALREADY EXISTS ABN Duplicate Request Received A13 RECEIVED DATE GREATER THAN CURRENT DATE DIV Date Invalid A13 PROCESS DATE AND TIME GREATER THAN CURRENT DATE AND TIME DIV Date Invalid A76 ACCOUNT ID DOES NOT EXIST A76 Account Not Found UND SUPPLIER DOES NOT HAVE AN IN SERVICE STATUS A84 Invalid Relationship (not ESP of record) Page 26 of Drop Request and Response Rev 1.7 Nov 16, 2015

28 UND SUPPLIER DUNS NUMBER DOES NOT EXIST UND Cannot identify ESP This is same as the above A84 for UGI UND AGENT DUNS NUMBER DOES NOT EXIST UND Cannot identify ESP UND POOL ID DOES NOT EXIST UND Cannot identify ESP UND SUPPLIER DOES NOT EXIST FOR THE INPUT POOL ID UND Cannot identify ESP - - ACI Action Code (ASI01) invalid - - API Required information missing (REF03 Required) - - B14 Reason for termination was required, or invalid code sent PGW does not have this code since it is a validation check for the code in the incoming ASI01 from the ESP. This must be trapped by Seeburger at the time of parsing the message. PGW does not have this code since it is a validation check for the incoming message from the ESP. This must be trapped by Seeburger at the time of parsing the message. PGW does not have this code since it is a validation check for the Drop reason code in the incoming message from the ESP. This must be trapped by Seeburger at the time of parsing the message. PGW accepted values for Page 27 of Drop Request and Response Rev 1.7 Nov 16, 2015

29 In addition to the above codes, PGW can send out the following as well: the drop reason codes are: OTH MOV NPS RQS RQC FBP. ANE NUMBER OF DAYS BEFORE SWITCH HAS NOT BEEN REACHED ANE ENROLLMENT HAS ALREADY BEEN RECEIVED FOR AN ALTERNATE SUPPLIER ANE SERVICE POINT NOT IN SERVICE STATUS ANE SP INSTALL DATE IS GREATER THAN RECEIVED DATE ANE ANE SP NOT CONNECTED TO THE SA MESSAGE FOR DAILY CUSTOMERS NOT ALLOWED A13 Other (Explanation Required in REF03) ANE INBOUND DROP/CHANGE FOR DAILY CUSTOMER MR1 LATEST BILLED READ NOT AMR READ MR1 SWITCH FAILURE BILL ESTIMATED MR2 NON AMR MTR ENROLLMENT IS NOT ALLOWED API SP ID DOES NOT EXIST Page 28 of Drop Request and Response Rev 1.7 Nov 16, 2015

30 References: PA PUC EDI Guidelines Page 29 of Drop Request and Response Rev 1.7 Nov 16, 2015