Changes for page ExternalServicesmanual

Last modified by Fredrik Nilsson on 2021/06/29 16:53
From empty
To version 212.1
edited by Simon Melin
on 2020/07/08 15:02
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,1265 @@
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 +[[image:PxR_InvoiceService_GetInvoiceInformationByBillNo20.png||alt="1573648586121-179.png"]]
585 +
586 +**Request parameters**
587 +
588 +(% class="table-bordered table-striped" %)
589 +|=(% colspan="4" %)(((
590 +==== GetInvoiceInformationByBillNo20Request ====
591 +)))
592 +|**Field**|**Datatype**|**Required**|**Description**
593 +|##BillNo##|String|Yes|
594 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
595 +|TraceId|String|Yes|
596 +
597 +**Response parameters**
598 +
599 +[[GetInvoinceInformation20Response>>||anchor="HGetInvoiceInformation20Response"]]
600 +
601 +**Error codes**
602 +
603 +(% class="table-bordered table-striped" %)
604 +|=(% colspan="4" %)(((
605 +==== Possible error codes from GetInvoinceInformationByBillNo20 ====
606 +)))
607 +|**Code**|**Name**|**Description**
608 +|##5080##|InvalidBillNo|BillNo does not match any valid invoices.
609 +
610 +== GetInvoiceInformationByBillNo21 ==
611 +
612 +**Request parameters**
613 +
614 +(% class="table-bordered table-striped" %)
615 +|=(% colspan="4" %)(((
616 +==== GetInvoiceInformationByBillNo21Request ====
617 +)))
618 +|**Field**|**Datatype**|**Required**|**Description**
619 +|##BillNo##|String|Yes|
620 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
621 +|TraceId|String|Yes|
622 +
623 +**Response parameters**
624 +
625 +[[GetInvoiceInformation21Response>>||anchor="HGetInvoiceInformation21Response"]]
626 +
627 +
628 +**Error codes**
629 +
630 +(% class="table-bordered table-striped" %)
631 +|=(% colspan="4" %)(((
632 +==== Possible error codes from GetInvoinceInformationByBillNo21 ====
633 +)))
634 +|**Code**|**Name**|**Description**
635 +|##5080##|InvalidBillNo|BillNo does not match any valid invoices.
636 +
637 +== GetInvoiceInformationByExternalInvoiceId20 ==
638 +
639 +**Class diagram**
640 +
641 +[[image:PxR_InvoiceService_GetOpenInvoiceInformationByExternalInvoiceId20.png||alt="1573822272252-854.png"]]
642 +
643 +**Request parameters**
644 +
645 +(% class="table-bordered table-striped" %)
646 +|=(% colspan="4" %)(((
647 +==== GetInvoiceInformationByExternalInvoiceId20Request ====
648 +)))
649 +|**Field**|**Datatype**|**Required**|**Description**
650 +|##ExternalInvoiceId##|String|Yes|
651 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
652 +|TraceId|String|Yes|
653 +
654 +**Response parameters**
655 +
656 +[[GetInvoinceInformation20Response>>||anchor="HGetInvoiceInformation20Response"]]
657 +
658 +**Error codes**
659 +
660 +(% class="table-bordered table-striped" %)
661 +|=(% colspan="4" %)(((
662 +==== Possible error codes from GetInvoinceInformationByExternalInvoiceId20 ====
663 +)))
664 +|**Code**|**Name**|**Description**
665 +|##5072##|InvalidExternalBillId|ExternalInvoiceId does not match any valid invoices.
666 +|5089|BillsNotFound|Invoice match but invoice not valid. May be older than 1 year.
667 +
668 +== GetInvoiceInformationByExternalInvoiceId21 ==
669 +
670 +[[image:PxR_InvoiceService_GetInvoiceInformationByExternalInvoiceId21.png]]
671 +
672 +**Request parameters**
673 +
674 +(% class="table-bordered table-striped" %)
675 +|=(% colspan="4" %)(((
676 +==== GetInvoiceInformationByExternalInvoiceId21Request ====
677 +)))
678 +|**Field**|**Datatype**|**Required**|**Description**
679 +|##ExternalInvoiceId##|String|Yes|
680 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
681 +|TraceId|String|Yes|
682 +
683 +**Response parameters**
684 +
685 +[[GetInvoinceInformation21Response>>||anchor="HGetInvoiceInformation21Response"]]
686 +
687 +**Error codes**
688 +
689 +(% class="table-bordered table-striped" %)
690 +|=(% colspan="4" %)(((
691 +==== Possible error codes from GetInvoinceInformationByExternalInvoiceId20 ====
692 +)))
693 +|**Code**|**Name**|**Description**
694 +|##5072##|InvalidExternalBillId|ExternalInvoiceId does not match any valid invoices.
695 +|5089|BillsNotFound|(((
696 +Invoice match but invoice not valid. May be older than 1 year.
697 +
698 +
699 +
700 +)))
701 +
702 +== GetInvoicePdfByBillNoExternalBillType10 ==
703 +
704 +**Class diagram**
705 +
706 +[[image:1573822789308-786.png||height="470" width="761"]]
707 +
708 +**Request parameters**
709 +
710 +(% class="table-bordered table-striped" %)
711 +|=(% colspan="4" %)(((
712 +==== GetInvoicePdfByBillNoExternalBillType10Request ====
713 +)))
714 +|**Field**|**Datatype**|**Required**|**Description**
715 +|##BillNo##|String|Yes|
716 +|ExternalBillType|String|Yes|(((
717 +Document type.
718 +Existing ExternalBillType can be retrived from GetInvoiceInformationByBillNo20 or GetInvoiceInformationByExternalInvoiceId20.
719 +)))
720 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
721 +|TraceId|String|Yes|
722 +
723 +**Response parameters**
724 +
725 +[[GetInvoicePDFResponse>>||anchor="HGetInvoicePDFResponse"]]
726 +
727 +**Error codes**
728 +
729 +(% class="table-bordered table-striped" %)
730 +|=(% colspan="4" %)(((
731 +==== GetInvoincePDFResponse ====
732 +)))
733 +|**Code**|**Name**|**Description**
734 +|##5046##|InvalidAccountType|Wrong account type. The requested bill number is not an invoice.
735 +|5080|InvalidBillNo|Invoice document not found.
736 +|5095|ExternalBillTypeCode|Invalid ExternalBillType.
737 +
738 +== ==
739 +
740 +== GetOpenInvoiceInformationByCustomerNo20 ==
741 +
742 +**Class diagram**
743 +
744 +[[image:PxR_InvoiceService_GetOpenInvoiceInformationByCustomerNo20.png||alt="1573825242764-218.png"]]
745 +
746 +**Request parameters**
747 +
748 +(% class="table-bordered table-striped" %)
749 +|=(% colspan="4" %)(((
750 +==== GetOpenInvoiceInformationByCustomerNo20Request ====
751 +)))
752 +|**Field**|**Datatype**|**Required**|**Description**
753 +|CustomerNo|String|Yes|
754 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
755 +|TraceId|String|Yes|
756 +
757 +**Response parameters**
758 +
759 +[[GetOpenInvoiceInformation20Response>>||anchor="HGetOpenInvoiceInformation20Response"]]
760 +
761 +
762 +
763 +== GetOpenInvoiceInformationByCustomerNo21 ==
764 +
765 +[[image:PxR_InvoiceService_GetOpenInvoiceInformationByCystomerNo21.png]]
766 +
767 +**Request parameters**
768 +
769 +(% class="table-bordered table-striped" %)
770 +|=(% colspan="4" %)(((
771 +==== GetOpenInvoiceInformationByCustomerNo21Request ====
772 +)))
773 +|**Field**|**Datatype**|**Required**|**Description**
774 +|CustomerNo|String|Yes|
775 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
776 +|TraceId|String|Yes|
777 +
778 +**Response parameters**
779 +
780 +[[GetOpenInvoiceInformation21Response>>||anchor="HGetOpenInvoiceInformation21Response"]]
781 +
782 +== ==
783 +
784 +== ==
785 +
786 +== GetOpenInvoiceInformationByRegNo20 ==
787 +
788 +**Class diagram**
789 +
790 +[[image:PxR_InvoiceService_GetOpenInvoiceInformationByRegNo20.png||alt="1573825242764-218.png"]]
791 +
792 +**Request parameters**
793 +
794 +(% class="table-bordered table-striped" %)
795 +|=(% colspan="4" %)(((
796 +==== GetOpenInvoiceInformationByRegNo20Request ====
797 +)))
798 +|**Field**|**Datatype**|**Required**|**Description**
799 +|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"]]
800 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
801 +|TraceId|String|Yes|
802 +
803 +**Response parameters**
804 +
805 +[[GetOpenInvoiceInformation20Response>>||anchor="HGetOpenInvoiceInformation20Response"]]
806 +
807 +== GetOpenInvoiceInformationByRegNo21 ==
808 +
809 +[[image:PxR_InvoiceService_GetOpenInvoiceInformationByRegNo21.png]]
810 +
811 +**Request parameters**
812 +
813 +(% class="table-bordered table-striped" %)
814 +|=(% colspan="4" %)(((
815 +==== GetOpenInvoiceInformationByRegNo21Request ====
816 +)))
817 +|**Field**|**Datatype**|**Required**|**Description**
818 +|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"]]
819 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
820 +|TraceId|String|Yes|
821 +
822 +**Response parameters**
823 +
824 +[[GetOpenInvoiceInformation21Response>>||anchor="HGetOpenInvoiceInformation21Response"]]
825 +
826 +== RegisterInvoicePSPPaymentByBillNo10 ==
827 +
828 +**Class diagram**
829 +
830 +[[image:1573825460421-413.png||height="460" width="778"]]
831 +
832 +**Request parameters**
833 +
834 +(% class="table-bordered table-striped" %)
835 +|=(% colspan="4" %)(((
836 +==== RegisterInvoicePSPPaymentByBillNoRequest ====
837 +)))
838 +|**Field**|**Datatype**|**Required**|**Description**
839 +|##BillNo##|String|Yes|
840 +|Amount|Decimal|Yes|
841 +|PaymentDate|DateTime|Yes|
842 +|SellerTransactionId|String(1-50)|Yes|
843 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
844 +|TraceId|String|Yes|
845 +
846 +**Response parameters**
847 +
848 +(% class="table-bordered table-striped" %)
849 +|=(% colspan="4" %)(((
850 +==== RegisterInvoicePSPPaymentByBillNoResponse ====
851 +)))
852 +|**Field**|**Datatype**|**Description**
853 +|##ResponseCode##|String|
854 +|##ResponseMessage##|String|
855 +|TraceId|String|
856 +
857 += =
858 +
859 +== GetOrderlinesByBillNo10 ==
860 +
861 +(% class="wikigeneratedid" %)
862 +Get all orderlines on a bill
863 +[[image:PxR_InvoiceService_GetOrderLinesByBillNo10.png]]
864 +
865 +**Request parameters**
866 +
867 +(% class="table-bordered table-striped" %)
868 +|=(% colspan="4" %)(((
869 +==== GetOrderlinesByBillNo10Request ====
870 +)))
871 +|**Field**|**Datatype**|**Required**|**Description**
872 +|##BillNo##|String|Yes|
873 +|##TrackingUserEMail##|String|Yes|User info for trackability.
874 +|TraceId|String|Yes|
875 +
876 +**Response parameters**
877 +
878 +(% class="table-bordered table-striped" %)
879 +|=(% colspan="3" %)(((
880 +==== GetOrderlinesByBillNo10Response ====
881 +)))
882 +|**Field**|**Datatype**|**Description**
883 +|(% style="font-family:monospace" %)##OrderLines##|List [[OrderLine>>doc:||anchor="HOrderline"]]|Array.
884 +|##ResponseCode##|String|
885 +|##ResponseMessage##|String|
886 +|##TraceId##|String|
887 +
888 +**Classes**
889 +
890 +(% class="table-bordered table-striped" %)
891 +|=(% colspan="3" %)(((
892 +==== Orderline ====
893 +)))
894 +|**Field**|**Datatype**|**Description**
895 +|(% style="font-family:monospace" %)AmountInclVat|Decimal|
896 +|(% style="font-family:monospace" %)Description|String|
897 +|(% style="font-family:monospace" %)ExternalReferenceId|String|
898 +|(% style="font-family:monospace" %)TransactionDate|DateTime|
899 +|(% style="font-family:monospace" %)##VatAmount##|Decimal|
900 +
901 +**Error codes**
902 +
903 +(% class="table-bordered table-striped" %)
904 +|=(% colspan="4" %)(((
905 +==== GetOrderlinesByBillNo10Response ====
906 +)))
907 +|**Code**|**Name**|**Description**
908 +|5080|InvalidBillNo|BillNo input is not valid or no matching bill found
909 +
910 +=
911 +\\CustomerService methods =
912 +
913 +The complete Wsdl specification for this service can be found at:
914 +[[https:~~/~~/connect.internaltest.payex.com/PxR/CustomerService.svc>>url:https://connect.internaltest.payex.com/PxR/CustomerService.svc]]
915 +
916 + (Username/password security model)
917 +
918 +== GetcustomerCurrentStateByCustomerNo ==
919 +
920 +Get information about current state of a customer.
921 +
922 +**Class diagram**
923 +
924 +
925 +
926 +[[image:7-class-diagram-external.png]]
927 +
928 +**Request parameters**
929 +
930 +(% class="table-bordered table-striped" %)
931 +|=(% colspan="4" %)(((
932 +==== GetCustomerCurrentStateByCustomerNoRequest ====
933 +)))
934 +|**Field**|**Datatype**|**Required**|**Description**
935 +|TraceId|String|Yes|
936 +|##CustomerNumber##|String(15)|Yes|
937 +|##TrackingUserEMail##|String|No|
938 +
939 +**Response parameters**
940 +
941 +(% class="table-bordered table-striped" %)
942 +|=(% colspan="3" %)(((
943 +==== GetCustomerCurrentStateByCustomerNoResponse ====
944 +)))
945 +|**Field**|**Datatype**|**Description**
946 +|(% style="font-family:monospace" %)##CustomerConsents##|[[CustomerConsent>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerConsent"]]|Array.
947 +|##CustomerInfo##|[[CustomerInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerInfo"]]|
948 +|##CustomerNo##|String|
949 +|##CustomerStatus##|[[CustomerStatus>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerStatus"]]|Array.
950 +
951 +**Classes**
952 +
953 +(% class="table-bordered table-striped" %)
954 +|=(% colspan="3" %)(((
955 +==== CustomerConsent ====
956 +)))
957 +|**Field**|**Datatype**|**Description**
958 +|(% style="font-family:monospace" %)##ConsentTypeCode##|Int|See the [[consent type codes>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HConsenttypecodes"]] table for available consent type codes.
959 +
960 +(% class="table-bordered table-striped" %)
961 +|=(% colspan="3" %)(((
962 +==== CustomerInfo ====
963 +)))
964 +|**Field**|**Datatype**|**Description**
965 +|(% style="font-family:monospace" %)##Name##|String|
966 +|##DistributionAddressInfo##|[[DistributionAddressInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HDistributionAddressInfo"]]|
967 +|##Language##|String|
968 +|##LegalEntityCode##|Int|See the [[legal entity codes table>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HLegalentitycodes"]] for available legal entity codes.
969 +|##VatNo##|String|
970 +|##Category##|String|Customer Category
971 +
972 +(% class="table-bordered table-striped" %)
973 +|=(% colspan="3" %)(((
974 +==== CustomerStatus ====
975 +)))
976 +|**Field**|**Datatype**|**Description**
977 +|(% style="font-family:monospace" %)##CustomerStatusTypeCode##|Int|[[See code specification.>>||anchor="HCustomerStatustypecodes"]]
978 +
979 +(% class="table-bordered table-striped" %)
980 +|=(% colspan="4" %)(((
981 +==== DistributionAddressInfo ====
982 +)))
983 +|**Field**|**Datatype**|**Required**|**Description**
984 +|(% style="font-family:monospace" %)##Addresses##|Array|Yes|See [[address>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HAddress"]].
985 +|##EMailAddress##|String|No|
986 +|##Cellphone##|String|No|
987 +
988 +(% class="table-bordered table-striped" %)
989 +|=(% colspan="4" %)(((
990 +==== Address ====
991 +)))
992 +|**Field**|**Datatype**|**Required**|**Description**
993 +|(% style="font-family:monospace" %)Addressee|String(72)|Yes|
994 +|##StreetAdress##|String(35)|No|
995 +|##ZipCode##|String(9)|Yes|
996 +|##City##|String(27)|Yes|
997 +|##CoAddress##|String(35)|No|
998 +|##CountryCode##|String(2)|Yes|
999 +|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.
1000 +
1001 +== GetCustomerCurrentStateByRegNo10 ==
1002 +
1003 +**Class diagram**
1004 +
1005 +[[image:1574422177227-663.png||height="671" width="1146"]]
1006 +
1007 +**Request parameters**
1008 +
1009 +(% class="table-bordered table-striped" %)
1010 +|=(% colspan="4" %)(((
1011 +==== GetCustomerCurrentStateByRegNo10Request ====
1012 +)))
1013 +|**Field**|**Datatype**|**Required**|**Description**
1014 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|Yes|
1015 +|##TrackingUserEMail##|String|Yes|
1016 +|TraceId|String|Yes|
1017 +
1018 +**Response parameters**
1019 +
1020 +(% class="table-bordered table-striped" %)
1021 +|=(% colspan="3" %)(((
1022 +==== GetCustomerCurrentStateByRegNo10Response ====
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 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
1030 +
1031 +(% id="HAppendix1SharedClasses" %)
1032 += Appendix 1 Shared Classes =
1033 +
1034 +
1035 +**Response parameters**
1036 +
1037 +(% class="table-bordered table-striped" %)
1038 +|=(% colspan="3" %)(((
1039 +==== GetInvoicePDFResponse ====
1040 +)))
1041 +|**Field**|**Datatype**|**Description**
1042 +|##Pdf##|Byte[]|
1043 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
1044 +|##CustomerNo##|String|
1045 +|##ResponseCode##|String|
1046 +|##ResponseMessage##|String|
1047 +|##TraceId##|String|
1048 +
1049 +(% class="table-bordered table-striped" style="width:1595px" %)
1050 +|=(% colspan="3" style="width: 1591px;" %)(((
1051 +==== GetInvoiceInformationResponse ====
1052 +)))
1053 +|(% style="width:700px" %)**Field**|(% style="width:400px" %)**Datatype**|(% style="width:493px" %)**Description**
1054 +|(% 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" %)
1055 +|(% style="width:700px" %)##CustomerNo##|(% style="width:400px" %)String|(% style="width:493px" %)
1056 +|(% 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" %)
1057 +|(% style="width:700px" %)##ResponseCode##|(% style="width:400px" %)String|(% style="width:493px" %)
1058 +|(% style="width:700px" %)##ResponseMessage##|(% style="width:400px" %)String|(% style="width:493px" %)
1059 +|(% style="width:700px" %)##TraceId##|(% style="width:400px" %)String|(% style="width:493px" %)
1060 +
1061 +(% class="table-bordered table-striped" %)
1062 +|=(% colspan="3" %)(((
1063 +==== Invoice ====
1064 +)))
1065 +|**Field**|**Datatype**|**Description**
1066 +|##PaymentReference##|String|
1067 +|##BillNo##|String|
1068 +|##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.
1069 +|##ExternalInvoiceId##|String|
1070 +|##ExternalReference##|String|
1071 +|##SellerNo##|String|
1072 +|##BillDate##|DateTime|
1073 +|##DueDate##|DateTime (Optional)|
1074 +|##OriginalAmount##|Decimal|
1075 +|##Interest##|[[Interest>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInterest"]]|
1076 +|##CurrentBalanceList##|List <[[Balance>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBalance"]]>|
1077 +|##CurrencyCode##|String|
1078 +|##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.
1079 +|##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.
1080 +|##PaymentBankAccount##|[[PaymentBankAccount>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HPaymentBankAccount"]]|
1081 +|##PaymentType##|String|
1082 +|##ActiveRespite##|[[ActiveRespite>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActiveRespite"]]|
1083 +|##ActivePaymentOrder##|[[ActivePaymentOrder>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActivePaymentOrder"]]|
1084 +|##BillId##|Long|
1085 +|##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.
1086 +|##InvoiceHistory##|List <[[InvoiceHistory>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoiceHistory"]]>|
1087 +
1088 +(% class="table-bordered table-striped" %)
1089 +|=(% colspan="3" %)(((
1090 +==== PaymentBankAccount21 inherit [[PaymentBankAccount>>||anchor="HPaymentBankAccount"]] ====
1091 +)))
1092 +|**Field**|**Datatype**|**Description**
1093 +| | |
1094 +
1095 +(% class="table-bordered table-striped" %)
1096 +|=(% colspan="3" %)(((
1097 +==== PaymentBankAccount ====
1098 +)))
1099 +|**Field**|**Datatype**|**Description**
1100 +|##BankAccountNo##|String|
1101 +|##BankAccountType##|String|
1102 +|##BIC##|String|
1103 +|##IBAN##|String|
1104 +|PaymentTypeName|String|
1105 +
1106 +(% class="table-bordered table-striped" %)
1107 +|=(% colspan="3" %)(((
1108 +==== ActiveRespite ====
1109 +)))
1110 +|**Field**|**Datatype**|**Description**
1111 +|##RespiteValidToDate##|DateTime|
1112 +|##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.
1113 +
1114 +(% class="table-bordered table-striped" %)
1115 +|=(% colspan="3" %)(((
1116 +==== InvoiceHistory ====
1117 +)))
1118 +|**Field**|**Datatype**|**Description**
1119 +|BillDate|DateTime|
1120 +|BillId|long|
1121 +|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.
1122 +
1123 +(% class="table-bordered table-striped" %)
1124 +|=(% colspan="3" %)(((
1125 +==== GetClosedInvoiceInformation21Response ====
1126 +)))
1127 +|**Field**|**Datatype**|**Description**
1128 +|CompanyNo|String|
1129 +|CustomerNo|string|
1130 +|CustomerName|String|
1131 +|InvoiceList|List<[[ClosedInvoice21>>||anchor="HClosedInvoice21"]]>|See [[ClosedInvoice21>>||anchor="HClosedInvoice21"]]
1132 +
1133 +(% class="table-bordered table-striped" %)
1134 +|=(% colspan="3" %)(((
1135 +==== GetOpenInvoiceInformation21Response ====
1136 +)))
1137 +|**Field**|**Datatype**|**Description**
1138 +|CompanyNo|String|
1139 +|CustomerNo|string|
1140 +|CustomerName|String|
1141 +|InvoiceList|List<[[OpenInvoice21>>doc:||anchor="HOpenInvoice21inheritClosedInvoice21"]]>|
1142 +
1143 +(% class="table-bordered table-striped" %)
1144 +|=(% colspan="3" %)(((
1145 +==== GetInvoiceInformation21Response ====
1146 +)))
1147 +|**Field**|**Datatype**|**Description**
1148 +|CompanyNo|String|
1149 +|RegNo|[[RegNo>>doc:||anchor="HRegNo"]]|
1150 +|CustomerNo|string|
1151 +|CustomerName|String|
1152 +|InvoiceList|List<[[InvoiceInformation21>>doc:||anchor="HInvoiceInformation21inheritOpenInvoice21"]]>|
1153 +
1154 +(% class="table-bordered table-striped" %)
1155 +|=(% colspan="3" %)(((
1156 +==== ClosedInvoice21 ====
1157 +)))
1158 +|**Field**|**Datatype**|**Description**
1159 +|CurrencyCode|String|
1160 +|BillNo|string|
1161 +|BillStatusCode|Int|
1162 +|ExternalInvoiceId|String|
1163 +|BillDate|DateTime|
1164 +|DueDate|DateTime|
1165 +|ExternalBillType|String|
1166 +|OriginalAmount|Decimal|
1167 +|SellerName|String|
1168 +|SellerNo|String|
1169 +|InvoiceProfileType|String|The invoice profile type code
1170 +|InvoiceAlias|String|User friendly name of the invoice profile type
1171 +
1172 +(% class="table-bordered table-striped" %)
1173 +|=(% colspan="4" %)(((
1174 +==== OpenInvoice21 inherit [[ClosedInvoice21>>||anchor="HClosedInvoice21"]] ====
1175 +)))
1176 +|**Field**|**Datatype**| |**Description**
1177 +|CurrentDebt|Decimal| |
1178 +|PaymentBankAccount|[[PaymentBankAccount21>>doc:||anchor="HPaymentBankAccount21inheritPaymentBankAccount"]]| |
1179 +|PaymentType|String| |
1180 +|ActiveRespite|[[ActiveRespite21>>||anchor="HActiveRespite21"]]| |
1181 +|ActivePaymentOrder|[[ActivePaymentOrder>>||anchor="HActivePaymentOrder"]]| |
1182 +|PaymentReference|String| |
1183 +|ExportedToCollection|Bool| |
1184 +|{{{ExportedToCollectionDate}}}|DateTime| |(((
1185 +
1186 +)))
1187 +
1188 +​​​​​​
1189 +
1190 +(% class="table-bordered table-striped" %)
1191 +|=(% colspan="3" %)(((
1192 +==== InvoiceInformation21 inherit [[OpenInvoice21>>doc:||anchor="HOpenInvoice21inheritClosedInvoice21"]] ====
1193 +)))
1194 +|**Field**|**Datatype**|**Description**
1195 +|PenaltyInterest|[[Interest>>url:https://developer.payex.com/xwiki/wiki/developer/view/Main/Invoicing/invoice-service/Technical%20reference/PayEx%20Connect%20%28API%29/ExternalServicesmanual/#HInterest]]|
1196 +|CurrentBalance|List<[[Balance>>||anchor="HBalance"]]>|
1197 +
1198 +(% class="table-bordered table-striped" %)
1199 +|=(% colspan="3" %)(((
1200 +==== GetClosedInvoiceInformation20Response ====
1201 +)))
1202 +|**Field**|**Datatype**|**Description**
1203 +|CompanyNo|String|
1204 +|CustomerNo|string|
1205 +|CustomerName|String|
1206 +|InvoiceList|List<[[ClosedInvoice20>>||anchor="HClosedInvoice20"]]>|See [[ClosedInvoice20>>||anchor="HClosedInvoice20"]]
1207 +
1208 +(% class="table-bordered table-striped" %)
1209 +|=(% colspan="3" %)(((
1210 +==== ClosedInvoice20 ====
1211 +)))
1212 +|**Field**|**Datatype**|**Description**
1213 +|CurrencyCode|String|
1214 +|BillNo|string|
1215 +|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.
1216 +|ExternalInvoiceId|String|
1217 +|BillDate|DateTime|
1218 +|DueDate|DateTime|
1219 +|ExternalBillType|String|
1220 +|OriginalAmount|Decimal|
1221 +|SellerName|String|
1222 +|SellerNo|String|
1223 +
1224 +(% class="table-bordered table-striped" %)
1225 +|=(% colspan="3" %)(((
1226 +==== GetOpenInvoiceInformation20Response ====
1227 +)))
1228 +|**Field**|**Datatype**|**Description**
1229 +|CompanyNo|String|
1230 +|CustomerNo|string|
1231 +|CustomerName|String|
1232 +|InvoiceList|List<[[OpenInvoice20>>doc:||anchor="HOpenInvoice20inheritClosedInvoice20"]]>|
1233 +
1234 +(% class="table-bordered table-striped" %)
1235 +|=(% colspan="3" %)(((
1236 +==== InvoiceInformation20 inherit [[OpenInvoice20>>||anchor="HOpenInvoice20inheritClosedInvoice20"]] ====
1237 +)))
1238 +|**Field**|**Datatype**|**Description**
1239 +|PenaltyInterest|[[Interest>>url:https://developer.payex.com/xwiki/wiki/developer/view/Main/Invoicing/invoice-service/Technical%20reference/PayEx%20Connect%20%28API%29/ExternalServicesmanual/#HInterest]]|
1240 +|CurrentBalance|List<[[Balance>>||anchor="HBalance"]]>|
1241 +|InvoiceHistory|List<[[InvoiceHistory20>>||anchor="HInvoiceHistory20"]]>|
1242 +
1243 +(% class="table-bordered table-striped" %)
1244 +|=(% colspan="3" %)(((
1245 +==== InvoiceHistory20 ====
1246 +)))
1247 +|**Field**|**Datatype**|**Description**
1248 +|BillDate|DateTime|
1249 +|ExternalBillType|String|
1250 +|BillAmount|Decimal|
1251 +
1252 +(% class="table-bordered table-striped" style="width:1186px" %)
1253 +|=(% colspan="3" style="width: 1183px;" %)(((
1254 +==== OpenInvoice20 inherit [[ClosedInvoice20>>||anchor="HClosedInvoice20"]] ====
1255 +)))
1256 +|**Field**|**Datatype**|(% style="width:155px" %)**Description**
1257 +|CurrentDebt|Decimal|(% style="width:155px" %)
1258 +|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" %)
1259 +|PaymentType|String|(% style="width:155px" %)
1260 +|ActiveRespite|[[ActiveRespite20>>||anchor="HActiveRespite20"]]|(% style="width:155px" %)
1261 +|ActivePaymentOrder|[[ActivePaymentOrder>>||anchor="HActivePaymentOrder"]]|(% style="width:155px" %)
1262 +|PaymentReference|String|(% style="width:155px" %)
1263 +|ExportedToCollection|Bool|(% style="width:155px" %)
1264 +
1265 +{{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.rae
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_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.rae
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