Changes for page ExternalServicesmanual
Last modified by frn on 2021/06/29 16:53
Change comment: There is no comment for this version
Summary
-
Page properties (6 modified, 0 added, 0 removed)
-
Attachments (0 modified, 32 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
- 1573822272252-854.png
- 1573822789308-786.png
- 1573825242764-218.png
- 1573825460421-413.png
- 1574422177227-663.png
- 1574423356546-688.png
- 1574426401088-684.png
- 1574426572366-122.png
- 1574427881741-366.png
- 1574428685798-189.png
- 1574431509616-621.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
- GetOpenInvoiceInformationByCustomerNo20.png
- PxR_InvoiceService_AddPaymentOrderOnDueDateRequest.png
- PxR_InvoiceService_DeletePaymentOrder.png
- PxR_InvoiceService_GetInvoiceInformationByBillNo20.png
- PxR_InvoiceService_GetOpenInvoiceInformationByCustomerNo20.png
- PxR_InvoiceService_GetOpenInvoiceInformationByExternalInvoiceId20.png
- PxR_InvoiceService_GetOpenInvoiceInformationByRegNo20.png
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.mly - Default language
-
... ... @@ -1,0 +1,1 @@ 1 +en - Tags
-
... ... @@ -1,0 +1,1 @@ 1 +px-custom-page-content - Content
-
... ... @@ -1,0 +1,1267 @@ 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 + 12 += InvoiceService methods = 13 + 14 +The complete Wsdl specification for this service can be found at: 15 + 16 +[[https:~~/~~/connect.payex.com/PxR/InvoiceService.svc?wsdl>>https://connect.payex.com/PxR/InvoiceService.svc?wsdl]] 17 + 18 + (Username/password security model) 19 + 20 +== GetInvoicePdfByBillNo == 21 + 22 +(% class="wikigeneratedid" %) 23 +Gets a specific invoice document in the format of PDF 24 + 25 +**Class diagram** 26 + 27 +**[[image:1-class-diagram-external.png]]** 28 + 29 +**Request parameters** 30 + 31 +(% class="table-bordered table-striped" %) 32 +|=(% colspan="4" %)((( 33 +==== GetInvoiceByBillNoRequest ==== 34 +))) 35 +|**Field**|**Datatype**|**Required**|**Description** 36 +|##BillNo##|String(15)|Yes| 37 +|##TrackingUserEmail##|String(50)|Yes|User info for trackability. 38 +|##TraceId##|String|Yes| 39 + 40 +(% class="wikigeneratedid" %) 41 +**Response parameters** 42 + 43 +(% class="wikigeneratedid" %) 44 +[[GetInvoicePDFResponse>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoicePDFResponse"]] 45 + 46 +== GetInvoicePdfByExternalInvoiceId == 47 + 48 +Gets a specific invoice document in the format of PDF 49 + 50 +**Class diagram** 51 + 52 +**[[image:2-class-diagram-external.png]]** 53 + 54 +**Request parameters** 55 + 56 +(% class="table-bordered table-striped" %) 57 +|=(% colspan="4" %)((( 58 +==== GetInvoicePdfByExternalInvoiceIdRequest ==== 59 +))) 60 +|**Field**|**Datatype**|**Required**|**Description** 61 +|##ExternalInvoiceId##|String(15)|Yes| 62 +|TrackingUserEmail|String(50)|Yes|User info for trackability. 63 +|TraceId|String|Yes| 64 + 65 +(% class="wikigeneratedid" %) 66 +**Response parameters** 67 + 68 +(% class="wikigeneratedid" %) 69 +[[GetInvoicePDFResponse>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoicePDFResponse"]] 70 + 71 +== GetInvoiceInformationByBillNo == 72 + 73 +Gets information about a specific invoice 74 + 75 +**Class diagram** 76 + 77 +**[[image:3-class-diagram-external.png]]** 78 + 79 +**Request parameters** 80 + 81 +(% class="table-bordered table-striped" %) 82 +|=(% colspan="4" %)((( 83 +==== GetInvoiceInformationByBillNoRequest ==== 84 +))) 85 +|**Field**|**Datatype**|**Required**|**Description** 86 +|##BillNo##|String(15)|Yes| 87 +|##TrackingUserEmail##|String(50)|Yes|User info for trackability. 88 +|##TraceId##|String|Yes| 89 + 90 +(% class="wikigeneratedid" %) 91 +**Response parameters** 92 + 93 +(% class="wikigeneratedid" %) 94 +[[GetInvoiceInformationResponse>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoiceInformationResponse"]] 95 + 96 +== GetInvoiceInformationByExternalInvoiceId == 97 + 98 +Gets information about a specific invoice 99 + 100 +**Class diagram** 101 + 102 +**[[image:4-class-diagram-external.png]]** 103 + 104 +**Request parameters** 105 + 106 +(% class="table-bordered table-striped" %) 107 +|=(% colspan="4" %)((( 108 +==== GetInvoiceByExternalInvoiceIdRequest ==== 109 +))) 110 +|**Field**|**Datatype**|**Required**|**Description** 111 +|ExternalInvoiceId|String (15)|Yes| 112 +|TrackingUserEmail|String (50)|Yes|User info for trackability. 113 +|TraceId|String|Yes| 114 + 115 +(% class="wikigeneratedid" %) 116 +**Response parameters** 117 + 118 +(% class="wikigeneratedid" %) 119 +[[GetInvoiceInformationResponse>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoiceInformationResponse"]] 120 + 121 +== GetOpenInvoiceInformationByCustomerNo == 122 + 123 +Gets open invoices 124 + 125 +**Class diagram** 126 + 127 +**[[image:5-class-diagram-external.png]]** 128 + 129 +**Request parameters** 130 + 131 +(% class="table-bordered table-striped" %) 132 +|=(% colspan="4" %)((( 133 +==== GetOpenInvoiceInformationByCustomerNoRequest ==== 134 +))) 135 +|**Field**|**Datatype**|**Required**|**Description** 136 +|##CustomerNo##|String(15)|Yes|##CustomerNo ##is your unique identifier of the customer. 137 +|##TrackingUserEMail##|String|No|User info for trackability. 138 +|##TraceId##|String|Yes| 139 + 140 +**Response parameters** 141 + 142 +(% class="table-bordered table-striped" %) 143 +|=(% colspan="3" %)((( 144 +==== GetOpenInvoiceInformationByCustomerNoResponse ==== 145 +))) 146 +|**Field**|**Datatype**|**Description** 147 +|##CompanyNo##|String| 148 +|##CustomerNo##|String|##CustomerNo ##is you Unique identifier of the customer. 149 +|##CustomerName##|String| 150 +|##InvoiceList##|List <[[OpenInvoice>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HOpenInvoice"]]>| 151 +|##ResponseCode##|String| 152 +|##ResponseMessage##|String| 153 +|##TraceId##|String| 154 + 155 +**Classes** 156 + 157 +(% class="table-bordered table-striped" %) 158 +|=(% colspan="3" %)((( 159 +==== OpenInvoice ==== 160 +))) 161 +|**Field**|**Datatype**|**Description** 162 +|(% style="font-family:monospace" %)BillNo|String| 163 +|##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. 164 +|##ExternalInvoiceId##|String|Additional unique invoice identifier. 165 +|##BillDate##|DateTime| 166 +|##DueDate##|DateTime(Optional)|Empty if BillTypeCode is ##Invoice.## 167 +|##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. 168 +|##OriginalAmount##|Decimal| 169 +|##CurrentDebt##|Decimal| 170 +|##CurrencyCode##|String| 171 +|##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. 172 +|##PaymentBankAccount##|[[PaymentBankAccount>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HPaymentBankAccount"]]| 173 +|##PaymentType##|String| 174 +|##ActiveRespite##|[[ActiveRespite>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActiveRespite"]]| 175 +|##ActivePaymentOrder##|[[ActivePaymentOrder>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActivePaymentOrder"]]| 176 + 177 +== GetClosedInvoiceInformationByCustomerNo == 178 + 179 +Gets closed invoices (status “Closed” only) 180 + 181 +**Class diagram** 182 + 183 +**[[image:6-class-diagram-external.png]]** 184 + 185 +**Request parameters** 186 + 187 +(% class="table-bordered table-striped" %) 188 +|=(% colspan="4" %)((( 189 +==== GetClosedInvoiceInformationByCustomerNoRequest ==== 190 +))) 191 +|**Field**|**Datatype**|**Required**|**Description** 192 +|##CustomerNo##|String(15)|Yes|CustomerNo is your unique identifier for the customer. 193 +|##TrackingUserEMail##|String|No|User info for trackability. 194 +|##TraceId##|String|Yes| 195 + 196 +**Response parameters** 197 + 198 +(% class="table-bordered table-striped" %) 199 +|=(% colspan="3" %)((( 200 +==== GetClosedInvoiceInformationByCustomerNoResponse ==== 201 +))) 202 +|**Field**|**Datatype**|**Description** 203 +|##CompanyNo##|String|Yoyr accounts receivable number at PayEx. 204 +|##CustomerNo##|String|##CustomerNo ##is you Unique identifier of the customer. 205 +|##CustomerName##|String| 206 +|##InvoiceList##|List <[[ClosedInvoice>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HClosedInvoice"]]>| 207 +|##ResponseCode##|String| 208 +|##ResponseMessage##|String| 209 +|##TraceId##|String| 210 + 211 +**Classes** 212 + 213 +(% class="table-bordered table-striped" %) 214 +|=(% colspan="3" %)((( 215 +==== ClosedInvoice ==== 216 +))) 217 +|**Field**|**Datatype**|**Description** 218 +|(% style="font-family:monospace" %)BillNo|String| 219 +|##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. 220 +|##ExternalInvoiceId##|String|Additional unique invoice identifier in accounts receivable. 221 +|##BillDate##|DateTime| 222 +|##DueDate##|DateTime(Optional)|Empty if BillTypeCode is ##Invoice.## 223 +|##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. 224 +|##OriginalAmount##|Decimal| 225 +|##CurrencyCode##|String| 226 + 227 +== AddInvoiceRespiteByBillNo10 == 228 + 229 +Add respite date to an open invoice. 230 + 231 +**Class diagram** 232 +[[image:1573563792142-225.png||height="318" width="920"]] 233 +**Request parameters** 234 + 235 +(% class="table-bordered table-striped" %) 236 +|=(% colspan="4" %)((( 237 +==== AddInvoiceRespiteByBillNo10Request ==== 238 +))) 239 +|**Field**|**Datatype**|**Required**|**Description** 240 +|##BillNo##|String(15)|Yes|Bill Number. 241 +|##RespiteCause##|String(250)|Yes|Reason for respite. 242 +|##TrackingUserEMail##|String(1-256)|Yes|User info for trackability. 243 +|##TraceId##|String|Yes| 244 +|##ValidToDate##|DateTime|Yes| 245 + 246 +**Response parameters** 247 + 248 +(% class="table-bordered table-striped" %) 249 +|=(% colspan="4" %)((( 250 +==== AddInvoiceRespiteByBillNo10Response ==== 251 +))) 252 +|**Field**|**Datatype**|**Description** 253 +|##ResponseCode##|String| 254 +|##ResponseMessage##|String| 255 +|##TraceId##|String| 256 + 257 +**Error codes** 258 + 259 +(% class="table-bordered table-striped" %) 260 +|=(% colspan="4" %)((( 261 +==== GetCustomerCurrentStateByCustomerNoResponse ==== 262 +))) 263 +|**Code**|**Name**|**Description** 264 +|##5074##|InvalidDate|ValidToDate is not within a valid date. 265 +|##5046##|InvalidAccountType|Bill of BillNo is not of a valid AccountType. 266 +|##1208##|InvalidAccountStatus|Respite not a valid action on this bill. 267 + 268 +== AddPaymentOrderOnDueDate == 269 + 270 +Add paymentorder to an open invoice. 271 + 272 +**Class diagram** 273 +[[image:PxR_InvoiceService_AddPaymentOrderOnDueDateRequest.png]] 274 +**Request parameters** 275 + 276 +(% class="table-bordered table-striped" %) 277 +|=(% colspan="4" %)((( 278 +==== AddPaymentOrderOnDueDate ==== 279 +))) 280 +|**Field**|**Datatype**|**Required**|**Description** 281 +|##BillNo##|String(15)|Yes|Bill Number. 282 +|CompanyNo|String(15)|Yes|Company number 283 +|##TrackingUserEMail##|String(1-256)|Yes|User info for trackability. 284 +|##TraceId##|String|Yes| 285 + 286 +**Response parameters** 287 + 288 +(% class="table-bordered table-striped" %) 289 +|=(% colspan="4" %)((( 290 +==== AddPaymentOrderOnDueDate ==== 291 +))) 292 +|**Field**|**Datatype**|**Description** 293 +|##ResponseCode##|String| 294 +|##ResponseMessage##|String| 295 +|##TraceId##|String| 296 + 297 +**Error codes** 298 + 299 +(% class="table-bordered table-striped" %) 300 +|=(% colspan="4" %)((( 301 +==== GetCustomerCurrentStateByCustomerNoResponse ==== 302 +))) 303 +|**Code**|**Name**|**Description** 304 +|##5080##|InvalidBillNo|No bill found with billNo and companyNo 305 +|##5117##|AddPaymentOrderException|((( 306 +Customer ain't available for PaymentOrder or already have one on this bill 307 +))) 308 +|##5002##|InvalidOpenBill|BillStatus ain't Open 309 +|##5074##|InvalidDate|Possible DistributionDate for PaymentOrder has already surpassed today's date 310 +|##5120##|ClaimProcessPauseException|Bill has a ClaimProcessPause 311 + 312 +== == 313 + 314 +== ConvertInvoiceToAccount10 == 315 + 316 +Convert an invoice account to a credit account. 317 + 318 +**Class diagram** 319 + 320 +[[image:1573569373687-299.png||height="324" width="739"]] 321 + 322 +**Request parameters** 323 + 324 +(% class="table-bordered table-striped" %) 325 +|=(% colspan="4" %)((( 326 +==== ConvertInvoiceToAccount10Request ==== 327 +))) 328 +|**Field**|**Datatype**|**Required**|**Description** 329 +|##BillNo##|String(15)|Yes|Bill Number. 330 +|##TrackingUserEMail##|String(1-256)|Yes|User info for trackability. 331 +|##TraceId##|String|Yes| 332 + 333 +**Response parameters** 334 + 335 +(% class="table-bordered table-striped" %) 336 +|=(% colspan="4" %)((( 337 +==== ConvertInvoiceToAccount10Response ==== 338 +))) 339 +|**Field**|**Datatype**|**Description** 340 +|##ResponseCode##|String| 341 +|##ResponseMessage##|String| 342 +|##TraceId##|String| 343 + 344 +== DeletePaymentOrder == 345 + 346 +Abort a PaymentOrder for billNo 347 + 348 +**Class diagram** 349 + 350 +[[image:PxR_InvoiceService_DeletePaymentOrder.png||height="174" width="1267"]] 351 + 352 + 353 +**Request parameters** 354 + 355 +(% class="table-bordered table-striped" %) 356 +|=(% colspan="4" %)((( 357 +==== DeletePaymentOrderRequest ==== 358 +))) 359 +|**Field**|**Datatype**|**Required**|**Description** 360 +|##BillNo##|String|Yes|Bill to match paymentorder. 361 +|CompanyNo|String |Yes|Company number 362 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 363 +|TraceId|String|Yes| 364 + 365 +**Response parameters** 366 + 367 +(% class="table-bordered table-striped" %) 368 +|=(% colspan="4" %)((( 369 +==== DeletePaymentOrderResponse ==== 370 +))) 371 +|**Field**|**Datatype**|**Description** 372 +|##ResponseCode##|String| 373 +|##ResponseMessage##|String| 374 +|##TraceId##|String| 375 + 376 +**Error codes** 377 + 378 +(% class="table-bordered table-striped" %) 379 +|=(% colspan="4" %)((( 380 +==== DeletePaymentOrderResponse ==== 381 +))) 382 +|**Code**|**Name**|**Description** 383 +|##5080##|InvalidBillNo|BillNo is invalid 384 +|##5115##|PaymentOrderNotFound|Found no paymentorders connected to bill 385 +|##5116##|DeletePaymentOrderNotAllowed|Found paymentOrder but are not allowed to Delete since the paymentorder has begun/finished processing 386 + 387 +== RegisterInvoiceDirectPaymentByBillNo10 == 388 + 389 +Register a direct payment on given invoice. 390 + 391 +**Class diagram** 392 + 393 +[[image:1573570140844-820.png||height="384" width="715"]] 394 + 395 +**Request parameters** 396 + 397 +(% class="table-bordered table-striped" %) 398 +|=(% colspan="4" %)((( 399 +==== RegisterInvoiceDirectPaymentByBillNo10Request ==== 400 +))) 401 +|**Field**|**Datatype**|**Required**|**Description** 402 +|##Amount##|Decimal|Yes|DirectPayment Amount. 403 +|##BillNo##|String|Yes|Bill to match payment to. 404 +|##PaymentDate##|DateTime|Yes|Date when payment occured. 405 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 406 +|TraceId|String|Yes| 407 + 408 +**Response parameters** 409 + 410 +(% class="table-bordered table-striped" %) 411 +|=(% colspan="4" %)((( 412 +==== RegisterInvoiceDirectPaymentByBillNo10Response ==== 413 +))) 414 +|**Field**|**Datatype**|**Description** 415 +|##ResponseCode##|String| 416 +|##ResponseMessage##|String| 417 +|##TraceId##|String| 418 + 419 +**Error codes** 420 + 421 +(% class="table-bordered table-striped" %) 422 +|=(% colspan="4" %)((( 423 +==== GetCustomerCurrentStateByCustomerNoResponse ==== 424 +))) 425 +|**Code**|**Name**|**Description** 426 +|##5080##|InvalidBillNo|BillNo is invalid 427 +|##1207##|InvalidAmount|Amount is invalid 428 +|##5074##|InvalidDate|PaymentDate is not within a valid date 429 + 430 +== AddInvoiceCopyOrderByBillNo10 == 431 + 432 +Order a copy of the invoice to be delivered. 433 + 434 +**Class diagram** 435 + 436 +[[image:1573631474317-399.png||height="349" width="795"]] 437 + 438 +**Request parameters** 439 + 440 +(% class="table-bordered table-striped" %) 441 +|=(% colspan="4" %)((( 442 +==== AddInvoiceCopyOrderByBillNo10Request ==== 443 +))) 444 +|**Field**|**Datatype**|**Required**|**Description** 445 +|##BillNo##|String|Yes| 446 +|##DistributionMethod##|String|Yes| 447 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 448 +|TraceId|String|Yes| 449 + 450 +**Response parameters** 451 + 452 +(% class="table-bordered table-striped" %) 453 +|=(% colspan="4" %)((( 454 +==== RegisterInvoiceDirectPaymentByBillNo10Response ==== 455 +))) 456 +|**Field**|**Datatype**|**Description**| | 457 +|##ResponseCode##|String| | | 458 +|##Respons##|String| 459 +|##TraceId##|String| 460 + 461 +**Error codes** 462 + 463 +(% class="table-bordered table-striped" %) 464 +|=(% colspan="4" %)((( 465 +==== GetCustomerCurrentStateByCustomerNoResponse ==== 466 +))) 467 +|**Code**|**Name**|**Description** 468 +|##5089##|BillsNotFound|Found no matching Invoices for BillNo 469 + 470 +== GetClosedInvoiceInformationByCustomerNo20 == 471 + 472 +Get information about a customer's closed invoice(s) by customer number. 473 + 474 +**Class diagram** 475 +[[image:1573632921277-742.png||height="509" width="841"]] 476 + 477 +**Request parameters** 478 + 479 +(% class="table-bordered table-striped" %) 480 +|=(% colspan="4" %)((( 481 +==== GetClosedInvoiceInformationByCustomerNo20Request ==== 482 +))) 483 +|**Field**|**Datatype**|**Required**|**Description** 484 +|##CustomerNo##|String|Yes| 485 +|##TrackingUserEmail##|String|Yes|User info for trackability. 486 +|TraceId| |yes| 487 + 488 +**Response parameters** 489 + 490 +**[[GetClosedInvoiceInformation20Response>>||anchor="HGetClosedInvoiceInformation20Response"]]** 491 + 492 + 493 + 494 +== GetClosedInvoiceInformationByCustomerNo21 == 495 + 496 +Get information about a customer's closed invoice(s) by customer number. 497 + 498 +**Request parameters** 499 + 500 +(% class="table-bordered table-striped" %) 501 +|=(% colspan="4" %)((( 502 +==== GetClosedInvoiceInformationByCustomerNo21Request ==== 503 +))) 504 +|**Field**|**Datatype**|**Required**|**Description** 505 +|##CustomerNo##|String|Yes| 506 +|##TrackingUserEmail##|String|Yes|User info for trackability. 507 +|TraceId| |yes| 508 + 509 +**Response parameters** 510 + 511 +**[[GetClosedInvoiceInformation21Response>>||anchor="HGetClosedInvoiceInformation21Response"]]** 512 + 513 + 514 + 515 +== GetClosedInvoiceInformationByRegNo20 == 516 + 517 +Get information about a customer's closed invoice(s) by social security number. 518 + 519 +**Class diagram** 520 + 521 +[[image:1573646248641-666.png||height="508" width="807"]] 522 + 523 +**Request parameters** 524 + 525 +(% class="table-bordered table-striped" %) 526 +|=(% colspan="4" %)((( 527 +==== GetClosedInvoiceInformationByRegNo20Request ==== 528 +))) 529 +|**Field**|**Datatype**|**Required**|**Description** 530 +|##RegNo##|[[RegNo>>||anchor="HRegNo"]]|Yes|See [[RegNo>>||anchor="HRegNo"]] 531 +|##TrackingUserEmail##|String|Yes|User info for trackability. 532 +|TraceId| |yes| 533 + 534 +**Response parameters** 535 + 536 +**[[GetClosedInvoiceInformation20Response>>||anchor="HGetClosedInvoiceInformation20Response"]]** 537 + 538 +**Error codes** 539 + 540 +(% class="table-bordered table-striped" %) 541 +|=(% colspan="4" %)((( 542 +==== Possible error codes from GetClosedInvoiceInformationByRegNo20 ==== 543 +))) 544 +|**Code**|**Name**|**Description** 545 +|##5006##|ExpectedCustomerNumber|Found multiple customer on RegNo, use CustomerNo instead. 546 +|5075|MissingAccountForBill|Found no matching customer for RegNo. 547 +|1024|ErrorInvalidRegNo|Invalid RegNo format. 548 + 549 +== GetClosedInvoiceInformationByRegNo21 == 550 + 551 +Get information about a customer's closed invoice(s) by social security number. 552 + 553 +**Request parameters** 554 + 555 + 556 +(% class="table-bordered table-striped" %) 557 +|=(% colspan="4" %)((( 558 +==== GetClosedInvoiceInformationByRegNo21Request ==== 559 +))) 560 +|**Field**|**Datatype**|**Required**|**Description** 561 +|##RegNo##|[[RegNo>>||anchor="HRegNo"]]|Yes|See [[RegNo>>||anchor="HRegNo"]] 562 +|##TrackingUserEmail##|String|Yes|User info for trackability. 563 +|TraceId| |yes| 564 + 565 +**Response parameters** 566 + 567 +**[[GetClosedInvoiceInformation21Response>>||anchor="HGetClosedInvoiceInformation21Response"]]** 568 + 569 +**Error codes** 570 + 571 +(% class="table-bordered table-striped" %) 572 +|=(% colspan="4" %)((( 573 +==== Possible error codes from GetClosedInvoiceInformationByRegNo21 ==== 574 +))) 575 +|**Code**|**Name**|**Description** 576 +|##5006##|ExpectedCustomerNumber|Found multiple customer on RegNo, use CustomerNo instead. 577 +|5075|MissingAccountForBill|Found no matching customer for RegNo. 578 +|1024|ErrorInvalidRegNo|Invalid RegNo format. 579 + 580 +== GetInvoiceInformationByBillNo20 == 581 + 582 +**Class diagram** 583 + 584 +[[image:PxR_InvoiceService_GetInvoiceInformationByBillNo20.png||alt="1573648586121-179.png"]] 585 + 586 +**Request parameters** 587 + 588 +(% class="table-bordered table-striped" %) 589 +|=(% colspan="4" %)((( 590 +==== GetInvoiceInformationByBillNo20Request ==== 591 +))) 592 +|**Field**|**Datatype**|**Required**|**Description** 593 +|##BillNo##|String|Yes| 594 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 595 +|TraceId|String|Yes| 596 + 597 +**Response parameters** 598 + 599 +[[GetInvoinceInformation20Response>>||anchor="HGetInvoiceInformation20Response"]] 600 + 601 +**Error codes** 602 + 603 +(% class="table-bordered table-striped" %) 604 +|=(% colspan="4" %)((( 605 +==== Possible error codes from GetInvoinceInformationByBillNo20 ==== 606 +))) 607 +|**Code**|**Name**|**Description** 608 +|##5072##|InvalidExternalBillId|ExternalInvoiceId does not match any valid invoices. 609 +|5089|BillsNotFound|Invoice match but invoice not valid. May be older than 1 year. 610 + 611 +== GetInvoiceInformationByBillNo21 == 612 + 613 +**Request parameters** 614 + 615 +(% class="table-bordered table-striped" %) 616 +|=(% colspan="4" %)((( 617 +==== GetInvoiceInformationByBillNo21Request ==== 618 +))) 619 +|**Field**|**Datatype**|**Required**|**Description** 620 +|##BillNo##|String|Yes| 621 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 622 +|TraceId|String|Yes| 623 + 624 +**Response parameters** 625 + 626 +[[GetInvoiceInformation21Response>>||anchor="HGetInvoiceInformation21Response"]] 627 + 628 + 629 +**Error codes** 630 + 631 +(% class="table-bordered table-striped" %) 632 +|=(% colspan="4" %)((( 633 +==== Possible error codes from GetInvoinceInformationByBillNo21 ==== 634 +))) 635 +|**Code**|**Name**|**Description** 636 +|##5072##|InvalidExternalBillId|ExternalInvoiceId does not match any valid invoices. 637 +|5089|BillsNotFound|Invoice match but invoice not valid. May be older than 1 year. 638 + 639 + 640 + 641 +== GetInvoiceInformationByExternalInvoiceId20 == 642 + 643 +**Class diagram** 644 + 645 +[[image:PxR_InvoiceService_GetOpenInvoiceInformationByExternalInvoiceId20.png||alt="1573822272252-854.png"]] 646 + 647 +**Request parameters** 648 + 649 +(% class="table-bordered table-striped" %) 650 +|=(% colspan="4" %)((( 651 +==== GetInvoiceInformationByExternalInvoiceId20Request ==== 652 +))) 653 +|**Field**|**Datatype**|**Required**|**Description** 654 +|##ExternalInvoiceId##|String|Yes| 655 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 656 +|TraceId|String|Yes| 657 + 658 +**Response parameters** 659 + 660 +[[GetInvoinceInformation20Response>>||anchor="HGetInvoiceInformation20Response"]] 661 + 662 +**Error codes** 663 + 664 +(% class="table-bordered table-striped" %) 665 +|=(% colspan="4" %)((( 666 +==== Possible error codes from GetInvoinceInformationByExternalInvoiceId20 ==== 667 +))) 668 +|**Code**|**Name**|**Description** 669 +|##5072##|InvalidExternalBillId|ExternalInvoiceId does not match any valid invoices. 670 +|5089|BillsNotFound|Invoice match but invoice not valid. May be older than 1 year. 671 + 672 +== GetInvoiceInformationByExternalInvoiceId21 == 673 + 674 + 675 +**Request parameters** 676 + 677 +(% class="table-bordered table-striped" %) 678 +|=(% colspan="4" %)((( 679 +==== GetInvoiceInformationByExternalInvoiceId21Request ==== 680 +))) 681 +|**Field**|**Datatype**|**Required**|**Description** 682 +|##ExternalInvoiceId##|String|Yes| 683 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 684 +|TraceId|String|Yes| 685 + 686 +**Response parameters** 687 + 688 +[[GetInvoinceInformation21Response>>||anchor="HGetInvoiceInformation21Response"]] 689 + 690 +**Error codes** 691 + 692 +(% class="table-bordered table-striped" %) 693 +|=(% colspan="4" %)((( 694 +==== Possible error codes from GetInvoinceInformationByExternalInvoiceId20 ==== 695 +))) 696 +|**Code**|**Name**|**Description** 697 +|##5072##|InvalidExternalBillId|ExternalInvoiceId does not match any valid invoices. 698 +|5089|BillsNotFound|((( 699 +Invoice match but invoice not valid. May be older than 1 year. 700 + 701 + 702 + 703 +))) 704 + 705 +== GetInvoicePdfByBillNoExternalBillType10 == 706 + 707 +**Class diagram** 708 + 709 +[[image:1573822789308-786.png||height="470" width="761"]] 710 + 711 +**Request parameters** 712 + 713 +(% class="table-bordered table-striped" %) 714 +|=(% colspan="4" %)((( 715 +==== GetInvoicePdfByBillNoExternalBillType10Request ==== 716 +))) 717 +|**Field**|**Datatype**|**Required**|**Description** 718 +|##BillNo##|String|Yes| 719 +|ExternalBillType|String|Yes|((( 720 +Document type. 721 +Existing ExternalBillType can be retrived from GetInvoiceInformationByBillNo20 or GetInvoiceInformationByExternalInvoiceId20. 722 +))) 723 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 724 +|TraceId|String|Yes| 725 + 726 +**Response parameters** 727 + 728 +[[GetInvoicePDFResponse>>||anchor="HGetInvoicePDFResponse"]] 729 + 730 +**Error codes** 731 + 732 +(% class="table-bordered table-striped" %) 733 +|=(% colspan="4" %)((( 734 +==== GetInvoincePDFResponse ==== 735 +))) 736 +|**Code**|**Name**|**Description** 737 +|##5046##|InvalidAccountType|Wrong account type. The requested bill number is not an invoice. 738 +|5080|InvalidBillNo|Invoice document not found. 739 +|5095|ExternalBillTypeCode|Invalid ExternalBillType. 740 + 741 +== == 742 + 743 +== GetOpenInvoiceInformationByCustomerNo20 == 744 + 745 +**Class diagram** 746 + 747 +[[image:PxR_InvoiceService_GetOpenInvoiceInformationByCustomerNo20.png||alt="1573825242764-218.png"]] 748 + 749 +**Request parameters** 750 + 751 +(% class="table-bordered table-striped" %) 752 +|=(% colspan="4" %)((( 753 +==== GetOpenInvoiceInformationByCustomerNo20Request ==== 754 +))) 755 +|**Field**|**Datatype**|**Required**|**Description** 756 +|CustomerNo|String|Yes| 757 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 758 +|TraceId|String|Yes| 759 + 760 +**Response parameters** 761 + 762 +[[GetOpenInvoiceInformation20Response>>||anchor="HGetOpenInvoiceInformation20Response"]] 763 + 764 + 765 + 766 +== GetOpenInvoiceInformationByCustomerNo21 == 767 + 768 + 769 +**Request parameters** 770 + 771 +(% class="table-bordered table-striped" %) 772 +|=(% colspan="4" %)((( 773 +==== GetOpenInvoiceInformationByCustomerNo21Request ==== 774 +))) 775 +|**Field**|**Datatype**|**Required**|**Description** 776 +|CustomerNo|String|Yes| 777 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 778 +|TraceId|String|Yes| 779 + 780 +**Response parameters** 781 + 782 +[[GetOpenInvoiceInformation21Response>>||anchor="HGetOpenInvoiceInformation21Response"]] 783 + 784 +== == 785 + 786 +== == 787 + 788 +== GetOpenInvoiceInformationByRegNo20 == 789 + 790 +**Class diagram** 791 + 792 +[[image:PxR_InvoiceService_GetOpenInvoiceInformationByRegNo20.png||alt="1573825242764-218.png"]] 793 + 794 +**Request parameters** 795 + 796 +(% class="table-bordered table-striped" %) 797 +|=(% colspan="4" %)((( 798 +==== GetOpenInvoiceInformationByRegNo20Request ==== 799 +))) 800 +|**Field**|**Datatype**|**Required**|**Description** 801 +|RegNo|RegNo|Yes| 802 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 803 +|TraceId|String|Yes| 804 + 805 +**Response parameters** 806 + 807 +[[GetOpenInvoiceInformation20Response>>||anchor="HGetOpenInvoiceInformation20Response"]] 808 + 809 + 810 + 811 +== GetOpenInvoiceInformationByRegNo21 == 812 + 813 + 814 +**Request parameters** 815 + 816 +(% class="table-bordered table-striped" %) 817 +|=(% colspan="4" %)((( 818 +==== GetOpenInvoiceInformationByRegNo21Request ==== 819 +))) 820 +|**Field**|**Datatype**|**Required**|**Description** 821 +|RegNo|RegNo|Yes| 822 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 823 +|TraceId|String|Yes| 824 + 825 +**Response parameters** 826 + 827 +[[GetOpenInvoiceInformation21Response>>||anchor="HGetOpenInvoiceInformation21Response"]] 828 + 829 +== RegisterInvoicePSPPaymentByBillNo10 == 830 + 831 +**Class diagram** 832 + 833 +[[image:1573825460421-413.png||height="460" width="778"]] 834 + 835 +**Request parameters** 836 + 837 +(% class="table-bordered table-striped" %) 838 +|=(% colspan="4" %)((( 839 +==== RegisterInvoicePSPPaymentByBillNoRequest ==== 840 +))) 841 +|**Field**|**Datatype**|**Required**|**Description** 842 +|##BillNo##|String|Yes| 843 +|Amount|Decimal|Yes| 844 +|PaymentDate|DateTime|Yes| 845 +|SellerTransactionId|String|Yes| 846 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability. 847 +|TraceId|String|Yes| 848 + 849 +**Response parameters** 850 + 851 +(% class="table-bordered table-striped" %) 852 +|=(% colspan="4" %)((( 853 +==== RegisterInvoicePSPPaymentByBillNoResponse ==== 854 +))) 855 +|**Field**|**Datatype**|**Description** 856 +|##ResponseCode##|String| 857 +|##ResponseMessage##|String| 858 +|TraceId|String| 859 + 860 += = 861 + 862 +== GetOrderlinesByBillNo10 == 863 + 864 +(% class="wikigeneratedid" %) 865 +Get all orderlines on a bill 866 + 867 + 868 +**Request parameters** 869 + 870 +(% class="table-bordered table-striped" %) 871 +|=(% colspan="4" %)((( 872 +==== GetOrderlinesByBillNo10Request ==== 873 +))) 874 +|**Field**|**Datatype**|**Required**|**Description** 875 +|##BillNo##|String|Yes| 876 +|##TrackingUserEMail##|String|No|User info for trackability. 877 +|TraceId|String|Yes| 878 + 879 +**Response parameters** 880 + 881 +(% class="table-bordered table-striped" %) 882 +|=(% colspan="3" %)((( 883 +==== GetOrderlinesByBillNo10Response ==== 884 +))) 885 +|**Field**|**Datatype**|**Description** 886 +|(% style="font-family:monospace" %)##OrderLines##|List<[[OrderLine>>doc:||anchor="HOrderLine"]]>|Array. 887 +|##ResponseCode##|String| 888 +|##ResponseMessage##|String| 889 +|##TraceId##|String| 890 + 891 +**Classes** 892 + 893 +(% class="table-bordered table-striped" %) 894 +|=(% colspan="3" %)((( 895 +==== Orderline ==== 896 +))) 897 +|**Field**|**Datatype**|**Description** 898 +|(% style="font-family:monospace" %)##TransactionDate##|Date|Date of the transaction 899 +|(% style="font-family:monospace" %)ExternalReferenceId|String|The external reference id of the transaction 900 +|(% style="font-family:monospace" %)Amount|Decimal|Amount of the orderline 901 +|(% style="font-family:monospace" %)Description|String|Description of the orderline 902 + 903 +**Error codes** 904 + 905 +(% class="table-bordered table-striped" %) 906 +|=(% colspan="4" %)((( 907 +==== GetOrderlinesByBillNo10Response ==== 908 +))) 909 +|**Code**|**Name**|**Description** 910 +| | | 911 + 912 += 913 +\\CustomerService methods = 914 + 915 +The complete Wsdl specification for this service can be found at: 916 +[[https:~~/~~/connect.internaltest.payex.com/PxR/CustomerService.svc>>url:https://connect.internaltest.payex.com/PxR/CustomerService.svc]] 917 + 918 + (Username/password security model) 919 + 920 +== GetcustomerCurrentStateByCustomerNo == 921 + 922 +Get information about current state of a customer. 923 + 924 +**Class diagram** 925 + 926 +[[image:7-class-diagram-external.png]] 927 + 928 +**Request parameters** 929 + 930 +(% class="table-bordered table-striped" %) 931 +|=(% colspan="4" %)((( 932 +==== GetCustomerCurrentStateByCustomerNoRequest ==== 933 +))) 934 +|**Field**|**Datatype**|**Required**|**Description** 935 +|##CustomerNumber##|String(15)|Yes| 936 +|##TrackingUserEMail##|String|No| 937 + 938 +**Response parameters** 939 + 940 +(% class="table-bordered table-striped" %) 941 +|=(% colspan="3" %)((( 942 +==== GetCustomerCurrentStateByCustomerNoResponse ==== 943 +))) 944 +|**Field**|**Datatype**|**Description** 945 +|(% style="font-family:monospace" %)##CustomerConsents##|[[CustomerConsent>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerConsent"]]|Array. 946 +|##CustomerInfo##|[[CustomerInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerInfo"]]| 947 +|##CustomerNo##|String| 948 +|##CustomerStatus##|[[CustomerStatus>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerStatus"]]|Array. 949 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]| 950 + 951 +**Classes** 952 + 953 +(% class="table-bordered table-striped" %) 954 +|=(% colspan="3" %)((( 955 +==== CustomerConsent ==== 956 +))) 957 +|**Field**|**Datatype**|**Description** 958 +|(% 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. 959 + 960 +(% class="table-bordered table-striped" %) 961 +|=(% colspan="3" %)((( 962 +==== CustomerInfo ==== 963 +))) 964 +|**Field**|**Datatype**|**Description** 965 +|(% style="font-family:monospace" %)##Name##|String| 966 +|##DistributionAddressInfo##|[[DistributionAddressInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HDistributionAddressInfo"]]| 967 +|##Language##|String| 968 +|##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. 969 +|##VatNo##|String| 970 +|##Category##| | 971 + 972 +(% class="table-bordered table-striped" %) 973 +|=(% colspan="3" %)((( 974 +==== CustomerStatus ==== 975 +))) 976 +|**Field**|**Datatype**|**Description** 977 +|(% style="font-family:monospace" %)##CustomerStatusTypeCode##|Int|[[See code specification.>>||anchor="HCustomerStatustypecodes"]] 978 + 979 +(% class="table-bordered table-striped" %) 980 +|=(% colspan="4" %)((( 981 +==== DistributionAddressInfo ==== 982 +))) 983 +|**Field**|**Datatype**|**Required**|**Description** 984 +|(% style="font-family:monospace" %)##Addresses##|Array|Yes|See [[address>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HAddress"]]. 985 +|##EMailAddress##|String|No| 986 +|##Cellphone##|String|No| 987 + 988 +(% class="table-bordered table-striped" %) 989 +|=(% colspan="4" %)((( 990 +==== Address ==== 991 +))) 992 +|**Field**|**Datatype**|**Required**|**Description** 993 +|(% style="font-family:monospace" %)Addressee|String(72)|Yes| 994 +|##StreetAdress##|String(35)|No| 995 +|##ZipCode##|String(9)|Yes| 996 +|##City##|String(27)|Yes| 997 +|##CoAddress##|String(35)|No| 998 +|##CountryCode##|String(2)|Yes| 999 + 1000 +== GetCustomerCurrentStateByRegNo10 == 1001 + 1002 +**Class diagram** 1003 + 1004 +[[image:1574422177227-663.png||height="671" width="1146"]] 1005 + 1006 +**Request parameters** 1007 + 1008 +(% class="table-bordered table-striped" %) 1009 +|=(% colspan="4" %)((( 1010 +==== GetCustomerCurrentStateByRegNo10Request ==== 1011 +))) 1012 +|**Field**|**Datatype**|**Required**|**Description** 1013 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|Yes| 1014 +|##TrackingUserEMail##|String|Yes| 1015 +|TraceId|String|Yes| 1016 + 1017 +**Response parameters** 1018 + 1019 +(% class="table-bordered table-striped" %) 1020 +|=(% colspan="3" %)((( 1021 +==== GetCustomerCurrentStateByRegNo10Response ==== 1022 +))) 1023 +|**Field**|**Datatype**|**Description** 1024 +|(% style="font-family:monospace" %)##CustomerConsents##|[[CustomerConsent>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerConsent"]]|Array. 1025 +|##CustomerInfo##|[[CustomerInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerInfo"]]| 1026 +|##CustomerNo##|String| 1027 +|##CustomerStatus##|[[CustomerStatus>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerStatus"]]|Array. 1028 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]| 1029 + 1030 +(% id="HAppendix1SharedClasses" %) 1031 += Appendix 1 Shared Classes = 1032 + 1033 + 1034 +**Response parameters** 1035 + 1036 +(% class="table-bordered table-striped" %) 1037 +|=(% colspan="3" %)((( 1038 +==== GetInvoicePDFResponse ==== 1039 +))) 1040 +|**Field**|**Datatype**|**Description** 1041 +|##Pdf##|Byte[]| 1042 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]| 1043 +|##CustomerNo##|String| 1044 +|##ResponseCode##|String| 1045 +|##ResponseMessage##|String| 1046 +|##TraceId##|String| 1047 + 1048 +(% class="table-bordered table-striped" style="width:1496px" %) 1049 +|=(% colspan="3" style="width: 1493px;" %)((( 1050 +==== GetInvoiceInformationResponse ==== 1051 +))) 1052 +|**Field**|**Datatype**|(% style="width:467px" %)**Description** 1053 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|(% style="width:467px" %) 1054 +|##CustomerNo##|String|(% style="width:467px" %) 1055 +|##Invoice##|[[Invoice>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoice"]]|(% style="width:467px" %) 1056 +|##ResponseCode##|String|(% style="width:467px" %) 1057 +|##ResponseMessage##|String|(% style="width:467px" %) 1058 +|##TraceId##|String|(% style="width:467px" %) 1059 + 1060 +(% class="table-bordered table-striped" %) 1061 +|=(% colspan="3" %)((( 1062 +==== Invoice ==== 1063 +))) 1064 +|**Field**|**Datatype**|**Description** 1065 +|##PaymentReference##|String| 1066 +|##BillNo##|String| 1067 +|##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. 1068 +|##ExternalInvoiceId##|String| 1069 +|##ExternalReference##|String| 1070 +|##SellerNo##|String| 1071 +|##BillDate##|DateTime| 1072 +|##DueDate##|DateTime (Optional)| 1073 +|##OriginalAmount##|Decimal| 1074 +|##Interest##|[[Interest>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInterest"]]| 1075 +|##CurrentBalanceList##|List <[[Balance>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBalance"]]>| 1076 +|##CurrencyCode##|String| 1077 +|##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. 1078 +|##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. 1079 +|##PaymentBankAccount##|[[PaymentBankAccount>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HPaymentBankAccount"]]| 1080 +|##PaymentType##|String| 1081 +|##ActiveRespite##|[[ActiveRespite>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActiveRespite"]]| 1082 +|##ActivePaymentOrder##|[[ActivePaymentOrder>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActivePaymentOrder"]]| 1083 +|##BillId##|Long| 1084 +|##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. 1085 +|##InvoiceHistory##|List <[[InvoiceHistory>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoiceHistory"]]>| 1086 + 1087 +(% class="table-bordered table-striped" %) 1088 +|=(% colspan="3" %)((( 1089 +==== PaymentBankAccount20 inherit [[PaymentBankAccount>>||anchor="HPaymentBankAccount"]] ==== 1090 +))) 1091 +|**Field**|**Datatype**|**Description** 1092 +|##PaymentTypeName##|String| 1093 + 1094 +(% class="table-bordered table-striped" %) 1095 +|=(% colspan="3" %)((( 1096 +==== PaymentBankAccount ==== 1097 +))) 1098 +|**Field**|**Datatype**|**Description** 1099 +|##BankAccountNo##|String| 1100 +|##BankAccountType##|String| 1101 +|##BIC##|String| 1102 +|##IBAN##|String| 1103 + 1104 +(% class="table-bordered table-striped" %) 1105 +|=(% colspan="3" %)((( 1106 +==== ActiveRespite ==== 1107 +))) 1108 +|**Field**|**Datatype**|**Description** 1109 +|##RespiteValidToDate##|DateTime| 1110 +|##RespiteTypeCode##|int| 1111 + 1112 +(% class="table-bordered table-striped" %) 1113 +|=(% colspan="3" %)((( 1114 +==== InvoiceHistory ==== 1115 +))) 1116 +|**Field**|**Datatype**|**Description** 1117 +|BillDate|DateTime| 1118 +|BillId|long| 1119 +|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. 1120 + 1121 +(% class="table-bordered table-striped" %) 1122 +|=(% colspan="3" %)((( 1123 +==== GetClosedInvoiceInformation21Response ==== 1124 +))) 1125 +|**Field**|**Datatype**|**Description** 1126 +|CompanyNo|String| 1127 +|CustomerNo|string| 1128 +|CustomerName|String| 1129 +|InvoiceList|List<[[ClosedInvoice21>>||anchor="HClosedInvoice21"]]>|See [[ClosedInvoice21>>||anchor="HClosedInvoice21"]] 1130 + 1131 +(% class="table-bordered table-striped" %) 1132 +|=(% colspan="3" %)((( 1133 +==== GetOpenInvoiceInformation21Response ==== 1134 +))) 1135 +|**Field**|**Datatype**|**Description** 1136 +|CompanyNo|String| 1137 +|CustomerNo|string| 1138 +|CustomerName|String| 1139 +|InvoiceList|List<[[OpenInvoice21>>doc:||anchor="HInvoiceInformation21inheritOpenInvoice21"]]>| 1140 + 1141 +(% class="table-bordered table-striped" %) 1142 +|=(% colspan="3" %)((( 1143 +==== GetInvoiceInformation21Response ==== 1144 +))) 1145 +|**Field**|**Datatype**|**Description** 1146 +|CompanyNo|String| 1147 +|RegNo|[[RegNo>>doc:||anchor="HRegNo"]]| 1148 +|CustomerNo|string| 1149 +|CustomerName|String| 1150 +|InvoiceList|List<[[InvoiceInformation21>>doc:||anchor="HInvoiceInformation21inheritOpenInvoice21"]]>| 1151 + 1152 +(% class="table-bordered table-striped" %) 1153 +|=(% colspan="3" %)((( 1154 +==== ClosedInvoice21 ==== 1155 +))) 1156 +|**Field**|**Datatype**|**Description** 1157 +|CurrencyCode|String| 1158 +|BillNo|string| 1159 +|BillStatusCode|Int| 1160 +|ExternalInvoiceId|String| 1161 +|BillDate|DateTime| 1162 +|DueDate|DateTime?| 1163 +|ExternalBillType|String| 1164 +|OriginalAmount|Decimal| 1165 +|SellerName|String| 1166 +|SellerNo|String| 1167 +|InvoiceProfileType|String|The invoice profile type code 1168 +|InvoiceAlias|String|User friendly name of the invoice profile type 1169 + 1170 +(% class="table-bordered table-striped" %) 1171 +|=(% colspan="4" %)((( 1172 +==== OpenInvoice21 inherit [[ClosedInvoice21>>||anchor="HClosedInvoice21"]] ==== 1173 +))) 1174 +|**Field**|**Datatype**| |**Description** 1175 +|CurrentDebt|Decimal| | 1176 +|PaymentBankAccount|[[PaymentBankAccount20>>doc:||anchor="HPaymentBankAccount20inheritPaymentBankAccount"]]| | 1177 +|PaymentType|String| | 1178 +|ActiveRespite|[[ActiveRespite20>>||anchor="HActiveRespite20"]]| | 1179 +|ActivePaymentOrder|[[ActivePaymentOrder>>||anchor="HActivePaymentOrder"]]| | 1180 +|PaymentReference|String| | 1181 +|ExportedToCollection|Bool| | 1182 +|{{{ExportedToCollectionDate}}}|DateTime?| |((( 1183 + 1184 +))) 1185 + 1186 + 1187 + 1188 +(% class="table-bordered table-striped" %) 1189 +|=(% colspan="3" %)((( 1190 +==== InvoiceInformation21 inherit [[OpenInvoice21>>doc:||anchor="HOpenInvoice21inheritClosedInvoice21"]] ==== 1191 +))) 1192 +|**Field**|**Datatype**|**Description** 1193 +|PenaltyIntest|[[Intrest>>||anchor="HIntrest"]]| 1194 +|CurrentBalance|List<[[Balance>>||anchor="HBalance"]]>| 1195 +|InvoiceHistory|List<[[InvoiceHistory20>>||anchor="HInvoiceHistory20"]]>| 1196 + 1197 +(% class="table-bordered table-striped" %) 1198 +|=(% colspan="3" %)((( 1199 +==== GetClosedInvoiceInformation20Response ==== 1200 +))) 1201 +|**Field**|**Datatype**|**Description** 1202 +|CompanyNo|String| 1203 +|CustomerNo|string| 1204 +|CustomerName|String| 1205 +|InvoiceList|List<[[ClosedInvoice20>>||anchor="HClosedInvoice20"]]>|See [[ClosedInvoice20>>||anchor="HClosedInvoice20"]] 1206 + 1207 +(% class="table-bordered table-striped" %) 1208 +|=(% colspan="3" %)((( 1209 +==== ClosedInvoice20 ==== 1210 +))) 1211 +|**Field**|**Datatype**|**Description** 1212 +|CurrencyCode|String| 1213 +|BillNo|string| 1214 +|BillStatusCode|Int| 1215 +|ExternalInvoiceId|String| 1216 +|BillDate|DateTime| 1217 +|DueDate|DateTime?| 1218 +|ExternalBillType|String| 1219 +|OriginalAmount|Decimal| 1220 +|SellerName|String| 1221 +|SellerNo|String| 1222 + 1223 +(% class="table-bordered table-striped" %) 1224 +|=(% colspan="3" %)((( 1225 +==== GetOpenInvoiceInformation20Response ==== 1226 +))) 1227 +|**Field**|**Datatype**|**Description** 1228 +|CompanyNo|String| 1229 +|CustomerNo|string| 1230 +|CustomerName|String| 1231 +|InvoiceList|List<[[OpenInvoice20>>doc:||anchor="HInvoiceInformation20inheritOpenInvoice20"]]>| 1232 + 1233 +(% class="table-bordered table-striped" %) 1234 +|=(% colspan="3" %)((( 1235 +==== InvoiceInformation20 inherit [[OpenInvoice20>>||anchor="HOpenInvoice20inheritClosedInvoice20"]] ==== 1236 +))) 1237 +|**Field**|**Datatype**|**Description** 1238 +|PenaltyIntest|[[Intrest>>||anchor="HIntrest"]]| 1239 +|CurrentBalance|List<[[Balance>>||anchor="HBalance"]]>| 1240 +|InvoiceHistory|List<[[InvoiceHistory20>>||anchor="HInvoiceHistory20"]]>| 1241 + 1242 +(% class="table-bordered table-striped" %) 1243 +|=(% colspan="3" %)((( 1244 +==== InvoiceHistory20 ==== 1245 +))) 1246 +|**Field**|**Datatype**|**Description** 1247 +|BillDate|DateTime| 1248 +|ExternalBillType|String| 1249 +|BillAmount|Decimal?| 1250 + 1251 +(% class="table-bordered table-striped" %) 1252 +|=(% colspan="4" %)((( 1253 +==== OpenInvoice20 inherit [[ClosedInvoice20>>||anchor="HClosedInvoice20"]] ==== 1254 +))) 1255 +|**Field**|**Datatype**| |**Description** 1256 +|CurrentDebt|Decimal| | 1257 +|PaymentBankAccount| | | 1258 +|PaymentType| | | 1259 +|ActiveRespite|[[ActiveRespite20>>||anchor="HActiveRespite20"]]| | 1260 +|ActivePaymentOrder|[[ActivePaymentOrder>>||anchor="HActivePaymentOrder"]]| | 1261 +|PaymentReference|String| | 1262 +|ExportedToCollection|Bool| | 1263 +|{{{ExportedToCollectionDate}}}|DateTime?| |((( 1264 +*Released 2020-04-14 1265 +))) 1266 + 1267 +{{display reference="developer:Main.PxConnectGeneralAppendix.WebHome"/}}
- 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
- 1573822272252-854.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1573822789308-786.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1573825242764-218.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1573825460421-413.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1574422177227-663.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1574423356546-688.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1574426401088-684.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1574426572366-122.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1574427881741-366.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1574428685798-189.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.bpi - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- 1574431509616-621.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
- GetOpenInvoiceInformationByCustomerNo20.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.rae - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- PxR_InvoiceService_AddPaymentOrderOnDueDateRequest.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.avp - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- PxR_InvoiceService_DeletePaymentOrder.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.avp - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- PxR_InvoiceService_GetInvoiceInformationByBillNo20.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.rae - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- PxR_InvoiceService_GetOpenInvoiceInformationByCustomerNo20.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.rae - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- PxR_InvoiceService_GetOpenInvoiceInformationByExternalInvoiceId20.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.rae - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content
- PxR_InvoiceService_GetOpenInvoiceInformationByRegNo20.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.rae - Size
-
... ... @@ -1,0 +1,1 @@ 1 +0 bytes - Content