Wiki source code of 01. Cusin

Last modified by David Persson on 2023/04/19 08:23
Hide last authors
David Persson 2.1 1 (% class="jumbotron" %)
2 (((
3 (% class="container" %)
4 (((
Fredrik Nilsson 72.1 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.
David Persson 2.1 6 )))
7 )))
8
David Persson 83.1 9 == XSD overview ==
David Persson 82.1 10
David Persson 2.1 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.
Fredrik Nilsson 72.1 13
Fredrik Nilsson 88.1 14 Invoice Service = <InvoiceWithDistribution>
Fredrik Nilsson 72.1 15
Fredrik Nilsson 88.1 16 Ledger Service = <InvoiceWithoutDistribution>
David Persson 2.1 17 {{/warning}}
18
David Persson 85.1 19 === Invoice service (with distribution) ===
David Persson 80.1 20
David Persson 83.1 21 (% class="wikigeneratedid" id="H" %)
22 [[image:Cusin_[2.0].xsd-withdistribution.svg||height="961" width="435"]]
David Persson 79.1 23
David Persson 85.1 24 === Ledger service (without distribution) ===
David Persson 71.1 25
David Persson 79.1 26 [[image:Cusin_[2.0].xsd-withoutdistribution.svg||height="829" width="397"]]
27
David Persson 2.1 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" %)
Jens Kral 68.1 38 |=Name components|=Description
David Persson 2.1 39 |CompanyNumber|The company number in our ledger system
Daniel Franzén 21.1 40 |DateTime|Date created, Should be in the format ISO 8601 format, YYYYMMDDhhmmdd
Jens Kral 68.1 41 |SerialNumber|Should follow an uninterrupted number series, 1, 2, 3 and so on.
David Persson 2.1 42
43 (% id="HXSDValidation" %)
44 == Limitations ==
45
46 (% class="table-bordered table-striped" %)
47 |=Limitations|=Description
48 |Maximum size limit|100 MB
David Persson 166.3 49 |Maximum number of invoices|50.000 invoice items
David Persson 2.1 50
Fredrik Nilsson 62.1 51 == Important to note! ==
David Persson 2.1 52
Fredrik Nilsson 64.1 53 * 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.
54 * To avoid most file errors, always validate the cusin-file toward an up-to-date XML schema before transferring the file to PayEx.
Fredrik Nilsson 87.1 55 * Standard length of CustomerNo in Norway and Denmark is 7 characters (numeric only).
Fredrik Nilsson 124.1 56 * Only use numeric characters and not with a leading zero for CustomerNo in Sweden, in order to use AutoGiro (Direct Debit).
Fredrik Nilsson 155.1 57 * 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"]].
Fredrik Nilsson 151.1 58 * 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:
59 ** [[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)
60 ** 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"
61 ** 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.
62 ** Finland only: Different claim processes will be used depending on "Private" or "Business"
David Persson 2.1 63
64 == Current XML schema description ==
65
Fredrik Nilsson 65.1 66 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]]
David Persson 2.1 67
Fredrik Nilsson 8.1 68 The Cusin file must be validated toward an up-to-date XML schema file!
David Persson 2.1 69
Fredrik Nilsson 8.1 70 == Download current XML schema file ==
71
David Persson 2.1 72 (% class="row" %)
73 (((
74 (% class="col-xs-12" %)
75 (((
76 (% border="0" style="width:1023px" %)
77 |=(% 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
David Persson 174.1 78 |(% style="width:208px" %)[[Cusin[2.X].xsd>>attach:CUSIN_[2.X].xsd]]|(% style="width:213px" %)2.9|(% style="width:288px" %)2023-04-18|(% style="width:585px" %)Added element 'CashDiscountInfo' for specifying cash discount on invoices, only supported for invoices without distribution
Anders Hällbom 29.2 79
Fredrik Nilsson 14.1 80 == Change Log ==
David Persson 2.1 81
Anders Hällbom 39.1 82 (% id="HVersion1.1" %)
David Persson 161.1 83 ==== **Version 2.9{{id name="3"/}}** ====
84
85 (% id="HJanuary2C2016" %)
86 ===== April 18, 2023 =====
87
David Persson 165.1 88 [[Cusin[2.9].xsd>>attach:CUSIN_[2.9].xsd]]
David Persson 161.1 89
90 (% class="box" %)
91 (((
92 Added element 'CashDiscountInfo' for specifying cash discount on invoices, only supported for invoices without distribution
93 )))
94
95 (% id="HVersion1.1" %)
David Persson 157.2 96 ==== **Version 2.8{{id name="3"/}}** ====
97
98 (% id="HJanuary2C2016" %)
David Persson 160.1 99 ===== March 29, 2023 =====
David Persson 157.2 100
David Persson 159.1 101 [[Cusin[2.8].xsd>>attach:CUSIN_[2.8].xsd]]
David Persson 157.2 102
103 (% class="box" %)
104 (((
105 Added element 'RecurringCardInfo' to support recurring card payments (agreement for card payments must be set before use)
106 )))
107
108 (% id="HVersion1.1" %)
David Persson 152.1 109 ==== **Version 2.7{{id name="3"/}}** ====
110
111 (% id="HJanuary2C2016" %)
112 ===== February, 2023 =====
113
David Persson 157.2 114 [[Cusin[2.7].xsd>>attach:CUSIN_[2.7].xsd]]
David Persson 152.1 115
116 (% class="box" %)
117 (((
118 Added VatRate 24 and 10
119 )))
120
121 (% id="HVersion1.1" %)
Tobias Karlsson 134.1 122 ==== **Version 2.6{{id name="3"/}}** ====
123
124 (% id="HJanuary2C2016" %)
Tobias Karlsson 136.1 125 ===== October, 2022 =====
Tobias Karlsson 134.1 126
Tobias Karlsson 144.1 127 [[Cusin[2.6].xsd>>attach:CUSIN_[2.6].xsd]]
Tobias Karlsson 134.1 128
129 (% class="box" %)
130 (((
131 Allows a wider range of chars for Name, Addressee, StreetAddress, COAddress and City.
132
133 Supports StreetAddress and COAddress with up to 72 chars in length.
134 )))
135
136 (% id="HVersion1.1" %)
137 ==== **Version 2.5{{id name="3"/}}** ====
138
139 (% id="HJanuary2C2016" %)
140 ===== September, 2022 =====
141
142 [[Cusin[2.5].xsd>>attach:CUSIN_[2.5].xsd]]
143
144 (% class="box" %)
145 (((
146 Added support for setting customer LegalStatus
147 )))
148
149 (% id="HVersion1.1" %)
Daniel Lofqvist 95.1 150 ==== **Version 2.4{{id name="3"/}}** ====
151
152 (% id="HJanuary2C2016" %)
Tobias Karlsson 134.1 153 ===== April, 2022 =====
Daniel Lofqvist 95.1 154
Tobias Karlsson 134.1 155 [[Cusin[2.4].xsd>>attach:CUSIN_[2.4].xsd]]
Daniel Lofqvist 95.1 156
157 (% class="box" %)
158 (((
159 eCurrencyType, added new values USD,GBP
160 )))
161
162 (% id="HVersion1.1" %)
Anders Hällbom 46.1 163 ==== **Version 2.3{{id name="3"/}}** ====
Rasmus Enekvist 19.1 164
Anders Hällbom 39.1 165 (% id="HJanuary2C2016" %)
166 ===== November, 2020 =====
167
David Persson 174.1 168 [[(% 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" style="color:#2980b9" %)__Cusin[2.3].xsd__>>attach:CUSIN_[2.3].xsd]]
Anders Hällbom 39.1 169
170 (% class="box" %)
171 (((
172 DistributionAddressInfo, added new field ProtectedIdentity
173 )))
174
David Persson 2.1 175 (% id="HVersion1.1" %)
Anders Hällbom 46.1 176 ==== **Version 2.2{{id name="3"/}}** ====
Rasmus Enekvist 19.1 177
178 (% id="HJanuary2C2016" %)
Anders Hällbom 32.2 179 ===== October, 2020 =====
180
David Persson 174.1 181 [[(% 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" style="color:#2980b9" %)__Cusin[2.2].xsd__>>attach:Main.Invoicing.invoice-service.Technical reference.WebHome@CUSIN_[2.2].xsd]]
Anders Hällbom 32.2 182
183 (% class="box" %)
184 (((
Anders Hällbom 36.1 185 EdiInfo.EDIOrderRows.Quantity decimal support,
186
187 EDIInfo.ExternalreferenceURL, added new field
188
189 Added support for more characters in EdiInfo.EDIOrderRow.ContractType
Anders Hällbom 32.2 190 )))
191
192 (% style="color:inherit; font-family:inherit; font-size:20px" %)**Version 2.1**
193
194 (% id="HVersion1.1" %)
195 ==== **{{id name="3"/}}** ====
196
197 (% id="HJanuary2C2016" %)
Kent Westerlund 28.1 198 ===== June, 2020 =====
199
David Persson 174.1 200 [[(% 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" style="color:#2980b9" %)__Cusin[2.1].xsd__>>attach:Main.Invoicing.invoice-service.Technical reference.WebHome@CUSIN_[2.1].xsd]]
Kent Westerlund 28.1 201
202 (% class="box" %)
203 (((
204 Order rows under SubOrderBlocks, no longer mandatory
205 )))
206
207
208 (% id="HVersion1.1" %)
209 ==== **Version 2.1{{id name="3"/}}** ====
210
211 (% id="HJanuary2C2016" %)
Rasmus Enekvist 19.1 212 ===== February, 2020 =====
213
Anders Hällbom 33.1 214 (% 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__
Rasmus Enekvist 19.1 215
216 (% class="box" %)
217 (((
218 Added new DistributionRule UseEInvoiceB2CFI, and two new properties for accounting InterCompanyCode and VatType
219 )))
220
221 (% id="HVersion1.1" %)
David Persson 2.1 222 ==== **Version 2.0{{id name="3"/}}** ====
223
224 (% id="HJanuary2C2016" %)
225 ===== September, 2016 =====
226
Anders Hällbom 33.1 227 Cusin[2.0].xsd
David Persson 2.1 228
229 (% class="box" %)
230 (((
231 Initial version (latest documented version)
232 )))
233
Fredrik Nilsson 13.1 234 == Download sample file ==
David Persson 2.1 235
Fredrik Nilsson 29.1 236 [[CUSIN_367_20190911090045_93>>attach:Main.Invoicing.invoice-service.Technical reference.WebHome@CUSIN_367_20190911090045_93.xml]]
David Persson 2.1 237 )))
238 )))