Name convention
BRPT050_<CompanyNr>_<DateTime>_0[CreditInvoiceReport_<BatchId>].DAT
| Name | Description |
| CompanyNr | The company number in PayEx ledger system |
| DateTime | Date created in format YYYYMMDDHHMMSS |
| CreditInvoiceReport | Report type |
| BatchId | Billing processId |
Examples of report files.
BRPT050_99999_20190901081544_0[CreditInvoiceReport__2732732].DAT
Change log
| Version | Date | Description | Created by |
|---|---|---|---|
| 1.0 | 2019-10-01 | Created document | Jacob de Boer |
| 1.01 | 2022-07-27 | Updated "CreditSign" format from X to X(50) for both H1 and D1 | Anders Göthberg |
| 1.02 | 2023-09-05 | Added field 10 in H1 and D2 -record | Jacob de Boer |
General information and explanation of records
This document contains information about a report from the PayEx Billing System regarding all created credit invoices by the PayEx Webservice during a certain period. To create a credit invoice for a customer a debet invoice is the basis upon new credit information post are created. All credit invoices have been approved before creation.
BRPT050 is based on all created credit invoices created by the PayEx Webservice for a certain period. The report will be produced every month and presents all invoices which have been created for this period.
Format description
All fields in the mentioned reports 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 |
| Record type | 1 | H | Req. | Record type |
| Company number | 2 | N(5) | Req. | You receive the company number from PayEx. |
| Company name | 3 | X(40) | Req. | Your company name. |
| Period start | 4 | N(10) | Req. | YYYY-MM-DD – credit invoice information from date |
| Period end | 5 | N(10) | Req. | YYYY-MM-DD – credit invoice information until date |
| Created date | 6 | N(10) | Req. | YYYY-MM-DD – Same date as in the file name. |
Example on the records appearance.
H;99999;CompanyName;2019-08-01;2019-08-31;2019-09-01
H1 - Description information credit invoice record
| Field name | Field no. | Format | Type | Description |
| Record type | 1 | H1 | Req. | Record type |
| CreditInvoiceNo | 2 | CreditInvoiceNo | Req. | |
| CreditAmount | 3 | CreditAmount | Req. | |
| CustomerNo | 4 | CustomerNo | Req. | |
| DebitInvoiceNo | 5 | DebitInvoiceNo | Req. | |
| CapitalAmount | 6 | CapitalAmount | Req. | |
| ApprovalSign | 7 | ApprovalSign | Req. | |
| BillingApprovalDate | 8 | BillingApprovalDate | Req. | |
| CreditSign | 9 | CreditSign | Req. | |
| ReasonCode | 10 | ReasonCode | Req. |
Example on the records appearance.
H1;CreditInvoiceNo;CreditAmount;CustomerNo;DebitInvoiceNo;CapitalAmount;ApprovalSign;BillingApprovalDate;CreditSign;ReasonCode
D1 - Description credit invoice record
| Field name | Field no. | Format | Type | Description |
| Record type | 1 | D1 | Req. | Record type |
| CreditInvoiceNo | 2 | N(15) | Req. | Invoice number for the created credit invoice |
| CreditAmount | 3 | N(7),N(2-6) | Req. | CreditAmount |
| CustomerNo | 4 | X(1-15) | Req. | CustomerNo |
| DebitInvoiceNo | 5 | N(15) | Req. | DebitInvoiceNo on which the credit invoice is based on |
| CapitalAmount | 6 | N(7),N(2-6) | Req. | Amount |
| ApprovalSign | 7 | X(50) | Req. | Signature of person who approved the credit invoice* |
| BillingApprovalDate | 8 | N(10) | Req. | YYYY-MM-DD |
| CreditSign | 9 | X(50) | Req. | Signature(s) of person who initiated the credit invoice |
| ReasonCode | 10 | X(10) | Req. | ReasonCode** |
Examples on the records appearance.
D1;900100;-55.000;12345;800100;112.000; GUI_99999_admin@admin.com;2019-08-01;GUI_99999_user@user.com;11
D1;900200;-99.000;34567;800200;99.000; 4747474;2019-08-02;GUI_99999_user@user.com;19
*for automated approval a batchId (N7) will be presented
** Reason codes are configurated on company level and a list with codes are described in the company’s parameter document
S - Trailer record
| Field name | Field no | Format | Type | Description |
| Record type | 1 | S | Req. | Record type |
Example on the records appearance.
S