Changes for page Implementation Guide

Last modified by Anders Göthberg on 2022/05/20 11:14
From empty
To version 62.1
edited by Andreas Benneck
on 2021/01/11 08:42
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +Implementation Guide
Parent
... ... @@ -1,0 +1,1 @@
1 +Main.billing.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.XWikiGuest
1 +xwiki:XWiki.anb
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Tags
... ... @@ -1,0 +1,1 @@
1 +px-custom-page-content
Content
... ... @@ -1,0 +1,204 @@
1 +(% id="HIntroduction" %)
2 += Introduction =
3 +
4 +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.
5 +
6 +
7 +(% id="HPrerequisites" %)
8 +== Prerequisites ==
9 +
10 +Before start implementing PayEx Billing the following is required:
11 +
12 +* An Agreement Invoice Service with Billing together with:
13 +** A SFTP Client
14 +** Business Rules
15 +* Revenue Accounting Rules (If Revenue Accounting)
16 +
17 +Feel free to [[contact us>>mailto:billing.client@payex.com]] if you have any questions on how to get started.
18 +
19 +== Overview ==
20 +
21 +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.
22 +
23 +{{plantuml}}
24 +@startuml
25 +skinparam sequence{
26 +ArrowColor #2DA944
27 +ActorFontColor #333333
28 +ActorFontStyle bold
29 +ActorFontSize 15
30 +ActorBackgroundColor #fefefe
31 +ActorBorderColor #2DA944
32 +LifeLineBorderColor #999999
33 +LifeLineBackgroundColor #dddddd
34 +ParticipantBorderColor #2DA944
35 +ParticipantBackgroundColor #ffffff
36 +ParticipantFontColor #333333
37 +ParticipantFontStyle bold
38 +}
39 +skinparam Roundcorner 10
40 +skinparam Shadowing false
41 +skinparam ActivityBorderColor #123123
42 +skinparam NoteBackgroundColor white
43 +skinparam NoteBorderColor #999999
44 +skinparam NoteFontColor #333333
45 +skinparam sequenceDividerBackgroundColor white
46 +skinparam sequenceDividerBorderColor #999999
47 +skinparam sequenceDividerFontStyle bold
48 +skinparam sequenceDividerFontSize 15
49 +'//Sequence start//'
50 +|||
51 +Customer->Company: Purchase information processed via Company's CRM
52 +|||
53 +Activate Customer
54 +==[[/xwiki/wiki/developer/view/Main/billing/Implementation%20Guide/#HIOverview Billing]]==
55 +Activate Company
56 +Activate PayEx
57 +Activate Ledger
58 +Company->PayEx: Create <Product Catalog>
59 +Company->PayEx: Create <Bicus2 or KUB>
60 +Company->PayEx: Create <PR01>
61 +PayEx->Company: Receive <Receipt>
62 +PayEx->Company: Receive <Errorlog>
63 +|||
64 +==[[https://developer.payex.com/xwiki/wiki/developer/view/Main/billing/Implementation%20Guide/#HReports Reports]]==
65 +PayEx->Company: Receive <InvoiceJournalBilling>
66 +PayEx->Company: Receive <UnbilledReport>
67 +PayEx->Company: Receive <BillingAccounting>
68 +|||
69 +==[[/xwiki/wiki/developer/view/Main/billing/Implementation%20Guide/#HRevenueAccounting Revenue Accounting (Optional)]]==
70 +PayEx->Company: Receive <UnbilledProduct>
71 +PayEx->Company: Receive <BilledInAdvanced>
72 +|||
73 +==[[/xwiki/wiki/developer/view/Main/Invoicing/invoice-service/Implementation%20guide/#HT Invoice Service]]==
74 +PayEx->Ledger: Create <Invoice Service>
75 +Ledger->Customer: Distribute <Invoice>
76 +|||
77 +Deactivate Company
78 +Deactivate PayEx
79 +Deactivate Ledger
80 +'//Sequence end//'
81 +@enduml
82 +{{/plantuml}}
83 +
84 +(% id="HWhatyoushoulddo2Cstepbystep." class="wikigeneratedid" %)
85 +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.
86 +
87 +If you encounter any problem during implementation, don't hesitate to [[contact us>>mailto:billing.client@payex.com]].
88 +
89 +(% id="HIOverview" %)
90 +== Information Overview ==
91 +
92 +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).
93 +
94 +When implementing Invoice Service Billing with Revenue Accounting, customer-specific configuration takes place.
95 +
96 +(% id="HBicus228Customerfilexml29" %)
97 +=== Bicus2 (Customerfile xml) ===
98 +
99 +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.
100 +
101 +(% id="HKUB28Customerfilecsv29" %)
102 +=== KUB (Customerfile csv) ===
103 +
104 +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.
105 +
106 +(% id="HPR0128Productfilecsv29" %)
107 +=== PR01 (Productfile) ===
108 +
109 +Using PR01 files in the PayEx Billing system gives possibilities to create non recurrent products on both customer and subscription level.
110 +
111 +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.
112 +
113 +(% id="HProductCatalog" %)
114 +=== Product Catalog ===
115 +
116 +The product catalog contains instructions about how all products should be booked in correlation with revenue accounting.
117 +
118 +(% id="HRevenueAccountingRules" %)
119 +=== Revenue Accounting Rules ===
120 +
121 +...
122 +
123 +(% id="HReceipt" %)
124 +== Receipt ==
125 +
126 +After processing one of the above files a receipt will be created.
127 +
128 +A detailed description you can find here.
129 +
130 +...
131 +
132 +(% id="HReports" %)
133 +== Reports ==
134 +
135 +Many different reports with statistics can be created after every billrun or per month. Below will always be produced.
136 +
137 +(% id="HInvoiceJournalBilling" %)
138 +=== Invoice Journal Billing ===
139 +
140 +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.
141 +
142 +(% id="HQueuepostReport" %)
143 +=== UnbilledReport ===
144 +
145 +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
146 +
147 +== Revenue Accounting ==
148 +
149 +Revenue Accounting is an optional service for PayEx companies.
150 +
151 +(% id="HBillingAccounting" %)
152 +=== BillingAccounting ===
153 +
154 +Each Billrun will be booked and there will be produced a report with name BillingAccounting.xml contains:
155 +
156 +(% role="list" %)
157 +* (((
158 +(% 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" %)
159 +Invoicenumber​
160 +)))
161 +* (((
162 +(% 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" %)
163 +VAT code
164 +)))
165 +* (((
166 +(% 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" %)
167 +Account
168 +)))
169 +* (((
170 +(% 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" %)
171 +ProductCode
172 +)))
173 +* (((
174 +(% 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" %)
175 +Group company code
176 +)))
177 +* (((
178 +(% 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" %)
179 +Cost center
180 +)))
181 +* (((
182 +(% 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" %)
183 +Amount
184 +)))
185 +
186 +(% id="HBilledInAdvanced" %)
187 +=== BilledInAdvanced ===
188 +
189 +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.
190 +
191 +(% id="HUnbilledProduct" %)
192 +=== UnbilledProduct ===
193 +
194 +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.
195 +
196 +(% id="HQueuepostReport" %)
197 +=== ===
198 +
199 +(% id="HErrorlog" %)
200 +== Error log ==
201 +
202 +If errors are encountered during file processing an errorlog will be created. Errors may refer to insufficient customer information or format errors.
203 +
204 +