Name conventions
Billing Statistics
BRPT020_< CompanyNumber>_< DateTime>_0[<Info>_<BatchId>].DAT
| Name | Description |
| CompanyNumber | The company number in PayEx ledger system |
| DateTime | Date created in format YYYYMMDDHHMMSS |
| Info | ”BillStat_Billed” or “BillStat_Unbilled” |
| BatchId | Billing processId |
Two examples of report files:
BRPT020_99999_20210101180000_0[BillStat_Billed_123456].DAT
BRPT020_99999_20210101181000_0[BillStat_Unbilled_123456].DAT
Change log
| Version | Date | Description | Created by |
|---|---|---|---|
| 1.0 | 2021-02-01 | Created document | Tomas Kristoffersson |
General information and explanation of records
The report BRPT020 presents statistics concerning recurrent products, non recurrent products and Usage aggregated on product group level for each “CompanyID”.
If your company has Revenue Accounting services, “CompanyID” is the same as “ProductId” in the associate “ProductCatalog”.
The report can be created on both billed and unbilled statistics
Billing Statistics Billed
The statistics in this report are based on specific billrun/billmonth. The information in this report is divided in four different groups.
Summarized statistics transaction types:
- Product group statistic (D1-Record)
- Recurring product statistic (D2-Record)
- Non recurring product statistic (D3-Record)
- Usage (D4-Record)
The report can be created with the following arguments:
- Billrun, by using the processId from the billrun.
- Billmonth, presents all billruns within the same month.
Billing Statistics UnBilled
The summarized billing statistic report are based on unbilled fees and usage. The information in the summarized statistic report is divided in different groups.
Summarized statistics transaction types:
- Product group statistic (D1-Record)
- Recurring product statistic (D2-Record)
- Non recurring product statistic (D3-Record)
- Usage (D4-Record)
Format description
The report always starts with a header (H) and always ends with a trailer (T).
All fields in the report are separated with semicolons ”;” and all data records (D) precedes with an information record (I) and followed by a summary record (S)
Record description
H - Header record
| Field name | Field no. | Format | Type | Description |
| Record type | 1 | H | Req. | Record type. |
| CompanyNumber | 2 | N(4) | Req | You receive the company number from PayEx. |
| CompanyName | 3 | X(40) | Req | Your company name. |
| Billing cycle | 4 | X(10) | YYYY-MM-01 – Billing cycle | |
| BatchID | 5 | N(10) | Batch id | |
| Created date | 6 | N(6) | Req | YYMMDD – Same date as in the file name. |
| Created time | 7 | N(4) | Req | HHMM – Time when the file was created. |
Example on the records appearance.
H;99999;CompanyName;2021-01-01; 00123; 211206;1200
Information record
I - Information record
The purpose of the information record is to explain the fields in the following data record (D).
| Name | Nr | Format | Type | Description |
| Record type | 1 | I1, I2, I3,I4 and I9 | Req. | Information record |
| … | X | … | Description of the field in the data record |
Data record
There are five different types of data record, each of them belonging to its information record.
D1 - Product Group statistics
Presents the product group statistic. The level of sum up is Product Group, Revenue Month and VAT rate.
| Name | Nr | Format | Type | Description |
| Record type | 1 | D1 | Req. | Data record, type 1 |
| ProductGroup | 2 | N | Req. | Product group id |
| RevenueMonth | 3 | YYYY-MM | Req. | Revenue month |
| Description | 4 | X | Product group description | |
| VATRate | 5 | N(2),N(2) | Req. | VAT rate |
| TotalAmount | 6 | N(7).N(2-3) | Req. | Amount with 2 or 3 decimals according to specific company configuration |
D2 - Recurring product statistic
This record presents the recurring product statistic. The level of sum up is Product Group, Revenue Month, Company Id, Product Code and VAT Rate.
| Name | Nr | Format | Type | Description |
| Record type | 1 | D2 | Req. | Data record, type 2 |
| ProductGroup | 2 | N | Req. | Product group id |
| RevenueMonth | 3 | YYYY-MM | Req. | Revenue month |
| CompanyId | 4 | N | Req. | 1 – 99999. 0 if missing |
| ProductCode | 5 | X | Req. | Product code |
| Description | 6 | X | Product description | |
| VATRate | 7 | N(2),N(2) | Req. | VAT rate |
| TotalAmount | 8 | N(7).N(2-3) | Req. | Amount with 2 or 3 decimals according to specific company configuration |
D3 - Non recurring product statistic
This record presents the non recurring product statistic. The level of sum up is Product Group, Revenue Month, Description , Company Id and VAT Rate. Quantity is not included in this record for the reason that one product can be divided in separate revenue months.
| Name | Nr | Format | Type | Description |
| Record type | 1 | D3 | Req. | Data record, type 3 |
| ProductGroup | 2 | N | Req. | Product group id |
| RevenueMonth | 3 | YYYY-MM | Req. | Revenue month |
| CompanyId | 4 | N | Req. | 1 – 99999. 0 if missing |
| Description | 5 | X | Product description | |
| VATRate | 6 | N(2),N(2) | Req. | VAT rate |
| TotalAmount | 7 | N(7).N(2-3) | Req. | Amount with 2 or 3 decimals according to specific company configuration |
D4 - Usage
This record presents the usage statistic. The level of sum up is Product Group, Revenue Month, Company Id, Usage Type, Description, Volume Code and VAT Rate.
| Name | Nr | Format | Type | Description |
| Record type | 1 | D4 | Req. | Data record, type 4 |
| ProductGroup | 2 | N | Req. | Product group id |
| RevenueMonth | 3 | YYYY-MM | Req. | Revenue month |
| CompanyId | 4 | N | Req. | 1 – 99999. 0 if missing |
| UsageType | 5 | N | Req. | Usage type |
| Description | 6 | X | Usage type description | |
| VolumeCode | 7 | N | Req. | Usage type volume code |
| VATRate | 8 | N(2),N(2) | Req. | VAT rate |
| Quantity | 9 | N | Req. | Quantity |
| PeakVolume | 10 | N | Req. | Peak volume, max value 2^63 |
| OPeakVolume | 11 | N | Req. | Off peak volume, max value 2^63 |
| CPeakVolume | 12 | N | Req. | Normal volume, max value 2^63 |
| ConnectionAmount | 13 | N(7).N(2-3) | Req. | Starting fee with 2 or 3 decimals according to specific company configuration |
| TotalAMount | 14 | N(7).N(2-3) | Req. | Total amount with 2 or 3 decimals according to specific company configuration |
| TotalCost | 15 | N(7).N(2-3) | Req. | Total cost with 2 or 3 decimals according to specific company configuration |
T - Trailer record
The trailer shows the total number of entries in the report.
| Name | Nr | Format | Type | Description |
| Posttype | 1 | T | Req. | Trailer record |
| Total entries | 2 | N | Req. | Total number of entries |
Example of summarized report
H;99999;Company Name;2021-01-01;123456;210101;1052
I1;ProductGroup;Description;RevenueMonth;VATRate;TotalAmount
D1;500;Abonnemang - Mobil;2021-01;25.00;39.00
D1;500;Abonnemang - Mobil;2021-02;25.00;306.00
D1;531;Trafik - Samtal;2020-10;25.00;1.38
D1;534;Trafik - Förmedlade tjänster;2020-10;0.00;40.00
D1;540;Påfyllning surf;2021-01;25.00;25.00
D1;565;Fakturaavgift;2021-02;25.00;98.00
I2;ProductGroup;RevenueMonth;CompanyId;ProductCode;Description;VATRate;TotalAmount
D2;565;2021-02;19498;960;Fakturaavgift;25.00;98.00
I3;ProductGroup;RevenueMonth;CustomerId;Description;VATRate;TotalAmount
D3;500;2021-01;150908;Huvudabonnemang 10 GB;25.00;88.00
D3;500;2021-01;151463;Abonnemangsrabatt 1;25.00;-49.00
D3;500;2021-02;150908;Huvudabonnemang 10 GB;25.00;269.00
D3;500;2021-02;151089;Testabonnemang;25.00;69.00
D3;500;2021-02;151402;8 GB;25.00;69.00
D3;500;2021-02;151404;3 GB;25.00;49.00
D3;500;2021-02;151463;Abonnemangsrabatt 2;25.00;-150.00
D3;540;2021-01;151406;Surf 1 GB;25.00;25.00
I4;ProductGroup;RevenueMonth;CustomerId;UsageType;Description;VolumeCode;VATRate;Quantity;PeakVolume;OPeakVolume;CPeakVolume;ConnectionAmount;TotalAmount;TotalCost
D4;531;2020-10;19471;302;Mobilsamtal;S;25.00;1;0;57;0;0.79;1.38;1.38
D4;534;2020-10;19485;902;Betalsamtal, förmedlad tjänst, Mobil;S;0.00;1;0;58;0;0.00;40.00;40.00
T;23