Name convention
Revenue reports
BRPT005_<CompanyNumber>_<DateTime>_0[RevenueReport_NRP_<BatchId>].DAT
BRPT006_<CompanyNumber>_<DateTime>_0[RevenueReport_U_<BatchId>].DAT
BRPT007_<CompanyNumber>_<DateTime>_0[RevenueReport_RP_<BatchId>].DAT
BRPT035_<CompanyNumber>_<DateTime>_0[RevenueReport_Calls_<BatchId>].DA
Names Component | Description |
---|---|
CompanyNumber | The company number in PayEx ledger system |
DateTime | Date created in format YYYYMMDDHHMMSS |
BatchId | The identification number from the creation of the InvoiceJournal creation process ID |
For example:
BRPT005_99999_20210308093539_0[RevenueReport_NRP_1234567].DAT
BRPT006_99999_20210308093539_0[RevenueReport_U_1234567].DAT
BRPT007_99999_20210308093539_0[RevenueReport_RP_1234567].DAT
BRPT035_99999_20210308093539_0[RevenueReport_Calls_1234567].DAT
The file is semicolon-separated.
Change log
Version | Date | Description | Created by |
---|---|---|---|
1.0 | 2019-08-01 | First version. | Tomas Kristoffersson |
General information and explanation of records
The "revenue reports" contains information about 4 different reports from the PayEx billingsystem regarding billed products and usage. These reports can be generated
on billmonth or billrun.
- BRPT005 RevenueReport_NRP, customer usage based on one-time fees/credits
- BRPT006 Report, Usage based on call type
- BRPT007 RevenueReport_RP, customer usage based on recurring fees/credits
- BRPT035 RevenueReport_Usage, customer usage based om call type in combination with pricelistinformation
Format description
All fields in the mentioned reports are separated with semicolons ”;”. Sort order is Customer number.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.
Record descriptions
BRPT005 (NRP)
This report is based on information sent to PayEx in the product file. Products can occure on either customer- and/or a-number level (based on how it is defined in the product file).
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 | N(10) | YYYY-MM-DD – Billing cycle | |
BatchID | 5 | N(10) | BatchID | |
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;2020-12-01; 00123; 181206;1200
B - Description record (NRP)
Field name | Field no. | Format | Type | Description |
Record type | 1 | B | Req. | Record type |
Customer number | 2 | KundNr | Req. | Customer number. |
MSISDN number | 3 | A-nr | Req. | The customers subscription number (a-number). |
Id-number | 4 | IdentifikationsNr | Req. | A description of the Id-number . |
Description | 5 | Klartext | Req. | Product description |
From date | 6 | Fom-datum | Req. | From date |
To date | 7 | Tom-datum | Req. | To date |
Number of products | 8 | Antal | Req. | The number of products of the product. |
Amount | 9 | Apris | Req. | The total amount for the product. (price * number of products) |
Example on the records appearance.
B;Kundnr;A-nr;Identifikationsnr;Klartext;Fom-datum;Tom-datum;Antal;aPris
T - Transaction record (NRP)
Field name | Field no. | Format | Type | Description |
Record type | 1 | T | Req. | Record type |
Customer number | 2 | X(15) | Req. | Customer number. |
MSISDN number | 3 | X(34) | Req. | The customers subscription number (a-number). |
Id-number | 4 | N(5) | Req. | A description of the Id-number . |
Description | 5 | X(120) | Req. | Product descripition |
From date | 6 | N(10) | Req. | From date |
To date | 7 | N(10) | Req. | Todate |
Number of products | 8 | N(10) | Req. | The number of products of the product. |
Amount | 9 | N(17).N(2-3) | Req. | The total amount for the product. |
Example on the records appearance.
T;1234567;0703123456;20;l0;250.000
S - Trailer record
Field name | Field no | Format | Type | Description |
Record type | 1 | S | Req. | Record type |
Total number of records | 2 | N(8) | Req. | Number of records, header record, description record and trailer record included. |
Number of records | 3 | N(8) | Req. | Number of records header record, description record and trailer record excluded. |
Example on the records appearance.
S;23;20
BRPT006 (U)
This report contains information about invoiced calls sorted on customer number and calltype.
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 | N(10) | YYYY-MM-DD – Billing cycle | |
BatchID | 5 | N(10) | BatchID | |
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;2019-01-01;123456;181201;1200
Description record (U)
Field name | Field no. | Format | Type | Description |
Record type | 1 | B | Req. | Record type |
Customer number | 2 | X(15) | Req. | Customer number. |
MSISDN number | 3 | X(34) | Req. | The customers subscription number (a-number). |
Call Type | 4 | X(3) | Req. | A description of the used call type. |
Number of calls | 5 | N(10) | Req. | The number of calls to the call type. |
Off-PeakSec | 7 | N(19) | Req. | The volume in seconds made on off-peak for the call type. |
PeakSec | 6 | N(19) | Req. | The volume in seconds made on peak for the call type. |
Amount | 8 | N(17).N(2-3) | Req. | The total amount for the consumed time for the call type. |
Example on the records appearance.
B;KundNr;A-nr;Samtalstyp;Antal;Off-PeakSec;PeakSec;Amount
T - Transaction record (U)
Field name | Field no. | Format | Type | Description | |
Record type | 1 | T | Req. | Record type | |
Customer number | 2 | X(15) | Req. | Customer number. | |
MSISDN number | 3 | X(34) | Req. | The customers subscription number (a-number). | |
Call Type | 4 | N(3) | Req. | A description of the used call type. | |
Number of calls | 5 | N(10) | Req. | The number of calls to the call type. | |
PeakSec | 6 | N(19) | Req. | The volume in seconds made on peak (price) for the call type. | |
Off-PeakSec | 7 | N(19) | Req. | The volume in seconds made on off-peak (price) for the call type. | |
Amount | 8 | N(17).N(2-3) | Req. | The total amount for the consumed volume for the call type. |
Example on the records appearance.
T;1234567;0703123456;15;l0;123;15;24.500
S - Trailer record
Field name | Field no | Format | Type | Description |
Record type | 1 | S | Req. | Record type |
Number of T-records | 3 | N(8) | Req. | Number of T-records. |
Number of records | 2 | N(8) | Req. | Number of records, header record, description record and trailer record included. |
Example on the records appearance.
S;20;23
BRPT006 (U/Peak)
This report contains information about invoiced calls sorted on customer number and calltype.
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 | N(10) | YYYY-MM-DD – Billing cycle | |
BatchID | 5 | N(10) | BatchID | |
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;2020-01-01; 123456; 181201;1200
B - Description record (U/Peak)
Field name | Field no. | Format | Type | Description |
Record type | 1 | B | Req. | Record type |
Customer number | 2 | X(15) | Req. | Customer number. |
MSISDN number | 3 | X(34) ? | Req. | The customers subscription number (a-number). |
Call Type | 4 | X(3) | Req. | A description of the used call type. |
Number of calls | 5 | N(10) | Req. | The number of calls to the call type. |
PeakSec | 6 | N(19) | Req. | The volume in seconds made on peak (price) for the call type. |
Semi-PeakSec | 7 | N(19) | Req. | The volume in seconds made on semi-peak (price) for the call type. |
Off-PeakSec | 8 | N(19) | Req. | The volume in seconds made on off-peak (price) for the call type. |
Amount | 9 | N(17).N(2-3) | Req. | The total amount for the consumed time for the call type. |
Example on the records appearance.
B;KundNr;A-nr;Samtalstyp;Antal;PeakSec;Semi-PeakSec;Off-PeakSec;Amount
T - Transaction record (U/Peak)
Field name | Field no. | Format | Type | Description |
Record type | 1 | T | Req. | Record type |
Customer number | 2 | X(15) | Req. | Customer number. |
MSISDN number | 3 | X(34) | Req. | The customers subscription number (a-number). |
Call Type | 4 | N(3) | Req. | A description of the used call type. |
Number of calls | 5 | N(10) | Req. | The number of calls to the call type. |
PeakSec | 6 | N(19) | Req. | The volume in seconds made on peak (price) for the call type. |
Semi-PeakSec | 7 | N(19) | Req. | The volume in seconds made on semi-peak (price) for the call type. |
Off-PeakSec | 8 | N(19) | Req. | The volume in seconds made on off-peak (price) for the call type. |
Amount | 9 | N(17).N(2-3) | Req. | The total amount for the volume for the call type. |
Example on the records appearance.
T;1234567;0703123456;15;l0;123;15;0;24.500
S - Trailer record
Field name | Field no | Format | Type | Description |
Record type | 1 | S | Req. | Record type |
Number of T-records | 3 | N(8) | Req. | Number of T-records. |
Number of records | 2 | N(8) | Req. | Number of records, header record, description record and trailer record included. |
Example on the records appearance.
S;20;23
BRPT007 (RP)
This report is based on billed fees which has been sent to PayEx as recurring fees by the customer file. Products can occure on either on a customer- or a-number level. Recurring fees can be billed on both customerlevel and a-number level.
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 | N(10) | YYYY-MM-DD – Billing cycle | |
BatchID | 5 | N(10) | BatchID | |
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;2018-12-01; 00123; 181206;1200
B - Description record (RP)
Field name | Field no. | Format | Type | Description |
Record type | 1 | B | Req. | Record type |
Customer number | 2 | KundNr | Req. | Customer number. |
MSISDN number | 3 | A-nr | Req. | The customers subscription number (a-number). |
Id-number | 4 | IdentifikationsNr | Req. | A description of the Id-number . |
Product code | 5 | Produkt | Req. | Product code. |
Number of products | 6 | Antal | Req. | The number of products of the product. |
Amount | 7 | Belopp | Req. | The total amount for the product. |
Example on the records appearance.
B;KundNr;A-nr;IdentifikationsNr;Produkt;Antal;Belopp
T - Transaction record (RP)
Field name | Field no. | Format | Type | Description |
Record type | 1 | T | Req. | Record type |
Customer number | 2 | X(15) | Req. | Customer number. |
MSISDN number | 3 | X(34) | The customers subscription number (a-number). | |
Id-number | 4 | N(5) | A description of the Id-number . | |
Product code | 5 | N(5) | Req. | Product code. |
Number of products | 6 | N(10) | Req. | The number of products of the product. |
Amount | 7 | N(17).N(2-3) | Req. | The total amount for the product. |
Example on the records appearance.
T; 1234567;0703123456;;P01;480;0.000
S - Trailer record
Field name | Field no | Format | Type | Description |
Record type | 1 | S | Req. | Record type |
Total number of records | 2 | N(8) | Req. | Number of records, header record, description record and trailer record included. |
Number of records | 3 | N(8) | Req. | Number of records, header record, description record and trailer record excluded. |
Example on the records appearance.
S;23;20
BRPT035 (Calls)
This report contains information about invoiced calls with connected pricelists.
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 | N(10) | YYYY-MM-DD – Billing cycle | |
BatchID | 5 | N(10) | BatchID | |
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;2020-12-01; 00123; 181206;1200
B - Description record (Calls)
Field name | Field no. | Format | Type | Description |
Record type | 1 | B | Req. | Record type |
Customer number | 2 | X(15) | Req. | Customer number. |
MSISDN number | 3 | X(34) ? | Req. | The customers subscription number (a-number). |
Call Type | 4 | X(3) | Req. | A description of the used call type. |
Number of calls | 5 | N(10) | Req. | The number of calls to the call type. |
PeakSec | 6 | N(19) | Req. | The volume in seconds made on peak (price) for the call type. |
Semi-PeakSec | 7 | N(19) | Req. | The volume in seconds made on semi-peak (price) for the call type. |
Off-PeakSec | 8 | N(19) | Req. | The volume in seconds made on off-peak (price) for the call type. |
Amount | 9 | N(17).N(2-3) | Req. | The total amount for the consumed time for the call type. |
Pricelist | 10 | X(10) | Req. | Pricelist used to rate call. |
Example on the records appearance.
B;CustomerNo.;MSISDN;Calltype;No.OfCalls;PeakSec;Semi-PeakSec;Off-PeakSec;Amount;Pricelist
T - Transaction record (Calls)
Field name | Field no. | Format | Type | Description |
Record type | 1 | T | Req. | Record type |
Customer number | 2 | X(15) | Req. | Customer number. |
MSISDN number | 3 | X(34) | Req. | The customers subscription number (a-number). |
Call Type | 4 | N(3) | Req. | A description of the used call type. |
Number of calls | 5 | N(10) | Req. | The number of calls to the call type. |
PeakSec | 6 | N(19) | Req. | The volume in seconds made on peak (price) for the call type. |
Semi-PeakSec | 7 | N(19) | Req. | The volume in seconds made on semi-peak (price) for the call type. |
Off-PeakSec | 8 | N(19) | Req. | The volume in seconds made on off-peak (price) for the call type. |
Amount | 9 | N(17).N(2-3) | Req. | The total amount for the volume for the call type. |
Pricelist | 10 | X(10) | Pricelist used to rate call. |
Example on the records appearance.
T;1234567;0703123456;15;l0;123;15;0;24.500;PRICE
S - Trailer record
Field name | Field no | Format | Type | Description |
Record type | 1 | S | Req. | Record type |
Number of T-records | 3 | N(8) | Req. | Number of T-records. |
Number of records | 2 | N(8) | Req. | Number of records, header record, description record and trailer record included. |
Example on the records appearance.
S;20;23