Changes for page ExternalServicesmanual

Last modified by Fredrik Nilsson on 2021/06/29 16:53
From empty
To version 98.1
edited by Rasmus Enekvist
on 2020/01/17 13:55
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.rae
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Tags
... ... @@ -1,0 +1,1 @@
1 +px-custom-page-content
Content
... ... @@ -1,0 +1,1399 @@
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 +== AddPaymentOrderOnDueDate ==
269 +
270 +Add paymentorder to an open invoice.
271 +
272 +**Class diagram**
273 +[[image:PxR_InvoiceService_AddPaymentOrderOnDueDateRequest.png]]
274 +**Request parameters**
275 +
276 +(% class="table-bordered table-striped" %)
277 +|=(% colspan="4" %)(((
278 +==== AddPaymentOrderOnDueDate ====
279 +)))
280 +|**Field**|**Datatype**|**Required**|**Description**
281 +|##BillNo##|String(15)|Yes|Bill Number.
282 +|CompanyNo|String(15)|Yes|Company number
283 +|##TrackingUserEMail##|String(1-256)|Yes|User info for trackability.
284 +|##TraceId##|String|Yes|
285 +
286 +**Response parameters**
287 +
288 +(% class="table-bordered table-striped" %)
289 +|=(% colspan="4" %)(((
290 +==== AddPaymentOrderOnDueDate ====
291 +)))
292 +|**Field**|**Datatype**|**Description**
293 +|##ResponseCode##|String|
294 +|##ResponseMessage##|String|
295 +|##TraceId##|String|
296 +
297 +**Error codes**
298 +
299 +(% class="table-bordered table-striped" %)
300 +|=(% colspan="4" %)(((
301 +==== GetCustomerCurrentStateByCustomerNoResponse ====
302 +)))
303 +|**Code**|**Name**|**Description**
304 +|##5080##|InvalidBillNo|No bill found with billNo and companyNo
305 +|##5114##|ConsentNotFoundException|Customer has no active consent for us to create payment order
306 +
307 +== ==
308 +
309 +== ConvertInvoiceToAccount10 ==
310 +
311 +Convert an invoice account to a credit account.
312 +
313 +**Class diagram**
314 +
315 +[[image:1573569373687-299.png||height="324" width="739"]]
316 +
317 +**Request parameters**
318 +
319 +(% class="table-bordered table-striped" %)
320 +|=(% colspan="4" %)(((
321 +==== ConvertInvoiceToAccount10Request ====
322 +)))
323 +|**Field**|**Datatype**|**Required**|**Description**
324 +|##BillNo##|String(15)|Yes|Bill Number.
325 +|##TrackingUserEMail##|String(1-256)|Yes|User info for trackability.
326 +|##TraceId##|String|Yes|
327 +
328 +**Response parameters**
329 +
330 +(% class="table-bordered table-striped" %)
331 +|=(% colspan="4" %)(((
332 +==== ConvertInvoiceToAccount10Response ====
333 +)))
334 +|**Field**|**Datatype**|**Description**
335 +|##ResponseCode##|String|
336 +|##ResponseMessage##|String|
337 +|##TraceId##|String|
338 +
339 +== DeletePaymentOrder ==
340 +
341 +Abort a PaymentOrder for billNo
342 +
343 +**Class diagram**
344 +
345 +[[image:PxR_InvoiceService_DeletePaymentOrder.png||height="174" width="1267"]]
346 +
347 +
348 +**Request parameters**
349 +
350 +(% class="table-bordered table-striped" %)
351 +|=(% colspan="4" %)(((
352 +==== DeletePaymentOrderRequest ====
353 +)))
354 +|**Field**|**Datatype**|**Required**|**Description**
355 +|##BillNo##|String|Yes|Bill to match paymentorder.
356 +|CompanyNo|String |Yes|Company number
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 +==== DeletePaymentOrderResponse ====
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 +==== DeletePaymentOrderResponse ====
376 +)))
377 +|**Code**|**Name**|**Description**
378 +|##5080##|InvalidBillNo|BillNo is invalid
379 +|##5115##|PaymentOrderNotFound|Found no paymentorders connected to bill
380 +|##5116##|DeletePaymentOrderNotAllowed|Found paymentOrder but are not allowed to Delete since the paymentorder has begun/finished processing
381 +
382 +== RegisterInvoiceDirectPaymentByBillNo10 ==
383 +
384 +Register a direct payment on given invoice.
385 +
386 +**Class diagram**
387 +
388 +[[image:1573570140844-820.png||height="384" width="715"]]
389 +
390 +**Request parameters**
391 +
392 +(% class="table-bordered table-striped" %)
393 +|=(% colspan="4" %)(((
394 +==== RegisterInvoiceDirectPaymentByBillNo10Request ====
395 +)))
396 +|**Field**|**Datatype**|**Required**|**Description**
397 +|##Amount##|Decimal|Yes|DirectPayment Amount.
398 +|##BillNo##|String|Yes|Bill to match payment to.
399 +|##PaymentDate##|DateTime|Yes|Date when payment occured.
400 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
401 +|TraceId|String|Yes|
402 +
403 +**Response parameters**
404 +
405 +(% class="table-bordered table-striped" %)
406 +|=(% colspan="4" %)(((
407 +==== RegisterInvoiceDirectPaymentByBillNo10Response ====
408 +)))
409 +|**Field**|**Datatype**|**Description**
410 +|##ResponseCode##|String|
411 +|##ResponseMessage##|String|
412 +|##TraceId##|String|
413 +
414 +**Error codes**
415 +
416 +(% class="table-bordered table-striped" %)
417 +|=(% colspan="4" %)(((
418 +==== GetCustomerCurrentStateByCustomerNoResponse ====
419 +)))
420 +|**Code**|**Name**|**Description**
421 +|##5080##|InvalidBillNo|BillNo is invalid
422 +|##1207##|InvalidAmount|Amount is invalid
423 +|##5074##|InvalidDate|PaymentDate is not within a valid date
424 +
425 +== AddInvoiceCopyOrderByBillNo10 ==
426 +
427 +Order a copy of the invoice to be delivered.
428 +
429 +**Class diagram**
430 +
431 +[[image:1573631474317-399.png||height="349" width="795"]]
432 +
433 +**Request parameters**
434 +
435 +(% class="table-bordered table-striped" %)
436 +|=(% colspan="4" %)(((
437 +==== AddInvoiceCopyOrderByBillNo10Request ====
438 +)))
439 +|**Field**|**Datatype**|**Required**|**Description**
440 +|##BillNo##|String|Yes|
441 +|##DistributionMethod##|String|Yes|
442 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
443 +|TraceId|String|Yes|
444 +
445 +**Response parameters**
446 +
447 +(% class="table-bordered table-striped" %)
448 +|=(% colspan="4" %)(((
449 +==== RegisterInvoiceDirectPaymentByBillNo10Response ====
450 +)))
451 +|**Field**|**Datatype**|**Description**
452 +|##ResponseCode##|String|
453 +|##ResponseMessage##|String|
454 +|##TraceId##|String|
455 +
456 +**Error codes**
457 +
458 +(% class="table-bordered table-striped" %)
459 +|=(% colspan="4" %)(((
460 +==== GetCustomerCurrentStateByCustomerNoResponse ====
461 +)))
462 +|**Code**|**Name**|**Description**
463 +|##5089##|BillsNotFound|Found no matching Invoices for BillNo
464 +
465 +== GetClosedInvoiceInformationByCustomerNo20 ==
466 +
467 +Get information about a customer's closed invoice(s) by customer number.
468 +
469 +**Class diagram**
470 +[[image:1573632921277-742.png||height="509" width="841"]]
471 +
472 +**Request parameters**
473 +
474 +(% class="table-bordered table-striped" %)
475 +|=(% colspan="4" %)(((
476 +==== GetClosedInvoiceInformationByCustomerNo20Request ====
477 +)))
478 +|**Field**|**Datatype**|**Required**|**Description**
479 +|##CustomerNo##|String|Yes|
480 +|##TrackingUserEmail##|String|Yes|User info for trackability.
481 +|TraceId| |yes|
482 +
483 +**Response parameters**
484 +
485 +**[[GetClosedInvoiceInformation20Response>>||anchor="HGetClosedInvoiceInformation20Response"]]**
486 +
487 +== GetClosedInvoiceInformationByRegNo20 ==
488 +
489 +Get information about a customer's closed invoice(s) by social security number.
490 +
491 +**Class diagram**
492 +
493 +[[image:1573646248641-666.png||height="508" width="807"]]
494 +
495 +**Request parameters**
496 +
497 +(% class="table-bordered table-striped" %)
498 +|=(% colspan="4" %)(((
499 +==== GetClosedInvoiceInformationByRegNo20Request ====
500 +)))
501 +|**Field**|**Datatype**|**Required**|**Description**
502 +|##RegNo##|[[RegNo>>||anchor="HRegNo"]]|Yes|See [[RegNo>>||anchor="HRegNo"]]
503 +|##TrackingUserEmail##|String|Yes|User info for trackability.
504 +|TraceId| |yes|
505 +
506 +**Response parameters**
507 +
508 +**[[GetClosedInvoiceInformation20Response>>||anchor="HGetClosedInvoiceInformation20Response"]]**
509 +
510 +**Error codes**
511 +
512 +(% class="table-bordered table-striped" %)
513 +|=(% colspan="4" %)(((
514 +==== GetClosedInvoiceInformation20Response ====
515 +)))
516 +|**Code**|**Name**|**Description**
517 +|##5006##|ExpectedCustomerNumber|Found multiple customer on RegNo, use CustomerNo instead.
518 +|5075|MissingAccountForBill|Found no matching customer for RegNo.
519 +|1024|ErrorInvalidRegNo|Invalid RegNo format.
520 +
521 +== GetInvoiceInformationByBillNo20 ==
522 +
523 +**Class diagram**
524 +
525 +[[image:1573648586121-179.png||height="582" width="1172"]]
526 +
527 +**Request parameters**
528 +
529 +(% class="table-bordered table-striped" %)
530 +|=(% colspan="4" %)(((
531 +==== GetInvoiceInformationByBillNo20Request ====
532 +)))
533 +|**Field**|**Datatype**|**Required**|**Description**
534 +|##BillNo##|String|Yes|
535 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
536 +|TraceId|String|Yes|
537 +
538 +**Response parameters**
539 +
540 +[[GetInvoinceInformation20Response>>||anchor="HGetInvoiceInformation20Response"]]
541 +
542 +**Error codes**
543 +
544 +(% class="table-bordered table-striped" %)
545 +|=(% colspan="4" %)(((
546 +==== GetInvoinceInformation20Response ====
547 +)))
548 +|**Code**|**Name**|**Description**
549 +|##5072##|InvalidExternalBillId|ExternalInvoiceId does not match any valid invoices.
550 +|5089|BillsNotFound|Invoice match but invoice not valid. May be older than 1 year.
551 +
552 +== GetInvoiceInformationByExternalInvoiceId20 ==
553 +
554 +**Class diagram**
555 +
556 +[[image:1573822272252-854.png||height="581" width="1220"]]
557 +
558 +**Request parameters**
559 +
560 +(% class="table-bordered table-striped" %)
561 +|=(% colspan="4" %)(((
562 +==== GetInvoiceInformationByExternalInvoiceId20Request ====
563 +)))
564 +|**Field**|**Datatype**|**Required**|**Description**
565 +|##ExternalInvoiceId##|String|Yes|
566 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
567 +|TraceId|String|Yes|
568 +
569 +**Response parameters**
570 +
571 +[[GetInvoinceInformation20Response>>||anchor="HGetInvoiceInformation20Response"]]
572 +
573 +**Error codes**
574 +
575 +(% class="table-bordered table-striped" %)
576 +|=(% colspan="4" %)(((
577 +==== GetInvoinceInformation20Response ====
578 +)))
579 +|**Code**|**Name**|**Description**
580 +|##5072##|InvalidExternalBillId|ExternalInvoiceId does not match any valid invoices.
581 +|5089|BillsNotFound|Invoice match but invoice not valid. May be older than 1 year.
582 +
583 +== GetInvoicePdfByBillNoExternalBillType10 ==
584 +
585 +**Class diagram**
586 +
587 +[[image:1573822789308-786.png||height="470" width="761"]]
588 +
589 +**Request parameters**
590 +
591 +(% class="table-bordered table-striped" %)
592 +|=(% colspan="4" %)(((
593 +==== GetInvoicePdfByBillNoExternalBillType10Request ====
594 +)))
595 +|**Field**|**Datatype**|**Required**|**Description**
596 +|##BillNo##|String|Yes|
597 +|ExternalBillType|String|Yes|(((
598 +Document type.
599 +Existing ExternalBillType can be retrived from GetInvoiceInformationByBillNo20 or GetInvoiceInformationByExternalInvoiceId20.
600 +)))
601 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
602 +|TraceId|String|Yes|
603 +
604 +**Response parameters**
605 +
606 +[[GetInvoicePDFResponse>>||anchor="HGetInvoicePDFResponse"]]
607 +
608 +**Error codes**
609 +
610 +(% class="table-bordered table-striped" %)
611 +|=(% colspan="4" %)(((
612 +==== GetInvoincePDFResponse ====
613 +)))
614 +|**Code**|**Name**|**Description**
615 +|##5046##|InvalidAccountType|Wrong account type. The requested bill number is not an invoice.
616 +|5080|InvalidBillNo|Invoice document not found.
617 +|5095|ExternalBillTypeCode|Invalid ExternalBillType.
618 +
619 +(% class="wikigeneratedid" %)
620 +== ==
621 +
622 +== GetOpenInvoiceInformationByCustomerNo20 ==
623 +
624 +**Class diagram**
625 +
626 +[[image:1573825242764-218.png||height="661" width="1066"]]
627 +
628 +**Request parameters**
629 +
630 +(% class="table-bordered table-striped" %)
631 +|=(% colspan="4" %)(((
632 +==== GetInvoicePdfByBillNoExternalBillType10Request ====
633 +)))
634 +|**Field**|**Datatype**|**Required**|**Description**
635 +|CustomerNo|String|Yes|
636 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
637 +|TraceId|String|Yes|
638 +
639 +**Response parameters**
640 +
641 +[[GetOpenInvoiceInformation20Response>>||anchor="HGetOpenInvoiceInformation20Response"]]
642 +
643 +(% class="wikigeneratedid" %)
644 +== ==
645 +
646 +(% class="wikigeneratedid" %)
647 +== ==
648 +
649 +== GetOpenInvoiceInformationByRegNo20 ==
650 +
651 +**Class diagram**
652 +
653 +[[image:1573825242764-218.png||height="661" width="1066"]]
654 +
655 +**Request parameters**
656 +
657 +(% class="table-bordered table-striped" %)
658 +|=(% colspan="4" %)(((
659 +==== GetInvoicePdfByBillNoExternalBillType10Request ====
660 +)))
661 +|**Field**|**Datatype**|**Required**|**Description**
662 +|RegNo|RegNo|Yes|
663 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
664 +|TraceId|String|Yes|
665 +
666 +**Response parameters**
667 +
668 +[[GetOpenInvoiceInformation20Response>>||anchor="HGetOpenInvoiceInformation20Response"]]
669 +
670 +== RegisterInvoicePSPPaymentByBillNo10 ==
671 +
672 +**Class diagram**
673 +
674 +[[image:1573825460421-413.png||height="460" width="778"]]
675 +
676 +**Request parameters**
677 +
678 +(% class="table-bordered table-striped" %)
679 +|=(% colspan="4" %)(((
680 +==== RegisterInvoicePSPPaymentByBillNoRequest ====
681 +)))
682 +|**Field**|**Datatype**|**Required**|**Description**
683 +|##BillNo##|String|Yes|
684 +|Amount|Decimal|Yes|
685 +|PaymentDate|DateTime|Yes|
686 +|SellerTransactionId|String|Yes|
687 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
688 +|TraceId|String|Yes|
689 +
690 +**Response parameters**
691 +
692 +(% class="table-bordered table-striped" %)
693 +|=(% colspan="4" %)(((
694 +==== RegisterInvoicePSPPaymentByBillNoResponse ====
695 +)))
696 +|**Field**|**Datatype**|**Description**
697 +|##ResponseCode##|String|
698 +|##ResponseMessage##|String|
699 +|TraceId|String|
700 +
701 += CreditAccount Service methods =
702 +
703 +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]]
704 +
705 +(Username/password security model)
706 +
707 +
708 +== GetBillingAccountCurrentStateByBillingAccountNo10 ==
709 +
710 +**Class diagram**
711 +
712 +[[image:1574423356546-688.png||height="954" width="923"]]
713 +
714 +**Request parameters**
715 +
716 +(% class="table-bordered table-striped" %)
717 +|=(% colspan="4" %)(((
718 +==== GetBillingAccountCurrentStateByBillingAccountNo10Request ====
719 +)))
720 +|**Field**|**Datatype**|**Required**|**Description**
721 +|##BillingAccountNo##|String(15)|Yes|
722 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
723 +|TraceId|String|Yes|
724 +
725 +**Response parameters**
726 +
727 +
728 +(% class="table-bordered table-striped" %)
729 +|=(% colspan="3" %)(((
730 +==== GetBillingAccountCurrentStateByBillingAccountNo10Response ====
731 +)))
732 +|**Field**|**Datatype**|**Description**
733 +|##CompanyNo##|String|
734 +|BillingAccount|[[BillingAccountDetail>>||anchor="HBillingAccountDetail"]]|
735 +|ResponseCode|String|
736 +|ResponseMessage|String|
737 +|TraceId|String|
738 +
739 +**Classes**
740 +
741 +(% class="table-bordered table-striped" %)
742 +|=(% colspan="3" %)(((
743 +==== BillingAccountDetail ====
744 +)))
745 +|**Field**|**Datatype**|**Description**
746 +|##BillingAccountNo##|String|
747 +|BillingAccountAlias|String|
748 +|Description|String|
749 +|OpenBill|[[BillDetail>>||anchor="HBillDetail"]]|
750 +|PaymentBankAccount|[[PaymentBankAccount20>>||anchor="HPaymentBankAccount20inheritPaymentBankAccount"]]|
751 +|PaymentReference|String|
752 +|ClosedBillHistoryList|List<[[BillHistory>>||anchor="HBillHistory"]]>|
753 +|CreditAccountList|List<[[CreditAccount>>||anchor="HCreditAccount"]]>|
754 +|CurrentBillingAccountDebt|Decimal|
755 +|CurrentBillingAccountAndCreditAccountDebt|Decimal|
756 +|CurrencyCode|String|
757 +|StartDate|DateTime|
758 +|PenaltyInterest|[[Intrest>>||anchor="HIntrest"]]|
759 +
760 +(% class="table-bordered table-striped" %)
761 +|=(% colspan="3" %)(((
762 +==== CreditAccount ====
763 +)))
764 +|**Field**|**Datatype**|**Description**
765 +|##CreditAccountNo##|String|
766 +|Description|String|
767 +|StartDate|DateTime|
768 +|CreditAccountAlias|String|
769 +|CurrentBalanceList|List<[[Balance>>||anchor="HBalance"]]>|
770 +|AccountLimit|Decimal|
771 +|DebtInterest|[[Intrest>>||anchor="HIntrest"]]|
772 +
773 +**Error codes**
774 +
775 +(% class="table-bordered table-striped" %)
776 +|=(% colspan="3" %)(((
777 +==== GetBillingAccountCurrentStateByBillingAccountNo10Response ====
778 +)))
779 +|**Code**|**Name**|**Description**
780 +|##5028##|MissingAccountForBillingAccount|Cant find BillingAccount in this company.
781 +
782 +== GetBillPdfByBillNoExternalBillType10 ==
783 +
784 +**Class diagram**
785 +
786 +[[image:1574426401088-684.png||height="403" width="812"]]
787 +
788 +**Request parameters**
789 +
790 +(% class="table-bordered table-striped" %)
791 +|=(% colspan="4" %)(((
792 +==== GetBillPdfByBillNoExternalBillType10Request ====
793 +)))
794 +|**Field**|**Datatype**|**Required**|**Description**
795 +|##BillNo##|String|Yes|
796 +|ExternalBillType|String|Yes|
797 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
798 +|TraceId|String|Yes|
799 +
800 +**Response parameters**
801 +
802 +[[GetInvoicePdfResponse>>||anchor="HGetInvoicePDFResponse"]]
803 +
804 +== GetClosedBillingAccountByRegNo10 ==
805 +
806 +**Class diagram**
807 +
808 +[[image:1574426572366-122.png||height="369" width="884"]]
809 +
810 +**Request parameters**
811 +
812 +(% class="table-bordered table-striped" %)
813 +|=(% colspan="4" %)(((
814 +==== GetClosedBillingAccountByRegNo10Request ====
815 +)))
816 +|**Field**|**Datatype**|**Required**|**Description**
817 +|##RegNo##|[[##RegNo##>>||anchor="HRegNo"]]|Yes|
818 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
819 +|TraceId|String|Yes|
820 +
821 +**Response parameters**
822 +
823 +(% class="table-bordered table-striped" %)
824 +|=(% colspan="3" %)(((
825 +==== GetClosedBillingAccountByRegNo10Response ====
826 +)))
827 +|**Field**|**Datatype**|**Description**
828 +|##CompanyNo##|String|
829 +|RegNo|[[RegNo>>||anchor="HRegNo"]]|
830 +|BillingAccountList|List<[[ClosedBillingAccountInfo>>||anchor="HClosedBillingAccountInfo"]]>|
831 +|ResponseCode|String|
832 +|ResponseMessage|String|
833 +|TraceId|String|
834 +
835 +**Classes**
836 +
837 +(% class="table-bordered table-striped" %)
838 +|=(% colspan="3" %)(((
839 +==== ClosedBillingAccountInfo ====
840 +)))
841 +|**Field**|**Datatype**|**Description**
842 +|##BillingAccountNo##|String|
843 +|BillingAccountAlias|String|
844 +|Description|String|
845 +
846 +== GetOpenBillingAccountByRegNo10 ==
847 +
848 +**Class diagram**
849 +
850 +[[image:1574427881741-366.png||height="851" width="1171"]]
851 +
852 +**Request parameters**
853 +
854 +(% class="table-bordered table-striped" %)
855 +|=(% colspan="4" %)(((
856 +==== GetOpenBillingAccountByRegNo10Request ====
857 +)))
858 +|**Field**|**Datatype**|**Required**|**Description**
859 +|##RegNo##|[[##RegNo##>>||anchor="HRegNo"]]|Yes|
860 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
861 +|TraceId|String|Yes|
862 +
863 +**Response parameters**
864 +
865 +(% class="table-bordered table-striped" %)
866 +|=(% colspan="3" %)(((
867 +==== GetOpenBillingAccountByRegNo10Response ====
868 +)))
869 +|**Field**|**Datatype**|**Description**
870 +|##CompanyNo##|String|
871 +|RegNo|[[RegNo>>||anchor="HRegNo"]]|
872 +|BillingAccountList|List<[[OpenBillingAccountInfo>>||anchor="HOpenBillingAccountInfo"]]>|
873 +|ResponseCode|String|
874 +|ResponseMessage|String|
875 +|TraceId|String|
876 +
877 +**Classes**
878 +
879 +(% class="table-bordered table-striped" %)
880 +|=(% colspan="3" %)(((
881 +==== OpenBillingAccountInfo ====
882 +)))
883 +|**Field**|**Datatype**|**Description**
884 +|##BillingAccountNo##|String|
885 +|BillingAccountAlias|String|
886 +|Description|String|
887 +|OpenBill|[[BillDetail>>||anchor="HBillDetail"]]|
888 +|PaymentBankAccount|[[PaymentBankAccount>>||anchor="HPaymentBankAccount"]]|
889 +|CurrentBillingAccountDebt|decimal|
890 +|PaymentReference|string|
891 +
892 +== RegisterBillPSPPaymentBillingAccountNo10 ==
893 +
894 +**Class diagram**
895 +
896 +[[image:1574428685798-189.png||height="460" width="778"]]
897 +
898 +**Request parameters**
899 +
900 +(% class="table-bordered table-striped" %)
901 +|=(% colspan="4" %)(((
902 +==== RegisterBillPSPPaymentBillingAccountNo10Request ====
903 +)))
904 +|**Field**|**Datatype**|**Required**|**Description**
905 +|##BillingAccountNo##|(% style="font-family:monospace" %)string(15)|Yes|
906 +|Amount|Decimal|Yes|
907 +|PaymentDate|DateTime|Yes|
908 +|SellerTransactionId|String|Yes|
909 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
910 +|TraceId|String|Yes|
911 +
912 +**Response parameters**
913 +
914 +(% class="table-bordered table-striped" %)
915 +|=(% colspan="3" %)(((
916 +==== RegisterBillPSPPaymentBillingAccountNo10Response ====
917 +)))
918 +|**Field**|**Datatype**|**Description**
919 +|##ResponseCode##|String|
920 +|ResponseMessage|String|
921 +|TraceId|String|
922 +
923 +== RegisterBillDirectPaymentByBillingAccountNo10 ==
924 +
925 +**Class diagram**
926 +
927 +[[image:1574431509616-621.png||height="360" width="883"]]
928 +
929 +**Request parameters**
930 +
931 +(% class="table-bordered table-striped" style="border:undefined" %)
932 +|=(% colspan="4" %)(((
933 +==== RegisterBillDirectPaymentByBillingAccountNo10Request ====
934 +)))
935 +|**Field**|**Datatype**|**Required**|**Description**
936 +|##Amount##|Decimal|Yes|
937 +|BillingAccountNo|String(15)|Yes|
938 +|PaymentDate|DateTime|Yes|
939 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
940 +|TraceId|String|Yes|
941 +
942 +**Response parameters**
943 +
944 +(% class="table-bordered table-striped" %)
945 +|=(% colspan="3" %)(((
946 +==== RegisterBillDirectPaymentByBillingAccountNo10Request ====
947 +)))
948 +|**Field**|**Datatype**|**Description**
949 +|##ResponseCode##|String|
950 +|ResponseMessage|String|
951 +|TraceId|String|
952 +
953 += CustomerService methods =
954 +
955 +The complete Wsdl specification for this service can be found at:
956 +[[https:~~/~~/connect.internaltest.payex.com/PxR/CustomerService.svc>>url:https://connect.internaltest.payex.com/PxR/CustomerService.svc]]
957 +
958 + (Username/password security model)
959 +
960 +== GetcustomerCurrentStateByCustomerNo ==
961 +
962 +Get information about current state of a customer.
963 +
964 +**Class diagram**
965 +
966 +[[image:7-class-diagram-external.png]]
967 +
968 +**Request parameters**
969 +
970 +(% class="table-bordered table-striped" %)
971 +|=(% colspan="4" %)(((
972 +==== GetCustomerCurrentStateByCustomerNoRequest ====
973 +)))
974 +|**Field**|**Datatype**|**Required**|**Description**
975 +|##CustomerNumber##|String(15)|Yes|
976 +|##TrackingUserEMail##|String|No|
977 +
978 +**Response parameters**
979 +
980 +(% class="table-bordered table-striped" %)
981 +|=(% colspan="3" %)(((
982 +==== GetCustomerCurrentStateByCustomerNoResponse ====
983 +)))
984 +|**Field**|**Datatype**|**Description**
985 +|(% style="font-family:monospace" %)##CustomerConsents##|[[CustomerConsent>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerConsent"]]|Array.
986 +|##CustomerInfo##|[[CustomerInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerInfo"]]|
987 +|##CustomerNo##|String|
988 +|##CustomerStatus##|[[CustomerStatus>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerStatus"]]|Array.
989 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
990 +
991 +**Classes**
992 +
993 +(% class="table-bordered table-striped" %)
994 +|=(% colspan="3" %)(((
995 +==== CustomerConsent ====
996 +)))
997 +|**Field**|**Datatype**|**Description**
998 +|(% 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.
999 +
1000 +(% class="table-bordered table-striped" %)
1001 +|=(% colspan="3" %)(((
1002 +==== CustomerInfo ====
1003 +)))
1004 +|**Field**|**Datatype**|**Description**
1005 +|(% style="font-family:monospace" %)##Name##|String|
1006 +|##DistributionAddressInfo##|[[DistributionAddressInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HDistributionAddressInfo"]]|
1007 +|##Language##|String|
1008 +|##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.
1009 +|##VatNo##|String|
1010 +|##Category##| |
1011 +
1012 +(% class="table-bordered table-striped" %)
1013 +|=(% colspan="3" %)(((
1014 +==== CustomerStatus ====
1015 +)))
1016 +|**Field**|**Datatype**|**Description**
1017 +|(% style="font-family:monospace" %)##CustomerStatusTypeCode##|Int|[[See code specification.>>||anchor="HCustomerStatustypecodes"]]
1018 +
1019 +(% class="table-bordered table-striped" %)
1020 +|=(% colspan="4" %)(((
1021 +==== DistributionAddressInfo ====
1022 +)))
1023 +|**Field**|**Datatype**|**Required**|**Description**
1024 +|(% style="font-family:monospace" %)##Addresses##|Array|Yes|See [[address>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HAddress"]].
1025 +|##EMailAddress##|String|No|
1026 +|##Cellphone##|String|No|
1027 +
1028 +(% class="table-bordered table-striped" %)
1029 +|=(% colspan="4" %)(((
1030 +==== Address ====
1031 +)))
1032 +|**Field**|**Datatype**|**Required**|**Description**
1033 +|(% style="font-family:monospace" %)Addressee|String(72)|Yes|
1034 +|##StreetAdress##|String(35)|No|
1035 +|##ZipCode##|String(9)|Yes|
1036 +|##City##|String(27)|Yes|
1037 +|##CoAddress##|String(35)|No|
1038 +|##CountryCode##|String(2)|Yes|
1039 +
1040 +== GetCustomerCurrentStateByRegNo10 ==
1041 +
1042 +**Class diagram**
1043 +
1044 +[[image:1574422177227-663.png||height="671" width="1146"]]
1045 +
1046 +**Request parameters**
1047 +
1048 +(% class="table-bordered table-striped" %)
1049 +|=(% colspan="4" %)(((
1050 +==== GetCustomerCurrentStateByRegNo10Request ====
1051 +)))
1052 +|**Field**|**Datatype**|**Required**|**Description**
1053 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|Yes|
1054 +|##TrackingUserEMail##|String|Yes|
1055 +|TraceId|String|Yes|
1056 +
1057 +**Response parameters**
1058 +
1059 +(% class="table-bordered table-striped" %)
1060 +|=(% colspan="3" %)(((
1061 +==== GetCustomerCurrentStateByRegNo10Response ====
1062 +)))
1063 +|**Field**|**Datatype**|**Description**
1064 +|(% style="font-family:monospace" %)##CustomerConsents##|[[CustomerConsent>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerConsent"]]|Array.
1065 +|##CustomerInfo##|[[CustomerInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerInfo"]]|
1066 +|##CustomerNo##|String|
1067 +|##CustomerStatus##|[[CustomerStatus>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerStatus"]]|Array.
1068 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
1069 +
1070 +(% id="HAppendix1SharedClasses" %)
1071 += Appendix 1 Shared Classes =
1072 +
1073 +
1074 +**Response parameters**
1075 +
1076 +(% class="table-bordered table-striped" %)
1077 +|=(% colspan="3" %)(((
1078 +==== GetInvoicePDFResponse ====
1079 +)))
1080 +|**Field**|**Datatype**|**Description**
1081 +|##Pdf##|Byte[]|
1082 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
1083 +|##CustomerNo##|String|
1084 +|##ResponseCode##|String|
1085 +|##ResponseMessage##|String|
1086 +|##TraceId##|String|
1087 +
1088 +(% class="table-bordered table-striped" %)
1089 +|=(% colspan="3" %)(((
1090 +==== GetInvoiceInformationResponse ====
1091 +)))
1092 +|**Field**|**Datatype**|**Description**
1093 +|##CompanyNo##|String|
1094 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
1095 +|##CustomerNo##|String|
1096 +|##CustomerName##|String|
1097 +|##Invoice##|[[Invoice>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoice"]]|
1098 +|##ResponseCode##|String|
1099 +|##ResponseMessage##|String|
1100 +|##TraceId##|String|
1101 +
1102 +(% class="table-bordered table-striped" %)
1103 +|=(% colspan="3" %)(((
1104 +==== RegNo ====
1105 +)))
1106 +|**Field**|**Datatype**|**Description**
1107 +|##CountryCode##|String|
1108 +|##Value##|String|
1109 +
1110 +(% class="table-bordered table-striped" %)
1111 +|=(% colspan="3" %)(((
1112 +==== Invoice ====
1113 +)))
1114 +|**Field**|**Datatype**|**Description**
1115 +|##PaymentReference##|String|
1116 +|##BillNo##|String|
1117 +|##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.
1118 +|##ExternalInvoiceId##|String|
1119 +|##ExternalReference##|String|
1120 +|##SellerNo##|String|
1121 +|##BillDate##|DateTime|
1122 +|##DueDate##|DateTime (Optional)|
1123 +|##OriginalAmount##|Decimal|
1124 +|##Interest##|[[Interest>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInterest"]]|
1125 +|##CurrentBalanceList##|List <[[Balance>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBalance"]]>|
1126 +|##CurrencyCode##|String|
1127 +|##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.
1128 +|##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.
1129 +|##PaymentBanAccount##|[[PaymentBankAccount>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HPaymentBankAccount"]]|
1130 +|##PaymentType##|String|
1131 +|##ActiveRespite##|[[ActiveRespite>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActiveRespite"]]|
1132 +|##ActivePaymentOrder##|[[ActivePaymentOrder>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActivePaymentOrder"]]|
1133 +|##BillId##|Long|
1134 +|##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.
1135 +|##InvoiceHistory##|List <[[InvoiceHistory>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoiceHistory"]]>|
1136 +
1137 +(% class="table-bordered table-striped" %)
1138 +|=(% colspan="3" %)(((
1139 +==== Interest ====
1140 +)))
1141 +|**Field**|**Datatype**|**Description**
1142 +|##CurrentInterestRate##|decimal|
1143 +|##InterestIntervalCode##|byte|
1144 +
1145 +(% class="table-bordered table-striped" %)
1146 +|=(% colspan="3" %)(((
1147 +==== Balance ====
1148 +)))
1149 +|**Field**|**Datatype**|**Description**
1150 +|##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.
1151 +|##Amount##|decimal|
1152 +
1153 +(% class="table-bordered table-striped" %)
1154 +|=(% colspan="3" %)(((
1155 +==== PaymentBankAccount20 inherit [[PaymentBankAccount>>||anchor="HPaymentBankAccount"]] ====
1156 +)))
1157 +|**Field**|**Datatype**|**Description**
1158 +|##PaymentTypeName##|String|
1159 +
1160 +(% class="table-bordered table-striped" %)
1161 +|=(% colspan="3" %)(((
1162 +==== PaymentBankAccount ====
1163 +)))
1164 +|**Field**|**Datatype**|**Description**
1165 +|##BankAccountNo##|String|
1166 +|##BankAccountType##|String|
1167 +|##BIC##|String|
1168 +|##IBAN##|String|
1169 +
1170 +(% class="table-bordered table-striped" %)
1171 +|=(% colspan="3" %)(((
1172 +==== ActiveRespite ====
1173 +)))
1174 +|**Field**|**Datatype**|**Description**
1175 +|##RespiteValidtoDate##|DateTime|
1176 +|##RespiteTypeCode##|int|
1177 +
1178 +(% class="table-bordered table-striped" %)
1179 +|=(% colspan="3" %)(((
1180 +==== ActivePaymentOrder ====
1181 +)))
1182 +|**Field**|**Datatype**|**Description**
1183 +|##PaymentType##|String|
1184 +|##ExecutionDate##|DateTime|
1185 +
1186 +(% class="table-bordered table-striped" %)
1187 +|=(% colspan="3" %)(((
1188 +==== InvoiceHistory ====
1189 +)))
1190 +|**Field**|**Datatype**|**Description**
1191 +|BillDate|DateTime|
1192 +|BillId|long|
1193 +|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.
1194 +
1195 +(% class="table-bordered table-striped" %)
1196 +|=(% colspan="3" %)(((
1197 +==== GetClosedInvoiceInformation20Response ====
1198 +)))
1199 +|**Field**|**Datatype**|**Description**
1200 +|CompanyNo|String|
1201 +|CustomerNo|string|
1202 +|CustomerName|String|
1203 +|InvoiceList|List<[[ClosedInvoice20>>||anchor="HClosedInvoice20"]]>|See [[ClosedInvoice20>>||anchor="HClosedInvoice20"]]
1204 +
1205 +(% class="table-bordered table-striped" %)
1206 +|=(% colspan="3" %)(((
1207 +==== ClosedInvoice20 ====
1208 +)))
1209 +|**Field**|**Datatype**|**Description**
1210 +|CurrencyCode|String|
1211 +|BillNo|string|
1212 +|BillStatusCode|Int|
1213 +|ExternalInvoiceId|String|
1214 +|BillDate|DateTime|
1215 +|DueDate|DateTime?|
1216 +|ExternalBillType|String|
1217 +|OriginalAmount|Decimal|
1218 +|SellerName|String|
1219 +|SellerNo|String|
1220 +
1221 +(% class="table-bordered table-striped" %)
1222 +|=(% colspan="3" %)(((
1223 +==== GetInvoiceInformation20Response ====
1224 +)))
1225 +|**Field**|**Datatype**|**Description**
1226 +|CompanyNo|String|
1227 +|RegNo|[[RegNo>>||anchor="HRegNo"]]|
1228 +|CustomerNo|string|
1229 +|CustomerName|String|
1230 +|Invoice|[[InvoiceInformation20>>||anchor="HInvoiceInformation20inheritOpenInvoice20"]]|
1231 +
1232 +(% class="table-bordered table-striped" %)
1233 +|=(% colspan="3" %)(((
1234 +==== InvoiceInformation20 inherit [[OpenInvoice20>>||anchor="HOpenInvoice20inheritClosedInvoice20"]] ====
1235 +)))
1236 +|**Field**|**Datatype**|**Description**
1237 +|PenaltyIntest|[[Intrest>>||anchor="HIntrest"]]|
1238 +|CurrentBalance|List<[[Balance>>||anchor="HBalance"]]>|
1239 +|InvoiceHistory|List<[[InvoiceHistory20>>||anchor="HInvoiceHistory20"]]>|
1240 +
1241 +(% class="table-bordered table-striped" %)
1242 +|=(% colspan="3" %)(((
1243 +==== InvoiceHistory20 ====
1244 +)))
1245 +|**Field**|**Datatype**|**Description**
1246 +|BillDate|DateTime|
1247 +|ExternalBillType|String|
1248 +|BillAmount|Decimal?|
1249 +
1250 +(% class="table-bordered table-striped" %)
1251 +|=(% colspan="3" %)(((
1252 +==== OpenInvoice20 inherit [[ClosedInvoice20>>||anchor="HClosedInvoice20"]] ====
1253 +)))
1254 +|**Field**|**Datatype**|**Description**
1255 +|CurrentDebt|Decimal|
1256 +|PaymentBankAccount|[[PaymentBankAccount>>||anchor="HPaymentBankAccount"]]|
1257 +|PaymentType|String|
1258 +|ActiveRespite|[[ActiveRespite20>>||anchor="HActiveRespite20"]]|
1259 +|ActivePaymentOrder|[[ActivePaymentOrder>>||anchor="HActivePaymentOrder"]]|
1260 +|PaymentRefrence|String|
1261 +|ExportedToCollection|Bool|
1262 +
1263 +(% class="table-bordered table-striped" %)
1264 +|=(% colspan="3" %)(((
1265 +==== ActiveRespite20 ====
1266 +)))
1267 +|**Field**|**Datatype**|**Description**
1268 +|RespiteValidToDate|DateTime?|
1269 +|RespiteTypeCode|Int|
1270 +
1271 +(% class="table-bordered table-striped" %)
1272 +|=(% colspan="3" %)(((
1273 +==== BillDetail ====
1274 +)))
1275 +|**Field**|**Datatype**|**Description**
1276 +|ExternalBillId|String|
1277 +|DueDate|DateTime|
1278 +|ExportedToCollection|Bool|
1279 +|BillNo|String|
1280 +|ActiveRespite|[[ActiveRespite20>>||anchor="HActiveRespite20"]]|
1281 +|ActivePaymentOrder|[[ActivePaymentOrder>>||anchor="HActivePaymentOrder"]]|
1282 +|CurrentBalanceList|List<[[Balance>>||anchor="HBalance"]]>|
1283 +|BillHistoryList|List<[[BillHistory>>||anchor="HBillHistory"]]>|
1284 +
1285 +(% class="table-bordered table-striped" %)
1286 +|=(% colspan="3" %)(((
1287 +==== BillHistory ====
1288 +)))
1289 +|**Field**|**Datatype**|**Description**
1290 +|BillDate|DateTime|
1291 +|ExternalBillType|String|
1292 +|BillAmount|Decimal|
1293 +
1294 += Appendix 2 Code specification =
1295 +
1296 +(% class="table-bordered table-striped" %)
1297 +|=(% colspan="2" %)(((
1298 +==== Bill status codes ====
1299 +)))
1300 +|**BillStatusCodes**|**Description**
1301 +|1|Open
1302 +|2|Closed
1303 +|3|Closed_Diff
1304 +|4|Closed_Loss
1305 +|5|Reversed
1306 +|6|Arrears
1307 +|7|Closed_Rest
1308 +|8|Closed_Convert
1309 +|9|Closed_Sold
1310 +|10|Closed_Reversal
1311 +|11|Pending
1312 +
1313 +(% class="table-bordered table-striped" %)
1314 +|=(% colspan="2" %)(((
1315 +==== Claim level codes ====
1316 +)))
1317 +|**ClaimLevelCode**|**Description**
1318 +|1|Invoice
1319 +|2|RestReminderSent
1320 +|3|ReminderSent
1321 +|4|RestReminderSent
1322 +|5|SecondReminderSent
1323 +|6|RestReminderSent
1324 +|7|CollectionClaimSent
1325 +|8|RestReminderSent
1326 +|9*|DebtCollection*
1327 +|10|Late Fee, credit account
1328 +|11|TerminationNoticeSent, credit account
1329 +
1330 +*Additional fees and interest may have occured in collection system, but is not included in the response.
1331 +
1332 +(% class="table-bordered table-striped" %)
1333 +|=(% colspan="2" %)(((
1334 +==== Bill type codes ====
1335 +)))
1336 +|**BillTypeCode**|**Description**
1337 +|1|Invoice
1338 +|4|CreditInvoice
1339 +
1340 +(% class="table-bordered table-striped" %)
1341 +|=(% colspan="2" %)(((
1342 +==== Consent type codes ====
1343 +)))
1344 +|**ConsentTypeCode**|**Description**
1345 +|1|BGAGSE
1346 +|2|EInvoiceB2CSE
1347 +|3|EInvoiceB2CNO
1348 +|4|BKAGNO
1349 +|5|KivraSE
1350 +|6|EInvoiceB2CFI
1351 +
1352 +(% class="table-bordered table-striped" %)
1353 +|=(% colspan="2" %)(((
1354 +==== CustomerStatus type codes ====
1355 +)))
1356 +|**CustomerStatusTypeCode**|**Description**
1357 +|1|ConfirmedDeceased
1358 +|2|ConfirmedBankruptcy
1359 +|3|ActiveComplaints
1360 +
1361 +(% class="table-bordered table-striped" %)
1362 +|=(% colspan="2" %)(((
1363 +==== Legal entity codes ====
1364 +)))
1365 +|**LegalEntiytCode**|**Description**
1366 +|None|None
1367 +|Private|Private
1368 +|Business|Business
1369 +
1370 +(% class="table-bordered table-striped" %)
1371 +|=(% colspan="2" %)(((
1372 +==== Balance type codes ====
1373 +)))
1374 +|**BalanceTypeCode**|**Description**
1375 +|0|None
1376 +|1|Capital
1377 +|2|ReminderFee
1378 +|3|PenaltyInterest
1379 +|4|CalculatedPenaltyInterest
1380 +|5|CollectionFee
1381 +|6|BusinessReminderFee
1382 +|7|BillingFee
1383 +|8|DelayFee
1384 +|9|DebtInterest
1385 +|10|DebtCollectionCharge
1386 +|11|Rounding
1387 +
1388 +(% class="table-bordered table-striped" %)
1389 +|=(% colspan="2" %)(((
1390 +==== Collection status codes ====
1391 +)))
1392 +|**CollectionStatusCode**|**Description**
1393 +|1|PreDebtCollection
1394 +|2|DebtCollection
1395 +|3|LegalProcess
1396 +|4|Monitoring
1397 +|5|External
1398 +|6|Closed
1399 +|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_AddPaymentOrderOnDueDateRequest.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.avp
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
PxR_InvoiceService_DeletePaymentOrder.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.avp
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content