Changes for page ExternalServicesmanual
Last modified by Fredrik Nilsson on 2021/06/29 16:53
From empty
To version 50.1
edited by Bent Pitkänen
on 2019/11/14 11:12
on 2019/11/14 11:12
Change comment: There is no comment for this version
Summary
-
Page properties (6 modified, 0 added, 0 removed)
-
Attachments (0 modified, 15 added, 0 removed)
- 1-class-diagram-external.png
- 1573563792142-225.png
- 1573569373687-299.png
- 1573570140844-820.png
- 1573631474317-399.png
- 1573632921277-742.png
- 1573646248641-666.png
- 1573648586121-179.png
- 2-class-diagram-external.png
- 3-class-diagram-external.png
- 4-class-diagram-external.png
- 5-class-diagram-external.png
- 6-class-diagram-external.png
- 7-class-diagram-external.png
- PayExConnect_Manual_PxR_ExternalServices.pdf
Details
- Page properties
-
- Title
-
... ... @@ -1,0 +1,1 @@ 1 +ExternalServicesmanual - Parent
-
... ... @@ -1,0 +1,1 @@ 1 +Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).WebHome - Author
-
... ... @@ -1,1 +1,1 @@ 1 - XWiki.XWikiGuest1 +xwiki:XWiki.bpi - Default language
-
... ... @@ -1,0 +1,1 @@ 1 +en - Tags
-
... ... @@ -1,0 +1,1 @@ 1 +px-custom-page-content - Content
-
... ... @@ -1,0 +1,790 @@ 1 += = 2 + 3 +(% class="jumbotron" %) 4 +((( 5 +(% class="container" %) 6 +((( 7 +The external services manual cover methods used to retrieve Invoice PDFs as well as invoice and customer information. 8 +))) 9 +))) 10 + 11 +**You can also use the PDF manual found [[here>>attach:PayExConnect_Manual_PxR_ExternalServices.pdf]].** 12 + 13 += InvoiceService methods = 14 + 15 +The complete Wsdl specification for this service can be found at: 16 + 17 +[[https:~~/~~/connect.payex.com~~/~~/PxR/InvoiceService.svc?wsdl>>url:https://connect.payex.com//PxR/InvoiceService.svc?wsdl]] 18 + 19 + (Username/password security model) 20 + 21 +== GetInvoicePdfByBillNo == 22 + 23 +(% class="wikigeneratedid" %) 24 +Gets a specific invoice document in the format of PDF 25 + 26 +**Class diagram** 27 + 28 +**[[image:1-class-diagram-external.png]]** 29 + 30 +**Request parameters** 31 + 32 +(% class="table-bordered table-striped" %) 33 +|=(% colspan="4" %)GetInvoiceByBillNoRequest 34 +|**Field**|**Datatype**|**Required**|**Description** 35 +|##BillNo##|String(15)|Yes| 36 +|##TrackingUserEmail##|Sting(50)|Yes|User info for trackability. 37 +|##TraceId##|String|Yes| 38 + 39 +(% class="wikigeneratedid" %) 40 +**Response parameters** 41 + 42 +(% class="wikigeneratedid" %) 43 +[[GetInvoicePDFResponse>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoicePDFResponse"]] 44 + 45 +== GetInvoicePdfByExternalInvoiceId == 46 + 47 +Gets a specific invoice document in the format of PDF 48 + 49 +**Class diagram** 50 + 51 +**[[image:2-class-diagram-external.png]]** 52 + 53 +**Request parameters** 54 + 55 +(% class="table-bordered table-striped" %) 56 +|=(% colspan="4" %)GetInvoicePdfByExternalInvoiceIdRequest 57 +|**Field**|**Datatype**|**Required**|**Description** 58 +|##ExternalInvoiceId##|String(15)|Yes| 59 +|TrackingUserEmail|String(50)|Yes|User info for trackability. 60 +|TraceId|String|Yes| 61 + 62 +(% class="wikigeneratedid" %) 63 +**Response parameters** 64 + 65 +(% class="wikigeneratedid" %) 66 +[[GetInvoicePDFResponse>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoicePDFResponse"]] 67 + 68 +== GetInvoiceInformationByBillNo == 69 + 70 +Gets information about a specific invoice 71 + 72 +**Class diagram** 73 + 74 +**[[image:3-class-diagram-external.png]]** 75 + 76 +**Request parameters** 77 + 78 +(% class="table-bordered table-striped" %) 79 +|=(% colspan="4" %)GetInvoiceInformationByBillNoRequest 80 +|**Field**|**Datatype**|**Required**|**Description** 81 +|##BillNo##|String(15)|Yes| 82 +|##TrackingUserEmail##|String(50)|Yes|User info for trackability. 83 +|##TraceId##|String|Yes| 84 + 85 +(% class="wikigeneratedid" %) 86 +**Response parameters** 87 + 88 +(% class="wikigeneratedid" %) 89 +[[GetInvoiceInformationResponse>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoiceInformationResponse"]] 90 + 91 +== GetInvoiceIformationByExternalInvoiceId == 92 + 93 +Gets information about a specific invoice 94 + 95 +**Class diagram** 96 + 97 +**[[image:4-class-diagram-external.png]]** 98 + 99 +**Request parameters** 100 + 101 +(% class="table-bordered table-striped" %) 102 +|=(% colspan="4" %)GetInvoiceByExternalInvoiceIdRequest 103 +|**Field**|**Datatype**|**Required**|**Description** 104 +|ExternalInvoiceId|String (15)|Yes| 105 +|TrackingUserEmail|String (50)|Yes|User info for trackability. 106 +|TraceId|String|Yes| 107 + 108 +(% class="wikigeneratedid" %) 109 +**Response parameters** 110 + 111 +(% class="wikigeneratedid" %) 112 +[[GetInvoiceInformationResponse>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoiceInformationResponse"]] 113 + 114 +== GetOpenInvoiceInformationByCustomerNo == 115 + 116 +Gets open invoices 117 + 118 +**Class diagram** 119 + 120 +**[[image:5-class-diagram-external.png]]** 121 + 122 +**Request parameters** 123 + 124 +(% class="table-bordered table-striped" %) 125 +|=(% colspan="4" %)GetOpenInvoiceInformationByCustomerNoRequest 126 +|**Field**|**Datatype**|**Required**|**Description** 127 +|##CustomerNo##|String(15)|Yes|##CustomerNo ##is your unique identifier of the customer. 128 +|##TrackingUserEMail##|String|No|User info for trackability. 129 +|##TraceId##|String|Yes| 130 + 131 +**Response parameters** 132 + 133 +(% class="table-bordered table-striped" %) 134 +|=(% colspan="3" %)GetOpenInvoiceInformationByCustomerNoResponse 135 +|**Field**|**Datatype**|**Description** 136 +|##CompanyNo##|String| 137 +|##CustomerNo##|String|##CustomerNo ##is you Unique identifier of the customer. 138 +|##CustomerName##|String| 139 +|##InvoiceList##|List <[[OpenInvoice>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HOpenInvoice"]]>| 140 +|##ResponseCode##|String| 141 +|##ResponseMessage##|String| 142 +|##TraceId##|String| 143 + 144 +**Classes** 145 + 146 +(% class="table-bordered table-striped" %) 147 +|=(% colspan="3" %)((( 148 +==== OpenInvoice ==== 149 +))) 150 +|**Field**|**Datatype**|**Description** 151 +|(% style="font-family:monospace" %)BillNo|String| 152 +|##BillStatusCode##|Int|See the [[bill status code table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBillstatuscodes"]] for available status codes. 153 +|##ExternalInvoiceId##|String|Additional unique invoice identifier. 154 +|##BillDate##|DateTime| 155 +|##DueDate##|DateTime(Optional)|Empty if BillTypeCode is ##Invoice.## 156 +|##BillTypeCode##|Byte|See the [[bill type code table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBilltypecodes"]] for available bill type codes. 157 +|##OriginalAmount##|Decimal| 158 +|##CurrentDebt##|Decimal| 159 +|##CurrencyCode##|String| 160 +|##CurrentClaimLevelCode##|Int|See the [[claim level code table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HClaimlevelcodes"]] for available claim level codes. 161 +|##PaymentBankAccount##|[[PaymentBankAccount>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HPaymentBankAccount"]]| 162 +|##PaymentType##|String| 163 +|##ActiveRespite##|[[ActiveRespite>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActiveRespite"]]| 164 +|##ActivePaymentOrder##|[[ActivePaymentOrder>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActivePaymentOrder"]]| 165 + 166 +== GetClosedInvoiceInformationByCustomerNo == 167 + 168 +Gets closed invoices (status “Closed” only) 169 + 170 +**Class diagram** 171 + 172 +**[[image:6-class-diagram-external.png]]** 173 + 174 +**Request parameters** 175 + 176 +(% class="table-bordered table-striped" %) 177 +|=(% colspan="4" %)GetClosedInvoiceInformationCustomerNoRequest 178 +|**Field**|**Datatype**|**Required**|**Description** 179 +|##CustomerNo##|String(15)|Yes|CustomerNo is your unique identifier for the customer. 180 +|##TrackingUserEMail##|String|No|User info for trackability. 181 +|##TraceId##|String|Yes| 182 + 183 +**Response parameters** 184 + 185 +(% class="table-bordered table-striped" %) 186 +|=(% colspan="3" %)GetClosedInvoiceInformationByCustomerNoResponse 187 +|**Field**|**Datatype**|**Description** 188 +|##CompanyNo##|String|Yoyr accounts receivable number at PayEx. 189 +|##CustomerNo##|String|##CustomerNo ##is you Unique identifier of the customer. 190 +|##CustomerName##|String| 191 +|##InvoiceList##|List <[[ClosedInvoice>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HClosedInvoice"]]>| 192 +|##ResponseCode##|String| 193 +|##ResponseMessage##|String| 194 +|##TraceId##|String| 195 + 196 +**Classes** 197 + 198 +(% class="table-bordered table-striped" %) 199 +|=(% colspan="3" %)((( 200 +==== ClosedInvoice ==== 201 +))) 202 +|**Field**|**Datatype**|**Description** 203 +|(% style="font-family:monospace" %)BillNo|String| 204 +|##BillStatusCode##|Int|See the [[bill status code table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBillstatuscodes"]] for available status codes. 205 +|##ExternalInvoiceId##|String|Additional unique invoice identifier in accounts receivable. 206 +|##BillDate##|DateTime| 207 +|##DueDate##|DateTime(Optional)|Empty if BillTypeCode is ##Invoice.## 208 +|##BillTypeCode##|Byte|See the [[bill type code table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBilltypecodes"]] for available bill type codes. 209 +|##OriginalAmount##|Decimal| 210 +|##CurrencyCode##|String| 211 + 212 +== AddInvoiceRespiteByBillNo10 == 213 + 214 +Add respite date to an open invoice. 215 + 216 +**Class diagram** 217 +[[image:1573563792142-225.png||height="318" width="920"]] 218 +**Request parameters** 219 + 220 +(% class="table-bordered table-striped" %) 221 +|=(% colspan="4" %)AddInvoiceRespiteByBillNo10Request 222 +|**Field**|**Datatype**|**Required**|**Description** 223 +|##BillNo##|String(15)|Yes|Bill Number. 224 +|##RespiteCause##|String(250)|Yes|Reason for respite. 225 +|##TrackingUserEMail##|String(1-256)|Yes|User info for trackability. 226 +|##TraceId##|String|Yes| 227 +|##ValidToDate##|DateTime|Yes| 228 + 229 +**Response parameters** 230 + 231 +(% class="table-bordered table-striped" %) 232 +|=(% colspan="4" %)AddInvoiceRespiteByBillNo10Response 233 +|**Field**|**Datatype**|**Description** 234 +|##ResponseCode##|String| 235 +|##ResponseMessage##|String| 236 +|##TraceId##|String| 237 + 238 +**Error codes** 239 + 240 +(% class="table-bordered table-striped" %) 241 +|=(% colspan="4" %)GetCustomerCurrentStateByCustomerNoResponse 242 +|**Code**|**Name**|**Description** 243 +|##5074##|InvalidDate|ValidToDate is not within a valid date. 244 +|##5046##|InvalidAccountType|Bill of BillNo is not of a valid AccountType. 245 +|##1208##|InvalidAccountStatus|Respite not a valid action on this bill. 246 + 247 +== ConvertInvoiceToAccount10 == 248 + 249 +Convert an invoice account to a credit account. 250 + 251 +**Class diagram** 252 + 253 +[[image:1573569373687-299.png||height="324" width="739"]] 254 + 255 +**Request parameters** 256 + 257 +(% class="table-bordered table-striped" %) 258 +|=(% colspan="4" %)ConvertInvoiceToAccount10Request 259 +|**Field**|**Datatype**|**Required**|**Description** 260 +|##BillNo##|String(15)|Yes|Bill Number. 261 +|##TrackingUserEMail##|String(1-256)|Yes|User info for trackability. 262 +|##TraceId##|String|Yes| 263 + 264 +**Response parameters** 265 + 266 +(% class="table-bordered table-striped" %) 267 +|=(% colspan="4" %)ConvertInvoiceToAccount10Response 268 +|**Field**|**Datatype**|**Description** 269 +|##ResponseCode##|String| 270 +|##ResponseMessage##|String| 271 +|##TraceId##|String| 272 + 273 +== RegisterInvoiceDirectPaymentByBillNo10 == 274 + 275 +Register a direct payment on given invoice. 276 + 277 +**Class diagram** 278 + 279 +[[image:1573570140844-820.png||height="384" width="715"]] 280 + 281 +**Request parameters** 282 + 283 +(% class="table-bordered table-striped" %) 284 +|=(% colspan="4" %)RegisterInvoiceDirectPaymentByBillNo10Request 285 +|**Field**|**Datatype**|**Required**|**Description** 286 +|##Amount##|Decimal|Yes|DirectPayment Amount. 287 +|##BillNo##|String|Yes|Bill to match payment to. 288 +|##PaymentDate##|DateTime|Yes|Date when payment occured. 289 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 290 +|TraceId|String|Yes| 291 + 292 +**Response parameters** 293 + 294 +(% class="table-bordered table-striped" %) 295 +|=(% colspan="4" %)RegisterInvoiceDirectPaymentByBillNo10Response 296 +|**Field**|**Datatype**|**Description** 297 +|##ResponseCode##|String| 298 +|##ResponseMessage##|String| 299 +|##TraceId##|String| 300 + 301 +**Error codes** 302 + 303 +(% class="table-bordered table-striped" %) 304 +|=(% colspan="4" %)GetCustomerCurrentStateByCustomerNoResponse 305 +|**Code**|**Name**|**Description** 306 +|##5080##|InvalidBillNo|BillNo is invalid 307 +|##1207##|InvalidAmount|Amount is invalid 308 +|##5074##|InvalidDate|PaymentDate is not within a valid date 309 + 310 +== AddInvoiceCopyOrderByBillNo10 == 311 + 312 +Order a copy of the invoice to be delivered. 313 + 314 +**Class diagram** 315 + 316 +[[image:1573631474317-399.png||height="349" width="795"]] 317 + 318 +**Request parameters** 319 + 320 +(% class="table-bordered table-striped" %) 321 +|=(% colspan="4" %)AddInvoiceCopyOrderByBillNo10Request 322 +|**Field**|**Datatype**|**Required**|**Description** 323 +|##BillNo##|String|Yes| 324 +|##DistributionMethod##|String|Yes| 325 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 326 +|TraceId|String|Yes| 327 + 328 +**Response parameters** 329 + 330 +(% class="table-bordered table-striped" %) 331 +|=(% colspan="4" %)RegisterInvoiceDirectPaymentByBillNo10Response 332 +|**Field**|**Datatype**|**Description** 333 +|##ResponseCode##|String| 334 +|##ResponseMessage##|String| 335 +|##TraceId##|String| 336 + 337 +**Error codes** 338 + 339 +(% class="table-bordered table-striped" %) 340 +|=(% colspan="4" %)GetCustomerCurrentStateByCustomerNoResponse 341 +|**Code**|**Name**|**Description** 342 +|##5089##|BillsNotFound|Found no matching Invoices for BillNo 343 + 344 +== GetClosedInvoiceInformationByCustomerNo20 == 345 + 346 +Get information about a customer's closed invoice(s) by customer number. 347 + 348 +**Class diagram** 349 +[[image:1573632921277-742.png||height="509" width="841"]] 350 + 351 +**Request parameters** 352 + 353 +(% class="table-bordered table-striped" %) 354 +|=(% colspan="4" %)GetClosedInvoiceInformationByCustomerNo20Request 355 +|**Field**|**Datatype**|**Required**|**Description** 356 +|##CustomerNo##|String|Yes| 357 +|##TrackingUserEmail##|String|Yes|User info for trackability. 358 +|TraceId| |yes| 359 + 360 +**Response parameters** 361 + 362 +**[[GetClosedInvoiceInformation20Response>>||anchor="HGetClosedInvoiceInformation20Response"]]** 363 + 364 +== GetClosedInvoiceInformationByRegNo20 == 365 + 366 +Get information about a customer's closed invoice(s) by social security number. 367 + 368 +**Class diagram** 369 + 370 +[[image:1573646248641-666.png||height="508" width="807"]] 371 + 372 +**Request parameters** 373 + 374 +(% class="table-bordered table-striped" %) 375 +|=(% colspan="4" %)GetClosedInvoiceInformationByRegNo20Request 376 +|**Field**|**Datatype**|**Required**|**Description** 377 +|##RegNo##|[[RegNo>>||anchor="HRegNo"]]|Yes|See [[RegNo>>||anchor="HRegNo"]] 378 +|##TrackingUserEmail##|String|Yes|User info for trackability. 379 +|TraceId| |yes| 380 + 381 +**Response parameters** 382 + 383 +**[[GetClosedInvoiceInformation20Response>>||anchor="HGetClosedInvoiceInformation20Response"]]** 384 + 385 +**Error codes** 386 + 387 +(% class="table-bordered table-striped" %) 388 +|=(% colspan="4" %)GetClosedInvoiceInformation20Response 389 +|**Code**|**Name**|**Description** 390 +|##5006##|ExpectedCustomerNumber|Found multiple customer on RegNo, use CustomerNo instead. 391 +|5075|MissingAccountForBill|Found no matching customer for RegNo. 392 +|1024|ErrorInvalidRegNo|Invalid RegNo format. 393 + 394 +== GetInvoiceInformationByBillNo20 == 395 + 396 +[[image:1573648586121-179.png||height="582" width="1172"]] 397 + 398 +**Request parameters** 399 + 400 +(% class="table-bordered table-striped" %) 401 +|=(% colspan="4" %)GetInvoiceInformationByBillNo20Request 402 +|**Field**|**Datatype**|**Required**|**Description** 403 +|##BillNo##|String|Yes| 404 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 405 +|TraceId|String|Yes| 406 + 407 +**Response parameters** 408 + 409 +[[GetInvoinceInformation20Response>>||anchor="HGetInvoiceInformation20Response"]] 410 + 411 +**Error codes** 412 + 413 +(% class="table-bordered table-striped" %) 414 +|=(% colspan="4" %)GetInvoinceInformation20Response 415 +|**Code**|**Name**|**Description** 416 +|##5072##|InvalidExternalBillId|ExternalInvoiceId does not match any valid invoices. 417 +|5089|BillsNotFound|Invoice match but invoice not valid. May be older than 1 year. 418 + 419 += CustomerService methods = 420 + 421 +The complete Wsdl specification for this service can be found at: 422 +[[https:~~/~~/connect.internaltest.payex.com/PxR/CustomerService.svc>>url:https://connect.internaltest.payex.com/PxR/CustomerService.svc]] 423 + 424 + (Username/password security model) 425 + 426 +== GetcustomerCurrentStateByCustomerNo == 427 + 428 +Get information about current state of a customer. 429 + 430 +**Class diagram** 431 + 432 +[[image:7-class-diagram-external.png]] 433 + 434 +**Request parameters** 435 + 436 +(% class="table-bordered table-striped" %) 437 +|=(% colspan="4" %)GetCustomerCurrentStateByCustomerNoRequest 438 +|**Field**|**Datatype**|**Required**|**Description** 439 +|##CustomerNumber##|String(15)|Yes| 440 +|##TrackingUserEMail##|String|No| 441 + 442 +**Response parameters** 443 + 444 +(% class="table-bordered table-striped" %) 445 +|=(% colspan="3" %)GetCustomerCurrentStateByCustomerNoResponse 446 +|**Field**|**Datatype**|**Description** 447 +|(% style="font-family:monospace" %)##CustomerConsents##|[[CustomerConsent>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerConsent"]]|Array. 448 +|##CustomerInfo##|[[CustomerInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerInfo"]]| 449 +|##CustomerNo##|String| 450 +|##CustomerStatus##|[[CustomerStatus>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerStatus"]]|Array. 451 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]| 452 + 453 +**Classes** 454 + 455 +(% class="table-bordered table-striped" %) 456 +|=(% colspan="3" %)((( 457 +==== CustomerConsent ==== 458 +))) 459 +|**Field**|**Datatype**|**Description** 460 +|(% style="font-family:monospace" %)##ConsentTypeCode##|Int|See the [[consent type codes>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HConsenttypecodes"]] table for available consent type codes. 461 + 462 +(% class="table-bordered table-striped" %) 463 +|=(% colspan="3" %)((( 464 +==== CustomerInfo ==== 465 +))) 466 +|**Field**|**Datatype**|**Description** 467 +|(% style="font-family:monospace" %)##Name##|String| 468 +|##DistributionAddressInfo##|[[DistributionAddressInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HDistributionAddressInfo"]]| 469 +|##Language##|String| 470 +|##LegalEntityCode##|Int|See the [[legal entity codes table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HLegalentitycodes"]] for available legal entity codes. 471 +|##VatNo##|String| 472 +|##Category##| | 473 + 474 +(% class="table-bordered table-striped" %) 475 +|=(% colspan="3" %)((( 476 +==== CustomerStatus ==== 477 +))) 478 +|**Field**|**Datatype**|**Description** 479 +|(% style="font-family:monospace" %)##CustomerStatusTypeCode##|Int| 480 + 481 +(% class="table-bordered table-striped" %) 482 +|=(% colspan="4" %)((( 483 +==== DistributionAddressInfo ==== 484 +))) 485 +|**Field**|**Datatype**|**Required**|**Description** 486 +|(% style="font-family:monospace" %)##Addresses##|Array|Yes|See [[address>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HAddress"]]. 487 +|##EMailAddress##|String|No| 488 +|##Cellphone##|String|No| 489 + 490 +(% class="table-bordered table-striped" %) 491 +|=(% colspan="4" %)((( 492 +==== Address ==== 493 +))) 494 +|**Field**|**Datatype**|**Required**|**Description** 495 +|(% style="font-family:monospace" %)Addressee|String(72)|Yes| 496 +|##StreetAdress##|String(35)|No| 497 +|##ZipCode##|String(9)|Yes| 498 +|##City##|String(27)|Yes| 499 +|##CoAddress##|String(35)|No| 500 +|##CountryCode##|String(2)|Yes| 501 + 502 +(% id="HAppendix1SharedClasses" %) 503 += Appendix 1 Shared Classes = 504 + 505 + 506 +**Response parameters** 507 + 508 +(% class="table-bordered table-striped" %) 509 +|=(% colspan="3" %)((( 510 +==== GetInvoicePDFResponse ==== 511 +))) 512 +|**Field**|**Datatype**|**Description** 513 +|##Pdf##|Byte[]| 514 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]| 515 +|##CustomerNo##|String| 516 +|##ResponseCode##|String| 517 +|##ResponseMessage##|String| 518 +|##TraceId##|String| 519 + 520 +(% class="table-bordered table-striped" %) 521 +|=(% colspan="3" %)((( 522 +==== GetInvoiceInformationResponse ==== 523 +))) 524 +|**Field**|**Datatype**|**Description** 525 +|##CompanyNo##|String| 526 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]| 527 +|##CustomerNo##|String| 528 +|##CustomerName##|String| 529 +|##Invoice##|[[Invoice>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoice"]]| 530 +|##ResponseCode##|String| 531 +|##ResponseMessage##|String| 532 +|##TraceId##|String| 533 + 534 +(% class="table-bordered table-striped" %) 535 +|=(% colspan="3" %)((( 536 +==== RegNo ==== 537 +))) 538 +|**Field**|**Datatype**|**Description** 539 +|##CountryCode##|String| 540 +|##Value##|String| 541 + 542 +(% class="table-bordered table-striped" %) 543 +|=(% colspan="3" %)((( 544 +==== Invoice ==== 545 +))) 546 +|**Field**|**Datatype**|**Description** 547 +|##PaymentReference##|String| 548 +|##BillNo##|String| 549 +|##BillStatusCode##|Int|See the [[bill type code table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBilltypecodes"]] for available bill type codes. 550 +|##ExternalInvoiceId##|String| 551 +|##ExternalReference##|String| 552 +|##SellerNo##|String| 553 +|##BillDate##|DateTime| 554 +|##DueDate##|DateTime (Optional)| 555 +|##OriginalAmount##|Decimal| 556 +|##Interest##|[[Interest>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInterest"]]| 557 +|##CurrentBalanceList##|List <[[Balance>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBalance"]]>| 558 +|##CurrencyCode##|String| 559 +|##CurrentClaimLevelCode##|Int|See the [[claim level codes table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HClaimlevelcodes"]] for available claim level codes. 560 +|##CollectionStatusCode##|Int|See the [[collection status code table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCollectionstatuscodes"]] for available collection status codes. 561 +|##PaymentBanAccount##|[[PaymentBankAccount>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HPaymentBankAccount"]]| 562 +|##PaymentType##|String| 563 +|##ActiveRespite##|[[ActiveRespite>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActiveRespite"]]| 564 +|##ActivePaymentOrder##|[[ActivePaymentOrder>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActivePaymentOrder"]]| 565 +|##BillId##|Long| 566 +|##BillTypeCode##|Byte|See the [[bill type code table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBilltypecodes"]] for available bill type codes. 567 +|##InvoiceHistory##|List <[[InvoiceHistory>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoiceHistory"]]>| 568 + 569 +(% class="table-bordered table-striped" %) 570 +|=(% colspan="3" %)((( 571 +==== Interest ==== 572 +))) 573 +|**Field**|**Datatype**|**Description** 574 +|##CurrentInterestRate##|decimal| 575 +|##InterestIntervalCode##|byte| 576 + 577 +(% class="table-bordered table-striped" %) 578 +|=(% colspan="3" %)((( 579 +==== Balance ==== 580 +))) 581 +|**Field**|**Datatype**|**Description** 582 +|##BalanceTypeCode##|int|See the [[balance type codes table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBalancetypecodes"]] for available balance type codes. 583 +|##Amount##|decimal| 584 + 585 +(% class="table-bordered table-striped" %) 586 +|=(% colspan="3" %)((( 587 +==== PaymentBankAccount ==== 588 +))) 589 +|**Field**|**Datatype**|**Description** 590 +|##BankAccountNo##|String| 591 +|##BankAccountType##|String| 592 +|##BIC##|String| 593 +|##IBAN##|String| 594 + 595 +(% class="table-bordered table-striped" %) 596 +|=(% colspan="3" %)((( 597 +==== ActiveRespite ==== 598 +))) 599 +|**Field**|**Datatype**|**Description** 600 +|##RespiteValidtoDate##|DateTime| 601 +|##RespiteTypeCode##|int| 602 + 603 +(% class="table-bordered table-striped" %) 604 +|=(% colspan="3" %)((( 605 +==== ActivePaymentOrder ==== 606 +))) 607 +|**Field**|**Datatype**|**Description** 608 +|##PaymentType##|String| 609 +|##ExecutionDate##|DateTime| 610 + 611 +(% class="table-bordered table-striped" %) 612 +|=(% colspan="3" %)((( 613 +==== InvoiceHistory ==== 614 +))) 615 +|**Field**|**Datatype**|**Description** 616 +|BillDate|DateTime| 617 +|BillId|long| 618 +|BillTypeCode|byte|See the [[bill type code table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBilltypecodes"]] for available bill type codes. 619 + 620 +(% class="table-bordered table-striped" %) 621 +|=(% colspan="3" %)((( 622 +==== GetClosedInvoiceInformation20Response ==== 623 +))) 624 +|**Field**|**Datatype**|**Description** 625 +|CompanyNo|String| 626 +|CustomerNo|string| 627 +|CustomerName|String| 628 +|InvoiceList|List<[[ClosedInvoice20>>||anchor="HClosedInvoice20"]]>|See [[ClosedInvoice20>>||anchor="HClosedInvoice20"]] 629 + 630 +(% class="table-bordered table-striped" %) 631 +|=(% colspan="3" %)((( 632 +==== ClosedInvoice20 ==== 633 +))) 634 +|**Field**|**Datatype**|**Description** 635 +|CurrencyCode|String| 636 +|BillNo|string| 637 +|BillStatusCode|Int| 638 +|ExternalInvoiceId|String| 639 +|BillDate|DateTime| 640 +|DueDate|DateTime?| 641 +|ExternalBillType|String| 642 +|OriginalAmount|Decimal| 643 +|SellerName|String| 644 +|SellerNo|String| 645 + 646 +(% class="table-bordered table-striped" %) 647 +|=(% colspan="3" %)((( 648 +==== GetInvoiceInformation20Response ==== 649 +))) 650 +|**Field**|**Datatype**|**Description** 651 +|CompanyNo|String| 652 +|RegNo|[[RegNo>>||anchor="HRegNo"]]| 653 +|CustomerNo|string| 654 +|CustomerName|String| 655 +|Invoice|[[InvoiceInformation20>>||anchor="HInvoiceInformation20inheritOpenInvoice20"]]| 656 + 657 +(% class="table-bordered table-striped" %) 658 +|=(% colspan="3" %)((( 659 +==== InvoiceInformation20 inherit [[OpenInvoice20>>||anchor="HOpenInvoice20inheritClosedInvoice20"]] ==== 660 +))) 661 +|**Field**|**Datatype**|**Description** 662 +|PenaltyIntest|[[Intrest>>||anchor="HIntrest"]]| 663 +|CurrentBalance|List<[[Balance>>||anchor="HBalance"]]>| 664 +|InvoiceHistory|List<[[InvoiceHistory20>>||anchor="HInvoiceHistory20"]]>| 665 + 666 +(% class="table-bordered table-striped" %) 667 +|=(% colspan="3" %)((( 668 +==== InvoiceHistory20 ==== 669 +))) 670 +|**Field**|**Datatype**|**Description** 671 +|BillDate|DateTime| 672 +|ExternalBillType|String| 673 +|BillAmount|Decimal?| 674 + 675 +(% class="table-bordered table-striped" %) 676 +|=(% colspan="3" %)((( 677 +==== OpenInvoice20 inherit [[ClosedInvoice20>>||anchor="HClosedInvoice20"]] ==== 678 +))) 679 +|**Field**|**Datatype**|**Description** 680 +|CurrentDebt|Decimal| 681 +|PaymentBankAccount|[[PaymentBankAccount>>||anchor="HPaymentBankAccount"]]| 682 +|PaymentType|String| 683 +|ActiveRespite|[[ActiveRespite20>>||anchor="HActiveRespite20"]]| 684 +|ActivePaymentOrder|[[ActivePaymentOrder>>||anchor="HActivePaymentOrder"]]| 685 +|PaymentRefrence|String| 686 +|ExportedToCollection|Bool| 687 + 688 +(% class="table-bordered table-striped" %) 689 +|=(% colspan="3" %)((( 690 +==== ActiveRespite20 ==== 691 +))) 692 +|**Field**|**Datatype**|**Description** 693 +|RespiteValidToDate|DateTime?| 694 +|RespiteTypeCode|Int| 695 + 696 += Appendix 2 Code specification = 697 + 698 +(% class="table-bordered table-striped" %) 699 +|=(% colspan="2" %)((( 700 +==== Bill status codes ==== 701 +))) 702 +|**BillStatusCodes**|**Description** 703 +|1|Open 704 +|2|Closed 705 +|3|Closed_Diff 706 +|4|Closed_Loss 707 +|5|Reversed 708 +|6|Arrears 709 +|7|Closed_Rest 710 +|8|Closed_Convert 711 +|9|Closed_Sold 712 +|10|Closed_Reversal 713 +|11|Pending 714 + 715 +(% class="table-bordered table-striped" %) 716 +|=(% colspan="2" %)((( 717 +==== Claim level codes ==== 718 +))) 719 +|**ClaimLevelCode**|**Description** 720 +|1|Invoice 721 +|2|RestReminderSent 722 +|3|ReminderSent 723 +|4|RestReminderSent 724 +|5|SecondReminderSent 725 +|6|RestReminderSent 726 +|7|CollectionClaimSent 727 +|8|RestReminderSent 728 +|9*|DebtCollection* 729 +|10|Late Fee, credit account 730 +|11|TerminationNoticeSent, credit account 731 + 732 +*Additional fees and interest may have occured in collection system, but is not included in the response. 733 + 734 +(% class="table-bordered table-striped" %) 735 +|=(% colspan="2" %)((( 736 +==== Bill type codes ==== 737 +))) 738 +|**BillTypeCode**|**Description** 739 +|1|Invoice 740 +|4|CreditInvoice 741 + 742 +(% class="table-bordered table-striped" %) 743 +|=(% colspan="2" %)((( 744 +==== Consent type codes ==== 745 +))) 746 +|**ConsentTypeCode**|**Description** 747 +|1|BGAGSE 748 +|2|EInvoiceB2CSE 749 +|3|EInvoiceB2CNO 750 +|4|BKAGNO 751 + 752 +(% class="table-bordered table-striped" %) 753 +|=(% colspan="2" %)((( 754 +==== Legal entity codes ==== 755 +))) 756 +|**LegalEntiytCode**|**Description** 757 +|None|None 758 +|Private|Private 759 +|Business|Business 760 + 761 +(% class="table-bordered table-striped" %) 762 +|=(% colspan="2" %)((( 763 +==== Balance type codes ==== 764 +))) 765 +|**BalanceTypeCode**|**Description** 766 +|0|None 767 +|1|Capital 768 +|2|ReminderFee 769 +|3|PenaltyInterest 770 +|4|CalculatedPenaltyInterest 771 +|5|CollectionFee 772 +|6|BusinessReminderFee 773 +|7|BillingFee 774 +|8|DelayFee 775 +|9|DebtInterest 776 +|10|DebtCollectionCharge 777 +|11|Rounding 778 + 779 +(% class="table-bordered table-striped" %) 780 +|=(% colspan="2" %)((( 781 +==== Collection status codes ==== 782 +))) 783 +|**CollectionStatusCode**|**Description** 784 +|1|PreDebtCollection 785 +|2|DebtCollection 786 +|3|LegalProcess 787 +|4|Monitoring 788 +|5|External 789 +|6|Closed 790 +|7|ReturnedWrongAddress
- 1-class-diagram-external.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.dap - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1573563792142-225.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1573569373687-299.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1573570140844-820.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1573631474317-399.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1573632921277-742.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1573646248641-666.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1573648586121-179.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 2-class-diagram-external.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.dap - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 3-class-diagram-external.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.dap - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 4-class-diagram-external.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.dap - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 5-class-diagram-external.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.dap - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 6-class-diagram-external.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.dap - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 7-class-diagram-external.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.dap - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- PayExConnect_Manual_PxR_ExternalServices.pdf
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.rae - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content