Name conventions
Total 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 | ”TotStat_Billed” or “TotStat_Unbilled” |
| BatchId | Billing processId |
Two examples of report files:
BRPT020_99999_20210101180000_0[TotStat_Billed_123456].DAT
BRPT020_99999_20210101181000_0[TotStat_Unbilled_123456].DAT
Total statistics Billruns
Three different reports can be produced on billruns:
Totalstatistics InvoiceMonth, based on specified month
Totalstatistics FB01, based on FB01 file billrun.
Totalstatistics WebCredit, based on Webcredit billrun.
BRPT020_<CompanyNr>_<DateTime>_0[TotStat_Billed_<ReportType>_<BatchId>].DAT
| Name | Description |
| CompanyNr | The company number in PayEx ledger system |
| DateTime | Date created in format YYYYMMDDHHMMSS |
| ReportType | Argument for report: InvoiceMonth, FB01-file or WebCredit |
| BatchId | Billing processId |
Examples of report files.
BRPT020_99999_20210211075841_0[TotStat_Billed_InvoiceMonth_123456].DAT
BRPT020_99999_20210211075731_0[TotStat_Billed_FB01_123456].DAT
BRPT020_99999_20210210153003_0[TotStat_Billed_WebCredit_123456].DAT
Change log
| Version | Date | Description | Created by |
|---|---|---|---|
| 1.1 | 2021-03-11 | Created document | Jakob Flodman |
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
Total statistics Billed
The statistics in this report are based on specific billrun/billmonth. The information in this report is divided in four different groups:
- Recurring product statistics (D5-record)
- Non recurring product statistics (D6-record)
- Usage (D7-record)
- Usage destinations (D8-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.
Total statistics Unbilled
The statistics in this report are based on unbilled fees and unbilled usage
The information in this report is divided in four different groups:
- Recurring product statistics (D5-record)
- Non recurring product statistics (D6-record)
- Usage (D7-record)
- Usage destinations (D8-record)
Total statistics Billruns
The statistics can also be created for following processes:
- FB01-files with associated processed PFB-files.*
- Billruns for Webcredit
- All billruns per Billmonth
*only if the split service is being used
The information in this report is divided in four different groups:
- Recurring product statistics (D5-record)
- Non recurring product statistics (D6-record)
- Usage (D7-record)
- Usage destinations (D8-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(5) | 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; 210202;1200
H2 - Header record – Only in Total statistic Billruns
| Field name | Field no. | Format | Type | Description |
| Record type | 1 | H2 | Req. | Record type. |
| Report type | 2 | X(40) | Req | Report Billrun: InvoiceMonth, FB01, WebCredit |
| FB File | 3 | X(40) | File name FB01 file | |
| BatchID | 4 | N(10) | Batch id | |
| Bill month | 5 | N(6) | YYYY-MM – Year Month Billrun For Report type “FB01” first PFB -files Bill Month added |
Example on the records appearance.
H2;FB01;FB01_999999_210201152700_556.DAT;2766108;2021-02
Information record
The purpose of the information record is to explain the fields in the following data record (D).
I - Information record
| Name | Nr | Format | Type | Description |
| Record type | 1 | I5,I6, I7 and I8 | Req. | Information record |
| … | X | … | Description of the fields in the data record |
Data record
There are four different types of data records, each of them belonging to its information record.
D5 - Recurring product statistics
Presents the recurring product statistic for the actual billmonth or billrun processId. The data record is sorted on the product code.
| Name | Nr | Format | Type | Description |
| Record type | 1 | D5 | Req. | Data record |
| ProductCode | 2 | X | Req. | Recurring product code |
| ProductGroup | 3 | N | Req. | Product group id |
| CompanyId | 4 | N | 1-99999. 0 if missing, Using Revenue Accounting services the ProcuctID from the Productcatalog will be presented | |
| Description | 5 | X | Product description | |
| Quantity | 6 | D | Req. | Total quantity of product occurrence |
| VatRate | 7 | N(2),N(2) | Req | Vat rate |
| Amount | 8 | N(7).N(2-3) | Req. | Amount with 2 or 3 decimals according to specific company configuration |
S5 Summation D5
Summarises the recurring product statistic for the actual billmonth or billrun processId.
| Name | Nr | Format | Type | Description |
| Record type | 1 | S5 | Req. | Summarized Data record |
| TotalQuantity | 6 | D | Req. | Total quantity of product occurrence |
| TotalAmount | 8 | N(7).N(2-3) | Req. | Amount with 2 or 3 decimals according to specific company configuration |
D6 - Non recurring product statistics
Presents the non recurring product statistic for the actual billmonth or billrun process -id. The data record is sorted on the description field.
| Name | Nr | Format | Type | Description |
| Record type | 1 | D6 | Req. | Data record |
| Description | 2 | X | Req. | Product description/Product group description. |
| ProductGroup | 3 | N | Req. | Product group |
| CompanyId | 4 | N | 1-99999. 0 if missing, Using Revenue Accounting services the ProcuctID from the Productcatalog will be presented | |
| Quantity | 5 | D | Req. | Quantity of product occurrence |
| VatRate | 6 | N(2),N(2) | Req. | Vat rate |
| Amount | 7 | N(7).N(2-3) | Req. | Amount with 2 or 3 decimals according to specific company configuration |
S6 Summation D6
Summarizes all the recurring product statistic for the actual billmonth or billrun processId.
| Name | Nr | Format | Type | Description |
| Record type | 1 | S6 | Req. | Summarized Data record |
| TotalQuantity | 5 | D | Req. | Total quantity of product occurrence |
| TotalAmount | 7 | N(7).N(2-3) | Req. | Total amount with 2 or 3 decimals according to specific company configuration |
D7 - Usage
Presents the usage statistics for the actual billmonth or billrun processId. The data record is sorted on the usage type field.
| Name | Nr | Format | Type | Description |
| Record type | 1 | D7 | Req. | Data record |
| UsageType | 2 | N | Req. | Usage type |
| ProductGroup | 3 | N | Req. | Product group id |
| CompanyId | 4 | N | Req. | 1-99999. 0 if missing, Using Revenue Accounting services the ProcuctID from the Productcatalog will be presented |
| Description | 5 | X | Usage type description | |
| Quantity | 6 | D | Req. | Quantity of usage type occurrence |
| PeakVolume | 7 | N | Req. | Peak volume, max value 2^63 |
| OpeakVolume | 8 | N | Req. | Off peak volume, max value 2^63 |
| CpeakVolume | 9 | N | Req. | Normal volume, max value 2^63 |
| VatRate | 10 | N(2),N(2) | Req. | Vat rate |
| Amount | 11 | N(7).N(2-3) | Req. | Amount including starting fee with 2 or 3 decimals according to specific company configuration. |
| Startfee | 12 | N(7).N(2-3) | Starting fee for the usage type |
S7 Summation D7
Summarizes all the usage types for the actual billmonth or billrun processId.
| Name | Nr | Format | Type | Description |
| Record type | 1 | S7 | Req. | Summarized Data record |
| TotalQuantity | 6 | D | Req. | Total quantity for the usage types |
| TotalPeakVolume | 7 | N | Req. | Total peak volume for the usage types, max value 2^63 |
| TotalOPeakVolume | 8 | N | Req. | Total off peak volume for the usage types, max value 2^63 |
| TotalCPeakVolume | 9 | N | Req. | Total normal volume for the usage types, max value 2^63 |
| TotalAmount | 11 | N(7).N(2-3) | Req. | Total amount including starting fee with 2 or 3 decimals according to specific company configuration. |
| TotalStartfee | 12 | N(7).N(2-3) | Req. | Total starting fee with 2 or 3 decimals according to specific company configuration |
D8 - Usage destinations
Presents the destination details for all usage types the actual billmonth or billrun processId. The data record is sorted on the usage type field.
| Name | Nr | Format | Type | Description |
| Record type | 1 | D8 | Req. | Data record |
| UsageType | 2 | N | Req. | Usage type |
| ProductGroup | 3 | N | Req | Product group id |
| CompanyId | 4 | N | Req. | 1-99999. 0 if missing, Using Revenue Accounting services the ProcuctID from the Productcatalog will be presented |
| Description | 5 | X | Destination description | |
| Quantity | 6 | D | Req. | Quantity of destination occurrence |
| PeakVolume | 7 | N | Req. | Peak volume, max value 2^63 |
| OPeakVolume | 8 | N | Req. | Off peak volume, max value 2^63 |
| CPeakVolume | 9 | N | Req. | Normal volume, max value 2^63 |
| VatRate | 10 | N(2),N(2) | Req. | Vat rate |
| Amount | 11 | N(7).N(2-3) | Req. | Amount including starting fee with 2 or 3 decimals according to specific company configuration. |
| Startfee | 12 | N(7).N(2-3) | Starting fee for the usage type |
S8 Summation D8
Summarises the destinations for the actual billmonth or billrunId.
| Name | Nr | Format | Type | Description |
| Record type | 1 | S8 | Req. | Summarized Data record |
| TotalQuantity | 6 | D | Req. | Total quantity |
| TotalPeakVolume | 7 | N | Req. | Total peak volume, max value 2^63 |
| TotalOPeakVolume | 8 | N | Req. | Total off peak volume, max value 2^63 |
| TotalCPeakVolume | 9 | N | Req. | Total normal volume, max value 2^63 |
| TotalAmount | 11 | N(7).N(2-3) | Req. | Total amount including starting fee with 2 or 3 decimals according to specific company configuration. |
| TotalStartfee | 12 | N(7).N(2-3) | Req. | Total starting fee with 2 or 3 decimals according to specific company configuration. |
T - Trailer record
The trailer presents the total number of entries in the report.
| Name | Nr | Format | Type | Description |
| Record type | 1 | T | Req. | Trailer record |
| Total entries | 2 | N | Req. | Total number of entries |
Example of Total Statistics report
H;99999;CompanyName;;;210119;1433
I5;ProductCode;ProductGroup;CompanyId;Description;Quantity;VATRate;Amount
D5;123;22;0;Bredband;30;25.00;295.00
D5;A;67;0;Bredbandstelefoni;92;25.00;61.38
D5;B;67;0;Bredbandstelefoni månadsavg.;10;25.00;14.66
D5;C;67;0;Nummerpresentation;8;25.00;4.00
D5;D;67;0;Telesvar;20;25.00;2.93
D5;E;1;0;Mobil Surf;4;25.00;6.53
D5;F;22;0;ADSL 28Mb Månadsavgift;1;25.00;6.63
D5;G;22;0;ADSL 28Mb Månadsavgift;1;25.00;7.63
D5;H;3;0;Fakturaavgift;383;25.00;7277.00
D5;I;1;0;Mobil Månadsavgift;21;25.00;11.20
D5;J;2;0;Fast Abonnemang;1;25.00;2.99
D5;K;2;0;Fast Abonnemang;10;25.00;31.67
D5;L;2;0;Nummerpresentation;25;25.00;12.50
S5;;;;;606;;7734.12
I6;Description;ProductGroup;CompanyId;Quantity;VATRate;Amount
D6;Bredband Fasta kostnader;22;0;6;25.00;-1238.17
D6;Övrigt;3;0;22;25.00;-23853.00
S6;;;;28;;-25091.17
I7;UsageType;ProductGroup;CompanyId;Description;Quantity;PeakVolume;OPeakVolume;CPeakVolume;VATRate;Amount;Startfee
D7;5;12;0;Internationella samtal;8;400;0;0;25.00;9.48;2.56
D7;15;11;0;Nationella samtal;10;1289;0;0;25.00;7.71;4.26
T;24
Example of Total Statistics InvoiceMonth report
H;99999;CompanyName;;;210211;0758
H2;InvoiceMonth;;;2021-02
I5;ProductCode;ProductGroup;CompanyId;Description;Quantity;VATRate;Amount
D5;952;146;19500;Fakturaavgift;8;25.00;392.00
S5;;;;;31;;1519.00
I6;Description;ProductGroup;CompanyId;Quantity;VATRate;Amount
D6;Abonnemang - Extra sim-kort surf;501;100462;2;25.00;-566.00
S6;;;;2352;;-313019.67
I7;UsageType;ProductGroup;CompanyId;Description;Quantity;PeakVolume;OPeakVolume;CPeakVolume;VATRate;Amount;Startfee
D7;902;534;19485;Betalsamtal, förmedlad tjänst, Mobil;1;0;58;0;0.00;40.00;0.00
S7;;;;;2;0;115;0;;41.38;0.79
I8;UsageType;ProductGroup;CompanyId;Description;Quantity;PeakVolume;OPeakVolume;CPeakVolume;VATRate;Amount;Startfee
D8;902;534;19485;Betalförmedling, samtal;1;0;58;0;0.00;40.00;0.00
S8;;;;;2;0;115;0;;41.38;0.79
T;15
Example of Total Statistics FB01 report
H;99999;CompanyName;;;210211;0757
H2;FB01;FB01_99999_210201152700_556.DAT;2766108;2021-02
I5;ProductCode;ProductGroup;CompanyId;Description;Quantity;VATRate;Amount
D5;960;565;19498;Fakturaavgift;23;25.00;1127.00
S5;;;;;23;;1127.00
I6;Description;ProductGroup;CompanyId;Quantity;VATRate;Amount
D6;Abonnemang - Mobil;500;150904;35;25.00;6046.00
S6;;;;106;;5544.00
I7;UsageType;ProductGroup;CompanyId;Description;Quantity;PeakVolume;OPeakVolume;CPeakVolume;VATRate;Amount;Startfee
D7;302;531;19471;Mobilsamtal;1;0;57;0;25.00;1.38;0.79
S7;;;;;2;0;115;0;;41.38;0.79
I8;UsageType;ProductGroup;CompanyId;Description;Quantity;PeakVolume;OPeakVolume;CPeakVolume;VATRate;Amount;Startfee
D8;302;531;19471;Betalnummer;1;0;57;0;25.00;1.38;0.79
S8;;;;;2;0;115;0;;41.38;0.79
T;15
Example of Total Statistics WebCredit report
H;99999;CompanyName;;;210211;0758
H2;WebCredit;;123456;2021-02
I5;ProductCode;ProductGroup;CompanyId;Description;Quantity;VATRate;Amount
D5;952;146;19500;Fakturaavgift;8;25.00;392.00
S5;;;;;31;;1519.00
I6;Description;ProductGroup;CompanyId;Quantity;VATRate;Amount
D6;Abonnemang - Mobil;500;150908;5;25.00;1072.00
S6;;;;2352;;-313019.67
I7;UsageType;ProductGroup;CompanyId;Description;Quantity;PeakVolume;OPeakVolume;CPeakVolume;VATRate;Amount;Startfee
D7;902;534;19485;Betalsamtal, förmedlad tjänst, Mobil;1;0;58;0;0.00;40.00;0.00
S7;;;;;2;0;115;0;;41.38;0.79
I8;UsageType;ProductGroup;CompanyId;Description;Quantity;PeakVolume;OPeakVolume;CPeakVolume;VATRate;Amount;Startfee
D8;902;534;19485;Betalförmedling, samtal;1;0;58;0;0.00;40.00;0.00
S8;;;;;2;0;115;0;;41.38;0.79
T;15