Wiki source code of Implementation Guide

Last modified by Anders Göthberg on 2022/05/20 11:14
Show last authors
1 (% id="HIntroduction" %)
2 = =
3
4 = Introduction =
5
6 (% class="jumbotron" %)
7 (((
8 (% class="container" %)
9 (((
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.
11 )))
12 )))
13
14
15
16 (% id="HPrerequisites" %)
17 == Prerequisites ==
18
19 Before start implementing PayEx Billing the following is required:
20
21 * An Agreement Invoice Service with Billing together with:
22 ** A SFTP Client
23 ** Business Rules
24 * Revenue Accounting Rules (If Revenue Accounting)
25
26 Feel free to [[contact us>>mailto:billing.client@payex.com]] if you have any questions on how to get started.
27
28 [[image:1653037758665-469.png||height="469" width="759"]]
29
30 == Overview ==
31
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.
33
34 (% class="wikigeneratedid" id="HWhatyoushoulddo2Cstepbystep." %)
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 Bicus2/KUB file format and to support you in the implementation.
36
37 If you encounter any problem during implementation, don't hesitate to [[contact us>>mailto:billing.client@payex.com]].
38
39 (% id="HIOverview" %)
40 == Information Overview ==
41
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).
43
44 When implementing Invoice Service Billing with Revenue Accounting, customer-specific configuration takes place.
45
46 (% id="HBicus228Customerfilexml29" %)
47 === Bicus2 (Customerfile xml) ===
48
49 Customer file to billing (Bicus2) is used to submit end-user information to the PayEx Billing system. Bicus2 contains the end customer information for example address, subscription numbers and recurring products to be processed in the PayEx Billing System.
50
51 (% id="HKUB28Customerfilecsv29" %)
52 === KUB (Customerfile csv) ===
53
54 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.
55
56 (% id="HPR0128Productfilecsv29" %)
57 === PR01 (Productfile) ===
58
59 Using PR01 files in the PayEx Billing system gives possibilities to create non recurrent products on both customer and subscription level.
60
61 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.
62
63 (% id="HProductCatalog" %)
64 === Product Catalog ===
65
66 The product catalog contains instructions about how all products should be booked in correlation with revenue accounting.
67
68 (% id="HRevenueAccountingRules" %)
69 === Revenue Accounting Rules ===
70
71 ...
72
73 (% id="HReceipt" %)
74 == Receipt ==
75
76 After processing one of the above files a receipt will be created.
77
78 A detailed description you can find here.
79
80 ...
81
82 (% id="HReports" %)
83 == Reports ==
84
85 Many different reports with statistics can be created after every billrun or per month. Below will always be produced.
86
87 (% id="HInvoiceJournalBilling" %)
88 === Invoice Journal Billing ===
89
90 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.
91
92 (% id="HQueuepostReport" %)
93 === UnbilledReport ===
94
95 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
96
97 == Revenue Accounting ==
98
99 Revenue Accounting is an optional service for PayEx companies.
100
101 (% id="HBillingAccounting" %)
102 === BillingAccounting ===
103
104 Each Billrun will be booked and there will be produced a report with name BillingAccounting.xml contains:
105
106 (% role="list" %)
107 * (((
108 (% 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" %)
109 Invoicenumber​
110 )))
111 * (((
112 (% 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" %)
113 VAT code
114 )))
115 * (((
116 (% 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" %)
117 Account
118 )))
119 * (((
120 (% 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" %)
121 ProductCode
122 )))
123 * (((
124 (% 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" %)
125 Group company code
126 )))
127 * (((
128 (% 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" %)
129 Cost center
130 )))
131 * (((
132 (% 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" %)
133 Amount
134 )))
135
136 (% id="HBilledInAdvanced" %)
137 === BilledInAdvanced ===
138
139 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.
140
141 (% id="HUnbilledProduct" %)
142 === UnbilledProduct ===
143
144 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.
145
146 (% id="HQueuepostReport" %)
147 === ===
148
149 (% id="HErrorlog" %)
150 == Error log ==
151
152 If errors are encountered during file processing an errorlog will be created. Errors may refer to insufficient customer information or format errors.