Changes for page ExternalServicesmanual

Last modified by Fredrik Nilsson on 2021/06/29 16:53
From empty
To version 57.1
edited by Bent Pitkänen
on 2019/11/15 14:58
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +ExternalServicesmanual
Parent
... ... @@ -1,0 +1,1 @@
1 +Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.XWikiGuest
1 +xwiki:XWiki.bpi
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Tags
... ... @@ -1,0 +1,1 @@
1 +px-custom-page-content
Content
... ... @@ -1,0 +1,897 @@
1 += =
2 +
3 +(% class="jumbotron" %)
4 +(((
5 +(% class="container" %)
6 +(((
7 +The external services manual cover methods used to retrieve Invoice PDFs as well as invoice and customer information.
8 +)))
9 +)))
10 +
11 +**You can also use the PDF manual found [[here>>attach:PayExConnect_Manual_PxR_ExternalServices.pdf]].**
12 +
13 += InvoiceService methods =
14 +
15 +The complete Wsdl specification for this service can be found at:
16 +
17 +[[https:~~/~~/connect.payex.com~~/~~/PxR/InvoiceService.svc?wsdl>>url:https://connect.payex.com//PxR/InvoiceService.svc?wsdl]]
18 +
19 + (Username/password security model)
20 +
21 +== GetInvoicePdfByBillNo ==
22 +
23 +(% class="wikigeneratedid" %)
24 +Gets a specific invoice document in the format of PDF
25 +
26 +**Class diagram**
27 +
28 +**[[image:1-class-diagram-external.png]]**
29 +
30 +**Request parameters**
31 +
32 +(% class="table-bordered table-striped" %)
33 +|=(% colspan="4" %)GetInvoiceByBillNoRequest
34 +|**Field**|**Datatype**|**Required**|**Description**
35 +|##BillNo##|String(15)|Yes|
36 +|##TrackingUserEmail##|Sting(50)|Yes|User info for trackability.
37 +|##TraceId##|String|Yes|
38 +
39 +(% class="wikigeneratedid" %)
40 +**Response parameters**
41 +
42 +(% class="wikigeneratedid" %)
43 +[[GetInvoicePDFResponse>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoicePDFResponse"]]
44 +
45 +== GetInvoicePdfByExternalInvoiceId ==
46 +
47 +Gets a specific invoice document in the format of PDF
48 +
49 +**Class diagram**
50 +
51 +**[[image:2-class-diagram-external.png]]**
52 +
53 +**Request parameters**
54 +
55 +(% class="table-bordered table-striped" %)
56 +|=(% colspan="4" %)GetInvoicePdfByExternalInvoiceIdRequest
57 +|**Field**|**Datatype**|**Required**|**Description**
58 +|##ExternalInvoiceId##|String(15)|Yes|
59 +|TrackingUserEmail|String(50)|Yes|User info for trackability.
60 +|TraceId|String|Yes|
61 +
62 +(% class="wikigeneratedid" %)
63 +**Response parameters**
64 +
65 +(% class="wikigeneratedid" %)
66 +[[GetInvoicePDFResponse>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoicePDFResponse"]]
67 +
68 +== GetInvoiceInformationByBillNo ==
69 +
70 +Gets information about a specific invoice
71 +
72 +**Class diagram**
73 +
74 +**[[image:3-class-diagram-external.png]]**
75 +
76 +**Request parameters**
77 +
78 +(% class="table-bordered table-striped" %)
79 +|=(% colspan="4" %)GetInvoiceInformationByBillNoRequest
80 +|**Field**|**Datatype**|**Required**|**Description**
81 +|##BillNo##|String(15)|Yes|
82 +|##TrackingUserEmail##|String(50)|Yes|User info for trackability.
83 +|##TraceId##|String|Yes|
84 +
85 +(% class="wikigeneratedid" %)
86 +**Response parameters**
87 +
88 +(% class="wikigeneratedid" %)
89 +[[GetInvoiceInformationResponse>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoiceInformationResponse"]]
90 +
91 +== GetInvoiceIformationByExternalInvoiceId ==
92 +
93 +Gets information about a specific invoice
94 +
95 +**Class diagram**
96 +
97 +**[[image:4-class-diagram-external.png]]**
98 +
99 +**Request parameters**
100 +
101 +(% class="table-bordered table-striped" %)
102 +|=(% colspan="4" %)GetInvoiceByExternalInvoiceIdRequest
103 +|**Field**|**Datatype**|**Required**|**Description**
104 +|ExternalInvoiceId|String (15)|Yes|
105 +|TrackingUserEmail|String (50)|Yes|User info for trackability.
106 +|TraceId|String|Yes|
107 +
108 +(% class="wikigeneratedid" %)
109 +**Response parameters**
110 +
111 +(% class="wikigeneratedid" %)
112 +[[GetInvoiceInformationResponse>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HGetInvoiceInformationResponse"]]
113 +
114 +== GetOpenInvoiceInformationByCustomerNo ==
115 +
116 +Gets open invoices
117 +
118 +**Class diagram**
119 +
120 +**[[image:5-class-diagram-external.png]]**
121 +
122 +**Request parameters**
123 +
124 +(% class="table-bordered table-striped" %)
125 +|=(% colspan="4" %)GetOpenInvoiceInformationByCustomerNoRequest
126 +|**Field**|**Datatype**|**Required**|**Description**
127 +|##CustomerNo##|String(15)|Yes|##CustomerNo ##is your unique identifier of the customer.
128 +|##TrackingUserEMail##|String|No|User info for trackability.
129 +|##TraceId##|String|Yes|
130 +
131 +**Response parameters**
132 +
133 +(% class="table-bordered table-striped" %)
134 +|=(% colspan="3" %)GetOpenInvoiceInformationByCustomerNoResponse
135 +|**Field**|**Datatype**|**Description**
136 +|##CompanyNo##|String|
137 +|##CustomerNo##|String|##CustomerNo ##is you Unique identifier of the customer.
138 +|##CustomerName##|String|
139 +|##InvoiceList##|List <[[OpenInvoice>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HOpenInvoice"]]>|
140 +|##ResponseCode##|String|
141 +|##ResponseMessage##|String|
142 +|##TraceId##|String|
143 +
144 +**Classes**
145 +
146 +(% class="table-bordered table-striped" %)
147 +|=(% colspan="3" %)(((
148 +==== OpenInvoice ====
149 +)))
150 +|**Field**|**Datatype**|**Description**
151 +|(% style="font-family:monospace" %)BillNo|String|
152 +|##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.
153 +|##ExternalInvoiceId##|String|Additional unique invoice identifier.
154 +|##BillDate##|DateTime|
155 +|##DueDate##|DateTime(Optional)|Empty if BillTypeCode is ##Invoice.##
156 +|##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.
157 +|##OriginalAmount##|Decimal|
158 +|##CurrentDebt##|Decimal|
159 +|##CurrencyCode##|String|
160 +|##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.
161 +|##PaymentBankAccount##|[[PaymentBankAccount>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HPaymentBankAccount"]]|
162 +|##PaymentType##|String|
163 +|##ActiveRespite##|[[ActiveRespite>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActiveRespite"]]|
164 +|##ActivePaymentOrder##|[[ActivePaymentOrder>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActivePaymentOrder"]]|
165 +
166 +== GetClosedInvoiceInformationByCustomerNo ==
167 +
168 +Gets closed invoices (status “Closed” only)
169 +
170 +**Class diagram**
171 +
172 +**[[image:6-class-diagram-external.png]]**
173 +
174 +**Request parameters**
175 +
176 +(% class="table-bordered table-striped" %)
177 +|=(% colspan="4" %)GetClosedInvoiceInformationCustomerNoRequest
178 +|**Field**|**Datatype**|**Required**|**Description**
179 +|##CustomerNo##|String(15)|Yes|CustomerNo is your unique identifier for the customer.
180 +|##TrackingUserEMail##|String|No|User info for trackability.
181 +|##TraceId##|String|Yes|
182 +
183 +**Response parameters**
184 +
185 +(% class="table-bordered table-striped" %)
186 +|=(% colspan="3" %)GetClosedInvoiceInformationByCustomerNoResponse
187 +|**Field**|**Datatype**|**Description**
188 +|##CompanyNo##|String|Yoyr accounts receivable number at PayEx.
189 +|##CustomerNo##|String|##CustomerNo ##is you Unique identifier of the customer.
190 +|##CustomerName##|String|
191 +|##InvoiceList##|List <[[ClosedInvoice>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HClosedInvoice"]]>|
192 +|##ResponseCode##|String|
193 +|##ResponseMessage##|String|
194 +|##TraceId##|String|
195 +
196 +**Classes**
197 +
198 +(% class="table-bordered table-striped" %)
199 +|=(% colspan="3" %)(((
200 +==== ClosedInvoice ====
201 +)))
202 +|**Field**|**Datatype**|**Description**
203 +|(% style="font-family:monospace" %)BillNo|String|
204 +|##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.
205 +|##ExternalInvoiceId##|String|Additional unique invoice identifier in accounts receivable.
206 +|##BillDate##|DateTime|
207 +|##DueDate##|DateTime(Optional)|Empty if BillTypeCode is ##Invoice.##
208 +|##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.
209 +|##OriginalAmount##|Decimal|
210 +|##CurrencyCode##|String|
211 +
212 +== AddInvoiceRespiteByBillNo10 ==
213 +
214 +Add respite date to an open invoice.
215 +
216 +**Class diagram**
217 +[[image:1573563792142-225.png||height="318" width="920"]]
218 +**Request parameters**
219 +
220 +(% class="table-bordered table-striped" %)
221 +|=(% colspan="4" %)AddInvoiceRespiteByBillNo10Request
222 +|**Field**|**Datatype**|**Required**|**Description**
223 +|##BillNo##|String(15)|Yes|Bill Number.
224 +|##RespiteCause##|String(250)|Yes|Reason for respite.
225 +|##TrackingUserEMail##|String(1-256)|Yes|User info for trackability.
226 +|##TraceId##|String|Yes|
227 +|##ValidToDate##|DateTime|Yes|
228 +
229 +**Response parameters**
230 +
231 +(% class="table-bordered table-striped" %)
232 +|=(% colspan="4" %)AddInvoiceRespiteByBillNo10Response
233 +|**Field**|**Datatype**|**Description**
234 +|##ResponseCode##|String|
235 +|##ResponseMessage##|String|
236 +|##TraceId##|String|
237 +
238 +**Error codes**
239 +
240 +(% class="table-bordered table-striped" %)
241 +|=(% colspan="4" %)GetCustomerCurrentStateByCustomerNoResponse
242 +|**Code**|**Name**|**Description**
243 +|##5074##|InvalidDate|ValidToDate is not within a valid date.
244 +|##5046##|InvalidAccountType|Bill of BillNo is not of a valid AccountType.
245 +|##1208##|InvalidAccountStatus|Respite not a valid action on this bill.
246 +
247 +== ConvertInvoiceToAccount10 ==
248 +
249 +Convert an invoice account to a credit account.
250 +
251 +**Class diagram**
252 +
253 +[[image:1573569373687-299.png||height="324" width="739"]]
254 +
255 +**Request parameters**
256 +
257 +(% class="table-bordered table-striped" %)
258 +|=(% colspan="4" %)ConvertInvoiceToAccount10Request
259 +|**Field**|**Datatype**|**Required**|**Description**
260 +|##BillNo##|String(15)|Yes|Bill Number.
261 +|##TrackingUserEMail##|String(1-256)|Yes|User info for trackability.
262 +|##TraceId##|String|Yes|
263 +
264 +**Response parameters**
265 +
266 +(% class="table-bordered table-striped" %)
267 +|=(% colspan="4" %)ConvertInvoiceToAccount10Response
268 +|**Field**|**Datatype**|**Description**
269 +|##ResponseCode##|String|
270 +|##ResponseMessage##|String|
271 +|##TraceId##|String|
272 +
273 +== RegisterInvoiceDirectPaymentByBillNo10 ==
274 +
275 +Register a direct payment on given invoice.
276 +
277 +**Class diagram**
278 +
279 +[[image:1573570140844-820.png||height="384" width="715"]]
280 +
281 +**Request parameters**
282 +
283 +(% class="table-bordered table-striped" %)
284 +|=(% colspan="4" %)RegisterInvoiceDirectPaymentByBillNo10Request
285 +|**Field**|**Datatype**|**Required**|**Description**
286 +|##Amount##|Decimal|Yes|DirectPayment Amount.
287 +|##BillNo##|String|Yes|Bill to match payment to.
288 +|##PaymentDate##|DateTime|Yes|Date when payment occured.
289 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
290 +|TraceId|String|Yes|
291 +
292 +**Response parameters**
293 +
294 +(% class="table-bordered table-striped" %)
295 +|=(% colspan="4" %)RegisterInvoiceDirectPaymentByBillNo10Response
296 +|**Field**|**Datatype**|**Description**
297 +|##ResponseCode##|String|
298 +|##ResponseMessage##|String|
299 +|##TraceId##|String|
300 +
301 +**Error codes**
302 +
303 +(% class="table-bordered table-striped" %)
304 +|=(% colspan="4" %)GetCustomerCurrentStateByCustomerNoResponse
305 +|**Code**|**Name**|**Description**
306 +|##5080##|InvalidBillNo|BillNo is invalid
307 +|##1207##|InvalidAmount|Amount is invalid
308 +|##5074##|InvalidDate|PaymentDate is not within a valid date
309 +
310 +== AddInvoiceCopyOrderByBillNo10 ==
311 +
312 +Order a copy of the invoice to be delivered.
313 +
314 +**Class diagram**
315 +
316 +[[image:1573631474317-399.png||height="349" width="795"]]
317 +
318 +**Request parameters**
319 +
320 +(% class="table-bordered table-striped" %)
321 +|=(% colspan="4" %)AddInvoiceCopyOrderByBillNo10Request
322 +|**Field**|**Datatype**|**Required**|**Description**
323 +|##BillNo##|String|Yes|
324 +|##DistributionMethod##|String|Yes|
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" %)RegisterInvoiceDirectPaymentByBillNo10Response
332 +|**Field**|**Datatype**|**Description**
333 +|##ResponseCode##|String|
334 +|##ResponseMessage##|String|
335 +|##TraceId##|String|
336 +
337 +**Error codes**
338 +
339 +(% class="table-bordered table-striped" %)
340 +|=(% colspan="4" %)GetCustomerCurrentStateByCustomerNoResponse
341 +|**Code**|**Name**|**Description**
342 +|##5089##|BillsNotFound|Found no matching Invoices for BillNo
343 +
344 +== GetClosedInvoiceInformationByCustomerNo20 ==
345 +
346 +Get information about a customer's closed invoice(s) by customer number.
347 +
348 +**Class diagram**
349 +[[image:1573632921277-742.png||height="509" width="841"]]
350 +
351 +**Request parameters**
352 +
353 +(% class="table-bordered table-striped" %)
354 +|=(% colspan="4" %)GetClosedInvoiceInformationByCustomerNo20Request
355 +|**Field**|**Datatype**|**Required**|**Description**
356 +|##CustomerNo##|String|Yes|
357 +|##TrackingUserEmail##|String|Yes|User info for trackability.
358 +|TraceId| |yes|
359 +
360 +**Response parameters**
361 +
362 +**[[GetClosedInvoiceInformation20Response>>||anchor="HGetClosedInvoiceInformation20Response"]]**
363 +
364 +== GetClosedInvoiceInformationByRegNo20 ==
365 +
366 +Get information about a customer's closed invoice(s) by social security number.
367 +
368 +**Class diagram**
369 +
370 +[[image:1573646248641-666.png||height="508" width="807"]]
371 +
372 +**Request parameters**
373 +
374 +(% class="table-bordered table-striped" %)
375 +|=(% colspan="4" %)GetClosedInvoiceInformationByRegNo20Request
376 +|**Field**|**Datatype**|**Required**|**Description**
377 +|##RegNo##|[[RegNo>>||anchor="HRegNo"]]|Yes|See [[RegNo>>||anchor="HRegNo"]]
378 +|##TrackingUserEmail##|String|Yes|User info for trackability.
379 +|TraceId| |yes|
380 +
381 +**Response parameters**
382 +
383 +**[[GetClosedInvoiceInformation20Response>>||anchor="HGetClosedInvoiceInformation20Response"]]**
384 +
385 +**Error codes**
386 +
387 +(% class="table-bordered table-striped" %)
388 +|=(% colspan="4" %)GetClosedInvoiceInformation20Response
389 +|**Code**|**Name**|**Description**
390 +|##5006##|ExpectedCustomerNumber|Found multiple customer on RegNo, use CustomerNo instead.
391 +|5075|MissingAccountForBill|Found no matching customer for RegNo.
392 +|1024|ErrorInvalidRegNo|Invalid RegNo format.
393 +
394 +== GetInvoiceInformationByBillNo20 ==
395 +
396 +**Class diagram**
397 +
398 +[[image:1573648586121-179.png||height="582" width="1172"]]
399 +
400 +**Request parameters**
401 +
402 +(% class="table-bordered table-striped" %)
403 +|=(% colspan="4" %)GetInvoiceInformationByBillNo20Request
404 +|**Field**|**Datatype**|**Required**|**Description**
405 +|##BillNo##|String|Yes|
406 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
407 +|TraceId|String|Yes|
408 +
409 +**Response parameters**
410 +
411 +[[GetInvoinceInformation20Response>>||anchor="HGetInvoiceInformation20Response"]]
412 +
413 +**Error codes**
414 +
415 +(% class="table-bordered table-striped" %)
416 +|=(% colspan="4" %)GetInvoinceInformation20Response
417 +|**Code**|**Name**|**Description**
418 +|##5072##|InvalidExternalBillId|ExternalInvoiceId does not match any valid invoices.
419 +|5089|BillsNotFound|Invoice match but invoice not valid. May be older than 1 year.
420 +
421 +== GetInvoiceInformationByExternalInvoiceId20 ==
422 +
423 +**Class diagram**
424 +
425 +[[image:1573822272252-854.png||height="581" width="1220"]]
426 +
427 +**Request parameters**
428 +
429 +(% class="table-bordered table-striped" %)
430 +|=(% colspan="4" %)GetInvoiceInformationByExternalInvoiceId20Request
431 +|**Field**|**Datatype**|**Required**|**Description**
432 +|##ExternalInvoiceId##|String|Yes|
433 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
434 +|TraceId|String|Yes|
435 +
436 +**Response parameters**
437 +
438 +[[GetInvoinceInformation20Response>>||anchor="HGetInvoiceInformation20Response"]]
439 +
440 +**Error codes**
441 +
442 +(% class="table-bordered table-striped" %)
443 +|=(% colspan="4" %)GetInvoinceInformation20Response
444 +|**Code**|**Name**|**Description**
445 +|##5072##|InvalidExternalBillId|ExternalInvoiceId does not match any valid invoices.
446 +|5089|BillsNotFound|Invoice match but invoice not valid. May be older than 1 year.
447 +
448 +== GetInvoicePdfByBillNoExternalBillType10 ==
449 +
450 +**Class diagram**
451 +
452 +[[image:1573822789308-786.png||height="470" width="761"]]
453 +
454 +**Request parameters**
455 +
456 +(% class="table-bordered table-striped" %)
457 +|=(% colspan="4" %)GetInvoicePdfByBillNoExternalBillType10Request
458 +|**Field**|**Datatype**|**Required**|**Description**
459 +|##BillNo##|String|Yes|
460 +|ExternalBillType|String|Yes|(((
461 +Document type.
462 +Existing ExternalBillType can be retrived from GetInvoiceInformationByBillNo20 or GetInvoiceInformationByExternalInvoiceId20.
463 +)))
464 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
465 +|TraceId|String|Yes|
466 +
467 +**Response parameters**
468 +
469 +[[GetInvoicePDFResponse>>||anchor="HGetInvoicePDFResponse"]]
470 +
471 +**Error codes**
472 +
473 +(% class="table-bordered table-striped" %)
474 +|=(% colspan="4" %)GetInvoincePDFResponse
475 +|**Code**|**Name**|**Description**
476 +|##5046##|InvalidAccountType|Wrong account type. The requested bill number is not an invoice.
477 +|5080|InvalidBillNo|Invoice document not found.
478 +|5095|ExternalBillTypeCode|Invalid ExternalBillType.
479 +
480 +== GetOpenInvoiceInformationByRegNo20 ==
481 +
482 +**Class diagram**
483 +
484 +[[image:1573825242764-218.png||height="661" width="1066"]]
485 +
486 +**Request parameters**
487 +
488 +(% class="table-bordered table-striped" %)
489 +|=(% colspan="4" %)GetInvoicePdfByBillNoExternalBillType10Request
490 +|**Field**|**Datatype**|**Required**|**Description**
491 +|RegNo|RegNo|Yes|
492 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
493 +|TraceId|String|Yes|
494 +
495 +**Response parameters**
496 +
497 +[[GetOpenInvoiceInformation20Response>>||anchor="HGetOpenInvoiceInformation20Response"]]
498 +
499 +== RegisterInvoicePSPPaymentByBillNo10 ==
500 +
501 +**Class diagram**
502 +
503 +[[image:1573825460421-413.png||height="460" width="778"]]
504 +
505 +**Request parameters**
506 +
507 +(% class="table-bordered table-striped" %)
508 +|=(% colspan="4" %)RegisterInvoicePSPPaymentByBillNoRequest
509 +|**Field**|**Datatype**|**Required**|**Description**
510 +|##BillNo##|String|Yes|
511 +|Amount|Decimal|Yes|
512 +|PaymentDate|DateTime|Yes|
513 +|SellerTransactionId|String|Yes|
514 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
515 +|TraceId|String|Yes|
516 +
517 +**Response parameters**
518 +
519 +(% class="table-bordered table-striped" %)
520 +|=(% colspan="4" %)RegisterInvoicePSPPaymentByBillNoResponse
521 +|**Field**|**Datatype**|**Description**
522 +|##ResponseCode##|String|
523 +|##ResponseMessage##|String|
524 +|TraceId|String|
525 +
526 += CustomerService methods =
527 +
528 +The complete Wsdl specification for this service can be found at:
529 +[[https:~~/~~/connect.internaltest.payex.com/PxR/CustomerService.svc>>url:https://connect.internaltest.payex.com/PxR/CustomerService.svc]]
530 +
531 + (Username/password security model)
532 +
533 +== GetcustomerCurrentStateByCustomerNo ==
534 +
535 +Get information about current state of a customer.
536 +
537 +**Class diagram**
538 +
539 +[[image:7-class-diagram-external.png]]
540 +
541 +**Request parameters**
542 +
543 +(% class="table-bordered table-striped" %)
544 +|=(% colspan="4" %)GetCustomerCurrentStateByCustomerNoRequest
545 +|**Field**|**Datatype**|**Required**|**Description**
546 +|##CustomerNumber##|String(15)|Yes|
547 +|##TrackingUserEMail##|String|No|
548 +
549 +**Response parameters**
550 +
551 +(% class="table-bordered table-striped" %)
552 +|=(% colspan="3" %)GetCustomerCurrentStateByCustomerNoResponse
553 +|**Field**|**Datatype**|**Description**
554 +|(% style="font-family:monospace" %)##CustomerConsents##|[[CustomerConsent>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerConsent"]]|Array.
555 +|##CustomerInfo##|[[CustomerInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerInfo"]]|
556 +|##CustomerNo##|String|
557 +|##CustomerStatus##|[[CustomerStatus>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerStatus"]]|Array.
558 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
559 +
560 +**Classes**
561 +
562 +(% class="table-bordered table-striped" %)
563 +|=(% colspan="3" %)(((
564 +==== CustomerConsent ====
565 +)))
566 +|**Field**|**Datatype**|**Description**
567 +|(% 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.
568 +
569 +(% class="table-bordered table-striped" %)
570 +|=(% colspan="3" %)(((
571 +==== CustomerInfo ====
572 +)))
573 +|**Field**|**Datatype**|**Description**
574 +|(% style="font-family:monospace" %)##Name##|String|
575 +|##DistributionAddressInfo##|[[DistributionAddressInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HDistributionAddressInfo"]]|
576 +|##Language##|String|
577 +|##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.
578 +|##VatNo##|String|
579 +|##Category##| |
580 +
581 +(% class="table-bordered table-striped" %)
582 +|=(% colspan="3" %)(((
583 +==== CustomerStatus ====
584 +)))
585 +|**Field**|**Datatype**|**Description**
586 +|(% style="font-family:monospace" %)##CustomerStatusTypeCode##|Int|
587 +
588 +(% class="table-bordered table-striped" %)
589 +|=(% colspan="4" %)(((
590 +==== DistributionAddressInfo ====
591 +)))
592 +|**Field**|**Datatype**|**Required**|**Description**
593 +|(% style="font-family:monospace" %)##Addresses##|Array|Yes|See [[address>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HAddress"]].
594 +|##EMailAddress##|String|No|
595 +|##Cellphone##|String|No|
596 +
597 +(% class="table-bordered table-striped" %)
598 +|=(% colspan="4" %)(((
599 +==== Address ====
600 +)))
601 +|**Field**|**Datatype**|**Required**|**Description**
602 +|(% style="font-family:monospace" %)Addressee|String(72)|Yes|
603 +|##StreetAdress##|String(35)|No|
604 +|##ZipCode##|String(9)|Yes|
605 +|##City##|String(27)|Yes|
606 +|##CoAddress##|String(35)|No|
607 +|##CountryCode##|String(2)|Yes|
608 +
609 +(% id="HAppendix1SharedClasses" %)
610 += Appendix 1 Shared Classes =
611 +
612 +
613 +**Response parameters**
614 +
615 +(% class="table-bordered table-striped" %)
616 +|=(% colspan="3" %)(((
617 +==== GetInvoicePDFResponse ====
618 +)))
619 +|**Field**|**Datatype**|**Description**
620 +|##Pdf##|Byte[]|
621 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
622 +|##CustomerNo##|String|
623 +|##ResponseCode##|String|
624 +|##ResponseMessage##|String|
625 +|##TraceId##|String|
626 +
627 +(% class="table-bordered table-striped" %)
628 +|=(% colspan="3" %)(((
629 +==== GetInvoiceInformationResponse ====
630 +)))
631 +|**Field**|**Datatype**|**Description**
632 +|##CompanyNo##|String|
633 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
634 +|##CustomerNo##|String|
635 +|##CustomerName##|String|
636 +|##Invoice##|[[Invoice>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoice"]]|
637 +|##ResponseCode##|String|
638 +|##ResponseMessage##|String|
639 +|##TraceId##|String|
640 +
641 +(% class="table-bordered table-striped" %)
642 +|=(% colspan="3" %)(((
643 +==== RegNo ====
644 +)))
645 +|**Field**|**Datatype**|**Description**
646 +|##CountryCode##|String|
647 +|##Value##|String|
648 +
649 +(% class="table-bordered table-striped" %)
650 +|=(% colspan="3" %)(((
651 +==== Invoice ====
652 +)))
653 +|**Field**|**Datatype**|**Description**
654 +|##PaymentReference##|String|
655 +|##BillNo##|String|
656 +|##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.
657 +|##ExternalInvoiceId##|String|
658 +|##ExternalReference##|String|
659 +|##SellerNo##|String|
660 +|##BillDate##|DateTime|
661 +|##DueDate##|DateTime (Optional)|
662 +|##OriginalAmount##|Decimal|
663 +|##Interest##|[[Interest>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInterest"]]|
664 +|##CurrentBalanceList##|List <[[Balance>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBalance"]]>|
665 +|##CurrencyCode##|String|
666 +|##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.
667 +|##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.
668 +|##PaymentBanAccount##|[[PaymentBankAccount>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HPaymentBankAccount"]]|
669 +|##PaymentType##|String|
670 +|##ActiveRespite##|[[ActiveRespite>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActiveRespite"]]|
671 +|##ActivePaymentOrder##|[[ActivePaymentOrder>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActivePaymentOrder"]]|
672 +|##BillId##|Long|
673 +|##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.
674 +|##InvoiceHistory##|List <[[InvoiceHistory>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoiceHistory"]]>|
675 +
676 +(% class="table-bordered table-striped" %)
677 +|=(% colspan="3" %)(((
678 +==== Interest ====
679 +)))
680 +|**Field**|**Datatype**|**Description**
681 +|##CurrentInterestRate##|decimal|
682 +|##InterestIntervalCode##|byte|
683 +
684 +(% class="table-bordered table-striped" %)
685 +|=(% colspan="3" %)(((
686 +==== Balance ====
687 +)))
688 +|**Field**|**Datatype**|**Description**
689 +|##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.
690 +|##Amount##|decimal|
691 +
692 +(% class="table-bordered table-striped" %)
693 +|=(% colspan="3" %)(((
694 +==== PaymentBankAccount ====
695 +)))
696 +|**Field**|**Datatype**|**Description**
697 +|##BankAccountNo##|String|
698 +|##BankAccountType##|String|
699 +|##BIC##|String|
700 +|##IBAN##|String|
701 +
702 +(% class="table-bordered table-striped" %)
703 +|=(% colspan="3" %)(((
704 +==== ActiveRespite ====
705 +)))
706 +|**Field**|**Datatype**|**Description**
707 +|##RespiteValidtoDate##|DateTime|
708 +|##RespiteTypeCode##|int|
709 +
710 +(% class="table-bordered table-striped" %)
711 +|=(% colspan="3" %)(((
712 +==== ActivePaymentOrder ====
713 +)))
714 +|**Field**|**Datatype**|**Description**
715 +|##PaymentType##|String|
716 +|##ExecutionDate##|DateTime|
717 +
718 +(% class="table-bordered table-striped" %)
719 +|=(% colspan="3" %)(((
720 +==== InvoiceHistory ====
721 +)))
722 +|**Field**|**Datatype**|**Description**
723 +|BillDate|DateTime|
724 +|BillId|long|
725 +|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.
726 +
727 +(% class="table-bordered table-striped" %)
728 +|=(% colspan="3" %)(((
729 +==== GetClosedInvoiceInformation20Response ====
730 +)))
731 +|**Field**|**Datatype**|**Description**
732 +|CompanyNo|String|
733 +|CustomerNo|string|
734 +|CustomerName|String|
735 +|InvoiceList|List<[[ClosedInvoice20>>||anchor="HClosedInvoice20"]]>|See [[ClosedInvoice20>>||anchor="HClosedInvoice20"]]
736 +
737 +(% class="table-bordered table-striped" %)
738 +|=(% colspan="3" %)(((
739 +==== ClosedInvoice20 ====
740 +)))
741 +|**Field**|**Datatype**|**Description**
742 +|CurrencyCode|String|
743 +|BillNo|string|
744 +|BillStatusCode|Int|
745 +|ExternalInvoiceId|String|
746 +|BillDate|DateTime|
747 +|DueDate|DateTime?|
748 +|ExternalBillType|String|
749 +|OriginalAmount|Decimal|
750 +|SellerName|String|
751 +|SellerNo|String|
752 +
753 +(% class="table-bordered table-striped" %)
754 +|=(% colspan="3" %)(((
755 +==== GetInvoiceInformation20Response ====
756 +)))
757 +|**Field**|**Datatype**|**Description**
758 +|CompanyNo|String|
759 +|RegNo|[[RegNo>>||anchor="HRegNo"]]|
760 +|CustomerNo|string|
761 +|CustomerName|String|
762 +|Invoice|[[InvoiceInformation20>>||anchor="HInvoiceInformation20inheritOpenInvoice20"]]|
763 +
764 +(% class="table-bordered table-striped" %)
765 +|=(% colspan="3" %)(((
766 +==== InvoiceInformation20 inherit [[OpenInvoice20>>||anchor="HOpenInvoice20inheritClosedInvoice20"]] ====
767 +)))
768 +|**Field**|**Datatype**|**Description**
769 +|PenaltyIntest|[[Intrest>>||anchor="HIntrest"]]|
770 +|CurrentBalance|List<[[Balance>>||anchor="HBalance"]]>|
771 +|InvoiceHistory|List<[[InvoiceHistory20>>||anchor="HInvoiceHistory20"]]>|
772 +
773 +(% class="table-bordered table-striped" %)
774 +|=(% colspan="3" %)(((
775 +==== InvoiceHistory20 ====
776 +)))
777 +|**Field**|**Datatype**|**Description**
778 +|BillDate|DateTime|
779 +|ExternalBillType|String|
780 +|BillAmount|Decimal?|
781 +
782 +(% class="table-bordered table-striped" %)
783 +|=(% colspan="3" %)(((
784 +==== OpenInvoice20 inherit [[ClosedInvoice20>>||anchor="HClosedInvoice20"]] ====
785 +)))
786 +|**Field**|**Datatype**|**Description**
787 +|CurrentDebt|Decimal|
788 +|PaymentBankAccount|[[PaymentBankAccount>>||anchor="HPaymentBankAccount"]]|
789 +|PaymentType|String|
790 +|ActiveRespite|[[ActiveRespite20>>||anchor="HActiveRespite20"]]|
791 +|ActivePaymentOrder|[[ActivePaymentOrder>>||anchor="HActivePaymentOrder"]]|
792 +|PaymentRefrence|String|
793 +|ExportedToCollection|Bool|
794 +
795 +(% class="table-bordered table-striped" %)
796 +|=(% colspan="3" %)(((
797 +==== ActiveRespite20 ====
798 +)))
799 +|**Field**|**Datatype**|**Description**
800 +|RespiteValidToDate|DateTime?|
801 +|RespiteTypeCode|Int|
802 +
803 += Appendix 2 Code specification =
804 +
805 +(% class="table-bordered table-striped" %)
806 +|=(% colspan="2" %)(((
807 +==== Bill status codes ====
808 +)))
809 +|**BillStatusCodes**|**Description**
810 +|1|Open
811 +|2|Closed
812 +|3|Closed_Diff
813 +|4|Closed_Loss
814 +|5|Reversed
815 +|6|Arrears
816 +|7|Closed_Rest
817 +|8|Closed_Convert
818 +|9|Closed_Sold
819 +|10|Closed_Reversal
820 +|11|Pending
821 +
822 +(% class="table-bordered table-striped" %)
823 +|=(% colspan="2" %)(((
824 +==== Claim level codes ====
825 +)))
826 +|**ClaimLevelCode**|**Description**
827 +|1|Invoice
828 +|2|RestReminderSent
829 +|3|ReminderSent
830 +|4|RestReminderSent
831 +|5|SecondReminderSent
832 +|6|RestReminderSent
833 +|7|CollectionClaimSent
834 +|8|RestReminderSent
835 +|9*|DebtCollection*
836 +|10|Late Fee, credit account
837 +|11|TerminationNoticeSent, credit account
838 +
839 +*Additional fees and interest may have occured in collection system, but is not included in the response.
840 +
841 +(% class="table-bordered table-striped" %)
842 +|=(% colspan="2" %)(((
843 +==== Bill type codes ====
844 +)))
845 +|**BillTypeCode**|**Description**
846 +|1|Invoice
847 +|4|CreditInvoice
848 +
849 +(% class="table-bordered table-striped" %)
850 +|=(% colspan="2" %)(((
851 +==== Consent type codes ====
852 +)))
853 +|**ConsentTypeCode**|**Description**
854 +|1|BGAGSE
855 +|2|EInvoiceB2CSE
856 +|3|EInvoiceB2CNO
857 +|4|BKAGNO
858 +
859 +(% class="table-bordered table-striped" %)
860 +|=(% colspan="2" %)(((
861 +==== Legal entity codes ====
862 +)))
863 +|**LegalEntiytCode**|**Description**
864 +|None|None
865 +|Private|Private
866 +|Business|Business
867 +
868 +(% class="table-bordered table-striped" %)
869 +|=(% colspan="2" %)(((
870 +==== Balance type codes ====
871 +)))
872 +|**BalanceTypeCode**|**Description**
873 +|0|None
874 +|1|Capital
875 +|2|ReminderFee
876 +|3|PenaltyInterest
877 +|4|CalculatedPenaltyInterest
878 +|5|CollectionFee
879 +|6|BusinessReminderFee
880 +|7|BillingFee
881 +|8|DelayFee
882 +|9|DebtInterest
883 +|10|DebtCollectionCharge
884 +|11|Rounding
885 +
886 +(% class="table-bordered table-striped" %)
887 +|=(% colspan="2" %)(((
888 +==== Collection status codes ====
889 +)))
890 +|**CollectionStatusCode**|**Description**
891 +|1|PreDebtCollection
892 +|2|DebtCollection
893 +|3|LegalProcess
894 +|4|Monitoring
895 +|5|External
896 +|6|Closed
897 +|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
2-class-diagram-external.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.dap
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
3-class-diagram-external.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.dap
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
4-class-diagram-external.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.dap
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
5-class-diagram-external.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.dap
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
6-class-diagram-external.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.dap
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
7-class-diagram-external.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.dap
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content
PayExConnect_Manual_PxR_ExternalServices.pdf
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.rae
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content