Wiki source code of ExternalServicesmanual

Last modified by Fredrik Nilsson on 2021/06/29 16:53
Show last authors
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
78 [[image:PxR_InvoiceService_GetInvoiceInformationByBillNo.png]]
79
80 **Request parameters**
81
82 (% class="table-bordered table-striped" %)
83 |=(% colspan="4" %)(((
84 ==== GetInvoiceInformationByBillNoRequest ====
85 )))
86 |**Field**|**Datatype**|**Required**|**Description**
87 |##BillNo##|String(15)|Yes|
88 |##TrackingUserEmail##|String(50)|Yes|User info for trackability.
89 |##TraceId##|String|Yes|
90
91 (% class="wikigeneratedid" %)
92 **Response parameters**
93
94 (% class="wikigeneratedid" %)
95 [[GetInvoiceInformationResponse>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoiceInformationResponse"]]
96
97 == GetInvoiceInformationByExternalInvoiceId ==
98
99 Gets information about a specific invoice
100
101 **Class diagram**
102
103
104 [[image:PxR_InvoiceService_GetInvoiceInformationByExternalInvoiceId.png]]
105
106 **Request parameters**
107
108 (% class="table-bordered table-striped" %)
109 |=(% colspan="4" %)(((
110 ==== GetInvoiceByExternalInvoiceIdRequest ====
111 )))
112 |**Field**|**Datatype**|**Required**|**Description**
113 |ExternalInvoiceId|String (15)|Yes|
114 |TrackingUserEmail|String (50)|Yes|User info for trackability.
115 |TraceId|String|Yes|
116
117 (% class="wikigeneratedid" %)
118 **Response parameters**
119
120 (% class="wikigeneratedid" %)
121 [[GetInvoiceInformationResponse>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoiceInformationResponse"]]
122
123 == GetOpenInvoiceInformationByCustomerNo ==
124
125 Gets open invoices
126
127 **Class diagram**
128
129 **[[image:5-class-diagram-external.png]]**
130
131 **Request parameters**
132
133 (% class="table-bordered table-striped" %)
134 |=(% colspan="4" %)(((
135 ==== GetOpenInvoiceInformationByCustomerNoRequest ====
136 )))
137 |**Field**|**Datatype**|**Required**|**Description**
138 |##CustomerNo##|String(15)|Yes|##CustomerNo ##is your unique identifier of the customer.
139 |##TrackingUserEMail##|String|No|User info for trackability.
140 |##TraceId##|String|Yes|
141
142 **Response parameters**
143
144 (% class="table-bordered table-striped" %)
145 |=(% colspan="3" %)(((
146 ==== GetOpenInvoiceInformationByCustomerNoResponse ====
147 )))
148 |**Field**|**Datatype**|**Description**
149 |##CompanyNo##|String|
150 |##CustomerNo##|String|##CustomerNo ##is you Unique identifier of the customer.
151 |##CustomerName##|String|
152 |##InvoiceList##|List <[[OpenInvoice>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HOpenInvoice"]]>|
153 |##ResponseCode##|String|
154 |##ResponseMessage##|String|
155 |##TraceId##|String|
156
157 **Classes**
158
159 (% class="table-bordered table-striped" %)
160 |=(% colspan="3" %)(((
161 ==== OpenInvoice ====
162 )))
163 |**Field**|**Datatype**|**Description**
164 |(% style="font-family:monospace" %)BillNo|String|
165 |##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.
166 |##ExternalInvoiceId##|String|Additional unique invoice identifier.
167 |##BillDate##|DateTime|
168 |##DueDate##|DateTime(Optional)|Empty if BillTypeCode is ##Invoice.##
169 |##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.
170 |##OriginalAmount##|Decimal|
171 |##CurrentDebt##|Decimal|
172 |##CurrencyCode##|String|
173 |##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.
174 |##PaymentBankAccount##|[[PaymentBankAccount>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HPaymentBankAccount"]]|
175 |##PaymentType##|String|
176 |##ActiveRespite##|[[ActiveRespite>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActiveRespite"]]|
177 |##ActivePaymentOrder##|[[ActivePaymentOrder>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActivePaymentOrder"]]|
178
179 == GetClosedInvoiceInformationByCustomerNo ==
180
181 Gets closed invoices (status “Closed” only)
182
183 **Class diagram**
184
185 **[[image:6-class-diagram-external.png]]**
186
187 **Request parameters**
188
189 (% class="table-bordered table-striped" %)
190 |=(% colspan="4" %)(((
191 ==== GetClosedInvoiceInformationByCustomerNoRequest ====
192 )))
193 |**Field**|**Datatype**|**Required**|**Description**
194 |##CustomerNo##|String(15)|Yes|CustomerNo is your unique identifier for the customer.
195 |##TrackingUserEMail##|String|No|User info for trackability.
196 |##TraceId##|String|Yes|
197
198 **Response parameters**
199
200 (% class="table-bordered table-striped" %)
201 |=(% colspan="3" %)(((
202 ==== GetClosedInvoiceInformationByCustomerNoResponse ====
203 )))
204 |**Field**|**Datatype**|**Description**
205 |##CompanyNo##|String|Yoyr accounts receivable number at PayEx.
206 |##CustomerNo##|String|##CustomerNo ##is you Unique identifier of the customer.
207 |##CustomerName##|String|
208 |##InvoiceList##|List <[[ClosedInvoice>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HClosedInvoice"]]>|
209 |##ResponseCode##|String|
210 |##ResponseMessage##|String|
211 |##TraceId##|String|
212
213 **Classes**
214
215 (% class="table-bordered table-striped" %)
216 |=(% colspan="3" %)(((
217 ==== ClosedInvoice ====
218 )))
219 |**Field**|**Datatype**|**Description**
220 |(% style="font-family:monospace" %)BillNo|String|
221 |##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.
222 |##ExternalInvoiceId##|String|Additional unique invoice identifier in accounts receivable.
223 |##BillDate##|DateTime|
224 |##DueDate##|DateTime(Optional)|Empty if BillTypeCode is ##Invoice.##
225 |##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.
226 |##OriginalAmount##|Decimal|
227 |##CurrencyCode##|String|
228
229 == AddInvoiceRespiteByBillNo10 ==
230
231 Add respite date to an open invoice.
232
233 **Class diagram**
234 [[image:1573563792142-225.png||height="318" width="920"]]
235 **Request parameters**
236
237 (% class="table-bordered table-striped" %)
238 |=(% colspan="4" %)(((
239 ==== AddInvoiceRespiteByBillNo10Request ====
240 )))
241 |**Field**|**Datatype**|**Required**|**Description**
242 |##BillNo##|String(15)|Yes|Bill Number.
243 |##RespiteCause##|String(250)|Yes|Reason for respite.
244 |##TrackingUserEMail##|String(1-256)|Yes|User info for trackability.
245 |##TraceId##|String|Yes|
246 |##ValidToDate##|DateTime|Yes|
247
248 **Response parameters**
249
250 (% class="table-bordered table-striped" %)
251 |=(% colspan="4" %)(((
252 ==== AddInvoiceRespiteByBillNo10Response ====
253 )))
254 |**Field**|**Datatype**|**Description**
255 |##ResponseCode##|String|
256 |##ResponseMessage##|String|
257 |##TraceId##|String|
258
259 **Error codes**
260
261 (% class="table-bordered table-striped" %)
262 |=(% colspan="4" %)(((
263 ==== GetCustomerCurrentStateByCustomerNoResponse ====
264 )))
265 |**Code**|**Name**|**Description**
266 |##5074##|InvalidDate|ValidToDate is not within a valid date.
267 |##5046##|InvalidAccountType|Bill of BillNo is not of a valid AccountType.
268 |##1208##|InvalidAccountStatus|Respite not a valid action on this bill.
269
270 == AddPaymentOrderOnDueDate ==
271
272 Add paymentorder to an open invoice.
273
274 **Class diagram**
275 [[image:PxR_InvoiceService_AddPaymentOrderOnDueDateRequest.png]]
276 **Request parameters**
277
278 (% class="table-bordered table-striped" %)
279 |=(% colspan="4" %)(((
280 ==== AddPaymentOrderOnDueDate ====
281 )))
282 |**Field**|**Datatype**|**Required**|**Description**
283 |##BillNo##|String(15)|Yes|Bill Number.
284 |CompanyNo|String(15)|Yes|Company number
285 |##TrackingUserEMail##|String(1-256)|Yes|User info for trackability.
286 |##TraceId##|String|Yes|
287
288 **Response parameters**
289
290 (% class="table-bordered table-striped" %)
291 |=(% colspan="4" %)(((
292 ==== AddPaymentOrderOnDueDate ====
293 )))
294 |**Field**|**Datatype**|**Description**
295 |##ResponseCode##|String|
296 |##ResponseMessage##|String|
297 |##TraceId##|String|
298
299 **Error codes**
300
301 (% class="table-bordered table-striped" %)
302 |=(% colspan="4" %)(((
303 ==== GetCustomerCurrentStateByCustomerNoResponse ====
304 )))
305 |**Code**|**Name**|**Description**
306 |##5080##|InvalidBillNo|No bill found with billNo and companyNo
307 |##5117##|AddPaymentOrderException|(((
308 Customer ain't available for PaymentOrder or already have one on this bill
309 )))
310 |##5002##|InvalidOpenBill|BillStatus ain't Open
311 |##5074##|InvalidDate|Possible DistributionDate for PaymentOrder has already surpassed today's date
312 |##5120##|ClaimProcessPauseException|Bill has a ClaimProcessPause
313
314 == ==
315
316 == ConvertInvoiceToAccount10 ==
317
318 Convert an invoice account to a credit account.
319
320 **Class diagram**
321
322 [[image:1573569373687-299.png||height="324" width="739"]]
323
324 **Request parameters**
325
326 (% class="table-bordered table-striped" %)
327 |=(% colspan="4" %)(((
328 ==== ConvertInvoiceToAccount10Request ====
329 )))
330 |**Field**|**Datatype**|**Required**|**Description**
331 |##BillNo##|String(15)|Yes|Bill Number.
332 |##TrackingUserEMail##|String(1-256)|Yes|User info for trackability.
333 |##TraceId##|String|Yes|
334
335 **Response parameters**
336
337 (% class="table-bordered table-striped" %)
338 |=(% colspan="4" %)(((
339 ==== ConvertInvoiceToAccount10Response ====
340 )))
341 |**Field**|**Datatype**|**Description**
342 |##ResponseCode##|String|
343 |##ResponseMessage##|String|
344 |##TraceId##|String|
345
346 == DeletePaymentOrder ==
347
348 Abort a PaymentOrder for billNo
349
350 **Class diagram**
351
352 [[image:PxR_InvoiceService_DeletePaymentOrder.png||height="174" width="1267"]]
353
354
355 **Request parameters**
356
357 (% class="table-bordered table-striped" %)
358 |=(% colspan="4" %)(((
359 ==== DeletePaymentOrderRequest ====
360 )))
361 |**Field**|**Datatype**|**Required**|**Description**
362 |##BillNo##|String|Yes|Bill to match paymentorder.
363 |CompanyNo|String |Yes|Company number
364 |TrackingUserEMail|String(1-256)|Yes|User info for trackability.
365 |TraceId|String|Yes|
366
367 **Response parameters**
368
369 (% class="table-bordered table-striped" %)
370 |=(% colspan="4" %)(((
371 ==== DeletePaymentOrderResponse ====
372 )))
373 |**Field**|**Datatype**|**Description**
374 |##ResponseCode##|String|
375 |##ResponseMessage##|String|
376 |##TraceId##|String|
377
378 **Error codes**
379
380 (% class="table-bordered table-striped" %)
381 |=(% colspan="4" %)(((
382 ==== DeletePaymentOrderResponse ====
383 )))
384 |**Code**|**Name**|**Description**
385 |##5080##|InvalidBillNo|BillNo is invalid
386 |##5115##|PaymentOrderNotFound|Found no paymentorders connected to bill
387 |##5116##|DeletePaymentOrderNotAllowed|Found paymentOrder but are not allowed to Delete since the paymentorder has begun/finished processing
388
389 == RegisterInvoiceDirectPaymentByBillNo10 ==
390
391 Register a direct payment on given invoice.
392
393 **Class diagram**
394
395 [[image:1573570140844-820.png||height="384" width="715"]]
396
397 **Request parameters**
398
399 (% class="table-bordered table-striped" %)
400 |=(% colspan="4" %)(((
401 ==== RegisterInvoiceDirectPaymentByBillNo10Request ====
402 )))
403 |**Field**|**Datatype**|**Required**|**Description**
404 |##Amount##|Decimal|Yes|DirectPayment Amount.
405 |##BillNo##|String|Yes|Bill to match payment to.
406 |##PaymentDate##|DateTime|Yes|Date when payment occured.
407 |TrackingUserEMail|String(1-256)|Yes|User info for trackability.
408 |TraceId|String|Yes|
409
410 **Response parameters**
411
412 (% class="table-bordered table-striped" %)
413 |=(% colspan="4" %)(((
414 ==== RegisterInvoiceDirectPaymentByBillNo10Response ====
415 )))
416 |**Field**|**Datatype**|**Description**
417 |##ResponseCode##|String|
418 |##ResponseMessage##|String|
419 |##TraceId##|String|
420
421 **Error codes**
422
423 (% class="table-bordered table-striped" %)
424 |=(% colspan="4" %)(((
425 ==== GetCustomerCurrentStateByCustomerNoResponse ====
426 )))
427 |**Code**|**Name**|**Description**
428 |##5080##|InvalidBillNo|BillNo is invalid
429 |##1207##|InvalidAmount|Amount is invalid
430 |##5074##|InvalidDate|PaymentDate is not within a valid date
431
432 == AddInvoiceCopyOrderByBillNo10 ==
433
434 Order a copy of the invoice to be delivered.
435
436 **Class diagram**
437
438 [[image:1573631474317-399.png||height="349" width="795"]]
439
440 **Request parameters**
441
442 (% class="table-bordered table-striped" %)
443 |=(% colspan="4" %)(((
444 ==== AddInvoiceCopyOrderByBillNo10Request ====
445 )))
446 |**Field**|**Datatype**|**Required**|**Description**
447 |##BillNo##|String|Yes|
448 |##DistributionMethod##|String|Yes|
449 |TrackingUserEMail|String(1-256)|Yes|User info for trackability.
450 |TraceId|String|Yes|
451
452 **Response parameters**
453
454 (% class="table-bordered table-striped" %)
455 |=(% colspan="4" %)(((
456 ==== RegisterInvoiceDirectPaymentByBillNo10Response ====
457 )))
458 |**Field**|**Datatype**|**Description**| |
459 |##ResponseCode##|String| | |
460 |##Respons##|String|
461 |##TraceId##|String|
462
463 **Error codes**
464
465 (% class="table-bordered table-striped" %)
466 |=(% colspan="4" %)(((
467 ==== GetCustomerCurrentStateByCustomerNoResponse ====
468 )))
469 |**Code**|**Name**|**Description**
470 |##5089##|BillsNotFound|Found no matching Invoices for BillNo
471
472 == GetClosedInvoiceInformationByCustomerNo20 ==
473
474 Get information about a customer's closed invoice(s) by customer number.
475
476 **Class diagram**
477 [[image:1573632921277-742.png||height="509" width="841"]]
478
479 **Request parameters**
480
481 (% class="table-bordered table-striped" %)
482 |=(% colspan="4" %)(((
483 ==== GetClosedInvoiceInformationByCustomerNo20Request ====
484 )))
485 |**Field**|**Datatype**|**Required**|**Description**
486 |##CustomerNo##|String|Yes|
487 |##TrackingUserEmail##|String|Yes|User info for trackability.
488 |TraceId| |yes|
489
490 **Response parameters**
491
492 **[[GetClosedInvoiceInformation20Response>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetClosedInvoiceInformation20Response"]]**
493
494
495
496 == GetClosedInvoiceInformationByCustomerNo21 ==
497
498 Get information about a customer's closed invoice(s) by customer number.
499
500 **Request parameters**
501
502 (% class="table-bordered table-striped" %)
503 |=(% colspan="4" %)(((
504 ==== GetClosedInvoiceInformationByCustomerNo21Request ====
505 )))
506 |**Field**|**Datatype**|**Required**|**Description**
507 |##CustomerNo##|String|Yes|
508 |##TrackingUserEmail##|String|Yes|User info for trackability.
509 |TraceId|String|yes|
510
511 **Response parameters**
512
513 **[[GetClosedInvoiceInformation21Response>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetClosedInvoiceInformation21Response"]]**
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>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|Yes|See [[RegNo>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]
531 |##TrackingUserEmail##|String|Yes|User info for trackability.
532 |TraceId| |yes|
533
534 **Response parameters**
535
536 **[[GetClosedInvoiceInformation20Response>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||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>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|Yes|See [[RegNo>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]
562 |##TrackingUserEmail##|String|Yes|User info for trackability.
563 |TraceId| |yes|
564
565 **Response parameters**
566
567 **[[GetClosedInvoiceInformation21Response>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||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
585 [[image:PxR_InvoiceService_GetInvoiceInformationByBillNo20.png]]
586
587 **Request parameters**
588
589 (% class="table-bordered table-striped" %)
590 |=(% colspan="4" %)(((
591 ==== GetInvoiceInformationByBillNo20Request ====
592 )))
593 |**Field**|**Datatype**|**Required**|**Description**
594 |##BillNo##|String|Yes|
595 |TrackingUserEMail|String(1-256)|Yes|User info for trackability.
596 |TraceId|String|Yes|
597
598 **Response parameters**
599
600 [[GetInvoinceInformation20Response>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoiceInformation20Response"]]
601
602 **Error codes**
603
604 (% class="table-bordered table-striped" %)
605 |=(% colspan="4" %)(((
606 ==== Possible error codes from GetInvoinceInformationByBillNo20 ====
607 )))
608 |**Code**|**Name**|**Description**
609 |##5080##|InvalidBillNo|BillNo does not match any valid invoices.
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>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||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 |##5080##|InvalidBillNo|BillNo does not match any valid invoices.
637
638 == GetInvoiceInformationByExternalInvoiceId20 ==
639
640 **Class diagram**
641
642
643 [[image:PxR_InvoiceService_GetInvoiceInformationByExternalInvoiceId20.png]]
644
645 **Request parameters**
646
647 (% class="table-bordered table-striped" %)
648 |=(% colspan="4" %)(((
649 ==== GetInvoiceInformationByExternalInvoiceId20Request ====
650 )))
651 |**Field**|**Datatype**|**Required**|**Description**
652 |##ExternalInvoiceId##|String|Yes|
653 |TrackingUserEMail|String(1-256)|Yes|User info for trackability.
654 |TraceId|String|Yes|
655
656 **Response parameters**
657
658 [[GetInvoinceInformation20Response>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoiceInformation20Response"]]
659
660 **Error codes**
661
662 (% class="table-bordered table-striped" %)
663 |=(% colspan="4" %)(((
664 ==== Possible error codes from GetInvoinceInformationByExternalInvoiceId20 ====
665 )))
666 |**Code**|**Name**|**Description**
667 |##5072##|InvalidExternalBillId|ExternalInvoiceId does not match any valid invoices.
668 |5089|BillsNotFound|Invoice match but invoice not valid. May be older than 1 year.
669
670 == GetInvoiceInformationByExternalInvoiceId21 ==
671
672 [[image:PxR_InvoiceService_GetInvoiceInformationByExternalInvoiceId21.png]]
673
674 **Request parameters**
675
676 (% class="table-bordered table-striped" %)
677 |=(% colspan="4" %)(((
678 ==== GetInvoiceInformationByExternalInvoiceId21Request ====
679 )))
680 |**Field**|**Datatype**|**Required**|**Description**
681 |##ExternalInvoiceId##|String|Yes|
682 |TrackingUserEMail|String(1-256)|Yes|User info for trackability.
683 |TraceId|String|Yes|
684
685 **Response parameters**
686
687 [[GetInvoinceInformation21Response>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoiceInformation21Response"]]
688
689 **Error codes**
690
691 (% class="table-bordered table-striped" %)
692 |=(% colspan="4" %)(((
693 ==== Possible error codes from GetInvoinceInformationByExternalInvoiceId20 ====
694 )))
695 |**Code**|**Name**|**Description**
696 |##5072##|InvalidExternalBillId|ExternalInvoiceId does not match any valid invoices.
697 |5089|BillsNotFound|(((
698 Invoice match but invoice not valid. May be older than 1 year.
699
700
701
702 )))
703
704 == GetInvoicePdfByBillNoExternalBillType10 ==
705
706 **Class diagram**
707
708 [[image:1573822789308-786.png||height="470" width="761"]]
709
710 **Request parameters**
711
712 (% class="table-bordered table-striped" %)
713 |=(% colspan="4" %)(((
714 ==== GetInvoicePdfByBillNoExternalBillType10Request ====
715 )))
716 |**Field**|**Datatype**|**Required**|**Description**
717 |##BillNo##|String|Yes|
718 |ExternalBillType|String|Yes|(((
719 Document type.
720 Existing ExternalBillType can be retrived from GetInvoiceInformationByBillNo20 or GetInvoiceInformationByExternalInvoiceId20.
721 )))
722 |TrackingUserEMail|String(1-256)|Yes|User info for trackability.
723 |TraceId|String|Yes|
724
725 **Response parameters**
726
727 [[GetInvoicePDFResponse>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoicePDFResponse"]]
728
729 **Error codes**
730
731 (% class="table-bordered table-striped" %)
732 |=(% colspan="4" %)(((
733 ==== GetInvoincePDFResponse ====
734 )))
735 |**Code**|**Name**|**Description**
736 |##5046##|InvalidAccountType|Wrong account type. The requested bill number is not an invoice.
737 |5080|InvalidBillNo|Invoice document not found.
738 |5095|ExternalBillTypeCode|Invalid ExternalBillType.
739
740 == GetInvoiceTransactionsByBillNo ==
741
742 [[image:PxR_InvoiceService_GetInvoiceTransactionsByBillNo.png]]
743
744 **Request parameters**
745
746 (% class="table-bordered table-striped" %)
747 |=(% colspan="4" %)(((
748 ==== GetInvoiceTransactionsByBillNoRequest ====
749 )))
750 |**Field**|**Datatype**|**Required**|**Description**
751 |RegNo|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|Yes|See [[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]
752 |TrackingUserEMail|String(1-256)|Yes|User info for trackability.
753 |TraceId|String|Yes|
754
755 **Response parameters**
756
757
758 (% class="table-bordered table-striped" %)
759 |=(% colspan="3" %)(((
760 ==== GetInvoiceTransactionsByBillNoResponse ====
761 )))
762 |**Field**|**Datatype**|**Description**
763 |Transactions|List<[[InvoiceTransaction>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HTransaction"]]>|
764 |ResponseCode|Int|
765 |ResponseMessage|String|
766 |TraceId|String|
767
768 (% class="table-bordered table-striped" %)
769 |=(% colspan="3" %)(((
770 ==== InvoiceTransaction ====
771 )))
772 |**Field**|**Datatype**|**Description**
773 |Amount|Decimal|
774 |CauseType|String|See possible values [[TransactionCauseCode>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HTransactionCausecodes"]]
775 |Date|DateTime|
776 |Reference|String|
777 |Type|String|See possible values [[TransactionTypeGroup>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HTransactionTypeGroupcodes"]]
778
779 == GetOpenInvoiceInformationByCustomerNo20 ==
780
781 **Class diagram**
782
783
784 [[image:PxR_InvoiceService_GetOpenInvoiceInformationByCustomerNo20.png]]
785
786 **Request parameters**
787
788 (% class="table-bordered table-striped" %)
789 |=(% colspan="4" %)(((
790 ==== GetOpenInvoiceInformationByCustomerNo20Request ====
791 )))
792 |**Field**|**Datatype**|**Required**|**Description**
793 |CustomerNo|String|Yes|
794 |TrackingUserEMail|String(1-256)|Yes|User info for trackability.
795 |TraceId|String|Yes|
796
797 **Response parameters**
798
799 [[GetOpenInvoiceInformation20Response>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetOpenInvoiceInformation20Response"]]
800
801 == GetOpenInvoiceInformationByCustomerNo21 ==
802
803 [[image:PxR_InvoiceService_GetOpenInvoiceInformationByCystomerNo21.png]]
804
805 **Request parameters**
806
807 (% class="table-bordered table-striped" %)
808 |=(% colspan="4" %)(((
809 ==== GetOpenInvoiceInformationByCustomerNo21Request ====
810 )))
811 |**Field**|**Datatype**|**Required**|**Description**
812 |CustomerNo|String|Yes|
813 |TrackingUserEMail|String(1-256)|Yes|User info for trackability.
814 |TraceId|String|Yes|
815
816 **Response parameters**
817
818 [[GetOpenInvoiceInformation21Response>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetOpenInvoiceInformation21Response"]]
819
820 == ==
821
822 == GetOpenInvoiceInformationByCustomerNo22 ==
823
824 [[image:PxR_InvoiceService_GetOpenInvoiceInformationByCustomerNo22.png]]
825
826
827 **Request parameters**
828
829 (% class="table-bordered table-striped" %)
830 |=(% colspan="4" %)(((
831 ==== GetOpenInvoiceInformationByCustomerNo22Request ====
832 )))
833 |**Field**|**Datatype**|**Required**|**Description**
834 |CustomerNo|String|Yes|
835 |TrackingUserEMail|String(1-256)|Yes|User info for trackability.
836 |TraceId|String|Yes|
837
838 **Response parameters**
839
840 [[GetOpenInvoiceInformation22Response>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetOpenInvoiceInformation22Response"]]
841
842 == ==
843
844 == GetOpenInvoiceInformationByRegNo20 ==
845
846 **Class diagram**
847
848
849 [[image:PxR_InvoiceService_GetOpenInvoiceInformationByRegNo20.png]]
850
851 **Request parameters**
852
853 (% class="table-bordered table-striped" %)
854 |=(% colspan="4" %)(((
855 ==== GetOpenInvoiceInformationByRegNo20Request ====
856 )))
857 |**Field**|**Datatype**|**Required**|**Description**
858 |RegNo|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|Yes|See [[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]
859 |TrackingUserEMail|String(1-256)|Yes|User info for trackability.
860 |TraceId|String|Yes|
861
862 **Response parameters**
863
864 [[GetOpenInvoiceInformation20Response>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetOpenInvoiceInformation20Response"]]
865
866 == GetOpenInvoiceInformationByRegNo21 ==
867
868 [[image:PxR_InvoiceService_GetOpenInvoiceInformationByRegNo21.png]]
869
870 **Request parameters**
871
872 (% class="table-bordered table-striped" %)
873 |=(% colspan="4" %)(((
874 ==== GetOpenInvoiceInformationByRegNo21Request ====
875 )))
876 |**Field**|**Datatype**|**Required**|**Description**
877 |RegNo|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|Yes|See [[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]
878 |TrackingUserEMail|String(1-256)|Yes|User info for trackability.
879 |TraceId|String|Yes|
880
881 **Response parameters**
882
883 [[GetOpenInvoiceInformation21Response>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetOpenInvoiceInformation21Response"]]
884
885
886 == GetOpenInvoiceInformationByRegNo22 ==
887
888 [[image:PxR_InvoiceService_GetOpenInvoiceInformationByRegNo22.png]]
889
890 **Request parameters**
891
892 (% class="table-bordered table-striped" %)
893 |=(% colspan="4" %)(((
894 ==== GetOpenInvoiceInformationByRegNo22Request ====
895 )))
896 |**Field**|**Datatype**|**Required**|**Description**
897 |RegNo|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|Yes|See [[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]
898 |TrackingUserEMail|String(1-256)|Yes|User info for trackability.
899 |TraceId|String|Yes|
900
901 **Response parameters**
902
903 [[GetOpenInvoiceInformation22Response>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetOpenInvoiceInformation22Response"]]
904
905 == RegisterInvoicePSPPaymentByBillNo10 ==
906
907 **Class diagram**
908
909 [[image:1573825460421-413.png||height="460" width="778"]]
910
911 **Request parameters**
912
913 (% class="table-bordered table-striped" %)
914 |=(% colspan="4" %)(((
915 ==== RegisterInvoicePSPPaymentByBillNoRequest ====
916 )))
917 |**Field**|**Datatype**|**Required**|**Description**
918 |##BillNo##|String|Yes|
919 |Amount|Decimal|Yes|
920 |PaymentDate|DateTime|Yes|
921 |SellerTransactionId|String(1-50)|Yes|
922 |TrackingUserEMail|String(1-256)|Yes|User info for trackability.
923 |TraceId|String|Yes|
924
925 **Response parameters**
926
927 (% class="table-bordered table-striped" %)
928 |=(% colspan="4" %)(((
929 ==== RegisterInvoicePSPPaymentByBillNoResponse ====
930 )))
931 |**Field**|**Datatype**|**Description**
932 |##ResponseCode##|String|
933 |##ResponseMessage##|String|
934 |TraceId|String|
935
936 = =
937
938 == GetOrderlinesByBillNo10 ==
939
940 (% class="wikigeneratedid" %)
941 Get all orderlines on a bill
942 [[image:PxR_InvoiceService_GetOrderLinesByBillNo10.png]]
943
944 **Request parameters**
945
946 (% class="table-bordered table-striped" %)
947 |=(% colspan="4" %)(((
948 ==== GetOrderlinesByBillNo10Request ====
949 )))
950 |**Field**|**Datatype**|**Required**|**Description**
951 |##BillNo##|String|Yes|
952 |##TrackingUserEMail##|String|Yes|User info for trackability.
953 |TraceId|String|Yes|
954
955 **Response parameters**
956
957 (% class="table-bordered table-striped" %)
958 |=(% colspan="3" %)(((
959 ==== GetOrderlinesByBillNo10Response ====
960 )))
961 |**Field**|**Datatype**|**Description**
962 |(% style="font-family:monospace" %)##OrderLines##|List [[OrderLine>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HOrderline"]]|Array.
963 |##ResponseCode##|String|
964 |##ResponseMessage##|String|
965 |##TraceId##|String|
966
967 **Classes**
968
969 (% class="table-bordered table-striped" %)
970 |=(% colspan="3" %)(((
971 ==== Orderline ====
972 )))
973 |**Field**|**Datatype**|**Description**
974 |(% style="font-family:monospace" %)AmountInclVat|Decimal|
975 |(% style="font-family:monospace" %)Description|String|
976 |(% style="font-family:monospace" %)ExternalReferenceId|String|
977 |(% style="font-family:monospace" %)TransactionDate|DateTime|
978 |(% style="font-family:monospace" %)##VatAmount##|Decimal|
979
980 **Error codes**
981
982 (% class="table-bordered table-striped" %)
983 |=(% colspan="4" %)(((
984 ==== GetOrderlinesByBillNo10Response ====
985 )))
986 |**Code**|**Name**|**Description**
987 |5080|InvalidBillNo|BillNo input is not valid or no matching bill found
988
989 =
990 \\CustomerService methods =
991
992 The complete Wsdl specification for this service can be found at:
993 [[https:~~/~~/connect.internaltest.payex.com/PxR/CustomerService.svc>>url:https://connect.internaltest.payex.com/PxR/CustomerService.svc]]
994
995 (Username/password security model)
996
997 == GetcustomerCurrentStateByCustomerNo ==
998
999 Get information about current state of a customer.
1000
1001 **Class diagram**
1002
1003
1004
1005 [[image:7-class-diagram-external.png]]
1006
1007 **Request parameters**
1008
1009 (% class="table-bordered table-striped" %)
1010 |=(% colspan="4" %)(((
1011 ==== GetCustomerCurrentStateByCustomerNoRequest ====
1012 )))
1013 |**Field**|**Datatype**|**Required**|**Description**
1014 |TraceId|String|Yes|
1015 |##CustomerNumber##|String(15)|Yes|
1016 |##TrackingUserEMail##|String|No|
1017
1018 **Response parameters**
1019
1020 (% class="table-bordered table-striped" %)
1021 |=(% colspan="3" %)(((
1022 ==== GetCustomerCurrentStateByCustomerNoResponse ====
1023 )))
1024 |**Field**|**Datatype**|**Description**
1025 |(% style="font-family:monospace" %)##CustomerConsents##|[[CustomerConsent>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerConsent"]]|Array.
1026 |##CustomerInfo##|[[CustomerInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerInfo"]]|
1027 |##CustomerNo##|String|
1028 |##CustomerStatus##|[[CustomerStatus>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerStatus"]]|Array.
1029
1030 **Classes**
1031
1032 (% class="table-bordered table-striped" %)
1033 |=(% colspan="3" %)(((
1034 ==== CustomerConsent ====
1035 )))
1036 |**Field**|**Datatype**|**Description**
1037 |(% 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.
1038
1039 (% class="table-bordered table-striped" %)
1040 |=(% colspan="3" %)(((
1041 ==== CustomerInfo ====
1042 )))
1043 |**Field**|**Datatype**|**Description**
1044 |(% style="font-family:monospace" %)##Name##|String|
1045 |##DistributionAddressInfo##|[[DistributionAddressInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HDistributionAddressInfo"]]|
1046 |##Language##|String|
1047 |##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.
1048 |##VatNo##|String|
1049 |##Category##|String|Customer Category
1050
1051 (% class="table-bordered table-striped" %)
1052 |=(% colspan="3" %)(((
1053 ==== CustomerStatus ====
1054 )))
1055 |**Field**|**Datatype**|**Description**
1056 |(% style="font-family:monospace" %)##CustomerStatusTypeCode##|Int|[[See code specification.>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerStatustypecodes"]]
1057
1058 (% class="table-bordered table-striped" %)
1059 |=(% colspan="4" %)(((
1060 ==== DistributionAddressInfo ====
1061 )))
1062 |**Field**|**Datatype**|**Required**|**Description**
1063 |(% style="font-family:monospace" %)##Addresses##|Array|Yes|See [[address>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HAddress"]].
1064 |##EMailAddress##|String|No|
1065 |##Cellphone##|String|No|
1066
1067 (% class="table-bordered table-striped" %)
1068 |=(% colspan="4" %)(((
1069 ==== Address ====
1070 )))
1071 |**Field**|**Datatype**|**Required**|**Description**
1072 |(% style="font-family:monospace" %)Addressee|String(72)|Yes|
1073 |##StreetAdress##|String(35)|No|
1074 |##ZipCode##|String(9)|Yes|
1075 |##City##|String(27)|Yes|
1076 |##CoAddress##|String(35)|No|
1077 |##CountryCode##|String(2)|Yes|
1078 |AddressType|Int|Yes|See the [[ address type codes table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HAddresstypecodes"]] for available legal entity codes.
1079
1080 == GetCustomerCurrentStateByRegNo10 ==
1081
1082 **Class diagram**
1083
1084 [[image:1574422177227-663.png||height="671" width="1146"]]
1085
1086 **Request parameters**
1087
1088 (% class="table-bordered table-striped" %)
1089 |=(% colspan="4" %)(((
1090 ==== GetCustomerCurrentStateByRegNo10Request ====
1091 )))
1092 |**Field**|**Datatype**|**Required**|**Description**
1093 |##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|Yes|
1094 |##TrackingUserEMail##|String|Yes|
1095 |TraceId|String|Yes|
1096
1097 **Response parameters**
1098
1099 (% class="table-bordered table-striped" %)
1100 |=(% colspan="3" %)(((
1101 ==== GetCustomerCurrentStateByRegNo10Response ====
1102 )))
1103 |**Field**|**Datatype**|**Description**
1104 |(% style="font-family:monospace" %)##CustomerConsents##|[[CustomerConsent>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerConsent"]]|Array.
1105 |##CustomerInfo##|[[CustomerInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerInfo"]]|
1106 |##CustomerNo##|String|
1107 |##CustomerStatus##|[[CustomerStatus>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerStatus"]]|Array.
1108 |##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
1109
1110 (% id="HAppendix1SharedClasses" %)
1111 = Appendix 1 Shared Classes =
1112
1113
1114 **Response parameters**
1115
1116 (% class="table-bordered table-striped" %)
1117 |=(% colspan="3" %)(((
1118 ==== GetInvoicePDFResponse ====
1119 )))
1120 |**Field**|**Datatype**|**Description**
1121 |##Pdf##|Byte[]|
1122 |##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
1123 |##CustomerNo##|String|
1124 |##ResponseCode##|String|
1125 |##ResponseMessage##|String|
1126 |##TraceId##|String|
1127
1128 (% class="table-bordered table-striped" style="width:1223px" %)
1129 |=(% colspan="3" style="width: 1220px;" %)(((
1130 ==== GetInvoiceInformationResponse ====
1131 )))
1132 |(% style="width:352px" %)**Field**|(% style="width:413px" %)**Datatype**|(% style="width:457px" %)**Description**
1133 |(% style="width:352px" %)##RegNo##|(% style="width:413px" %)[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|(% style="width:457px" %)
1134 |(% style="width:352px" %)##CustomerNo##|(% style="width:413px" %)String|(% style="width:457px" %)
1135 |(% style="width:352px" %)##Invoice##|(% style="width:413px" %)[[Invoice>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoice"]]|(% style="width:457px" %)
1136 |(% style="width:352px" %)##ResponseCode##|(% style="width:413px" %)String|(% style="width:457px" %)
1137 |(% style="width:352px" %)##ResponseMessage##|(% style="width:413px" %)String|(% style="width:457px" %)
1138 |(% style="width:352px" %)##TraceId##|(% style="width:413px" %)String|(% style="width:457px" %)
1139
1140 (% class="table-bordered table-striped" %)
1141 |=(% colspan="3" %)(((
1142 ==== Invoice ====
1143 )))
1144 |**Field**|**Datatype**|**Description**
1145 |##PaymentReference##|String|
1146 |##BillNo##|String|
1147 |##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.
1148 |##ExternalInvoiceId##|String|
1149 |##ExternalReference##|String|
1150 |##SellerNo##|String|
1151 |##BillDate##|DateTime|
1152 |##DueDate##|DateTime (Optional)|
1153 |##OriginalAmount##|Decimal|
1154 |##Interest##|[[Interest>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInterest"]]|
1155 |##CurrentBalanceList##|List <[[Balance>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBalance"]]>|
1156 |##CurrencyCode##|String|
1157 |##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.
1158 |##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.
1159 |##PaymentBankAccount##|[[PaymentBankAccount>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HPaymentBankAccount"]]|
1160 |##PaymentType##|String|
1161 |##ActiveRespite##|[[ActiveRespite>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActiveRespite"]]|
1162 |##ActivePaymentOrder##|[[ActivePaymentOrder>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActivePaymentOrder"]]|
1163 |##BillId##|Long|
1164 |##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.
1165 |##InvoiceHistory##|List <[[InvoiceHistory>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoiceHistory"]]>|
1166
1167 (% class="table-bordered table-striped" %)
1168 |=(% colspan="3" %)(((
1169 ==== PaymentBankAccount21 inherit [[PaymentBankAccount>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HPaymentBankAccount"]] ====
1170 )))
1171 |**Field**|**Datatype**|**Description**
1172 | | |
1173
1174 (% class="table-bordered table-striped" %)
1175 |=(% colspan="3" %)(((
1176 ==== PaymentBankAccount ====
1177 )))
1178 |**Field**|**Datatype**|**Description**
1179 |##BankAccountNo##|String|
1180 |##BankAccountType##|String|
1181 |##BIC##|String|
1182 |##IBAN##|String|
1183 |PaymentTypeName|String|
1184
1185 (% class="table-bordered table-striped" %)
1186 |=(% colspan="3" %)(((
1187 ==== ActiveRespite ====
1188 )))
1189 |**Field**|**Datatype**|**Description**
1190 |##RespiteValidToDate##|DateTime|
1191 |##RespiteTypeCode##|int|See the [[respite type code table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRespitetypecodes"]] for available respite type codes.
1192
1193 (% class="table-bordered table-striped" %)
1194 |=(% colspan="3" %)(((
1195 ==== ActiveRespite22 ====
1196 )))
1197 |**Field**|**Datatype**|**Description**
1198 |##RespiteValidToDate##|DateTime|
1199 |RespiteCause|int|See the [[complaint cause code table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HComplaintCausecodes"]] for available respite type codes.
1200 |##RespiteTypeCode##|int|See the [[respite type code table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRespitetypecodes"]] for available respite type codes.
1201
1202 (% class="table-bordered table-striped" %)
1203 |=(% colspan="3" %)(((
1204 ==== InvoiceHistory ====
1205 )))
1206 |**Field**|**Datatype**|**Description**
1207 |BillDate|DateTime|
1208 |BillId|long|
1209 |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.
1210
1211 (% class="table-bordered table-striped" %)
1212 |=(% colspan="3" %)(((
1213 ==== GetClosedInvoiceInformation21Response ====
1214 )))
1215 |**Field**|**Datatype**|**Description**
1216 |CompanyNo|String|
1217 |CustomerNo|string|
1218 |CustomerName|String|
1219 |InvoiceList|List<[[ClosedInvoice21>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HClosedInvoice21"]]>|See [[ClosedInvoice21>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HClosedInvoice21"]]
1220
1221 (% class="table-bordered table-striped" %)
1222 |=(% colspan="3" %)(((
1223 ==== GetOpenInvoiceInformation21Response ====
1224 )))
1225 |**Field**|**Datatype**|**Description**
1226 |CompanyNo|String|
1227 |CustomerNo|string|
1228 |CustomerName|String|
1229 |InvoiceList|List<[[OpenInvoice21>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HOpenInvoice21inheritClosedInvoice21"]]>|
1230
1231 (% class="table-bordered table-striped" %)
1232 |=(% colspan="3" %)(((
1233 ==== GetOpenInvoiceInformation22Response ====
1234 )))
1235 |**Field**|**Datatype**|**Description**
1236 |CompanyNo|String|
1237 |CustomerNo|string|
1238 |CustomerName|String|
1239 |InvoiceList|List<[[OpenInvoice22>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HOpenInvoice22inheritClosedInvoice22"]]>|
1240
1241 (% class="table-bordered table-striped" %)
1242 |=(% colspan="3" %)(((
1243 ==== GetInvoiceInformation21Response ====
1244 )))
1245 |**Field**|**Datatype**|**Description**
1246 |CompanyNo|String|
1247 |RegNo|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
1248 |CustomerNo|string|
1249 |CustomerName|String|
1250 |InvoiceList|List<[[InvoiceInformation21>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoiceInformation21inheritOpenInvoice21"]]>|
1251
1252 (% class="table-bordered table-striped" %)
1253 |=(% colspan="3" %)(((
1254 ==== ClosedInvoice21 ====
1255 )))
1256 |**Field**|**Datatype**|**Description**
1257 |CurrencyCode|String|
1258 |BillNo|string|
1259 |BillStatusCode|Int|
1260 |ExternalInvoiceId|String|
1261 |BillDate|DateTime|
1262 |DueDate|DateTime|
1263 |ExternalBillType|String|
1264 |OriginalAmount|Decimal|
1265 |SellerName|String|
1266 |SellerNo|String|
1267 |InvoiceProfileType|String|The invoice profile type code
1268 |InvoiceAlias|String|User friendly name of the invoice profile type
1269
1270 (% class="table-bordered table-striped" %)
1271 |=(% colspan="3" %)(((
1272 ==== ClosedInvoice22 inherits [[ClosedInvoice21>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HClosedInvoice21"]] ====
1273 )))
1274 |**Field**|**Datatype**|**Description**
1275 | | |
1276
1277 (% class="table-bordered table-striped" %)
1278 |=(% colspan="4" %)(((
1279 ==== OpenInvoice21 inherit [[ClosedInvoice21>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HClosedInvoice21"]] ====
1280 )))
1281 |**Field**|**Datatype**| |**Description**
1282 |CurrentDebt|Decimal| |
1283 |PaymentBankAccount|[[PaymentBankAccount21>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HPaymentBankAccount21inheritPaymentBankAccount"]]| |
1284 |PaymentType|String| |
1285 |ActiveRespite|[[ActiveRespite21>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActiveRespite21"]]| |
1286 |ActivePaymentOrder|[[ActivePaymentOrder>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActivePaymentOrder"]]| |
1287 |PaymentReference|String| |
1288 |ExportedToCollection|Bool| |
1289 |{{{ExportedToCollectionDate}}}|DateTime| |(((
1290
1291 )))
1292
1293 ​​​​​​
1294
1295 (% class="table-bordered table-striped" %)
1296 |=(% colspan="4" %)(((
1297 ==== OpenInvoice22 inherit [[ClosedInvoice22>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HClosedInvoice22inheritsClosedInvoice21"]] ====
1298 )))
1299 |**Field**|**Datatype**| |**Description**
1300 |CurrentDebt|Decimal| |
1301 |PaymentBankAccount|[[PaymentBankAccount21>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HPaymentBankAccount21inheritPaymentBankAccount"]]| |
1302 |PaymentType|String| |
1303 |ActiveRespite|[[ActiveRespite22>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActiveRespite22"]]| |
1304 |ActivePaymentOrder|[[ActivePaymentOrder>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActivePaymentOrder"]]| |
1305 |PaymentReference|String| |
1306 |ExportedToCollection|Bool| |
1307 |{{{ExportedToCollectionDate}}}|DateTime| |(((
1308
1309 )))
1310
1311 ​​​​​​
1312
1313 (% class="table-bordered table-striped" %)
1314 |=(% colspan="3" %)(((
1315 ==== InvoiceInformation21 inherit [[OpenInvoice21>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HOpenInvoice21inheritClosedInvoice21"]] ====
1316 )))
1317 |**Field**|**Datatype**|**Description**
1318 |PenaltyInterest|[[Interest>>url:https://developer.payex.com/xwiki/wiki/developer/view/Main/Invoicing/invoice-service/Technical%20reference/PayEx%20Connect%20%28API%29/ExternalServicesmanual/#HInterest]]|
1319 |CurrentBalance|List<[[Balance>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBalance"]]>|
1320
1321 (% class="table-bordered table-striped" %)
1322 |=(% colspan="3" %)(((
1323 ==== GetClosedInvoiceInformation20Response ====
1324 )))
1325 |**Field**|**Datatype**|**Description**
1326 |CompanyNo|String|
1327 |CustomerNo|string|
1328 |CustomerName|String|
1329 |InvoiceList|List<[[ClosedInvoice20>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HClosedInvoice20"]]>|See [[ClosedInvoice20>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HClosedInvoice20"]]
1330
1331 (% class="table-bordered table-striped" %)
1332 |=(% colspan="3" %)(((
1333 ==== ClosedInvoice20 ====
1334 )))
1335 |**Field**|**Datatype**|**Description**
1336 |CurrencyCode|String|
1337 |BillNo|string|
1338 |BillStatusCode|Int|See the [[bill status code table>>url:https://developer.payex.com/xwiki/wiki/developer/view/Main/Invoicing/invoice-service/Technical%20reference/PayEx%20Connect%20%28API%29/ExternalServicesmanual/#HBillstatuscodes]] for available status codes.
1339 |ExternalInvoiceId|String|
1340 |BillDate|DateTime|
1341 |DueDate|DateTime|
1342 |ExternalBillType|String|
1343 |OriginalAmount|Decimal|
1344 |SellerName|String|
1345 |SellerNo|String|
1346
1347 (% class="table-bordered table-striped" %)
1348 |=(% colspan="3" %)(((
1349 ==== GetOpenInvoiceInformation20Response ====
1350 )))
1351 |**Field**|**Datatype**|**Description**
1352 |CompanyNo|String|
1353 |CustomerNo|string|
1354 |CustomerName|String|
1355 |InvoiceList|List<[[OpenInvoice20>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HOpenInvoice20inheritClosedInvoice20"]]>|
1356
1357 (% class="table-bordered table-striped" %)
1358 |=(% colspan="3" %)(((
1359 ==== InvoiceInformation20 inherit [[OpenInvoice20>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HOpenInvoice20inheritClosedInvoice20"]] ====
1360 )))
1361 |**Field**|**Datatype**|**Description**
1362 |PenaltyInterest|[[Interest>>url:https://developer.payex.com/xwiki/wiki/developer/view/Main/Invoicing/invoice-service/Technical%20reference/PayEx%20Connect%20%28API%29/ExternalServicesmanual/#HInterest]]|
1363 |CurrentBalance|List<[[Balance>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBalance"]]>|
1364 |InvoiceHistory|List<[[InvoiceHistory20>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoiceHistory20"]]>|
1365
1366 (% class="table-bordered table-striped" %)
1367 |=(% colspan="3" %)(((
1368 ==== InvoiceHistory20 ====
1369 )))
1370 |**Field**|**Datatype**|**Description**
1371 |BillDate|DateTime|
1372 |ExternalBillType|String|
1373 |BillAmount|Decimal|
1374
1375 (% class="table-bordered table-striped" style="width:1186px" %)
1376 |=(% colspan="3" style="width: 1183px;" %)(((
1377 ==== OpenInvoice20 inherit [[ClosedInvoice20>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HClosedInvoice20"]] ====
1378 )))
1379 |**Field**|**Datatype**|(% style="width:155px" %)**Description**
1380 |CurrentDebt|Decimal|(% style="width:155px" %)
1381 |PaymentBankAccount|[[PaymentBankAccount>>url:https://developer.payex.com/xwiki/wiki/developer/view/Main/Invoicing/invoice-service/Technical%20reference/PayEx%20Connect%20%28API%29/ExternalServicesmanual/#HPaymentBankAccount]]|(% style="width:155px" %)
1382 |PaymentType|String|(% style="width:155px" %)
1383 |ActiveRespite|[[ActiveRespite20>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActiveRespite20"]]|(% style="width:155px" %)
1384 |ActivePaymentOrder|[[ActivePaymentOrder>>Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActivePaymentOrder"]]|(% style="width:155px" %)
1385 |PaymentReference|String|(% style="width:155px" %)
1386 |ExportedToCollection|Bool|(% style="width:155px" %)
1387
1388 {{display reference="developer:Main.PxConnectGeneralAppendix.WebHome"/}}