Wiki source code of 01. Cusin

Last modified by Kent Westerlund on 2026/02/24 08:39
Show last authors
1 (% class="jumbotron" %)
2 (((
3 (% class="container" %)
4 (((
5 PayEx CUSIN (CustomerInvoice) is a file format for you to send customer and invoice information to PayEx. This is a technical overview of the file format, its elements and related material. This section should be seen as a companion to the standard setup scenario.
6 )))
7 )))
8
9 == XSD overview ==
10
11 {{warning}}
12 Please note that your CUSIN file, depending on package type and file version, might only utilize and/or contain a subset of all elements described below. See the XSD for your CUSIN file version to learn more.
13
14 Invoice Service = <InvoiceWithDistribution>
15
16 Ledger Service = <InvoiceWithoutDistribution>
17 {{/warning}}
18
19 === Invoice service (with distribution) ===
20
21 (% class="wikigeneratedid" id="H" %)
22 [[image:Cusin_[2.0].xsd-withdistribution.svg||height="961" width="435"]]
23
24 === Ledger service (without distribution) ===
25
26 [[image:Cusin_[2.0].xsd-withoutdistribution.svg||height="829" width="397"]]
27
28 == Encoding ==
29
30 The file must use [[(% style="color:#0066cc" %)__UTF-8 encoding__>>url:https://en.wikipedia.org/wiki/UTF-8]](%%).
31
32 (% id="HNameconvention" %)
33 == Name convention ==
34
35 CUSIN_<CompanyNumber>_<DateTime>_<SerialNumber>.xml
36
37 (% class="table-bordered table-striped" %)
38 |=Name components|=Description
39 |CompanyNumber|The company number in our ledger system
40 |DateTime|Date created, Should be in the format ISO 8601 format, YYYYMMDDhhmmdd
41 |SerialNumber|Should follow an uninterrupted number series, 1, 2, 3 and so on.
42
43 (% id="HXSDValidation" %)
44 == Limitations ==
45
46 (% class="table-bordered table-striped" %)
47 |=Limitations|=Description
48 |Maximum size limit|100 MB
49 |Maximum number of invoices|50.000 invoice items
50
51 == Important to note! ==
52
53 * If there are multiple invoices to be handled at the same time: do not send one invoice per file. We strongly suggest to batch them together in one single file. This will also speed up the process of creating and distributing the invoices.
54 * You cannot use the same serial number more than once. In case something goes wrong during CUSIN processing, you need to supply a new serial number - the next number in the number series you are using - when transferring the rectified file to PayEx.
55 * To avoid most file errors, always validate the cusin-file toward an up-to-date XML schema before transferring the file to PayEx.
56 * Standard length of CustomerNo in Norway and Denmark is 7 characters (numeric only).
57 * Only use numeric characters and not with a leading zero for CustomerNo in Sweden, in order to use AutoGiro (Direct Debit).
58 * The use of EDIInfo will result in distribution by E-Invoice B2B if no other preferred distribution method is set in eDistributionType, see [[Standard Invoice distribution order of priority>>doc:Main.Invoicing.invoice-service.Implementation guide.Invoice columns.WebHome||anchor="HStandardInvoicedistributionorderofpriority"]].
59 * DistributionDate on the credit invoice must have been passed when using CreditInstructions, in order to execute the settlement against a debit invoice.
60 * Dependency to [[LegalEntity>>url:https://developer.payex.com/xwiki/wiki/developer/view/Main/Invoicing/invoice-service/Implementation%20guide/Technical%20reference/Cusin/XML%20Schema%20specification/#type_LegalEntity]] in CustomerInfo element:
61 ** [[Late fee>>url:https://developer.payex.com/xwiki/wiki/developer/view/Main/Invoicing/invoice-service/Implementation%20guide/Supplementary%20features/?HLatefee]] will be added instead of reminder fee or collection claim fee when LegalEntity is set to "Business" (if specially contracted with PayEx and configured in ledger)
62 ** SSN (RegNo) for private individuals will not be displayed in ledger reports due to GDPR. RegNO will only be displayed when LegalEntity is set till "Business"
63 ** If distributed by e-mail: When LegalEntity is set to "Private" the e-mail message will include a link to PayEx Invoice Portal where the invoice/claim is available, otherwise a copy of the invoice/claim will be attached in the e-mail message as a pdf-file.
64 ** Finland only: Different claim processes will be used depending on "Private" or "Business"
65
66 == Current XML schema description ==
67
68 A detailed description of the elements in the current version of the XML schema definition file (XSD) can be found [[here>>doc:Main.Invoicing.invoice-service.Implementation guide.Technical reference.Cusin.XML Schema specification.WebHome]]
69
70 The Cusin file must be validated toward an up-to-date XML schema file!
71
72 == Download current XML schema file ==
73
74 (% class="row" %)
75 (((
76 (% class="col-xs-12" %)
77 (((
78 (% border="0" style="width:1023px" %)
79 |=(% style="width: 208px; background-color: rgb(237, 237, 237);" %)Fileversion|=(% style="width: 213px; background-color: rgb(237, 237, 237);" %)Version|=(% style="width: 288px; background-color: rgb(237, 237, 237);" %)Releasedate|=(% style="width: 585px; background-color: rgb(237, 237, 237);" %)Comment
80 |(% style="width:208px" %)[[Cusin[2.X].xsd>>attach:CUSIN_[2.X].xsd]]|(% style="width:213px" %)2.92|(% style="width:288px" %)2026-01-28|(% style="width:585px" %)Added VatRate enum item 13.50
81
82 == Change Log ==
83
84 (% id="HVersion1.1" %)
85 ==== **Version 2.92{{id name="3"/}}** ====
86
87 (% id="HJanuary2C2016" %)
88 ===== January 28, 2026 =====
89
90 [[Cusin[2.X].xsd>>attach:CUSIN_[2.X].xsd]]
91
92 (% class="box" %)
93 (((
94 Added VatRate enum item 13.50
95 )))
96
97 (% id="HVersion1.1" %)
98 ==== Change Log ====
99
100 (% id="HVersion1.1" %)
101 ==== **Version 2.91{{id name="3"/}}** ====
102
103 (% id="HJanuary2C2016" %)
104 ===== September 03, 2024 =====
105
106 [[Cusin[2.X].xsd>>attach:CUSIN_[2.X].xsd]]
107
108 (% class="box" %)
109 (((
110 Added VatRate enum item 25.50
111 )))
112
113 (% id="HVersion1.1" %)
114 ==== **Version 2.9{{id name="3"/}}** ====
115
116 (% id="HJanuary2C2016" %)
117 ===== April 18, 2023 =====
118
119 [[Cusin[2.9].xsd>>attach:CUSIN_[2.9].xsd]]
120
121 (% class="box" %)
122 (((
123 Added element 'CashDiscountInfo' for specifying cash discount on invoices, only supported for invoices without distribution
124 )))
125
126 (% id="HVersion1.1" %)
127 ==== **Version 2.8{{id name="3"/}}** ====
128
129 (% id="HJanuary2C2016" %)
130 ===== March 29, 2023 =====
131
132 [[Cusin[2.8].xsd>>attach:CUSIN_[2.8].xsd]]
133
134 (% class="box" %)
135 (((
136 Added element 'RecurringCardInfo' to support recurring card payments (agreement for card payments must be set before use)
137 )))
138
139 (% id="HVersion1.1" %)
140 ==== **Version 2.7{{id name="3"/}}** ====
141
142 (% id="HJanuary2C2016" %)
143 ===== February, 2023 =====
144
145 [[Cusin[2.7].xsd>>attach:CUSIN_[2.7].xsd]]
146
147 (% class="box" %)
148 (((
149 Added VatRate 24 and 10
150 )))
151
152 (% id="HVersion1.1" %)
153 ==== **Version 2.6{{id name="3"/}}** ====
154
155 (% id="HJanuary2C2016" %)
156 ===== October, 2022 =====
157
158 [[Cusin[2.6].xsd>>attach:CUSIN_[2.6].xsd]]
159
160 (% class="box" %)
161 (((
162 Allows a wider range of chars for Name, Addressee, StreetAddress, COAddress and City.
163
164 Supports StreetAddress and COAddress with up to 72 chars in length.
165 )))
166
167 (% id="HVersion1.1" %)
168 ==== **Version 2.5{{id name="3"/}}** ====
169
170 (% id="HJanuary2C2016" %)
171 ===== September, 2022 =====
172
173 [[Cusin[2.5].xsd>>attach:CUSIN_[2.5].xsd]]
174
175 (% class="box" %)
176 (((
177 Added support for setting customer LegalStatus
178 )))
179
180 (% id="HVersion1.1" %)
181 ==== **Version 2.4{{id name="3"/}}** ====
182
183 (% id="HJanuary2C2016" %)
184 ===== April, 2022 =====
185
186 [[Cusin[2.4].xsd>>attach:CUSIN_[2.4].xsd]]
187
188 (% class="box" %)
189 (((
190 eCurrencyType, added new values USD,GBP
191 )))
192
193 (% id="HVersion1.1" %)
194 ==== **Version 2.3{{id name="3"/}}** ====
195
196 (% id="HJanuary2C2016" %)
197 ===== November, 2020 =====
198
199 [[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" style="color:#2980b9" %)__Cusin[2.3].xsd__>>attach:CUSIN_[2.3].xsd]]
200
201 (% class="box" %)
202 (((
203 DistributionAddressInfo, added new field ProtectedIdentity
204 )))
205
206 (% id="HVersion1.1" %)
207 ==== **Version 2.2{{id name="3"/}}** ====
208
209 (% id="HJanuary2C2016" %)
210 ===== October, 2020 =====
211
212 [[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" style="color:#2980b9" %)__Cusin[2.2].xsd__>>attach:Main.Invoicing.invoice-service.Technical reference.WebHome@CUSIN_[2.2].xsd]]
213
214 (% class="box" %)
215 (((
216 EdiInfo.EDIOrderRows.Quantity decimal support,
217
218 EDIInfo.ExternalreferenceURL, added new field
219
220 Added support for more characters in EdiInfo.EDIOrderRow.ContractType
221 )))
222
223 (% style="color:inherit; font-family:inherit; font-size:20px" %)**Version 2.1**
224
225 (% id="HVersion1.1" %)
226 ==== **{{id name="3"/}}** ====
227
228 (% id="HJanuary2C2016" %)
229 ===== June, 2020 =====
230
231 [[(% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" style="color:#2980b9" %)__Cusin[2.1].xsd__>>attach:Main.Invoicing.invoice-service.Technical reference.WebHome@CUSIN_[2.1].xsd]]
232
233 (% class="box" %)
234 (((
235 Order rows under SubOrderBlocks, no longer mandatory
236 )))
237
238
239 (% id="HVersion1.1" %)
240 ==== **Version 2.1{{id name="3"/}}** ====
241
242 (% id="HJanuary2C2016" %)
243 ===== February, 2020 =====
244
245 (% class="wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink" style="color:#2980b9" %)__Cusin[2.01].xsd__
246
247 (% class="box" %)
248 (((
249 Added new DistributionRule UseEInvoiceB2CFI, and two new properties for accounting InterCompanyCode and VatType
250 )))
251
252 (% id="HVersion1.1" %)
253 ==== **Version 2.0{{id name="3"/}}** ====
254
255 (% id="HJanuary2C2016" %)
256 ===== September, 2016 =====
257
258 Cusin[2.0].xsd
259
260 (% class="box" %)
261 (((
262 Initial version (latest documented version)
263 )))
264
265 == Download sample file ==
266
267 [[CUSIN_367_20190911090045_93>>attach:Main.Invoicing.invoice-service.Technical reference.WebHome@CUSIN_367_20190911090045_93.xml]]
268 )))
269 )))