Wiki source code of KUB

Last modified by Anders Göthberg on 2024/03/28 10:31
Hide last authors
Andreas Benneck 34.1 1 (% class="jumbotron" %)
2 (((
3 (% class="container" %)
4 (((
Jacob de Boer 49.1 5 Processing KUB-files can be done 24/7 and immediately after processing the file a Response file will be created.
Andreas Benneck 35.1 6
Anders Göthberg 42.1 7 Please note that your Response files might only utilize and/or contain a subset of all elements described below.
Andreas Benneck 34.1 8 )))
9 )))
Andreas Benneck 4.2 10
11 ----
12
13
Andreas Benneck 3.2 14 (% style="margin:0cm 0cm 6pt" %)
Anders Göthberg 9.1 15 KUB file is a customerfile in CSV, and it is used to submit end-user information to PayEx billing. The KUB-file also contains subscriptions och products for end-users. Processing the KUB-files can be done 24/7 and immediately deliver resonse files after processing the file.
Anders Göthberg 8.1 16
Anders Göthberg 26.1 17 = Name convention =
Anders Göthberg 21.1 18
19 KUB_<CompanyNumber>_<DateTime>_<(% style="font-size:14px" %)SEQNO(%%)>.DAT
20
21
Anders Göthberg 24.1 22 (% border="1" %)
23 |=(% style="width: 371px;" %)Names Component|=(% style="width: 1121px;" %)Description
24 |(% style="width:371px" %)CompanyNumber|(% style="width:1121px" %)The company number in PayEx ledger system
25 |(% style="width:371px" %)DateTime|(% style="width:1121px" %)Date created in format YYYYMMDDHHMMSS
26 |(% style="width:371px" %)SEQNO|(% style="width:1121px" %)Unbroken serial number sequence.
Anders Göthberg 21.1 27
Anders Göthberg 24.1 28 **For example: **KUB_1234_20201001155511_1.DAT
29
Anders Göthberg 21.1 30 The file is semicolon-separated.
31
32 (% id="HWhattoavoid" %)
33 == What to avoid ==
34
Anders Göthberg 29.1 35 * You cannot use the same serial number more than once. In case something goes wrong during KUB processing, **you need to supply a new serial number - the next number in the number series you are using - when transferring the rectified file to PayEx**.
Anders Göthberg 21.1 36
Anders Göthberg 22.1 37 == Change log ==
38
Anders Göthberg 24.2 39 (% border="1" %)
Anders Göthberg 24.3 40 |=**Version**|=(% style="width: 166px;" %)**Date**|=(% style="width: 879px;" %)**Description**|=(% style="width: 328px;" %)**Created by**
Anders Göthberg 36.1 41 |1.04|(% style="width:166px" %)2020-04-21|(% style="width:879px" %)Corrected file name included seconds|(% style="width:328px" %)Anders Göthberg
Anders Göthberg 37.1 42 |1.05|(% style="width:166px" %)2021-04-20|(% style="width:879px" %)(((
43 Protected identity added to field 7 in C1 (field marked as “not used” in earlier versions)
Andreas Benneck 15.2 44
Anders Göthberg 37.1 45 ZIP code, in A -record extended to 12 characters
Anders Göthberg 44.1 46 )))|(% style="width:328px" %)(((
47 Daniel Olsson
48
49 )))
Daniel Engström 45.1 50 |1.06|(% style="width:166px" %)2022-09-27|(% style="width:879px" %)Legal status added to field 10 in C1 (field marked as “not used” in earlier versions)|(% style="width:328px" %)(((
51 Anders Göthberg
52 )))
53 |(((
54
Anders Göthberg 37.1 55
Daniel Engström 45.1 56 1.07
Daniel Engström 50.1 57 )))|(% style="width:166px" %)2022-11-17|(% style="width:879px" %)(((
Anders Göthberg 46.1 58 Extended address record for C/O address and street address field 2 and 3 in A record from 1-35 to 1-72.
Daniel Engström 45.1 59
Anders Göthberg 46.1 60 Extended datatype PXNameAddressString with diacritical and cyrillic characters.
Daniel Engström 45.1 61 )))|(% style="width:328px" %)Daniel Engström
62
Anders Göthberg 17.1 63 =
Anders Göthberg 22.1 64 General information and explanation of records =
Andreas Benneck 15.2 65
Anders Göthberg 24.2 66 Customerfile to Billing (KUB) is used to submit end-user information to the PayEx Billing System. KUB contains the end customer's customer information together with all of the end customer's subscriptions and products to be processed in the PayEx Billing System.
Andreas Benneck 15.2 67
68 The PayEx Billing System processes and stores all correct customers. Incorrect customers will be returned in a detailed error file.
69
70 Updated customers have to be sent in its entirety. The sending party sends a total snapshot of a customer’s data to be processed in the Billing System.
71 If any of the customer's information, for example a subscription not has send it will be deleted in the Billing System.
72
73 Processing KUB files can be done 24/7 and response files will be delivered immediately after processing KUB files.
74
Anders Göthberg 22.1 75 === Implementation ===
Andreas Benneck 15.2 76
77 Implementation of KUB requires a complete file with all customers. Otherwise it is sufficient to only send updated customers.
78
Anders Göthberg 22.1 79 === GDPR (General Data Protection Regulation) ===
Andreas Benneck 15.2 80
81 Inactivating a customer can be done by using record C1, field 8 (CustomerStatus). Default is the value = 2 (Active). For inactive value 1 is used.
82
83 The requirement to inactivate a customer is that the customers subscriptions are not active and that all products and usage has been billed.
84
85 As soon as a customer has been send with value 1 (Inactive) no information regarding this customer will be available in any report or api. A final removal of the customers information will be made after x days, where the recommendation is to use the default of 40 days. Within this period it´s possible to reactivate the customer again.This can be done by sending value Active in the customerstatus
86
Anders Göthberg 41.1 87 === Restriction invoice period of recurring products ===
Anders Göthberg 39.1 88
89 (% class="wikigeneratedid" %)
Anders Göthberg 41.1 90 PayEx Billing has a restriction for invoice period of recurring products (record C2, MO and PR) to a maximum of 24 historical month.
Andreas Benneck 15.2 91
Anders Göthberg 24.1 92 == Response files ==
93
Andreas Benneck 15.2 94 If the file contains format errors a general error file will be produced.
95
96 If the file format is correct and the file contains correct and incorrect customers an error file with filename (BERR010..ErrorlogKund) and a receipt file (BRCP010..ReceiptCustomerfile) will be produced.
97
98 If the file format is correct and the file contains only correct customers no error file will be produced, only a receipt file will be produced.
99
Anders Göthberg 24.1 100 === Receipt and Error -files ===
101
Anders Göthberg 51.1 102 Text format :[[ Receipt and Error -file example>>doc:.Example Error file KUB.Text format.WebHome]]
Andreas Benneck 15.2 103
Anders Göthberg 43.1 104 ==== CSV format ====
105
106 [[Error log (BERR010)>>doc:.Example Error file KUB.Error log (BERR010).WebHome]]
107
108 [[Receipt (BRCP010)>>doc:.Example Error file KUB.Receipt (BRCP010).WebHome]]
109
Anders Göthberg 51.1 110 ==== ====
Anders Göthberg 43.1 111
Anders Göthberg 42.1 112