Name convention
BPXUSAGE04_<CompanyNumber>_<DateTime>_<SEQNO>[<BatchId>].DAT
| Names Component | Description |
|---|---|
| CompanyNumber | The company number in PayEx ledger system |
| DateTime | Date created in format YYYYMMDDHHMMSS |
| SEQNO | Unbroken serial number sequence. |
| BatchId | Billing process Id |
For example: BPXUSAGE04_9999_20210123121243_00123[123456].DAT
Change log
| Version | Date | Description | Created by |
|---|---|---|---|
| 1.1 | 2021-02-23 | Created document | Daniel Olsson |
1.2 | 2024-02-15 | Extended number of characters to 60 for field 6 (Detailinfo) in T1-record | Jacob de Boer |
| 1.3 | 2024-04-04 | Extended number of characters to 75 for field 6 (Detailinfo) in T1-record Changed number of characters to 34 for field 5 (SubscriptionId) in T1-record Changed field 13 (VolumeCode) to: S, E, B, KB, MB, GB, MIN Added field 21 (UnitPrice), field 22 (UnitPriceCode), field 23 (ChargeInterval), field 24 (ContentProviderReferenceCode), field 25 (RoamingProviderReferenceCode) and field 26 (DestinationReferenceCode). | Daniel Engström |
General information and explanation of records
The report BPXUSAGE04 presents all states for a rated CDR during all processes in the PayEx Billing system.
The report contains information about:
- Successful rated CDRs (T1)
- Updated CDR:s from unbilled to billed in the Billing process (T2)
- Removed unbilled CDR:s for some reason (StatusId) in Billing process (T3)
- Removed unbilled CDR:s from reverse rating (T5)
- Removed billed CDR:s from reverse Billing (T8)
- Removed billed CDR. From BKB -file process (T51)
- Removed unbilled CDR. From BKB -file process (T52)
The report is produced during:
- Normal rating
- Reprocessing the Slush-file
- Billruns (creating invoices)
- Reversing a billing process:
- Reverse rating - manual triggered
- Reverse billing - manual triggered
- Reverse BKB file -process
Format description
All fields are separated with semicolons ”;”.
The format field is written in the way that numerical values are written as N and
alphanumerical characters are written as X. where ”n” is the maximum number of characters/digits or in certain cases number of characters that must exist.
Dot “.” is decimal separator on fields with amount. Some records are not obligatory but if they exist can some fields in the record be obligatory. Obligatory records are described with the abbreviation ” Req.” in the type column.
H - Header record
| Field name | Field no. | Format | Type | Description |
| Recordtype | 1 | H | Req. | Header record. |
| CompanyNumber | 2 | N(4) | Req. | You receive the company number from PayEx. |
| CompanyName | 3 | X(40) | Req. | Your company name |
| Creationdate | 4 | N(6) | Req. | YYMMDD |
| Creationtime | 5 | N(4) | Req. | HHMM |
T - Usage records
T1 Add new CDR to unbilled from rating process, including slush reprocess
All rated CDR:s from rating in Billing generate a record in T1, also rated CDR:s from “Slush” -rating
| Field name | Field no. | Format | Type | Description |
| Recordtype | 1 | T1 | Req. | Record type |
| CDRId | 2 | N(19) | Req. | Unique ID on CDR, created by Payex |
| YearMonth | 3 | N(6) | Req. | YYYYMM |
| CustomerId | 4 | X(15) | Req. | CustomerId |
| SubscriptionId | 5 | X(34) | Req. | SubscriptionId |
| Detailinfo | 6 | X(75) | Req. | B-Number |
| UsageType | 7 | N(9) | Req. | UsageType |
| UsageCode | 8 | X(15) | Req. | UsageCode |
| StartDateTime | 9 | X(19) | Req. | StartDateTime for CDR, YYYY-MM-DD TT:MM:SS |
| Amount | 10 | N(9).(3) | Req. | Amount incl start amount |
| StartAmount | 11 | N(9).(3) | Req. | Start amount |
| Volume | 12 | N(19) | Req. | Volume: amount, seconds, megabyte, etc. depending on volume code |
| VolumeCode | 13 | X(10) | Req. | S, E, B, KB, MB, GB, MIN |
| VatRate | 14 | N(2).(2) | Req. | VatRate |
| IP-address | 15 | X(15) | IP-Address only relevant for radius-CDR | |
| External reference | 16 | X(20) | External CDRId or other reference from CDR file | |
| Pricelist | 17 | X(15) | Pricelist for rating CDR | |
| StartTariff | 18 | N(1) | Req. | 0 = Unknown 1 = OPeak, 2 = MPeak, 3 = Peak |
| RatingId | 19 | N(9) | Req. | Payex BatchID for rating |
| StatusId | 20 | N(3) | Req. | 0 = Debitable, 3 = Non-debitable |
| UnitPrice | 21 | N(9).(3) | Req. | Price per unit used to calculate Amount |
| UnitPriceCode | 22 | X(10) | Req. | N/A, S, E, B, KB, MB, GB, MIN |
| ChargeInterval | 23 | N(9) | Req. | Charge interval which is used during rating. For example, for a CDR priced per started minute, this value should be 60. The unit must be the same as the Volume field. In case of per started minute (60 as charge interval) the Unit needs to be S |
| ContentProviderReferenceCode | 24 | N(9) | Reference code to more detailed content provider information | |
| RoamingProviderReferenceCode | 25 | N(9) | Reference code to more detailed roaming provider information | |
| DestinationReferenceCode | 26 | N(9) | Reference code to more detailed usage code information |
T2 Updated CDR:s from unbilled to billed. Billing-process
CDR connects to invoicing
| Field name | Field no. | Format | Type | Description |
| Recordtype | 1 | T2 | Req. | Record type |
| CDRId | 2 | N(19) | Req. | Unique ID on CDR, created by Payex |
| YearMonth | 3 | X(6) | Req. | YYYYMM |
| SubBillId | 4 | N(19) | Req. | InvoiceID-number at Payex |
| VatRate | 5 | N(2).(2) | Req. | VatRate |
| VatType | 6 | N(2) | Req. | VatType |
| SubBillRunId | 7 | N(9) | Req. | BatchID-number for actual billingproces at Payex |
T3 Removed unbilled CDR:s from Billing process
Removed Unbilled CDR:s from Billing process due to StatusId (rules).
| Field name | Field no. | Format | Type | Description |
| Recordtype | 1 | T3 | Req. | Record type |
| CDRId | 2 | N(19) | Req. | Unique ID on CDR, created by Payex |
| YearMonth | 3 | X(6) | Req. | YYYYMM |
| SubBillRunId | 4 | N(9) | Req. | BatchID-number for actual billing process at Payex |
| StatusId | 5 | N(3) | Req. | 1 = Duplicate, 2 = Old, 3 = Non-debitable. |
T5 Removed unbilled CDR:s from reverse rating process
Deleted CDR due reverse rating. Handled manually by PayEx
| Field name | Field no. | Format | Type | Description |
| Recordtype | 1 | T5 | Req. | Record type |
| CDRId | 2 | N(19) | Req. | Unique ID on CDR, created by Payex |
| YearMonth | 3 | X(6) | Req. | YYYYMM |
T8 Removed billed CDR:s from reverse Billing process
CDR with actual SubBillRunID will be restored regarding T2 and T3 information
Handled manually by PayEx
| Field name | Field no. | Format | Type | Description |
| Recordtype | 1 | T8 | Req. | Record type |
| CDRId | 2 | N(19) | Req. | Unique ID on CDR, created by Payex |
| YearMonth | 3 | X(6) | Req. | YYYYMM |
| Reserverad | 4 | X(10) | Req. | Reserved for future use, always 0 |
T51 Remove billed CDR. From BKB -file process
Only used with agreement to PayEx
| Field name | Field no. | Format | Type | Description |
| Recordtype | 1 | T51 | Req. | Record type |
| CDRId | 2 | N(19) | Req. | Unique ID on CDR, created by Payex |
| YearMonth | 3 | X(6) | Req. | YYYYMM |
T52 Remove unbilled CDR. From BKB -file process
Only used with agreement to PayEx
| Field name | Field no. | Format | Type | Description |
| Recordtype | 1 | T52 | Req. | Record type |
| CDRId | 2 | N(19) | Req. | Unique ID on CDR, created by Payex |
| YearMonth | 3 | X(6) | Req. | YYYYMM |
S - Trailer record
| Field name | Field no. | Format | Type | Description |
| Recordtype | 1 | S | Req. | Trailer record |
| Number of records | 2 | N(9) | Req. | Total number of records including header and trailer |
Example
Rating process
H;123456;Company name;210201;1007
T1;137497666209;202102;12345;0498202000;0046;1;6789;2021-02-01 01:02:03;1.000;0.700;20;S;25.00;;;;0;ID1;0
T1;206217142945;202102;12345;0498202001;0046;1;6789;2021-02-02 02:02:03;1.000;0.700;30;S;25.00;;;;0;ID1;0
T1;274936619681;202102;23456;0498202002;0046;1;6789;2021-02-01 03:02:03;1.000;0.700;40;S;25.00;;;;0;ID1;0
T1;343656096417;202102;23456;0498202003;0046;1;6789;2021-02-02 04:02:03;2.500;0.500;200;S;25.00;;;;0;ID1;0
T1;412375573153;202102;12345;0498202004;0046;1;6789;2021-02-01 05:02:03;1.000;0.700;30;S;25.00;;;;0;ID1;0
S;7
Billing process
H; 123456;Company name;210202;1007
T2;58892650217233;202101;994883200842416;25.00;0;3669846
T2;15461940893329;202101;994917560580784;25.00;0;3669846
T2;4191946709169;202101;994917560580784;25.00;0;3669846
S;5