From empty
To version 54.1
edited by Bent Pitkänen
on 2019/11/15 14:33
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,842 @@
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 +[[image:1573822789308-786.png||height="470" width="761"]]
451 +
452 +**Request parameters**
453 +
454 +(% class="table-bordered table-striped" %)
455 +|=(% colspan="4" %)GetInvoicePdfByBillNoExternalBillType10Request
456 +|**Field**|**Datatype**|**Required**|**Description**
457 +|##BillNo##|String|Yes|
458 +|ExternalBillType|String|Yes|(((
459 +Document type.
460 +Existing ExternalBillType can be retrived from GetInvoiceInformationByBillNo20 or GetInvoiceInformationByExternalInvoiceId20.
461 +)))
462 +|TrackingUserEMail|String(1-256)|Yes|User info for trackability.
463 +|TraceId|String|Yes|
464 +
465 +Response parameters
466 +
467 +[[GetInvoicePDFResponse>>||anchor="HGetInvoicePDFResponse"]]
468 +
469 +
470 +
471 += CustomerService methods =
472 +
473 +The complete Wsdl specification for this service can be found at:
474 +[[https:~~/~~/connect.internaltest.payex.com/PxR/CustomerService.svc>>url:https://connect.internaltest.payex.com/PxR/CustomerService.svc]]
475 +
476 + (Username/password security model)
477 +
478 +== GetcustomerCurrentStateByCustomerNo ==
479 +
480 +Get information about current state of a customer.
481 +
482 +**Class diagram**
483 +
484 +[[image:7-class-diagram-external.png]]
485 +
486 +**Request parameters**
487 +
488 +(% class="table-bordered table-striped" %)
489 +|=(% colspan="4" %)GetCustomerCurrentStateByCustomerNoRequest
490 +|**Field**|**Datatype**|**Required**|**Description**
491 +|##CustomerNumber##|String(15)|Yes|
492 +|##TrackingUserEMail##|String|No|
493 +
494 +**Response parameters**
495 +
496 +(% class="table-bordered table-striped" %)
497 +|=(% colspan="3" %)GetCustomerCurrentStateByCustomerNoResponse
498 +|**Field**|**Datatype**|**Description**
499 +|(% style="font-family:monospace" %)##CustomerConsents##|[[CustomerConsent>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerConsent"]]|Array.
500 +|##CustomerInfo##|[[CustomerInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerInfo"]]|
501 +|##CustomerNo##|String|
502 +|##CustomerStatus##|[[CustomerStatus>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HCustomerStatus"]]|Array.
503 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
504 +
505 +**Classes**
506 +
507 +(% class="table-bordered table-striped" %)
508 +|=(% colspan="3" %)(((
509 +==== CustomerConsent ====
510 +)))
511 +|**Field**|**Datatype**|**Description**
512 +|(% 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.
513 +
514 +(% class="table-bordered table-striped" %)
515 +|=(% colspan="3" %)(((
516 +==== CustomerInfo ====
517 +)))
518 +|**Field**|**Datatype**|**Description**
519 +|(% style="font-family:monospace" %)##Name##|String|
520 +|##DistributionAddressInfo##|[[DistributionAddressInfo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HDistributionAddressInfo"]]|
521 +|##Language##|String|
522 +|##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.
523 +|##VatNo##|String|
524 +|##Category##| |
525 +
526 +(% class="table-bordered table-striped" %)
527 +|=(% colspan="3" %)(((
528 +==== CustomerStatus ====
529 +)))
530 +|**Field**|**Datatype**|**Description**
531 +|(% style="font-family:monospace" %)##CustomerStatusTypeCode##|Int|
532 +
533 +(% class="table-bordered table-striped" %)
534 +|=(% colspan="4" %)(((
535 +==== DistributionAddressInfo ====
536 +)))
537 +|**Field**|**Datatype**|**Required**|**Description**
538 +|(% style="font-family:monospace" %)##Addresses##|Array|Yes|See [[address>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HAddress"]].
539 +|##EMailAddress##|String|No|
540 +|##Cellphone##|String|No|
541 +
542 +(% class="table-bordered table-striped" %)
543 +|=(% colspan="4" %)(((
544 +==== Address ====
545 +)))
546 +|**Field**|**Datatype**|**Required**|**Description**
547 +|(% style="font-family:monospace" %)Addressee|String(72)|Yes|
548 +|##StreetAdress##|String(35)|No|
549 +|##ZipCode##|String(9)|Yes|
550 +|##City##|String(27)|Yes|
551 +|##CoAddress##|String(35)|No|
552 +|##CountryCode##|String(2)|Yes|
553 +
554 +(% id="HAppendix1SharedClasses" %)
555 += Appendix 1 Shared Classes =
556 +
557 +
558 +**Response parameters**
559 +
560 +(% class="table-bordered table-striped" %)
561 +|=(% colspan="3" %)(((
562 +==== GetInvoicePDFResponse ====
563 +)))
564 +|**Field**|**Datatype**|**Description**
565 +|##Pdf##|Byte[]|
566 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
567 +|##CustomerNo##|String|
568 +|##ResponseCode##|String|
569 +|##ResponseMessage##|String|
570 +|##TraceId##|String|
571 +
572 +(% class="table-bordered table-striped" %)
573 +|=(% colspan="3" %)(((
574 +==== GetInvoiceInformationResponse ====
575 +)))
576 +|**Field**|**Datatype**|**Description**
577 +|##CompanyNo##|String|
578 +|##RegNo##|[[RegNo>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HRegNo"]]|
579 +|##CustomerNo##|String|
580 +|##CustomerName##|String|
581 +|##Invoice##|[[Invoice>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoice"]]|
582 +|##ResponseCode##|String|
583 +|##ResponseMessage##|String|
584 +|##TraceId##|String|
585 +
586 +(% class="table-bordered table-striped" %)
587 +|=(% colspan="3" %)(((
588 +==== RegNo ====
589 +)))
590 +|**Field**|**Datatype**|**Description**
591 +|##CountryCode##|String|
592 +|##Value##|String|
593 +
594 +(% class="table-bordered table-striped" %)
595 +|=(% colspan="3" %)(((
596 +==== Invoice ====
597 +)))
598 +|**Field**|**Datatype**|**Description**
599 +|##PaymentReference##|String|
600 +|##BillNo##|String|
601 +|##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.
602 +|##ExternalInvoiceId##|String|
603 +|##ExternalReference##|String|
604 +|##SellerNo##|String|
605 +|##BillDate##|DateTime|
606 +|##DueDate##|DateTime (Optional)|
607 +|##OriginalAmount##|Decimal|
608 +|##Interest##|[[Interest>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInterest"]]|
609 +|##CurrentBalanceList##|List <[[Balance>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HBalance"]]>|
610 +|##CurrencyCode##|String|
611 +|##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.
612 +|##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.
613 +|##PaymentBanAccount##|[[PaymentBankAccount>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HPaymentBankAccount"]]|
614 +|##PaymentType##|String|
615 +|##ActiveRespite##|[[ActiveRespite>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActiveRespite"]]|
616 +|##ActivePaymentOrder##|[[ActivePaymentOrder>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HActivePaymentOrder"]]|
617 +|##BillId##|Long|
618 +|##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.
619 +|##InvoiceHistory##|List <[[InvoiceHistory>>doc:Main.Invoicing.invoice-service.Technical reference.PayEx Connect (API).ExternalServicesmanual.WebHome||anchor="HInvoiceHistory"]]>|
620 +
621 +(% class="table-bordered table-striped" %)
622 +|=(% colspan="3" %)(((
623 +==== Interest ====
624 +)))
625 +|**Field**|**Datatype**|**Description**
626 +|##CurrentInterestRate##|decimal|
627 +|##InterestIntervalCode##|byte|
628 +
629 +(% class="table-bordered table-striped" %)
630 +|=(% colspan="3" %)(((
631 +==== Balance ====
632 +)))
633 +|**Field**|**Datatype**|**Description**
634 +|##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.
635 +|##Amount##|decimal|
636 +
637 +(% class="table-bordered table-striped" %)
638 +|=(% colspan="3" %)(((
639 +==== PaymentBankAccount ====
640 +)))
641 +|**Field**|**Datatype**|**Description**
642 +|##BankAccountNo##|String|
643 +|##BankAccountType##|String|
644 +|##BIC##|String|
645 +|##IBAN##|String|
646 +
647 +(% class="table-bordered table-striped" %)
648 +|=(% colspan="3" %)(((
649 +==== ActiveRespite ====
650 +)))
651 +|**Field**|**Datatype**|**Description**
652 +|##RespiteValidtoDate##|DateTime|
653 +|##RespiteTypeCode##|int|
654 +
655 +(% class="table-bordered table-striped" %)
656 +|=(% colspan="3" %)(((
657 +==== ActivePaymentOrder ====
658 +)))
659 +|**Field**|**Datatype**|**Description**
660 +|##PaymentType##|String|
661 +|##ExecutionDate##|DateTime|
662 +
663 +(% class="table-bordered table-striped" %)
664 +|=(% colspan="3" %)(((
665 +==== InvoiceHistory ====
666 +)))
667 +|**Field**|**Datatype**|**Description**
668 +|BillDate|DateTime|
669 +|BillId|long|
670 +|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.
671 +
672 +(% class="table-bordered table-striped" %)
673 +|=(% colspan="3" %)(((
674 +==== GetClosedInvoiceInformation20Response ====
675 +)))
676 +|**Field**|**Datatype**|**Description**
677 +|CompanyNo|String|
678 +|CustomerNo|string|
679 +|CustomerName|String|
680 +|InvoiceList|List<[[ClosedInvoice20>>||anchor="HClosedInvoice20"]]>|See [[ClosedInvoice20>>||anchor="HClosedInvoice20"]]
681 +
682 +(% class="table-bordered table-striped" %)
683 +|=(% colspan="3" %)(((
684 +==== ClosedInvoice20 ====
685 +)))
686 +|**Field**|**Datatype**|**Description**
687 +|CurrencyCode|String|
688 +|BillNo|string|
689 +|BillStatusCode|Int|
690 +|ExternalInvoiceId|String|
691 +|BillDate|DateTime|
692 +|DueDate|DateTime?|
693 +|ExternalBillType|String|
694 +|OriginalAmount|Decimal|
695 +|SellerName|String|
696 +|SellerNo|String|
697 +
698 +(% class="table-bordered table-striped" %)
699 +|=(% colspan="3" %)(((
700 +==== GetInvoiceInformation20Response ====
701 +)))
702 +|**Field**|**Datatype**|**Description**
703 +|CompanyNo|String|
704 +|RegNo|[[RegNo>>||anchor="HRegNo"]]|
705 +|CustomerNo|string|
706 +|CustomerName|String|
707 +|Invoice|[[InvoiceInformation20>>||anchor="HInvoiceInformation20inheritOpenInvoice20"]]|
708 +
709 +(% class="table-bordered table-striped" %)
710 +|=(% colspan="3" %)(((
711 +==== InvoiceInformation20 inherit [[OpenInvoice20>>||anchor="HOpenInvoice20inheritClosedInvoice20"]] ====
712 +)))
713 +|**Field**|**Datatype**|**Description**
714 +|PenaltyIntest|[[Intrest>>||anchor="HIntrest"]]|
715 +|CurrentBalance|List<[[Balance>>||anchor="HBalance"]]>|
716 +|InvoiceHistory|List<[[InvoiceHistory20>>||anchor="HInvoiceHistory20"]]>|
717 +
718 +(% class="table-bordered table-striped" %)
719 +|=(% colspan="3" %)(((
720 +==== InvoiceHistory20 ====
721 +)))
722 +|**Field**|**Datatype**|**Description**
723 +|BillDate|DateTime|
724 +|ExternalBillType|String|
725 +|BillAmount|Decimal?|
726 +
727 +(% class="table-bordered table-striped" %)
728 +|=(% colspan="3" %)(((
729 +==== OpenInvoice20 inherit [[ClosedInvoice20>>||anchor="HClosedInvoice20"]] ====
730 +)))
731 +|**Field**|**Datatype**|**Description**
732 +|CurrentDebt|Decimal|
733 +|PaymentBankAccount|[[PaymentBankAccount>>||anchor="HPaymentBankAccount"]]|
734 +|PaymentType|String|
735 +|ActiveRespite|[[ActiveRespite20>>||anchor="HActiveRespite20"]]|
736 +|ActivePaymentOrder|[[ActivePaymentOrder>>||anchor="HActivePaymentOrder"]]|
737 +|PaymentRefrence|String|
738 +|ExportedToCollection|Bool|
739 +
740 +(% class="table-bordered table-striped" %)
741 +|=(% colspan="3" %)(((
742 +==== ActiveRespite20 ====
743 +)))
744 +|**Field**|**Datatype**|**Description**
745 +|RespiteValidToDate|DateTime?|
746 +|RespiteTypeCode|Int|
747 +
748 += Appendix 2 Code specification =
749 +
750 +(% class="table-bordered table-striped" %)
751 +|=(% colspan="2" %)(((
752 +==== Bill status codes ====
753 +)))
754 +|**BillStatusCodes**|**Description**
755 +|1|Open
756 +|2|Closed
757 +|3|Closed_Diff
758 +|4|Closed_Loss
759 +|5|Reversed
760 +|6|Arrears
761 +|7|Closed_Rest
762 +|8|Closed_Convert
763 +|9|Closed_Sold
764 +|10|Closed_Reversal
765 +|11|Pending
766 +
767 +(% class="table-bordered table-striped" %)
768 +|=(% colspan="2" %)(((
769 +==== Claim level codes ====
770 +)))
771 +|**ClaimLevelCode**|**Description**
772 +|1|Invoice
773 +|2|RestReminderSent
774 +|3|ReminderSent
775 +|4|RestReminderSent
776 +|5|SecondReminderSent
777 +|6|RestReminderSent
778 +|7|CollectionClaimSent
779 +|8|RestReminderSent
780 +|9*|DebtCollection*
781 +|10|Late Fee, credit account
782 +|11|TerminationNoticeSent, credit account
783 +
784 +*Additional fees and interest may have occured in collection system, but is not included in the response.
785 +
786 +(% class="table-bordered table-striped" %)
787 +|=(% colspan="2" %)(((
788 +==== Bill type codes ====
789 +)))
790 +|**BillTypeCode**|**Description**
791 +|1|Invoice
792 +|4|CreditInvoice
793 +
794 +(% class="table-bordered table-striped" %)
795 +|=(% colspan="2" %)(((
796 +==== Consent type codes ====
797 +)))
798 +|**ConsentTypeCode**|**Description**
799 +|1|BGAGSE
800 +|2|EInvoiceB2CSE
801 +|3|EInvoiceB2CNO
802 +|4|BKAGNO
803 +
804 +(% class="table-bordered table-striped" %)
805 +|=(% colspan="2" %)(((
806 +==== Legal entity codes ====
807 +)))
808 +|**LegalEntiytCode**|**Description**
809 +|None|None
810 +|Private|Private
811 +|Business|Business
812 +
813 +(% class="table-bordered table-striped" %)
814 +|=(% colspan="2" %)(((
815 +==== Balance type codes ====
816 +)))
817 +|**BalanceTypeCode**|**Description**
818 +|0|None
819 +|1|Capital
820 +|2|ReminderFee
821 +|3|PenaltyInterest
822 +|4|CalculatedPenaltyInterest
823 +|5|CollectionFee
824 +|6|BusinessReminderFee
825 +|7|BillingFee
826 +|8|DelayFee
827 +|9|DebtInterest
828 +|10|DebtCollectionCharge
829 +|11|Rounding
830 +
831 +(% class="table-bordered table-striped" %)
832 +|=(% colspan="2" %)(((
833 +==== Collection status codes ====
834 +)))
835 +|**CollectionStatusCode**|**Description**
836 +|1|PreDebtCollection
837 +|2|DebtCollection
838 +|3|LegalProcess
839 +|4|Monitoring
840 +|5|External
841 +|6|Closed
842 +|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
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