Changes for page ExternalServicesmanual

Last modified by Fredrik Nilsson on 2021/06/29 16:53
From empty
To version 218.1
edited by Simon Melin
on 2020/07/08 15:10
Change comment: There is no comment for this version

Summary

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.XWikiGuest
1 +xwiki:XWiki.avp
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Tags
... ... @@ -1,0 +1,1 @@
1 +px-custom-page-content
Content
... ... @@ -1,0 +1,1266 @@
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>>||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>>||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>>||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 +
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>>||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>>||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>>||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>>||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>>||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 +== ==
741 +
742 +== GetOpenInvoiceInformationByCustomerNo20 ==
743 +
744 +**Class diagram**
745 +
746 +
747 +[[image:PxR_InvoiceService_GetOpenInvoiceInformationByCustomerNo20.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 +== GetOpenInvoiceInformationByCustomerNo21 ==
765 +
766 +[[image:PxR_InvoiceService_GetOpenInvoiceInformationByCystomerNo21.png]]
767 +
768 +**Request parameters**
769 +
770 +(% class="table-bordered table-striped" %)
771 +|=(% colspan="4" %)(((
772 +==== GetOpenInvoiceInformationByCustomerNo21Request ====
773 +)))
774 +|**Field**|**Datatype**|**Required**|**Description**
775 +|CustomerNo|String|Yes|
776 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
777 +|TraceId|String|Yes|
778 +
779 +**Response parameters**
780 +
781 +[[GetOpenInvoiceInformation21Response>>||anchor="HGetOpenInvoiceInformation21Response"]]
782 +
783 +== ==
784 +
785 +== ==
786 +
787 +== GetOpenInvoiceInformationByRegNo20 ==
788 +
789 +**Class diagram**
790 +
791 +[[image:PxR_InvoiceService_GetOpenInvoiceInformationByRegNo20.png||alt="1573825242764-218.png"]]
792 +
793 +**Request parameters**
794 +
795 +(% class="table-bordered table-striped" %)
796 +|=(% colspan="4" %)(((
797 +==== GetOpenInvoiceInformationByRegNo20Request ====
798 +)))
799 +|**Field**|**Datatype**|**Required**|**Description**
800 +|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"]]
801 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
802 +|TraceId|String|Yes|
803 +
804 +**Response parameters**
805 +
806 +[[GetOpenInvoiceInformation20Response>>||anchor="HGetOpenInvoiceInformation20Response"]]
807 +
808 +== GetOpenInvoiceInformationByRegNo21 ==
809 +
810 +[[image:PxR_InvoiceService_GetOpenInvoiceInformationByRegNo21.png]]
811 +
812 +**Request parameters**
813 +
814 +(% class="table-bordered table-striped" %)
815 +|=(% colspan="4" %)(((
816 +==== GetOpenInvoiceInformationByRegNo21Request ====
817 +)))
818 +|**Field**|**Datatype**|**Required**|**Description**
819 +|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"]]
820 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
821 +|TraceId|String|Yes|
822 +
823 +**Response parameters**
824 +
825 +[[GetOpenInvoiceInformation21Response>>||anchor="HGetOpenInvoiceInformation21Response"]]
826 +
827 +== RegisterInvoicePSPPaymentByBillNo10 ==
828 +
829 +**Class diagram**
830 +
831 +[[image:1573825460421-413.png||height="460" width="778"]]
832 +
833 +**Request parameters**
834 +
835 +(% class="table-bordered table-striped" %)
836 +|=(% colspan="4" %)(((
837 +==== RegisterInvoicePSPPaymentByBillNoRequest ====
838 +)))
839 +|**Field**|**Datatype**|**Required**|**Description**
840 +|##BillNo##|String|Yes|
841 +|Amount|Decimal|Yes|
842 +|PaymentDate|DateTime|Yes|
843 +|SellerTransactionId|String(1-50)|Yes|
844 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
845 +|TraceId|String|Yes|
846 +
847 +**Response parameters**
848 +
849 +(% class="table-bordered table-striped" %)
850 +|=(% colspan="4" %)(((
851 +==== RegisterInvoicePSPPaymentByBillNoResponse ====
852 +)))
853 +|**Field**|**Datatype**|**Description**
854 +|##ResponseCode##|String|
855 +|##ResponseMessage##|String|
856 +|TraceId|String|
857 +
858 += =
859 +
860 +== GetOrderlinesByBillNo10 ==
861 +
862 +(% class="wikigeneratedid" %)
863 +Get all orderlines on a bill
864 +[[image:PxR_InvoiceService_GetOrderLinesByBillNo10.png]]
865 +
866 +**Request parameters**
867 +
868 +(% class="table-bordered table-striped" %)
869 +|=(% colspan="4" %)(((
870 +==== GetOrderlinesByBillNo10Request ====
871 +)))
872 +|**Field**|**Datatype**|**Required**|**Description**
873 +|##BillNo##|String|Yes|
874 +|##TrackingUserEMail##|String|Yes|User info for trackability.
875 +|TraceId|String|Yes|
876 +
877 +**Response parameters**
878 +
879 +(% class="table-bordered table-striped" %)
880 +|=(% colspan="3" %)(((
881 +==== GetOrderlinesByBillNo10Response ====
882 +)))
883 +|**Field**|**Datatype**|**Description**
884 +|(% style="font-family:monospace" %)##OrderLines##|List [[OrderLine>>doc:||anchor="HOrderline"]]|Array.
885 +|##ResponseCode##|String|
886 +|##ResponseMessage##|String|
887 +|##TraceId##|String|
888 +
889 +**Classes**
890 +
891 +(% class="table-bordered table-striped" %)
892 +|=(% colspan="3" %)(((
893 +==== Orderline ====
894 +)))
895 +|**Field**|**Datatype**|**Description**
896 +|(% style="font-family:monospace" %)AmountInclVat|Decimal|
897 +|(% style="font-family:monospace" %)Description|String|
898 +|(% style="font-family:monospace" %)ExternalReferenceId|String|
899 +|(% style="font-family:monospace" %)TransactionDate|DateTime|
900 +|(% style="font-family:monospace" %)##VatAmount##|Decimal|
901 +
902 +**Error codes**
903 +
904 +(% class="table-bordered table-striped" %)
905 +|=(% colspan="4" %)(((
906 +==== GetOrderlinesByBillNo10Response ====
907 +)))
908 +|**Code**|**Name**|**Description**
909 +|5080|InvalidBillNo|BillNo input is not valid or no matching bill found
910 +
911 +=
912 +\\CustomerService methods =
913 +
914 +The complete Wsdl specification for this service can be found at:
915 +[[https:~~/~~/connect.internaltest.payex.com/PxR/CustomerService.svc>>url:https://connect.internaltest.payex.com/PxR/CustomerService.svc]]
916 +
917 + (Username/password security model)
918 +
919 +== GetcustomerCurrentStateByCustomerNo ==
920 +
921 +Get information about current state of a customer.
922 +
923 +**Class diagram**
924 +
925 +
926 +
927 +[[image:7-class-diagram-external.png]]
928 +
929 +**Request parameters**
930 +
931 +(% class="table-bordered table-striped" %)
932 +|=(% colspan="4" %)(((
933 +==== GetCustomerCurrentStateByCustomerNoRequest ====
934 +)))
935 +|**Field**|**Datatype**|**Required**|**Description**
936 +|TraceId|String|Yes|
937 +|##CustomerNumber##|String(15)|Yes|
938 +|##TrackingUserEMail##|String|No|
939 +
940 +**Response parameters**
941 +
942 +(% class="table-bordered table-striped" %)
943 +|=(% colspan="3" %)(((
944 +==== GetCustomerCurrentStateByCustomerNoResponse ====
945 +)))
946 +|**Field**|**Datatype**|**Description**
947 +|(% style="font-family:monospace" %)##CustomerConsents##|[[CustomerConsent>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerConsent"]]|Array.
948 +|##CustomerInfo##|[[CustomerInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerInfo"]]|
949 +|##CustomerNo##|String|
950 +|##CustomerStatus##|[[CustomerStatus>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerStatus"]]|Array.
951 +
952 +**Classes**
953 +
954 +(% class="table-bordered table-striped" %)
955 +|=(% colspan="3" %)(((
956 +==== CustomerConsent ====
957 +)))
958 +|**Field**|**Datatype**|**Description**
959 +|(% 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.
960 +
961 +(% class="table-bordered table-striped" %)
962 +|=(% colspan="3" %)(((
963 +==== CustomerInfo ====
964 +)))
965 +|**Field**|**Datatype**|**Description**
966 +|(% style="font-family:monospace" %)##Name##|String|
967 +|##DistributionAddressInfo##|[[DistributionAddressInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HDistributionAddressInfo"]]|
968 +|##Language##|String|
969 +|##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.
970 +|##VatNo##|String|
971 +|##Category##|String|Customer Category
972 +
973 +(% class="table-bordered table-striped" %)
974 +|=(% colspan="3" %)(((
975 +==== CustomerStatus ====
976 +)))
977 +|**Field**|**Datatype**|**Description**
978 +|(% style="font-family:monospace" %)##CustomerStatusTypeCode##|Int|[[See code specification.>>||anchor="HCustomerStatustypecodes"]]
979 +
980 +(% class="table-bordered table-striped" %)
981 +|=(% colspan="4" %)(((
982 +==== DistributionAddressInfo ====
983 +)))
984 +|**Field**|**Datatype**|**Required**|**Description**
985 +|(% style="font-family:monospace" %)##Addresses##|Array|Yes|See [[address>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HAddress"]].
986 +|##EMailAddress##|String|No|
987 +|##Cellphone##|String|No|
988 +
989 +(% class="table-bordered table-striped" %)
990 +|=(% colspan="4" %)(((
991 +==== Address ====
992 +)))
993 +|**Field**|**Datatype**|**Required**|**Description**
994 +|(% style="font-family:monospace" %)Addressee|String(72)|Yes|
995 +|##StreetAdress##|String(35)|No|
996 +|##ZipCode##|String(9)|Yes|
997 +|##City##|String(27)|Yes|
998 +|##CoAddress##|String(35)|No|
999 +|##CountryCode##|String(2)|Yes|
1000 +|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.
1001 +
1002 +== GetCustomerCurrentStateByRegNo10 ==
1003 +
1004 +**Class diagram**
1005 +
1006 +[[image:1574422177227-663.png||height="671" width="1146"]]
1007 +
1008 +**Request parameters**
1009 +
1010 +(% class="table-bordered table-striped" %)
1011 +|=(% colspan="4" %)(((
1012 +==== GetCustomerCurrentStateByRegNo10Request ====
1013 +)))
1014 +|**Field**|**Datatype**|**Required**|**Description**
1015 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|Yes|
1016 +|##TrackingUserEMail##|String|Yes|
1017 +|TraceId|String|Yes|
1018 +
1019 +**Response parameters**
1020 +
1021 +(% class="table-bordered table-striped" %)
1022 +|=(% colspan="3" %)(((
1023 +==== GetCustomerCurrentStateByRegNo10Response ====
1024 +)))
1025 +|**Field**|**Datatype**|**Description**
1026 +|(% style="font-family:monospace" %)##CustomerConsents##|[[CustomerConsent>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerConsent"]]|Array.
1027 +|##CustomerInfo##|[[CustomerInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerInfo"]]|
1028 +|##CustomerNo##|String|
1029 +|##CustomerStatus##|[[CustomerStatus>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerStatus"]]|Array.
1030 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
1031 +
1032 +(% id="HAppendix1SharedClasses" %)
1033 += Appendix 1 Shared Classes =
1034 +
1035 +
1036 +**Response parameters**
1037 +
1038 +(% class="table-bordered table-striped" %)
1039 +|=(% colspan="3" %)(((
1040 +==== GetInvoicePDFResponse ====
1041 +)))
1042 +|**Field**|**Datatype**|**Description**
1043 +|##Pdf##|Byte[]|
1044 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
1045 +|##CustomerNo##|String|
1046 +|##ResponseCode##|String|
1047 +|##ResponseMessage##|String|
1048 +|##TraceId##|String|
1049 +
1050 +(% class="table-bordered table-striped" style="width:1595px" %)
1051 +|=(% colspan="3" style="width: 1591px;" %)(((
1052 +==== GetInvoiceInformationResponse ====
1053 +)))
1054 +|(% style="width:700px" %)**Field**|(% style="width:400px" %)**Datatype**|(% style="width:493px" %)**Description**
1055 +|(% style="width:700px" %)##RegNo##|(% style="width:400px" %)[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|(% style="width:493px" %)
1056 +|(% style="width:700px" %)##CustomerNo##|(% style="width:400px" %)String|(% style="width:493px" %)
1057 +|(% style="width:700px" %)##Invoice##|(% style="width:400px" %)[[Invoice>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoice"]]|(% style="width:493px" %)
1058 +|(% style="width:700px" %)##ResponseCode##|(% style="width:400px" %)String|(% style="width:493px" %)
1059 +|(% style="width:700px" %)##ResponseMessage##|(% style="width:400px" %)String|(% style="width:493px" %)
1060 +|(% style="width:700px" %)##TraceId##|(% style="width:400px" %)String|(% style="width:493px" %)
1061 +
1062 +(% class="table-bordered table-striped" %)
1063 +|=(% colspan="3" %)(((
1064 +==== Invoice ====
1065 +)))
1066 +|**Field**|**Datatype**|**Description**
1067 +|##PaymentReference##|String|
1068 +|##BillNo##|String|
1069 +|##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.
1070 +|##ExternalInvoiceId##|String|
1071 +|##ExternalReference##|String|
1072 +|##SellerNo##|String|
1073 +|##BillDate##|DateTime|
1074 +|##DueDate##|DateTime (Optional)|
1075 +|##OriginalAmount##|Decimal|
1076 +|##Interest##|[[Interest>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInterest"]]|
1077 +|##CurrentBalanceList##|List <[[Balance>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBalance"]]>|
1078 +|##CurrencyCode##|String|
1079 +|##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.
1080 +|##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.
1081 +|##PaymentBankAccount##|[[PaymentBankAccount>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HPaymentBankAccount"]]|
1082 +|##PaymentType##|String|
1083 +|##ActiveRespite##|[[ActiveRespite>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActiveRespite"]]|
1084 +|##ActivePaymentOrder##|[[ActivePaymentOrder>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActivePaymentOrder"]]|
1085 +|##BillId##|Long|
1086 +|##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.
1087 +|##InvoiceHistory##|List <[[InvoiceHistory>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoiceHistory"]]>|
1088 +
1089 +(% class="table-bordered table-striped" %)
1090 +|=(% colspan="3" %)(((
1091 +==== PaymentBankAccount21 inherit [[PaymentBankAccount>>||anchor="HPaymentBankAccount"]] ====
1092 +)))
1093 +|**Field**|**Datatype**|**Description**
1094 +| | |
1095 +
1096 +(% class="table-bordered table-striped" %)
1097 +|=(% colspan="3" %)(((
1098 +==== PaymentBankAccount ====
1099 +)))
1100 +|**Field**|**Datatype**|**Description**
1101 +|##BankAccountNo##|String|
1102 +|##BankAccountType##|String|
1103 +|##BIC##|String|
1104 +|##IBAN##|String|
1105 +|PaymentTypeName|String|
1106 +
1107 +(% class="table-bordered table-striped" %)
1108 +|=(% colspan="3" %)(((
1109 +==== ActiveRespite ====
1110 +)))
1111 +|**Field**|**Datatype**|**Description**
1112 +|##RespiteValidToDate##|DateTime|
1113 +|##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.
1114 +
1115 +(% class="table-bordered table-striped" %)
1116 +|=(% colspan="3" %)(((
1117 +==== InvoiceHistory ====
1118 +)))
1119 +|**Field**|**Datatype**|**Description**
1120 +|BillDate|DateTime|
1121 +|BillId|long|
1122 +|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.
1123 +
1124 +(% class="table-bordered table-striped" %)
1125 +|=(% colspan="3" %)(((
1126 +==== GetClosedInvoiceInformation21Response ====
1127 +)))
1128 +|**Field**|**Datatype**|**Description**
1129 +|CompanyNo|String|
1130 +|CustomerNo|string|
1131 +|CustomerName|String|
1132 +|InvoiceList|List<[[ClosedInvoice21>>||anchor="HClosedInvoice21"]]>|See [[ClosedInvoice21>>||anchor="HClosedInvoice21"]]
1133 +
1134 +(% class="table-bordered table-striped" %)
1135 +|=(% colspan="3" %)(((
1136 +==== GetOpenInvoiceInformation21Response ====
1137 +)))
1138 +|**Field**|**Datatype**|**Description**
1139 +|CompanyNo|String|
1140 +|CustomerNo|string|
1141 +|CustomerName|String|
1142 +|InvoiceList|List<[[OpenInvoice21>>doc:||anchor="HOpenInvoice21inheritClosedInvoice21"]]>|
1143 +
1144 +(% class="table-bordered table-striped" %)
1145 +|=(% colspan="3" %)(((
1146 +==== GetInvoiceInformation21Response ====
1147 +)))
1148 +|**Field**|**Datatype**|**Description**
1149 +|CompanyNo|String|
1150 +|RegNo|[[RegNo>>doc:||anchor="HRegNo"]]|
1151 +|CustomerNo|string|
1152 +|CustomerName|String|
1153 +|InvoiceList|List<[[InvoiceInformation21>>doc:||anchor="HInvoiceInformation21inheritOpenInvoice21"]]>|
1154 +
1155 +(% class="table-bordered table-striped" %)
1156 +|=(% colspan="3" %)(((
1157 +==== ClosedInvoice21 ====
1158 +)))
1159 +|**Field**|**Datatype**|**Description**
1160 +|CurrencyCode|String|
1161 +|BillNo|string|
1162 +|BillStatusCode|Int|
1163 +|ExternalInvoiceId|String|
1164 +|BillDate|DateTime|
1165 +|DueDate|DateTime|
1166 +|ExternalBillType|String|
1167 +|OriginalAmount|Decimal|
1168 +|SellerName|String|
1169 +|SellerNo|String|
1170 +|InvoiceProfileType|String|The invoice profile type code
1171 +|InvoiceAlias|String|User friendly name of the invoice profile type
1172 +
1173 +(% class="table-bordered table-striped" %)
1174 +|=(% colspan="4" %)(((
1175 +==== OpenInvoice21 inherit [[ClosedInvoice21>>||anchor="HClosedInvoice21"]] ====
1176 +)))
1177 +|**Field**|**Datatype**| |**Description**
1178 +|CurrentDebt|Decimal| |
1179 +|PaymentBankAccount|[[PaymentBankAccount21>>doc:||anchor="HPaymentBankAccount21inheritPaymentBankAccount"]]| |
1180 +|PaymentType|String| |
1181 +|ActiveRespite|[[ActiveRespite21>>||anchor="HActiveRespite21"]]| |
1182 +|ActivePaymentOrder|[[ActivePaymentOrder>>||anchor="HActivePaymentOrder"]]| |
1183 +|PaymentReference|String| |
1184 +|ExportedToCollection|Bool| |
1185 +|{{{ExportedToCollectionDate}}}|DateTime| |(((
1186 +
1187 +)))
1188 +
1189 +​​​​​​
1190 +
1191 +(% class="table-bordered table-striped" %)
1192 +|=(% colspan="3" %)(((
1193 +==== InvoiceInformation21 inherit [[OpenInvoice21>>doc:||anchor="HOpenInvoice21inheritClosedInvoice21"]] ====
1194 +)))
1195 +|**Field**|**Datatype**|**Description**
1196 +|PenaltyInterest|[[Interest>>url:https://developer.payex.com/xwiki/wiki/developer/view/Main/Invoicing/invoice-service/Technical%20reference/PayEx%20Connect%20%28API%29/ExternalServicesmanual/#HInterest]]|
1197 +|CurrentBalance|List<[[Balance>>||anchor="HBalance"]]>|
1198 +
1199 +(% class="table-bordered table-striped" %)
1200 +|=(% colspan="3" %)(((
1201 +==== GetClosedInvoiceInformation20Response ====
1202 +)))
1203 +|**Field**|**Datatype**|**Description**
1204 +|CompanyNo|String|
1205 +|CustomerNo|string|
1206 +|CustomerName|String|
1207 +|InvoiceList|List<[[ClosedInvoice20>>||anchor="HClosedInvoice20"]]>|See [[ClosedInvoice20>>||anchor="HClosedInvoice20"]]
1208 +
1209 +(% class="table-bordered table-striped" %)
1210 +|=(% colspan="3" %)(((
1211 +==== ClosedInvoice20 ====
1212 +)))
1213 +|**Field**|**Datatype**|**Description**
1214 +|CurrencyCode|String|
1215 +|BillNo|string|
1216 +|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.
1217 +|ExternalInvoiceId|String|
1218 +|BillDate|DateTime|
1219 +|DueDate|DateTime|
1220 +|ExternalBillType|String|
1221 +|OriginalAmount|Decimal|
1222 +|SellerName|String|
1223 +|SellerNo|String|
1224 +
1225 +(% class="table-bordered table-striped" %)
1226 +|=(% colspan="3" %)(((
1227 +==== GetOpenInvoiceInformation20Response ====
1228 +)))
1229 +|**Field**|**Datatype**|**Description**
1230 +|CompanyNo|String|
1231 +|CustomerNo|string|
1232 +|CustomerName|String|
1233 +|InvoiceList|List<[[OpenInvoice20>>doc:||anchor="HOpenInvoice20inheritClosedInvoice20"]]>|
1234 +
1235 +(% class="table-bordered table-striped" %)
1236 +|=(% colspan="3" %)(((
1237 +==== InvoiceInformation20 inherit [[OpenInvoice20>>||anchor="HOpenInvoice20inheritClosedInvoice20"]] ====
1238 +)))
1239 +|**Field**|**Datatype**|**Description**
1240 +|PenaltyInterest|[[Interest>>url:https://developer.payex.com/xwiki/wiki/developer/view/Main/Invoicing/invoice-service/Technical%20reference/PayEx%20Connect%20%28API%29/ExternalServicesmanual/#HInterest]]|
1241 +|CurrentBalance|List<[[Balance>>||anchor="HBalance"]]>|
1242 +|InvoiceHistory|List<[[InvoiceHistory20>>||anchor="HInvoiceHistory20"]]>|
1243 +
1244 +(% class="table-bordered table-striped" %)
1245 +|=(% colspan="3" %)(((
1246 +==== InvoiceHistory20 ====
1247 +)))
1248 +|**Field**|**Datatype**|**Description**
1249 +|BillDate|DateTime|
1250 +|ExternalBillType|String|
1251 +|BillAmount|Decimal|
1252 +
1253 +(% class="table-bordered table-striped" style="width:1186px" %)
1254 +|=(% colspan="3" style="width: 1183px;" %)(((
1255 +==== OpenInvoice20 inherit [[ClosedInvoice20>>||anchor="HClosedInvoice20"]] ====
1256 +)))
1257 +|**Field**|**Datatype**|(% style="width:155px" %)**Description**
1258 +|CurrentDebt|Decimal|(% style="width:155px" %)
1259 +|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" %)
1260 +|PaymentType|String|(% style="width:155px" %)
1261 +|ActiveRespite|[[ActiveRespite20>>||anchor="HActiveRespite20"]]|(% style="width:155px" %)
1262 +|ActivePaymentOrder|[[ActivePaymentOrder>>||anchor="HActivePaymentOrder"]]|(% style="width:155px" %)
1263 +|PaymentReference|String|(% style="width:155px" %)
1264 +|ExportedToCollection|Bool|(% style="width:155px" %)
1265 +
1266 +{{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.avp
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_GetInvoiceInformationByBillNo.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.avp
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
PxR_InvoiceService_GetInvoiceInformationByExternalInvoiceId.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.avp
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
PxR_InvoiceService_GetInvoiceInformationByExternalInvoiceId20.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.avp
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
PxR_InvoiceService_GetInvoiceInformationByExternalInvoiceId21.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.avp
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
PxR_InvoiceService_GetOpenInvoiceInformationByCustomerNo20.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.avp
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
PxR_InvoiceService_GetOpenInvoiceInformationByCystomerNo21.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.avp
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
PxR_InvoiceService_GetOpenInvoiceInformationByRegNo21.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.avp
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
PxR_InvoiceService_GetOrderLinesByBillNo10.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.avp
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content