Name convention
BPXPRODUCT_<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. | |
| Billing process Id |
For example: BPXPRODUCT_9999_20210123121243_00123[123456].DAT
Change log
| Version | Date | Description | Created by |
|---|---|---|---|
| 1.1 | 2021-02-23 | Created document | Daniel Olsson |
General information and explanation of records
The report BPXPRODUCT presents billed non recurring and recurring product on both customer and subscription level.
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.
Record description
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 |
T2 - Billed (Created in conjunction with the creation of the invoice basis)
Source system: BILLING
| Field name | Field no. | Format | Type | Description |
| Recordtype | 1 | T2 | Req. | |
| SubBillId | 2 | X(20) | Req. | InvoiceID-number at Payex |
| YearMonth | 3 | X(6) | Req. | Month when the product was invoiced. Not to be confused with the parameter invoicemonth. |
| CustomerNo | 4 | X(15) | Req. | |
| SubscriberId | 5 | X(34) | ||
| ProductGroupId | 6 | N(9) | Req. | |
| ProductType | 7 | X(3) | Req. | Global types: (I = Recurring product and E = Non recurring product) I1: Product on customer level I2: Product on subscriber level E1: Product on customer level E2: Infoproduct on customer level E3: Product on subscriber level E4: Infoproduct on subscriber level E5: Non billable product on subscriber level E6: Non billable product on customer level |
| ProductCodeBase | 8 | X(5) | If recurring product then the product code from the base product. If non recurring product then empty. | |
| ProductCodeDeviation | 9 | X(5) | If recurring product then the product code from the deviant product. If non recurring product then empty. | |
| ProductId | 10 | N(9) | If recurring product then the products id in the Billing system. If non recurring product then empty. | |
| Description | 11 | X(150) | Req. | |
| IdNumber | 12 | N(9) | External id concept. (Identification_No in the PR file). | |
| Volume | 13 | N(9) | Req. | |
| TotalCharge | 14 | N(9).N(3) | Req. | |
| StartDate | 15 | X(10) | YYYY-MM-DD | |
| EndDate | 16 | X(10) | YYYY-MM-DD | |
| VatRate | 17 | N(2).(2) | Req. | |
| VatType | 18 | N(2) | ||
| SortOrder | 19 | N(19) | ||
| ExtProductId | 20 | X(16) | If recurring product then empty. If non recurring product then the products product id. | |
| UnitPrice | 21 | N(9).(2-6) | Req. | Unit price. |
| UnitPriceVolumeCode | 22 | X(10) | Req. | “D” = Day, “M” = Month or “F” = invoice or “N/A” = volume code missing. |
| VolumeCode | 23 | X(10) | Req. | “D” = Day, “M” = Month or “F” = invoice or “N/A” = volume code missing. |
| ProvisionBasis | 24 | N(1) | Req. | |
| SubBillRunid | 25 | N(9) | Req. |
T5 - Delete (Created in conjunction with the reversion of the billing.)
Source system: BILLING
Billing that has been reversed.
| Field name | Field no. | Format | Type | Description |
| Recordtype | 1 | T5 | Req. | |
| SubBillRunId | 2 | N(9) | Req. |
T51 - Delete (Created in conjunction with the reversion of billing using a BKB file)
Source system: BILLING
Billing that has been reversed.
| Field name | Field no. | Format | Type | Description |
| Recordtype | 1 | T51 | Req. | |
| SubBillId | 2 | X(20) | Req. | InvoiceID-number at Payex |
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 |