PayEx Developer Portal

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.

)))

)))

== XSD overview ==

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

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"]]

== Encoding ==

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 ==

(% class="row" %)

(((

(% 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.91|(% style="width:288px" %)2024-09-03|(% style="width:585px" %)Added VatRate enum item 25.50

== Change Log ==

(% id="HVersion1.1" %)

85

==== **Version 2.91{{id name="3"/}}** ====

86

87

(% id="HJanuary2C2016" %)

88

===== September 03, 2024 =====

89

90

[[Cusin[2.X].xsd>>attach:CUSIN_[2.X].xsd]]

(% class="box" %)

(((

Added VatRate enum item 25.50

95

)))

96

97

(% id="HVersion1.1" %)

98

==== **Version 2.9{{id name="3"/}}** ====

99

100

(% id="HJanuary2C2016" %)

101

===== April 18, 2023 =====

102

103

[[Cusin[2.9].xsd>>attach:CUSIN_[2.9].xsd]]

(% class="box" %)

(((

Added element 'CashDiscountInfo' for specifying cash discount on invoices, only supported for invoices without distribution

108

)))

109

110

(% id="HVersion1.1" %)

111

==== **Version 2.8{{id name="3"/}}** ====

112

113

(% id="HJanuary2C2016" %)

114

===== March 29, 2023 =====

115

116

[[Cusin[2.8].xsd>>attach:CUSIN_[2.8].xsd]]

(% class="box" %)

(((

Added element 'RecurringCardInfo' to support recurring card payments (agreement for card payments must be set before use)

121

)))

122

123

(% id="HVersion1.1" %)

124

==== **Version 2.7{{id name="3"/}}** ====

125

126

(% id="HJanuary2C2016" %)

127

===== February, 2023 =====

128

129

[[Cusin[2.7].xsd>>attach:CUSIN_[2.7].xsd]]

(% class="box" %)

(((

Added VatRate 24 and 10

134

)))

135

136

(% id="HVersion1.1" %)

137

==== **Version 2.6{{id name="3"/}}** ====

138

139

(% id="HJanuary2C2016" %)

140

===== October, 2022 =====

141

142

[[Cusin[2.6].xsd>>attach:CUSIN_[2.6].xsd]]

(% class="box" %)

(((

Allows a wider range of chars for Name, Addressee, StreetAddress, COAddress and City.

147

148

Supports StreetAddress and COAddress with up to 72 chars in length.

149

)))

150

151

(% id="HVersion1.1" %)

152

==== **Version 2.5{{id name="3"/}}** ====

153

154

(% id="HJanuary2C2016" %)

155

===== September, 2022 =====

156

157

[[Cusin[2.5].xsd>>attach:CUSIN_[2.5].xsd]]

(% class="box" %)

(((

Added support for setting customer LegalStatus

162

)))

163

164

(% id="HVersion1.1" %)

165

==== **Version 2.4{{id name="3"/}}** ====

166

167

(% id="HJanuary2C2016" %)

168

===== April, 2022 =====

169

170

[[Cusin[2.4].xsd>>attach:CUSIN_[2.4].xsd]]

(% class="box" %)

(((

eCurrencyType, added new values USD,GBP

175

)))

176

177

(% id="HVersion1.1" %)

178

==== **Version 2.3{{id name="3"/}}** ====

179

180

(% id="HJanuary2C2016" %)

181

===== November, 2020 =====

182

183

[[(% 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" style="color:#2980b9" %)__Cusin[2.3].xsd__>>attach:CUSIN_[2.3].xsd]]

(% class="box" %)

(((

DistributionAddressInfo, added new field ProtectedIdentity

188

)))

189

190

(% id="HVersion1.1" %)

191

==== **Version 2.2{{id name="3"/}}** ====

192

193

(% id="HJanuary2C2016" %)

194

===== October, 2020 =====

195

196

[[(% 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" style="color:#2980b9" %)__Cusin[2.2].xsd__>>attach:Main.Invoicing.invoice-service.Technical reference.WebHome@CUSIN_[2.2].xsd]]

(% class="box" %)

(((

EdiInfo.EDIOrderRows.Quantity decimal support,

201

202

EDIInfo.ExternalreferenceURL, added new field

203

204

Added support for more characters in EdiInfo.EDIOrderRow.ContractType

205

)))

206

207

(% style="color:inherit; font-family:inherit; font-size:20px" %)**Version 2.1**

208

209

(% id="HVersion1.1" %)

210

==== **{{id name="3"/}}** ====

211

212

(% id="HJanuary2C2016" %)

213

===== June, 2020 =====

214

215

[[(% 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" style="color:#2980b9" %)__Cusin[2.1].xsd__>>attach:Main.Invoicing.invoice-service.Technical reference.WebHome@CUSIN_[2.1].xsd]]

(% class="box" %)

(((

Order rows under SubOrderBlocks, no longer mandatory

)))

(% id="HVersion1.1" %)

224

==== **Version 2.1{{id name="3"/}}** ====

225

226

(% id="HJanuary2C2016" %)

227

===== February, 2020 =====

228

229

(% 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__

(% class="box" %)

(((

Added new DistributionRule UseEInvoiceB2CFI, and two new properties for accounting InterCompanyCode and VatType

234

)))

235

236

(% id="HVersion1.1" %)