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 response files after processing the file.
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.
Name convention
KUB_<CompanyNumber>_<DateTime>_<SEQNO>.DAT
Names Component | Description |
---|---|
CompanyNumber | The company number in PayEx ledger system |
DateTime | Date created in format YYYYMMDDHHMMSS |
SEQNO | Unbroken serial number sequence. |
For example: KUB_1234_20161201155511_1.DAT
The file is semicolon-separated.
What to avoid
- You cannot use the same serial number more than once. In case something goes wrong during CUSIN 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.
Change log
Version | Date | Description | Created by |
1.04 | 20-04-21 | Corrected file name included seconds | Anders Göthberg |
1.03 | 20-01-24 | New record type added for subscription information (SI) Inter Company Code added to field 15 in C1 (field marked as “not used” in earlier versions) Completed MB record with explanation regarding VAT-types | Daniel Olsson |
1.02 | 19-04-02 | Expand number of character in customer name | Anders Göthberg |
1.01 | 18-09-19 | Reduced possible values to 1-4 in C1:4 and removed Password (A:7) from Address record | Anders Göthberg |
1.0 | 18-05-04 | Created document | Anders Göthberg |
General information and explanation of records
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.
The PayEx Billing System processes and stores all correct customers. Incorrect customers will be returned in a detailed error file.
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.
If any of the customer's information, for example a subscription not has send it will be deleted in the Billing System.
Processing KUB files can be done 24/7 and response files will be delivered immediately after processing KUB files.
Format
In the format columns below, the numerical values are called N where “n” stands for the maximum number of characters, or in some cases the obligatory number of characters. Alphanumeric characters are written as X. The decimal separator for amounts will be a point “.”. Each record has a description about which character check will be made. Some records are not obligatory but if they do occur, some fields for the record may become obligatory. See the fixed telephony record “C2” for example, or mobile telephony record “MO”. Obligatory records are described with the abbreviation “Obl.” in the type column. All records marked with a star can only be used after contacting Payex.
The customers different records have to be sent in the same order as the record description.
Implementation
Implementation of KUB requires a complete file with all customers. Otherwise it is sufficient to only send updated customers.
GDPR (General Data Protection Regulation)
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.
The requirement to inactivate a customer is that the customers subscriptions are not active and that all products and usage has been billed.
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
Response files
If the file contains format errors a general error file will be produced.
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.
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.
Error -file
Examples of an extract from an error-file:
7.2Receipt -file
Examples of a receipt-file: