Wiki source code of Implementation Guide

Last modified by Anders Göthberg on 2025/12/30 14:50
Hide last authors
Andreas Benneck 4.1 1 (% id="HIntroduction" %)
Anders Göthberg 76.1 2 = =
Andreas Benneck 65.1 3
Andreas Benneck 4.1 4 = Introduction =
5
Andreas Benneck 65.1 6 (% class="jumbotron" %)
7 (((
8 (% class="container" %)
9 (((
Andreas Benneck 61.1 10 PayEx Billing creates invoices for the PayEx Ledger System. PayEx Billing compiles one-time and recurring fees and credits to an invoice per end customer. When creating an invoice, any debit or credit products are taken into account. The invoice information is then exported to PayEx Ledger System (invoice service) and PayEx Distribution System. Billing-files can be received and loaded automatically all around the clock every day of the year.
Andreas Benneck 65.1 11 )))
12 )))
Andreas Benneck 4.1 13
14
Andreas Benneck 65.1 15
Andreas Benneck 4.1 16 (% id="HPrerequisites" %)
17 == Prerequisites ==
18
Andreas Benneck 61.1 19 Before start implementing PayEx Billing the following is required:
Andreas Benneck 4.1 20
Andreas Benneck 27.2 21 * An Agreement Invoice Service with Billing together with:
22 ** A SFTP Client
23 ** Business Rules
Andreas Benneck 61.1 24 * Revenue Accounting Rules (If Revenue Accounting)
Andreas Benneck 4.1 25
Andreas Benneck 60.1 26 Feel free to [[contact us>>mailto:billing.client@payex.com]] if you have any questions on how to get started.
Andreas Benneck 4.1 27
Anders Göthberg 73.1 28 [[image:1767100785085-448.png||height="606" width="962"]]
Andreas Benneck 64.1 29
Andreas Benneck 3.1 30 == Overview ==
31
Andreas Benneck 21.2 32 Before getting started, have a look at the high level sequence diagram below, which will help you getting a better understanding of the process and the components necessary to implement Invoice Service.
Andreas Benneck 3.1 33
Andreas Benneck 64.1 34 (% class="wikigeneratedid" id="HWhatyoushoulddo2Cstepbystep." %)
Anders Göthberg 70.1 35 All main steps of the invoice process are described below. **Please note** that all examples below are primarily for visualization, to help you get an understanding of the KUB file format and to support you in the implementation.
Andreas Benneck 3.1 36
Andreas Benneck 60.1 37 If you encounter any problem during implementation, don't hesitate to [[contact us>>mailto:billing.client@payex.com]].
Andreas Benneck 3.1 38
Anders Göthberg 59.1 39 (% id="HIOverview" %)
Anders Göthberg 54.1 40 == Information Overview ==
Andreas Benneck 2.1 41
Andreas Benneck 61.1 42 PayEx Billing aggregates one-time and recurring fees & credits to one invoice per end customer. When creating invoice information, any submitted discounts and credit products are taken into account. The invoice is then exported to PayEx ledger system and PayEx Distribution system (creation of invoices and mailings to distribution).
Andreas Benneck 2.1 43
Andreas Benneck 27.3 44 When implementing Invoice Service Billing with Revenue Accounting, customer-specific configuration takes place.
Andreas Benneck 2.1 45
46 (% id="HKUB28Customerfilecsv29" %)
47 === KUB (Customerfile csv) ===
48
Andreas Benneck 27.3 49 Customer file to PayEx billing (KUB) is used to submit end-user information to the PayEx Billing system. KUB contains the end customer information for example address, subscription numbers and recurring products to be processed in the PayEx Billing System.
Andreas Benneck 2.1 50
51 (% id="HPR0128Productfilecsv29" %)
Anders Göthberg 77.1 52 === PR01 (Productfile csv) ===
Andreas Benneck 2.1 53
Andreas Benneck 27.3 54 Using PR01 files in the PayEx Billing system gives possibilities to create non recurrent products on both customer and subscription level.
Andreas Benneck 2.1 55
Andreas Benneck 61.1 56 Communication of non recurring products that will be added at the end customer level. The product file contains information about price (+/-), VAT rate and the product name (invoice text) that is communicated to the end customer.
Andreas Benneck 2.1 57
58 (% id="HReceipt" %)
Anders Göthberg 77.1 59 === Receipt and/or Error logs ===
Andreas Benneck 2.1 60
Anders Göthberg 77.1 61 After Billing processing any files sent by the company a receipt and/or error log will be created.
Andreas Benneck 2.1 62
Anders Göthberg 77.1 63 Detailed description of all all files can be find under [[Billing File>>doc:Main.Invoicing.billing.technical-reference.Billing File.WebHome]].
Andreas Benneck 2.1 64
65 (% id="HReports" %)
66 == Reports ==
67
Andreas Benneck 30.1 68 Many different reports with statistics can be created after every billrun or per month. Below will always be produced.
Andreas Benneck 2.1 69
70 (% id="HInvoiceJournalBilling" %)
71 === Invoice Journal Billing ===
72
Andreas Benneck 27.3 73 For every billrun in the PayEx Billing System an Invoice Journal is being created. The Invoice Journal contains information regarding the new invoice numbers and associated customers, amounts and VAT. File has XML format.
Andreas Benneck 2.1 74
Andreas Benneck 17.2 75 (% id="HQueuepostReport" %)
76 === UnbilledReport ===
77
Andreas Benneck 29.1 78 Reports for unbilled fees/usage can be produced both before and after a billrun. UnbilledReport are both produced in the skv-format aswell as in text format
Andreas Benneck 17.2 79
Anders Göthberg 49.1 80 == Revenue Accounting ==
Andreas Benneck 17.3 81
Anders Göthberg 47.1 82 Revenue Accounting is an optional service for PayEx companies.
83
Anders Göthberg 76.1 84 (% id="HRevenueAccountingRules" %)
85 === Revenue Accounting Rules ===
86
87 Companies that want the additional service "Revenue Accounting" need to work with Billing to set up the rules for how the accounting of the company's own invoice receivables should work so that the company can reconcile this in its accounting system.
88
89 (% id="HProductCatalog" %)
90 === Product Catalog ===
91
92 The product catalog contains instructions about how all products should be booked in correlation with revenue accounting.
93
Andreas Benneck 2.1 94 (% id="HBillingAccounting" %)
95 === BillingAccounting ===
96
Andreas Benneck 30.2 97 Each Billrun will be booked and there will be produced a report with name BillingAccounting.xml contains:
Andreas Benneck 2.1 98
99 (% role="list" %)
100 * (((
101 (% data-ccp-props="{~"335551550~":1,~"335551620~":1,~"335559683~":0,~"335559685~":450,~"335559731~":-450,~"335559737~":0,~"335562764~":2,~"335562765~":1,~"335562766~":4,~"335562767~":0,~"335562768~":4,~"335562769~":0}" data-indent="-450" lang="EN-US" paraeid="{5c66c65e-8d9e-4bcf-a86e-8e130028a5b7}{93}" paraid="0" %)
102 Invoicenumber​
103 )))
104 * (((
105 (% data-ccp-props="{~"335551550~":1,~"335551620~":1,~"335559683~":1,~"335559685~":1170,~"335559731~":-450,~"335559737~":0,~"335562764~":2,~"335562765~":1,~"335562766~":4,~"335562767~":0,~"335562768~":4,~"335562769~":0}" data-indent="-450" lang="EN-US" paraeid="{5c66c65e-8d9e-4bcf-a86e-8e130028a5b7}{96}" paraid="0" %)
106 VAT code
107 )))
108 * (((
109 (% data-ccp-props="{~"335551550~":1,~"335551620~":1,~"335559683~":1,~"335559685~":1170,~"335559731~":-450,~"335559737~":0,~"335562764~":2,~"335562765~":1,~"335562766~":4,~"335562767~":0,~"335562768~":4,~"335562769~":0}" data-indent="-450" lang="EN-US" paraeid="{5c66c65e-8d9e-4bcf-a86e-8e130028a5b7}{96}" paraid="0" %)
110 Account
111 )))
112 * (((
113 (% data-ccp-props="{~"335551550~":1,~"335551620~":1,~"335559683~":1,~"335559685~":1170,~"335559731~":-450,~"335559737~":0,~"335562764~":2,~"335562765~":1,~"335562766~":4,~"335562767~":0,~"335562768~":4,~"335562769~":0}" data-indent="-450" lang="EN-US" paraeid="{5c66c65e-8d9e-4bcf-a86e-8e130028a5b7}{96}" paraid="0" %)
114 ProductCode
115 )))
116 * (((
117 (% data-ccp-props="{~"335551550~":1,~"335551620~":1,~"335559683~":1,~"335559685~":1170,~"335559731~":-450,~"335559737~":0,~"335562764~":2,~"335562765~":1,~"335562766~":4,~"335562767~":0,~"335562768~":4,~"335562769~":0}" data-indent="-450" lang="EN-US" paraeid="{5c66c65e-8d9e-4bcf-a86e-8e130028a5b7}{96}" paraid="0" %)
118 Group company code
119 )))
120 * (((
121 (% data-ccp-props="{~"335551550~":1,~"335551620~":1,~"335559683~":1,~"335559685~":1170,~"335559731~":-450,~"335559737~":0,~"335562764~":2,~"335562765~":1,~"335562766~":4,~"335562767~":0,~"335562768~":4,~"335562769~":0}" data-indent="-450" lang="EN-US" paraeid="{5c66c65e-8d9e-4bcf-a86e-8e130028a5b7}{99}" paraid="0" %)
122 Cost center
123 )))
124 * (((
125 (% data-ccp-props="{~"335551550~":1,~"335551620~":1,~"335559683~":1,~"335559685~":1170,~"335559731~":-450,~"335559737~":0,~"335562764~":2,~"335562765~":1,~"335562766~":4,~"335562767~":0,~"335562768~":4,~"335562769~":0}" data-indent="-450" lang="EN-US" paraeid="{5c66c65e-8d9e-4bcf-a86e-8e130028a5b7}{102}" paraid="0" %)
126 Amount
Andreas Benneck 8.6 127 )))
128
129 (% id="HBilledInAdvanced" %)
Andreas Benneck 2.1 130 === BilledInAdvanced ===
131
Andreas Benneck 30.2 132 To close the books regarding revenue accounting every month an XML report regarding all billed fees which have been billed in advance will be created. This means that these fees have a later billmonth then current billmonth.
Andreas Benneck 2.1 133
134 (% id="HUnbilledProduct" %)
135 === UnbilledProduct ===
136
Andreas Benneck 30.2 137 Another possible report to close the books every month with. This XML report contains all processed fees with associated revenue ID in the PayEx Billing System, but not billed yet.