Wiki source code of Reference
Last modified by Asbjørn Ulsberg on 2018/09/03 10:57
| 1 | This is the reference section for the CUSIN format. The CUSIN File is organized around XML. |
| 2 | |
| 3 | > This section is currently being worked on. If something is missing, you'll find it [[here>>attach:CUSIN_Postbeskriving.pdf]]. |
| 4 | |
| 5 | = CUSIN File = |
| 6 | |
| 7 | == XML Declaration == |
| 8 | |
| 9 | == CUSIN Header == |
| 10 | |
| 11 | ((( |
| 12 | |(% style="text-align:right" %)**Attributes** |=Description |
| 13 | |(% style="text-align:right" %){{code}}Version{{/code}} |
| 14 | (% style="color:LightGrey" %)xs:string |
| 15 | (required)|((( |
| 16 | Describes which version of the xsd the xml is validated against. XSD validation should be done before sending xml file to PayEx. |
| 17 | ))) |
| 18 | |(% style="text-align:right" %){{code}}CreatedDateTime{{/code}} |
| 19 | (% style="color:LightGrey" %)xs:dateTime |
| 20 | (required)|((( |
| 21 | Date and time when the file was created. |
| 22 | ))) |
| 23 | |(% style="text-align:right" %){{code}}CompanyNo{{/code}} |
| 24 | (% style="color:LightGrey" %)string |
| 25 | (required)|((( |
| 26 | Your company number (accountsreceivable) at PayEx. |
| 27 | minLength 9, maxLength 15, pattern [0-9] |
| 28 | ))) |
| 29 | |(% style="text-align:right" %){{code}}CompanyName{{/code}} |
| 30 | (% style="color:LightGrey" %)xs:string |
| 31 | (required)|((( |
| 32 | Your company name (accountsreceivable) at PayEx. |
| 33 | ))) |
| 34 | ))) |
| 35 | |
| 36 | == Distribution Date == |
| 37 | |
| 38 | ((( |
| 39 | |(% style="text-align:right" %)**Attribute** |=Description |
| 40 | |(% style="text-align:right" %){{code}}DistributionDate{{/code}} |
| 41 | (% style="color:LightGrey" %)xs:date or xs:anytype |
| 42 | (required)|((( |
| 43 | Valid attributes {{code}}Date{{/code}} or {{code}}AsSoonAsPossible{{/code}}. |
| 44 | |
| 45 | {{code}}Date{{/code}}: Only used if distribution of invoices are part of a contracted production planning. Distributiondate has to be in the future. Distributiondate has to be a bankday |
| 46 | {{code}}AsSoonAsPossible{{/code}}: Used to distribute invoices as soon as possible. The element supposed to be empty. |
| 47 | ))) |
| 48 | ))) |
| 49 | |
| 50 | == CUSINInfo == |
| 51 | |
| 52 | === CustomerNo === |
| 53 | |
| 54 | ((( |
| 55 | |(% style="text-align:right" %)**Attributes** |=Description |
| 56 | |(% style="text-align:right" %){{code}}CustomerNo{{/code}} |
| 57 | (% style="color:LightGrey" %)Identifier15 |
| 58 | (required)|((( |
| 59 | CustomerNo is your unique identifier of the customer in the accountsreceivable and should always be used. CustomerNo is mandatory by default. |
| 60 | |
| 61 | Requirements |
| 62 | |
| 63 | MinLength 1 |
| 64 | MaxLength 15 |
| 65 | Pattern [a-zA-Z0-9äåöÄÅÖ&/_ -.]* |
| 66 | |
| 67 | If you do not have unique identifiers of your customers, please contact PayEx. |
| 68 | ))) |
| 69 | |(% style="text-align:right" %){{code}}CustomerInfo{{/code}} |
| 70 | (% style="color:LightGrey" %)array |
| 71 | (required)|((( |
| 72 | This array contains the following elements {{code}}Name{{/code}}, {{code}}LegalEntity{{/code}}, {{code}}RegNo{{/code}}, {{code}}DistributionAddressInfo{{/code}}, {{code}}PaymentInfo{{/code}} and {{code}}DistributionInfo{{/code}} |
| 73 | ))) |
| 74 | |(% style="text-align:right" %){{code}}Invoices{{/code}} |
| 75 | (% style="color:LightGrey" %)array |
| 76 | (required)|((( |
| 77 | This array contains with a lot of elementes. |
| 78 | ))) |
| 79 | ))) |
| 80 | |
| 81 | === CustomerInfo === |
| 82 | |
| 83 | ==== Name ==== |
| 84 | |
| 85 | ((( |
| 86 | |(% style="text-align:right" %)**Attribute** |=Description |
| 87 | |(% style="text-align:right" %){{code}}Name{{/code}} |
| 88 | (% style="color:LightGrey" %)NameAddressString72 |
| 89 | (required)|((( |
| 90 | Full name for the customer in the accountsreceivablesystem. Used as display name |
| 91 | |
| 92 | Requirements |
| 93 | |
| 94 | MinLength 1 |
| 95 | MaxLength 72 |
| 96 | Pattern [a-zA-Z0-9_:!;"#<>=?\[\]@{}´

 %-/À-ÖØ-öø-úü]* |
| 97 | ))) |
| 98 | ))) |
| 99 | |
| 100 | ==== RegNo ==== |
| 101 | |
| 102 | ((( |
| 103 | |(% style="text-align:right" %)**Attribute** |=Description |
| 104 | |(% style="text-align:right" %){{code}}RegNo{{/code}} |
| 105 | (% style="color:LightGrey" %)RegNo |
| 106 | (required)|((( |
| 107 | Customer social security number/corporate identity number. Has to conform to country specific algorithms |
| 108 | |
| 109 | Requirements |
| 110 | |
| 111 | CountryCode: Nationality according to ISO3166 in conjuction with PXString. |
| 112 | MinLength 1 |
| 113 | MaxLength 15 |
| 114 | Pattern [a-zA-Z0-9_:!;"#<>=?\[\]@{}´

 %-/À-ÖØ-öø-ú]* |
| 115 | ))) |
| 116 | ))) |
| 117 | |
| 118 | ==== Category ==== |
| 119 | |
| 120 | ((( |
| 121 | |(% style="text-align:right" %)**Attribute** |=Description |
| 122 | |(% style="text-align:right" %){{code}}Category{{/code}} |
| 123 | (% style="color:LightGrey" %)String10 |
| 124 | (optional)|((( |
| 125 | Can only be used if contracted with PayEx. Category has to be preconfigured in the accountsreceivable system |
| 126 | |
| 127 | Requirements |
| 128 | |
| 129 | MinLength 1 |
| 130 | MaxLength 10 |
| 131 | Pattern [a-zA-Z0-9_:!;"#<>=?\[\]@{}´

 %-/À-ÖØ-öø-ú] |
| 132 | ))) |
| 133 | ))) |
| 134 | |
| 135 | ==== LanguageCode ==== |
| 136 | |
| 137 | ((( |
| 138 | |(% style="text-align:right" %)**Attribute** |=Description |
| 139 | |(% style="text-align:right" %){{code}}LanguageCode{{/code}} |
| 140 | (% style="color:LightGrey" %)ISO639 |
| 141 | (optional)|((( |
| 142 | Only used if preferred invoice language is other than accounts receivable default |
| 143 | |
| 144 | Requirements |
| 145 | |
| 146 | MinLength 1 |
| 147 | Pattern [a-zA-Z0-9_:!;"#<>=?\[\]@{}´

 %-/À-ÖØ-öø-ú]* |
| 148 | Example values {SV,NO,DA,FI,EN} |
| 149 | ))) |
| 150 | ))) |
| 151 | |
| 152 | ==== VatNo ==== |
| 153 | |
| 154 | ((( |
| 155 | |(% style="text-align:right" %)**Attribute** |=Description |
| 156 | |(% style="text-align:right" %){{code}}VatNo{{/code}} |
| 157 | (% style="color:LightGrey" %)VatNumber |
| 158 | (optional)|((( |
| 159 | Customer VAT registration number. Mandatory if reverse tax is used. Must conform to country specific algorithm |
| 160 | |
| 161 | Requirements |
| 162 | |
| 163 | MinLength 7 |
| 164 | MaxLength 14 |
| 165 | Pattern [A-Z]{2}.* |
| 166 | ))) |
| 167 | ))) |
| 168 | |
| 169 | ==== DistributionAddressInfo ==== |
| 170 | |
| 171 | ((( |
| 172 | |(% style="text-align:right" %)**Attribute** |=Description |
| 173 | |(% style="text-align:right" %){{code}}DistributionAddressInfo{{/code}} |
| 174 | (% style="color:LightGrey" %)??Type?? |
| 175 | (Required)|((( |
| 176 | Contains customer distribution address information and has the following children {{code}}Addresses{{/code}}, {{code}}E-MailAddress{{/code}} and {{code}}Cellphone{{/code}} |
| 177 | ))) |
| 178 | ))) |
| 179 | |
| 180 | ===== Addresses ===== |
| 181 | |
| 182 | ===== E-MailAddress ===== |
| 183 | |
| 184 | ===== Cellphone ===== |
| 185 | |
| 186 | ==== PaymentInfo ==== |
| 187 | |
| 188 | ((( |
| 189 | |(% style="text-align:right" %)**Attribute** |=Description |
| 190 | |(% style="text-align:right" %){{code}}PaymentInfo{{/code}} |
| 191 | (% style="color:LightGrey" %)??Type?? |
| 192 | (optional)|((( |
| 193 | Contains differing customer paymentinfo from accounts receivable default and has the following children {{code}}Clear{{/code}} and {{code}}Set{{/code}} |
| 194 | ))) |
| 195 | ))) |
| 196 | |
| 197 | ===== Clear ===== |
| 198 | |
| 199 | ===== Set ===== |
| 200 | |
| 201 | ==== DunningInfo ==== |
| 202 | |
| 203 | ((( |
| 204 | |(% style="text-align:right" %)**Attribute** |=Description |
| 205 | |(% style="text-align:right" %){{code}}DunningInfo{{/code}} |
| 206 | (% style="color:LightGrey" %)??Type?? |
| 207 | (optional)|((( |
| 208 | Contains differing customer dunninginfo from accountsreceivable default and has the following children {{code}}Clear{{/code}} and {{code}}Set{{/code}} |
| 209 | ))) |
| 210 | ))) |
| 211 | |
| 212 | ===== Clear ===== |
| 213 | |
| 214 | ===== Set ===== |
| 215 | |
| 216 | ==== DistributionInfo ==== |
| 217 | |
| 218 | ((( |
| 219 | |(% style="text-align:right" %)**Attribute** |=Description |
| 220 | |(% style="text-align:right" %){{code}}DistributionInfo{{/code}} |
| 221 | (% style="color:LightGrey" %)??Type?? |
| 222 | (optional)|((( |
| 223 | Contains differing customer distribution info from accountsreceivable default and has the following children {{code}}Clear{{/code}} and {{code}}Set{{/code}} |
| 224 | ))) |
| 225 | ))) |
| 226 | |
| 227 | ===== Clear ===== |
| 228 | |
| 229 | ===== Set ===== |
| 230 | |
| 231 | ==== NotificationInfo ==== |
| 232 | |
| 233 | ((( |
| 234 | |(% style="text-align:right" %)**Attribute** |=Description |
| 235 | |(% style="text-align:right" %){{code}}NotificationInfo{{/code}} |
| 236 | (% style="color:LightGrey" %)??Type?? |
| 237 | (optional)|((( |
| 238 | Contains differing notification settings from accounts receivable default and has the following children {{code}}Clear{{/code}} and {{code}}Set{{/code}} |
| 239 | ))) |
| 240 | ))) |
| 241 | |
| 242 | ===== Clear ===== |
| 243 | |
| 244 | ===== Set ===== |
| 245 | |
| 246 | === Invoices === |
| 247 | |
| 248 | ==== InvoiceWithDistribution ==== |
| 249 | |
| 250 | ===== InvoiceNo ===== |
| 251 | |
| 252 | |
| 253 | ===== ReferenceInfo ===== |
| 254 | |
| 255 | ===== InvoiceDate ===== |
| 256 | |
| 257 | ===== PreferredDueDate ===== |
| 258 | |
| 259 | ===== Amount ===== |
| 260 | |
| 261 | ===== DistributionInfo ===== |
| 262 | |
| 263 | ===== CreditInstructions ===== |
| 264 | |
| 265 | = Datatypes = |