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

* 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.

55

* Standard length of CustomerNo in Norway and Denmark is 7 characters (numeric only).

56

* Only use numeric characters and not with a leading zero for CustomerNo in Sweden, in order to use AutoGiro (Direct Debit).

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

58

* DistributionDate on the credit invoice must have been passed when using CreditInstructions, in order to execute the settlement against a debit invoice.

59

* 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:

60

** [[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)

61

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

62

** 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.

63

** Finland only: Different claim processes will be used depending on "Private" or "Business"

64

65

== Current XML schema description ==

66

67

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

68

69

The Cusin file must be validated toward an up-to-date XML schema file!

70

71

== Download current XML schema file ==

(% class="row" %)

(((

(% class="col-xs-12" %)

76

(((

77

(% border="0" style="width:1023px" %)

78

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

79

|(% 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" %)

84

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

85

86

(% id="HJanuary2C2016" %)

87

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

88

89

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

(% class="box" %)

(((

Added VatRate enum item 25.50

94

)))

95

96

(% id="HVersion1.1" %)

97

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

98

99

(% id="HJanuary2C2016" %)

100

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

101

102

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

107

)))

108

109

(% id="HVersion1.1" %)

110

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

111

112

(% id="HJanuary2C2016" %)

113

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

114

115

[[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)

120

)))

121

122

(% id="HVersion1.1" %)

123

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

124

125

(% id="HJanuary2C2016" %)

126

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

127

128

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

(% class="box" %)

(((

Added VatRate 24 and 10

133

)))

134

135

(% id="HVersion1.1" %)

136

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

137

138

(% id="HJanuary2C2016" %)

139

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

140

141

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

(% class="box" %)

(((

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

146

147

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

148

)))

149

150

(% id="HVersion1.1" %)

151

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

152

153

(% id="HJanuary2C2016" %)

154

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

155

156

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

(% class="box" %)

(((

Added support for setting customer LegalStatus

161

)))

162

163

(% id="HVersion1.1" %)

164

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

165

166

(% id="HJanuary2C2016" %)

167

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

168

169

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

(% class="box" %)

(((

eCurrencyType, added new values USD,GBP

174

)))

175

176

(% id="HVersion1.1" %)

177

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

178

179

(% id="HJanuary2C2016" %)

180

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

181

182

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

187

)))

188

189

(% id="HVersion1.1" %)

190

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

191

192

(% id="HJanuary2C2016" %)

193

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

194

195

[[(% 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,

200

201

EDIInfo.ExternalreferenceURL, added new field

202

203

Added support for more characters in EdiInfo.EDIOrderRow.ContractType

204

)))

205

206

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

207

208

(% id="HVersion1.1" %)

209

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

210

211

(% id="HJanuary2C2016" %)

212

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

213

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 wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink wikiattachmentlink 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" %)

223

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

224

225

(% id="HJanuary2C2016" %)

226

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

227

228

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

233

)))

234

235

(% id="HVersion1.1" %)