Records
H - Header
| Field name | Field no. | Format | Type | Description |
|---|---|---|---|---|
| Transaction type | 1 | H | Req | Header record |
| Firm number | 2 | N(5) | Req | The firm number you receive from PayEx |
| Firm name | 3 | X(40) | Req | Your firm name |
| Created date | 4 | N(6) | Req | YYMMDD – the same date as in the filename. |
| Created time | 5 | N(4) | Req | HHMM – the time of creation. |
Example on the records appearance.
H;1234;Firm;180919;1220
M - Metadata record
| Field name | Filed no. | Format | Type | Description |
|---|---|---|---|---|
| Transaction type | 1 | M | Req | Metadata record |
| Type of billing | 2 | N(2) | Req | 0 = ordinary invoicing (default). 1 – n = test invoicing. Support for test invoicing and the different codes to be used are set up in cooperation with PayEx. |
| Reserved | 3 | Reserved for future use |
Example on the records appearance
M;0;
P - Product record
| Field name | Field no. | Format | Type | Description |
|---|---|---|---|---|
| Transaction type | 1 | P | Product record. | |
| Customer number | 2 | X(15) | Req | Customer number |
| Product text | 3 | X(73) | Req | Product text, see Definitions and terms |
| Quantity | 4 | N(5) | Req | Number of products |
| Unit | 5 | N(7),N(2-6) | Req | Price for one product, can have 2 to 6 decimals. |
| VAT rate | 6 | N(7),N(2) | Req | VAT rate |
| Product_group_Id | 7 | N(5) | Req | According to agreement with PayEx. |
| Identification_No | 8 | N(10) | Id used to group statistics. Required when service Revenue Accounting is active, maximum value 231 | |
| Product_Id | 9 | N(10) | Id for the product, maximum value 231 |
Example on the records appearance.
P;12345;Football1;5;23,50;25,00;2;;
P;12345;Football2;5;23,50;25,00;2;1;12365487
K - Customer number Information record
**Is not used without agreement
| Field name | Field no. | Format | Type | Description |
|---|---|---|---|---|
| Transaction type | 1 | K | Product record. | |
| Customer number | 2 | X(15) | Req | Customer number |
| Product text | 3 | X | Req | Product text, see Definitions and terms |
| Product_group_Id | 4 | N(5) | Req | According to agreement with PayEx.* |
| Group_No | 5 | N(3) | Is empty if nothing else is agreed. |
Example on the records appearance:
K;000087;Installation: the Villa;9;
*Product_group_id is set according to agreement for CustnoInformation record.
I - A -number Information record
**Is not used without agreement
| Field name | Field no | Format | Type | Description |
|---|---|---|---|---|
| Transaction type | 1 | I | Product record. | |
| Customer number | 2 | X(15) | Req | Customer number |
| A-number | 3 | X(34) | Req | A-number |
| Product text | 4 | X | Req | Product text, see Definitions and terms |
| Product_group_Id | 5 | N(5) | Req | According to agreement with PayEx.* |
| Group_No | 6 | N(3) | Is left blank if nothing else is agreed. |
Example on the records appearance:
I;000087;0702402377;Installation: The house;9;
* Product_group_id is set according to agreement for A -no Information record.
A - A -number product record
| Field name | Field no | Format | Type | Description |
|---|---|---|---|---|
| Transaction type | 1 | A | Product record. | |
| Customer number | 2 | X(15) | Req | Customer no. |
| A-number | 3 | X(34) | Req | A-Number |
| Product text | 4 | X | Req | Product text, see Definitions and terms |
| Quantity | 5 | N(5) | Req | Number of products |
| Unit | 6 | N(7),N(2-6) | Req | Price for one product, can have 2 to 6 decimals. |
| VAT rate | 7 | N(7),N(2) | Req | VAT rate |
| Product_group_Id | 8 | N(5) | Req | According to agreement with PayEx. |
| Identification_No | 9 | N(10) | Id used to group statistics. Required when service Revenue Accounting is active, maximum value 231 | |
| Product_Id | 10 | N(10) | Id for the product, maximum value 231 |
Example on the records appearance:
A;12345;4788743;Installation fee1;5;150,00;25,00;1;2;
A;12345;4788743;Installation fee3;5;150,00;25,00;1;2;123456
Q - Date product record
**Is not used without agreement
| Field name | Field no | Format | Type | Description |
|---|---|---|---|---|
| Transaction type | 1 | Q | Product record. | |
| Customer number | 2 | X(15) | Req | Customer number |
| Product text | 3 | X | Req | Product text, see Definitions and terms |
| Quantity | 4 | N(5) | Req | Number of products |
| Unit | 5 | N(7),N(2-6) | Req | Price for one product, can have 2 to 6 decimals. |
| VAT rate | 6 | N(7),N(2) | Req | VAT rate |
| Product_group_Id | 7 | N(5) | Req | According to agreement with PayEx. |
| From-date | 8 | N(8) | Req | YYYYMMDD – Date from when the product is active |
| To-date | 9 | N(8) | Req | YYYYMMDD – Date from when the product no longer is active |
| Identification_No | 10 | N(10) | Id used to group statistics. Required when service Revenue Accounting is active, maximum value 231 | |
| Product_Id | 11 | N(10) | Id for the product, maximum value 231 | |
| Product property 1 | 12 | N(1) | Property for product (0-9) ex. for grouping on invoice layout | |
| Product property 2 | 13 | N(1) | Property for product (0-9) | |
| Product property 3 | 14 | N(1) | Property for product (0-9) |
Note! When service Revenue Accounting is active, the dates must be within revenue month. It is only allowed to use from- and to-date within a calendar month. Use of “Product property” field is set up in agreement with PayEx
Example on the records appearance:
Q;12345;Football1;5;23,50;25,00;2;20180101;20181001;1;;;;
Q;12345;Football2;5;23,50;25,00;2;20180101;20181001;1;1234567;1;2;8
B - Date A -number product record
**Is not used without agreement
| Field name | Field no | Format | Type | Description |
|---|---|---|---|---|
| Transaction type | 1 | B | Product record. | |
| Customer number | 2 | X(15) | Req | Customer number |
| A-Number | 3 | X(34) | Req | A-Number |
| Product text | 4 | X | Req | Product text, see Definitions and terms |
| Quantity | 5 | N(5) | Req | Number of products |
| Unit | 6 | N(7),N(2-6) | Req | Price for one product, can have 2 to 6 decimals. |
| VAT rate | 7 | N(7),N(2) | Req | VAT rate |
| Product_group_Id | 8 | N(5) | Req | According to agreement with PayEx. |
| From-date | 9 | N(8) | Req | YYYYMMDD – Date from when the product is active |
| To-date | 10 | N(8) | Req | YYYYMMDD – Date from when the product no longer is active |
| Identification_No | 11 | N(10) | Id used to group statistics. Required when service Revenue Accounting is active, maximum value 231 | |
| Product_Id | 12 | N(10) | Id for the product, maximum value 231 | |
| Product property 1 | 13 | N(1) | Property for product (0-9) ex. for grouping on invoice layout | |
| Product property 2 | 14 | N(1) | Property for product (0-9) | |
| Product property 3 | 15 | N(1) | Property for product (0-9) |
Note! When service Revenue Accounting is active, the dates must be within revenue month. It is only allowed to use from- and to-date within a calendar month. Use of “Product property” field is set up in agreement with PayEx
Example on the records appearance:
B;12345;4788743;Installationfee1;5;150,00;25,00;1;20180101;20181001;2;;;;
B;12345;4788743;Installationfee2;5;150,00;25,00;1;20180101;20181001;2;123456;1;2;8
S - Trailer record
| Field name | Field no | Format | Type | Description |
|---|---|---|---|---|
| Transaction type | 1 | S | Req | Trailer record. |
| Number of records. | 2 | N(8) | Req | Number of records, main record and end record included. |
Example on the records appearance:
S;10
Example on appearance
H;99999;TestFirm;180919;1002
M;0;
P;sp000012;Dressing gown; 3;350,00;25,00;3;;
P;sp000012;Mug; 3;50,00;25,00;3;;134567
P;sp000302;Dressing gown; 1;350,00;25,00;3;214;
I;000087;0702402377;Installation: House;9;
I;000087;0702402377;Calculated year consumption: 24795 kWh;9;
I;000087;0702402377;Calculated meter reading: 000731: 28671;9;
A;000087;0702402377;Electricity june;992;0,129;25,00;6;147;
A;000087;0702402377;Energy tax june;992;0,162;25,00;6;;123456
Q;12345Football;5;23,50;25,00;2;20180101;20181001;1;1;2;8
B;12345;4788743;Installfee;5;150,00;25,00;1;20180101;20181001;212;125478;1;2;8
S;12
Definitions and terms
Header record and Trailer record exists only once. Records of the type P, A, I, Q, K and B can exist a multiply of times for a single customer number. The maximum length of the product text is depending on which type of invoice layout is used, and is therefore agreed with PayEx.
There are also some limitations regarding which characters can be used in the product text. See below “Characters that can not be used in product text field”.
Characters that not can be used in product text field.
| Character | ASCII | Function |
|---|---|---|
| 0 | NUL | |
| 1 | SOH | |
| 2 | STX | |
| 3 | ETX | |
| 4 | EOT | |
| 5 | ENQ | |
| 6 | ACK | |
| 7 | BEL | |
| 8 | BS | |
| 9 | TAB | |
| 10 | LF | |
| 11 | VT | |
| 12 | FF | |
| 13 | CR | |
| 14 | SO | |
| 15 | SI | |
| 16 | DLE | |
| 17 | DC1 | |
| 18 | DC2 | |
| 19 | DC3 | |
| 20 | DC4 | |
| 21 | NAK | |
| 22 | SYN | |
| 23 | ETB | |
| 24 | CAN | |
| 25 | EM | |
| 26 | SUB | |
| 27 | ESC | |
| 28 | FS | |
| 29 | GS | |
| 30 | RS | |
| 31 | US | |
| ; | 59 | Semicolon |
| | | 124 | Vertical line |
| ~ | 126 | Tilde |
| 127 | DEL | |
| – | 150 | Simple dash |
Characters that not can be used in A-number field.
| Character | ASCII | Function |
|---|---|---|
| 0 | NUL | |
| 1 | SOH | |
| 2 | STX | |
| 3 | ETX | |
| 4 | EOT | |
| 5 | ENQ | |
| 6 | ACK | |
| 7 | BEL | |
| 8 | BS | |
| 9 | TAB | |
| 10 | LF | |
| 11 | VT | |
| 12 | FF | |
| 13 | CR | |
| 14 | SO | |
| 15 | SI | |
| 16 | DLE | |
| 17 | DC1 | |
| 18 | DC2 | |
| 19 | DC3 | |
| 20 | DC4 | |
| 21 | NAK | |
| 22 | SYN | |
| 23 | ETB | |
| 24 | CAN | |
| 25 | EM | |
| 26 | SUB | |
| 27 | ESC | |
| 28 | FS | |
| 29 | GS | |
| 30 | RS | |
| 31 | US | |
| 32 | Space | |
| $ | 36 | Dollarsign |
| * | 42 | Asterisk |
| ; | 59 | Semicolon |
| < | 60 | Less then |
| ^ | 94 | Caret |
| ` | 96 | Acute accent |
| | | 124 | Vertical line |
| ~ | 126 | Tilde |
| 127 | DEL | |
| – | 150 | Simple dash |
| ¤ | 164 | General currency symbol |