Changes for page ExternalServicesmanual

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