Changes for page ExternalServicesmanual

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